Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Version History

Version 1 Next »

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

Request Body

 Request Payload for INR (Indian Rupee)
{
  "currencyCode": "INR",
  "remittersInfo": {
    "remitterAddress": "Demo Account",
    "remitterCountryIso": "IN",
    "remitterDateOfBirth": "1994-03-31",
    "remitterID": "25031971",
    "remitterIDType": "driver",
    "remitterType": "I",
    "remitterFullName": "Demo Account",
    "remitterIDIssueDate": "2023-03-31",
    "remitterIDExpiryDate": "2024-03-31",
    "remitterPhoneNumber": 9566778899
  },
  "beneficiaryAccountName": "Bhavita Maulik Shah",
  "beneficiaryAccountNumber": "918010039955817",
  "beneficiaryContactNo": 9566778899,
  "beneficiaryPIN": null,
  "beneficiaryType": "I",
  "beneficiaryIDType": "DATEOFBIRTH",
  "beneficiaryIDExpiryDate": "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",
  "beneficiaryCity": "PLACE",
  "beneficiaryState": "THERE",
  "beneficiaryZIP": "1212",
  "beneficiaryCountryIso": "IN",
  "transferPurpose": "PC02" 
}

 

 INR Transfer Purpose List
[
    {
      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'],
    },

  ]

 

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,

 

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 “YESBANKALL”

 

YESBANKALL

Yes

paymentMethodValue

The payment value of your transaction, this is IFSC code of the beneficiary bank details

string

UTIB0000327

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

 

 

 

No

beneficiaryLastName

 

 

 

No

beneficiaryState

State of the beneficiary

string

 

No

beneficiaryCity

City of the beneficiary

string

 

No

beneficiaryCountryIso

Country of the beneficiary: IN

string

Iso2, (IN)

Yes

transferPurpose

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

string

PC02

Yes

Always select the Purpose code that matches your remitter type and beneficiary type from the list.

Highlight important information in a panel like this one. To edit this panel's color or style, select one of the options in the menu.

\uD83D\uDCCB Related articles

  • No labels

0 Comments

You are not logged in. Any changes you make will be marked as anonymous. You may want to Log In if you already have an account.
 

Leatherback 2024