Skip to main content
GET
/
finops
/
v1
/
transactions
/
{transaction_id}
Get a transaction
curl --request GET \
  --url https://api.sandbox.tesouro.com/finops/v1/transactions/{transaction_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'x-finops-version: <x-finops-version>' \
  --header 'x-organization-id: <x-organization-id>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "amount": 123,
  "currency": "USD",
  "entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "merchant_amount": 123,
  "merchant_currency": "AED",
  "merchant_location": "<string>",
  "merchant_name": "<string>",
  "payment_method": {
    "details": {
      "brand": "<string>",
      "card_type": "credit",
      "expiry_month": 6,
      "expiry_year": 123,
      "last4": "<string>"
    },
    "type": "card"
  },
  "started_at": "2023-11-07T05:31:56Z",
  "type": "capture",
  "description": "<string>",
  "entity_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "external_id": "<string>",
  "partner_metadata": {},
  "receipt_id": "<string>",
  "status": "created"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
x-finops-version
string<date>
required
​
x-organization-id
string<uuid>
required

The ID of the entity that owns the requested resource.

Example:

"9d2b4c8f-2087-4738-ba91-7359683c49a4"

Path Parameters

​
transaction_id
string<uuid>
required

Response

Successful Response

​
id
string<uuid>
required

A unique Monite-generated ID assigned to this transaction.

​
amount
integer
required

The transaction amount in minor units. Positive values for in-flow, negative values for out-flow.

​
currency
enum<string>
required

ISO currency code.

Available options:
AED,
AFN,
ALL,
AMD,
ANG,
AOA,
ARS,
AUD,
AWG,
AZN,
BAM,
BBD,
BDT,
BGN,
BHD,
BIF,
BMD,
BND,
BOB,
BRL,
BSD,
BTN,
BWP,
BYN,
BZD,
CAD,
CDF,
CHF,
CLP,
CNY,
COP,
CRC,
CVE,
CZK,
DJF,
DKK,
DOP,
DZD,
EGP,
ETB,
EUR,
FJD,
FKP,
GBP,
GEL,
GHS,
GIP,
GMD,
GNF,
GTQ,
GYD,
HKD,
HNL,
HTG,
HUF,
IDR,
ILS,
INR,
IQD,
ISK,
JMD,
JOD,
JPY,
KES,
KGS,
KHR,
KMF,
KRW,
KWD,
KYD,
KZT,
LAK,
LBP,
LKR,
LRD,
LSL,
LYD,
MAD,
MDL,
MGA,
MKD,
MMK,
MNT,
MOP,
MUR,
MVR,
MWK,
MXN,
MYR,
MZN,
NAD,
NGN,
NIO,
NOK,
NPR,
NZD,
OMR,
PAB,
PEN,
PGK,
PHP,
PKR,
PLN,
PYG,
QAR,
RON,
RSD,
RUB,
RWF,
SAR,
SBD,
SCR,
SEK,
SGD,
SHP,
SLE,
SOS,
SRD,
SSP,
SVC,
SZL,
THB,
TJS,
TMT,
TND,
TOP,
TRY,
TTD,
TWD,
TZS,
UAH,
UGX,
USD,
UYU,
UZS,
VND,
VUV,
WST,
XAF,
XCD,
XOF,
XPF,
YER,
ZAR,
ZMW
Example:

"USD"

​
entity_id
string<uuid>
required

ID of the entity that owns this resource.

​
merchant_amount
integer
required

Original merchant transaction amount in minor units.

​
merchant_currency
enum<string>
required

ISO currency code for the merchant_amount.

Available options:
AED,
AFN,
ALL,
AMD,
ANG,
AOA,
ARS,
AUD,
AWG,
AZN,
BAM,
BBD,
BDT,
BGN,
BHD,
BIF,
BMD,
BND,
BOB,
BRL,
BSD,
BTN,
BWP,
BYN,
BZD,
CAD,
CDF,
CHF,
CLP,
CNY,
COP,
CRC,
CVE,
CZK,
DJF,
DKK,
DOP,
DZD,
EGP,
ETB,
EUR,
FJD,
FKP,
GBP,
GEL,
GHS,
GIP,
GMD,
GNF,
GTQ,
GYD,
HKD,
HNL,
HTG,
HUF,
IDR,
ILS,
INR,
IQD,
ISK,
JMD,
JOD,
JPY,
KES,
KGS,
KHR,
KMF,
KRW,
KWD,
KYD,
KZT,
LAK,
LBP,
LKR,
LRD,
LSL,
LYD,
MAD,
MDL,
MGA,
MKD,
MMK,
MNT,
MOP,
MUR,
MVR,
MWK,
MXN,
MYR,
MZN,
NAD,
NGN,
NIO,
NOK,
NPR,
NZD,
OMR,
PAB,
PEN,
PGK,
PHP,
PKR,
PLN,
PYG,
QAR,
RON,
RSD,
RUB,
RWF,
SAR,
SBD,
SCR,
SEK,
SGD,
SHP,
SLE,
SOS,
SRD,
SSP,
SVC,
SZL,
THB,
TJS,
TMT,
TND,
TOP,
TRY,
TTD,
TWD,
TZS,
UAH,
UGX,
USD,
UYU,
UZS,
VND,
VUV,
WST,
XAF,
XCD,
XOF,
XPF,
YER,
ZAR,
ZMW
​
merchant_location
string
required

The merchant location.

Maximum string length: 128
Example:

"New York, US"

​
merchant_name
string
required

The merchant name.

Maximum string length: 128
Example:

"Acme Inc."

​
payment_method
object
required
​
started_at
string<date-time>
required

Date and time when the transaction was initiated.

​
type
enum<string>
required

The nature of the transaction.

Available options:
capture,
refund,
cash_withdrawal,
fee,
adjustment,
reversal
​
description
string

A human-readable description of the transaction.

Maximum string length: 255
​
entity_user_id
string<uuid>

ID of the entity user who made the transaction, if applicable.

​
external_id
string

External identifier for idempotency, if provided by the source system.

Maximum string length: 128
​
partner_metadata
object

Extensible key-value pairs for storing additional custom information for partner needs.

​
receipt_id
string

ID of the related receipt from payables service, if any. This field is read-only and system-managed.

​
status
enum<string>
default:created

The current processing status of the transaction.

Available options:
created,
processing,
succeeded,
declined,
refunded,
failed