Payment Methods
Get available payment methods
Returns the list of payment methods currently enabled for the merchant.
GET
/
v1.1
/
available_payment_methods
Get available payment methods
curl --request GET \
--url https://api.paymee.com.br/v1.1/available_payment_methods \
--header 'x-api-key: <x-api-key>' \
--header 'x-api-token: <x-api-token>'import requests
url = "https://api.paymee.com.br/v1.1/available_payment_methods"
headers = {
"x-api-key": "<x-api-key>",
"x-api-token": "<x-api-token>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {'x-api-key': '<x-api-key>', 'x-api-token': '<x-api-token>'}
};
fetch('https://api.paymee.com.br/v1.1/available_payment_methods', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.paymee.com.br/v1.1/available_payment_methods",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <x-api-key>",
"x-api-token: <x-api-token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.paymee.com.br/v1.1/available_payment_methods"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<x-api-key>")
req.Header.Add("x-api-token", "<x-api-token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.paymee.com.br/v1.1/available_payment_methods")
.header("x-api-key", "<x-api-key>")
.header("x-api-token", "<x-api-token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.paymee.com.br/v1.1/available_payment_methods")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<x-api-key>'
request["x-api-token"] = '<x-api-token>'
response = http.request(request)
puts response.read_body{
"status": 0,
"message": "success",
"payment_methods": [
{
"label": "Pagamento via PIX",
"type": "pix",
"value": "PIX"
},
{
"label": "Pagamento por transferência via Banco do Brasil",
"type": "wire_transfer",
"value": "BB_TRANSFER"
},
{
"label": "Pagamento por transferência via Bradesco",
"type": "wire_transfer",
"value": "BRADESCO_TRANSFER"
},
{
"label": "Pagamento por transferência via Caixa",
"type": "wire_transfer",
"value": "CEF_TRANSFER"
},
{
"label": "Pagamento por transferência via Santander Brasil",
"type": "wire_transfer",
"value": "SANTANDER_TRANSFER"
},
{
"label": "Pagamento por transferência via Banco BS2",
"type": "wire_transfer",
"value": "BS2_TRANSFER"
},
{
"label": "Pagamento por depósito bancário via Banco do Brasil",
"type": "cash_deposit",
"value": "BB_DI"
},
{
"label": "Pagamento por depósito bancário via Santander Brasil",
"type": "cash_deposit",
"value": "SANTANDER_DI"
}
]
}{
"errorCount": 1,
"errors": [
{
"error": "Forbidden",
"message": "Access Denied"
}
],
"message": "field validation failure",
"status": -1
}Headers
Example:
"{{your-x-api-key}}"
Example:
"{{your-x-api-token}}"
Previous
Query current balanceReturns the merchant’s current balance, the timestamp when the balance was calculated (GMT‑3), and a status/message pair indicating success or failure.
Next
⌘I
Get available payment methods
curl --request GET \
--url https://api.paymee.com.br/v1.1/available_payment_methods \
--header 'x-api-key: <x-api-key>' \
--header 'x-api-token: <x-api-token>'import requests
url = "https://api.paymee.com.br/v1.1/available_payment_methods"
headers = {
"x-api-key": "<x-api-key>",
"x-api-token": "<x-api-token>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {'x-api-key': '<x-api-key>', 'x-api-token': '<x-api-token>'}
};
fetch('https://api.paymee.com.br/v1.1/available_payment_methods', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.paymee.com.br/v1.1/available_payment_methods",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <x-api-key>",
"x-api-token: <x-api-token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.paymee.com.br/v1.1/available_payment_methods"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<x-api-key>")
req.Header.Add("x-api-token", "<x-api-token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.paymee.com.br/v1.1/available_payment_methods")
.header("x-api-key", "<x-api-key>")
.header("x-api-token", "<x-api-token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.paymee.com.br/v1.1/available_payment_methods")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<x-api-key>'
request["x-api-token"] = '<x-api-token>'
response = http.request(request)
puts response.read_body{
"status": 0,
"message": "success",
"payment_methods": [
{
"label": "Pagamento via PIX",
"type": "pix",
"value": "PIX"
},
{
"label": "Pagamento por transferência via Banco do Brasil",
"type": "wire_transfer",
"value": "BB_TRANSFER"
},
{
"label": "Pagamento por transferência via Bradesco",
"type": "wire_transfer",
"value": "BRADESCO_TRANSFER"
},
{
"label": "Pagamento por transferência via Caixa",
"type": "wire_transfer",
"value": "CEF_TRANSFER"
},
{
"label": "Pagamento por transferência via Santander Brasil",
"type": "wire_transfer",
"value": "SANTANDER_TRANSFER"
},
{
"label": "Pagamento por transferência via Banco BS2",
"type": "wire_transfer",
"value": "BS2_TRANSFER"
},
{
"label": "Pagamento por depósito bancário via Banco do Brasil",
"type": "cash_deposit",
"value": "BB_DI"
},
{
"label": "Pagamento por depósito bancário via Santander Brasil",
"type": "cash_deposit",
"value": "SANTANDER_DI"
}
]
}{
"errorCount": 1,
"errors": [
{
"error": "Forbidden",
"message": "Access Denied"
}
],
"message": "field validation failure",
"status": -1
}
