Global Collections Webhooks

This chapter explains the Global Collections Webhooks.

Transaction Status


{
            "amount": "4.50",
            "currency": "GBP",
            "cmsProfileId": 123,
            "event": "INTERNATIONAL_PAYMENT_COLLECTED",
            "paymentTime": "2022-12-29 13:42:54",
            "referenceId": 63,
            "remarks": "",
            "remitterAccount": "1223456789",
            "remitterAddress": "Dummy Address",
            "remitterBic": "TRWIBEB1XXX",
            "remitterCountry": "GB",
            "remitterName": "Dummy Sender",
            "remitterRoutingCode": "TLG0123",
            "signature": "QfbNhM7BeySY7xoTygQZC86Ihm4Ojx4pJVYTF14Sy9Y=",
            "status": "COMPLETED",
            "utr": "5347f52a-9851-4fe9-8618-32eb085590ce",
            "updatedStatusTime": "2022-12-29 13:50:35",
            "vAccountId": "97836",
            "vAccountNumber": "GB38TCCL12345687997836"
        }

Payload Field Description

FieldDescriptionExample
amountThe foreign currency amount sent4.50
currencyThree character ISO code. View list of supported currencies here.GBP
cmsProfileIdMerchant identifier123
eventWebhook eventINTERNATIONAL_AMOUNT_COLLECTED
paymentTimeThe time at which the payment was initiated.2022-12-29 13:42:54
referenceIdCashfree Payments transaction identifier63
remarksRemarks passed by the sender.Sample Remark
remitterAccountThe bank account number of the person who sends the money.1223456789
remitterAddressThe address of the person who sends the money.Dummy Address
remitterBicBank identifier code for the remitter.TRWIBEB1XXX
remitterCountryThe country from which the money is sent.GB
remitterNameThe name of the remitter who is sending the money.John Doe
remitterRoutingCodeThe routing code of the remitter's bank.TLG0123
signatureWebhook signatureQfbNhM7BeySY7xoTygQZC86Ihm4Ojx4pJVYTF14Sy9Y=
statusStatus of FCY (foreign currency leg) of transaction.COMPLETED, FAILED, PENDING
updatedStatusTimeThe time of the last status update.2022-12-29 13:50:35
vAccountIdIdentifier of the virtual account.97836
vAccountNumberAccount number to which the payment was done.GB38TCCL12345687997836

Settlement Status


{
    "amount": "4.50",
    "cmsProfileId": 123,
    "currency": "GBP",
    "event": "INR_SETTLEMENT_INITIATED",
    "paymentRail": "ACH",
    "paymentTime": "2022-12-29 13:42:54",
    "referenceId": 63,
    "remarks": "",
    "remitterAccount": "1223456789",
    "remitterAddress": "Dummy Address",
    "remitterBic": "TRWIBEB1XXX",
    "remitterCountry": "GB",
    "remitterName": "Dummy Sender",
    "remitterRoutingCode": "TLG0123",
    "signature": "QfbNhM7BeySY7xoTygQZC86Ihm4Ojx4pJVYTF14Sy9Y=",
    "status": "READY_FOR_SETTLEMENT",
    "updatedStatusTime": "2022-12-29 13:50:35",
    "utr": "5347f52a-9851-4fe9-8618-32eb085590ce",
    "vAccountId": "97836",
    "vAccountNumber": "GB38TCCL12345687997836",
    "settlement": {
        "expectedSettlementDate": "2023-08-30",
        "firaFileDownloadUrl": "fileDownloadUrl",
        "id": "b84a7c4c-2ce0-48ca-9b86-2a2c9ad5a35d",
        "inrAmount": 16219.65,
        "status": "INITIATED"
    }
}

πŸ“˜

The firaFileDownloadUrl field will only be included in the webhook response after it has been updated.

Possible Events and Corresponding Settlement Status Mapping

Event NameSettlement StatusDescription
INR_SETTLEMENT_INITIATEDINITIATEDThe settlement is initiated.
INR_SETTLEMENT_APPROVEDSETTLEDThe settlement is settled.
INR_SETTLEMENT_REJECTEDREJECTEDThe settlement is rejected.
FIRA_FILE_RECEIVEDSETTLEDFIRA file received for the settlement.

Payload Field Description

