Query bank account required information

  • GET /v3/b2b/recipient/bankFillingRequired

Precautions: Because different bank accounts require different parameters, this interface enables the user to query the parameters required.

Request Sample

curl --location --request POST 'https://test2-business-cgi.pingpongx.com/v3/b2b/recipient/bankFillingRequired' \
--header 'Authorization: Bearer b971ea74d3f2421fbf0e17fdf805f683f9a7a97b2d124757bda5243c2d1ee119' \
--header 'Content-Type: application/json' \
--header 'timestamp: 1637564397860' \
--header 'sign: 4a70672b69b59d24d1ef05b716b1fc1d89e3e87e2b4921cb5847b6230e91c472' \
--header 'app_id: 80242303107221' \
--data-raw '{
      "open_id":"728c86d145b2be4e30f9745f7350",
      "currency":"USD",
      "location":"China"
}'

Request Schema

Parameter Type Required Description
open_id String M User ID in PingPong
currency String M ISO-4217 currency code, e.g. USD, AUD.
location String M Full name of country e.g. United States

Response Sample

{
    "code": 0,
    "success": true,
    "message": "OK",
    "data": {
        "beneficiary_parameters": [
            {
                "name": "Recipient Email",
                "description": "hello",
                "note": null,
                "required": true,
                "map_name": "email"
            },
            {
                "name": "Prefix(e.g +1)",
                "description": "hello",
                "note": null,
                "required": false,
                "map_name": "prefix"
            },
            {
                "name": "Phone Number",
                "description": "hello",
                "note": null,
                "required": false,
                "map_name": "phone"
            },
            {
                "name": "Currency",
                "description": "hello",
                "note": null,
                "required": true,
                "map_name": "currency"
            },
            {
                "name": "Amount",
                "description": "hello",
                "note": null,
                "required": true,
                "map_name": "amount"
            },
            {
                "name": "Bank Location",
                "description": "hello",
                "note": null,
                "required": true,
                "map_name": "country"
            },
            {
                "name": "Bank Name",
                "description": "hello",
                "note": null,
                "required": true,
                "map_name": "bankName"
            },
            {
                "name": "Account Holder Name",
                "description": "hello",
                "note": null,
                "required": true,
                "map_name": "accountName"
            },
            {
                "name": "Account Number",
                "description": "hello",
                "note": null,
                "required": true,
                "map_name": "accountNo"
            },
            {
                "name": "Swift Code/BIC",
                "description": "8 or 11 characters",
                "note": "8 or 11 characters",
                "required": true,
                "map_name": "swiftOrBic"
            },
            {
                "name": "Note (Invoice / Reference number)",
                "description": "hello",
                "note": null,
                "required": false,
                "map_name": "remark"
            }
        ]
    }
}

Response Schema

Parameter Type Required Description
beneficiary_parameters List M The required parameters of bank account
beneficiary_parameters.name String M Full name of this required parameter
beneficiary_parameters.mapName String M Interface required parameter
beneficiary_parameters.description String M Description of this reauired parameter
beneficiary_parameters.note String O Conditions about this required parameter, e.g. parameter length limits cannot exceed 8 characters
beneficiary_parameters.required Boolean M Specifies whether the parameter is required
Copyright © pingpongx.com 2021 all right reserved,powered by Gitbooklast modified: 2022-04-26 10:15:17

results matching ""

    No results matching ""