Introduction

⚠️

Important Note

We recommend that new customers integrating with the PPRO API first consult their Account Manager before proceeding with the Technical Specifications referenced here, as this API is planned for deprecation. Instead, we recommend using the latest PPRO API, which provides more efficient management of disputes, chargebacks & fraud alerting (reference).

PPRO provides a set of intuitive, powerful, and flexible APIs. All endpoints accept and return JSON payloads and are designed around standard HTTP methods (GET, POST, etc..) for customer interactions. This section covers a few basic concepts on how to use our APIs.

Common API functionality

User Agent Header: With improved security, all API requests should now have the User-Agent header. This value should be the application / client making the call.

API Authentication: All APIs expect a Bearer Token for authentication. The access_token is obtained through the Authentication API.

HTTP Verbs: The APIs are designed to get as close as possible to standard HTTP and REST conventions with the use of HTTP verbs.

VerbUsage
GETUsed to retrieve resources.
POSTUsed to add a child resource under resources collection, it is a non-idempotent operation also commonly used to retrieve tokens.
PATCHUsed to partially update an existing resource, it is a non-idempotent operation.