Create Checkout Link

post https://api-pay-sandbox.venly.io/checkout/sessions

Initiate the checkout process for a single payment by calling this endpoint. Save the id and url from response body. The id parameter is the sessionId (Used when checking status of this checkout), and the url parameter is the checkout URL (You pass this to your end-user).

Body Params

line_items

array of objects

line_items

success_url

string

The URL where your user will be directed in case of successful checkout. (URLs must begin with http or https)

cancel_url

string

The URL where your user will be directed in case they decide to cancel the payment. (URLs must begin with http or https)

mode

string

Defaults to payment

Only payment mode is allowed.

expires_at

date-time

The date-time at which the Checkout Session will expire. It can be set to expire anytime between 30 minutes to 24 hours after it's created. By default, it expires 24 hours after creation. This field accepts a date-time in ISO-8601 format.

client_reference_id

string

A distinctive identifier for the Checkout Session. This might be a customer ID, cart ID, or something similar, and can be utilized to match the session with your internal systems.

customer

object

Responses

Language

Credentials

OAuth2

URL


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api-pay-sandbox.venly.io/checkout/sessions \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '{"mode":"payment"}'

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

application/json

200OK

400Bad Request

401When the user is not authorized to access the resource

403When a user doesn't have proper security authority

404Not Found

405When the HttpMethod is not supported

415Usually when the input is not a valid json

500Internal Server Error