FieldDescriptionExample
amountThe foreign currency amount sent4.50
currencyThree character ISO code. View list of supported currencies here.GBP
cmsProfileIdMerchant identifier123
eventWebhook eventINTERNATIONAL_AMOUNT_COLLECTED
paymentTimeThe time at which the payment was initiated.2022-12-29 13:42:54
referenceIdCashfree Payments transaction identifier63
remarksRemarks passed by the sender.Sample Remark
remitterAccountThe bank account number of the person who sends the money.1223456789
remitterAddressThe address of the person who sends the money.Dummy Address
remitterBicBank identifier code for the remitter.TRWIBEB1XXX
remitterCountryThe country from which the money is sent.GB
remitterNameThe name of the remitter who is sending the money.John Doe
remitterRoutingCodeThe routing code of the remitter's bank.TLG0123
signatureWebhook signatureQfbNhM7BeySY7xoTygQZC86Ihm4Ojx4pJVYTF14Sy9Y=
statusStatus of FCY (foreign currency leg) of transaction.COMPLETED, FAILED, PENDING
updatedStatusTimeThe time of the last status update.2022-12-29 13:50:35
vAccountIdIdentifier of the virtual account.97836
vAccountNumberAccount number to which the payment was made.GB38TCCL12345687997836
paymentRailPayment Network used to make the paymentACH,EFT,FPS,SEPA,SWIFT,FEDWIRE
settlement.idUnique reference ID for the settlement since the payment can have multiple settlements.b84a7c4c-2ce0-48ca-9b86-2a2c9ad5a35d
settlement.firafileDownloadUrlDownload link to FIRA filefileDownloadUrl
settlement.expectedSettlementDateExpected date of settlement.2023-08-30
settlement.inrAmountSettlement amount in rupees (INR).16219.65
settlement.statusCurrent status of the settlement.INITIATED

Virtual Account Details


{
    "cmsProfileId": 260559,
    "event": "VIRTUAL_ACCOUNT_DETAILS",
    "signature": "fi/o9cYwEqZLbSBAXRIwPfgiC+aOLyON7tXLv8wdH2",
    "vAccounts": [  
        {  
            "accountNumber": "GB11TCCL12345638242754",  
            "accountType": "iban",  
            "paymentType": "priority",  
            "bankName": "The Currency Cloud Limited",  
            "bankAddress": "12 Steward Street, The Steward Building, London, E1 6FQ, GB",  
            "bankCountry": "GB",  
            "currency": "AUD",  
            "routingCode": "TCCLGB3L",  
            "routingCodeType": "bic_swift",  
            "addedOn": "2023-03-28 14:43:30",  
            "vaccountId": "GB11T"  
        },  
        {  
            "accountNumber": "GB11TCCL12345638242754",  
            "accountType": "iban",  
            "paymentType": "priority",  
            "bankName": "The Currency Cloud Limited",  
            "bankAddress": "12 Steward Street, The Steward Building, London, E1 6FQ, GB",  
            "bankCountry": "GB",  
            "currency": "BHD",  
            "routingCode": "TCCLGB3L",  
            "routingCodeType": "bic_swift",  
            "addedOn": "2023-03-28 14:43:30",  
            "vaccountId": "GB11T"  
        }  
    ]
}

Description

Sometimes there is mere might be a slight delay in creating some virtual accounts during onboarding and as a result, some of them might be missing in the Get All Collection Accounts API. Hence, when these missing account details are added, this webhook is triggered with all virtual account details (including the ones that were present before). This webhook contains information for all virtual account associated with a merchant along with cmsProfileId , signature and event.

Payload Field Description

FieldDescriptionExample
cmsProfileIdMerchant identifier123
eventWebhook EventVIRTUAL_ACCOUNT_DETAILS
signatureWebhook Signaturefi/o9cYwEqZLbSBAXRIwPfgiC+aOLyON7tXLv8wdH2
vAccounts.accountNumberAccount NumberGB11TCCL12345638242754
vAccounts.accountTypeAccount Typeiban
vAccounts.paymentTypeType of Paymentpriority
vAccounts.bankNameBank NameThe Currency Cloud Limited
vAccounts.bankAddressBank Address12 Steward Street, The Steward Building, London, E1 6FQ, GB
vAccounts.bankCountryBank CountryGB
vAccounts.currencyCurrency CodeBHD
vAccounts.routingCodeRouting CodeTCCLGB3L
vAccounts.routingCodeTypeRouting Code Typebic_swift
vAccounts.addedOnThe time when this virtual account was created2023-03-28 14:43:30
vAccounts.vaccountIdVirtual Account IdGB11T