Create New Invoice

post

https://api.stg.bavabank.com/checkout/v1/vendors/{vendor_id}/invoices

Creates an invoice to charge a customer. Can send the payment link through E-mail and WhatsApp.

Path Params

vendor_id

uuid

required

Id of an existing vendor.

Body Params

invoice_id

uuid

Invoice Identifier

merchant_id

uuid

required

Merchant identifier

expires_in

number

required

Total time to expire invoice in minutes

order_number

string

client order number identifier

payment_link

boolean

Defaults to true

Indicate if It will be accesible on web

guarantee

object

Guarantee data about creation. It always be guaranteed the total amount of the invoice.

amount

integer

required

Amount to be charged in cents

payment_methods

object

required

multiple_payments

object

customer

object

required

Customer data

notification

array of objects

notification

metadata

object

Key, Value properties. You can choose which data you want to store

items

array of objects

Items of Invoice

items

Responses

403

Necessary permission scope.

404

Resource not found.

409

Already exists an resource with same Id.

500

Internal Server Error

Language

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Invoice Created

400For invalid param, json field or required field.

401Missing or invalid token.