For AI agents: visit https://developerhub.ppro.com/global-api/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI. Append .md to any documentation page URL to get its markdown version.

Jump to Content

Documentation API Reference Changelog PPRO Dashboard

v1.0

API Reference

v1.0Documentation API Reference Changelog PPRO Dashboard

Fundamentals

API authentication
Data standards
API rate limiting
Idempotency
Errors representation
- PPRO failure codes

Payment Charges

Charge Endpoints
Authorization Endpoints
Capture Endpoints
Refund Endpoints
Void Endpoints

Payment Instruments

Instrument Endpoints

Payment Agreements

Authorization Endpoints
- Update authorizationpost
Agreement Endpoints
Charges Endpoints
- Create a Payment Chargepost

Payment Sessions

Payment Sessions

Fund Statuses

Fund Endpoints
- Fetch latest available funds statuses for payment charge captures and refundsget

Risk Management

Disputes
Dispute Reports
- Create a dispute reportpost
- Get a dispute report by IDget
Chargebacks

Webhooks

Payment Agreements
Chargebacks
- Chargeback Succeededwebhook
Payment Charges
Fund Statuses
- Funds State Changedwebhook
Payment Instruments
Payment Reports

Agreement Updated

webhook

Agreement Updated

Sent when the Payment Agreement is updated

Payload

The root payload envelope sent by the webhook.

specversion

string

The CloudEvents specification version

source

string

The event source

datacontenttype

string

The event content type

id

string

The event ID

type

string

The event type

subject

string

The event subject

time

string

The event timestamp

data

object

The event business payload

Updated 2 months ago

Agreement Active

Agreement Failed

Did this page help you?

Loading…

Updated 2 months ago

Agreement Active

Agreement Failed

Did this page help you?