Pix on File Bank List
PIX Jornada Sem Redirecionamento is fully coordinated by the Central Bank (Banco Central), and all major financial institutions and payment institutions with over 500,000 active accounts (which are obligated to offer Pix) are either required to or are in the process of implementing it.
To know which banks currently accept account linking, consult EBANX Bank List.
Requirements
- EBANX Account
- API Credentials - Ensure you have your EBANX integration Key. If not, complete the Merchant Signup Form.
Pix on File is processed by the EBANX Brazilian payment institution, so all requests must be sent to the local hosts below — not to the cross-border hosts used by other payment methods.
- Sandbox:
https://sandbox-local-latam.ebanxpay.com - Production:
https://api-local-latam.ebanxpay.com
See the API endpoints reference for the complete tenant and environment list.
Instructions
To get the list of banks currently enabled for PIX JSR, follow the steps below.
This is a GET request and all parameters are sent as query string parameters. Do not send a request body.
| Parameter | Requirement | Description |
|---|---|---|
integration_key | Required | Your integration key |
country | Required | Must be br |
payment_type | Required | Must be pix-jsr |
This endpoint reads the payment method from payment_type. Any other name — including payment_type_code, used by the payment and enrollment endpoints — is ignored, and the request still returns HTTP 200 with a generic Brazilian bank list that is not the Pix on File list. Always confirm the returned codes come from this endpoint with payment_type=pix-jsr.
Sample Request
curl -X GET 'https://sandbox-local-latam.ebanxpay.com/ws/getBankList?integration_key={{integration_key}}&country=br&payment_type=pix-jsr'
A successful request will return a JSON response like the one below, containing an array of banks. The values listed as {bank_code} are the acceptable enrollment.account_details.bank_id values when initiating Device Linking.
[
{
"code": "{bank_code}",
"name": "{bank_name}",
"logo_url": "{bank_logo_svg}"
}
]
logo_url is only present when the institution has a logo registered, so treat it as optional when rendering a bank selector.