Sign in

v1

latestOpenAPI 3.0.12026-07-245303882.5 MB
Charge

Emitir Boleto

post/charge

Request body

externalIdstring required

Identificador do cliente.

merchantCatagoryCodestring nullable

Categoria do estabelecimento.

expirationAfterPaymentinteger required

Dias após o vencimento que a cobraça pode ser paga. Valores aceitos de 0 a 59.

duedatestring date-time required

Data de vencimento da cobrança.

amountnumber double required

Valor da cobrança.

keystring nullable

Chave pix da conta BaaS para recebimento.

invoiceNumberstring nullable

Número de nota fiscal.

bankEmissorinteger nullable

Código do banco emissor.

informationsstring[] nullable

Informações Personalizadas do Boleto Array de String com 3 itens no máximo Cada item com no máximo 70 caracteres

chargeType'BOLETO' | 'BOLEPIX'

Example request

{
  "externalId": "externalId1",
  "merchantCatagoryCode": "0000",
  "expirationAfterPayment": 1,
  "duedate": "2023-12-30",
  "amount": 12.5,
  "key": "teste@chavepix.com.br",
  "invoiceNumber": "61523",
  "debtor": {
    "name": "Marcos Samuel Duarte",
    "document": "49188474801",
    "postalCode": "06463035",
    "publicArea": "Rua Mãe D'Água",
    "number": "1004",
    "complement": "Apto 123",
    "neighborhood": "Jardim Mutinga",
    "city": "Barueri",
    "state": "SP"
  },
  "receiver": {
    "document": "40655847871",
    "account": "30023646056263"
  },
  "instructions": {
    "fine": 10,
    "interest": 5,
    "discount": {
      "discountType": "DATA_FIXA",
      "discountOne": {
        "value": 100,
        "limitDate": "2023-05-12"
      },
      "discountTwo": {
        "value": 100,
        "limitDate": "2023-05-12"
      },
      "discountThree": {
        "value": 100,
        "limitDate": "2023-05-12"
      }
    },
    "discountTwo": {
      "discountType": "DATA_FIXA",
      "discountOne": {
        "value": 100,
        "limitDate": "2023-05-12"
      },
      "discountTwo": {
        "value": 100,
        "limitDate": "2023-05-12"
      },
      "discountThree": {
        "value": 100,
        "limitDate": "2023-05-12"
      }
    },
    "discountThree": {
      "discountType": "DATA_FIXA",
      "discountOne": {
        "value": 100,
        "limitDate": "2023-05-12"
      },
      "discountTwo": {
        "value": 100,
        "limitDate": "2023-05-12"
      },
      "discountThree": {
        "value": 100,
        "limitDate": "2023-05-12"
      }
    }
  },
  "split": [
    {
      "account": "40655847871",
      "document": "40655847871",
      "percent": 5,
      "amount": 1,
      "aggregatePayment": true
    }
  ],
  "bankEmissor": 1
}

Response

Created

versionstring nullable

Versão da api.

statusstring nullable

Status.

Example response

{
  "version": "1.0.0",
  "status": "SUCCESS",
  "body": {
    "transactionId": "ce9b8d9b-0617-42e1-b500-80bf9d8154cf"
  }
}