Listar métodos de pagamento

POST /list_payments_method

Retorna a lista de métodos de pagamento disponíveis para uma unidade. Esses métodos são utilizados principalmente em cobranças, pedidos de venda e contratos, especialmente no campo charge.payment_type.

---

Autenticação (obrigatório)

Campo	Tipo	Obrigatório	Descrição
access_token	string	Sim	Token de autenticação
unit_token	string	Sim	Token da unidade

---

Request

Exemplo de payload

{
  "access_token": "SEU_ACCESS_TOKEN",
  "unit_token": "SEU_UNIT_TOKEN"
}

---

Response

Sucesso — 200 OK

{
  "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"
      },
      {
        "token": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
        "name": "Boleto bancário"
      },
      {
        "token": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
        "name": "Dinheiro"
      }
    ]
  }
}

---

Estrutura do retorno

Campo	Tipo	Descrição
token	string	Token do método de pagamento
name	string	Nome do método de pagamento

---

Uso prático

O campo token retornado deve ser utilizado em outros endpoints, por exemplo:

Pedido de venda / cobrança

{
  "charge": {
    "payment_type": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
    "provider_bank": "asaas"
  }
}

---

Observações importantes

• A lista pode variar de acordo com a unidade.
• O token é o valor persistido e utilizado internamente.
• O name é apenas informativo para exibição em tela.
• Alguns métodos exigem campos adicionais em cobranças (ex.: cartão, boleto, PIX).

---

Erros comuns

Status	Descrição
403	Invalid data (token inválido ou sem permissão)
500	Erro interno ao listar métodos de pagamento