Incoming Funds
This event is for Global Collections use case, when funds are received on behalf of Financial Institution's ultimate beneficiaries.
At this time, this event is only triggered whe the status of a payin is NO_MATCH.
https://<customerHost:Port>/webhook
Request Parameters
| Field | Description |
|---|---|
Content-Type | application/json |
Request Example
{
"clientHashId": "86ce8d7b-f3fa-46d5-8d1c-53212aade5b5",
"customerHashId": "857dc08e-dffa-4e9a-ad96-79041c8a7025",
"walletHashId": "857dc08e-dffa-4e9a-ad96-79041c8a7025",
"systemReferenceNumber": "RT1343085439",
"bankReferenceNumber": "5A826K18",
"beneficiaryName": "Johnny Appleseed",
"ExternalId": "XYZ123",
"clientTransactionId":"12345",
"email": "johnny.appleseed@nium.com",
"receiverBank": "Monoova",
"paymentType": "FAST",
"remitterBankName": "Bank of Singapore",
"remitterName": "John Smith",
"template": "INCOMING_FUNDS_WEBHOOK",
"transactionAmount": 5418.1700,
"transactionCurrency": "SGD",
"transactionDate": "2024-12-20",
"uniquePayerId": "null",
"virtualAccountNumber": "8850932067971"
}
Request body
| Field | Description | Type |
|---|---|---|
clientHashId | The unique identifier for the client generated during onboarding; the unique clientId. | String |
customerHashId | The unique identifier for the customer generated when the customer was added to the clients account a customerId was generated. | String |
walletHashId | The unique identifier for the client's wallet; the walletId. | String |
systemReferenceNumber | The unique identifier for the transaction, same as AuthCode in a transaction. | String |
bankReferenceNumber | The bank’s identifier for the transaction. | String |
beneficiaryName | The name of the beneficiary. | String |
ExternalId | The client’s identifier for the customer. | String |
clientTransactionId | The client’s identifier for the transaction. | String |
email | The client’s email address. | String |
receiverBank | The partner bank sending the inward credit confirmation to notify Nium of funds received. | String |
paymentType | The payment mode used to send the funds to Nium’s partner bank. | String |
remitterBankName | The name of the bank used by the remitter to send the funds. | String |
remitterName | The name of the remitter. | String |
template | Const of value: INCOMING_FUNDS_WEBHOOK. | Constant |
transactionAmount | The amount received. | String |
transactionCurrency | The currency code for the funds received in the transaction. | String, length must be three characters |
transactionDate | The date of the transaction. | String with the format YYYY-MM-DD |
uniquePayerId | The unique email ID provided to the customer in addition to a uniquePaymentId for supported regions and configurations. If the region doesn't support the uniquePayerId, the field will return null. | String |
virtualAccountNumber | The virtual account number is provided to customers for supported regions and configuration (for example, IBAN in EU, virtual account number from Moonova in AU). If not supported, returns null. | String |