Create Checkout Session

Creates a session and generates a hosted checkout payment link.

This endpoint expects an object.

amountdoubleRequired

The transaction amount.

currencystringRequired

The currency code (e.g., ‘NGN’).

integrationTypeenumRequired

Type of integration.

Allowed values:

merchantReferencestringOptional

Optional merchant-provided reference for the transaction.

redirectUrlstringOptional

Optional URL to redirect after payment.

brandstringOptional

Unique key for transacting entity.

payerTokenstringOptional

PayOS issued token identifier.

payerDetailsobjectOptional

Payer details, required for direct integration.

paymentMethodslist of objectsOptional

List of available payment methods.

Session created successfully with payment link.

sessionIdstringOptional

Unique identifier for the session.

paymentLinkstringOptional

URL for the hosted checkout payment.

1	curl -X POST https://api.payos.money/v1/checkout/session \
2	-H "Content-Type: application/json" \
3	-d '{
4	"amount": 15000,
5	"currency": "NGN",
6	"integrationType": "hosted",
7	"merchantReference": "ORDER12345",
8	"redirectUrl": "https://merchant.com/redirect",
9	"brand": "merchant-brand-key",
10	"payerToken": "TOKEN_abcdef123456",
11	"payerDetails": {
12	"payerName": "Chinwe Okafor",
13	"payerEmailAddress": "chinwe.okafor@example.com",
14	"payerMobileNumber": "08012345678",
15	"payerLocation": "NG"
16	},
17	"paymentMethods": [
18	{
19	"type": "fawry-pay",
20	"restrict": true
21	}
22	]
23	}'

1	{
2	"sessionId": "SESSION_abcdef123456",
3	"paymentLink": "https://payos.money/checkout/SESSION_abcdef123456"
4	}