Payment Methods Endpoint
The Payment Methods endpoint allows you to retrieve the complete list of payment methods you have available for the country specified
get
https://api-stg.directa24.com
/v3/payment_methods?country={country}
Payment Methods
The
payment_methods endpoint will show you all the payment methods your account has enabled for the country specified as query params in the request.It will also show details about each payment method like the
payment method code, the payment method name, thepayment method type as well as the payment method logo and others.In case of integrating the OneShot Experience and displaying the payment methods on your cashier, make sure you check the payment methods with this API multiple times per day to make sure that in case a new payment method becomes available or unavailable, you will also automatically update it on your cashier without requiring manual intervention from either side.
In order to start using the payment methods endpoint, you need to:
- 1.Send the request with GET method.
- 2.
- 3.Send the Authorization header with your read-only API Key as Bearer as follows:
Authorization: Bearer your_read_only_key_here
cURL
JAVA
C#
PHP
curl --location --request GET 'https://api-stg.directa24.com/v3/payment_methods?country=BR' \
--header 'Authorization: Bearer your_read_only_key_here'
import java.io.*;
import okhttp3.*;
public class main {
public static void main(String []args) throws IOException{
OkHttpClient client = new OkHttpClient().newBuilder()
.build();
Request request = new Request.Builder()
.url("https://api-stg.directa24.com/v3/payment_methods?country=BR")
.method("GET", null)
.addHeader("Authorization", "Bearer your_read_only_key_here")
.build();
Response response = client.newCall(request).execute();
System.out.println(response.body().string());
}
}
using System;
using RestSharp;
namespace HelloWorldApplication {
class HelloWorld {
static void Main(string[] args) {
var client = new RestClient("https://api-stg.directa24.com/v3/payment_methods?country=BR");
client.Timeout = -1;
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer your_read_only_key_here");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);
}
}
}
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://api-stg.directa24.com/v3/payment_methods?country=BR",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => array(
"Authorization: Bearer your_read_only_key_here"
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;
[
{
"country": "BR",
"code": "BB",
"name": "Banco do Brasil",
"type": "BANK_DEPOSIT",
"status": "OK",
"logo": "https://resources.directa24.com/cashin/payment_method/square/BB.svg",
"daily_average": 5,
"monthly_average": 5
},
{
"country": "BR",
"code": "BL",
"name": "Boleto",
"type": "VOUCHER",
"status": "OK",
"logo": "https://resources.directa24.com/cashin/payment_method/square/BL.svg",
"daily_average": 5,
"monthly_average": 5
},
{
"country": "BR",
"code": "B",
"name": "Bradesco",
"type": "BANK_DEPOSIT",
"status": "OK",
"logo": "https://resources.directa24.com/cashin/payment_method/square/B.svg",
"daily_average": 5,
"monthly_average": 5
},
{
"country": "BR",
"code": "PP",
"name": "Picpay",
"type": "VOUCHER",
"status": "OK",
"logo": "https://resources.directa24.com/cashin/payment_method/square/PP.svg",
"daily_average": 5,
"monthly_average": 5
},
{
"country": "BR",
"code": "SB",
"name": "Santander",
"type": "BANK_TRANSFER",
"status": "OK",
"logo": "https://resources.directa24.com/cashin/payment_method/square/SB.svg",
"daily_average": 5,
"monthly_average": 5
}
]
The response will return an object different for each payment method. You should be able to iterate though it no matter how many payment methods are returned.
Field | Format | Description |
country | String | |
code | String | |
name | String | Payment method name |
type | String | |
status | String | Status of the payment method. It will be updated in case a payment methods becomes momentaneously unavailable |
logo | String | URL containing the payment method logo |
daily_average | Number | Daily average time for the approval of the deposits with this payment method in seconds. *Note that in case the method is new, we may not have daily average information so this field won't be returned |
monthly_average | Number | Monthly average time for the approval of the deposits with this payment method in seconds. *Note that in case the method is new, we may not have monthly average information so this field won't be returned |
We may add more fields to this response's object in the future. Please develop your integration considering that it will ignore new fields and continue working fine no matter if we add new fields.
payment_type | Description | Icon |
BANK_DEPOSIT | Bank deposits | |
BANK_TRANSFER | Electronic Funds Transfer (TEF) | |
CREDIT_CARD | Credit and Debit card methods | |
VOUCHER | Cash solutions |
Check the Payment Methods page for the full list of payment methods.
Last modified 6mo ago