Retrieve a Transaction
Provides the information necessary for the business to determine the state of the transaction identified by id
, decide if any action must be taken to continue processing the transaction, and act on the decision.
Path Parameters
- id string required
- 200
- 400
- 404
Transaction found.
- application/json
- Schema
- Example (from schema)
Schema
- oneOf
- TransactionSEP24
- TransactionSEP31
id string requiredsep string requiredPossible values: [
24
]kind string requiredPossible values: [
deposit
,withdrawal
]status StatusSEP24 requiredPossible 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 requiredasset string requiredamount_in object
amount string requiredasset string requiredamount_out object
amount string requiredasset string requiredamount_fee object
amount string requiredasset string requiredstarted_at date-time requiredupdated_at date-timecompleted_at date-timetransfer_received_at date-timemessage stringrefunds object
amount_refunded object
amount string requiredasset string requiredamount_fee object
amount string requiredasset string requiredpayments object[]
Array [id stringid_type stringPossible values: [
stellar
,external
]amount object
amount string requiredasset string requiredfee object
amount string requiredasset string requiredrequested_at date-timerefunded_at date-time]stellar_transactions object[]
Array [id string requiredThe ID of the transaction in the Stellar network.
memo stringThe memo of the transaction in the Stellar network.
memo_type stringPossible 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 requiredThe time the transaction was registered in the Stellar network.
envelope string requiredThe transaction envelope, containing all the transaction information.
payments object[] required
Array [id string requiredThe ID of the payment in the Stellar Network.
payment_type string requiredPossible values: [
payment
,path_payment
]Default value:
payment
The type of payment in the Stellar Network.
source_account string requiredThe account being debited in the Stellar Network.
destination_account string requiredThe account being credited in the Stellar Network.
amount object required
amount string requiredasset string required]]source_account stringdestination_account string requiredexternal_transaction_id stringmemo stringmemo_type MemoTypePossible values: [
text id hash
]The memo type of the transaction in the Stellar network. Should be present if memo is not null.
id string requiredsep string requiredPossible values: [
31
]kind string requiredPossible values: [
receive
]status StatusSEP31 requiredPossible 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_expected object
amount string requiredasset string requiredamount_in object
amount string requiredasset string requiredamount_out object
amount string requiredasset string requiredamount_fee object
amount string requiredasset string requiredquote_id stringstarted_at date-time requiredupdated_at date-timecompleted_at date-timetransfer_received_at date-timemessage stringrefunds object
amount_refunded object
amount string requiredasset string requiredamount_fee object
amount string requiredasset string requiredpayments object[]
Array [id stringid_type stringPossible values: [
stellar
,external
]amount object
amount string requiredasset string requiredfee object
amount string requiredasset string requiredrequested_at date-timerefunded_at date-time]stellar_transactions object[]
Array [id string requiredThe ID of the transaction in the Stellar network.
memo stringThe memo of the transaction in the Stellar network.
memo_type stringPossible 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 requiredThe time the transaction was registered in the Stellar network.
envelope string requiredThe transaction envelope, containing all the transaction information.
payments object[] required
Array [id string requiredThe ID of the payment in the Stellar Network.
payment_type string requiredPossible values: [
payment
,path_payment
]Default value:
payment
The type of payment in the Stellar Network.
source_account string requiredThe account being debited in the Stellar Network.
destination_account string requiredThe account being credited in the Stellar Network.
amount object required
amount string requiredasset string required]]external_transaction_id stringcustomers 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, theaccount
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 stringThe
id
of the customer registered through SEP-12.account stringEither 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 stringThe
id
of the customer registered through SEP-12.account stringEither 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 stringThe
id
of the customer registered through SEP-12.account stringEither the Stellar account or Muxed account address of the on-chain entity.
{
"id": "string",
"sep": "24",
"kind": "deposit",
"status": "incomplete",
"amount_expected": {
"amount": "string",
"asset": "string"
},
"amount_in": {
"amount": "string",
"asset": "string"
},
"amount_out": {
"amount": "string",
"asset": "string"
},
"amount_fee": {
"amount": "string",
"asset": "string"
},
"started_at": "2023-06-02T22:28:25.036Z",
"updated_at": "2023-06-02T22:28:25.036Z",
"completed_at": "2023-06-02T22:28:25.036Z",
"transfer_received_at": "2023-06-02T22:28:25.036Z",
"message": "string",
"refunds": {
"amount_refunded": {
"amount": "string",
"asset": "string"
},
"amount_fee": {
"amount": "string",
"asset": "string"
},
"payments": [
{
"id": "string",
"id_type": "stellar",
"amount": {
"amount": "string",
"asset": "string"
},
"fee": {
"amount": "string",
"asset": "string"
},
"requested_at": "2023-06-02T22:28:25.036Z",
"refunded_at": "2023-06-02T22:28:25.036Z"
}
]
},
"stellar_transactions": [
{
"id": "string",
"memo": "string",
"memo_type": "text",
"created_at": "2023-06-02T22:28:25.036Z",
"envelope": "string",
"payments": [
{
"id": "string",
"payment_type": "payment",
"source_account": "string",
"destination_account": "string",
"amount": {
"amount": "string",
"asset": "string"
}
}
]
}
],
"source_account": "string",
"destination_account": "string",
"external_transaction_id": "string",
"memo": "string",
"memo_type": "text id hash"
}
Bad Request
- application/json
- Schema
- Example (from schema)
Schema
- error string required
- id string
{
"error": "string",
"id": "string"
}
Transaction not found.
- application/json
- Schema
- Example (from schema)
Schema
- error string required
- id string
{
"error": "string",
"id": "string"
}