2.2 Use Cases
For more (technical) information about the payments API, please visit Common API GitHub.
Diagram
Use Case Category - Payment Submission
Customer Core Use Cases
Submit payments
Show submitted payments incl. status
Delete submitted payments (before execution)
Show all initated payments
TPP Functionality
Submit ISO20022 XML payment instruction (PAIN.001)
Retrieve a specific submitted PAIN.001 message
Get status report (PAIN.002) for a specific payment instruction
Delete a submitted ISO20022 XML PAIN.001 message before execution
Initiate new payments submission
Retrieve a specific payment submission
Retrieve a specific payment submission’s status
Delete a submitted payment message before execution
Return the list of all initated payments of all types
FI API Paths
/iso20022/v[x]/payments
/payments/v[x]
/single-payments/v[x]
(e.g. /iso20022/v1/payments where v1 is the major version 1 of the API)
Use Case Category - Statements
Customer Core Use Cases
Show all entries booked to the account (e.g. balance information)
TPP Functionality
Get list of resource links to account statements (CAMT.053)
Retrieve a specific CAMT.053 document
FI API Paths
/iso20022/v[x]/statements
(e.g. /iso20022/v1/statements where v1 is the major version 1 of the API)
Use Case Category - Standing Orders
Customer Core Use Cases
Submit and manage standing orders
TPP Functionality
Create a new Standing Order
Delete a specific standing order submission
Retrieve a specific standing order submittsion
Retrieve a specific standing order submission’s status
FI API Paths
/standing-orders/v[x]
(e.g. /standing-orders/v1 where v1 is the major version 1 of the API)