SEP-24SEP-31

Update Transactions Info

Accepts one or more objects containing updated information on transactions. Note that requests containing invalid data for any transaction will result in a 400 Bad Request and no transactions will be updated. Importantly, this operation is NOT atomic. If one update fails, all previous updates would be applied, all subsequent updates would be discarded, and an error would be raised.

application/json

Request Body

• oneOf
  • PatchTransactionSEP24
  • PatchTransactionSEP31

  ---
• records object[]

  Array [

  transaction object

  id string required

  sep string

  Possible values: [24]

  status StatusSEP24

  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_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

  updated_at date-time

  completed_at date-time

  transfer_received_at date-time

  external_transaction_id string

  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

  ]

  ]

  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.

  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

  ]

  ]

records object[]

Array [

transaction object

id string required

sep string

Possible values: [31]

status StatusSEP31

Possible values: [incomplete, completed, refunded, expired, error, pending_stellar, pending_external, pending_sender, pending_receiver, pending_transaction_info_update, pending_customer_info_update]

Possible status value for SEP-31 transactions

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

updated_at date-time

completed_at date-time

transfer_received_at date-time

external_transaction_id string

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

]

]

message string

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 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.

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 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.

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.

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

]

]