Beneficiary Form
Get all required fields for your bank/recipient
Beneficiary/recipient receiving information might be tricky, check out the required fields to help add beneficiary.
POST METHOD
Note
Pass required data to help filter required fields for payout.
{{baseUrl}}/api/v2/beneficiary/forms
{
"country":"US",
"cur":"USD",
"category":"BANK",
"option":""
}
| Field | Required | Data Type | Description |
|---|---|---|---|
| country | true | String | Length: 2, Country ISO code i.e US. |
| cur | true | String | Length: 3, Country ISO code i.e USD. |
| category | false | String | Bank (default value), Wallet, Cash |
| option | false | String |
Response
{
"status": true,
"content": {
"data": [
{
"fieldName": "bankName",
"title": "Bank Name",
"hasDefaultValue": false,
"defaultValue": null,
"verification": null,
"required": true,
"dependency": null,
"visibility": true,
"fieldType": "select2",
"fieldTypeAlternative": null,
"validation": null,
"populate": {
"isEndpoint": true,
"endpoint": "/otherBanks",
"method": "POST",
"payload": [
{
"field": "cur",
"value": "USD",
"valueType": "data",
"fieldValue": null
},
{
"field": "country",
"value": "US",
"valueType": "data",
"fieldValue": null
},
{
"field": "category",
"value": "BANK",
"valueType": "data",
"fieldValue": null
}
],
"param": []
}
},
{
"fieldName": "bankCode",
"title": null,
"hasDefaultValue": false,
"defaultValue": null,
"required": true,
"dependency": [
"bankName"
],
"visibility": false,
"fieldType": "input",
"fieldTypeAlternative": null,
"validation": null,
"populate": null,
"inherit": {
"inheritFrom": "bankName",
"value": "bankCode"
}
},
{
"fieldName": "accountNo",
"title": "Account Number",
"hasDefaultValue": false,
"defaultValue": null,
"verification": {
"min": 4,
"len": 17,
"max": 17,
"regex": "^[0-9a-zA-Z]{4,17}$",
"dataType": "numeric"
},
"required": true,
"dependency": null,
"visibility": true,
"fieldType": "input",
"fieldTypeAlternative": null,
"validation": null,
"populate": null,
"inherit": null
},
{
"fieldName": "accountName",
"title": "Account Name",
"hasDefaultValue": false,
"defaultValue": null,
"verification": null,
"required": true,
"dependency": null,
"visibility": true,
"fieldType": "input",
"fieldTypeAlternative": null,
"validation": null,
"populate": null,
"inherit": null
},
{
"fieldName": "bankRoutingNo",
"title": "Routing Number",
"hasDefaultValue": false,
"defaultValue": null,
"verification": {
"min": 9,
"len": 9,
"max": 9,
"regex": "^[0-9]{9,9}$",
"dataType": "numeric"
},
"required": true,
"dependency": null,
"visibility": true,
"fieldType": "input",
"fieldTypeAlternative": null,
"validation": {
"isEndpoint": true,
"endpoint": "/swift-iban-verify",
"method": "POST",
"payload": [
{
"field": "account",
"value": "bankRoutingNo",
"valueType": "fieldName",
"fieldValue": "text"
},
{
"field": "mode",
"value": "ROUTINE",
"valueType": "data",
"fieldValue": null
}
],
"param": []
},
"populate": null
},
{
"fieldName": "beneficiaryEmail",
"title": "Beneficiary Email Address",
"required": false,
"dependency": null,
"visibility": false,
"fieldType": "input",
"fieldTypeAlternative": null,
"validation": null,
"verification": null,
"populate": null
}
]
}
}
Updated 11 months ago