get_transactions
Query a list of transactions by SEP, transaction status or other criteria.
Params
(5)Please note that parameter structure within the request must contain named parameters as a by-name object, and not as positional arguments in a by-position array
1. sep (required)
Sep of the transaction belongs to
Protocol of the transaction.
2. order_by
Specifies field that transactions will be ordered by. Note, that secondary sort is transaction id in ascending value.
The order by string used to sort the results.
3. statuses
The statuses of the transaction to filter by.
The statuses of the transaction to filter by.
4. page_size
The number of records to return in each page.
The number of records to return in each page.
5. page_number
Page number to use for continuous search. Page count beings at 0.
Page number to use for continuous search. Page count beings at 0.
Result
(get_transactionResponse)A unique transaction identifier.
Protocol of the transaction.
The kind of transaction that is desired.
Processing status of the transaction.
Funding method used for transferring or settling assets.
DEPRECATED in favor of funding_method. Type of deposit, withdrawal or receive.
The amount expected in the payment.
Amount expected/received by anchor.
The amount expected to be sent by anchor to user at end of transaction.
Description of fee charged by the anchor.
The id returned from a SEP-38 POST /quote response
Start date and time of transaction.
The date and time of transaction reaching the current status.
The date and time of transaction reaching completed or refunded status.
The date and time of receiving transfer.
Time and date by which user action is required.
Human readable explanation of transaction status
An object describing any on or offchain refund associated with this transaction.
The account being debited in the Stellar Network.
The account being credited in the Stellar Network.
A unique transaction identifier.
The memo type of the transaction in the Stellar network. Should be present if memo is not null.
The memo type of the transaction in the Stellar network. Should be present if memo is not null.
The domain of the client.
The domain of the client.
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.
A object that identify end-user.
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 or SEP-24 Anchor, the account and memo fields should be used.
Example
Example request to the get_transactions method.
Request
- cURL
- JavaScript
- Python
- JSON
curl -X POST \
-H 'Content-Type: application/json' \
-d '{
"jsonrpc": "2.0",
"id": 8675309,
"method": "get_transactions",
"params": {
"sep": "31",
"order_by": "created_at",
"statuses": [
"completed"
]
}
}' \
https://platform-server.exampleanchor.com | jq
let requestBody = {
"jsonrpc": "2.0",
"id": 8675309,
"method": "get_transactions",
"params": {
"sep": "31",
"order_by": "created_at",
"statuses": [
"completed"
]
}
}
let res = await fetch('https://platform-server.exampleanchor.com', {
method: 'POST',
headers: {
'Content-Type': 'application/json',
},
body: JSON.stringify(requestBody),
})
let json = await res.json()
console.log(json)
import json, requests
res = requests.post('https://platform-server.exampleanchor.com', json={
"jsonrpc": "2.0",
"id": 8675309,
"method": "get_transactions",
"params": {
"sep": "31",
"order_by": "created_at",
"statuses": [
"completed"
]
}
})
print(json.dumps(res.json(), indent=4))
{
"jsonrpc": "2.0",
"id": 8675309,
"method": "get_transactions",
"params": {
"sep": "31",
"order_by": "created_at",
"statuses": [
"completed"
]
}
}
Result
{
"jsonrpc": "2.0",
"id": 8675309,
"result": {
"records": [
{
"id": "1c186184-09ee-486c-82a7-aa7a0ab1119d",
"sep": "31",
"kind": "receive",
"status": "completed",
"funding_method": "SWIFT",
"amount_expected": {
"amount": "100",
"asset": "iso4217:USD"
},
"amount_in": {
"amount": "100.0000",
"asset": "iso4217:USD"
},
"amount_out": {
"amount": "98.0000000",
"asset": "stellar:USDC:GBBD47IF6LWK7P7MDEVSCWR7DPUWV3NY3DTQEVFL4NAT4AQH3ZLLFLA5"
},
"fee_details": {
"total": "2.0000",
"asset": "iso4217:USD"
},
"quote_id": "quote-id",
"message": "Please don't forget to foo bar",
"refunds": {
"amount_refunded": {
"amount": "90.0000",
"asset": "iso4217:USD"
},
"amount_fee": {
"amount": "8.0000",
"asset": "iso4217:USD"
},
"payments": [
{
"id": "1111",
"id_type": "stellar",
"amount": {
"amount": "50.0000",
"asset": "iso4217:USD"
},
"fee": {
"amount": "4.0000",
"asset": "iso4217:USD"
}
},
{
"id": "2222",
"id_type": "stellar",
"amount": {
"amount": "40.0000",
"asset": "iso4217:USD"
},
"fee": {
"amount": "4.0000",
"asset": "iso4217:USD"
}
}
]
},
"stellar_transactions": [
{
"id": "stellar-tx-id",
"memo": "my-memo",
"memo_type": "text",
"envelope": "here_comes_the_envelope",
"payments": [
{
"id": "payment-id",
"amount": {
"amount": "100.0000",
"asset": "iso4217:USD"
},
"payment_type": "payment",
"source_account": "GB4GJAV4Q7DPGU7WI3H5TMVKEYZJ4JFLFEF3O3TRJKDPXK7NAMRBXWFL",
"destination_account": "GDIN5ZULIOT5YPBIXJXFGNH4TCNTDKIA4ZF6QQE3S2P5P44BHCQQJNDC"
}
]
}
],
"external_transaction_id": "external-tx-id",
"customers": {
"sender": {
"id": "sender-id"
},
"receiver": {
"id": "receiver-id"
}
},
"creator": {
"id": "creator-id"
}
}
]
}
}