Remittance Services

Card Services

Overview

Our remittance solution provides the facility to initiate cross-border remittance from any sender’s card/account/wallet (via internet/mobile banking) to Recipient bank accounts/digital wallets.  
This solution works for P2P(person-to-person)/A2A(Account-to-account) cross-border payments.

Download
Version
Create Payout(Post)

The Create Payout API can be used to create the payout transaction to initiate the cross-border remittance payouts via NI.

Status :Production
Version : V2
Try Out   
Get Exchange Rate (Post)

This service will return real-time exchange rate to be used for calculating the source to destination currency conversion.

Status :Production
Version : V2
Try Out   
Get Payout (Post)

This service is used to obtain the payout details and latest status of the payout submitted with the payment vendors. It allows Originators to query the real time processing status of account and wallet transactions.

Status :Production
Version : V2
Try Out   
Cancel Payout(Post)

This service is used to cancel a payout transaction. Originator request to cancel a transaction and stop a payment where the sender sent to an incorrect recipient or wrong amount in the payout instruction or sent a duplicate payout in error.

Status :Production
Version : V2
Try Out   
Release Payout (Post)

This service is used to release a payout from On-hold status so that it can be processed.

Status :Production
Version : V2
Try Out   
Get Balance (Post)

This service can be used by banks to check the available balance on prefunding account with selected vendor.

Status :Production
Version : V2
Try Out   
Get Receipt(Post)

This service brings the receipt details of a completed payout based on the payout ID or the external ID. Currently only supported for bank transfers.

Status :Production
Version : V2
Try Out   
Get Conversion Rate(Post)

This service returns the exchange rate of the given currency.

Status :Production
Version : V2
Try Out   
Funds Transfer Inquiry(Post)

Funds Transfer Inquiry.

Status :Production
Version : V2
Try Out   
Create Funds Transaction(Post)

This service returns the fund transaction status.

Status :Production
Version : V2
Try Out   
Funds Transaction Query(Post)

This service returns the status of fund transaction.

Status :Production
Version : V2
Try Out   
Alias Resolve(Post)

Retrieve information about an Alias and the payment credential(s) associated with the Alias.

Status :Production
Version : V2
Try Out   
Alias Inquiry(Post)

This enables clients to check if an Alias or list of Aliases is available for Alias resolution. The response will indicate the Aliases that are available for Alias resolution. Up to 1000 Aliases can be sent in a single request.

Status :Production
Version : V2
Try Out   

Create Payout

Status:

Production

Version:

V2

Category:

Remittance Services

Create Payout....

Overview

The Create Payout API can be used to create the payout transaction to initiate the cross-border remittance payouts via NI. This service is used to create and submit the payout to either bank account or UPI ID or mobile wallet in destination corridors.

This request is used to create the transaction with the money transfer values from the quotation received, and further input details for the transfer, beneficiary, and account details for instance.

Depending on each country’s bank compliance requirements, some additional fields might be mandatory when sending payouts.

Create new payout

API allows financial institutions to submit the payout to either bank account or UPI ID or mobile wallet in destination corridors.

Flexible data structure

Depending on each country’s bank compliance requirements, some additional fields might be mandatory when sending payouts.

Hierarchical organization

This request is used to create the transaction with the money transfer values from the quotation received, and further input details for the transfer, beneficiary, and account details for instance.

Create Payout

Status:

Production

Version:

V2

Category:

Remittance Services
/Remittance/Transaction/V1/CreatePayout
curl --location --request POST '#{PARAM_URL}' --header 'Authorization: Bearer {{ access_token }}' {custom_headers} --data-raw '#{JSON_PAYLOAD}'
curl --location --request GET 'https://api-sandbox.network.global/v1/tokenkc/generate' \--data-raw '#{JSON_PAYLOAD}'
curl --location --request POST 'https://api-sandbox.network.global/v1/tokenkc/generate' \--data-raw '#{JSON_PAYLOAD}'

Node Child Node Type Length Description
Authorization* requiredBearer xxxx* requiredstringAuthorization Header (Bearer Token)
Content-Type* requiredapplication/json* requiredstringContent Type

