SEP-24SEP-31SEP-6

Receive an Event

POST 
/event

Receive a JSON object representing an event.

Request

application/json

Body

idstringrequired
typestringrequired

The transaction event type. Can be one of the following:

• transaction_created - a transaction was created through the SEP endpoints. The payload is in the transaction field.
• transaction_status_changed - the status of a transaction has changed. The payload is in the transaction field.
• transaction_error - error processing the transaction. The payload is in the transaction field.
• quote_created - a quote was created via the SEP38 API. The payload is in the quote field.

Possible values: [transaction_created, transaction_status_changed, transaction_error, quote_created, customer_updated]

timestampdate-timerequired
payloadobjectrequired
transactionobject
oneOf
TransactionSEP24
idstringrequired
sepstringrequired
Possible values: [24]
kindstringrequired
Possible values: [deposit, withdrawal]
statusStatusSEP24 (string)required
Possible status value for SEP-24 transactions
Possible values: [incomplete, completed, refunded, expired, error, pending_stellar, pending_external, pending_user_transfer_start, pending_user_transfer_complete, pending_anchor, pending_trust, pending_user, no_market, too_small, too_large]
amount_expected
object
required
amountstringrequired
assetstringrequired
amount_in
object
amountstringrequired
assetstringrequired
amount_out
object
amountstringrequired
assetstringrequired
amount_fee
object
amountstringrequired
assetstringrequired
quote_idstring
started_atdate-timerequired
updated_atdate-time
completed_atdate-time
transfer_received_atdate-time
messagestring
refunds
object
amount_refunded
object
amountstringrequired
assetstringrequired
amount_fee
object
amountstringrequired
assetstringrequired
payments
object[]
Array [
idstring
id_typestring
Possible values: [stellar, external]
amount
object
amountstringrequired
assetstringrequired
fee
object
amountstringrequired
assetstringrequired
requested_atdate-time
refunded_atdate-time
]
stellar_transactions
object[]
Array [
idstringrequired
The ID of the transaction in the Stellar network.
memostring
The memo of the transaction in the Stellar network.
memo_typestring
The memo type of the transaction in the Stellar network. Should be present if memo is not null.
Possible values: [text, hash, id]
created_atdate-timerequired
The time the transaction was registered in the Stellar network.
envelopestringrequired
The transaction envelope, containing all the transaction information.
payments
object[]
required
Array [
idstringrequired
The ID of the payment in the Stellar Network.
payment_typestringrequired
The type of payment in the Stellar Network.
Possible values: [payment, path_payment]
Default value: payment
source_accountstringrequired
The account being debited in the Stellar Network.
destination_accountstringrequired
The account being credited in the Stellar Network.
amount
object
required
amountstringrequired
assetstringrequired
]
]
source_accountstring
destination_accountstringrequired
external_transaction_idstring
memostring
memo_typeMemoType (string)
The memo type of the transaction in the Stellar network. Should be present if memo is not null.
Possible values: [text id hash]
refund_memostring
if provided, this memo should be used for refund transactions
refund_memo_typeMemoType (string)
The memo type of the transaction in the Stellar network. Should be present if memo is not null.
Possible values: [text id hash]
client_domainstring
client_namestring
TransactionSEP31
idstringrequired
sepstringrequired
Possible values: [31]
kindstringrequired
Possible values: [receive]
statusStatusSEP31 (string)required
Possible status value for SEP-31 transactions
Possible values: [incomplete, completed, refunded, expired, error, pending_stellar, pending_external, pending_sender, pending_receiver, pending_transaction_info_update, pending_customer_info_update]
amount_expected
object
amountstringrequired
assetstringrequired
amount_in
object
amountstringrequired
assetstringrequired
amount_out
object
amountstringrequired
assetstringrequired
amount_fee
object
amountstringrequired
assetstringrequired
quote_idstring
started_atdate-timerequired
updated_atdate-time
completed_atdate-time
transfer_received_atdate-time
messagestring
refunds
object
amount_refunded
object
amountstringrequired
assetstringrequired
amount_fee
object
amountstringrequired
assetstringrequired
payments
object[]
Array [
idstring
id_typestring
Possible values: [stellar, external]
amount
object
amountstringrequired
assetstringrequired
fee
object
amountstringrequired
assetstringrequired
requested_atdate-time
refunded_atdate-time
]
stellar_transactions
object[]
Array [
idstringrequired
The ID of the transaction in the Stellar network.
memostring
The memo of the transaction in the Stellar network.
memo_typestring
The memo type of the transaction in the Stellar network. Should be present if memo is not null.
Possible values: [text, hash, id]
created_atdate-timerequired
The time the transaction was registered in the Stellar network.
envelopestringrequired
The transaction envelope, containing all the transaction information.
payments
object[]
required
Array [
idstringrequired
The ID of the payment in the Stellar Network.
payment_typestringrequired
The type of payment in the Stellar Network.
Possible values: [payment, path_payment]
Default value: payment
source_accountstringrequired
The account being debited in the Stellar Network.
destination_accountstringrequired
The account being credited in the Stellar Network.
amount
object
required
amountstringrequired
assetstringrequired
]
]
external_transaction_idstring
client_domainstring
client_namestring
customers
object
The Identification info of the sending and receiving customers. If they were created through SEP-12, this object should contain the SEP-12 customer id. Otherwise, the account address of the customer.
sender
object
StellarId's are objects that identify end-users and SEP-31 Sending Anchors, but not SEP-31 Receiving Anchors. For a SEP-12 customer, the id field should be sufficient to fully identify the customer in the business' Backend. For a SEP-31 Sending Anchor, the account and memo fields should be used. For a SEP-6 Anchor, the account and memo fields should be used.
idstring
The id of the customer registered through SEP-12.
accountstring
Either the Stellar account or Muxed account address of the on-chain entity.
memostring
The memo value identifying a customer with a shared account, where the shared account is account.
receiver
object
StellarId's are objects that identify end-users and SEP-31 Sending Anchors, but not SEP-31 Receiving Anchors. For a SEP-12 customer, the id field should be sufficient to fully identify the customer in the business' Backend. For a SEP-31 Sending Anchor, the account and memo fields should be used. For a SEP-6 Anchor, the account and memo fields should be used.
idstring
The id of the customer registered through SEP-12.
accountstring
Either the Stellar account or Muxed account address of the on-chain entity.
memostring
The memo value identifying a customer with a shared account, where the shared account is account.
creator
object
StellarId's are objects that identify end-users and SEP-31 Sending Anchors, but not SEP-31 Receiving Anchors. For a SEP-12 customer, the id field should be sufficient to fully identify the customer in the business' Backend. For a SEP-31 Sending Anchor, the account and memo fields should be used. For a SEP-6 Anchor, the account and memo fields should be used.
idstring
The id of the customer registered through SEP-12.
accountstring
Either the Stellar account or Muxed account address of the on-chain entity.
memostring
The memo value identifying a customer with a shared account, where the shared account is account.
quote
object
idstring
sell_amountstring
sell_assetstring
buy_amountstring
buy_assetstring
expires_atdate-time
pricestring
total_pricestring
creator
object
StellarId's are objects that identify end-users and SEP-31 Sending Anchors, but not SEP-31 Receiving Anchors. For a SEP-12 customer, the id field should be sufficient to fully identify the customer in the business' Backend. For a SEP-31 Sending Anchor, the account and memo fields should be used. For a SEP-6 Anchor, the account and memo fields should be used.
idstring
The id of the customer registered through SEP-12.
accountstring
Either the Stellar account or Muxed account address of the on-chain entity.
memostring
The memo value identifying a customer with a shared account, where the shared account is account.
transaction_idstring
created_atdate-time
customer
object
idstring

Responses

200

The event is successfully processed and ready to receive next event. The response body is empty.

400

The event is invalid or rejected. The response body contains the error message.