Currency Account Credit

This is a webhook that gets triggered when funding credits are applied to a client's currency wallet.

Definition

URL

https://<customerHost:Port>/webhook

Headers:

Field	Description
Content-Type	The Content-Type entity header is used to indicate the media type of the resource. Expected value is application/json.
x-api-key	f9be0d9e-6903-4862-8d69-5b2651426bf9

Example Request:

Bash

curl --location --request POST 'https://<customerHost:Port>/webhook' \\
--header 'Content-Type: application/json' \\
--header 'x-api-key: f9be0d9e-6903-4862-8d69-5b2651426bf9' \\
--data-raw '{
    "client_id": "593feb7c7c52bb2357b2df6c",
    "account_number": "107950258295",
    "currency_code": "EUR",
    "amount": 100,
    "status": "SUCCESS",
    "funding_id": "PREPF10545759",
    "gl_reference_number": "1629183106811715",
    "event": "FUNDING_UPDATE",
    "remark": "fdg | Bank of Lithuania - LT593590010000000000 - EUR - Lithuania",
    "timestamp": "2021-08-05T10:01:07.236Z"
}'

Javascript

var settings = {
  "url": "https://<customerHost:Port>/webhook",
  "method": "POST",
  "timeout": 0,
  "headers": {
    "content-type": "application/json",
    "x-api-key": "f9be0d9e-6903-4862-8d69-5b2651426bf9"
  },
  "data": JSON.stringify({
    "client_id": "593feb7c7c52bb2357b2df6c",
    "account_number": "107950258295",
    "currency_code": "EUR",
    "amount": 100,
    "gl_reference_number": "1628157637308219",
    "status": "SUCCESS",
    "funding_id": "PREPF10545759",
    "event": "CURRENCY_ACCOUNT_CREDIT",
    "funding_type": "FUNDING",
    "remark": "fdg | Bank of Lithuania - LT593590010000000000 - EUR - Lithuania",
    "timestamp": "2021-08-05T10:01:07.236Z"
  }),
};

$.ajax(settings).done(function (response) {
  console.log(response);
});

Request Body:

Field	Description	Type
client_id	Unique Identifier (ID) of the client whose currency wallet was credited.	String
account_number	Unique Identifier (ID) of the credited currency wallet.	String
currency_code	The currency denomination of the credited amount. Note: The funding amount currency denomination is the same as the currency denomination of the credited currency wallet.	String
amount	Funding amount credited to the currency wallet.	Number
status	Denotes the status of application of funds to the currency wallet.	String
funding_id	Unique Identifier (ID) generated in NIUM's platform against the funding event. The ID is referenced in the Account Statement against the given funding ledger entry.	String
gl_reference_number	Ledger Reference Number generated by NIUM.	String
event	The name of the webhook event. The value of the field for the given callback is "FUNDING_UPDATE".	String
remark	Returns the details about Statement Narrative and NIUM's funding bank account.	String
timestamp	Timestamp of the application of funds to the currency wallet.	String