--- title: "List all Payment Authorizations" method: GET path: "/payments/br/payment-authorizations/" tags: ["Payment Authorizations (Brazil)"] --- # List all Payment Authorizations `GET /payments/br/payment-authorizations/` {% admonition type="warning" name="Coming Soon" %} This endpoint is currently undergoing development.. As such, minor changes or bugs may occur. If you encounter any issues, please contact your Belvo representative. {% /admonition %} List all Payment Authorizations associated with your Belvo account. ## Query parameters - `page` integer - `page_size` integer - `id__in` string[] - `amount` number, float - `amount__gt` number, float - `amount__gte` number, float - `amount__lt` number, float - `amount__lte` number, float - `amount__range` number[] - `created_at` string, date - `created_at__gt` string, date - `created_at__gte` string, date - `created_at__lt` string, date - `created_at__lte` string, date - `created_at__range` string[] - `customer` string, uuid - `customer__in` string[] - `external_id` string, uuid - `external_id__in` string[] - `search` string - `updated_at` string, date - `updated_at__gt` string, date - `updated_at__gte` string, date - `updated_at__lt` string, date - `updated_at__lte` string, date - `updated_at__range` string[] ## Headers - `X-Belvo-API-Resource-Version` 'Payments-BR.V2' ## Response `200` OK - object - `count` integer — The total number of results in your Belvo account. - `next` string, uri, nullable — The URL to next page of results. Each page consists of up to 100 items. If there are not enough results for an additional page, the value is `null`. In our documentation example, we use `{endpoint}` as a placeholder value. In production, this value will be replaced by the actual endpoint you are currently using (for example, `accounts` or `owners`). - `previous` string, uri, nullable — The URL to the previous page of results. If there is no previous page, the value is `null`. - `results` PaymentAuthorization[] — Array of Payment Authorization objects. - `id` string, uuid, required — The Belvo ID for the Payment Authorization. - `created_at` string, date-time, required — The ISO-8601 timestamp of when the Payment Authorization was created. - `updated_at` string, date-time, required — The ISO-8601 timestamp of when the Payment Authorization was last updated. - `status` 'AWAITING_AUTHORIZATION' | 'PARTIALLY_ACCEPTED' | 'AUTHORIZED' | 'FAILED' | 'CONSUMED' | 'REVOKED', required — The current status of the Payment Authorization. - `status_reason_code` string, nullable, required — A code indicating the reason for the current status (when applicable). For a full list of possible codes and messages, please see our dedicated Error Codes and Messages article. - `status_reason_message` string, nullable, required — A human-readable message explaining the reason for the current status (when applicable). - `status_updated_at` string, date-time, required — The ISO-8601 timestamp of when the status was last updated. - `authorized_at` string, date-time, nullable, required — The ISO-8601 timestamp of when the Payment Authorization was authorized by the user. - `external_id` string, uuid, nullable, required — The merchant's internal ID for the authorization. - `description` string, required — An internal description used by the merchant only. - `return_url` string, uri, required — The URL where the user will be redirected after authorization. - `payment_method` 'PIX_OF_IMMEDIATE' | 'PIX_OF_SCHEDULED', required — The payment method that was authorized. - `payer` object, required — Details regarding the payer. - `customer` string, uuid — The Belvo ID for the customer. - `institution` string, uuid — The Belvo ID of the institution that the payer will use. - `representative_identifier` string — In the case that the customer is a business, the CPF of the representative authorized to make payments. - `beneficiary` object, required — Details regarding the beneficiary of the payment. - `type` 'BANK_ACCOUNT' — The type of beneficiary account. - `target` string, uuid — The Belvo ID of the bank account that will receive funds. - `payment_method_configuration` union, required — Configuration details for the payment method. - object — Configuration details for the `PIX_OF_IMMEDIATE` payment method. - `amount` string — The amount that your customer will be charged. - `statement_description` string — The description that will appear on your customer's bank statement. - `authorization_url` string, uri — The URL where the user should be redirected to authorize the payment. - object — Configuration details for the `PIX_OF_SCHEDULED` payment method. - `amount` string — The amount that your customer will be charged. - `statement_description` string — The description that will appear on your customer's bank statement. - `dates` string[] — The date that the payment is scheduled to be made, in `YYYY-MM-DD` format. - `authorization_url` string, uri — The URL where the user should be redirected to authorize the payment. - `charges` string[], required — A list of Charge IDs associated with the Payment Authorization. - `metadata` MetadataPayments — Optional and customizable object where you can provide any additional key-value pairs for your internal purposes. For example, an internal reference number for the payment intent. {% admonition type="info" name="Metadata Limitations" %} You can only provide up to 50 keys (keys can have up to 50 characters each and each value can be up to 500 characters). We do not support nested objects, only ASCII values. {% /admonition %} ## Other responses - `401` — Unauthorized - `403` — Access to Belvo API denied - `404` — Not Found Error - `408` — Request Timeout - `500` — Unexpected Error --- [API](https://skmtc.net/belvo/apis/belvo-api-docs.md) · [All operations](https://skmtc.net/belvo/apis/belvo-api-docs/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/belvo/belvo-api-docs/revisions/e82dca4a4b97/schema)