Qodex.ai

Payouts and supporting services [Public]

Number of APIs: 11

The Payouts and supporting services collection offers South African merchants a number of financial services, including:

  • Payouts: Batch EFT payments

  • Bank account verification (BANV): Confirm that bank accounts are valid

  • Real-time bank account verification (BANVR): Confirm, in real-time, that bank accounts are valid

  • Check digit verification (CDV): Verify bank account numbers against bank-supplied algorithms to determine if the account numbers fall within a valid range for that bank

  • Beneficiaries: Securely manage beneficiary accounts

API endpoints

The following are the API endpoints for the live and sandbox servers for all the functionality, except beneficiary management:

  • Live: https://www.peachpay.co.za/API/{service}?key={yourkey}

  • Sandbox: https://test.peachpay.co.za/API/{service}?key={yourkey}

For beneficiary management, the following are the API endpoints for the live and sandbox servers:

  • Live: https://api.peachpay.co.za/

  • Sandbox: https://api.test.peachpay.co.za/

Prerequisites

Ensure that you have received the following credentials from support@peachpayments.com:

  • username: It resembles JohSmi01.

  • password: It resembles 73GnZwY6z5cQktz.

  • apiKey: It resembles 3af26eda-223e-4a71-8aa5-b541651fa60z.

The username and password are your credentials used to log in to test.peachpay.co.za or www.peachpay.co.za.

Note: You must be linked to at least one client to use the API.

Fork the environment and collection

To fork the environment from the [Peach Payments workspace]

  1. Navigate to Environments, click View more actions next to the Payouts-Services-Public environment, and click Create a fork.

  2. Enter a fork label, select the workspace to fork to, and click Fork Environment.

To fork the collection from the [Peach Payments workspace]

  1. Navigate to Collections, click View more actions next to the Payouts and supporting services [Public] collection, and click Create a fork.

  2. Enter a fork label, select the workspace to fork to, ensure that Watch original collection is selected, and click Fork Collection.

Configure the environment

To get started:

  1. In your workspace, navigate to Environments and click the forked Payouts-Services-Public environment.

  2. Enter the username, password, and apiKey credentials from the Prerequisites section above into the CURRENT VALUE column.

  3. Select the Payouts-Services-Public option from the environment drop-down list in the upper right of the screen.

  4. Click Save in the upper right of the screen.

Use the Payouts and supporting services API

For more information on testing the Payouts and supporting services API, see the documentation hub.

Initiate a payout

  1. In your forked collection, navigate to Payouts and supporting services [Public] > API > POST Payouts.

  2. Select the Payouts-Services-Public option from the environment drop-down list in the upper right of the screen.

  3. Click Send.

The payout is executed.

Verify a bank account asynchronously

  1. In your forked collection, navigate to Payouts and supporting services [Public] > API > POST Bank Verification - Async.

  2. Select the Payouts-Services-Public option from the environment drop-down list in the upper right of the screen.

  3. Click Send.

The bank account is verified asynchronously.

Verify a bank account in real-time

  1. In your forked collection, navigate to Payouts and supporting services [Public] > API > POST Bank Verification - RealTime.

  2. Select the Payouts-Services-Public option from the environment drop-down list in the upper right of the screen.

  3. Click Send.

The bank account is verified in real-time.

Verify a bank account number

Check digit verification is included in bank account verification but can also be executed independently.

  1. In your forked collection, navigate to Payouts and supporting services [Public] > API > POST CDV.

  2. Select the Payouts-Services-Public option from the environment drop-down list in the upper right of the screen.

  3. Click Send.

The bank account number is validated against bank-supplied algorithms to determine if the account number falls within a valid range for that bank.

Use the Beneficiary management API

The Beneficiary management API enables you to add and search for beneficiaries using either the payments or collections endpoints.

Authenticate for beneficiary management

Before using the Beneficiary management API, you need to authenticate and get an access token.

  1. In your forked collection, navigate to Payouts and supporting services [Public] > api/beneficiaries > Authorisation > POST Authentication.

  2. Select the Payouts-Services-Public option from the environment drop-down list in the upper right of the screen.

  3. Click Send.

You're authenticated and the response includes an access token. This Qodex collection has been configured to use this access token for subsequent calls.

Payments endpoint

This section describes how to use the payments endpoint.

Add beneficiary

  1. In your forked collection, navigate to Payouts and supporting services [Public] > api/beneficiaries > payments > POST Add Beneficiary.

  2. Select the Payouts-Services-Public option from the environment drop-down list in the upper right of the screen.

  3. Click Send.

The beneficiary is added.

Search for beneficiary by client code

  1. In your forked collection, navigate to Payouts and supporting services [Public] > api/beneficiaries > payments > GET Search Beneficiary by Client.

  2. Select the Payouts-Services-Public option from the environment drop-down list in the upper right of the screen.

  3. Click Send.

The beneficiary information is returned.

Search for beneficiary by ID

  1. In your forked collection, navigate to Payouts and supporting services [Public] > api/beneficiaries > payments > GET Search Beneficiary by ID.

  2. Select the Payouts-Services-Public option from the environment drop-down list in the upper right of the screen.

  3. Click Send.

The beneficiary information is returned.

Collections endpoint

This section describes how to use the collections endpoint.

Add beneficiary

  1. In your forked collection, navigate to Payouts and supporting services [Public] > api/beneficiaries > collections > POST Add Beneficiary.

  2. Select the Payouts-Services-Public option from the environment drop-down list in the upper right of the screen.

  3. Click Send.

The beneficiary is added.

Search for beneficiary by client code

  1. In your forked collection, navigate to Payouts and supporting services [Public] > api/beneficiaries > collections > GET Search Beneficiary by Client.

  2. Select the Payouts-Services-Public option from the environment drop-down list in the upper right of the screen.

  3. Click Send.

The beneficiary information is returned.

Search for beneficiary by ID

  1. In your forked collection, navigate to Payouts and supporting services [Public] > api/beneficiaries > collections > GET Search Beneficiary by ID.

  2. Select the Payouts-Services-Public option from the environment drop-down list in the upper right of the screen.

  3. Click Send.

The beneficiary information is returned.

  1. api/beneficiaries-collections - Add Beneficiary POST {{beneficiaryUrl}}/api/beneficiaries/collections

  2. api/beneficiaries-collections - Search Beneficiary by Client GET {{beneficiaryUrl}}/api/beneficiaries/collections/?client=PP{{clientCode}}&service={{serviceCode}}&page=1&pageSize=20

  3. api/beneficiaries-collections - Search Beneficiary by ID GET {{beneficiaryUrl}}/api/beneficiaries/collections/:EntityKey

  4. api/beneficiaries-Authorisation - Authentication POST {{beneficiaryUrl}}/token

  5. API - Payouts POST {{baseUrl}}/API/Payments?key={{apiKey}}

  6. API - Bank Verification - Async POST {{baseUrl}}/API/Verification?key={{apiKey}}

  7. API - Bank Verification - RealTime POST {{baseUrl}}/API/RealtimeVerification?key={{apiKey}}

  8. API - CDV POST {{baseUrl}}/API/CDV?key={{apiKey}}

  9. api/beneficiaries-payments - Add Beneficiary POST {{beneficiaryUrl}}/api/beneficiaries/payments

  10. api/beneficiaries-payments - Search Beneficiary by ID GET {{beneficiaryUrl}}/api/beneficiaries/payments/:EntityKey