Skip to main content

Webhook Events

Here, we present the current events that you may receive through your registered Webhook, as described in the previous section. These events include the following:

EventsDescription
TICKETA ticket event refers to any updates related to a created ticket (money) within your Account. Naturally, it may also involve a subAccount. This event can have multiple statuses, such as TICKET-CREATED, DEPOSIT-PROCESSING, among others.
KYCA KYC event refers to any updates related to a KYC attempt. This event can have multiple statuses, such as KYC-STARTED, KYC-PROCESSING, KYC-EXPIRED, and KYC-COMPLETED.
LIMIT-UPDATEAn event that notifies you when there are changes to your account's operational limits. This is typically triggered after a successful KYC verification or when an administrator modifies your account limits.

Ticket

The Ticket Event always reflects an update related to any updates related to a created ticket within your account. In other words, for each type of transaction (as defined inside the quote field of a ticket), a ticket is generated.

Each ticket has a specific type, which determines the nature of the transaction, and during the lifecycle of that ticket, you’ll receive multiple status updates reflecting its current state.

These updates will be sent to your registered Webhook as the ticket progresses through its execution steps.

tickets fluxogram

Ticket Event's Status

Status NameDescription
TICKET-CREATEDThe ticket has been successfully created—this occurs when the transaction hits the endpoint.
DEPOSIT-PROCESSINGThe deposit phase has started and is currently being processed.
DEPOSIT-SUCCESSThe deposit was completed successfully.
DEPOSIT-FAILEDThe deposit attempt has failed.
DELIVERY-PROCESSINGThe delivery phase (e.g., transfer of tokens or funds) is now in progress.
DELIVERY-SUCCESSThe delivery was completed successfully.
DELIVERY-FAILEDThe delivery attempt has failed.
TICKET-COMPLETEThe entire ticket lifecycle has been completed, regardless of the outcome.
info

If a deposit is made to the Main Account without a previously created Ticket, a Ticket Event will still be triggered, starting with the status TICKET-CREATED

info

Any type of error will also return a REASON field, providing details about why the specific step could not be completed.

An additional note for when the Ticket represents a Pay Out—either via PIX or BrCode

When the Ticket represents a Pay Out via PIX or BrCode, the delivery status may fail. In such cases, a new status will be generated, followed by a refund of the original input amount.

ticket fluxogram when it is pay out pix or br code

Ticket Event's Status Pay Out Failure

Status NameDescription
DELIVERY-PROCESSINGThe delivery phase (e.g., transfer of tokens or funds) is now in progress.
DELIVERY-PARTIAL-FAILEDFailure to complete Pay Out delivery

Understanding the Data Returned in a Webhook

Ticket Events follow a standardized structure, where:

