API explorer

Theme switcher

Create Session

Body Parameters

clientobject Required

The client information associated with the session.

Show child attributes

customerobject Required

Information about the customer involved in the transaction.

Show child attributes

billingAddressobject Required

Billing address of the customer.

Show child attributes

shippingAddressobject

The address to which the product will be shipped.

Show child attributes

submerchantobject

Note: This object is optional and only used for specific internal cases. It can be safely ignored by most integrations.

Show child attributes

transactionobject Required

The details of the transaction being processed.

Show child attributes

Response

200
Object

Response Attributes

statusstring

"success" when the session was created.

sessionIDstring

Unique ID of the created payment session. Use it to query Session Status.

sessionURLstring

URL to redirect the customer to for completing the payment. When seamless mode is enabled for your account, this holds the success URL instead.

invoicestring

Billink invoice number linked to this session.

expiresAtstring

Moment the session expires, format H:i:s d/m/Y.

customerIDstring

Only returned when client.customData contains CustomerID.

customInvoiceIDstring

Echo of transaction.customInvoiceID; only returned when client.customData contains CustomInvoiceID.

400
Object

Response Attributes

error_backendobject

Show child attributes

404
Object

Response Attributes

statusstring
messagestring
416
Object

Response Attributes

http_status_codenumber
http_bodystring
http_body_encodingstring
Was this section helpful?

POST

/

Select
1

Response

Was this section helpful?