Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Version History

Version 1 Current »

This page shows the request payload for processing Payout transaction to US Beneficiaries.

Request Body

 Request Payload for USD Payout Using BicSwift
{
    "currencyCode": "USD",
    "beneficiaryAccountName": "ACCOUNT HOLDER NAME",
    "beneficiaryAccountNumber": "0112345678", // using test account
    "amount": 35,
    "narration": "Single Payout USD example",
    "paymentMethodType": "BicSwift",
    "paymentMethodValue": "CHASUS33", // using test value
    "tenantReference": "{{$randomInt}}",
    "beneficiaryAddress": "8916 Str Ave, Woodhaven, United Kingdom",
    "intermidiaryBankRoutingNumber": "21000021",
    "beneficiaryCity": null,
    "beneficiaryState": null,
    "beneficiaryZIP": null,
    "beneficiaryCountryIso": "US"
}

 Request Payload for USD Payout Using AbaRouting
{
    "currencyCode": "USD",
    "beneficiaryAccountName": "ACCOUNT HOLDER NAME",
    "beneficiaryAccountNumber": "0112345678", // using test account
    "amount": 35,
    "narration": "Single Payout USD example",
    "paymentMethodType": "AbaRouting",
    "paymentMethodValue": "CHASUS33", // using test value
    "tenantReference": "{{$randomInt}}",
    "beneficiaryAddress": "8916 Str Ave, Woodhaven, United Kingdom",
    "intermidiaryBankRoutingNumber": null,
    "beneficiaryCity": null,
    "beneficiaryState": null,
    "beneficiaryZIP": null,
    "beneficiaryCountryIso": "US"
}

Element

Description

Type

Example

Required

currencyCode

Currency Code for the transaction which is USD

String, 3 digits

USD

Yes

beneficiaryAccountName

Full name of the beneficiary account, this can be retrieved from name enquiry endpoint

string

Account Holder

Yes

beneficiaryAccountNumber

Account Number of beneficiary

String | max: 10 digits,

 

no special characters, no space, no alphanumeric

8814648730

Yes

amount

Transaction Amount to be sent to beneficiary

Float | Integer,

 

Must be greater or equal to 1.00,

2 Decimal places

100, 100.20

Yes

narration

Description for transaction, which user will see

String, maxlength: 100 character

E.g “Payment for lunch”

Yes

paymentMethodType

The payment method type supported for this transaction is “AbaRouting”, “BicSwift”

String | ENUM

“AbaRouting” -> local transaction

“BicSwift” -> International transaction

Yes

paymentMethodValue

This is the routing number of the beneficiary account bank, it could (wire, ach, aba, swift) depending on bank

string, all integers, 9 digits

 

BicSwift: 8 digits

If “AbaRouting”: 026073150

 

If “BicSwift”

CMFGUS33

Yes

intermidiaryBankRoutingNumber

This is the routing number of the processing bank

string: 9 digits

026073150

Yes, if paymentMethodType = “BicSwift”

tenantReference

This is your reference linked to the transaction, this will be returned with a prefix

string

If you pass “TYGHR”, it will be returned as “RTDF-TYGHR”, just as an example

Yes

beneficiaryAddress

Address of the beneficiary

string

 

No

beneficiaryCountryIso

Country of the beneficiary: US

string

Iso2: US

Yes

  • No labels

Leatherback 2024