Request Payload for PKR Payout

Element

Description

Type

Example

Required

currencyCode

Iso3: PKR

string

PKR

Yes

remitterAddress

This is the Remitter’s address

String, (Only special characters values are restricted) Allowed pattern

.'(DOT),'- '(hyphen),: (colon),'{}','@','#',' ?','!'

Disallowed Pattern, \','%','\','/','()',','

Yes

remitterDateofBirth

This is the date of birth of the remitter (YYYY-MM-DD)

string, date

YYYY-MM-DD

Yes

remitterCountryIso

iso2

strong

PK

Yes

remitterFirstName

This is the First name of the remitter

string, (Alphanumeric and only numbers allowed, only special characters values are restricted) - Allowed pattern .'(DOT),'- '(hyphen),: (colon),'{}','@','#',' ?','!'

Disallowed

pattern \','%','\','/','()',','

Yes

remitterLastName

This is the Last Name of the remitter

string, (Alphanumeric and only numbers allowed, only special characters values are restricted) - Allowed pattern .'(DOT),'- '(hyphen),: (colon),'{}','@','#',' ?','!' Disallowed pattern \','%','\','/','()',','

remitterID

 ID Number of the Identification provider

String | integer

Yes

remitterIDType

Type of Identification of remitter

string

PASSPORT, DRIVER LICENSE, etc

Yes

remitterType

This describes the category which the remitter belongs to. This may be an Individual “I” or Corporate “C”.

string

You are required to pass I or C

Yes

remitterIDIssueDate

Issue date of ID submitted

string

YYYY-MM-DD

Yes

remitterIDExpiryDate

Expiry date of ID submitted

string

YYYY-MM-DD

Yes

remitterPhoneNumber

Phone number of remitter, with no space. Mobile Number should have country code appended

String | integer

9566778899

Yes

beneficiaryAccountName

The account name of beneficiary

String (Only special characters values are restricted)

Yes

beneficiaryAccountNumber

The account number of beneficiary

string - whiteSpace(collapse) pattern(\w+

Yes

beneficiaryContactNo

Phone number of beneficiary, with no space. Mobile Number should have country code appended

String | integer

9566778899

No

beneficiaryType

Category which the beneficiary belongs to. This may be an Individual “I” or Corporate “C”.

string

You are required to pass I or C

Yes

beneficiaryIDType

Type of Identification of remitter

string

PASSPORT, DRIVER LICENSE, etc

Yes

beneficiaryIDIssueDate

Issue date of ID submitted

string

YYYY-MM-DD

Yes

beneficiaryIDExpiryDatebeneficiaryIDNumber

Expiry date of ID submitted

YYYY-MM-DD

Yes

beneficiaryAddress

Beneficiary address of the receiver

string

Yes

amount

Transaction amount, 2 decimal places

float | integer,

Must be greater or equal to 1.00,

2 decimal place

2000 | 2000.50

Yes

narration

Narration for your transaction

string

Yes

paymentMethodType

The payment method type supported for this transaction is “Transfer”

String | ENUM

Transfer

Yes

paymentMethodValue

This is the value/code of the beneficiary bank. This can be retrieved from bank list endpoint ( Beneficiary bank code)

string

E,g MIB

Yes

tenantReference

This is your reference linked to the transaction, this will be returned with a prefix

string

If you pass “TYGHR”, it will be returned as “RTDF-TYGHR”, just as an example

Yes

beneficiaryFirstName

Beneficiary first name

string

Yes

beneficiaryLastName

Beneficiary Last name

string

Yes

beneficiaryState

State of the beneficiary

string

No

beneficiaryCity

City of the beneficiary

string

No

beneficiaryCountryIso

Country of the beneficiary: PK

string

Iso2, (PK)

Yes