API Reference

Create a Payment Agreement

post
https://api.sandbox.eu.ppro.com/v1/payment-agreements
Body Params
string
required
length ≥ 1
Defaults to ##default

The payment method which should be used to process the payment charge.

string
enum
Defaults to ECOMMERCE

The payment medium.

Allowed:
string
length between 0 and 100
Defaults to ##default

The description of the agreement

string
Defaults to ##default

The merchant payment agreement reference.

frequency
object
Defaults to ##default

The frequency of payment charges

date-time
Defaults to ##default

The start date of the agreement

date-time
Defaults to ##default

The end date of the agreement

amount
object
Defaults to ##default

Defines the amount of each subsequent payment charge. Defined in conjunction with 'amountType'.

string
enum
Defaults to ##default

Defines if the provided 'amount' is a maximum value or an exact value.

Allowed:
string
Defaults to ##default

The identifier of an existing payment instrument. Instruments are used for account on file payments.

instrument

The payment instrument

string
Defaults to ##default

The identifier of the associated payment-session. Payment-sessions are created by the drop-in UI.

consumer
object
required
Defaults to ##default

The consumer details.

string
Defaults to ##default

The URL to which the agreement state changes will be notified

initialPaymentCharge
object
Defaults to ##default

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

authenticationSettings
array
Defaults to ##default

The authorization authentication settings.

authenticationSettings
string
Defaults to ##default

The initial scheme authorization reference, eg. for cards network transaction identifier (NTI)

labels
object

Custom labels associated with the payment agreement.

Headers
string
required
Defaults to ##default

The merchant identifier.

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