List payment instructions

Lists Automatic Pix payment instructions according to the provided filters.

Each instruction represents the processing of a recurring payment at the payer's institution. Use this operation to find instructions by authorization, customer, payment or current status.

To check the details of a specific instruction, use Retrieve a single payment instruction.

📘

Tracking changes

To track creation, scheduling, refusal and cancellation of instructions, use Webhooks instead of querying this endpoint repeatedly.

The DONE status may be returned by the API, but the financial completion of the payment must be tracked through the payment events defined in the Automatic Pix flow.

See the Automatic Pix Webhook Flows.

Related content

Guides

Webhooks

Query Params
string

Filter by the unique identifier of the instruction authorization

string

Filter by unique customer identifier

string

Filter by unique payment identifier

string
enum

Filter by the status of the instruction

Allowed:
Responses

403

Forbidden. Occurs when the request body is filled, GET method calls must have an empty body.

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json