Developer ZoneRecipesAPI ReferenceChangelog
Developer Zone

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)

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

preferredSofProfile

AN 10

O

SoF Code as preferred

beneficiaryId

AN 50

C

Registered beneficiary ID

beneficiaryType

C 50

C

Type of beneficiary account which is used with beneficiaryTypeValue.

  • 'DEFAULT' - Default
  • 'BANKACC' - Bank Account Number
  • 'MOBILE' - Mobile Number
  • 'IDN' - ID Number
  • 'CIDN' - Company ID Number
  • 'PPN' - Passport Number
  • 'APN' - Army/Police Number

beneficiaryTypeValue

C 50

C

Value for beneficiaryType based on the type chosen.

preferredProvider

C 50

C

Indicate Preferred Provider if Mobile Number is used for multiple wallets.
Note: Applicable for Malaysia and Thailand only

notificationUrl

C 255

O

Merchant’s notification URL to receive payout notification callback