Node TypeTypeLengthDescription
NISrvRequestrequest_create_payoutheadermsg_id* requiredstring12Message ID, this field should be unique id for each Api call. This will be generated from client side. If the same message ID is used the system will decline the API call with Error Description “Duplicate Message ID”
msg_type* requiredstring12Message Type – This can have either “TRANSACTION” or “ENQUIRY” As for this API the value expected is “ENQUIRY”
msg_function* requiredstring50Static Value - REQ_CREATE_PAYOUT
src_application* requiredstring10Source Application: This is a free Text and the client can populate the source system from where the API is Initiated Example: IVR, IB, MB No Validations of these are kept at Network Systems
target_application* requiredstring10The target_application can hold any value from FI side, this can be used by FI to check the target system of the API call
timestamp* requiredstring30Timestamp of the request - Format YYYY-MM-DDtHH:MM:SS.SSS+04:00
bank_id* requiredstring4Bank Id is Unique Id 4 digit code for each client and the same will be provided once the client setup is completed in our core system. For sandbox testing – Please use “NIC”
bodytransaction_reference* requiredstring10Transaction Identifier - client provided
recipient_account* requiredstring110beneficiary account number(IBAN or BAN) /wallet ID/UPI ID
recipient_account_type* requiredstring20Account type - Checking/Savings/wallet/UPI
payout_amount* requiredstring20payout amount
payout_currency* requiredstring3payout amount currency
origination_country* requiredstring3country in which payout is initiated
recipient_bank_namestring140Name of the Bank holding the receiving account
recipient_bank_branch_namestring140Name of the Bank branch holding the receiving account
recipient_bank_branch_codestring45Beneficiary's bank branch code
recipient_bank_code* requiredstring12bank code associated with the bank name - bank identification code (BIC) (Required for Account transfers only)
recipient_bank_code_typestring15Baneficiary bank account bank code type
recipient_bank_bicstring11Baneficiary bank account Business Identifier Code(BIC)
payment_typestring3Type of payout transaction initiated - A2A, P2P
source_of_fundsstring35sender's source of funds (Required for MC & Visa only)
sender_typestring1type of sender (Required for Visa only)
sender_account_numberstring200Sender account number
sender_first_name* requiredstring140Sender 's first name
sender_last_name* requiredstring140Sender 's last name
sender_address_line1* requiredstring500Sender 's address line1 (Required for MC & VisaDirect only)
sender_address_line2string500Sender 's address line2 (Required for dLocal & VisaDirect only)
sender_address_city* requiredstring35Sender 's address city (Required for dLocal & VisaDirect only)
sender_address_postalcodestring16Sender 's address postal code (Required for MC & VisaDirect only)
sender_address_statestring25Sender 's address state (Required for VisaDirect only)
sender_address_countrystring3Sender 's address country (Required for MC & VisaDirect only)
recipient_typestring1type of recipient (Required for VisaDirect only)
recipient_first_name* requiredstring70Beneficiary's bank account name
recipient_last_name* requiredstring70Recipient's last name
recipient_address_line1string500recipient 's address line1 (Required for MC & VisaDirect only)
recipient_address_line2string500recipient 's address line2 (Required for MC & VisaDirect only)
recipient_address_citystring35recipient 's address city (Required for VisaDirect only)
recipient_address_postalcodestring16recipient 's address postal code (Required for VisaDirect only)
recipient_address_statestring25recipient 's address state (Required for VisaDirect only)
recipient_address_countrystring3recipient 's address country (Required for MC & VisaDirect only)
recipient_country_of_birthstring3recipient 's country of birth (Required for VisaDirect only)
recipient_dobstring10Recipient 's date of birth (Required for VisaDirect only)
recipient_id_typestring10Recipent identification type
recipient_id_numberstring35Recipent identification number
recipient_phone* requiredstring30recipient's contact number (Required for dLocal only)
recipient_mail* requiredstring210recipient's email address (Required for dLocal only)
intiating_client_idstring20Identifier assigned by Visa to uniquely identify the originating entity (Required for VisaDirect only)
payout_methodstring1payout method to indicate account or wallet (Required for VisaDirect only)
preferred_vendorstring10customer/client's preferred vendor for cross-border services
recipient_bank_account_namestring70Beneficiary bank account name
recipient_account_country_codestring3Beneficiary bank account country code (Required for VisaDirect only)
recipient_account_currency_codestring3Beneficiary bank account currency code
recipient_wallet_operator_namestring20identifies the operator that has issued the recipient's account and is going to receive and post to recipient's wallet (Required for VisaDirect only)
sender_country_of_birthstring3Sender 's country of birth (Required for VisaDirect only)
sender_dob* requiredstring10Sender 's date of birth (Required for dLocal & VisaDirect only)
sender_nationality* requiredstring3Sender 's country of birth (Required for dLocal only)
purpose_of_payment* requiredstring39Purpose of payment is required in certain markets to clearly identify the purpose of the payment
custom_fieldskeystring100
valuestring100

