Create a Payment Session

This endpoint aims at providing a payment session for a PSU to initiate a payment.

The same endpoint can be used to generate an Immediate Transfer, a Smart Transfer or a Buy Now Pay Later payment. To mix Immediate Transfer, Smart Transfer and Buy Now Pay Later in the same payment session, see the Fintecture Payment Hub guide

🚧 Important

Signature, digest, date and x-request-id headers are mandatory when calling the PRODUCTION environment

💡 Note

Request payloads examples for Immediate Transfer, Smart Transfer and Buy Now Pay Later can be found under the "Example" dropdown.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
required
length ≤ 512

a state parameter which will be provided back on redirection

string

must correspond to one of the URLs provided when creating an application on the console. Required in Redirect mode.

string

The URL to which he will be returned if he cancels the payment from the Connect webview. By default the user is returned to the previous screen (i.e. your checkout page)

boolean

Returns the beneficiary in the response

boolean

Returns the virtual beneficiary in the response. Requires an internal payment account to be enabled.
⚠️ This query param should only be added for Smart Transfer payments as the virtual beneficiary is only available for those payments.

Body Params
meta
object

Description of a Payer

data
object
Headers
string
required

Sha-256 base64 encoded digest.
Related documentation can be found by clicking here

string

uuid v4. Required in Redirect mode.

string
enum

Type of PSU

Allowed:
string
length between 2 and 2

2 letter country code

string
length between 2 and 2

A 2 letter language code to set the preferred language for PSU notifications.
Default value: en

string

provider_id

string
required

Signature is used to enforce security by signing request.
Related documentation can be found by clicking here

string
required

RFC2822 formatted date.

Responses

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Choose an example:
application/json