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 method can be used to check the transaction status:

• GetPayout

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.

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": "Complete"
    }
}

Payout object

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

BankDetailsObject

Payout Status

TestConfigurationModel

To test the different outcomes a payout request may have, a merchant will be required to configure the various outcomes that a payout request may incur based on the setting configured. Below are the two API calls that provide the Get and Set methods for access to changing the TestConfigurationModel.

Get configuration.

{baseUrl}/gettestconfiguration?siteCode={siteCode}

When this method is called, the required parameter is the SiteCode of the merchant that returns the state of the configuration set by the merchant. This method can return a null object or return the current settings set for the merchant site. A null reference means the merchant has not yet set a test configuration setting.

Response model: refer to table below

Set configuration

{baseUrl}/settestconfiguration

When this method is called, the merchant sets new settings or updates the current settings that will impact the result set to expect when a payout request is made. The purpose of this method is to mock the outcome of the payouts, marking the given fields as true in order to produce an expected outcome in the process of making a payout.

🚧

Constraint:

A valid method call only happens when one field is set to true. This prevents the expected outcome from only generating a response for one instance at a time. If all fields are marked as false for the test configuration model, the mock outcome will be the default payout request and a complete payout request journey will be undertaken.

❗

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

Parameters