Withdraw Fund

Withdraw API is invoked when the Customer creates a funds withdraw request to the own/beneficiary bank account for a certain amount. Withdraw Request can be tracked using the following callback URL.

Definition

URL

POST https://api-test.instarem.com:4803/api/v1/client/{clientId}/withdrawFund

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

Example Request:

Bash

curl --request post \\
--url "https://api-test.instarem.com:4803/api/v1/client/{clientId}/withdrawFund" \\
--header 'authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE0OTgxMzQ4OTQsImRhdGEiOnsic3ViIjoiNTk0MjNmMzZjZWEyMTQ2OTI2ODczOWE1IiwiY2xpZW50IjoiNTk0MjNmMzZjZWEyMTQ2OTI2ODczOWExIn0sImlhdCI6MTQ5ODA0ODQ5NH0.pevwSDpk-JDNtVIpqFu_m0Xu1UnDVumrAYStcrxf8sM' \\
--header 'content-type: application/json' \\
--data '{
    "clientBankId": "03bd58a0-f726-11ea-ab6c-414e561364fe",
    "withdrawalAmount": "100",
    "accountNumber": 107951243083,
    "requestId": "1XkQkI34DA"
}'

Javascript

var data = JSON.stringify({
    "clientBankId": "03bd58a0-f726-11ea-ab6c-414e561364fe",
    "withdrawalAmount": "100",
    "accountNumber": 107951243083,
    "requestId": "1XkQkI34DA"
});

var xhr = new XMLHttpRequest();
xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});
xhr.open("post", "https://api-test.instarem.com:4803/api/v1/client/{clientId}/withdrawFund");
xhr.setRequestHeader("authorization", "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE0OTgxMzQ4OTQsImRhdGEiOnsic3ViIjoiNTk0MjNmMzZjZWEyMTQ2OTI2ODczOWE1IiwiY2xpZW50IjoiNTk0MjNmMzZjZWEyMTQ2OTI2ODczOWExIn0sImlhdCI6MTQ5ODA0ODQ5NH0.pevwSDpk-JDNtVIpqFu_m0Xu1UnDVumrAYStcrxf8sM");
xhr.setRequestHeader("content-type", "application/json");
xhr.send(data);

C#

var client = new RestClient("https://api-test.instarem.com:4803/api/v1/client/{clientId}/withdrawFund");
var request = new RestRequest(Method.POST);
request.AddHeader("authorization", "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE0OTgxMzQ4OTQsImRhdGEiOnsic3ViIjoiNTk0MjNmMzZjZWEyMTQ2OTI2ODczOWE1IiwiY2xpZW50IjoiNTk0MjNmMzZjZWEyMTQ2OTI2ODczOWExIn0sImlhdCI6MTQ5ODA0ODQ5NH0.pevwSDpk-JDNtVIpqFu_m0Xu1UnDVumrAYStcrxf8sM");
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", @"{
    ""clientBankId"": ""03bd58a0-f726-11ea-ab6c-414e561364fe"",
    ""withdrawalAmount"": ""100"",
    ""accountNumber"": 107951243083,
    ""requestId"": ""1XkQkI34DA""
}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

Body Parameters:

Parameter	Description	Type	Required
clientBankId	Unique bank account id generated by Nium.	String	Yes
withdrawalAmount	Withdrawal amount.	String	Yes
accountNumber	Currency wallet account number from where the withdraw funds was initiated.	Number	Yes
requestId	A unique request ID specified by the client in the request.	String	Yes

Response:

{
    "withdrawFundId": "eb69f945-f507-4767-97da-03ef4fc55dce",
    "requestId": "1XkQkI34DA",
    "status": "AUTO_APPROVED",
    "clientId": "593feb7c7c52bb2357b2df6c",
    "referenceNumber": "FW000985",
    "clientBankId": "6e6b5ad0-f75d-11ea-8ea0-b18b03157cec",
    "accountNumber": 107951243083,
    "withdrawalAmount": "100",
    "paymentId": "DEVPY10262677",
    "subStatus": "",
    "statusDescription": ""
}

Response Parameters:

Parameter	Description	Type
withdrawFundId	Unique transaction ID generated by NIUM.	String
requestId	A unique request ID specified by the client in the request.	String
status	Status of withdraw payment.	String
clientId	This is the unique client ID generated by Nium.	String
referenceNumber	Unique reference number of withdraw payment generated by Nium.	String
clientBankId	Unique bank account id generated by Nium.	String
accountNumber	Currency wallet account number from where the withdraw funds was initiated.	Number
withdrawalAmount	Withdrawal amount.	String
paymentId	Unique paymentId of withdraw payment generated by Nium.	String
subStatus	Withdrawal payment request sub status.	String
statusDescription	Withdrawal payment request status description.	String