{
    "NISrvRequest": {
        "request_create_payout": {
            "header": {
                "msg_id": "236001",
                "msg_type": "TRANSACTION",
                "msg_function": "REQ_CREATE_PAYOUT",
                "src_application": "BNK",
                "target_application": "DLOCAL",
                "timestamp": "2024-03-06T11:45:02.366+04:00",
                "bank_id": "NIC"
            },
            "body": {
                "transaction_reference": "1709306653t",
                "recipient_account": "",
                "recipient_account_type": "",
                "payout_amount": "",
                "payout_currency": "",
                "origination_country": "",
                "recipient_bank_name": "",
                "recipient_bank_branch_name": "",
                "recipient_bank_branch_code": "",
                "recipient_bank_code": "",
                "recipient_bank_code_type": "",
                "recipient_bank_bic": "",
                "payment_type": "",
                "source_of_funds": "",
                "sender_type": "",
                "sender_account_number": "",
                "sender_first_name": "",
                "sender_last_name": "",
                "sender_address_line1": "",
                "sender_address_line2": "",
                "sender_address_city": "",
                "sender_address_postalcode": "",
                "sender_address_state": "",
                "sender_address_country": "",
                "recipient_type": "",
                "recipient_first_name": "",
                "recipient_last_name": "",
                "recipient_address_line1": "",
                "recipient_address_line2": "",
                "recipient_address_city": "",
                "recipient_address_postalcode": "",
                "recipient_address_state": "",
                "recipient_address_country": "",
                "recipient_country_of_birth": "",
                "recipient_dob": "",
                "recipient_id_type": "",
                "recipient_id_number": "",
                "recipient_phone": "",
                "recipient_mail": "",
                "intiating_client_id": "",
                "payout_method": "",
                "preferred_vendor": "DLOCAL",
                "recipient_bank_account_name": "",
                "recipient_account_country_code": "",
                "recipient_account_currency_code": "",
                "recipient_wallet_operator_name": "",
                "sender_country_of_birth": "",
                "sender_dob": "",
                "sender_nationality": "",
                "purpose_of_payment": "",
                "custom_fields": [
                    {
                        "key": "",
                        "value": ""
                    }
                ]
            }
        }
    }
}

Node Child Node Type Length Description
Content-Typeapplication/jsonstringContent Type

