Skip to main content
GET
/
transactions
Get transactions
curl --request GET \
  --url https://api.sandbox.monite.com/v1/transactions \
  --header 'Authorization: Bearer <token>' \
  --header 'x-monite-entity-id: <x-monite-entity-id>' \
  --header 'x-monite-version: <x-monite-version>'
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "amount": 123,
      "currency": "EUR",
      "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": {},
      "status": "created"
    }
  ],
  "next_pagination_token": "<string>",
  "prev_pagination_token": "<string>"
}

Authorizations

​
Authorization
string
header
required

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

Headers

​
x-monite-version
string<date>
required
​
x-monite-entity-id
string<uuid>
required

The ID of the entity that owns the requested resource.

Example:

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

Query Parameters

​
order
enum<string>
default:asc

Sort order (ascending by default). Typically used together with the sort parameter.

Available options:
asc,
desc
​
limit
integer
default:100

Max is 100

Required range: 1 <= x <= 100
​
pagination_token
string

A token, obtained from previous page. Prior over other filters

​
sort
enum<string>

The field to sort the results by. Typically used together with the order parameter.

Available options:
created_at,
updated_at,
started_at,
amount,
merchant_amount,
merchant_name,
status,
type,
external_id
​
created_at__gt
string<date-time>

Created after this datetime (exclusive)

​
created_at__lt
string<date-time>

Created before this datetime (exclusive)

​
updated_at__gt
string<date-time>

Updated after this datetime (exclusive)

​
updated_at__lt
string<date-time>

Updated before this datetime (exclusive)

​
started_at__gt
string<date-time>

Transaction started after this datetime (exclusive)

​
started_at__lt
string<date-time>

Transaction started before this datetime (exclusive)

​
status__in
enum<string>[]

One or multiple of the transaction statuses

Available options:
created,
processing,
succeeded,
declined,
refunded,
failed
​
type__in
enum<string>[]

One or multiple of the transaction types

Available options:
capture,
refund,
cash_withdrawal,
fee,
adjustment,
reversal
​
entity_user_id__in
string<uuid>[]

One or multiple of the entity users

​
external_id__in
string[]

One or multiple of the transaction external ids

​
amount__gt
integer

Amount greater than (exclusive)

​
amount__lt
integer

Amount less than (exclusive)

​
currency__in
enum<string>[]

One or multiple of the transaction currencies

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_amount__gt
integer

Merchant amount greater than (exclusive)

​
merchant_amount__lt
integer

Merchant amount less than (exclusive)

​
merchant_currency__in
enum<string>[]

One or multiple of the transaction merchant currencies

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_name__icontains
string

Partially matched merchant name

Response

Successful Response

A paginated list of transactions.

​
data
object[]
required
​
next_pagination_token
string

A token that can be sent in the pagination_token query parameter to get the next page of results, or null if there is no next page (i.e. you've reached the last page).

​
prev_pagination_token
string

A token that can be sent in the pagination_token query parameter to get the previous page of results, or null if there is no previous page (i.e. you've reached the first page).