post https://infrapay.stg.libercapital.com.br/api/payment/bill
Create bill
Role-based access control
Required role customerBillCreateWrite
REQUEST BODY OBJECT HAS THE FOLLOWING PROPERTIES:
| Attribute | Type | Description | Required |
|---|---|---|---|
billed | boolean | Billed condition | No |
externalId | string | Your id reference | Yes |
dueDate | date | Due Date, ISO String format YYYY-MM-DDTHH:mm:ss.sssZ | Yes |
value | number | Value of bill | Yes |
customer.phone | string | Customer phone | Yes |
customer.email | string | Customer email | Yes |
customer.type | string | customer type enum[juridica,fisica] | Yes |
customer.document | string | Customer document(cpf/cnpj) | Yes |
customer.name | string | Customer name | Yes |
customer.address.address | string | Customer address street | Yes |
customer.address.number | string | Customer address number | Yes |
customer.address.complement | string | Customer address complement | No |
customer.address.postalCode | string | Customer address postal code | Yes |
customer.address.neighborhood | string | Customer address neighborhood | Yes |
customer.address.city | string | Customer address city | Yes |
customer.address.state | string | Customer address state | Yes |
callbackUrl | string | Callback Url | No |
ourNumber | string | Nosso Número | No |
Response object has the following properties:
| Attribute | Type | Description |
|---|---|---|
_id | string | Id of bill |
valuePaid | number | Paid value of bill |
barCode | string | Bar code |
digitableLine | string | Digitable line |
externalId | string | Your id reference |
value | number | Value of bill |
dueDate | date | Due Date, ISO String format YYYY-MM-DDTHH:mm:ss.sssZ |
status.id | number | Id of status, Pending = 1, Expired = 2, Canceled = 3, Paid = 4, WaitingToCancel = 5, WaitingNewDueDate = 6 |
status.statusText | string | Text of status |
customer.name | string | Customer name |
customer.document | string | Customer document(cpf/cnpj) |
createDate | date | Create date, ISO String format YYYY-MM-DDTHH:mm:ss.sssZ |
callbackUrl | string | Callback Url |
ourNumber | string | Nosso Número |
ourNumberDigit | string | Dígito verificador do Nosso Número |
Response status code
| status | Description |
|---|---|
| 201 | CREATED |
| 400 | BAD_REQUEST |
| 500 | INTERNAL_SERVER_ERROR |
| 403 | FORBIDDEN |