Pular para o conteúdo principal

Listar métodos de pagamento

POST /list_payments_method

Retorna os métodos de pagamento disponíveis para uso em cobranças, pedidos de venda e contratos.

Autenticação

CampoTipoObrigatório
access_tokenstringSim
unit_tokenstringSim

Request

{
"access_token": "<access_token>",
"unit_token": "<unit_token>"
}

Response

Esta rota usa o envelope legado do backend atual.

{
"status": 200,
"response": {
"success": true,
"data": [
{
"token": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"name": "Transferência"
},
{
"token": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"name": "PIX"
},
{
"token": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"name": "Cartão de crédito"
}
]
}
}

Campos retornados

CampoTipoDescrição
tokenstringIdentificador do método de pagamento.
namestringNome exibido no sistema.

Uso prático

O token retornado é o valor que deve ser enviado em campos como charge.payment_type no cadastro de pedidos de venda e contratos.