Payouts
Remittances
Payment page
curl --request GET \
--url https://api.sandbox.pawapay.io/v2/payouts/{payoutId} \
--header 'Authorization: Bearer <token>'{
"status": "FOUND",
"data": {
"payoutId": "8917c345-4791-4285-a416-62f24b6982db",
"status": "COMPLETED",
"amount": "123.00",
"currency": "ZMW",
"country": "ZMB",
"recipient": {
"type": "MMO",
"accountDetails": {
"phoneNumber": "260763456789",
"provider": "MTN_MOMO_ZMB"
}
},
"clientReferenceId": "REF-987654321",
"customerMessage": "From ACME company",
"created": "2020-10-19T08:17:01Z",
"providerTransactionId": "12356789",
"metadata": {
"orderId": "ORD-123456789",
"customerId": "[email protected]"
}
}
}Check payout status
curl --request GET \
--url https://api.sandbox.pawapay.io/v2/payouts/{payoutId} \
--header 'Authorization: Bearer <token>'{
"status": "FOUND",
"data": {
"payoutId": "8917c345-4791-4285-a416-62f24b6982db",
"status": "COMPLETED",
"amount": "123.00",
"currency": "ZMW",
"country": "ZMB",
"recipient": {
"type": "MMO",
"accountDetails": {
"phoneNumber": "260763456789",
"provider": "MTN_MOMO_ZMB"
}
},
"clientReferenceId": "REF-987654321",
"customerMessage": "From ACME company",
"created": "2020-10-19T08:17:01Z",
"providerTransactionId": "12356789",
"metadata": {
"orderId": "ORD-123456789",
"customerId": "[email protected]"
}
}
}payoutId.Authorizations
See Authentication.
Path Parameters
The id of the payout that you are performing this operation on.
36Response
Request has been processed by pawaPay
The result of this operation.
FOUND- The payment was found in pawaPay.NOT_FOUND- The payment was not found in pawaPay.
FOUND, NOT_FOUND Show child attributes
Show child attributes
The unique ID for this payment in pawaPay as specified by you during initiation.
36"f4401bd2-1568-4140-bf2d-eb77d2b2b639"
Possible payout statuses:
ACCEPTED- The payout has been accepted by pawaPay for processing.ENQUEUED- The payout has been accepted, but has been enqueued for processing later. Read more about enqueued payouts.PROCESSING- The payout has been submitted to the provider and is being processed.IN_RECONCILIATION- The payout is being reconciled currently to determine it's final status.COMPLETED- The payout has been successfully processed. This is a final status.FAILED- The payout has been processed, but failed. This is a final status.. SeefailureReasonfor details.
ACCEPTED, ENQUEUED, PROCESSING, IN_RECONCILIATION, COMPLETED, FAILED The amount of the payment.
Amount must follow below requirements or the request will be rejected:
- Not all providers support decimals. Find which ones do from providers or dynamically using active configuration endpoint.
- Transaction limits apply. Find them from the Active Configuration endpoint.
- Leading zeroes are not permitted except where the value is less than 1. For any value less than one, one and only one leading zero must be supplied.
1 - 23"15"
The currency in which the amount is specified.
Format must be the ISO 4217 three character currency code in upper case. Read more from Wikipedia.
Find the supported currencies for the provider.
The active configuration endpoint has all the providers configured for your account together with the supported currencies.
"ZMW"
Details about the customer who is paying or receiving the payment.
Show child attributes
Show child attributes
The type of account involved in the transaction. At the moment, only MMO is supported.
MMO "MMO"
Show child attributes
Show child attributes
The phone number (MSISDN) of the customer paying or receiving payment. The format is described in Wikipedia.
Use predict provider to validate and sanitise the phone number.
Phone number validation has following rules:
- Only digits without whitespaces or any other separators or prefixes like '+'.
- Should not start with zero.
- Country code is mandatory.
- Should not exceed or be less than the valid length of specified country.
"260763456789"
The provider represents the mobile money operator or processor that can process payments.
Find here a list of all the supported providers.
The active configuration endpoint provides the list of provider configured for your account.
You can use the predict provider enpoint to predict the provider to use based on the phone number (MSISDN).
"MTN_MOMO_ZMB"
A short narration for the transaction. Depending on the 'provider', this message may be visible to the customer in the SMS receipt or within their transaction history.
Defaults to your company name as registered on your pawaPay account trimmed to fit the length limitations.
4 - 22"Note of 4 to 22 chars"
The unique ID for this payment assigned by the provider. The customer would see this ID on their SMS receipt and transaction history.
"ABC123"
Show child attributes
Show child attributes
Possible payout failure codes:
PAWAPAY_WALLET_OUT_OF_FUNDS- Your pawaPay wallet does not have enough funds to complete this payout.RECIPIENT_NOT_FOUND- The phone number specified as the receipient does not belong to the provider.WALLET_LIMIT_REACHED- The recipient has reached a limit on their wallet that stops them from being able to accept this payout.MANUALLY_CANCELLED- The payout was enqueued and subsequently cancelled from the pawaPay Dashboard or through the Cancel Enqueued Payout endpoint.UNSPECIFIED_FAILURE- The provider confirmed the payment has failed, but did not provide any information about the reason of the failure.UNKNOWN_ERROR- An unknown error has occured.
PAWAPAY_WALLET_OUT_OF_FUNDS, RECIPIENT_NOT_FOUND, WALLET_LIMIT_REACHED, MANUALLY_CANCELLED, UNSPECIFIED_FAILURE, UNKNOWN_ERROR "WALLET_LIMIT_REACHED"
Description of the reason for this failure
"Recipient's address is blocked"
The metadata that was provided in the original initation request in a JSON object format.
Show child attributes
Show child attributes
Each passed in metadata field will be a property of the metadata JSON object.
{
"orderId": "ORD-123456789",
"customerId": "[email protected]"
}Was this page helpful?