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   

Cancel Payout

Status:

Production

Version:

V2

Category:

Remittance Services

Cancel Payout....

Overview

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.

Note that only payouts with received status can be cancelled. Payouts under On Hold status can also be canceled.

https://api-sandbox.network.global

Cancel Payout

Status:

Production

Version:

V2

Category:

Remittance Services
/Remittance/Transaction/V1/CancelPayout
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_cancel_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_CANCEL_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”
bodypreferred_vendor* requiredstring10customer/client's preferred vendor for cross-border services
transaction_reference* requiredstring100Transaction Identifier - client provided (Either payout_id or transaction_reference has to be sent)
payout_id* requiredstring50payout id created in respective systems (Either payout_id or transaction_reference has to be sent)
initiating_client_idstring10Registered Bank ID with respective systems
id_typestring10indicates type of identifier
custom_fieldskeystring100
valuestring100

{
    "NISrvRequest": {
        "request_cancel_payout": {
            "header": {
                "msg_id": "236001",
                "msg_type": "TRANSACTION",
                "msg_function": "REQ_CANCEL_PAYOUT",
                "src_application": "BNK",
                "target_application": "DLOCAL",
                "timestamp": "2024-03-06T11:45:02.366+04:00",
                "bank_id": "NIC"
            },
            "body": {
                "preferred_vendor": "DLOCAL",
                "transaction_reference": "1709306653t",
                "payout_id": "1298123",
                "initiating_client_id": "1298123",
                "id_type": "1298123",
                "custom_fields": [
                    {
                        "key": "",
                        "value": ""
                    }
                ]
            }
        }
    }
}

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

Node TypeTypeLengthDescription
NISrvResponseresponse_cancel_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 - RES_CANCEL_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 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
initiating_client_idstring10registered client ID with respective scheme
payout_idstring50payout id created in respective systems
status_codestring20status description of the transaction
status_descstring1Status code of the transaction
custom_fieldskeystring100
valuestring100

{
    "NISrvResponse": {
        "response_cancel_payout": {
            "header": {
                "msg_id": "236001",
                "msg_type": "TRANSACTION",
                "msg_function": "RES_CANCEL_PAYOUT",
                "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",
                "initiating_client_id": "",
                "payout_id": "1298123",
                "status_code": "0",
                "status_desc": "Success",
                "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.