PKR Payout
This page shows the request payload for processing PKR Payout.
Request Body
Element | Description | Type | Example | Required |
| Iso3: PKR | string | PKR | Yes |
| This is the Remitter’s address | String, (Only special characters values are restricted) Allowed pattern .'(DOT),'- '(hyphen),: (colon),'{}','@','#',' ?','!'
Disallowed Pattern, \','%','\','/','()',',' |
| Yes |
| This is the date of birth of the remitter (YYYY-MM-DD) | string, date | YYYY-MM-DD | Yes |
| iso2 | strong | PK | Yes |
| 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 |
| 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 \','%','\','/','()',',' |
|
|
| ID Number of the Identification provider | String | integer |
| Yes |
| Type of Identification of remitter | string | PASSPORT, DRIVER LICENSE, etc | Yes |
| 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 |
| Issue date of ID submitted | string | YYYY-MM-DD | Yes |
| Expiry date of ID submitted | string | YYYY-MM-DD | Yes |
| Phone number of remitter, with no space. Mobile Number should have country code appended | String | integer | 9566778899 | Yes |
| The account name of beneficiary | String (Only special characters values are restricted) |
| Yes |
| The account number of beneficiary | string - whiteSpace(collapse) pattern(\w+ |
| Yes |
| Phone number of beneficiary, with no space. Mobile Number should have country code appended | String | integer | 9566778899 | No |
| 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 |
| Type of Identification of remitter | string | PASSPORT, DRIVER LICENSE, etc | Yes |
| Issue date of ID submitted | string | YYYY-MM-DD | Yes |
| Expiry date of ID submitted |
| YYYY-MM-DD | Yes |
| Beneficiary address of the receiver | string |
| Yes |
| Transaction amount, 2 decimal places | float | integer,
Must be greater or equal to 1.00,
2 decimal place | 2000 | 2000.50 | Yes |
| Narration for your transaction | string |
| Yes |
| The payment method type supported for this transaction is “Transfer” | String | ENUM | Transfer | Yes |
| 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 |
| 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 |
| Beneficiary first name | string |
| Yes |
| Beneficiary Last name | string |
| Yes |
| State of the beneficiary | string |
| No |
| City of the beneficiary | string |
| No |
| Country of the beneficiary: PK | string | Iso2, (PK) | Yes |
Related articles
Leatherback 2024