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.

Version

Get Balance

Status:

Production

Version:

V2

Category:

Remittance Services

Get Balance....

Overview

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

 

 

https://api-sandbox.network.global

Get Balance

Status:

Production

Version:

V2

Category:

Remittance Services
/Remittance/Enquiry/V1/GetBalance
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_get_balanceheadermsg_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_GET_BALANCE
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
initiating_client_idstring35Registered client ID with respective schemes
custom_fieldskeystring100
valuestring100

{
    "NISrvRequest": {
        "request_get_balance": {
            "header": {
                "msg_id": "236001",
                "msg_type": "ENQUIRY",
                "msg_function": "REQ_GET_BALANCE",
                "src_application": "BNK",
                "target_application": "DLOCAL",
                "timestamp": "2024-03-06T11:45:02.366+04:00",
                "bank_id": "NIC"
            },
            "body": {
                "preferred_vendor": "DLOCAL",
                "initiating_client_id": "1298123",
                "custom_fields": [
                    {
                        "key": "",
                        "value": ""
                    }
                ]
            }
        }
    }
}

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

Node TypeTypeLengthDescription

{
    "NISrvResponse": {
        "response_get_balance": {
            "header": {
                "msg_id": "236001",
                "msg_type": "ENQUIRY",
                "msg_function": "RES_GET_BALANCE",
                "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",
                "available_balance": "1000",
                "currency_code": "USD",
                "balance_as_of_date": "2024-03-06",
                "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.