Skip to main content
GET
Get Payment

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

Payment

paymentId
string<uuid>
required

Payment identifier

Example:

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

orderId
string<uuid> | null
required

Order identifier

Example:

null

organizationId
string<uuid>
required

Organization identifier

Example:

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

organization
object
required

Organization

cooperativeId
string<uuid>
required

Cooperative identifier

Example:

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

cooperative
object
required

Cooperative

externalProvider
string
required

External provider name

Example:

"mock"

externalProviderId
string
required

External payment identifier

Example:

"pay_a1b2c3d4"

externalOrderId
string | null
required

External order identifier

Example:

"order_a1b2c3d4"

method
enum<string>
required

Payment method

Available options:
CASH,
PIX,
CREDIT_CARD,
DEBIT_CARD
Example:

"PIX"

channel
enum<string>
required

Payment channel

Available options:
ONLINE,
POS,
DRIVER_APP
Example:

"ONLINE"

amount
integer
required

Total amount in cents

Example:

15000

status
enum<string>
required

Payment status

Available options:
ANTIFRAUD_APPROVED,
ANTIFRAUD_MANUAL,
ANTIFRAUD_PENDING,
ANTIFRAUD_REPROVED,
CANCELED,
CHARGEDBACK,
OVERPAID,
PAID,
PARTIAL_CANCELED,
PAYMENT_FAILED,
PENDING,
PROCESSING,
REFUNDED,
UNDERPAID
Example:

"PENDING"

issuedAt
string<date-time>
required

Issued at

Example:

"2026-01-01T00:00:00.000Z"

createdAt
string<date-time>
required

Created at

Example:

"2026-01-01T00:00:00.000Z"

updatedAt
string<date-time>
required

Updated at

Example:

"2026-01-01T00:00:00.000Z"

cashSettlementId
string<uuid> | null

Cash settlement identifier

Example:

null

description
string | null

Payment description

Example:

"Order payment"

card
object | null

Card details

pix
object | null

Pix details

canceledBy
string<uuid> | null

Canceled by

Example:

null

createdBy
string<uuid> | null

Created by

Example:

null

updatedBy
string<uuid> | null

Updated by

Example:

null

dueDate
string<date-time> | null

Due date

Example:

"2026-01-15T00:00:00.000Z"

paidAt
string<date-time> | null

Paid at

Example:

"2026-01-01T00:00:00.000Z"

overdueAt
string<date-time> | null

Overdue at

Example:

"2026-01-20T00:00:00.000Z"

canceledAt
string<date-time> | null

Canceled at

Example:

"2026-01-10T00:00:00.000Z"