# PISP Resources and Data Models - v4.0
Resources accessed using the pisp PSD2 role are detailed here:
- Domestic Payment Consents
- Domestic Payments
- Domestic Scheduled Payment Consents
- Domestic Scheduled Payments
- Domestic Standing Order Consents
- Domestic Standing Orders
- International Payment Consents
- International Payments
- International Scheduled Payment Consents
- International Scheduled Payments
- International Standing Order Consents
- International Standing Orders
- File Payment Consents
- File Payments
# Endpoints
The API endpoints for these resources, and their mandatory/conditional/optional status are given below.
Resource | Endpoints | Mandatory? |
---|---|---|
domestic-payment-consents | POST /domestic-payment-consents | Mandatory |
domestic-payment-consents | GET /domestic-payment-consents/{ConsentId} | Mandatory |
domestic-payment-consents | GET /domestic-payment-consents/{ConsentId}/funds-confirmation | Mandatory |
domestic-payments | POST /domestic-payments | Mandatory |
domestic-payments | GET /domestic-payments/{DomesticPaymentId} | Mandatory |
payment-details | GET /domestic-payments/{DomesticPaymentId}/payment-details | Optional |
domestic-scheduled-payment-consents | POST /domestic-scheduled-payment-consents | Conditional |
domestic-scheduled-payment-consents | GET /domestic-scheduled-payment-consents/{ConsentId} | Mandatory (if resource POST implemented) |
domestic-scheduled-payments | POST /domestic-scheduled-payments | Conditional |
domestic-scheduled-payments | GET /domestic-scheduled-payments/{DomesticScheduledPaymentId} | Mandatory (if resource POST implemented) |
payment-details | GET /domestic-scheduled-payments/{DomesticScheduledPaymentId}/payment-details | Optional |
domestic-standing-order-consents | POST /domestic-standing-order-consents | Conditional |
domestic-standing-order-consents | GET /domestic-standing-order-consents/{ConsentId} | Mandatory (if resource POST implemented) |
domestic-standing-orders | POST /domestic-standing-orders | Conditional |
domestic-standing-orders | GET /domestic-standing-orders/{DomesticStandingOrderId} | Mandatory (if resource POST implemented) |
payment-details | GET /domestic-standing-orders/{DomesticStandingOrderId}/payment-details | Optional |
international-payment-consents | POST /international-payment-consents | Conditional |
international-payment-consents | GET /international-payment-consents/{ConsentId} | Mandatory (if resource POST implemented) |
international-payment-consents | GET /international-payment-consents/{ConsentId}/funds-confirmation | Mandatory (if resource POST implemented) |
international-payments | POST /international-payments | Conditional |
international-payments | GET /international-payments/{InternationalPaymentId} | Mandatory (if resource POST implemented) |
payment-details | GET /international-payments/{InternationalPaymentId}/payment-details | Optional |
international-scheduled-payment-consents | POST /international-scheduled-payment-consents | Conditional |
international-scheduled-payment-consents | GET /international-scheduled-payment-consents/{ConsentId} | Mandatory (if resource POST implemented) |
international-scheduled-payment-consents | GET /international-scheduled-payment-consents/{ConsentId}/funds-confirmation | Mandatory (if resource POST implemented) |
international-scheduled-payments | POST /international-scheduled-payments | Conditional |
international-scheduled-payments | GET /international-scheduled-payments/{InternationalScheduledPaymentId} | Mandatory (if resource POST implemented) |
payment-details | GET /international-scheduled-payments/{InternationalScheduledPaymentId}/payment-details | Optional |
international-standing-order-consents | POST /international-standing-order-consents | Conditional |
international-standing-order-consents | GET /international-standing-order-consents/{ConsentId} | Mandatory (if resource POST implemented) |
international-standing-orders | POST /international-standing-orders | Conditional |
international-standing-orders | GET /international-standing-orders/{InternationalStandingOrderPaymentId} | Mandatory (if resource POST implemented) |
payment-details | GET /international-standing-orders/{InternationalStandingOrderPaymentId}/payment-details | Optional |
file-payment-consents | POST /file-payment-consents | Conditional |
file-payment-consents | GET /file-payment-consents/{ConsentId} | Conditional |
file-payment-consents | POST /file-payment-consents/{ConsentId}/file | Mandatory (if resource POST implemented) |
file-payment-consents | GET /file-payment-consents/{ConsentId}/file | Conditional |
file-payments | POST /file-payments | Conditional |
file-payments | GET /file-payments/{FilePaymentId} | Mandatory (if resource POST implemented) |
file-payments | GET /file-payments/{FilePaymentId}/report-file | Conditional |
payment-details | GET /file-payments/{FilePaymentId}/payment-details | Optional |
# Notes
Definitions for Mandatory, Conditional and Optional are given in the Read/Write Data API Profile.
# Payment Initiation Resource Compatibility
Read-Write API Profile | Read-Write API Profile | Read-Write API Profile | Payment Initiation API Profile | Payment Initiation API Profile | Payment Initiation API Profile | File Payments API Profile | File Payments API Profile | File Payments API Profile | ||
---|---|---|---|---|---|---|---|---|---|---|
v3.1 | v3.1.1 | 3.1.2 | v3.1 | v3.1.1 | 3.1.2 | v3.1 | v3.1.1 | 3.1.2 | ||
Domestic Payment Consents | v3.1 | TRUE | TRUE | TRUE | TRUE | TRUE | TRUE | n/a | ||
v3.1.1 | TRUE | TRUE | TRUE | TRUE | TRUE | TRUE | ||||
v3.1.2 | TRUE | TRUE | TRUE | TRUE | TRUE | TRUE | ||||
Domestic Payments | v3.1 | TRUE | TRUE | TRUE | TRUE | TRUE | TRUE | n/a | ||
v3.1.1 | TRUE | TRUE | TRUE | TRUE | TRUE | TRUE | ||||
v3.1.2 | TRUE | TRUE | TRUE | TRUE | TRUE | TRUE | ||||
Domestic Scheduled Payment Consents | v3.1 | TRUE | TRUE | TRUE | TRUE | TRUE | TRUE | n/a | ||
v3.1.1 | TRUE | TRUE | TRUE | TRUE | TRUE | TRUE | ||||
v3.1.2 | TRUE | TRUE | TRUE | TRUE | TRUE | TRUE | ||||
Domestic Scheduled Payments | v3.1 | TRUE | TRUE | TRUE | TRUE | TRUE | TRUE | n/a | ||
v3.1.1 | TRUE | TRUE | TRUE | TRUE | TRUE | TRUE | ||||
v3.1.2 | TRUE | TRUE | TRUE | TRUE | TRUE | TRUE | ||||
Domestic Standing Order Consents | v3.1 | TRUE | TRUE | TRUE | TRUE | TRUE | TRUE | n/a | ||
v3.1.1 | TRUE | TRUE | TRUE | TRUE | TRUE | TRUE | ||||
v3.1.2 | TRUE | TRUE | TRUE | TRUE | TRUE | TRUE | ||||
Domestic Standing Orders | v3.1 | TRUE | TRUE | TRUE | TRUE | TRUE | TRUE | n/a | ||
v3.1.1 | TRUE | TRUE | TRUE | TRUE | TRUE | TRUE | ||||
v3.1.2 | TRUE | TRUE | TRUE | TRUE | TRUE | TRUE | ||||
International Payment Consents | v3.1 | TRUE | TRUE | TRUE | TRUE | TRUE | TRUE | n/a | ||
v3.1.1 | TRUE | TRUE | TRUE | TRUE | TRUE | TRUE | ||||
v3.1.2 | TRUE | TRUE | TRUE | TRUE | TRUE | TRUE | ||||
International Payments | v3.1 | TRUE | TRUE | TRUE | TRUE | TRUE | TRUE | n/a | ||
v3.1.1 | TRUE | TRUE | TRUE | TRUE | TRUE | TRUE | ||||
v3.1.2 | TRUE | TRUE | TRUE | TRUE | TRUE | TRUE | ||||
International Scheduled Payment Consents | v3.1 | TRUE | TRUE | TRUE | TRUE | TRUE | TRUE | n/a | ||
v3.1.1 | TRUE | TRUE | TRUE | TRUE | TRUE | TRUE | ||||
v3.1.2 | TRUE | TRUE | TRUE | TRUE | TRUE | TRUE | ||||
International Scheduled Payments | v3.1 | TRUE | TRUE | TRUE | TRUE | TRUE | TRUE | n/a | ||
v3.1.1 | TRUE | TRUE | TRUE | TRUE | TRUE | TRUE | ||||
v3.1.2 | TRUE | TRUE | TRUE | TRUE | TRUE | TRUE | ||||
International Standing Order Consents | v3.1 | TRUE | TRUE | TRUE | TRUE | TRUE | TRUE | n/a | ||
v3.1.1 | TRUE | TRUE | TRUE | TRUE | TRUE | TRUE | ||||
v3.1.2 | TRUE | TRUE | TRUE | TRUE | TRUE | TRUE | ||||
International Standing Orders | v3.1 | TRUE | TRUE | TRUE | TRUE | TRUE | TRUE | n/a | ||
v3.1.1 | TRUE | TRUE | TRUE | TRUE | TRUE | TRUE | ||||
v3.1.2 | TRUE | TRUE | TRUE | TRUE | TRUE | TRUE | ||||
File Payment Consents | v3.1 | TRUE | TRUE | TRUE | TRUE | TRUE | TRUE | TRUE | TRUE | TRUE |
v3.1.1 | TRUE | TRUE | TRUE | TRUE | TRUE | TRUE | TRUE | TRUE | TRUE | |
v3.1.2 | TRUE | TRUE | TRUE | TRUE | TRUE | TRUE | TRUE | TRUE | TRUE | |
File Payments | v3.1 | TRUE | TRUE | TRUE | TRUE | TRUE | TRUE | TRUE | TRUE | TRUE |
v3.1.1 | TRUE | TRUE | TRUE | TRUE | TRUE | TRUE | TRUE | TRUE | TRUE | |
v3.1.2 | TRUE | TRUE | TRUE | TRUE | TRUE | TRUE | TRUE | TRUE | TRUE |