Get an operation

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

import requests

url = "https://api.sandbox.tracefinance.com/v1/operations/{operationId}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.sandbox.tracefinance.com/v1/operations/{operationId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sandbox.tracefinance.com/v1/operations/{operationId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sandbox.tracefinance.com/v1/operations/{operationId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.sandbox.tracefinance.com/v1/operations/{operationId}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.tracefinance.com/v1/operations/{operationId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "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"
        },
        "birthDate": "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": "USDT",
      "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": {}
    }
  },
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "tags": [
    {
      "key": "psp",
      "value": "Amazon"
    },
    {
      "key": "compliance-tier",
      "value": "high"
    }
  ]
}

GET

operations

{operationId}

Get an operation

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

import requests

url = "https://api.sandbox.tracefinance.com/v1/operations/{operationId}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.sandbox.tracefinance.com/v1/operations/{operationId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sandbox.tracefinance.com/v1/operations/{operationId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sandbox.tracefinance.com/v1/operations/{operationId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.sandbox.tracefinance.com/v1/operations/{operationId}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.tracefinance.com/v1/operations/{operationId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "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"
        },
        "birthDate": "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": "USDT",
      "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": {}
    }
  },
  "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

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.

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

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

The operation's current state. Carries a status, optional reason, and the time the state was entered.

Show child attributes

createdAt

string<date-time>

required

read-only

updatedAt

string<date-time>

required

read-only

Accounts

Operations

Reports

Quotes

Beneficiaries

Webhooks

Get an operation

Authorizations

Headers

Path Parameters

Response