GET
/
payouts
/
{payoutId}
[
  {
    "payoutId": "8917c345-4791-4285-a416-62f24b6982db",
    "status": "COMPLETED",
    "amount": "123.45",
    "currency": "ZMW",
    "country": "ZMB",
    "correspondent": "MTN_MOMO_ZMB",
    "recipient": {
      "type": "MSISDN",
      "address": {
        "value": "260763456789"
      }
    },
    "customerTimestamp": "2020-10-19T08:17:00Z",
    "statementDescription": "From ACME company",
    "created": "2020-10-19T08:17:01Z",
    "receivedByRecipient": "2020-10-19T08:17:02Z",
    "correspondentIds": {
      "SOME_CORRESPONDENT_ID": "12356789"
    },
    "metadata": {
      "orderId": "ORD-123456789",
      "customerId": "customer@email.com"
    }
  }
]

Get payout status by the payoutId from your initial payout request. A list with at most one Payout is returned.

This operation can be used to confirm the current status of a payout.

Authorizations

Authorization
string
headerrequired

See Authentication.

Path Parameters

payoutId
string
required

The payoutId of the payout you want to check the status of.

Response

200 - application/json
payoutId
string
required

The payoutId which was used to initiate this payout.

status
enum<string>
required

Possible payout statuses:

  • ACCEPTED - The payout request has been accepted by pawaPay for processing.
  • ENQUEUED - The payout request has been accepted, but has been enqueued for processing later. Read more about enqueued payouts.
  • SUBMITTED - The payout request has been submitted to the MMO and is being processed.
  • COMPLETED - The payout request has been successfully processed. This is a Final state.
  • FAILED - The payout request has been processed, but failed. Final state.
Available options:
ACCEPTED,
SUBMITTED,
ENQUEUED,
COMPLETED,
FAILED
amount
string
required

The amount to be collected (deposit) or disbursed (payout or refund).

Amount must follow below requirements or the request will be rejected:

  • Between zero and two decimal places can be supplied, depending on what the specific MMO supports. Learn about all MMO supported decimal places.
  • The minimum and maximum amount depends on the limits of the specific MMO. You can 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.
  • Trailing zeroes are permitted.

Valid examples: 5, 5.0, 5.00, 5.5, 5.55, 5555555, 0.5

Not valid examples: 5., 5.555, 5555555555555555555, .5, -5.5, 00.5, 00.00, 00001.32

currency
string
required

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.

You can find all the supported currencies that the specific correspondent supports from here.

The active configuration endpoint provides the list of correspondents configured for your account together with the currencies.

country
string
required

The country in which the MMO operates.

Format is ISO 3166-1 alpha-3, three character country code in upper case. Read more from Wikipedia.

correspondent
string
required

The correspondent code refers to the specific MMO that the specified phone number (MSISDN) has an active mobile money wallet with.

You can find all the supported correspondents listed here.

The active configuration endpoint provides the list of correspondents configured for your account.

You can use the predict correspondent enpoint to predict the correct correspondent to use based on the phone number (MSISDN).

recipient
object
required

The phone number (MSISDN) of the recipient or payer must be specified as the value of the address.

customerTimestamp
string
required

The timestamp for when you initiated the payout process. Format defined by 'date-time' in RFC3339 section 5.6 from IETF.

statementDescription
string

Short description for the transaction. Depending on the specific MMO performing the transaction this message may be visible to the customer in the SMS receipt or within their transaction history.

Must be between 4 and 22 alphanumeric characters.

created
string
required

The timestamp of when the payout was created in the pawaPay platform. Format defined by 'date-time' in RFC3339 section 5.6 from IETF.

receivedByRecipient
string

When the payment was received by the recipient. Format defined by 'date-time' in RFC3339 section 5.6 from IETF.

correspondentIds
object

The unique ID for this financial transaction assigned by the MMO.

failureReason
object
metadata
object

The metadata that was provided in the original initation request in a JSON object format.

Request payoutResend payout callback