PApaymentology
Ledger API - Accounts

Generate virtual IBAN

<ul> <li class="docBullet">Generates a virtual IBAN for an account using the rules defined for the client.</li> <li class="docBullet">Currently supports South Africa (ZA) only.</li> </ul>
post/pty/account/v1/accounts/{account_id}/iban

Request

  • Base URL
    https://api.uat.paymentology.com
  • URL
    https://api.uat.paymentology.com/pty/account/v1/accounts/{account_id}/iban
  • Auth
    HTTP bearer

Path parameters

account_idinteger required
Example:479823917

Request body

country'ZA' required

ISO 3166-1 alpha-2 country code.

api_call_unique_identifierstring

Optional unique identifier for correlating or deduplicating this API request. When provided, it is propagated as a correlation ID in downstream events.

account_numberstring

Domestic bank account number (7 to 11 digits, optional).

Example request

{
  "api_call_unique_identifier": "438574845790657485",
  "account_number": "10123456789"
}

Response

Account number generated, or the existing one returned if the account already has one.

account_numberstring required

Generated account number identifier (7 to 11 digits).

branch_codestring required

Branch code of the bank.

bank_namestring required

Name of the bank.

Example response

{
  "account_number": "01234567890",
  "branch_code": "051001",
  "bank_name": "Example Bank"
}

Changes

No recorded changes to this operation across all 1 revision of this API.