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
Description
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.
Request
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
Example request
cURL
JAVA
C#
PHP
1
curl --location --request GET 'https://api-stg.directa24.com/v3/payment_methods?country=BR' \
2
--header 'Authorization: Bearer your_read_only_key_here'
3
4
Copied!
1
import java.io.*;
2
import okhttp3.*;
3
4
public class main {
5
public static void main(String []args) throws IOException{
6
OkHttpClient client = new OkHttpClient().newBuilder()
7
.build();
8
Request request = new Request.Builder()
9
.url("https://api-stg.directa24.com/v3/payment_methods?country=BR")
10
.method("GET", null)
11
.addHeader("Authorization", "Bearer your_read_only_key_here")
12
.build();
13
Response response = client.newCall(request).execute();
14
System.out.println(response.body().string());
15
}
16
}
17
18
Copied!
1
using System;
2
using RestSharp;
3
4
namespace HelloWorldApplication {
5
class HelloWorld {
6
static void Main(string[] args) {
7
var client = new RestClient("https://api-stg.directa24.com/v3/payment_methods?country=BR");
8
client.Timeout = -1;
9
var request = new RestRequest(Method.GET);
10
request.AddHeader("Authorization", "Bearer your_read_only_key_here");
11
IRestResponse response = client.Execute(request);
12
Console.WriteLine(response.Content);
13
}
14
}
15
}
16
17
Copied!
1
<?php
2
3
$curl = curl_init();
4
5
curl_setopt_array($curl, array(
6
CURLOPT_URL => "https://api-stg.directa24.com/v3/payment_methods?country=BR",
7
CURLOPT_RETURNTRANSFER => true,
8
CURLOPT_ENCODING => "",
9
CURLOPT_MAXREDIRS => 10,
10
CURLOPT_TIMEOUT => 0,
11
CURLOPT_FOLLOWLOCATION => true,
12
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
13
CURLOPT_CUSTOMREQUEST => "GET",
14
CURLOPT_HTTPHEADER => array(
15
"Authorization: Bearer your_read_only_key_here"
16
),
17
));
18
19
$response = curl_exec($curl);
20
21
curl_close($curl);
22
echo $response;
23
24
Copied!
Example response
1
[
2
{
3
"country": "BR",
4
"code": "SJ",
5
"name": "Sicredi",
6
"type": "BANK_DEPOSIT",
7
"status": "OK",
8
"logo": "https://resources.directa24.com/cashin/payment_method/square/SJ.svg"
9
},
10
{
11
"country": "BR",
12
"code": "BB",
13
"name": "Banco do Brasil",
14
"type": "BANK_DEPOSIT",
15
"status": "OK",
16
"logo": "https://resources.directa24.com/cashin/payment_method/square/BB.svg",
17
"daily_average": 5,
18
"monthly_average": 5
19
},
20
{
21
"country": "BR",
22
"code": "BL",
23
"name": "Boleto",
24
"type": "VOUCHER",
25
"status": "OK",
26
"logo": "https://resources.directa24.com/cashin/payment_method/square/BL.svg",
27
"daily_average": 5,
28
"monthly_average": 5
29
},
30
{
31
"country": "BR",
32
"code": "B",
33
"name": "Bradesco",
34
"type": "BANK_DEPOSIT",
35
"status": "OK",
36
"logo": "https://resources.directa24.com/cashin/payment_method/square/B.svg",
37
"daily_average": 5,
38
"monthly_average": 5
39
},
40
{
41
"country": "BR",
42
"code": "PP",
43
"name": "Picpay",
44
"type": "VOUCHER",
45
"status": "OK",
46
"logo": "https://resources.directa24.com/cashin/payment_method/square/PP.svg",
47
"daily_average": 5,
48
"monthly_average": 5
49
},
50
{
51
"country": "BR",
52
"code": "SB",
53
"name": "Santander",
54
"type": "BANK_TRANSFER",
55
"status": "OK",
56
"logo": "https://resources.directa24.com/cashin/payment_method/square/SB.svg",
57
"daily_average": 5,
58
"monthly_average": 5
59
}
60
]
61
Copied!
Response Fields
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
nameString
Payment method name
statusString
Status of the payment method. It will be updated in case a payment methods becomes momentaneously unavailable
logoString
URL containing the payment method logo
daily_averageNumber
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_averageNumber
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 types
payment_type
Description
Icon
BANK_DEPOSITBank deposits
BANK_TRANSFERElectronic Funds Transfer (TEF)
CREDIT_CARDCredit and Debit card methods
Payment Methods
Check the Payment Methods page for the full list of payment methods.
Last modified 8mo ago