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

Beneficiary Registration Request 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

merchantID

AN 25

M

Merchant ID provided by 2C2P to merchant

requestID

AN 40

M

Unique number used to validate requests

  • Duplicate request IDs will be rejected (idempotency ID)
  • Must be in UUID format
  • Only requires either the “requestID”or “UTR” parameters

idCard

C 50

C

Beneficiary ID Card

accountName

C 10

M

Beneficiary account name

bankCode

N 30

C

Beneficiary bank code

  • Requires if transfer to bank account.

emailAddress

A 50

O

Beneficiary email address

mobileNo

A 50

C

This is personal info and not beneficiary type value

companyId

A 50

O

This is personal info and not beneficiary type value

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

If merchant does not provide this endpoint. Merchant can use query API to check registration status