Documentation/API/Payments

Payments Service

API reference for processing payments and transfers

VERTEX ENGINE

00

Table of Contents

  1. Transfer EFT RTC

1. Transfer EFT RTC

Initiates an EFT/RTC transfer.

Subject: svc.account.<entity_id>.transfer_eft_rtc

Request

{
  "clientTxId": "string",        // Required - client side tx id to avoid duplicate transactions
  "amount": 0,                   // Required - amount in cents (ie. 1000 == ZAR 10.00)
  "ref": "string",               // Required - reference for the recipient
  "real_time": boolean,          // Required - pay and clear now option
  "own_ref": "string",           // Required - your reference
  "account_number": "string",    // Required - recipient account number
  "branch_code": "string",       // Required - bank branch code
  "name": "string",              // Required - recipient name
  "notification_email": "string" // Optional - must be valid email if provided
}

Required Fields

  • clientTxId - client side tx id to avoid duplicate transactions. These ids are persisted for 15 minutes. Any transaction with the same Id will return an error
  • amount - this amount in an integer in cents (ie. 1000 == ZAR 10.00)
  • ref - reference for the recipient
  • real_time - pay and clear now option
  • own_ref - your reference
  • account_number - recipient account number
  • branch_code - bank branch code
  • name - recipient name

Optional Fields

  • notification_email - must be valid email if provided

Response

{
  "tx_id": "string",
  "amount": "string"
}

Possible Errors

  • 400 Bad Request: Invalid request data | Insufficient funds
  • 401 Unauthorized: Authentication failed
  • 409 Conflict: Duplicate transaction
  • 500 Internal Server Error: Server-side error occurred

Notes

  • The amount field in the request is an integer, while in the response it's a string. Ensure proper handling on the client side.
  • Validate the ref field (length 2-25) and own_ref field (length 2-50) to ensure they meet the length requirements.
Previous: AccountsNext: Cards