Skip to main content
POST
/
v2
/
payouts
Initiate payout
curl --request POST \
  --url https://api.sandbox.pawapay.io/v2/payouts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "payoutId": "f4401bd2-1568-4140-bf2d-eb77d2b2b639",
  "recipient": {
    "type": "MMO",
    "accountDetails": {
      "phoneNumber": "260763456789",
      "provider": "MTN_MOMO_ZMB"
    }
  },
  "clientReferenceId": "INV-123456",
  "customerMessage": "Note of 4 to 22 chars",
  "amount": "15",
  "currency": "ZMW",
  "metadata": [
    {
      "orderId": "ORD-123456789"
    },
    {
      "customerId": "customer@email.com",
      "isPII": true
    }
  ]
}'
{
  "payoutId": "f4401bd2-1568-4140-bf2d-eb77d2b2b639",
  "status": "ACCEPTED",
  "created": "2020-10-19T11:17:01Z"
}
The payout endpoint allows you to pay a customer.

Check the guide!

Follow the step-by-step guide on how to build a payment flow using payouts.
  • This API call is idempotent, which means it is safe to submit a request with the same payoutId multiple times.
  • Duplicate requests with the same payoutId will be ignored with the DUPLICATE_IGNORED status in the response.
  • Since the request can be rejected, you must check the status code in the response for each submitted request. The failureReason in the response will contain information about the reason of the rejection.
Each request can get one of the statuses on initiation:
StatusDescription
ACCEPTEDYesThe payout has been accepted by pawaPay for processing.
REJECTEDNoThe payout has been rejected. See failureReason for details.
DUPLICATE_IGNOREDNoThe payout has been ignored as a duplicate of an already accepted payout. Duplication logic relies upon payoutId.

​
How to find out the final status of this payout?

As the pawaPay Merchant API is an asynchronous API, you can find out the final status of the ACCEPTED payout by either:

Waiting for a callback

If you have configured callbacks, the callback with the final status of the payout will be delivered to your callback URL.

Checking the status

Or poll the Check Payout Status endpoint.
Headers related to signatures must only be included if you have enabled “Only accept signed requests”. Read more about it from the pawaPay Dashboard documentation.

Authorizations

​
Authorization
string
header
required

Headers

​
Content-Digest
string<string>
​
Signature
string<string>
​
Signature-Input
string<string>
​
Accept-Signature
string<string>
​
Accept-Digest
string<string>

Body

application/json
​
payoutId
string<uuid>
required
Required string length: 36
Example:
​
recipient
object
required
​
amount
string
required
Required string length: 1 - 23
Example:
​
currency
string
required
Example:
​
clientReferenceId
string
Example:
​
customerMessage
string
Required string length: 4 - 22
Example:
​
metadata
object[]
Example:

Response

​
payoutId
string<uuid>
required
Required string length: 36
Example:
​
status
enum<string>
required
Available options:
ACCEPTED,
REJECTED,
DUPLICATE_IGNORED
​
created
string<date-time>
Example:
​
failureReason
object