Page Comparison

This page shows the request payload for NGN (Nigerian Naira) Payout

Panel

bgColor	#FFC400

Request Body

Expand

title	Request Payload for INR NGN (Indian RupeeNigerian Naira)

Code Block

language	json

{

 "currencyCode": "INR",   "remittersInfocurrencyCode": {
    "remitterAddress": "Demo Account""NGN",
    "remitterCountryIsobeneficiaryAccountName": "IN",ACCOUNT HOLDER    "remitterDateOfBirth": "1994-03-31"NAME",
    "remitterIDbeneficiaryAccountNumber": "250319710112345678", // using test account
"remitterIDType": "driver",     "remitterTypeamount": "I"1200,
    "remitterFullNamenarration": "DemoSingle Account",Payout     "remitterIDIssueDate": "2023-03-31NGN example",
    "remitterIDExpiryDatepaymentMethodType": "2024-03-31BankCode",
    "remitterPhoneNumber": 9566778899
  },
  "beneficiaryAccountNamepaymentMethodValue": "Bhavita Maulik Shah999998", // using "beneficiaryAccountNumber": "918010039955817",test value
  "beneficiaryContactNo": 9566778899,   "beneficiaryPINtenantReference": null,
  "beneficiaryType": "I",
  "beneficiaryIDType": "DATEOFBIRTH",{{$randomInt}}",
    "beneficiaryIDExpiryDatebeneficiaryAddress": "2024-03-31",
  "beneficiaryIDIssueDate": "2023-03-31",
  "beneficiaryIDNumber": "25035971",
  "amount": 17,
  "narration": "Single Payout NGN example",
  "paymentMethodType": "YESBANKALL",
  "paymentMethodValue": "UTIB0000327",
  "tenantReference": "{{$randomUUID}}",
  "beneficiaryAddress": "example address",
  "beneficiaryFirstName": "CHI",
  "beneficiaryLastName": "BEE",8916 Str Ave, Woodhaven, United Kingdom",
    "nameEnquiryRef": null,
    "beneficiaryKYCLevel": null,
    "beneficiaryBankVerificationNumber": null,
    "beneficiaryCity": "PLACE"null,
  "beneficiaryState": "THERE",   "beneficiaryZIPbeneficiaryState": "1212"null,
  "beneficiaryCountryIso": "IN",   "transferPurpose": "PC02" 
}

Expand

title	INR Transfer Purpose List

Code Block

language	json

[
    {
      id: 'PC01',
      code: 'PC01',
      description: 'Credit to Non-resident Indian Rupee accounts.',
      remitterType: ['Individual', 'Company'],
      beneficiaryType: ['Individual'],
    },
    {
      id: 'PC02',
      code: 'PC02',
      description: 'Payments to families of Non-resident Indians.',
      remitterType: ['Individual'],
      beneficiaryType: ['Individual'],
    },
    {
      id: 'PC03',
      code: 'PC03',
      description:
        'Payments to insurance companies, mutual funds, and the Postmaster for investments.',
      remitterType: ['Individual'],
      beneficiaryType: ['Company'],
    },
    {
      id: 'PC04',
      code: 'PC04',
      description:
        'Payments to bankers for investments in shares and debentures.',
      remitterType: ['Individual'],
      beneficiaryType: ['Company'],
    },
 
    {
      id: 'PC06',
      code: 'PC06',
      description: 'Payments to educational institutions for fees.',
      remitterType: ['Individual'],
      beneficiaryType: ['Company'],
    },
    {
      id: 'PC07',
      code: 'PC07',
      description: 'Payments to medical institutions for treatment.',
      remitterType: ['Individual'],
      beneficiaryType: ['Company'],
    },
    {
      id: 'PC08',
      code: 'PC08',
      description: 'Payments to hotels for stay.',
      remitterType: ['Individual'],
      beneficiaryType: ['Individual', 'Company'],
    },
    {
      id: 'PC09',
      code: 'PC09',
      description: 'Payments to travel agents for domestic travel bookings.',
      remitterType: ['Individual', 'Company'],
      beneficiaryType: ['Individual', 'Company'],
    },
    {
      id: 'PC10',
      code: 'PC10',
      description: 'Trade transactions up to Rs. 15 lakhs per transaction.',
      remitterType: ['Company'],
      beneficiaryType: ['Individual', 'Company'],
    },
    {
      id: 'PC11',
      code: 'PC11',
      description: 'Payments to utility service providers.',
      remitterType: ['Individual'],
      beneficiaryType: ['Company'],
    },
    {
      id: 'PC12',
      code: 'PC12',
      description: 'Tax payments in India.',
      remitterType: ['Individual'],
      beneficiaryType: ['Company'],
    },
    {
      id: 'PC13',
      code: 'PC13',
      description: 'EMI payments to Banks and NBFCs for loans.',
      remitterType: ['Individual'],
      beneficiaryType: ['Company'],
    },
    {
      id: 'PC14',
      code: 'PC14',
      description: "Remittances to the Prime Minister's National Relief Fund.",
      remitterType: ['Individual', 'Company'],
      beneficiaryType: ['Company'],
    },
    {
      id: 'PC15',
      code: 'PC15',
      description: 'Salary payments.',
      remitterType: ['Company'],
      beneficiaryType: ['Individual'],
    },
    {
      id: 'PC16',
      code: 'PC16',
      description: 'Trade transactions up to Rs. 15 lakhs per transaction.',
      remitterType: ['Company'],
      beneficiaryType: ['Individual', 'Company'],
    },

  ]

