How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

PPRO Payment Agreements API

The Payment Agreements API from PPRO — 2 operation(s) for payment agreements.

PPRO Payment Agreements API is one of 18 APIs that PPRO publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Payment Agreements. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.

This API exposes 2 operations across 2 paths, and defines 65 schemas. It is described by OpenAPI 3.2.0, at version v1.

Requests are made against 2 base URLs: https://api.sandbox.eu.ppro.com, https://api.qa.eu.ppro.com/v1/payment-agreements.

2 operations 2 paths 65 schemas 1 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v1
Base URL
https://api.eu.ppro.com
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

PPRO Payment Agreements API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearer_token). By default, every request must be authenticated.

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 1 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Payment Agreements 2
POST
/v1/payment-agreements
Create a Payment Agreement
createAgreement 1 param body → 200504
GET
/v1/payment-agreements/{agreement-id}
Retrieve a Payment Agreement
fetchPaymentAgreement 2 params → 200504

Schemas 65

The contract defines 65 schemas that model the data the API accepts and returns. The most detailed are AgreementResponse (23 properties), AgreementRequest (19 properties), TravelDetails (18 properties), ExternalThreeDs (12 properties). Each schema is shown below with its type and property counts.

AdditionalData
object
2 properties
RedirectAuthenticationSettingsDetails
object
1 property
AuthenticationMethod
object
2 properties
RawCardInstrument
1 required
HistoryEntryResponse
object
4 properties
ExternalThreeDs
object
12 properties
RedirectAuthenticationDetails
object
2 properties
MultiFactorAuthenticationSettingsDetails
object
1 property
AirlineIndustryData
1 required
RevocationResponse
object
4 properties
Challenge
object
4 properties
ProcessingFailure
object
6 properties
TravelDetails
object
18 properties
BancontactAccountDetails
object
5 properties 5 required
AirlineDetails
object
8 properties 1 required
ScanCodeAuthenticationSettings
AppIntentAuthenticationMethod
RedirectAuthenticationSettings
AuthenticationSettings
object
1 property 1 required
AppNotificationAuthenticationSettings
ScanCodeAuthenticationDetails
object
6 properties
RedirectAuthenticationMethod
AppNotificationAuthenticationDetails
ExternalThreeDsAuthenticationSettings
Client
object
2 properties
MultiFactorAuthenticationSettings
Frequency
object
2 properties 1 required
Consumer
object
11 properties 1 required
UpiAutopayInstrument
AgreementResponse
object
23 properties
AirlineTripSegment
object
7 properties
ConsumerUpdate
object
2 properties
ScanCodeAuthenticationMethod
MultiFactorAuthenticationDetails
PaymentCharge
object
11 properties 1 required
ThreeDsAuthenticationMethod
ExceptionResponseBody
object
4 properties
ThreeDsAuthenticationSettingsDetails
object
2 properties
ThreeDsAuthenticationSettings
Profile
object
6 properties
ScanCodeAuthenticationSettingsDetails
object
1 property
Address
object
8 properties
PassthroughWalletDetails
object
1 property
CardNetworkTokenDetails
object
7 properties 5 required
ThreeDsAuthenticationDetails
object
2 properties
AgreementRequest
object
19 properties 2 required
AppNotificationAuthenticationSettingsDetails
object
1 property
MultiFactorAuthenticationMethod
MockInstrument
IndustryData
object
1 property 1 required
OutOfScope
object
1 property
AppNotificationAuthenticationMethod
PaymentInstrument
object
1 property 1 required
OrderItem
object
6 properties 3 required
BancontactAccountInstrument
TravelIndustryData
1 required
CardNetworkTokenInstrument
AppIntentAuthenticationDetails
object
1 property
Order
object
7 properties
BankAccountDetails
object
8 properties
InstallmentPlan
object
2 properties 1 required
Money
object
2 properties 2 required
EducationIndustryData
BankAccountInstrument
1 required
PassthroughWalletInstrument

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ppro-payment-agreements-api-openapi.yml Raw ↑

Other APIs PPRO publishes across the network.

PPRO Authorization Endpoints API
PPRO Capture Endpoints API
PPRO Dispute Reports API
PPRO Disputes API
PPRO Enrollment Endpoints API
PPRO Internal API
PPRO Merchants API
PPRO Payment Agreement Revocations API
PPRO Payment Charge Controller API
PPRO Payment Charges API
PPRO Payment Instruments API
PPRO Payment Sessions API
Where this information came from

This is an independent, third-party profile of PPRO Payment Agreements API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.