Tipos de Pagamento

Visão Geral

Este grupo cobre os tipos de pagamento habilitados pela integração e as configurações que governam como cada tipo se comporta no fluxo transacional.

Ele funciona como base de parametrização para criação e manutenção de opções de pagamento, garantindo que front-end e operação administrativa usem combinações compatíveis com as regras do gateway.

Entidades Envolvidas

O ponto principal deste grupo é o tipo de pagamento, que define o comportamento funcional de cada forma de cobrança disponível na loja.

Cada tipo possui um conjunto de configurações associadas, que orientam como a opção de pagamento deve operar em cenários específicos.

As opções de pagamento consomem essas definições para se materializar no checkout e no fluxo administrativo.

Tudo isso é condicionado pelo meio de pagamento ativo, que determina quais tipos e configurações podem ser utilizados em cada integração.

Listagem de Tipos de Pagamento

Descrição

Retorna os tipos de pagamento cadastrados e expostos pela integração.

Os tipos retornados representam as modalidades disponíveis para composição de opções de pagamento (por exemplo, pix, cartão, boleto), servindo como base para cadastro e atualização de opções.

Parâmetros

Cabeçalhos Obrigatórios

Exemplo de Requisição

1curl --request GET \
2  --url '{{MAIN_URL}}/payments/types' \
3  --header 'Authorization: Bearer SEU_TOKEN_AQUI'

✅ Resposta de Sucesso

1{
2  "status": true,
3  "data": [
4    {
5      "id": 1,
6      "code": "pix"
7    },
8    {
9      "id": 2,
10      "code": "credit-card"
11    },
12    {
13      "id": 3,
14      "code": "internal-deposit"
15    }
16  ]
17}

Configurações por Tipo de Pagamento

Descrição

Retorna as configurações disponíveis para o tipo identificado por paymentTypeId.

Parâmetros

Cabeçalhos Obrigatórios

Parâmetros de URL

Exemplo de Requisição

1curl --request GET \
2  --url '{{MAIN_URL}}/payments/types/1/configurations' \
3  --header 'Authorization: Bearer SEU_TOKEN_AQUI'

✅ Resposta de Sucesso

1{
2  "status": true,
3  "data": [
4    {
5      "id": 1,
6      "code": "max-number-installment",
7      "enum": null,
8      "type": "int",
9      "title": "Número máximo de parcelas",
10      "value": 12
11    }
12  ]
13}

Exemplo para Depósito Interno (internal-deposit)

Para o tipo internal-deposit, a configuração disponível é bank-account-map:

1{
2  "status": true,
3  "data": [
4    {
5      "id": 1,
6      "code": "bank-account-map",
7      "enum": null,
8      "type": "json",
9      "title": "Mapa de contas bancárias",
10      "value": []
11    }
12  ]
13}

> A configuração bank-account-map define as contas bancárias disponíveis para seleção no checkout. Seu valor é configurado via PUT /payments/options/{paymentOptionId}/configure.

⚠️ Possíveis erros: