Skip to main content
GET
/
api
/
v1
/
bko
/
payments
/
{paymentId}
Get Payment
curl --request GET \
  --url https://api.example.com/api/v1/bko/payments/{paymentId} \
  --header 'Authorization: Bearer <token>'
{
  "paymentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "orderId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "externalProvider": "<string>",
  "externalProviderId": "<string>",
  "description": "<string>",
  "card": {},
  "pix": {},
  "amount": 123,
  "dueDate": "2023-11-07T05:31:56Z",
  "issuedAt": "2023-11-07T05:31:56Z",
  "paidAt": "2023-11-07T05:31:56Z",
  "overdueAt": "2023-11-07T05:31:56Z",
  "canceledBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "canceledAt": "2023-11-07T05:31:56Z",
  "createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
paymentId
string<uuid>
required

Payment identifier

Example:

"0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a"

Query Parameters

​
fields
string

Comma-separated list of fields to include in the response. Supports dot notation for nested projection (e.g. id,name,user.email,trips.route.id). Unknown fields are silently dropped.

Response

OK

Pagamento único associado a um pedido

​
paymentId
string<uuid>
required

Identificador único

​
orderId
string<uuid>
required

Referência ao pedido (relação 1:1)

​
organizationId
string<uuid>
required

Referência à organização da empresa beneficiária

​
companyId
string<uuid>
required

Referência à empresa beneficiária

​
externalProvider
string
required

Nome do provedor externo de pagamento

​
externalProviderId
string
required

ID da transação no provedor externo

​
description
string | null
required

Descrição do pagamento

​
method
enum<string>
required

Método de pagamento

Available options:
CASH,
PIX,
CREDIT_CARD,
DEBIT_CARD
​
channel
enum<string>
required

Canal em que o pagamento foi criado

Available options:
ONLINE,
POS
​
card
object | null
required

Metadados do cartão (quando aplicável)

​
pix
object | null
required

Metadados do PIX (quando aplicável)

​
amount
integer
required

Valor do pagamento em centavos

​
dueDate
string<date-time> | null
required

Data de vencimento

​
status
enum<string>
required

Status do pagamento

Available options:
PENDING,
PROCESSING,
ANTIFRAUD_PENDING,
ANTIFRAUD_MANUAL,
ANTIFRAUD_APPROVED,
ANTIFRAUD_REPROVED,
PAID,
UNDERPAID,
OVERPAID,
PARTIAL_CANCELED,
CANCELED,
PAYMENT_FAILED,
REFUNDED,
CHARGEDBACK
​
issuedAt
string<date-time>
required

Data de emissão

​
paidAt
string<date-time> | null
required

Data em que o pagamento foi confirmado

​
overdueAt
string<date-time> | null
required

Data em que o pagamento ficou vencido

​
canceledBy
string<uuid> | null
required

Usuário que cancelou o pagamento, quando aplicável

​
canceledAt
string<date-time> | null
required

Data de cancelamento

​
createdBy
string<uuid> | null
required

Usuário que criou o registro, quando aplicável

​
createdAt
string<date-time>
required

Data de criação

​
updatedBy
string<uuid> | null
required

Usuário que fez a última atualização, quando aplicável

​
updatedAt
string<date-time>
required

Data da última atualização