Node TypeTypeLengthDescription
NISrvResponseresponse_get_receiptheadermsg_id* requiredstring12Message ID, this field should be unique id for each Api call. This will be generated from client side. If the same message ID is used the system will decline the API call with Error Description “Duplicate Message ID”
msg_type* requiredstring12Message Type – This can have either “TRANSACTION” or “ENQUIRY” As for this API the value expected is “ENQUIRY”
msg_function* requiredstring50Static Value - RES_GET_RECEIPT
src_application* requiredstring10Source Application: This is a free Text and the client can populate the source system from where the API is Initiated Example: IVR, IB, MB No Validations of these are kept at Network Systems
target_application* requiredstring10The target_application can hold any value from FI side, this can be used by FI to check the target system of the API call
timestamp* requiredstring30Timestamp of the response Date & time Format DD/MM/YYYY HH:MM:SS
bank_id* requiredstring4Bank Id is Unique Id 4 digit code for each client and the same will be provided once the client setup is completed in our core system. For sandbox testing – Please use “NIC”
exception_detailsapplication_name* requiredstring20Application Name
date_time* requiredstring30Timestamp of the response Format “YYYY-MM-DD HH:MM:SS”
status* requiredstring1Status of the request (S/F)
error_code* requiredstring4EAI Internal Error Code (Check error codes section for the complete list of error codes and error code descriptions)
error_description* requiredstring100Error Description (Check error codes section for the complete list of error codes and error code descriptions)
transaction_ref_idstring20The tracking_id sent in the request will be sent back in response in this field.
bodypreferred_vendorstring10customer/client's preferred vendor for cross-border services
transaction_referencestring100Transaction Identifier - client provided
payout_idstring50unique identifier generated by each system to idenitify the transaction
receipt_datestring4date of the receipt Date & Time (UTC)
countrystring3recipient country
amountstring20amount credited to beneficiary's bank account
currencystring3currency code of the transaction amount
payment_datestring25Date of the Payment Date & Time (UTC)
processing_idstring10Processing ID
beneficiary_namestring50Name of the beneficiary
payment_methodstring32payment method used - bank_transfer
bank_namestring140Name of the beneficiary's bank
bank_branchstring140Name of the bank branch
bank_accountstring210Bank Account number
wallet_idstring210Wallet ID
custom_fieldskeystring100
valuestring100

{
    "NISrvResponse": {
        "response_get_receipt": {
            "header": {
                "msg_id": "236001",
                "msg_type": "ENQUIRY",
                "msg_function": "RES_GET_RECEIPT",
                "src_application": "BNK",
                "target_application": "DLOCAL",
                "timestamp": "2024-03-06T11:50:02.366+04:00",
                "bank_id": "NIC"
            },
            "exception_details": {
                "application_name": "TCC-ADP",
                "date_time": "2023-02-01T16:39:47.314+04:00",
                "status": "S",
                "error_code": "000",
                "error_description": "Success",
                "transaction_ref_id": "236001"
            },
            "body": {
                "preferred_vendor": "DLOCAL",
                "transaction_reference": "1709306653t",
                "payout_id": "1298123",
                "receipt_date": "0323",
                "country": "IN",
                "amount": "900",
                "currency": "INR",
                "payment_date": "2024-03-01T15:44:21Z[UTC]",
                "processing_id": "32432424",
                "beneficiary_name": "Siva Sankar",
                "payment_method": "bank_transfer",
                "bank_name": "HDFC",
                "bank_branch": "HDFC",
                "bank_account": "12345678912",
                "wallet_id": "4234242",
                "custom_fields": [
                    {
                        "key": "",
                        "value": ""
                    }
                ]
            }
        }
    }
}

Code Description
200Sample Description
400Bad Request
401Unauthorized
403Forbidden
500Internal Server Error
502Bad gateway
503Scheduled Maintenance
504Gateway Timeout
596Service Not Found

How It Works

Follow the steps below. For more details, read the Quick Start Guide.

1- Process 1

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Amet, sed at amet cras fringilla adipiscing nunc, in pulvinar. Sagittis pellentesque leo et proin convallis justo vitae in.

2- Process 1

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Amet, sed at amet cras fringilla adipiscing nunc, in pulvinar. Sagittis pellentesque leo et proin convallis justo vitae in.

3- Process 1

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Amet, sed at amet cras fringilla adipiscing nunc, in pulvinar. Sagittis pellentesque leo et proin convallis justo vitae in.

4- Process 1

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Amet, sed at amet cras fringilla adipiscing nunc, in pulvinar. Sagittis pellentesque leo et proin convallis justo vitae in.

5- Process 1

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Amet, sed at amet cras fringilla adipiscing nunc, in pulvinar. Sagittis pellentesque leo et proin convallis justo vitae in.