Order Created

webhook deprecated

Order Created

Payload

Event payload representing a state change in an order's lifecycle. This object is typically emitted through webhooks or messaging systems and reflects the current status of the order, as well as its historical transitions. Used to track order progression from creation to processing and completion.

Event payload representing a state change in an order's lifecycle.

object

Order ID

idempotentId

string

Idempotent ID to ensure request uniqueness and deduplication

companyId

object

Identifier of the company that owns the order

counterpartyId

object

Identifier of the counterparty involved in the transaction

settlementId

object

Identifier of the settlement that this order is associated with (if any)

currencyPair

object

The currency pair involved in the operation (source and target)

referenceRate

object

Market reference rate used for the conversion at the time of simulation or creation

customerRate

object

Final rate applied to the customer, including any spread

paymentAmount

object

Amount the payer must pay for the operation

receiveAmount

object

Amount the beneficiary will receive after conversion

currentState

object

The current state of the order (e.g., CREATED, PROCESSED, COMPLETED)

states

array of objects

Full history of state transitions for this order

states

atTime

object

Timestamp indicating when the current event was triggered

Headers

X-Company-Id

uuid

Company unique identifier

X-Message-Id

string

Message unique identifier

X-Message-Signature

string

Message signature

X-Event-Type

string

Event Type

X-Resource-Name

string

Resource Name

Response

200

Return 200 status to indicate that the event was processed successfully