Skip to main content
GET
/
v1
/
charges
Get all charges
curl --request GET \
  --url https://api-global.fastpaybrasil.com/v1/charges \
  --header 'Authorization: Basic <encoded-value>'
{
  "data": [
    {
      "id": "2vorkDcXyvzifL63YX09S9VqcnI",
      "status": "paid",
      "pspRefId": "ch_123456789",
      "amount": 100.5,
      "currency": "USD",
      "spread": 2.5,
      "net": 98,
      "customer": {
        "id": "2vorkDcXyvzifL63YX09S9VqcnI",
        "name": "John Doe",
        "email": "[email protected]",
        "document": "123.456.789-00"
      },
      "paymentMethod": {
        "type": "credit_card",
        "firstSix": "123456",
        "lastFour": "7890",
        "expirationMonth": "08",
        "expirationYear": "2024",
        "holderName": "John Doe",
        "installments": 3
      },
      "merchantId": "2vorkDcXyvzifL63YX09S9VqcnI",
      "paymentDetails": {
        "firstSix": "123456",
        "lastFour": "7890",
        "expirationMonth": "08",
        "expirationYear": "2024",
        "holderName": "John Doe",
        "installments": 3
      },
      "metadata": {
        "order_id": "123",
        "user_id": "456"
      },
      "paidAt": "2023-01-15T14:30:00Z",
      "createdAt": "2023-01-15T14:30:00Z",
      "updatedAt": "2023-01-15T14:30:00Z"
    }
  ],
  "page": 1,
  "pages": 10,
  "total": 100,
  "size": 10
}

Authorizations

​
Authorization
string
header
required

HTTP Basic authentication. Use your secret key as the username and an empty string as password. The API key should be base64 encoded in the format 'username:' when sending the Authorization header.

Query Parameters

​
page
integer
default:1

Page number (starts at 1)

Example:

1

​
size
integer
default:10

Number of items per page

Example:

20

​
orderBy
string

Order results by fields (comma-separated). Prefix with - for descending order.

Example:

"createdAt,-amount"

​
status
enum<string>

Filter charges by status

Available options:
paid,
pending,
refused,
failed,
refunded,
in_analysis,
authentication_required
Example:

"paid"

​
merchantId
string

Filter charges by merchant ID

Example:

"2vorkDcXyvzifL63YX09S9VqcnI"

Response

Successfully retrieved the list of charges

​
data
object[]

Array of charges in the current page

​
page
integer

Current page number

Example:

1

​
pages
integer

Total number of pages available

Example:

10

​
total
integer

Total number of charges across all pages

Example:

100

​
size
integer

Number of charges per page

Example:

10