API Reference

Create a payment charge

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

Creates a payment charge.

Body Params
string
required
length ≥ 1

The payment method to be used for processing the payment charge.
The value must be provided in uppercase.

string
enum
Defaults to ECOMMERCE

The medium through which the payment was initiated.

Allowed:
string

A short descriptor for the payment that may appear on consumer statements.
This helps identify the transaction source or purpose.

string

The initial scheme authorization reference. It establishes the link back to the original agreement and authorization for recurring payments.

string
enum

The initiator of the payment charge.

Allowed:
string
enum
Defaults to UNSCHEDULED

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 identifier of an existing payment instrument.
Instruments are used for recurring payments.

instrument

Provides additional details required by certain payment methods to process the payment successfully.

instrumentUpdateDetails

Additional details to update an existing instrument. Must be used together with instrumentId.

amount
object
required

The amount to be authorized.

consumer
object
required

Defines the details of the consumer.

order
object

Defines order information, including purchased items and associated shipping details.

string

A merchant-defined identifier that uniquely represents a single payment attempt.

authenticationSettings
array

The authorization authentication settings.

authenticationSettings
boolean

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

string

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

labels
object

Custom labels associated with the payment charge.

Headers
string
required

The merchant identifier.

string

Unique request reference to facilitate debugging.

string

Optional Idempotency Key for the request. Sending duplicate requests will result in 409 HTTP status code.

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