get https://{providerApiEndpoint}/payment-methods
Return all payment methods that your provider can handle. Please make sure you are returning only supported payment methods as listed above.
Important: this endpoint must be public, and should not require X-VTEX-API-AppKey
/X-VTEX-API-AppToken
headers.
Response body
Name | Type | Mandatory | Description |
---|---|---|---|
paymentMethods |
string | Yes | List of each payment method implemented |
Available payment methods
Payment Method | Type | Country |
---|---|---|
Visa |
Credit Card | Global |
Mastercard |
Credit Card | Global |
American Express |
Credit Card | Global |
Discover |
Credit Card | Global |
JCB |
Credit Card | Global |
Diners |
Credit Card | Global |
Elo |
Credit Card | Brazil |
Hipercard |
Credit Card | Brazil |
Aura |
Credit Card | Brazil |
Banricompras |
Credit Card | Brazil |
Credz |
Credit Card | Brazil |
VirtualDebitElo |
Debit Card | Brazil |
Cabal |
Credit Card | Argentina, Brazil, Uruguay, Paraguay |
Visa Electron |
Debit Card | Global |
Maestro |
Debit Card | Global |
Mastercard Debit |
Debit Card | Global |
Cobranded |
Card | Global |
Privatelabels |
Card | Global |
Promissories |
Generic | Global |
Cash |
Generic | Global |
BankInvoice |
Offline/Voucher | Brazil (Boleto Bancário) |
Pix |
Online Transfer | Brazil |
SPEI |
Online Transfer | Mexico |
Safetypay |
Online Transfer | Americas and Europe |
Bitcoin |
Cryptocurrency | Global |
Branded/Local Payment Methods |
---|
PinCash , LevPay , PayMee , PicPay , Losango , PagoLivre , Pagomio , PagSeguro , PlaceToPay |
Request examples and their responses
curl --location --request GET 'https://{{providerApiEndpoint}}/payment-methods' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json'
{
"paymentMethods": [
"Visa",
"Mastercard",
"Pix",
"American Express",
"BankInvoice",
"Privatelabels",
"Promissories"
]
}