Get virtual receiving account statement

This let's you fetch a detailed statement of a particular currency virtual account.

Definition

URL
GET https://api-test.instarem.com:4803/api/v1/client/{clientId}/virtual-receiving-account-statement/{virtualReceivingAccountId}

Header Parameters:

Parameter	Description	Type	Required
authorization	Authentication token.	String	*Yes*
content-type	The Content-Type entity header is used to indicate the media type of the resource. Expected values could be application/json or multipart/form-data.	String	*Yes*

Path Parameters:

Parameter	Description	Type	Required
clientId	This is the unique client ID generated by NIUM.	String	*Yes*
virtualReceivingAccountId	Unique virtual receiving account Id.	String	*Yes*

Query Parameters:

Parameter	Description	Type	Required
status	Defines the current state of the transaction and possible are: ALL, IN_PROCESS, APPROVED, REJECTED, REFUNDED.	String	No
start	Start counter for the page.	Number	No
length	Number of records to be determined.	Number	No
transactionId	Transaction to be fetched.	String	No
currencyCode	Currency for which you want to fetch the statement. For ex: USD, SGD	String	No
fromDate	date in YYYY-MM-DD format to be given to fetch transactions from that day. e.g. 2022-03-21	String	No
toDate	date in YYYY-MM-DD format to be given to fetch transactions till that day. e.g. 2022-03-22	String	No

Example Request:

Bash
Javascript
C#

curl --request get \\
--url "https://api-test.instarem.com:4803/api/v1/client/{clientId}/virtual-receiving-account-statement/{virtualReceivingAccountId}?status=&start=&length=&transactionId=&fromDate=&toDate=" \\
--header 'authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE0OTgxMzQ4OTQsImRhdGEiOnsic3ViIjoiNTk0MjNmMzZjZWEyMTQ2OTI2ODczOWE1IiwiY2xpZW50IjoiNTk0MjNmMzZjZWEyMTQ2OTI2ODczOWExIn0sImlhdCI6MTQ5ODA0ODQ5NH0.pevwSDpk-JDNtVIpqFu_m0Xu1UnDVumrAYStcrxf8sM' \\
--header 'content-type: application/json'

var xhr = new XMLHttpRequest();
xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});
xhr.open("get", "https://api-test.instarem.com:4803/api/v1/client/{clientId}/virtual-receiving-account-statement/{virtualReceivingAccountId}?status=&start=&length=&transactionId=&fromDate=&toDate=");
xhr.setRequestHeader("authorization", "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE0OTgxMzQ4OTQsImRhdGEiOnsic3ViIjoiNTk0MjNmMzZjZWEyMTQ2OTI2ODczOWE1IiwiY2xpZW50IjoiNTk0MjNmMzZjZWEyMTQ2OTI2ODczOWExIn0sImlhdCI6MTQ5ODA0ODQ5NH0.pevwSDpk-JDNtVIpqFu_m0Xu1UnDVumrAYStcrxf8sM");
xhr.setRequestHeader("content-type", "application/json");
xhr.send();

var client = new RestClient("https://api-test.instarem.com:4803/api/v1/client/{clientId}/virtual-receiving-account-statement/{virtualReceivingAccountId}?status=&start=&length=&transactionId=&fromDate=&toDate=");
var request = new RestRequest(Method.GET);
request.AddHeader("authorization", "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE0OTgxMzQ4OTQsImRhdGEiOnsic3ViIjoiNTk0MjNmMzZjZWEyMTQ2OTI2ODczOWE1IiwiY2xpZW50IjoiNTk0MjNmMzZjZWEyMTQ2OTI2ODczOWExIn0sImlhdCI6MTQ5ODA0ODQ5NH0.pevwSDpk-JDNtVIpqFu_m0Xu1UnDVumrAYStcrxf8sM");
request.AddHeader("content-type", "application/json");
IRestResponse response = client.Execute(request);

Response:

