Payment Management Biz API
home
Brief Description
The specification of the REST API for Payments. It includes the model definition as well as all available operations for payments and refunds.
This API allows the following operations
- Notify of a performed payment
- Retrieve a list of payments filtered by a given criteria
- Retrieve a single performed payment
- Notify of a performed refund
- Retrieve a list of refunds filtered by a given criteria
- Retrieve a single performed refund
Use Case
set of main use cases that can be performed with this API. Additional use cases can be generated using the operations and resources defined in this specification.
- Request a list of performed payments stored on a server filtered by different criteria
- Request a specific payment stored on a server
- Notify of a new performed payment
- Request a list of performed refunds stored on a server filtered by different criteria
- Request a specific refund stored on a server
- Notify of a new performed refund
Note that typically refunds that undo a payment will be applied to the same payment method that was used to perform it.
Criticality
Medium
Layer/Category
Process
API Current State
Design Phase
Usage
TBD
Base URI Summary of Methods
- Development:
- TEST:
- PREPROD:
- PROD:
Transport Protocol(s)
HTTP
HTTPS
3 Layer architecture flow diagram
Sequence Diagram
TBD
Quality of Service (QoS)
TBD
Avg. Response Time (Secs)
TBD
Avg. Payload Size (KB/MB)
TBD
Max Payload Size (KB/MB)
TBD
Avg. Volumes (per day)
TBD
Peak Volumes
TBD
Peak Volumes Timespan
TBD
Availability
High Availability
Service Level Agreement
N/A
Policies
N/A
GDPR
TBD
Constraints
There are no constraints applicable to this API.
Assumptions
Average/Peak Response time depends on the size of payload and speed and other network and processing factors.
Reference documents