API Reference
Start typing to search…

Create a Payment Agreement

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

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

The description of the agreement

string

The merchant payment agreement reference.

frequency
object

The frequency of payment charges

date-time

The start date of the agreement

date-time

The end date of the agreement

amount
object

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

string
enum

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

Allowed:
string

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

instrument

The payment instrument

string

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

consumer
object
required

The consumer details.

string

The URL to which the agreement state changes will be notified

initialPaymentCharge
object

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

authenticationSettings
array

The authorization authentication settings.

authenticationSettings
string

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

labels
object

Custom labels associated with the payment agreement.

Headers
string
required

The merchant identifier.

Responses

Updated 6 months ago

Language
Credentials
Bearer
URL
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 6 months ago