{
"event": {
"id": "6df2ae75-670f-4619-a6b1-8a5018af56b0",
"accountId": "94fdb114-189f-46d2-bce8-6ee6ba461d18",
"subscription": "TICKET",
"data": {
"ticket": {},
"type": "TICKET-CREATED"
}
"createdAt": "2025-09-16T12:32:12.338058Z"
}
Detailed ticket events

TICKET-CREATED

{
"event": {
"id": "6df2ae75-670f-4619-a6b1-8a5018af56b0",
"accountId": "94fdb114-189f-46d2-bce8-6ee6ba461d18",
"subscription": "TICKET",
"data": {
"ticket": {
"id": "c4bd34dd-cbb2-4cda-b158-f104dd67d0c8",
"externalId": "",
"workspaceId": "fbe2f6a3-6604-4b12-aae5-9f2994aaa3c1",
"userId": "94fdb114-189f-46d2-bce8-6ee6ba461d18",
"status": "UNPAID",
"reason": "",
"failureReason": "",
"createdAt": "2025-09-16T12:32:12.208933037Z",
"updatedAt": "2025-09-16T12:32:12.208933037Z",
"expiresAt": "2025-09-17T12:32:12.208933037Z",
"quote": {
"inputCurrency": "BRL",
"inputPaymentMethod": "PIX",
"inputAmount": "10.2",
"outputCurrency": "BRLA",
"outputPaymentMethod": "INTERNAL",
"outputAmount": "10",
"markupCurrency": "",
"markupAmount": "0",
"sendMethod": "PERMIT",
"inputThirdParty": false,
"outputThirdParty": false,
"basePrice": "1",
"appliedFees": [
{
"type": "Markup Fee",
"description": "Total markup fees represented in the input currency.",
"amount": "0",
"currency": "BRL",
"rebatable": false
},
{
"type": "In Fee",
"description": "Fees due to input currency and input payment method.",
"amount": "0.2",
"currency": "BRL",
"rebatable": true
},
{
"type": "Conversion Fee",
"description": "Fees due to conversion from input currency to output currency.",
"amount": "0",
"currency": "BRL",
"rebatable": true
},
{
"type": "Out Fee",
"description": "Fees due to output currency and output payment method.",
"amount": "0",
"currency": "BRL",
"rebatable": true
},
{
"type": "Gas Fee",
"description": "Fees due to blockchain transaction costs.",
"amount": "0",
"currency": "BRL",
"rebatable": false
}
],
"pairName": "BRLBRLA",
"outputBrCode": "",
"createdAt": "2025-09-16T12:32:11Z"
},
"brazilianFiatSenderInfo": {
"referenceLabel": "uOUAP45Mg7PrhVg50DURHjX6f",
"additionalData": "BRLA Ticket Payment",
"name": "",
"taxId": "",
"bankCode": "",
"branchCode": "",
"accountNumber": "",
"accountType": "",
"endToEndId": ""
},
"blockchainReceiverInfo": {
"walletAddress": "0xe6B0847cE60Dd81C9DC55a8CC69F37343bFE5eF4",
"walletChain": "INTERNAL",
"walletMemo": "",
"txHash": ""
}
},
"type": "TICKET-CREATED"
},
"createdAt": "2025-09-16T12:32:12.338058Z",
"EventType": ""
}
}

DEPOSIT-PROCESSING

{
"event": {
"id": "7b1cc0ab-5e35-4cb0-a5be-720aba6f9146",
"accountId": "94fdb114-189f-46d2-bce8-6ee6ba461d18",
"subscription": "TICKET",
"data": {
"ticket": {
"id": "c4bd34dd-cbb2-4cda-b158-f104dd67d0c8",
"externalId": "",
"workspaceId": "fbe2f6a3-6604-4b12-aae5-9f2994aaa3c1",
"userId": "94fdb114-189f-46d2-bce8-6ee6ba461d18",
"status": "PROCESSING",
"reason": "",
"failureReason": "",
"createdAt": "2025-09-16T12:32:12.219815Z",
"updatedAt": "2025-09-16T12:32:12.219815Z",
"expiresAt": "2025-09-17T12:32:12.208933Z",
"quote": {
"inputCurrency": "BRL",
"inputPaymentMethod": "PIX",
"inputAmount": "10.2",
"outputCurrency": "BRLA",
"outputPaymentMethod": "INTERNAL",
"outputAmount": "10",
"markupCurrency": "",
"markupAmount": "0",
"sendMethod": "PERMIT",
"inputThirdParty": false,
"outputThirdParty": false,
"basePrice": "1",
"appliedFees": [
{
"type": "Markup Fee",
"description": "Total markup fees represented in the input currency.",
"amount": "0",
"currency": "BRL",
"rebatable": false
},
{
"type": "In Fee",
"description": "Fees due to input currency and input payment method.",
"amount": "0.2",
"currency": "BRL",
"rebatable": true
},
{
"type": "Conversion Fee",
"description": "Fees due to conversion from input currency to output currency.",
"amount": "0",
"currency": "BRL",
"rebatable": true
},
{
"type": "Out Fee",
"description": "Fees due to output currency and output payment method.",
"amount": "0",
"currency": "BRL",
"rebatable": true
},
{
"type": "Gas Fee",
"description": "Fees due to blockchain transaction costs.",
"amount": "0",
"currency": "BRL",
"rebatable": false
}
],
"pairName": "BRLBRLA",
"outputBrCode": "",
"createdAt": "2025-09-16T12:32:11Z"
},
"brazilianFiatSenderInfo": {
"referenceLabel": "uOUAP45Mg7PrhVg50DURHjX6f",
"additionalData": "BRLA Ticket Payment",
"name": "",
"taxId": "",
"bankCode": "",
"branchCode": "",
"accountNumber": "",
"accountType": "",
"endToEndId": ""
},
"blockchainReceiverInfo": {
"walletAddress": "0xe6B0847cE60Dd81C9DC55a8CC69F37343bFE5eF4",
"walletChain": "INTERNAL",
"walletMemo": "",
"txHash": ""
}
},
"type": "DEPOSIT-PROCESSING"
},
"createdAt": "2025-09-16T12:32:26.669037Z",
"EventType": ""
}
}

DELIVERY-PROCESSING

{
"event": {
"id": "98db8c1b-b2f6-4ee1-92d9-cd7821ce29f8",
"accountId": "94fdb114-189f-46d2-bce8-6ee6ba461d18",
"subscription": "TICKET",
"data": {
"ticket": {
"id": "c4bd34dd-cbb2-4cda-b158-f104dd67d0c8",
"externalId": "",
"workspaceId": "fbe2f6a3-6604-4b12-aae5-9f2994aaa3c1",
"userId": "94fdb114-189f-46d2-bce8-6ee6ba461d18",
"status": "PROCESSING",
"reason": "",
"failureReason": "",
"createdAt": "2025-09-16T12:32:12.219815Z",
"updatedAt": "2025-09-16T12:32:12.219815Z",
"expiresAt": "2025-09-17T12:32:12.208933Z",
"quote": {
"inputCurrency": "BRL",
"inputPaymentMethod": "PIX",
"inputAmount": "10.2",
"outputCurrency": "BRLA",
"outputPaymentMethod": "INTERNAL",
"outputAmount": "10",
"markupCurrency": "",
"markupAmount": "0",
"sendMethod": "PERMIT",
"inputThirdParty": false,
"outputThirdParty": false,
"basePrice": "1",
"appliedFees": [
{
"type": "Markup Fee",
"description": "Total markup fees represented in the input currency.",
"amount": "0",
"currency": "BRL",
"rebatable": false
},
{
"type": "In Fee",
"description": "Fees due to input currency and input payment method.",
"amount": "0.2",
"currency": "BRL",
"rebatable": true
},
{
"type": "Conversion Fee",
"description": "Fees due to conversion from input currency to output currency.",
"amount": "0",
"currency": "BRL",
"rebatable": true
},
{
"type": "Out Fee",
"description": "Fees due to output currency and output payment method.",
"amount": "0",
"currency": "BRL",
"rebatable": true
},
{
"type": "Gas Fee",
"description": "Fees due to blockchain transaction costs.",
"amount": "0",
"currency": "BRL",
"rebatable": false
}
],
"pairName": "BRLBRLA",
"outputBrCode": "",
"createdAt": "2025-09-16T12:32:11Z"
},
"brazilianFiatSenderInfo": {
"referenceLabel": "uOUAP45Mg7PrhVg50DURHjX6f",
"additionalData": "BRLA Ticket Payment",
"name": "Ada Capital Gestao de Recursos Ltda",
"taxId": "45981761000100",
"bankCode": "20018183",
"branchCode": "0001",
"accountNumber": "6275574179823616",
"accountType": "payment",
"endToEndId": "e200181832025091612324x1ssb1r69a"
},
"blockchainReceiverInfo": {
"walletAddress": "0xe6B0847cE60Dd81C9DC55a8CC69F37343bFE5eF4",
"walletChain": "INTERNAL",
"walletMemo": "",
"txHash": ""
}
},
"type": "DELIVERY-PROCESSING"
},
"createdAt": "2025-09-16T12:32:26.829798Z",
"EventType": ""
}
}

DEPOSIT-SUCCESS

{
"event": {
"id": "b4d05f88-09a0-488c-8360-5c42c11d3a52",
"accountId": "94fdb114-189f-46d2-bce8-6ee6ba461d18",
"subscription": "TICKET",
"data": {
"ticket": {
"id": "c4bd34dd-cbb2-4cda-b158-f104dd67d0c8",
"externalId": "",
"workspaceId": "fbe2f6a3-6604-4b12-aae5-9f2994aaa3c1",
"userId": "94fdb114-189f-46d2-bce8-6ee6ba461d18",
"status": "PROCESSING",
"reason": "",
"failureReason": "",
"createdAt": "2025-09-16T12:32:12.219815Z",
"updatedAt": "2025-09-16T12:32:12.219815Z",
"expiresAt": "2025-09-17T12:32:12.208933Z",
"quote": {
"inputCurrency": "BRL",
"inputPaymentMethod": "PIX",
"inputAmount": "10.2",
"outputCurrency": "BRLA",
"outputPaymentMethod": "INTERNAL",
"outputAmount": "10",
"markupCurrency": "",
"markupAmount": "0",
"sendMethod": "PERMIT",
"inputThirdParty": false,
"outputThirdParty": false,
"basePrice": "1",
"appliedFees": [
{
"type": "Markup Fee",
"description": "Total markup fees represented in the input currency.",
"amount": "0",
"currency": "BRL",
"rebatable": false
},
{
"type": "In Fee",
"description": "Fees due to input currency and input payment method.",
"amount": "0.2",
"currency": "BRL",
"rebatable": true
},
{
"type": "Conversion Fee",
"description": "Fees due to conversion from input currency to output currency.",
"amount": "0",
"currency": "BRL",
"rebatable": true
},
{
"type": "Out Fee",
"description": "Fees due to output currency and output payment method.",
"amount": "0",
"currency": "BRL",
"rebatable": true
},
{
"type": "Gas Fee",
"description": "Fees due to blockchain transaction costs.",
"amount": "0",
"currency": "BRL",
"rebatable": false
}
],
"pairName": "BRLBRLA",
"outputBrCode": "",
"createdAt": "2025-09-16T12:32:11Z"
},
"brazilianFiatSenderInfo": {
"referenceLabel": "uOUAP45Mg7PrhVg50DURHjX6f",
"additionalData": "BRLA Ticket Payment",
"name": "Ada Capital Gestao de Recursos Ltda",
"taxId": "45981761000100",
"bankCode": "20018183",
"branchCode": "0001",
"accountNumber": "6275574179823616",
"accountType": "payment",
"endToEndId": "e200181832025091612324x1ssb1r69a"
},
"blockchainReceiverInfo": {
"walletAddress": "0xe6B0847cE60Dd81C9DC55a8CC69F37343bFE5eF4",
"walletChain": "INTERNAL",
"walletMemo": "",
"txHash": ""
}
},
"type": "DEPOSIT-SUCCESS"
},
"createdAt": "2025-09-16T12:32:26.857476Z",
"EventType": ""
}
}

DELIVERY-SUCCESS

{
"event": {
"id": "546dce9b-98ea-447b-9136-d1265cb36d81",
"accountId": "94fdb114-189f-46d2-bce8-6ee6ba461d18",
"subscription": "TICKET",
"data": {
"ticket": {
"id": "c4bd34dd-cbb2-4cda-b158-f104dd67d0c8",
"externalId": "",
"workspaceId": "fbe2f6a3-6604-4b12-aae5-9f2994aaa3c1",
"userId": "94fdb114-189f-46d2-bce8-6ee6ba461d18",
"status": "PAID",
"reason": "",
"failureReason": "",
"createdAt": "2025-09-16T12:32:12.219815Z",
"updatedAt": "2025-09-16T12:32:12.219815Z",
"expiresAt": "2025-09-17T12:32:12.208933Z",
"quote": {
"inputCurrency": "BRL",
"inputPaymentMethod": "PIX",
"inputAmount": "10.2",
"outputCurrency": "BRLA",
"outputPaymentMethod": "INTERNAL",
"outputAmount": "10",
"markupCurrency": "",
"markupAmount": "0",
"sendMethod": "PERMIT",
"inputThirdParty": false,
"outputThirdParty": false,
"basePrice": "1",
"appliedFees": [
{
"type": "Markup Fee",
"description": "Total markup fees represented in the input currency.",
"amount": "0",
"currency": "BRL",
"rebatable": false
},
{
"type": "In Fee",
"description": "Fees due to input currency and input payment method.",
"amount": "0.2",
"currency": "BRL",
"rebatable": true
},
{
"type": "Conversion Fee",
"description": "Fees due to conversion from input currency to output currency.",
"amount": "0",
"currency": "BRL",
"rebatable": true
},
{
"type": "Out Fee",
"description": "Fees due to output currency and output payment method.",
"amount": "0",
"currency": "BRL",
"rebatable": true
},
{
"type": "Gas Fee",
"description": "Fees due to blockchain transaction costs.",
"amount": "0",
"currency": "BRL",
"rebatable": false
}
],
"pairName": "BRLBRLA",
"outputBrCode": "",
"createdAt": "2025-09-16T12:32:11Z"
},
"brazilianFiatSenderInfo": {
"referenceLabel": "uOUAP45Mg7PrhVg50DURHjX6f",
"additionalData": "BRLA Ticket Payment",
"name": "Ada Capital Gestao de Recursos Ltda",
"taxId": "45981761000100",
"bankCode": "20018183",
"branchCode": "0001",
"accountNumber": "6275574179823616",
"accountType": "payment",
"endToEndId": "e200181832025091612324x1ssb1r69a"
},
"blockchainReceiverInfo": {
"walletAddress": "0xe6B0847cE60Dd81C9DC55a8CC69F37343bFE5eF4",
"walletChain": "INTERNAL",
"walletMemo": "",
"txHash": "0x4f07776967cee4146a03c0729df49c6b743e0fdb3d899bf612be8dfff6e56960"
}
},
"type": "DELIVERY-SUCCESS"
},
"createdAt": "2025-09-16T12:32:35.762643Z",
"EventType": ""
}
}

TICKET-COMPLETE

{
"event": {
"id": "ee9a907f-3fdc-4521-9d61-28f6c6a859b5",
"accountId": "94fdb114-189f-46d2-bce8-6ee6ba461d18",
"subscription": "TICKET",
"data": {
"ticket": {
"id": "c4bd34dd-cbb2-4cda-b158-f104dd67d0c8",
"externalId": "",
"workspaceId": "fbe2f6a3-6604-4b12-aae5-9f2994aaa3c1",
"userId": "94fdb114-189f-46d2-bce8-6ee6ba461d18",
"status": "PAID",
"reason": "",
"failureReason": "",
"createdAt": "2025-09-16T12:32:12.219815Z",
"updatedAt": "2025-09-16T12:32:12.219815Z",
"expiresAt": "2025-09-17T12:32:12.208933Z",
"quote": {
"inputCurrency": "BRL",
"inputPaymentMethod": "PIX",
"inputAmount": "10.2",
"outputCurrency": "BRLA",
"outputPaymentMethod": "INTERNAL",
"outputAmount": "10",
"markupCurrency": "",
"markupAmount": "0",
"sendMethod": "PERMIT",
"inputThirdParty": false,
"outputThirdParty": false,
"basePrice": "1",
"appliedFees": [
{
"type": "Markup Fee",
"description": "Total markup fees represented in the input currency.",
"amount": "0",
"currency": "BRL",
"rebatable": false
},
{
"type": "In Fee",
"description": "Fees due to input currency and input payment method.",
"amount": "0.2",
"currency": "BRL",
"rebatable": true
},
{
"type": "Conversion Fee",
"description": "Fees due to conversion from input currency to output currency.",
"amount": "0",
"currency": "BRL",
"rebatable": true
},
{
"type": "Out Fee",
"description": "Fees due to output currency and output payment method.",
"amount": "0",
"currency": "BRL",
"rebatable": true
},
{
"type": "Gas Fee",
"description": "Fees due to blockchain transaction costs.",
"amount": "0",
"currency": "BRL",
"rebatable": false
}
],
"pairName": "BRLBRLA",
"outputBrCode": "",
"createdAt": "2025-09-16T12:32:11Z"
},
"brazilianFiatSenderInfo": {
"referenceLabel": "uOUAP45Mg7PrhVg50DURHjX6f",
"additionalData": "BRLA Ticket Payment",
"name": "Ada Capital Gestao de Recursos Ltda",
"taxId": "45981761000100",
"bankCode": "20018183",
"branchCode": "0001",
"accountNumber": "6275574179823616",
"accountType": "payment",
"endToEndId": "e200181832025091612324x1ssb1r69a"
},
"blockchainReceiverInfo": {
"walletAddress": "0xe6B0847cE60Dd81C9DC55a8CC69F37343bFE5eF4",
"walletChain": "INTERNAL",
"walletMemo": "",
"txHash": "0x4f07776967cee4146a03c0729df49c6b743e0fdb3d899bf612be8dfff6e56960"
}
},
"type": "TICKET-COMPLETE"
},
"createdAt": "2025-09-16T12:32:35.776372Z",
"EventType": ""
}
}

KYC

The KYC Event reflects updates related to a Know Your Customer verification attempt within your account. These events track the entire lifecycle of a KYC verification process, from submission to completion.

During the KYC verification process, you'll receive multiple status updates reflecting the current state of the verification attempt.

KYC Event Types

Type NameDescription
KYC-STARTEDIndicates that the KYC process has been initiated.
KYC-PROCESSINGIndicates that the KYC information is being processed.
KYC-COMPLETEDIndicates that the KYC process has been completed.
KYC-EXPIREDIndicates that the KYC process has been expired.

KYC Status

Status NameDescription
PENDINGThe KYC verification is pending and awaiting processing.
PROCESSINGThe KYC verification is currently being processed.
COMPLETEDThe KYC verification has been completed (with either APPROVED or REJECTED result).
EXPIREDThe KYC verification has expired without being completed.

KYC Result

Result NameDescription
APPROVEDThe KYC verification was successfully approved.
REJECTEDThe KYC verification was rejected. A resultMessage field will provide details about the reason for rejection.

Understanding the Data Returned in a KYC Webhook

KYC Events follow a standardized structure, where:

{
"event": {
"id": "unique-event-id",
"accountId": "account-identifier",
"subscription": "KYC",
"data": {
"attempt": {
"id": "kyc-attempt-id",
"userId": "user-identifier",
"levelName": "level-1",
"submissionData": {
// Personal information submitted for verification
},
"status": "COMPLETED",
"result": "APPROVED",
"resultMessage": "",
"retryable": false,
"createdAt": "timestamp",
"updatedAt": "timestamp"
},
"type": "KYC-COMPLETED"
},
"createdAt": "timestamp",
"EventType": ""
}
}

KYC Webhook Fields

FieldDescription
idUnique identifier for the webhook event.
accountIdThe identifier of the account associated with this KYC attempt.
subscriptionAlways "KYC" for KYC events.
data.attempt.idUnique identifier for the specific KYC attempt.
data.attempt.userIdThe identifier of the user making the KYC attempt.
data.attempt.levelNameThe KYC level being attempted (e.g., "level-1").
data.attempt.submissionDataContains all personal information submitted for verification.
data.attempt.statusCurrent status of the KYC attempt (PENDING, PROCESSING, COMPLETED, EXPIRED).
data.attempt.resultResult of the KYC verification (APPROVED or REJECTED) when completed.
data.attempt.resultMessageProvides details about rejection reasons if the result is REJECTED.
data.attempt.retryableBoolean indicating if another KYC attempt can be made.
data.typeThe type of KYC event (KYC-STARTED, KYC-PROCESSING, KYC-COMPLETED).
info

When a KYC verification is rejected, the resultMessage field will contain information about why the verification failed, such as "birthdate does not match".

info

The retryable field indicates whether a new KYC attempt can be made. If true, the user can submit another KYC verification with corrected information.

LIMIT-UPDATE

The LIMIT-UPDATE Event notifies you when there are changes to your account's operational limits. These events are triggered whenever your account limits are updated, either due to KYC level changes, administrative actions, or other account-related events.

Understanding the Data Returned in a LIMIT-UPDATE Webhook

LIMIT-UPDATE Events follow a standardized structure, where:

{
"event": {
"id": "unique-event-id",
"accountId": "account-identifier",
"subscription": "LIMIT-UPDATE",
"data": {
"limitInfo": {
"blocked": false,
"createdAt": "timestamp",
"limits": [
{
"currency": "*",
"maxFiatIn": "100000",
"maxFiatOut": "100000",
"maxChainIn": "100000",
"maxChainOut": "100000",
"usedLimit": {
"year": 0,
"month": 0,
"usedFiatIn": "0",
"usedFiatOut": "0",
"usedChainIn": "0",
"usedChainOut": "0"
}
},
{
"currency": "BRL",
"maxFiatIn": "600000",
"maxFiatOut": "600000",
"maxChainIn": "600000",
"maxChainOut": "600000",
"usedLimit": {
"year": 0,
"month": 0,
"usedFiatIn": "0",
"usedFiatOut": "0",
"usedChainIn": "0",
"usedChainOut": "0"
}
}
// Additional currencies...
]
},
"type": "LIMIT-UPDATE"
},
"createdAt": "timestamp",
"EventType": ""
}
}

LIMIT-UPDATE Webhook Fields

FieldDescription
idUnique identifier for the webhook event.
accountIdThe identifier of the account whose limits were updated.
subscriptionAlways "LIMIT-UPDATE" for limit update events.
data.limitInfo.blockedBoolean indicating if the account is blocked from operations.
data.limitInfo.createdAtTimestamp when the limit information was generated.
data.limitInfo.limitsArray of objects containing limit details for different currencies.
data.typeAlways "LIMIT-UPDATE" for this event type.

Each object in the limits array contains:

FieldDescription
currencyThe currency code. A value of "*" represents the global limit in USD.
maxFiatInThe maximum monthly limit for fiat deposits.
maxFiatOutThe maximum monthly limit for fiat withdrawals.
maxChainInThe maximum monthly limit for on-chain deposits.
maxChainOutThe maximum monthly limit for on-chain withdrawals.
usedLimitObject containing details about consumed limits for the current month.
info

The LIMIT-UPDATE event is typically triggered after a successful KYC verification or when an administrator modifies your account limits.