Esta documentação está em processo de atualização e, por enquanto, representa apenas uma versão preliminar do conteúdo disponível sobre a API. As informações, exemplos e recursos descritos podem evoluir à medida que novas funcionalidades são incorporadas e ajustes técnicos realizados. Recomenda-se consultar este espaço regularmente para acessar as novidades e garantir o uso mais atualizado da integração.

Para dúvidas, nos contate via: [email protected]


📥 Status HTTP

  • 200 OK – Sucesso.

  • 201 Created – Recurso criado.

  • 204 No Content – Operação sem retorno.

  • 400 Bad Request – Dados inválidos.

  • 401 Unauthorized – Token ausente ou inválido.

  • 403 Forbidden – Acesso negado.

  • 404 Not Found – Recurso inexistente.

  • 500 Internal Server Error – Erro interno.


🔒 Autenticação

  • POST {{baseUrl}}/external-payments/v1.0/login


Request Body:

{
  "username": "usuario_exemplo",
  "password": "senha_exemplo"
}

Response 200 OK:

 [
  {
    "providerId": 123,
    "displayName": "Provedor Exemplo",
    "methods": [...],
    "configurationProperties": [...]
  }
]



📂 Estrutura de Endpoints

Imagem geradaProvedores de Pagamento:


  • GET /external-payments/v1.0/providers → Lista os provedores de pagamento.


Exemplo de Request Body:

GET {{baseUrl}}/external-payments/v1.0/providers?pageNumber=1&pageSize=10&tenantId=5


Parâmetros Query (opcionais):

  • pageNumber: inteiro (número da página)

  • pageSize: inteiro (tamanho da página)

  • tenantId: inteiro (filtra por tenant)


Response 200 OK:

[
  {
    "providerId": 1,
    "displayName": "Provedor A",
    "methods": [
      {
        "methodId": 10,
        "providerId": 1,
        "paymentTypeId": 101
      }
    ],
    "configurationProperties": [
      {
        "configurationPropertyId": 1001,
        "providerId": 1,
        "name": "ApiKey",
        "displayName": "Chave API",
        "hint": "Chave fornecida pelo provedor",
        "isRequired": true,
        "inputDataType": 1,
        "isSecret": true,
        "configurationOptions": []
      }
    ]
  }
]


  • POST /external-payments/v1.0/providers → Cria um novo provedor de pagamento.


Exemplo de Request Body:

{
  "providerId": 0,
  "displayName": "Novo Provedor",
  "methods": [
    {
      "methodId": 0,
      "providerId": 0,
      "paymentTypeId": 101
    }
  ],
  "configurationProperties": [
    {
      "configurationPropertyId": 0,
      "providerId": 0,
      "name": "ApiKey",
      "displayName": "Chave API",
      "hint": "Chave fornecida pelo provedor",
      "isRequired": true,
      "inputDataType": 1,
      "isSecret": true,
      "configurationOptions": []
    }
  ]
}

Response 201 Created:

{
  "providerId": 2,
  "displayName": "Novo Provedor",
  "methods": [...],
  "configurationProperties": [...]
}


  • GET /external-payments/v1.0/providers/{id} → Busca um provedor pelo ID


Exemplo de Request:

GET {{baseUrl}}/external-payments/v1.0/providers/1

Response 200 OK:

{
  "providerId": 1,
  "displayName": "Provedor A",
  "methods": [...],
  "configurationProperties": [...]
}


  • PUT /external-payments/v1.0/providers/{id} → Atualiza um provedor pelo ID.


Exemplo de Request:

{
  "providerId": 1,
  "displayName": "Novo Provedor",
  "methods": [
    {
      "methodId": 0,
      "providerId": 0,
      "paymentTypeId": 101
    }
  ],
  "configurationProperties": [
    {
      "configurationPropertyId": 0,
      "providerId": 0,
      "name": "ApiKey",
      "displayName": "Chave API",
      "hint": "Chave fornecida pelo provedor",
      "isRequired": true,
      "inputDataType": 1,
      "isSecret": true,
      "configurationOptions": []
    }
  ]
}

Response 200 OK:

{
  "providerId": 1,
  "displayName": "Provedor Atualizado",
  "methods": [
    {
      "methodId": 10,
      "providerId": 1,
      "paymentTypeId": 101
    },
    {
      "methodId": 11,
      "providerId": 1,
      "paymentTypeId": 102
    }
  ],
  "configurationProperties": [
    {
      "configurationPropertyId": 1001,
      "providerId": 1,
      "name": "ApiKey",
      "displayName": "Chave API",
      "hint": "Chave fornecida pelo provedor",
      "isRequired": true,
      "inputDataType": 1,
      "isSecret": true,
      "configurationOptions": []
    }
  ]
}


  • DELETE /external-payments/v1.0/providers/{id} → Remove um provedor pelo ID.


Exemplo de Request:

DELETE {{baseUrl}}/external-payments/v1.0/providers/1

Response 200 OK:

{
  "status": "success",
  "message": "Provedor removido com sucesso",
  "providerId": 1
}


Imagem geradaTipos de Pagamento


  • GET /external-payments/v1.0/paymenttypes → Recupera os tipos de pagamento disponíveis.


Exemplo de request:

GET {{baseUrl}}/external-payments/v1.0/paymenttypes

Response 200 OK:

[
  "CreditCard",
  "DebitCard",
  "Pix",
  "Boleto"
]

Imagem geradaSplit de Pagamento

  • Não disponível na V1

Imagem geradaRecorrência de pagamento:

  • Não disponível na V1