List Payments - Documentação DEVMOB

{ "data": [ { "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" } ], "meta": { "limit": 10, "page": 1, "totalItems": 142, "totalPages": 15 } }

Authorizations

Authorization

string

header

required

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

Query Parameters

limit

number

default:10

Items per page

Example:

10

page

number

default:1

Page number

Example:

1

status

enum<string>

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"

sortBy

enum<string>

default:createdAt

Field to sort by

Available options:

createdAt,

paidAt,

amount

Example:

"createdAt"

sortOrder

enum<string>

default:desc

Sort order

Available options:

asc,

desc

Example:

"desc"

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

data

object[]

required

Show child attributes