POST - Create sale in Boleto

On this page:

POST Create sale in Boleto

https://api.premepay.com/v1/stores/:id/orders

Parameters List

Parameter	Type	Description	Required
`customerId`	integer	Customer ID	Yes
`fingerprint`	string	User session unique identifier	No
`includeFeeTransfer`	boolean	Indicates whether fees should be passed on to the consumer	No
`amount`	decimal	Total amount to be charged	Yes
`products`	array<object>	Products associated with payment	No
`productId`	integer	Product ID	Yes, if the products property is used
`quantity`	decimal	Quantity of the product associated with the payment	Yes, if the products property is used
`description`	string	Sale Description	Yes
`generateAllBoletos`	boolean	In the case of purchases in installments, this property defines whether all payment slips will be generated and sent to the Consumer at the time of purchase.	No, if the property is omitted or if the value is set to `false`, the installment/slip will be generated/sent to the Consumer automatically every due date
`voucher`	string	Discount coupon	No
`payment`	object	Payment information	Yes
`type`	string	Payment type (boleto)	Yes
`installments`	int	Number of installments. Available up to 12 installments.	Yes
`dueDate`	date	Due date	Yes
`lateFee`	object	Late fee charge	No
`amount`	decimal	Amount	When*`Mode`* is `Daily_Amount` or `Fixed`**
`percentage`	decimal	Percentage	When*`Mode`* is`Daily_Percentage`, `Monthly_Percentage` or`Percentage`**
`mode`	string	Billing type	No
	`daily_percentage`	Percentage per day
	`daily_amount`	Fixed amount per day
	`monthly_percentage`	Percentage per month
	`fixed`	Fixed value
	`percentage`	Percentage value
`interestOrFine`	object	Late interest charges	No
`discount`	object	Discount	No
`limitDate`	date	The deadline for granting the discount must be greater than or equal to the current date. Backdates on these properties return a 500 error.	Yes
`tax`	object	Additional fees	No
`splits`	array<object>	Splits	No
`splitRuleId`	integer	Identifier	Yes
`metadata`	dictionary<key, value>	Used to save miscellaneous information in dictionary format <key, value>	No
`warrantyDays`	integer	Service Warranty Time in Days	No
`whenShouldIssueNfe`	int	When to issue the NFe	Yes, if the `sendNfeToCustomer` property is used
	`0`	At the time of sale
	`1`	After warranty
	`2`	Do not issue
`sendNfeToCustomer`	boolean	Send invoice to consumer	Yes, if the when Should IssuaNce property is used

<aside> <img src="/icons/alert_red.svg" alt="/icons/alert_red.svg" width="40px" /> NFE properties are only available in case of integration with eNotas.

</aside>

Status related to Order

Status	Meaning
`New`	Temporary status, if this status persists, contact support
`Succeded`	Order created successfully
`Canceled`	Order canceled
`Failed`	Failed during order creation

Status related to Payment

Status	Meaning
`New`	Temporary status, if this status persists, contact support
`Pending`	Pending payment
`Succeded`	Payment made successfully
`Canceled`	Payment Canceled
`Dispute`	Payment in Dispute
`Failed`	Payment Failure
`ChargedBack`	Payment Failure
`DisputeSucceeded`	Dispute Overdue
`PartiallySucceded`	Payment partially made
`PartiallyCanceled`	Payment partially canceled

<aside> 💡 Important: the discount coupon changes the final value of the Payment Order.

</aside>

Request example

This is an example of how your request to create a new Payment Order with the payment method Boleto in installments, where the slips will be generated and sent to the consumer instantly, should look like. The generateAllBoletos property is used to generate all slips. Use this property with the value false so that the slips are generated automatically, only at each due date.

Body

Responses

200: OK

If your request has invalid creation parameters - for example, specifying an invalid field or value - you may receive an error response. Below is the complete list of possible error responses:

400: Bad Request
401: Unauthorized
403: Forbidden
500: Internal Server Error

</aside>