Create Bill Payment


What it does:

Creates a new bank slip, registers the bank slip in the banking gateway

To create an bank slip need some infos.

KeyFieldTypeRequired
AmountStringTrue
TypeStringTrue
DueDateStringTrue
PayerObjectTrue
InterestObjectFalse
FineObjectFalse
DiscountsObjectFalse

Payload Request Example:

{
   "amount":{
      "value":10000,
      "currency":"BRL"
   },
   "type":"DM",
   "dueDate":"2025-08-29",
   "payer":{
      "name":"John Doe",
      "taxId":"12345678901",
      "address":{
         "street":"Av. Paulista",
         "number":"1000",
         "district":"Bela Vista",
         "city":"São Paulo",
         "state":"SP",
         "zipCode":"01310000"
      }
   },
   "interest":{
      "percentage":2.5,
      "daysAfterDueDate":1
   },
   "fine":{
      "percentage":2.0,
      "daysAfterDueDate":1
   },
   "discounts":[
      {
         "deadlineDate":"2025-08-20",
         "percentage":1.5
      }
   ]
}

Payload Response Example:

{
   "data":{
      "bankAccountId":"019540f6-a870-7927-b97b-cdbbeb13f390",
      "id":"123e4567-e89b-12d3-a456-426614174000",
      "companyId":"company_789",
      "amount":{
         "value":10000,
         "currency":"BRL"
      },
      "type":"DM",
      "barCode":"34191090010000000001234567890123456789",
      "line":"34191.09001 00000.000012 34567.890123 4 09001000000000",
      "ourNumber":"00001649435",
      "referenceNumber":"REF-123456",
      "payer":{
         "name":"John Doe",
         "taxId":"12345678901",
         "address":{
            "street":"Av. Paulista",
            "number":"1000",
            "district":"Bela Vista",
            "city":"São Paulo",
            "state":"SP",
            "zipCode":"01310000"
         }
      },
      "dueDate":"2025-08-29",
      "states":[
         {
            "status":"CREATED",
            "reason":null,
            "atTime":"2025-08-01T10:00:00Z"
         }
      ],
      "currentState":{
         "status":"CREATED",
         "reason":null,
         "atTime":"2025-08-01T10:00:00Z"
      },
      "amountPaid":null,
      "paidAt":null,
      "createdAt":"2025-08-01T10:00:00Z",
      "updatedAt":"2025-08-01T10:00:00Z"
   }
}