Skip to main content
GET
/
transactions
Get transactions
curl --request GET \
  --url http://api.obsidiam.com/transactions
{
  "transactions": [
    {
      "id": "<string>",
      "amountCents": 123,
      "account": "<string>",
      "customer": {
        "id": "<string>",
        "name": "",
        "email": "",
        "cpfCnpj": ""
      },
      "payerName": "",
      "payerCpfCnpj": "",
      "description": "<string>",
      "e2eID": "",
      "status": "<string>",
      "method": "<string>",
      "type": "<string>",
      "currency": "<string>",
      "fees": 123,
      "disputed": true,
      "pixKey": "",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "completedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "total": 123,
  "totalPages": 123,
  "currentPage": 123,
  "hasMore": true
}

Query Parameters

​
customerId
string
​
accountId
string
​
type
enum<string>
default:all
Available options:
inbound,
outbound,
all
​
query
string
​
from
string<date-time>
​
to
string<date-time>
​
page
number
default:1
​
status
enum<string>
default:all
Available options:
succeeded,
incomplete,
failed,
refunded,
created,
all
​
method
enum<string>
default:all
Available options:
pix,
ted,
boleto,
same_bank_transfer,
all

Response

default - application/json
​
transactions
object[]
required
​
total
number
required
​
totalPages
number
required
​
currentPage
number
required
​
hasMore
boolean
required