GET
/
payouts
/
{payoutId}
curl --request GET \
  --url https://api.sandbox.pawapay.io/payouts/{payoutId} \
  --header 'Authorization: Bearer <token>'
[
  {
    "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
header
required

See Authentication.

Path Parameters

​
payoutId
string
required

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

Required string length: 36

Response

200
application/json
Request has been processed by pawaPay

The response is of type object[].