Skip to main content
SEP-24SEP-31

Receive an Event​

Receive a JSON object representing an event.

Request Body
  • id string required
  • type string required

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

    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.
  • timestamp date-time required
  • payload object required
  • transaction object
  • oneOf
  • id string required
  • sep string required

    Possible values: [24]

  • kind string required

    Possible values: [deposit, withdrawal]

  • status StatusSEP24 required

    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]

    Possible status value for SEP-24 transactions

  • amount_expected object required
  • amount string required
  • asset string required
  • amount_in object
  • amount string required
  • asset string required
  • amount_out object
  • amount string required
  • asset string required
  • amount_fee object
  • amount string required
  • asset string required
  • started_at date-time required
  • updated_at date-time
  • completed_at date-time
  • transfer_received_at date-time
  • message string
  • refunds object
  • amount_refunded object
  • amount string required
  • asset string required
  • amount_fee object
  • amount string required
  • asset string required
  • payments object[]
  • Array [
  • id string
  • id_type string

    Possible values: [stellar, external]

  • amount object
  • amount string required
  • asset string required
  • fee object
  • amount string required
  • asset string required
  • requested_at date-time
  • refunded_at date-time
  • ]
  • stellar_transactions object[]
  • Array [
  • id string required

    The ID of the transaction in the Stellar network.

  • memo string

    The memo of the transaction in the Stellar network.

  • memo_type string

    Possible values: [text, hash, id]

    The memo type of the transaction in the Stellar network. Should be present if memo is not null.

  • created_at date-time required

    The time the transaction was registered in the Stellar network.

  • envelope string required

    The transaction envelope, containing all the transaction information.

  • payments object[] required
  • Array [
  • id string required

    The ID of the payment in the Stellar Network.

  • payment_type string required

    Possible values: [payment, path_payment]

    Default value: payment

    The type of payment in the Stellar Network.

  • source_account string required

    The account being debited in the Stellar Network.

  • destination_account string required

    The account being credited in the Stellar Network.

  • amount object required
  • amount string required
  • asset string required
  • ]
  • ]
  • source_account string
  • destination_account string required
  • external_transaction_id string
  • memo string
  • memo_type MemoType

    Possible values: [text id hash]

    The memo type of the transaction in the Stellar network. Should be present if memo is not null.

  • refund_memo string

    if provided, this memo should be used for refund transactions

  • refund_memo_type MemoType

    Possible values: [text id hash]

    The memo type of the transaction in the Stellar network. Should be present if memo is not null.

  • quote object
  • id string
  • sell_amount string
  • sell_asset string
  • buy_amount string
  • buy_asset string
  • expires_at date-time
  • price string
  • total_price string
  • 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 field should be used.

  • id string

    The id of the customer registered through SEP-12.

  • account string

    Either the Stellar account or Muxed account address of the on-chain entity.

  • transaction_id string
  • created_at date-time
Responses

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

Loading...