Skip to main content
POST
/
api
/
payouts
cURL
curl --request POST \
  --url https://test.digitaltermination.com/api/payouts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data amount=0.1 \
  --data send_amount=0.1 \
  --data sender_country=GHA \
  --data send_currency=GHS \
  --data sender_first_name=Zeepay \
  --data sender_last_name=Ghana \
  --data receiver_first_name=GODWIN \
  --data receiver_last_name=HOTTOR \
  --data service_type=Wallet \
  --data receiver_msidn=123 \
  --data receiver_country=GHA \
  --data receiver_currency=GHS \
  --data transaction_type=CR \
  --data extr_id=guid-example \
  --data mno=MTN \
  --data callback_url=https://webhook.site/3b3b3b3b-3b3b-3b3b-3b3b-3b3b3b3b3b3b
{
  "code": 411,
  "message": "Transaction is pending response from a third party",
  "zeepay_id": 123456
}
  • For Credit Mobile Wallet Transactions, use service_type as "Wallet".
  • For Bank Account Transactions, use service_type as "Bank" for standard bank transfers.
  • For Cash Pick-up Transactions, use service_type as "Pickup" for cash pick-up services.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/x-www-form-urlencoded
​
amount
integer
required

The amount to credit the mobile wallet

Example:

0.1

​
send_amount
integer
required

The amount to send

Example:

0.1

​
sender_country
string
required

The country code of the sender

Example:

"GHA"

​
send_currency
string
required

The currency code of the sender

Example:

"GHS"

​
sender_first_name
string
required

The first name of the sender

Example:

"Zeepay"

​
sender_last_name
string
required

The last name of the sender

Example:

"Ghana"

​
receiver_first_name
string
required

The first name of the receiver

Example:

"GODWIN"

​
receiver_last_name
string
required

The last name of the receiver

Example:

"HOTTOR"

​
service_type
string
required

The service type

Example:

"Wallet"

​
receiver_msidn
integer
required

The receiver mobile number

​
receiver_country
string
required

The country code of the receiver

Example:

"GHA"

​
receiver_currency
string
required

The currency code of the receiver

Example:

"GHS"

​
transaction_type
string
required

The transaction type

Example:

"CR"

​
extr_id
string
required

The external ID

Example:

"guid-example"

​
mno
string
required

The mobile service provider

Example:

"MTN"

​
callback_url
string

The callback URL (optional)

Example:

"https://webhook.site/3b3b3b3b-3b3b-3b3b-3b3b-3b3b3b3b3b3b"

Response

200 - application/json

Successfully processed the payout request

​
code
number

Static response code indicating the status

Example:

411

​
message
string

This is a response message from the third party

Example:

"Transaction is pending response from a third party"

​
zeepay_id
integer

The Zeepay ID of the transaction

Example:

123456