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
^[A-Z0-9_]+$

The payment method the consumer uses to pay. The value must be provided in uppercase.

string
enum
Defaults to ECOMMERCE

The channel medium through which the payment was initiated.

Allowed:
string

A short descriptor for the payment that may appear on the consumer's statement. It helps the consumer identify the purpose of the payment.

string

The initial scheme authorization reference of the original authorization. It links this payment back to the original agreement and authorization for recurring payments.

string

The Transaction Link Reference or ID (for example, a Mastercard TLID) that links a transaction in a card network's transaction chain. Provide the initial TLID when creating subsequent merchant-initiated transactions.

string
enum

The party that initiated the payment charge.

Allowed:
string
enum
Defaults to UNSCHEDULED

The type of payment charge being processed. Use UNSCHEDULED for a one-off charge not tied to a schedule. Use SCHEDULED for a charge that is part of a recurring schedule. Use SCHEDULED_RETRY for a retry of a previously failed scheduled payment. The RECURRING value 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 authorize.

consumer
object
required

The consumer's details.

order
object

The order information, including the purchased items and the associated shipping details.

string

A merchant-defined identifier that represents a single payment charge.

authenticationSettings
array

The settings for the consumer payment authentication.

authenticationSettings
boolean

Set to true to capture the payment charge automatically after a successful authorization.

string
^(https)://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]

The HTTPS URL to which payment charge state changes are sent.

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 5 months ago

Did this page help you?
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 5 months ago

Did this page help you?