Single USD Payout
Last updated
Last updated
To send money to a single bank account, you need a single API. This process requires an active balance where the funds are debited then sent.
Setup an Active Balance for your payouts here
POST
https://staging.moneywaveapp.com/v1/disburse
Destination and transfer details are passed for processing
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Please note additional parameters may be required by specific banks. For example payouts to FCMB require the following parameters - recipientRelationship, recipientOccupataion, senderOccupation and purpose
The ref passed must be unique to prevent double disbursements to the same beneficiary. Preferably the ref used should match a unique customer action, for example a loan ID, settlement ID or charge / payment reference.
Increase timeout settings in your http client to 180 seconds. This ensures you receive an expected response for payouts with long processing times.
After a disburse request is received via API, it is submitted for processing. When completed a response is returned. See the example response in the API snippet above.
A disbursement is successful only when the disburse API response has the value below.
Some USD payouts are asynchronous and would return a response code of 02 indicating Transaction Processing. To receive notification when completed see here
Authorization
string
Authorization Token
x_purpose
string
Payment reason or purpose
x_sender_name
string
Sender Name
x_answer
string
Required for CASHPICKUP
x_secret
string
Required for CASHPICKUP
x_transfer_type
string
ACCOUNT or CASHPICKUP
x_sender_location
string
Sender Country
x_sender_address
string
Sender Address
x_sender_phone
string
Sender Phone Number
x_sender_email
string
Sender Name
x_routing_number
string
Routing Number
x_recipient_address
string
Beneficiary address
x_recipient_email
string
Beneficiary Email
x_recipient_phone
string
Beneficiary Phone Number
x_recipient_name
string
Beneficiary Name
walletUref
string
Specify the source balance
narration
string
Description to appear in bank Statement
ref
string
Unique transaction tracking reference
amount
number
Amount to send
currency
string
Currency of amount to send i.e USD
bankcode
string
Destination Bank
accountNumber
string
Beneficiary account number. For CASHPICKUP pass 0
senderName
string
Sender/Business Name to appear in the bank statement
lock
string
Password required to access active wallet