5. Bank List

Retrieve a list with all available banks for P4F GO OUT API.

5.1 Bank List API Request

Retrieve a List of Bank available for PIX Bank Account

get

Header parameters

merchantIdstringOptional

hashstringOptional

Responses

200

Success

text/plainapplication/jsontext/jsonapplication/xmltext/xml

bankCodestring · nullableOptional

bankNamestring · nullableOptional

400

Bad Request

text/plainapplication/jsontext/jsonapplication/xmltext/xml

get

/1.0/GoOut/BankList

HTTPcURLJavaScriptPython

GET /1.0/GoOut/BankList HTTP/1.1
Accept: */*

[
  {
    "bankCode": "text",
    "bankName": "text"
  }
]

5.2 A Header Sample:

{
    merchantId: 123456,
    hash: "xxxxxxxxx"
    Content-Type: "application/json"
}

5.3 A Response Sample:

[
    {
        "bankCode": "001",
        "bankName": "Banco do Brasil"
    },
    {
        "bankCode": "003",
        "bankName": "Banco Santander"
    }, …
]

5.4 Bank List Method Hash Seed Strings:

Concatenate the following information, in that order, to obtain the seed string for hash generation for Bank List requests (check Appendix – Generating the Hash section):

• Merchant’s ID

• Merchant’s secret

Assuming merchant’s ID is 34567 and merchant’s secret is “abcdef”, the seed string for hash generation would be:

Seed string = 34567abcdef

5.5 List of Possible Errors

• HTTP Status Code 400 (Bad Request):

  • MERCHANT_NOT_FOUND: The specified merchant was not found. Ensure that a valid merchant identifier is provided.

  • PROCESSING_ERROR: An error occurred during the processing of the request. It's advisable to review the request and try again.

• HTTP Status Code 200 (Success):

  • This status code indicates that the request was successful, and the list of banks has been retrieved.