Payment Methods Endpoint

The Payment Methods endpoint allows you to retrieve the complete list of payment methods you have available for the country specified

post
Payment Methods API

https://api.directa24.com/api_curl/apd/get_banks_by_country
STG: POST https://api-stg.directa24.com/api_curl/apd/get_banks_by_country This endpoint returns a list of the Payment Methods available for a specific country. Use this API to show on your Deposit Page the payment methods available.
Request
Response
Request
Headers
Content-Type
required
string
application/x-www-form-urlencoded
Body Parameters
x_login
required
string
Your Directa24 WEB STATUS API Key, found on the Merchant Panel by going to Settings -> API Access -> Web Status Credentials -> API Key
x_trans_key
required
string
Your Directa24 WEB STATUS API Passphrase, found on Merchant Panel by going to Settings -> API Access -> Web Status Credentials -> API Passphrase
country_code
required
string
Country ISO code
type
optional
string
The format of the response: JSON, XML or STRING. If none is specified the response will be in XML
Response
200: OK
Payment Methods list
[
{
"code": "BL",
"name": "Boleto",
"logo": "https://resources.directa24.com/cashin/payment_method/square/BL.svg",
"payment_type": "02"
},
{
"code": "PP",
"name": "Picpay",
"logo": "https://resources.directa24.com/cashin/payment_method/square/PP.svg",
"payment_type": "02"
},
{
"code": "BB",
"name": "Banco do Brasil",
"logo": "https://resources.directa24.com/cashin/payment_method/square/BB.svg",
"payment_type": "00"
},
{
"code": "B",
"name": "Bradesco",
"logo": "https://resources.directa24.com/cashin/payment_method/square/B.svg",
"payment_type": "00"
},
{
"code": "VI",
"name": "Visa",
"logo": "https://resources.directa24.com/cashin/payment_method/square/VI.svg",
"payment_type": "03"
},
{
"code": "MC",
"name": "Mastercard",
"logo": "https://resources.directa24.com/cashin/payment_method/square/MC.svg",
"payment_type": "03"
},
{
"code": "CA",
"name": "Caixa",
"logo": "https://resources.directa24.com/cashin/payment_method/square/CA.svg",
"payment_type": "01"
},
{
"code": "SB",
"name": "Santander",
"logo": "https://resources.directa24.com/cashin/payment_method/square/SB.svg",
"payment_type": "01"
},
{
"code": "I",
"name": "Itau",
"logo": "https://resources.directa24.com/cashin/payment_method/square/I.svg",
"payment_type": "00"
},
{
"code": "SJ",
"name": "Sicredi",
"logo": "https://resources.directa24.com/cashin/payment_method/square/SJ.svg",
"payment_type": "01"
},
{
"code": "BZ",
"name": "Banco Original",
"logo": "https://resources.directa24.com/cashin/payment_method/square/BZ.svg",
"payment_type": "01"
},
{
"code": "UL",
"name": "Banrisul",
"logo": "https://resources.directa24.com/cashin/payment_method/square/UL.svg",
"payment_type": "01"
},
{
"code": "SF",
"name": "Banco Safra",
"logo": "https://resources.directa24.com/cashin/payment_method/square/SF.svg",
"payment_type": "01"
},
{
"code": "LC",
"name": "Loterias Caixa",
"logo": "https://resources.directa24.com/cashin/payment_method/square/LC.svg",
"payment_type": "02"
}
]

The same information this endpoint returns can be retrieved from the Merchant Panel by going to the Payment Methods section.

All the requests must be in x-www-form-urlencoded format and contain the following header:

Content-Type: application/x-www-form-urlencoded

Example request

curl -X POST \
https://api.directa24.com/api_curl/apd/get_banks_by_country \
-H 'Content-Type: application/x-www-form-urlencoded' \
-d 'x_login=API_Key&x_trans_key=API_Passphrase&country_code=BR&type=json'

Example response

[
{
"code": "BL",
"name": "Boleto",
"logo": "https://resources.directa24.com/cashin/payment_method/square/BL.svg",
"payment_type": "02"
},
{
"code": "PP",
"name": "Picpay",
"logo": "https://resources.directa24.com/cashin/payment_method/square/PP.svg",
"payment_type": "02"
},
{
"code": "BB",
"name": "Banco do Brasil",
"logo": "https://resources.directa24.com/cashin/payment_method/square/BB.svg",
"payment_type": "00"
},
{
"code": "B",
"name": "Bradesco",
"logo": "https://resources.directa24.com/cashin/payment_method/square/B.svg",
"payment_type": "00"
},
{
"code": "CA",
"name": "Caixa",
"logo": "https://resources.directa24.com/cashin/payment_method/square/CA.svg",
"payment_type": "01"
},
{
"code": "SB",
"name": "Santander",
"logo": "https://resources.directa24.com/cashin/payment_method/square/SB.svg",
"payment_type": "01"
},
{
"code": "I",
"name": "Itau",
"logo": "https://resources.directa24.com/cashin/payment_method/square/I.svg",
"payment_type": "00"
}
]

Request fields description

Field

Format

Description

x_login

string (max length: 32)

Your Directa24 DEPOSITS API Key, found on the Merchant Panel by going to Settings -> API Access -> Deposit Credentials -> API Key

x_trans_key

string (max length: 32)

Your Directa24 DEPOSITS API Passphrase, found on the Merchant Panel by going to Settings -> API Access -> Deposit Credentials -> API Passphrase

country_code

String (2 chars)

Country ISO code. Click here to see country codes.

type

String

Response type. Example: json, xml, pipe

Click here for each payment_type code meaning shown in the get_banks_by_country API response.