This chapter explains the Global Collections Webhooks.
Event Name | Payment Status | Description |
---|---|---|
INTERNATIONAL_PAYMENT_COLLECTED | COMPLETED | Received payment |
INTERNATIONAL_PAYMENT_BLOCKED | BLOCKED | The transaction has been blocked due to the specified reason in the designated field. |
INTERNATIONAL_PAYMENT_AWAITING_DETAILS | COMPLETED | Waiting for the details of the transaction |
Field | Description | Example |
---|---|---|
amount | The foreign currency amount sent | 4.50 |
currency | Three character ISO code. View list of supported currencies here. | GBP |
cmsProfileId | Merchant identifier | 123 |
event | Webhook event | INTERNATIONAL_AMOUNT_COLLECTED |
paymentTime | The time at which the payment was initiated. | 2022-12-29 13:42:54 |
referenceId | Cashfree Payments transaction identifier | 63 |
remarks | Remarks passed by the sender. | Sample Remark |
reason | Reason regarding the transaction being blocked. | Transaction value below the allowed limit |
remitterAccount | The bank account number of the person who sends the money. | 1223456789 |
remitterAddress | The address of the person who sends the money. | Dummy Address |
remitterBic | Bank identifier code for the remitter. | TRWIBEB1XXX |
remitterCountry | The country from which the money is sent. | GB |
remitterName | The name of the remitter who is sending the money. | John Doe |
remitterRoutingCode | The routing code of the remitter’s bank. | TLG0123 |
status | Status of FCY (foreign currency leg) of transaction. | COMPLETED, FAILED, AWAITING_DETAILS |
updatedStatusTime | The time of the last status update. | 2022-12-29 13:50:35 |
vAccountId | Identifier of the virtual account. | 97836 |
vAccountNumber | Account number to which the payment was done. | GB38TCCL12345687997836 |
merchant | Object contains merchant_id used while creating merchant | CF_7644f46b-ad82-472c-8d97-609d1a429eac |
Event Name | Reversal Status | Transaction Status | Description |
---|---|---|---|
INTERNATIONAL_PAYMENT_REVERSAL_INITIATED | INITIATED | REVERSAL_INITIATED | Reversal for the transaction is initiated. |
INTERNATIONAL_PAYMENT_REVERSAL_DONE | DONE | REVERSAL_DONE | Reversal for the transaction is completed. The funds have been successfully returned to the sender. |
Event Name | Settlement Status | Description |
---|---|---|
INR_SETTLEMENT_INITIATED | INITIATED | The settlement is initiated. |
INR_SETTLEMENT_APPROVED | SETTLED | The settlement is settled. |
INR_SETTLEMENT_REJECTED | REJECTED | The settlement is rejected. |
FIRA_FILE_RECEIVED | SETTLED | FIRA file received for the settlement. |
Field | Description | Example |
---|---|---|
amount | The foreign currency amount sent | 4.50 |
currency | Three character ISO code. View list of supported currencies here. | GBP |
cmsProfileId | Merchant identifier | 123 |
event | Webhook event | INTERNATIONAL_AMOUNT_COLLECTED |
merchant | Object contains the merchant_id to map the merchant created. | CF_7644f46b-ad82-472c-8d97-609d1a429eac |
paymentTime | The time at which the payment was initiated. | 2022-12-29 13:42:54 |
referenceId | Cashfree Payments transaction identifier | 63 |
remarks | Remarks passed by the sender. | Sample Remark |
remitterAccount | The bank account number of the person who sends the money. | 1223456789 |
remitterAddress | The address of the person who sends the money. | Dummy Address |
remitterBic | Bank identifier code for the remitter. | TRWIBEB1XXX |
remitterCountry | The country from which the money is sent. | GB |
remitterName | The name of the remitter who is sending the money. | John Doe |
remitterRoutingCode | The routing code of the remitter’s bank. | TLG0123 |
status | Status of FCY (foreign currency leg) of transaction. | COMPLETED, FAILED |
updatedStatusTime | The time of the last status update. | 2022-12-29 13:50:35 |
vAccountId | Identifier of the virtual account. | 97836 |
vAccountNumber | Account number to which the payment was made. | GB38TCCL12345687997836 |
paymentRail | Payment Network used to make the payment | ACH,EFT,FPS,SEPA,SWIFT,FEDWIRE |
settlement.id | Unique reference ID for the settlement since the payment can have multiple settlements. | b84a7c4c-2ce0-48ca-9b86-2a2c9ad5a35d |
settlement.fxRate | The foreign exchange rate used for currency conversion between the transaction currency and settlement currency | 85.12 |
settlement.netPartnerCommission | The final commission amount payable to the partner after deducting all applicable fees and charge | 2106.72 |
settlement.settlementCharge | Service fees charged for facilitating the settlement | 4213.44 |
settlement.settlementChargeTax | Applicable tax amount levied on the settlement service charges | 758.42 |
settlement.inrAmount | Settlement amount in rupees (INR). | 16219.65 |
settlement.firafileDownloadUrl | Download link to FIRA file | fileDownloadUrl |
settlement.status | Current status of the settlement. | INITIATED |
Event Name | Virtual Account Status | Description |
---|---|---|
VIRTUAL_ACCOUNTS_ACTIVATED | ACTIVE | Virtual account is activated |
VIRTUAL_ACCOUNTS_CREATED | INACTIVE / ACTIVE | If all the business required details are passed in the first go, VAs are created in ACTIVE state or INACTIVE |
VIRTUAL_ACCOUNT_DETAILS | ACTIVE | Will contain all the details of the VA |
Field | Description | Example |
---|---|---|
cmsProfileId | Merchant identifier | 123 |
event | Webhook Event | VIRTUAL_ACCOUNT_DETAILS |
merchant | Object contains the merchant_id to map the merchant created. | CF_7644f46b-ad82-472c-8d97-609d1a429eac |
vAccounts.accountName | Account Name | John Doe |
vAccounts.accountNumber | Account Number | GB11TCCL12345638242754 |
vAccounts.accountType | Account Type | iban |
vAccounts.paymentType | Type of Payment | priority |
vAccounts.bankName | Bank Name | The Currency Cloud Limited |
vAccounts.bankAddress | Bank Address | 12 Steward Street, The Steward Building, London, E1 6FQ, GB |
vAccounts.bankCountry | Bank Country | GB |
vAccounts.currency | Currency Code | BHD |
vAccounts.routingCode | Routing Code | TCCLGB3L |
vAccounts.routingCodeType | Routing Code Type | bic_swift |
vAccounts.addedOn | The time when this virtual account was created | 2023-03-28 14:43:30 |
vAccounts.vaccountId | Virtual Account Id | GB11T |