Skip to main content
GET
/
api
/
v1
/
transactions
Listar todas as transações
curl --request GET \
  --url https://api.payments.bob.company/api/v1/transactions/ \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "data": [
    {
      "id": "<string>",
      "externalId": "<string>",
      "transactionCode": "<string>",
      "status": "waiting_payment",
      "amountCents": 123,
      "product": "<string>",
      "quantity": 123,
      "paidAt": "<string>",
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "customer": {
        "id": "<string>",
        "name": "<string>",
        "email": "<string>"
      },
      "connection": {
        "id": "<string>",
        "alias": "<string>",
        "providerId": "<string>",
        "providerName": "<string>"
      },
      "originDomain": "<string>",
      "customerEmail": "<string>",
      "customerName": "<string>"
    }
  ],
  "meta": {
    "total": 0,
    "page": 0,
    "limit": 0,
    "totalPages": 0
  },
  "message": "<string>"
}

Authorizations

Authorization
string
header
required

Autenticação por API Key usando token SK (sk_live_xxx ou sk_test_xxx). Envie como: Authorization: Bearer sk_live_xxx

Query Parameters

page
integer
default:1
Required range: x <= 9007199254740991
limit
integer
default:10
Required range: x <= 100
status
enum<string>
Available options:
waiting_payment,
paid,
refunded,
cancelled,
expired,
processing
customerId
string<cuid>
Pattern: ^[cC][^\s-]{8,}$
environment
enum<string>
Available options:
live,
sandbox
originDomain
string
domain
string
connectionId
string<cuid>
Pattern: ^[cC][^\s-]{8,}$
amountMin
integer
Required range: 0 <= x <= 9007199254740991
amountMax
integer
Required range: 0 <= x <= 9007199254740991
Required string length: 1 - 200
customerEmail
string<email>
Pattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$

Response

Default Response

success
boolean
default:true
required
data
object[]
required
meta
object
required
message
string