API Reference

Create payment session

post
https://api.sandbox.eu.ppro.com/v1/payment-sessions

Creates a new Payment Session.

Body Params
amount
object
required

The amount to be authorized.

string
enum

Defines if the provided 'amount' is a maximum value or an exact value. This field is relevant only for recurring payments.

Allowed:
consumer
object
required

The consumer details.

boolean
required

Indicates whether this is a recurring payment which needs the creation of a payment-agreement.

string

The URL to which the agreement state changes will be notified

authenticationSettings
array
authenticationSettings
string

The payment descriptor (arbitrary string). May be presented to the consumer.

string

The merchant payment charge reference.

string

The merchant payment agreement reference.

string

ID of an existing payment-agreement with the consumer

order
object

The order details.

initialPaymentCharge
object

An initial payment charge to be created when initializing the agreement in a "link and pay" journey

frequency
object
date-time

The start date of the agreement

date-time

The end date of the agreement

boolean

Indicates whether the payment charge should be automatically captured after a successful authorization.

labels
object

Custom labels associated with the payment charge or agreement.

Headers
string
required
length ≥ 1
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 7 months ago

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
*/*
application/json

Updated 7 months ago