beneficiaryZIP": null,
    "beneficiaryCountryIso": null
}

...

Element	Description	Type	Example	Required
`currencyCode`

Iso3: INR

string

INR

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

IN

Yes

remitterFullName

Full name of the remitter

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

Disallowed

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

Yes

remitterID

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(colla pse) pattern(\w+

Yes

beneficiaryContactNo

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

String | integer

9566778899

Yes

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

beneficiaryIDExpiryDate

Expiry date of ID submitted

YYYY-MM-DD

Yes

beneficiaryIDNumber

The ID number on the Identification type of the beneficiary

string | integer

989834

Yes

beneficiaryAddress

Beneficiary address of the receiver

string

Yes

amount

Transaction amount, 2 decimal places

float | integer,

Currency Code for the transaction which is NGN	String, 3 digits	NGN	Yes
`beneficiaryAccountName`	Full name of the beneficiary account, this can be retrieved from name enquiry endpoint	string	Account Holder	Yes
`beneficiaryAccountNumber`	Account Number of beneficiary	String \| 10 digits, no special characters, no space, no alphanumeric	0123456789	Yes
`amount`	Transaction Amount to be sent to beneficiary	Float \| Integer, Must be greater or equal to 1.00,

2

decimal place2000 | 2000.50

Decimal places	100, 100.20	Yes
`narration`

Narration

Description for

your

transaction

string

, which user will see	String, maxlength: 100 character	E.g “Payment for lunch”	Yes
`paymentMethodType`	The payment method type supported for this transaction is

“YESBANKALL”

“BankCode”

String | ENUM

YESBANKALL

“BankCode”	Yes
`paymentMethodValue`

The payment value of your transaction, this is IFSC

This is the value/code of the beneficiary bank

details

string

UTIB0000327

. This can be retrieved from bank list endpoint (Beneficiary bank code)	String, all integers, 6 digits	000004	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

beneficiaryAddress

Address of the beneficiary

string

No

beneficiaryLastName

string

nameEnquiryRef

This can be retrieve from nameEnquiry as “sessionID”

string

"sessionID": "999328240122180450359330640488",

No

beneficiaryState

State of the beneficiary

beneficiaryKYCLevel

No

beneficiaryCity

beneficiaryBankVerificationNumber

City

BVN of the beneficiary

string

account number, this can be retrieved using name enquiry	String, 11 digits	33000000032	No
`beneficiaryCountryIso`	Country of the beneficiary:

IN

NG

string

Iso2

, (IN)

Yes

transferPurpose

The purpose of the transaction, find list on the (add a link to purpose code).

string

PC02

Yes

...

panelIconId	atlassian-warning
panelIcon	:warning:
bgColor	#FFBDAD

: NG

Yes

\uD83D\uDCCB Related articles

...

Version	Old Version 1	New Version 2
Changes made by	Leatherback (Unlicensed)	Leatherback (Unlicensed)
Saved on	Jun 18, 2024	Jun 18, 2024

Versions Compared

Key

\uD83D\uDCCB Related articles