Check Payout status using API (recommended)

Even though this step is optional, we highly recommend it to ensure that responses received reflect the correct transaction status. This will eliminate the chance that anyone is able to spoof the Ozow response to update a transaction status on the merchant site.

Each API call needs an http header value with the merchant's API key. The following API methods can be used to check the transaction status:

• GetPayout
• GetPayoutByReference

GetPayout

{baseUrl}/getpayout?payoutId={payoutId}

❗

Before you start

N.B. Please ensure that the relevant SiteCode and ApiKey are included in the headers for all requests to the Payouts endpoints

This method is called when you want to query a payout using the payoutId.

GetPayoutByReference

{baseUrl}/getpayoutbyreference

❗

Before you start

N.B. Please ensure that the relevant SiteCode and ApiKey are included in the headers for all requests to the Payouts endpoints

This method is called when you want to query a payout using the MerchantReference or CustomerBankReference.

Post Variables

Response

Payout - a successful call will return a payout object. The payout object is described further down.

{
    "id": "00000000-0000-0000-0000-000000000000",
    "amount": 0.01,
    "merchantReference": "123",
    "customerBankReference": "ABC123",
    "siteCode": "[YOUR SITE CODE]",
    "notifyUrl": "https://requestcatcher.com/",
    "isRtc": false,
    "bankingDetails": {
        "bankGroupId": "13999FA-3A32-4E3D-82F0-A1DF7E9E4F7B",
        "branchCode": "198765",
        "accountNumber": "ff313a955ad9a8ddff32cb734d49fbcddd8eeb1e235009d59a801bc5af78270cfd"
    },
    "payoutStatus": {
        "status": 5,
        "subStatus": 0,
        "errorMessage": "this field may contain an error if the status is not complete"
    }
}

Payout object

This is the object referred to in the response of the API calls above.

BankDetailsObject

Payout Status