Fiat Deposit Received

Overview

When this event occurs, the provided callback URL will receive a JSON-formatted message with the above details. If the application successfully receives the webhook, it should respond with a 200 HTTP status code; otherwise, the banking platform will retry sending the message for a certain period.

For developers, it's important to manage these callbacks properly, including validating the received messages using the provided secret, to ensure proper synchronization between the banking platform and the application.

Callback Request Parameters

FieldDescription

AccountId

Receiving account Id

TransactionId

Associated transaction Id

Reference

Deposit reference

SenderDetails.RoutingNumber

Sender routing number

SenderDetails.AccountNumber

Sender account number

SenderDetails.Name

Sender name

SenderDetails.AddressLine1

Sender address line 1

SenderDetails.AddressLine2

Sender address line 2

SenderDetails.AddressLine3

Sender address line 3

Amount

Amount deposited

Imad

Transfer IMAD number

Date

Transfer date

bReversal

True when a transaction is a refund for a existing transaction on the platform. In this case, OriginalTransactionsId will contain the ID of the original transaction

OriginalTransactionsId

In cases where the fiat deposit represents a refund, this field will contain the ID of the original transaction.

bFlagged

True when a transaction is flagged. Inbound transactions may be flagged by our compliance system. If this value is true, you can expect to receive a TRANSACTION_STATUS_UPDATED regarding updated status once a decision is made.

Callback Example

Standard Deposit Example

{
    "Id": "022afa7a-25e1-4a96-9273-eca3a5dd657f"
    "Type": "FIAT_DEPOSIT_RECEIVED"
    "Data":{
        "AccountsId": 1601,
        "TransactionsId": 13470,
        "OriginalTransactionsId": null,
        "Reference": "ExampleRef"
        "SenderDetails":{
            "RoutingNumber": "011000000",
            "AccountNumber": "0123456789",
            "Name": "Name Surname",
            "AddressLinel": "Address Line 1"
            "AddressLine2": "Address Line 2",
            "AddressLine3": null
        },
        "Amount": 25,
        "Imad": "7679117526335469481169"
        "Date": "2022-08-24713:39:37.72+00:00",
        "bReversal": false,
        "bFlagged": false
    }
}

Refund Deposit Example

{
    "Id": "13590b4f-c190-4a5e-9438-16400aa3b53e",
    "Type": "FIAT_DEPOSIT_RECEIVED",
    "Data": {
        "AccountsId": 4116,
        "TransactionsId": 81878,
        "OriginalTransactionsId": 81877,
        "Reference": "Refund",
        "SenderDetails": null,
        "Amount": 1.230000000000000000,
        "Imad": null,
        "Date": "2024-08-02T16:28:12.0766667+00:00",
        "bReversal": true,
        "bFlagged": false
    }
}

Retrieving Further Information

Once a Fiat Deposit has been received, you can utilize the Get Transaction Details endpoint to retrieve further information for a particular transaction. You can do so by utilizing the Data.TransactionsId value provided in this FIAT_DEPOSIT_RECIEVED callback.

You can also access account balances by accessing the Get Asset Account by ID endpoint. This endpoint will accept the Data.AccountsId value, which corresponds to the ID of the account.

Last updated