Get an operation

Retrieves the details of an operation by its ID.

GET /api/operations/{operationId}

Get an operation

cURL

curl --request GET \
  --url https://api.sandbox.tracefinance.com/api/operations/{operationId} \
  --header 'Authorization: Bearer <token>'

200

Example

{ "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "account": { "id": "a1b2c3d4-5e6f-7890-abcd-ef1234567890", "owner": "Acme Importação Ltda" }, "sourceAmount": { "value": "500.00", "asset": "BRL", "decimals": 2 }, "targetAmount": { "value": "500.00", "asset": "BRL", "decimals": 2 }, "intent": { "type": "WITHDRAWAL", "beneficiary": { "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "entity": { "type": "INDIVIDUAL", "firstName": "<string>", "lastName": "<string>", "taxId": { "value": "52998224725", "type": "CPF" }, "dateOfBirth": "2023-12-25", "address": { "addressLine1": "<string>", "addressLine2": "<string>", "city": "<string>", "state": "<string>", "country": "BR", "postalCode": "<string>" } }, "paymentInstruction": { "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "rail": "PIX_KEY", "key": "<string>" } } }, "quote": { "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "effectiveRate": { "value": "5.25", "base": "USD", "quote": "BRL" }, "expiresAt": "2023-11-07T05:31:56Z", "consumedAt": "2023-11-07T05:31:56Z" }, "fees": [ { "amount": { "value": "500.00", "asset": "BRL", "decimals": 2 }, "createdAt": "2023-11-07T05:31:56Z" } ], "transactions": [ { "id": "<string>", "amount": { "value": "500.00", "asset": "BRL", "decimals": 2 } } ], "currentState": { "createdAt": "2023-11-07T05:31:56Z", "reason": { "code": "INSUFFICIENT_BALANCE", "message": "Insufficient balance for the requested operation", "details": {} } }, "states": [ { "createdAt": "2023-11-07T05:31:56Z", "reason": { "code": "INSUFFICIENT_BALANCE", "message": "Insufficient balance for the requested operation", "details": {} } } ], "createdAt": "2023-11-07T05:31:56Z", "updatedAt": "2023-11-07T05:31:56Z", "tags": [ { "key": "psp", "value": "Amazon" }, { "key": "compliance-tier", "value": "high" } ] }

Authorizations

Authorization · string · header · required

JWT bearer token. Include as Authorization: Bearer <token>. See the Authentication guide for how to obtain one.

Headers

X-Trace-Version · string

API version. Omit to use the default version.

Example:

"1"

Path Parameters

operationId · string<uuid> · required

UUID of the operation.

Response

200

application/json

Operation details.

A created operation. Withdrawals, swaps, deposits, and transfers share this shape; intent.type identifies which. The quote field is always present — transfers take no quoteId and get a 1:1 quote generated internally.

id · string<uuid> · required · read-only

customerId · string<uuid> · required

account · object · required

Reference to a customer account, including the registered owner name.

Show child attributes

sourceAmount · object · required

Monetary amount expressed as a decimal string in the asset's canonical scale. Use a decimal-precision library (BigDecimal, Decimal) for arithmetic — never JavaScript Number. Request bodies use the scalar AmountValue instead.

Show child attributes

targetAmount · object · required

Monetary amount expressed as a decimal string in the asset's canonical scale. Use a decimal-precision library (BigDecimal, Decimal) for arithmetic — never JavaScript Number. Request bodies use the scalar AmountValue instead.

Show child attributes

intent · Withdrawal · object · required

Operation intent. Discriminated by type.

Withdrawal

Swap

Deposit

Transfer

Show child attributes

quote · object · required

Reference to the quote consumed by the operation.

Show child attributes

fees · object[] · required

Show child attributes

transactions · object[] · required

Show child attributes

currentState · object · required

A single entry in an operation's state history. Carries a status, optional reason, and the time the state was entered.

Show child attributes

states · object[] · required

Full state history of the operation, oldest first. The last entry equals currentState.

Show child attributes

createdAt · string<date-time> · required · read-only

updatedAt · string<date-time> · required · read-only

tags · object[]

System-managed labels stamped onto the operation when it is created. Inherited from the account's propagating tags.

Show child attributes

Example:

[
  { "key": "psp", "value": "Amazon" },
  { "key": "compliance-tier", "value": "high" }
]