Sign in

v1

latestOpenAPI 3.0.3Proprietary2026-07-2441103204.8 KB
Bank Account Verification

Create bank account verification request

Start a bank account verification request.

For more information, see the documentation, and for sample calls, see the public Postman collection.

post/merchants/{merchantId}/banv

Path parameters

merchantIdstring required

A unique merchant ID provided by Peach Payments in hexadecimal format.

Example:d0bf5a6a909111f0aabf02d14af18cff

A unique merchant ID provided by Peach Payments.

Request body

accountNumberstring required
accountType'current_cheque_account' | 'savings_account' | 'transmission_account' | 'bond_account' | 'subscription_share' | 'unknown' required
branchCodestring required
idNumberstring required

SAID number, passport number, or company registration. The API strips any '/' or '\' characters before processing.

initialsstring
lastNamestring

Example request

{
  "accountNumber": "123456789012",
  "accountType": "current_cheque_account",
  "branchCode": "123456",
  "idNumber": "123456789012",
  "initials": "JD",
  "lastName": "Sibusiso"
}

Response

The bank account verification request was received and will be processed.

messagestring required
bankVerificationIdstring required

A valid v4 UUID expressed in lowercase with dashes.

status'pending' | 'processing' | 'successful' | 'failed' required

The current status of the bank account verification request.

resultCodestring string required

The result code indicating the status or error of the payout.

Example response

{
  "message": "Bank account verification request submitted",
  "bankVerificationId": "123e4567-e89b-42d3-a456-426614174000",
  "status": "pending",
  "resultCode": "2902.000.001"
}