API Reference

Create a Payment Charge

post
https://api.sandbox.eu.ppro.com/v1/payment-agreements//payment-charges
Path Params
string
required
Body Params
string
enum

The charge initiator

Allowed:
string
enum

Indicates the type of payment charge being processed. Use UNSCHEDULED for a one-off charge not tied to a schedule. Use SCHEDULED for charge that is part of a recurring schedule. Use SCHEDULED_RETRY for a retry attempt of a previously failed scheduled payment. The RECURRING enum is planned for deprecation and should not be used in new implementations.

Allowed:
string

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

amount
object
required

The amount to be authorized.

boolean

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

order
object

The order details.

string

The merchant payment charge reference. Aka, Transaction Reference.

string

The URL to which the payment charge state changes will be notified

authenticationSettings
array

The authorization authentication settings.

authenticationSettings
consumer
object

The consumer details to override the agreement consumer.

string

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

labels
object

Custom labels associated with the payment agreement charge.

Headers
string
required

The merchant identifier.

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated about 1 month 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 about 1 month ago