multipart/form-data
with a stringified JSON payload under the transaction
field.
POST
{{baseURL}}/v1/payout
Header | Value | Required |
---|---|---|
x-api-key | YOUR_API_KEY | ✅ Yes |
Field | Type | Description |
---|---|---|
message | String | Transaction status message |
status | String | Operation status (success /error ) |
Field | Type | Description |
---|---|---|
id | String | Unique transaction ID |
remark | String | Internal reference note |
reason | String | Transaction purpose |
referenceNumber | String | Tracking reference |
type | String | Always SEND |
state | String | Current status |
created | String | ISO 8601 creation time |
processed | String | ISO 8601 processing time |
Field | Type | Description |
---|---|---|
recipient.idType | String | ID type (ID_CARD ) |
recipient.idNumber | String | Government ID number |
recipient.mobileNumber | String | Contact number |
recipient.city | String | Business location |
recipient.address | String | Physical address |
recipient.countryName | String | Country of operation |
recipient.invoiceNo | String | Business invoice reference |
Field | Type | Description |
---|---|---|
account.name | String | Registered company name |
account.accountNumber | String | Corporate account number |
account.type | String | COMPANY |
account.sortCode | String | Bank branch code |
account.bankName | String | Recipient bank name |
Status Code | Meaning | Example Response | How to Handle |
---|---|---|---|
400 | Invalid Bank Details | Invalid sort code for bank | Verify bank routing information |
400 | ID Validation Failed | Invalid business registration ID | Check government-issued ID |
400 | Invalid Transaction PIN | Invalid transaction authorization | Verify 6-digit PIN |
400 | Business Info Mismatch | Account name mismatch with registration | Ensure names match official records |