These docs are for v4.0.2. Click to read the latest docs for v4.3.0.

Payout Inquiry Response Parameter

📘

Data Attribute Reference

Data Type

  • A: Alphabet
  • AN: Alphanumeric
  • C: Characters
  • B: Boolean
  • D: Decimal
  • N: Numeric

Mandatory attributes

  • M: Mandatory
  • C: Conditional
  • O: Optional

Parameter

Data Type/ Length

Mandatory

Description

version

C 5

M

Request version

Current version 1.2

requestID

AN 50

M

Unique number used to validate requests

  • Duplicate request IDs will be rejected (idempotency ID)
  • Must be in UUID format

UTR

AN 25

M

Unique transaction reference (UTR) number

  • Will be sent to the Bank (if supported)
  • Default UTR generated (if parameter is blank)
  • Format of generated UTR:
    {PayoutDate:YYMMDD}{SequenceNumber:N16}
  • Sample generated UTR: 2105211234567890123456

payoutDate

C 10

M

Scheduled payout date

  • In dd/MM/yyyy format
  • If parameter is blank, system will set payoutDate = current date + 2 (T+2)

amount

D 16,2

M

Amount to be transferred

  • In 2-decimal format

currency

A 3

M

Currency code

beneficiaryName

A 150

O

Beneficiary name

beneficiaryBankName

C 100

O

Beneficiary bank name

beneficiaryBankCode

AN 10

O

Beneficiary bank code

beneficiaryEmail

AN 150

O

Beneficiary email address

userDefined1

C 150

O

Merchant’s defined information

userDefined2

C 150

O

Merchant’s defined information

userDefined3

C 150

O

Merchant’s defined information

userDefined4

C 150

O

Merchant’s defined information

userDefined5

C 150

O

Merchant’s defined information

respCode

N 4

M

Response Code

respDesc

C 150

M

Response description