Skip to main content
GET
/
charge
/
{chargeId}
curl -X GET "https://api.gates2b.com/charge/{chargeId}" \
  -H "Authorization: Bearer {your-token}"

{
  "id": "chr_abc123",
  "grossAmount": "10.50",
  "currency": "BRL",
  "status": "PENDING",
  "description": "Test charge",
  "externalReference": "order-123",
  "createdAt": "2026-01-15T14:00:00.000Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.gates2b.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Authorization
string
required
Bearer authentication token.
​
chargeId
string
required
Charge ID.

​
Response

​
id
string
Unique charge ID.
​
grossAmount
string
Gross amount.
​
currency
string
Charge currency.
​
status
string
Current charge status (PENDING, PAID, EXPIRED, CANCELED).
​
description
string
Charge description.
​
externalReference
string
External reference.
​
createdAt
string
Creation date (ISO 8601).
curl -X GET "https://api.gates2b.com/charge/{chargeId}" \
  -H "Authorization: Bearer {your-token}"

{
  "id": "chr_abc123",
  "grossAmount": "10.50",
  "currency": "BRL",
  "status": "PENDING",
  "description": "Test charge",
  "externalReference": "order-123",
  "createdAt": "2026-01-15T14:00:00.000Z"
}

​
Other available queries

​
List Charges

GET /charge/list?page=1&limit=10 Returns a paginated list of charges for the authenticated user.
ParameterTypeDescription
pagenumberPage number (default: 1)
limitnumberRecords per page (default: 10)

​
Get by External Reference

GET /charge?externalReference=order-123 Finds a charge by the external reference from your system.
ParameterTypeDescription
externalReferencestringExternal reference used at creation

​
List Charge Attempts

GET /charge/{chargeId}/attempts Returns all payment attempts associated with a charge. Each attempt contains:
FieldTypeDescription
idstringAttempt ID
chargeIdstringCharge ID
paymentMethodstringMethod used (PIX, CREDIT_CARD, INTERNATIONAL)
statusstringAttempt status
checkoutMetaobjectGateway metadata

​
Get Specific Attempt

GET /charge/attempts/{attemptId} Returns the details of a specific attempt, including gateway status and checkoutMeta.