Payout to bank
This endpoint is used to initiate a payout process. It allows users to specify the amount to be paid out, the country for the transaction, and a narration for reference.
POST /v1/payment/payouts/process
Headers
secret-key
string
Your Alexpay secret key
public-key
string
Your Alexpay public-key
Request body
amount (integer): The amount of money to be processed for the payout. This value must be a positive integer.
countryId (string): A unique identifier for the country where the payout is being processed. This should correspond to a valid country ID.
narration (string: optional): A brief description or note regarding the payout. This helps in identifying the purpose of the transaction.
transfer_to(string: required): In the case bank.
bank_id: A unique identifier for the bank where the payout is being processed to. This should correspond to a valid bank ID.
account_number:(string: required)
webhook_url(sting: optional):
Request
For example, you can make a post request to the endpoint above and pass in the raw json data bellow.
Payout to banks
{
"amount": 1,
"countryId": "{{ghana_country_id}}",
"narration": "Invoice payment",
"webhook_url": "{{webhook_url}}",
"transfer_to": "bank",
"bank_id": "e2638454-bd13-5***********",
"account_number": "********8"
}Request body
On a successful request, the API will return a response with the following structure:
status (string): The status of the payout request. This may provide additional context on the transaction's result.
code (integer): A numerical code indicating the outcome of the request. A code of 0 typically indicates success.
message (string): A message providing further details about the request status.
data (object): An object containing additional details about the payout, including:
amount (integer): The amount processed in the payout.
payout_id (string): A unique identifier for the payout transaction.
status (string): The current status of the payout.
Last updated