API explorer

Theme switcher

Session Status

Body Parameters

billinkUsernamestring Required

The billinkUsername is the username linked to the Billink account for the session.

billinkIDstring Required

The billinkID is the unique identifier for the Billink account linked to the session.

sessionIDstring Required

Session ID returned by Create Session. Provide at least one identifier: sessionID, billinkInvoiceNumber, invoiceNumber or customInvoiceID.

billinkInvoiceNumberstring

Billink invoice number linked to the session (the "invoice" field from Create Session).

invoiceNumberstring

Your webshop order number (transaction.orderNumber from Create Session).

customInvoiceIDstring

Your own invoice ID (transaction.customInvoiceID from Create Session).

Response

200
Object

Response Attributes

statusstring

The status parameter indicates the current status of the session. One of: order_created (payment completed), session_active, session_expired, cancelled (only when the cancel state is enabled for your account).

200
Object

Response Attributes

statusstring

The status parameter indicates the current status of the session. One of: order_created (payment completed), session_active, session_expired, cancelled (only when the cancel state is enabled for your account).

200
Object

Response Attributes

statusstring

The status parameter indicates the current status of the session. One of: order_created (payment completed), session_active, session_expired, cancelled (only when the cancel state is enabled for your account).

200
Object

Response Attributes

statusstring

The status parameter indicates the current status of the session. One of: order_created (payment completed), session_active, session_expired, cancelled (only when the cancel state is enabled for your account).

400
Object

Response Attributes

statusstring
messagestring
403
Object

Response Attributes

statusstring
messagestring
404
Object

Client not found, or no session matches the identifiers.

Response Attributes

statusstring
messagestring
500
Object

Response Attributes

statusstring
messagestring
Was this section helpful?

POST

/

Select
1

Response

Was this section helpful?