Search Payments

Search for payments (payouts) using different query methods.

Environment	Base URL
Production	https://api-pix.crypto2pay.app/v2/withdrawals

---

Query by ID

GET /v2/withdrawals?id={ID}

Returns a single payment record matching the provided internal ID.

Query Parameters

Parameter	Type		Description
id	number	required	Internal payment ID returned when the payment was created.

Example Request

curl -X GET "https://api-pix.crypto2pay.app/v2/withdrawals?id=796" \
  -H "Authorization: YOUR_API_KEY"

Response 200

{
  "id": 796,
  "transaction_id": "9233a90c-1b2a-4c3d-8e5f-6a7b8c9d0e1f",
  "status": 1,
  "currency": "BRL",
  "amount": 1500,
  "e2e": "E8255720202504150900s0717459648",
  "psp_id": "psp-ref-00001234",
  "bank": {
    "type": "email",
    "bank_name": "COOPERATIVA DE CRÉDITO",
    "ispb": "82527557",
    "account_agency": "3879",
    "account_number": "7716539016157248"
  }
}

Field	Type	Description
id	number	Internal payment ID.
transaction_id	string	The transaction ID provided at creation.
status	number	Current payment status (see Payment Status Reference).
currency	string	Currency code.
amount	number	Payment amount in reais.
e2e	string	End-to-end identifier from the PIX network.
psp_id	string	PSP reference identifier.
bank	object	Beneficiary bank details.

---

Query by Transaction ID

GET /v2/withdrawals?transaction_id={TRANSACTION_ID}

Returns a single payment record matching the provided transaction ID.

Query Parameters

Parameter	Type		Description
transaction_id	string	required	The transaction ID you provided when creating the payment.

Example Request

curl -X GET "https://api-pix.crypto2pay.app/v2/withdrawals?transaction_id=9233a90c-1b2a-4c3d-8e5f-6a7b8c9d0e1f" \
  -H "Authorization: YOUR_API_KEY"

Response 200

{
  "id": 796,
  "transaction_id": "9233a90c-1b2a-4c3d-8e5f-6a7b8c9d0e1f",
  "status": 1,
  "currency": "BRL",
  "amount": 1500,
  "e2e": "E8255720202504150900s0717459648",
  "psp_id": "psp-ref-00001234",
  "bank": {
    "type": "email",
    "bank_name": "COOPERATIVA DE CRÉDITO",
    "ispb": "82527557",
    "account_agency": "3879",
    "account_number": "7716539016157248"
  }
}

---

Query by Period

GET /v2/withdrawals/period

Returns a paginated list of payments within a specified date/time range.

Query Parameters

Parameter	Type		Description
start	string	required	Start of the period in ISO 8601 format (e.g. 2025-01-01T00:00:00).
end	string	required	End of the period in ISO 8601 format (e.g. 2025-01-31T23:59:59).
page	number	optional	Page number (default: 1).
size	number	optional	Number of records per page (default: 20).
status	number	optional	Filter by payment status code.

Example Request

curl -X GET "https://api-pix.crypto2pay.app/v2/withdrawals/period?start=2025-01-01T00:00:00&end=2025-01-31T23:59:59&page=1&size=20" \
  -H "Authorization: YOUR_API_KEY"

Response 200

{
  "count_data": 42,
  "page": 1,
  "size": 20,
  "count_pages": 3,
  "data": [
    {
      "id": 796,
      "transaction_id": "9233a90c-1b2a-4c3d-8e5f-6a7b8c9d0e1f",
      "status": 1,
      "currency": "BRL",
      "amount": 1500
    }
  ]
}

Field	Type	Description
count_data	number	Total number of records matching the query.
page	number	Current page number.
size	number	Number of records per page.
count_pages	number	Total number of pages available.
data	array	Array of payment objects.

---

Query by Customer

GET /v2/withdrawals/customer?document_number={DOCUMENT_NUMBER}

Returns all payments associated with a specific customer document (CPF or CNPJ).

Query Parameters

Parameter	Type		Description
document_number	string	required	Customer CPF or CNPJ — digits only, no punctuation.

Example Request

curl -X GET "https://api-pix.crypto2pay.app/v2/withdrawals/customer?document_number=12345678900" \
  -H "Authorization: YOUR_API_KEY"

Response 200

[
  {
    "id": 796,
    "transaction_id": "9233a90c-1b2a-4c3d-8e5f-6a7b8c9d0e1f",
    "status": 1,
    "currency": "BRL",
    "amount": 1500
  }
]

Errors

HTTP Status	Description
400	document_number is missing or not a valid CPF/CNPJ.
404	No payments found for the provided document number.

---

Export by Period (CSV)

GET /v2/withdrawals/period/csv

Exports payments within a specified date/time range as a downloadable CSV file.

Query Parameters

Parameter	Type		Description
start	string	required	Start of the period in ISO 8601 format.
end	string	required	End of the period in ISO 8601 format.
status	number	optional	Filter by payment status code.

Example Request

curl -X GET "https://api-pix.crypto2pay.app/v2/withdrawals/period/csv?start=2025-01-01T00:00:00&end=2025-01-31T23:59:59" \
  -H "Authorization: YOUR_API_KEY" \
  --output withdrawals.csv

Response

Returns a CSV file with Content-Type: text/csv. Each row represents a single payment record.

---

Payment Status Reference

Code	Status	Description
0	Created	Payment has been created and is pending processing.
1	Approved	Payment was successfully processed and delivered.
2	Rejected	Payment was rejected by the receiving institution.
3	Reversed	Payment was completed but subsequently reversed by the customer or bank.
4	Processing	Payment is currently being processed by the network.