Get Charge

Retrieves charges by ID, external reference, paginated listing, and payment attempts.

GET /charge/{chargeId}

cURL

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

Success

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

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

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

Success

{
  "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.

Parameter	Type	Description
page	number	Page number (default: 1)
limit	number	Records per page (default: 10)

Get by External Reference

GET /charge?externalReference=order-123

Finds a charge by the external reference from your system.

Parameter	Type	Description
externalReference	string	External reference used at creation

List Charge Attempts

GET /charge/{chargeId}/attempts

Returns all payment attempts associated with a charge. Each attempt contains:

Field	Type	Description
id	string	Attempt ID
chargeId	string	Charge ID
paymentMethod	string	Method used (PIX, CREDIT_CARD, INTERNATIONAL)
status	string	Attempt status
checkoutMeta	object	Gateway metadata

Get Specific Attempt

GET /charge/attempts/{attemptId}

Returns the details of a specific attempt, including gateway status and checkoutMeta.