Transfer

You can expect to receive webhook events whenever a transfer is created or its status is updated.

Event Category:

TRANSFER

Event Type:

TRANSFER.CRYPTO_TO_CRYPTO: Status updates for crypto-to-crypto transfers.
TRANSFER.CRYPTO_TO_FIAT: Status updates for crypto-to-fiat transfers.
TRANSFER.FIAT_TO_CRYPTO: Status updates for fiat-to-crypto transfers.

Event Action:

CREATE
UPDATE

Sandbox

In the Sandbox environment, we simulate the transaction status update process by sending a series of webhook events.

Example webhook event

The data object is expected to have the same structure as the response from the Get Transfer endpoint.

{
  "eventId": "evt_1934b4ccbe45ba233e",
  "eventCategory": "TRANSFER",
  "eventType": "TRANSFER.CRYPTO_TO_FIAT",
  "eventAction": "UPDATE",
  "createdAt": "2024-11-20T20:39:04.632Z",
  "timestamp": "2024-11-20T20:39:20.889Z",
  "data": {
    "transferType": "CRYPTO_TO_FIAT",
    "transferDetails": {
      "id": "021f464a-f462-4dc2-8fd2-ebf4909d2949",
      "fee": null,
      "chain": "POLYGON_AMOY",
      "amount": 10,
      "status": "SUBMITTED_ONCHAIN",
      "createdAt": "2024-11-20T20:38:36.990982+00:00",
      "requestId": "ea5cab95-9801-4b4e-b107-48a6a5480c9f",
      "updatedAt": "2024-11-20T20:38:36.990982+00:00",
      "sourceUser": null,
      "failedReason": null,
      "sourceUserId": "3b0d06c8-85dd-498c-ae37-1a1d5c4ea35a",
      "conversionRate": {
        "vaildFrom": "2024-11-20T20:39:04.420Z",
        "toCurrency": "brl",
        "vaildUntil": "2024-11-20T20:43:40.512Z",
        "fromCurrency": "usdc",
        "conversionRate": 5.7123
      },
      "sourceCurrency": "usdc",
      "contractAddress": "0x4D423D2cfB373862B8E12843B6175752dc75f795",
      "destinationUser": null,
      "transactionHash": "0x137aa669eb2fd6e35f6e0825795d4724c2a9ea938b1894ded61f08d2c06bd938",
      "quoteInformation": {
        "vaildFrom": "2024-11-20T20:39:04.420Z",
        "toCurrency": "brl",
        "vaildUntil": "2024-11-20T20:43:40.512Z",
        "fromCurrency": "usdc",
        "sendingAmount": 10,
        "receivingAmount": 56.55
      },
      "destinationUserId": "3b0d06c8-85dd-498c-ae37-1a1d5c4ea35a",
      "destinationAccount": {
        "name": "Bank Account Name",
        "type": "pix",
        "pixKey": "14947677725",
        "userId": "3b0d06c8-85dd-498c-ae37-1a1d5c4ea35a",
        "accountId": "ae566056-1f10-400e-89d1-73f27aa8e289"
      },
      "liquidationAddress": null,
      "destinationCurrency": "brl",
      "destinationAccountId": "ae566056-1f10-400e-89d1-73f27aa8e289"
    }
  }
}