Authorize

Consult

POST https://mapi.yuansfer.com/auto-debit/v3/consult

Use this interface to initiate authorization of the authorization verification URL for an authorization that occurs at Yuansfer. Authorize the user according to the information in the request.

Request Body

NameTypeDescription

vendor*

string

The possible payment channels are "alipay", "truemoney", "alipay_hk", "tng", "gcash", "dana", "kakaopay", "bkash", "easypaisa".

merchantNo*

string

Merchant ID

storeNo*

string

Store ID

note

string

The payment note.

osType

string

When the terminal is "WAP" or "APP", we need this parameter, the possible value is "IOS", "ANDROID".

osVersion

string

When the terminal is "WAP" or "APP", return this parameter.

autoIpnUrl*

string

Asynchronous callback address (note: If autoIpnUrl is set null when the user authorization is complete, Yuansfer will send an asynchronous callback notification containing parameters such as autoDebitNo, autoReference, vendor, time, note, and verifySign).

autoRedirectUrl*

string

Synchronize the callback address.

autoReference*

string

The invoice number of the auto-debit in the merchant's system.

terminal*

string

The possible values are: "ONLINE", "WAP", "APP".

verifySign*

string

The parameter signature.

{
    "result": {
        "authUrl": "https://render.alipay.com/p/c/jzmcoal2/gcash-login?callback=http%3A%2F%2Fzk-tys.yunkeguan.com%2FappIpnCallbackNotify%2Fauto-auth-redirect%2F298222562856331071&authState=298222562856331071&county=US&merchantId=21881101806601J7&merchantName=Yuansfer_Cashier",
        "autoDebitNo": "298222562856331071",
        "autoReference": "testAuth2021010801",
        "vendor": "GCASH"
    },
    "ret_code": "000100",
    "ret_msg": "consult success"
}

Response

Parameter

Type

Description

result

object

The result object.

ret_msg

string

The response return message.

ret_code

string

The response return code. For more details, see here.

Result Object

Parameter

Type

Description

normalUrl

string

The URL that redirects users to open an app when the target app is installed, or to open a WAP page when the target app is not installed.

applinkUrl

string

The URL that redirects users to a WAP or WEB page in the default browser or the embedded WebView.

authUrl

string

User redirect to this URL to sign contract.

autoDebitNo

string

Unique ID of auto debit in Yuansfer's system.

autoReference

string

Unique ID of auto debit in the merchant's system.

vendor

string

The possible payment channels are "gcash", "kakaopay", "alipay", "alipay_hk", "dana", "truemoney", "tng", "easypaisa", "bkash".

{
    "merchantNo": "200043",
    "storeNo": "300014",
    "verifySign": "dc6a38102a63a5e3527589679d9ecc9f",
    "vendor": "GCASH",
    "autoIpnUrl": "http://zk-tys.yunkeguan.com/ttest/test",
    "autoRedirectUrl": "http://zk-tys.yunkeguan.com/ttest/test2",
    "autoReference": "testAuth2021010801",
    "terminal": "ONLINE",
    "osType": "IOS",
    "osVersion": "14.0.0.1"
}

Last updated