API Reference

Authorize payment charge or agreement

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

Authorize underlying payment charge or agreement of the given payment session.

Path Params
string
required
Body Params
string
required
length ≥ 1

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

consumer
object
amount
object

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:
initialPaymentCharge
object

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

instrument

The payment instrument. This field is required for a subset of PPRO's supported payment methods.

authenticationSettings
array

Authorization-time authentication settings overrides.

authenticationSettings
date-time

The start date of the agreement

date-time

The end date of the agreement

frequency
object

The frequency of the agreement

labels
object

Custom labels associated with the payment charge or agreement.

Headers
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