{
    "currencyCode": "USD",
    "virtualReceivingAccountId": "62616d73-8e19-4522-8eac-e456a68b11ab",
    "virtualAccountNumber": "907654315445678",
    "accountNumber": "227961469275",
    "transactionCountByStatus": {
        "APPROVED": 1,
        "REJECTED": 0,
        "ALL": 3,
        "IN_PROCESS": 1,
        "REFUNDED": 1
    },
    "transactions": [
        {
            "transactionId": "32696a9a-a376-4687-87b0-443231a29dde",
            "status": "IN_PROCESS",
            "subStatus": "RFI_RAISED",
            "content": "Transfer",
            "statusDescription": "In process",
            "transactionReferenceNumber": "0016IT8449488",
            "payerBankCode": "BARCGB22XXX",
            "payerBankId": "BARCGB22XXX",
            "payerName": "SBI Remit Co. LTD",
            "paymentDetail": "CITI",
            "amount": 10000.12,
            "paymentReceivedAt": "2019-08-06T00:00:00",
            "payerAccountNumber": "HLFX11029100808072",
            "paymentRequestId": "PR100799",
            "currencyCode": "USD"
        },
        {
            "transactionId": "b0a01cd7-23be-47bc-a86c-265f32715a01",
            "status": "APPROVED",
            "content": "PR100799",
            "statusDescription": "Transaction Finance approved",
            "transactionReferenceNumber": "I940OJHGFGSGAXXXSN",
            "payerBankCode": "EASCGB22XXX",
            "payerBankId": "EASCGB22XXX",
            "payerName": "SBI Remit Co. LTD",
            "paymentDetail": "CITI",
            "amount": 111,
            "paymentReceivedAt": "2021-02-05T22:49:24.310Z",
            "payerAccountNumber": "BGYD609587665132860",
            "paymentRequestId": "PR001089",
            "currencyCode": "USD"
        },
        {
            "transactionId": "31a01cd7-23be-47bc-a86c-265f32715a91",
            "status": "REFUNDED",
            "content": "PR103231",
            "statusDescription": "Transaction amount is refunded to the payer",
            "transactionReferenceNumber": "X212SASDSS",
            "payerBankCode": "BASCGS11XX",
            "payerBankId": "BASCGS11XX",
            "payerName": "SBI Remit Co. LTD",
            "paymentDetail": "CITI",
            "amount": 2000,
            "paymentReceivedAt": "2021-05-03T22:32:24.310Z",
            "payerAccountNumber": "SAED5394723922",
            "paymentRequestId": null,
            "currencyCode": "USD"
        }
    ]
}

Response Parameters:

Parameter	Description	Type
currencyCode	Returns currency.	String
virtualReceivingAccountId	Unique virtual receiving account Id.	String
virtualAccountNumber	Unique bank account number for a particular currency.	String
accountNumber	Returns 12 digit account number generated by NIUM	String
payerName	It is the name of the payer who is currently tagged to the Virtual Receiving Account.	String
transactionCountByStatus.APPROVED	Status of the transactions APPROVED.	Number
transactionCountByStatus.REJECTED	Status of the transactions REJECTED.	Number
transactionCountByStatus.ALL	Status of the transactions ALL.	Number
transactionCountByStatus.IN_PROCESS	Status of the transactions IN_PROCESS.	Number
transactionCountByStatus.REFUNDED	Status of the transactions REFUNDED	Number
transactions[n].transactionId	Unique uuid generated by NIUM.	String
transactions[n].status	This field defines the current status of the transaction and the value for this could be: - IN_PROCESS - REJECTED - APPROVED - ERROR - REFUNDED	String
transactions[n].subStatus	This field defines the sub-status of the transaction and the value for this could be: - RFI_RAISED - RFI_RESPONDED	String
transactions[n].content	This field holds any remittance information entered by the payment sender in the narrative field of their banking partner NIUM recommends client to quote "paymentRequestId" in narrative Example: PR100799	String
transactions[n].statusDescription	IN_PROCESS: The payment has been received and is in NIUM queue for processing. RFI_RAISED: A request for information or clarification for that transaction raised by NIUM team. RFI_RESPONDED: When requested information/documents are provided by the client for an RFI. APPROVED: The transaction that has been approved by NIUM team and money is updated in corresponding currency wallets. REJECTED: The transaction is rejected by NIUM team. REFUNDED: Transaction is refunded by NIUM team.	String
transactions[n].transactionReferenceNumber	This unique Id is given by the payment senders bank which is a unique reference number of that transaction.	String
transactions[n].payerBankCode	Bank code of the payers bank account from which the payment was made.	String
transactions[n].payerBankId	Bank ID of the payers bank account from which the payment was made. (DEPRECATED)	String
transactions[n].payerName	It is the name of the person who has made a payment in that particular virtual account.	String
transactions[n].paymentDetail	This field defines banking service source. Example: CITI , SEPA	String
transactions[n].amount	Amount received.	Number
transactions[n].paymentReceivedAt	Defines the timestamp of the transaction in the following YYYY-MM-DD HH:MM:SS.UTC+ 00:00 offset.	String
transactions[n].payerAccountNumber	The payer account number.	String
transactions[n].paymentRequestId	PaymentRequestId will be labeled after successful reconciliation of incoming payment with payment request else the value will be null.	String
transactions[n].currencyCode	currencyCode represents the currency of the transaction	String

Definition​

Header Parameters:​

Path Parameters:​

Query Parameters:​

Example Request:​

Response:​

Response Parameters:​

Definition

Header Parameters:

Path Parameters:

Query Parameters:

Example Request:

Response:

Response Parameters: