HomeGuidesRecipesAPI ReferenceChangelog
Treasury Portal Login
Guides

3.13 Events

Events for the lifecycle of a widget BUY order.

Event

Description

PENDING_KYC

Order has been created, waiting for customer to complete KYC. if the customer passes KYC we'll update the order with their approved info. If the customer's KYC is rejected, order is marked as EXPIRED

PROCESSING

Order has been created and is being processed within Yellow Card's system. During this process, the the order will attempt to collect from the customer. If so, order will be marked as PENDING, otherwise it will retry until it goes through or eventually mark itself as FAILED and refund.

PENDING

Order is no longer an internal Yellow Card transaction, has been broadcasted on the channel, and is awaiting results to finalize.

COMPLETE

Fiat collection from customer has now succeeded.

FAILED

Order has failed from the customer's end.

PENDING_REFUND

Refund request is received and is queued for processing.

REFUND_PROCESSING

Refund request is being processed, waiting for feedback from order provider.

REFUND_FAILED

We’ve tried to refund the order 5 times and it failed from provider's end, advisable
to resend a refund request after a few hours.

REFUNDED

Refund is complete, fund has been received by the customer.

CANCELLED

Collection order request has been cancelled and would be refunded if we
receive the collection

EXPIRED

KYC request not approved, order marked EXPIRED.

SETTLEMENT_PENDING

We're attempting to send out the crypto from our end, doing a few checks.

SETTLEMENT_PROCESSING

Crypto transfer is processing, waiting for feedback from provider.

SETTLEMENT_COMPLETE

Crypto transfer is now complete, widget Order is in it's end state.

SETTLEMENT_FAILED

Crypto transfer failed, this will trigger a refund request, sending the fiat back to the customer.

Events for the lifecycle of a widget SELL order.

Event

Description

PENDING_KYC

Order has been created, waiting for customer to complete KYC. if the customer passes KYC we'll update the order with their approved info. If the customer's KYC is rejected, order is marked as EXPIRED

PROCESSING

Order has been created and is being processed within Yellow Card's system. During this process, the the order will attempt to collect from the customer. If so, order will be marked as PENDING, otherwise it will retry until it goes through or eventually mark itself as FAILED and refund.

PENDING

Order is no longer an internal Yellow Card transaction, has been broadcasted on the channel, and is awaiting results to finalize.

PENDING_SETTLEMENT

Order has been created and now pending customer crypto transfer.

PENDING_CONFIRMATION

Crypto is pending blockchain confirmation, Once confirmation is complete, we'll move the sell order to PROCESSING

COMPLETE

Fiat collection / payment from / to customer has now succeeded.

FAILED

Order has failed from the customer's end.

PENDING_REFUND

Refund request is received and is queued for processing.

REFUND_PROCESSING

Refund request is being processed, waiting for feedback from order provider.

REFUND_FAILED

We’ve tried to refund the order 5 times and it failed from provider's end, advisable
to resend a refund request after a few hours.

REFUNDED

Refund is complete, fund has been received by the customer.

CANCELLED

Collection order request has been cancelled and would be refunded if we
receive the collection

EXPIRED

KYC request not approved, order marked EXPIRED.

📘

Widget Orders

A buy order would create a collection record, while a sell order would create a payment record.


Events for user's KYC lifecycle

EventDescription
UNDER_REVIEWA widget user has submitted their KYC information, verification is pending from our identity provider
APPROVEDOur identity provider has approved a widget user's KYC.
REJECTEDOur identity provider has rejected a widget user's KYC.
BLOCKEDA widget user has submitted KYC information and been rejected 5 times, they have been blocked from transacting.