Introduction

Build the front-end form for bank account-based payment, partners need to calls the Get Account Form API to obtain field definitions such as bank selection, account number input, and any other user-required data fields.

API Description

Request Method:POST

Request Path:open/api/transfer/requiredField

Parameters

Request Parameters

Parameter	Sign	Mandatory	Type	Length	Description
appId	Y	Y	string	64	AppId is unique for merchant
sign	N	Y	string	512	Sign
currency	Y	Y	string	20	Fiat currency:`MXN`,`NGN`,`ZMW`,`USD`,`BDT`

Request Parameter Example

{
    "currency": "NGN",
    "appId":"TEST000001",
    "sign":"TEST000001"
}

Response Parameters

Parameter	Type	Description
success	boolean	Success
error	boolean	Error
code	long	Response code
msg	string	Response message
traceId	string	Trace id
model	object	Response content

Response Parameter Example(NGN)

{
    "code": "0",
    "msg": "success",
    "model": {
        "fields": [
            {
                "regex": "",
                "fieldName": "bankName",
                "dataSourceKey": "bankList",
                "formElement": "select",
                "length": "",
                "fieldType": "string"
            },
            {
                "regex": "",
                "fieldName": "bankCode",
                "dataSourceKey": "bankList",
                "formElement": "select",
                "length": "",
                "fieldType": "string"
            },
            {
                "regex": "",
                "fieldName": "bankAccountNumber",
                "dataSourceKey": "",
                "formElement": "input",
                "length": "10",
                "fieldType": "string"
            }
        ],
        "dataSource": {
            "bankList": [
                {
                    "bankCode": "311",
                    "bankName": "Parkway - ReadyCash"
                },
                {
                    "bankCode": "51293",
                    "bankName": "QuickFund MFB"
                },
                {
                    "bankCode": "100039",
                    "bankName": "Paystack-Titan"
                }
            ]
        }
    },
    "traceId": "685a2c0e0e8f4e73f2077d6a09348575",
    "success": true,
    "error": false
}

Response Parameter Example(USD)

{
  "code": "0",
  "msg": "success",
  "model": {
    "fields": [
      {
        "regex": "",
        "fieldName": "priceEnd",
        "dataSourceKey": "bankList",
        "formElement": "label",
        "length": "",
        "fieldType": "string"
      },
      {
        "regex": "",
        "fieldName": "priceStart",
        "dataSourceKey": "bankList",
        "formElement": "label",
        "length": "",
        "fieldType": "string"
      },
      {
        "regex": "",
        "fieldName": "logoUrl",
        "dataSourceKey": "bankList",
        "formElement": "img",
        "length": "",
        "fieldType": "string"
      },
      {
        "regex": "",
        "fieldName": "imageUrl",
        "dataSourceKey": "bankList",
        "formElement": "img",
        "length": "",
        "fieldType": "string"
      },
      {
        "regex": "",
        "fieldName": "bankName",
        "dataSourceKey": "bankList",
        "formElement": "label",
        "length": "",
        "fieldType": "string"
      },
      {
        "regex": "",
        "fieldName": "bankCode",
        "dataSourceKey": "bankList",
        "formElement": "select",
        "length": "",
        "fieldType": "string"
      }
    ],
    "dataSource": {
      "bankList": [
        {
          "bankCode": "CT000000003453",
          "imageUrl": "https://snaplii.s3.us-west-2.amazonaws.com/merchant/spiderman/1i5ehii3d_0dq8ht_e6tio7_bmdc0n_Walmart_eGift%5B1%5D.png",
          "priceStart": "10",
          "priceEnd": "500",
          "bankName": "Walmart Gift Card",
          "logoUrl": "https://snaplii.s3.us-west-2.amazonaws.com/merchant/spiderman/1i5ehii3d_0dq8ht_e6tio7_bmdc0n_Walmart_eGift%5B1%5D.png"
        },
        {
          "bankCode": "CT000000002192",
          "imageUrl": "https://snaplii.s3.us-west-2.amazonaws.com/merchant/spiderman/1i1b2midi_0s75q1_4kfuq2_v8o6bc_1hsp8ogv5_lfml50_1do1ii_mlseca_Columbia.png",
          "priceStart": "5",
          "priceEnd": "500",
          "bankName": "Columbia Gift Card",
          "logoUrl": "https://snaplii.s3.us-west-2.amazonaws.com/merchant/spiderman/1i1b2midi_0s75q1_4kfuq2_v8o6bc_1hsp8ogv5_lfml50_1do1ii_mlseca_Columbia.png"
        },
        {
          "bankCode": "CT000000003373",
          "imageUrl": "https://snaplii.s3.us-west-2.amazonaws.com/merchant/spiderman/1i4kms4u8_eccq9u_4be154_ftlksn_Apple.png",
          "priceStart": "10",
          "priceEnd": "10",
          "bankName": "Apple Gift Card",
          "logoUrl": "https://snaplii.s3.us-west-2.amazonaws.com/merchant/spiderman/1i4kms4u8_eccq9u_4be154_ftlksn_Apple.png"
        }
      ]
    }
  },
  "traceId": "68d0f10743e9ea1b735143f9eb6cb058",
  "success": true,
  "error": false
}

Response Parameter Example(ZMW)

{
        "code": "0",
        "msg": "success",
        "model": {
            "fields": [
                {
                    "regex": "",
                    "fieldName": "mobile",
                    "dataSourceKey": "",
                    "formElement": "input",
                    "length": "10",
                    "fieldType": "string"
                }
            ],
            "dataSource": {
                "bankList": [


                ]
            }
        },
        "traceId": "68eccc3cb2f17bac4b520797287f258b",
        "success": true,
        "error": false
    }

Response Parameter Example(MXN)

{
    "code": "0",
    "msg": "success",
    "model": {
        "fields": [
            {
                "regex": "",
                "fieldName": "bankName",
                "dataSourceKey": "bankList",
                "formElement": "select",
                "length": "",
                "fieldType": "string"
            },
            {
                "regex": "",
                "fieldName": "bankCode",
                "dataSourceKey": "bankList",
                "formElement": "select",
                "length": "",
                "fieldType": "string"
            },
            {
                "regex": "",
                "fieldName": "bankAccountNumber",
                "dataSourceKey": "",
                "formElement": "input",
                "length": "",
                "fieldType": "string"
            }
        ],
        "dataSource": {
            "bankList": [
                {
                    "bankCode": "90722",
                    "bankName": "Mercado Pago W"
                },
                {
                    "bankCode": "90723",
                    "bankName": "Cuenca"
                },
                {
                    "bankCode": "90710",
                    "bankName": "NVIO"
                }
            ]
        }
    },
    "traceId": "68f9eb86429436f055e52ec64d78ee04",
    "error": false,
    "success": true
}

Response Parameter Example(BDT)

{
    "code": "0",
    "msg": "success",
    "model": {
        "fields": [
            {
                "regex": "",
                "fieldName": "payMethod",
                "dataSourceKey": "bankList",
                "formElement": "select",
                "length": "",
                "fieldType": "string"
            },
            {
                "regex": "^01\\d{9}$",
                "fieldName": "mobile",
                "dataSourceKey": "",
                "formElement": "input",
                "length": "11",
                "fieldType": "string"
            }
        ],
        "dataSource": {
            "bankList": [
                {
                    "payMethod": "BD_BKASH"
                },
                {
                    "payMethod": "BD_NAGAD"
                }
            ]
        }
    },
    "traceId": "6952265fae5edfd4c1d762e124af9733",
    "success": true,
    "error": false
}