DocumentationRecipesAPI ReferenceChangelog
Documentation
Start typing to search…

Payout Inquiry Response Parameter

📘

Data Attribute Reference

Data Type

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

Mandatory attributes

  • M: Mandatory
  • C: Conditional
  • O: Optional
ParameterData Type/ LengthMandatoryDescription
versionC 5MRequest versionCurrent version 1.2
merchantIDAN 25MMerchant ID provided by 2C2P to merchant
requestIDAN 50MUnique number used to validate requests
  • Duplicate request IDs will be rejected (idempotency ID)
  • Must be in UUID format
UTRAN 25MUnique 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
payoutDateC 10MScheduled payout date
  • In yyyy-MM-dd format
  • If parameter is blank, system will set payoutDate = current date + 2 (T+2)
amountD 16,2MAmount to be transferred
  • In 2-decimal format
currencyA 3MCurrency code
  • Refer to currency code list
beneficiaryNameA 150MBeneficiary name
beneficiaryBankNameC 100CBeneficiary bank name
beneficiaryBankCodeAN 20CBeneficiary bank code
bankReferenceNoC 100OAdditional reference numbers returned from bank
userDefined1C 150OMerchant's defined information
userDefined2C 150OMerchant's defined information
userDefined3C 150OMerchant's defined information
userDefined4C 150OMerchant's defined information
userDefined5C 150OMerchant's defined information
respCodeN 4MResponse Code
respDescC 150MResponse description
remarksC 150CAdditional information. This can be rejection reason or cause from bank.
preferredSofProfileAN 10CAs per provided in payout request
beneficiaryIdAN 50CAs per provided in payout request
beneficiaryTypeC 50C
  • 'DEFAULT' - Default
  • 'BANKACC' - Bank Account Number
  • 'MOBILE' - Mobile Number
  • 'IDN' - ID Number
  • 'CIDN' - Company ID Number
  • 'PPN' - Passport Number
  • 'APN' - Army/Police Number
beneficiaryTypeValueC 50CValue for beneficiaryType based on the type chosen.
preferredProviderC 50CIndicate Preferred Provider if Mobile Number is used for multiple wallets

Updated 6 days ago