Tableau de bordAPI ReferenceObtenir une clé API
API Reference

Create a BNPL

post
https://api.test.bictorys.com/billing/v1/bnpl

This endpoint allows the creation of a Buy Now, Pay Later (BNPL) plan for facility payments. Customers can make an optional initial payment, with the remaining amount distributed across recurring payment periods.

Body Params
string

Optional. BNPL reference.

double

total order amount

string
required

currency associated to the amount.

orderDetails
array of objects

Optional. List of purchased items

orderDetails
double
Defaults to 0

Optional. if a partial payment is required at the time of purchase. If deposit is required, startDate must be in the futur.

integer
required

Required. number of installments excluded deposit.

integer
Defaults to 30

Number of days between two installments. Defaults to 30 if not specified.

date
required

start date of the first installment. The startDate must be today date or in the futur.

uuid
required

Required. Unique Id of the customer.

string

Message intended to customer for installment payment. The message is sent to the customer with the payment link at every occurence. Do no add customer name or grettings in the message.

string
enum
Defaults to email

By which means the payment link will be send to the customer

Allowed:
Headers
string

HTTP request identifier allow to trace individual request sent from client to service.

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

401

The caller is not authenticated

403

Access rights not sufficient

Updated 11 months ago

Language
Credentials
Header
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json
Updated 11 months ago