EnterPay API Docs V1
  1. Cobrança
EnterPay API Docs V1
  • Referência de API
  • Autenticação
  • Erros
  • Clientes
    • Buscar um cliente
      GET
    • Listar meus clientes
      GET
    • Cadastrar novo cliente
      POST
    • Atualizar dados do cliente
      PUT
    • Remover cliente
      DELETE
  • Cobrança
    • Listar minhas cobranças
      GET
    • Criar uma nova cobrança
      POST
  • Configurações da conta
    • Empresa
      • Atualizar dados da empresa
      • Obter informações da empresa
    • Customização
      • Atualizar dados de customização
      • Obter dados de customização
  • Webhook
    • UpdateStatus
      POST
  1. Cobrança

Criar uma nova cobrança

POST
/api/billings

Requisição

Authorization
Forneça seu token bearer no cabeçalho
Authorization
ao fazer requisições para recursos protegidos.
Exemplo:
Authorization: Bearer ********************
Parâmetros Bodyapplication/json

Exemplo
{
    "billing": {
        "type": "one_time",
        "frequency": null,
        "title": "15 Caixa de frutas - Kiwi  - Bruno3",
        "description": "lorem ipsum",
        "amount": 21000,
        "customer_id": 1
    },
    "payment_settings": [
        {
            "max_installments": 12,
            "discount_percentage": 0,
            "billing_date": "2024-10-29",
            "payment_type_id": 1
        },
        {
            "max_installments": 5,
            "discount_percentage": 0,
            "billing_date": "2024-10-29",
            "payment_type_id": 2
        },
        {
            "max_installments": 5,
            "discount_percentage": 0,
            "billing_date": "2024-10-29",
            "payment_type_id": 3
        }
    ]
}

Códigos de solicitação

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://sandbox.enterpay.com.br/api/billings' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "billing": {
        "type": "one_time",
        "frequency": null,
        "title": "15 Caixa de frutas - Kiwi  - Bruno3",
        "description": "lorem ipsum",
        "amount": 21000,
        "customer_id": 1
    },
    "payment_settings": [
        {
            "max_installments": 12,
            "discount_percentage": 0,
            "billing_date": "2024-10-29",
            "payment_type_id": 1
        },
        {
            "max_installments": 5,
            "discount_percentage": 0,
            "billing_date": "2024-10-29",
            "payment_type_id": 2
        },
        {
            "max_installments": 5,
            "discount_percentage": 0,
            "billing_date": "2024-10-29",
            "payment_type_id": 3
        }
    ]
}'

Respostas

🟢200Success
application/json
Body

Exemplo
{
    "success": true,
    "message": "Operação realizada com sucesso.",
    "data": {
        "type": "one_time",
        "frequency": null,
        "title": "200 sacos de cimento CP3",
        "description": "lorem ipsum",
        "amount": 6500,
        "customer_id": 1,
        "updated_at": "2024-09-13T18:44:57.000000Z",
        "created_at": "2024-09-13T18:44:57.000000Z",
        "id": 4
    }
}
Modificado em 2024-10-04 21:00:07
Página anterior
Listar minhas cobranças
Próxima página
Atualizar dados da empresa
Built with