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

Beneficiary Registration Response Parameters

📘

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

requestId

AN 40

M

As per provided in beneficiary registration request

beneficiaryId

AN 50

C

Unique string generated by 2C2P

accountName

C 10

M

As per provided in beneficiary registration request

emailAddress

A 50

O

As per provided in beneficiary registration request

mobileNo

A 50

C

As per provided in beneficiary registration request

bankCode

N 30

C

As per provided in beneficiary registration request

merchantId

AN 25

C

As per provided in beneficiary registration request

idCard

C 50

C

As per provided in beneficiary registration request

companyId

A 50

O

As per provided in beneficiary registration request

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. To be used with beneficiaryType

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

notificationUrl

A 200

O

As per provided in beneficiary registration request

respCode

N 4

M

See Payout Response Code

respDesc

C 150

M

See Payout Response Code

Remarks

C 150

C

Send in notification callback only when registration is not success

Notification HTTP Header

Variable

Data Type/ Length

Mandatory

Description

x-notify-event

AN 15

M

Notification event name: register-beneficiary

x-signature

AN 30

M

Notification signature: Hmac256 raw http body with merchant secret key