Payout Request 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

merchantID

AN 25

M

Merchant ID provided by 2C2P to merchant.

beneficiaryName

A 150

M

Beneficiary name

amount

D 16,2

M

Amount to be transferred

  • In 2-decimal format

beneficiaryBankCode

AN 20

M

Beneficiary bank code

requestID

AN 40

M

Unique number used to validate requests

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

UTR

AN 22

O

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

O

Scheduled payout date

  • In dd/MM/yyyy format
  • If parameter is blank, system will set payoutDate = current date + 2 (T+2)
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
preferredSofProfileAN 10OSoF Code as preferred
beneficiaryIdAN 50CRegistered beneficiary ID
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
notificationUrlC 255OMerchant’s notification URL to receive payout notification callback

Updated about 1 month ago