{ "opencollection": "1.0.0", "info": { "name": "Triodos XS2A BG service", "version": "1.1" }, "items": [ { "info": { "name": "Initial Access Token Service", "type": "folder" }, "items": [ { "info": { "name": "Get initial access token", "type": "http" }, "http": { "method": "GET", "url": "https://xs2a-sandbox.triodos.com/xs2a-bg/:tenant/onboarding/v1", "params": [ { "name": "tenant", "value": "", "type": "path", "description": "Branch of the request." } ] }, "docs": "Validates the TPP's X.509 EIDAS certificate and returns an initial access token to continue onboarding procedure." } ] }, { "info": { "name": "Account Information Service", "type": "folder" }, "items": [ { "info": { "name": "Get account", "type": "http" }, "http": { "method": "GET", "url": "https://xs2a-sandbox.triodos.com/xs2a-bg/:tenant/v1/accounts/:account-id", "headers": [ { "name": "X-Request-ID", "value": "" }, { "name": "Signature", "value": "" }, { "name": "Digest", "value": "" }, { "name": "PSU-IP-Address", "value": "" }, { "name": "Consent-ID", "value": "" } ], "params": [ { "name": "tenant", "value": "", "type": "path", "description": "Branch of the request." }, { "name": "account-id", "value": "", "type": "path", "description": "ID of account." }, { "name": "withBalance", "value": "", "type": "query", "description": "Not supported, should be unset" } ] }, "docs": "Reads details about an account, with balances where required. It is assumed that a consent of the PSU to this access is already given and stored on the ASPSP system. The addressed details of this account depends then on the stored consent addressed by consentId, respectively the OAuth2 access token." }, { "info": { "name": "Get accounts", "type": "http" }, "http": { "method": "GET", "url": "https://xs2a-sandbox.triodos.com/xs2a-bg/:tenant/v1/accounts", "headers": [ { "name": "X-Request-ID", "value": "" }, { "name": "Signature", "value": "" }, { "name": "Digest", "value": "" }, { "name": "PSU-IP-Address", "value": "" }, { "name": "Consent-ID", "value": "" } ], "params": [ { "name": "tenant", "value": "", "type": "path", "description": "Branch of the request." }, { "name": "withBalance", "value": "", "type": "query", "description": "Not supported, should be unset" } ] }, "docs": "Reads a list of bank accounts, with balances where required. It is assumed that a consent of the PSU to this access is already given and stored on the ASPSP system. The addressed list of accounts depends then on the PSU ID and the stored consent addressed by consentId, respectively the OAuth2 access token." }, { "info": { "name": "Get account balances", "type": "http" }, "http": { "method": "GET", "url": "https://xs2a-sandbox.triodos.com/xs2a-bg/:tenant/v1/accounts/:account-id/balances", "headers": [ { "name": "X-Request-ID", "value": "" }, { "name": "Signature", "value": "" }, { "name": "Digest", "value": "" }, { "name": "PSU-IP-Address", "value": "" }, { "name": "Consent-ID", "value": "" } ], "params": [ { "name": "tenant", "value": "", "type": "path", "description": "Branch of the request." }, { "name": "account-id", "value": "", "type": "path", "description": "ID of account." } ] }, "docs": "Reads account data from a given account addressed by \"account-id\"." }, { "info": { "name": "Get account transactions", "type": "http" }, "http": { "method": "GET", "url": "https://xs2a-sandbox.triodos.com/xs2a-bg/:tenant/v1/accounts/:account-id/transactions", "headers": [ { "name": "X-Request-ID", "value": "" }, { "name": "Signature", "value": "" }, { "name": "Digest", "value": "" }, { "name": "PSU-IP-Address", "value": "" }, { "name": "Consent-ID", "value": "" } ], "params": [ { "name": "tenant", "value": "", "type": "path", "description": "Branch of the request." }, { "name": "account-id", "value": "", "type": "path", "description": "ID of account." }, { "name": "bookingStatus", "value": "", "type": "query", "description": "Permitted codes are \"booked\", \"pending\" and \"both\", mandated if no delta access is required." }, { "name": "dateFrom", "value": "", "type": "query", "description": "Starting date (inclusive the date dateFrom) of the transaction list, mandated if no delta access is required." }, { "name": "dateTo", "value": "", "type": "query", "description": "End date (inclusive the date dateTo) of the transaction list, default is now if not given." }, { "name": "withBalance", "value": "", "type": "query", "description": "Not supported, should be unset" }, { "name": "entryReferenceFrom", "value": "", "type": "query", "description": "Not supported, should be unset" }, { "name": "deltaList", "value": "", "type": "query", "description": "Not supported, should be unset" }, { "name": "edgeToken", "value": "", "type": "query", "description": "Pagination edge token, to be used when paging through transactions" } ] }, "docs": "Reads account data from a given account addressed by \"account-id\"." }, { "info": { "name": "Paginate account transactions (deprecated, pass edge token to transactions endpoint instead)", "type": "http" }, "http": { "method": "GET", "url": "https://xs2a-sandbox.triodos.com/xs2a-bg/:tenant/v1/accounts/:account-id/transactions/page", "headers": [ { "name": "X-Request-ID", "value": "" }, { "name": "Signature", "value": "" }, { "name": "Digest", "value": "" }, { "name": "PSU-IP-Address", "value": "" }, { "name": "Consent-ID", "value": "" } ], "params": [ { "name": "tenant", "value": "", "type": "path", "description": "Branch of the request." }, { "name": "account-id", "value": "", "type": "path", "description": "ID of account." }, { "name": "edgeToken", "value": "", "type": "query", "description": "Pagination edge token." } ] }, "docs": "Reads account data from a given account addressed by \"account-id\"." }, { "info": { "name": "Get authorisations", "type": "http" }, "http": { "method": "GET", "url": "https://xs2a-sandbox.triodos.com/xs2a-bg/:tenant/v1/consents/:resource-id/authorisations", "headers": [ { "name": "X-Request-ID", "value": "" }, { "name": "Signature", "value": "" }, { "name": "Digest", "value": "" } ], "params": [ { "name": "tenant", "value": "", "type": "path", "description": "Branch of the request." }, { "name": "resource-id", "value": "", "type": "path", "description": "ID of the consent." } ] }, "docs": "Will deliver an array of resource ids of all generated authorisation sub-resources." }, { "info": { "name": "Create authorisation", "type": "http" }, "http": { "method": "POST", "url": "https://xs2a-sandbox.triodos.com/xs2a-bg/:tenant/v1/consents/:resource-id/authorisations", "headers": [ { "name": "X-Request-ID", "value": "" }, { "name": "Signature", "value": "" }, { "name": "Digest", "value": "" }, { "name": "TPP-Redirect-URI", "value": "" } ], "params": [ { "name": "tenant", "value": "", "type": "path", "description": "Branch of the request." }, { "name": "resource-id", "value": "", "type": "path", "description": "ID of the consent to create authorisation sub-resource for." } ] }, "docs": "Creates a consent authorisation sub-resource." }, { "info": { "name": "Get authorisation status", "type": "http" }, "http": { "method": "GET", "url": "https://xs2a-sandbox.triodos.com/xs2a-bg/:tenant/v1/consents/:resource-id/authorisations/:authorisation-id", "headers": [ { "name": "X-Request-ID", "value": "" }, { "name": "Signature", "value": "" }, { "name": "Digest", "value": "" } ], "params": [ { "name": "tenant", "value": "", "type": "path", "description": "Branch of the request." }, { "name": "resource-id", "value": "", "type": "path", "description": "ID of the consent." }, { "name": "authorisation-id", "value": "", "type": "path", "description": "ID of the authorisation sub-resource." } ] }, "docs": "Checks the SCA status of an authorisation sub-resource." }, { "info": { "name": "Update consent authorisation with access token", "type": "http" }, "http": { "method": "PUT", "url": "https://xs2a-sandbox.triodos.com/xs2a-bg/:tenant/v1/consents/:resource-id/authorisations/:authorisation-id", "headers": [ { "name": "X-Request-ID", "value": "" }, { "name": "Signature", "value": "" }, { "name": "Digest", "value": "" } ], "params": [ { "name": "tenant", "value": "", "type": "path", "description": "Branch of the request." }, { "name": "resource-id", "value": "", "type": "path", "description": "ID of the consent." }, { "name": "authorisation-id", "value": "", "type": "path", "description": "ID of the authorisation sub-resource" } ] }, "docs": "Updates the account information consent authorisation with an access token. If the access token has sufficient privileges, the consent will be authorized" }, { "info": { "name": "Get consent", "type": "http" }, "http": { "method": "GET", "url": "https://xs2a-sandbox.triodos.com/xs2a-bg/:tenant/v1/consents/:resource-id", "headers": [ { "name": "X-Request-ID", "value": "" }, { "name": "Signature", "value": "" }, { "name": "Digest", "value": "" } ], "params": [ { "name": "tenant", "value": "", "type": "path", "description": "Branch of the request." }, { "name": "resource-id", "value": "", "type": "path", "description": "ID of the consent." } ] }, "docs": "Returns the content of an account information consent object. This is returning the data for the TPP especially in cases, where the consent was directly managed between ASPSP and PSU e.g. in a re-direct SCA Approach." }, { "info": { "name": "Delete consent", "type": "http" }, "http": { "method": "DELETE", "url": "https://xs2a-sandbox.triodos.com/xs2a-bg/:tenant/v1/consents/:resource-id", "headers": [ { "name": "X-Request-ID", "value": "" }, { "name": "Signature", "value": "" }, { "name": "Digest", "value": "" } ], "params": [ { "name": "tenant", "value": "", "type": "path", "description": "Branch of the request." }, { "name": "resource-id", "value": "", "type": "path", "description": "ID of the consent." } ] }, "docs": "Deletes a given consent." }, { "info": { "name": "Get consent status", "type": "http" }, "http": { "method": "GET", "url": "https://xs2a-sandbox.triodos.com/xs2a-bg/:tenant/v1/consents/:resource-id/status", "headers": [ { "name": "X-Request-ID", "value": "" }, { "name": "Signature", "value": "" }, { "name": "Digest", "value": "" } ], "params": [ { "name": "tenant", "value": "", "type": "path", "description": "Branch of the request." }, { "name": "resource-id", "value": "", "type": "path", "description": "ID of the consent." } ] }, "docs": "Check the status of an account information consent resource." }, { "info": { "name": "Register consent", "type": "http" }, "http": { "method": "POST", "url": "https://xs2a-sandbox.triodos.com/xs2a-bg/:tenant/v1/consents", "headers": [ { "name": "X-Request-ID", "value": "" }, { "name": "Signature", "value": "" }, { "name": "Digest", "value": "" }, { "name": "PSU-IP-Address", "value": "" }, { "name": "TPP-Redirect-URI", "value": "" }, { "name": "TPP-Signature-Certificate", "value": "" } ], "params": [ { "name": "tenant", "value": "", "type": "path", "description": "Branch of the request." } ] }, "docs": "Creates an account information consent resource at the ASPSP regarding access to accounts specified in this request." } ] }, { "info": { "name": "Payment Initiation Service", "type": "folder" }, "items": [ { "info": { "name": "Get authorisations", "type": "http" }, "http": { "method": "GET", "url": "https://xs2a-sandbox.triodos.com/xs2a-bg/:tenant/v1/bulk-payments/sepa-credit-transfers/:resource-id/authorisations", "headers": [ { "name": "X-Request-ID", "value": "" }, { "name": "Signature", "value": "" }, { "name": "Digest", "value": "" } ], "params": [ { "name": "tenant", "value": "", "type": "path", "description": "Branch of the request." }, { "name": "resource-id", "value": "", "type": "path", "description": "ID of the payment." } ] }, "docs": "Will deliver an array of resource ids of all generated authorisation sub-resources." }, { "info": { "name": "Create authorisation", "type": "http" }, "http": { "method": "POST", "url": "https://xs2a-sandbox.triodos.com/xs2a-bg/:tenant/v1/bulk-payments/sepa-credit-transfers/:resource-id/authorisations", "headers": [ { "name": "X-Request-ID", "value": "" }, { "name": "Signature", "value": "" }, { "name": "Digest", "value": "" }, { "name": "TPP-Redirect-URI", "value": "" } ], "params": [ { "name": "tenant", "value": "", "type": "path", "description": "Branch of the request." }, { "name": "resource-id", "value": "", "type": "path", "description": "ID of the payment to create authorisation sub-resource for." } ] }, "docs": "Creates a payment authorisation sub-resource." }, { "info": { "name": "Get authorisation status", "type": "http" }, "http": { "method": "GET", "url": "https://xs2a-sandbox.triodos.com/xs2a-bg/:tenant/v1/bulk-payments/sepa-credit-transfers/:resource-id/authorisations/:authorisation-id", "headers": [ { "name": "X-Request-ID", "value": "" }, { "name": "Signature", "value": "" }, { "name": "Digest", "value": "" } ], "params": [ { "name": "tenant", "value": "", "type": "path", "description": "Branch of the request." }, { "name": "resource-id", "value": "", "type": "path", "description": "ID of the payment." }, { "name": "authorisation-id", "value": "", "type": "path", "description": "ID of the authorisation sub-resource." } ] }, "docs": "Checks the SCA status of an authorisation sub-resource." }, { "info": { "name": "Submit payment authorisation", "type": "http" }, "http": { "method": "PUT", "url": "https://xs2a-sandbox.triodos.com/xs2a-bg/:tenant/v1/bulk-payments/sepa-credit-transfers/:resource-id/authorisations/:authorisation-id", "headers": [ { "name": "X-Request-ID", "value": "" }, { "name": "Signature", "value": "" }, { "name": "Digest", "value": "" }, { "name": "Authorization", "value": "" } ], "params": [ { "name": "tenant", "value": "", "type": "path", "description": "Branch of the request." }, { "name": "resource-id", "value": "", "type": "path", "description": "ID of the payment" }, { "name": "authorisation-id", "value": "", "type": "path", "description": "ID of the authorisation sub-resource" } ] }, "docs": "Submits an access token to authorise a payment initiation." }, { "info": { "name": "Get cancellation authorisations", "type": "http" }, "http": { "method": "GET", "url": "https://xs2a-sandbox.triodos.com/xs2a-bg/:tenant/v1/bulk-payments/sepa-credit-transfers/:resource-id/cancellation-authorisations", "headers": [ { "name": "X-Request-ID", "value": "" }, { "name": "Signature", "value": "" }, { "name": "Digest", "value": "" } ], "params": [ { "name": "tenant", "value": "", "type": "path", "description": "Branch of the request." }, { "name": "resource-id", "value": "", "type": "path", "description": "ID of the payment to get cancellation authorisations for." } ] }, "docs": "Will deliver an array of resource ids of all generated cancellation authorisation sub-resources." }, { "info": { "name": "Create cancellation authorisation", "type": "http" }, "http": { "method": "POST", "url": "https://xs2a-sandbox.triodos.com/xs2a-bg/:tenant/v1/bulk-payments/sepa-credit-transfers/:resource-id/cancellation-authorisations", "headers": [ { "name": "X-Request-ID", "value": "" }, { "name": "Signature", "value": "" }, { "name": "Digest", "value": "" }, { "name": "TPP-Redirect-URI", "value": "" } ], "params": [ { "name": "tenant", "value": "", "type": "path", "description": "Branch of the request." }, { "name": "resource-id", "value": "", "type": "path", "description": "ID of the payment to create cancellation authorisation sub-resource for." } ] }, "docs": "Creates a payment cancellation authorisation sub-resource." }, { "info": { "name": "Get cancellation authorisation status", "type": "http" }, "http": { "method": "GET", "url": "https://xs2a-sandbox.triodos.com/xs2a-bg/:tenant/v1/bulk-payments/sepa-credit-transfers/:resource-id/cancellation-authorisations/:authorisation-id", "headers": [ { "name": "X-Request-ID", "value": "" }, { "name": "Signature", "value": "" }, { "name": "Digest", "value": "" } ], "params": [ { "name": "tenant", "value": "", "type": "path", "description": "Branch of the request." }, { "name": "resource-id", "value": "", "type": "path", "description": "ID of the payment." }, { "name": "authorisation-id", "value": "", "type": "path", "description": "ID of the cancellation authorisation sub-resource." } ] }, "docs": "Checks the SCA status of a cancellation authorisation sub-resource." }, { "info": { "name": "Update payment cancellation authorisation with access token", "type": "http" }, "http": { "method": "PUT", "url": "https://xs2a-sandbox.triodos.com/xs2a-bg/:tenant/v1/bulk-payments/sepa-credit-transfers/:resource-id/cancellation-authorisations/:authorisation-id", "headers": [ { "name": "X-Request-ID", "value": "" }, { "name": "Signature", "value": "" }, { "name": "Digest", "value": "" } ], "params": [ { "name": "tenant", "value": "", "type": "path", "description": "Branch of the request." }, { "name": "resource-id", "value": "", "type": "path", "description": "ID of the payment to cancel" }, { "name": "authorisation-id", "value": "", "type": "path", "description": "ID of the cancellation authorisation sub-resource" } ] }, "docs": "Updates the payment cancellation data on the server by PSU data, if requested by the ASPSP. Also cancels the payment if sufficient privileges are present." }, { "info": { "name": "Cancel payment", "type": "http" }, "http": { "method": "DELETE", "url": "https://xs2a-sandbox.triodos.com/xs2a-bg/:tenant/v1/bulk-payments/sepa-credit-transfers/:resource-id", "headers": [ { "name": "X-Request-ID", "value": "" }, { "name": "TPP-Redirect-URI", "value": "" } ], "params": [ { "name": "tenant", "value": "", "type": "path", "description": "Branch of the request." }, { "name": "resource-id", "value": "", "type": "path", "description": "ID of the payment." } ] }, "docs": "If the payment is not authorized yet, the payment request is directly cancelled. Otherwise a cancellation authorization sub-resource is created." }, { "info": { "name": "Get payment status", "type": "http" }, "http": { "method": "GET", "url": "https://xs2a-sandbox.triodos.com/xs2a-bg/:tenant/v1/bulk-payments/sepa-credit-transfers/:resource-id/status", "headers": [ { "name": "X-Request-ID", "value": "" }, { "name": "Signature", "value": "" }, { "name": "Digest", "value": "" } ], "params": [ { "name": "tenant", "value": "", "type": "path", "description": "Branch of the request." }, { "name": "resource-id", "value": "", "type": "path", "description": "ID of the payment." } ] }, "docs": "Can check the status of a payment initiation." }, { "info": { "name": "Initiate Sepa Bulk Payment", "type": "http" }, "http": { "method": "POST", "url": "https://xs2a-sandbox.triodos.com/xs2a-bg/:tenant/v1/bulk-payments/sepa-credit-transfers", "headers": [ { "name": "X-Request-ID", "value": "" }, { "name": "Signature", "value": "" }, { "name": "Digest", "value": "" }, { "name": "PSU-IP-Address", "value": "" }, { "name": "TPP-Redirect-URI", "value": "" }, { "name": "Consent-ID", "value": "" }, { "name": "TPP-Signature-Certificate", "value": "" } ], "params": [ { "name": "tenant", "value": "", "type": "path", "description": "Branch of the request." } ] }, "docs": "Creates a Sepa bulk payment initiation request and corresponding authorisation sub-resource." }, { "info": { "name": "Get authorisations", "type": "http" }, "http": { "method": "GET", "url": "https://xs2a-sandbox.triodos.com/xs2a-bg/:tenant/v1/payments/cross-border-credit-transfers/:resource-id/authorisations", "headers": [ { "name": "X-Request-ID", "value": "" }, { "name": "Signature", "value": "" }, { "name": "Digest", "value": "" } ], "params": [ { "name": "tenant", "value": "", "type": "path", "description": "Branch of the request." }, { "name": "resource-id", "value": "", "type": "path", "description": "ID of the payment." } ] }, "docs": "Will deliver an array of resource ids of all generated authorisation sub-resources." }, { "info": { "name": "Create authorisation", "type": "http" }, "http": { "method": "POST", "url": "https://xs2a-sandbox.triodos.com/xs2a-bg/:tenant/v1/payments/cross-border-credit-transfers/:resource-id/authorisations", "headers": [ { "name": "X-Request-ID", "value": "" }, { "name": "Signature", "value": "" }, { "name": "Digest", "value": "" }, { "name": "TPP-Redirect-URI", "value": "" } ], "params": [ { "name": "tenant", "value": "", "type": "path", "description": "Branch of the request." }, { "name": "resource-id", "value": "", "type": "path", "description": "ID of the payment to create authorisation sub-resource for." } ] }, "docs": "Creates a payment authorisation sub-resource." }, { "info": { "name": "Get authorisation status", "type": "http" }, "http": { "method": "GET", "url": "https://xs2a-sandbox.triodos.com/xs2a-bg/:tenant/v1/payments/cross-border-credit-transfers/:resource-id/authorisations/:authorisation-id", "headers": [ { "name": "X-Request-ID", "value": "" }, { "name": "Signature", "value": "" }, { "name": "Digest", "value": "" } ], "params": [ { "name": "tenant", "value": "", "type": "path", "description": "Branch of the request." }, { "name": "resource-id", "value": "", "type": "path", "description": "ID of the payment." }, { "name": "authorisation-id", "value": "", "type": "path", "description": "ID of the authorisation sub-resource." } ] }, "docs": "Checks the SCA status of an authorisation sub-resource." }, { "info": { "name": "Submit payment authorisation", "type": "http" }, "http": { "method": "PUT", "url": "https://xs2a-sandbox.triodos.com/xs2a-bg/:tenant/v1/payments/cross-border-credit-transfers/:resource-id/authorisations/:authorisation-id", "headers": [ { "name": "X-Request-ID", "value": "" }, { "name": "Signature", "value": "" }, { "name": "Digest", "value": "" }, { "name": "Authorization", "value": "" } ], "params": [ { "name": "tenant", "value": "", "type": "path", "description": "Branch of the request." }, { "name": "resource-id", "value": "", "type": "path", "description": "ID of the payment" }, { "name": "authorisation-id", "value": "", "type": "path", "description": "ID of the authorisation sub-resource" } ] }, "docs": "Submits an access token to authorise a payment initiation." }, { "info": { "name": "Get cancellation authorisations", "type": "http" }, "http": { "method": "GET", "url": "https://xs2a-sandbox.triodos.com/xs2a-bg/:tenant/v1/payments/cross-border-credit-transfers/:resource-id/cancellation-authorisations", "headers": [ { "name": "X-Request-ID", "value": "" }, { "name": "Signature", "value": "" }, { "name": "Digest", "value": "" } ], "params": [ { "name": "tenant", "value": "", "type": "path", "description": "Branch of the request." }, { "name": "resource-id", "value": "", "type": "path", "description": "ID of the payment to get cancellation authorisations for." } ] }, "docs": "Will deliver an array of resource ids of all generated cancellation authorisation sub-resources." }, { "info": { "name": "Create cancellation authorisation", "type": "http" }, "http": { "method": "POST", "url": "https://xs2a-sandbox.triodos.com/xs2a-bg/:tenant/v1/payments/cross-border-credit-transfers/:resource-id/cancellation-authorisations", "headers": [ { "name": "X-Request-ID", "value": "" }, { "name": "Signature", "value": "" }, { "name": "Digest", "value": "" }, { "name": "TPP-Redirect-URI", "value": "" } ], "params": [ { "name": "tenant", "value": "", "type": "path", "description": "Branch of the request." }, { "name": "resource-id", "value": "", "type": "path", "description": "ID of the payment to create cancellation authorisation sub-resource for." } ] }, "docs": "Creates a payment cancellation authorisation sub-resource." }, { "info": { "name": "Get cancellation authorisation status", "type": "http" }, "http": { "method": "GET", "url": "https://xs2a-sandbox.triodos.com/xs2a-bg/:tenant/v1/payments/cross-border-credit-transfers/:resource-id/cancellation-authorisations/:authorisation-id", "headers": [ { "name": "X-Request-ID", "value": "" }, { "name": "Signature", "value": "" }, { "name": "Digest", "value": "" } ], "params": [ { "name": "tenant", "value": "", "type": "path", "description": "Branch of the request." }, { "name": "resource-id", "value": "", "type": "path", "description": "ID of the payment." }, { "name": "authorisation-id", "value": "", "type": "path", "description": "ID of the cancellation authorisation sub-resource." } ] }, "docs": "Checks the SCA status of a cancellation authorisation sub-resource." }, { "info": { "name": "Update payment cancellation authorisation with access token", "type": "http" }, "http": { "method": "PUT", "url": "https://xs2a-sandbox.triodos.com/xs2a-bg/:tenant/v1/payments/cross-border-credit-transfers/:resource-id/cancellation-authorisations/:authorisation-id", "headers": [ { "name": "X-Request-ID", "value": "" }, { "name": "Signature", "value": "" }, { "name": "Digest", "value": "" } ], "params": [ { "name": "tenant", "value": "", "type": "path", "description": "Branch of the request." }, { "name": "resource-id", "value": "", "type": "path", "description": "ID of the payment to cancel" }, { "name": "authorisation-id", "value": "", "type": "path", "description": "ID of the cancellation authorisation sub-resource" } ] }, "docs": "Updates the payment cancellation data on the server by PSU data, if requested by the ASPSP. Also cancels the payment if sufficient privileges are present." }, { "info": { "name": "Cancel payment", "type": "http" }, "http": { "method": "DELETE", "url": "https://xs2a-sandbox.triodos.com/xs2a-bg/:tenant/v1/payments/cross-border-credit-transfers/:resource-id", "headers": [ { "name": "X-Request-ID", "value": "" }, { "name": "TPP-Redirect-URI", "value": "" } ], "params": [ { "name": "tenant", "value": "", "type": "path", "description": "Branch of the request." }, { "name": "resource-id", "value": "", "type": "path", "description": "ID of the payment." } ] }, "docs": "If the payment is not authorized yet, the payment request is directly cancelled. Otherwise a cancellation authorization sub-resource is created." }, { "info": { "name": "Get payment status", "type": "http" }, "http": { "method": "GET", "url": "https://xs2a-sandbox.triodos.com/xs2a-bg/:tenant/v1/payments/cross-border-credit-transfers/:resource-id/status", "headers": [ { "name": "X-Request-ID", "value": "" }, { "name": "Signature", "value": "" }, { "name": "Digest", "value": "" } ], "params": [ { "name": "tenant", "value": "", "type": "path", "description": "Branch of the request." }, { "name": "resource-id", "value": "", "type": "path", "description": "ID of the payment." } ] }, "docs": "Can check the status of a payment initiation." }, { "info": { "name": "Initiate Cross Border payment", "type": "http" }, "http": { "method": "POST", "url": "https://xs2a-sandbox.triodos.com/xs2a-bg/:tenant/v1/payments/cross-border-credit-transfers", "headers": [ { "name": "X-Request-ID", "value": "" }, { "name": "Signature", "value": "" }, { "name": "Digest", "value": "" }, { "name": "PSU-IP-Address", "value": "" }, { "name": "TPP-Redirect-URI", "value": "" }, { "name": "Consent-ID", "value": "" }, { "name": "TPP-Signature-Certificate", "value": "" } ], "params": [ { "name": "tenant", "value": "", "type": "path", "description": "Branch of the request." } ] }, "docs": "Creates a Cross Border payment initiation request and corresponding authorisation sub-resource." }, { "info": { "name": "Get authorisations", "type": "http" }, "http": { "method": "GET", "url": "https://xs2a-sandbox.triodos.com/xs2a-bg/:tenant/v1/payments/sepa-credit-transfers/:resource-id/authorisations", "headers": [ { "name": "X-Request-ID", "value": "" }, { "name": "Signature", "value": "" }, { "name": "Digest", "value": "" } ], "params": [ { "name": "tenant", "value": "", "type": "path", "description": "Branch of the request." }, { "name": "resource-id", "value": "", "type": "path", "description": "ID of the payment." } ] }, "docs": "Will deliver an array of resource ids of all generated authorisation sub-resources." }, { "info": { "name": "Create authorisation", "type": "http" }, "http": { "method": "POST", "url": "https://xs2a-sandbox.triodos.com/xs2a-bg/:tenant/v1/payments/sepa-credit-transfers/:resource-id/authorisations", "headers": [ { "name": "X-Request-ID", "value": "" }, { "name": "Signature", "value": "" }, { "name": "Digest", "value": "" }, { "name": "TPP-Redirect-URI", "value": "" } ], "params": [ { "name": "tenant", "value": "", "type": "path", "description": "Branch of the request." }, { "name": "resource-id", "value": "", "type": "path", "description": "ID of the payment to create authorisation sub-resource for." } ] }, "docs": "Creates a payment authorisation sub-resource." }, { "info": { "name": "Get authorisation status", "type": "http" }, "http": { "method": "GET", "url": "https://xs2a-sandbox.triodos.com/xs2a-bg/:tenant/v1/payments/sepa-credit-transfers/:resource-id/authorisations/:authorisation-id", "headers": [ { "name": "X-Request-ID", "value": "" }, { "name": "Signature", "value": "" }, { "name": "Digest", "value": "" } ], "params": [ { "name": "tenant", "value": "", "type": "path", "description": "Branch of the request." }, { "name": "resource-id", "value": "", "type": "path", "description": "ID of the payment." }, { "name": "authorisation-id", "value": "", "type": "path", "description": "ID of the authorisation sub-resource." } ] }, "docs": "Checks the SCA status of an authorisation sub-resource." }, { "info": { "name": "Submit payment authorisation", "type": "http" }, "http": { "method": "PUT", "url": "https://xs2a-sandbox.triodos.com/xs2a-bg/:tenant/v1/payments/sepa-credit-transfers/:resource-id/authorisations/:authorisation-id", "headers": [ { "name": "X-Request-ID", "value": "" }, { "name": "Signature", "value": "" }, { "name": "Digest", "value": "" }, { "name": "Authorization", "value": "" } ], "params": [ { "name": "tenant", "value": "", "type": "path", "description": "Branch of the request." }, { "name": "resource-id", "value": "", "type": "path", "description": "ID of the payment" }, { "name": "authorisation-id", "value": "", "type": "path", "description": "ID of the authorisation sub-resource" } ] }, "docs": "Submits an access token to authorise a payment initiation." }, { "info": { "name": "Get cancellation authorisations", "type": "http" }, "http": { "method": "GET", "url": "https://xs2a-sandbox.triodos.com/xs2a-bg/:tenant/v1/payments/sepa-credit-transfers/:resource-id/cancellation-authorisations", "headers": [ { "name": "X-Request-ID", "value": "" }, { "name": "Signature", "value": "" }, { "name": "Digest", "value": "" } ], "params": [ { "name": "tenant", "value": "", "type": "path", "description": "Branch of the request." }, { "name": "resource-id", "value": "", "type": "path", "description": "ID of the payment to get cancellation authorisations for." } ] }, "docs": "Will deliver an array of resource ids of all generated cancellation authorisation sub-resources." }, { "info": { "name": "Create cancellation authorisation", "type": "http" }, "http": { "method": "POST", "url": "https://xs2a-sandbox.triodos.com/xs2a-bg/:tenant/v1/payments/sepa-credit-transfers/:resource-id/cancellation-authorisations", "headers": [ { "name": "X-Request-ID", "value": "" }, { "name": "Signature", "value": "" }, { "name": "Digest", "value": "" }, { "name": "TPP-Redirect-URI", "value": "" } ], "params": [ { "name": "tenant", "value": "", "type": "path", "description": "Branch of the request." }, { "name": "resource-id", "value": "", "type": "path", "description": "ID of the payment to create cancellation authorisation sub-resource for." } ] }, "docs": "Creates a payment cancellation authorisation sub-resource." }, { "info": { "name": "Get cancellation authorisation status", "type": "http" }, "http": { "method": "GET", "url": "https://xs2a-sandbox.triodos.com/xs2a-bg/:tenant/v1/payments/sepa-credit-transfers/:resource-id/cancellation-authorisations/:authorisation-id", "headers": [ { "name": "X-Request-ID", "value": "" }, { "name": "Signature", "value": "" }, { "name": "Digest", "value": "" } ], "params": [ { "name": "tenant", "value": "", "type": "path", "description": "Branch of the request." }, { "name": "resource-id", "value": "", "type": "path", "description": "ID of the payment." }, { "name": "authorisation-id", "value": "", "type": "path", "description": "ID of the cancellation authorisation sub-resource." } ] }, "docs": "Checks the SCA status of a cancellation authorisation sub-resource." }, { "info": { "name": "Update payment cancellation authorisation with access token", "type": "http" }, "http": { "method": "PUT", "url": "https://xs2a-sandbox.triodos.com/xs2a-bg/:tenant/v1/payments/sepa-credit-transfers/:resource-id/cancellation-authorisations/:authorisation-id", "headers": [ { "name": "X-Request-ID", "value": "" }, { "name": "Signature", "value": "" }, { "name": "Digest", "value": "" } ], "params": [ { "name": "tenant", "value": "", "type": "path", "description": "Branch of the request." }, { "name": "resource-id", "value": "", "type": "path", "description": "ID of the payment to cancel" }, { "name": "authorisation-id", "value": "", "type": "path", "description": "ID of the cancellation authorisation sub-resource" } ] }, "docs": "Updates the payment cancellation data on the server by PSU data, if requested by the ASPSP. Also cancels the payment if sufficient privileges are present." }, { "info": { "name": "Cancel payment", "type": "http" }, "http": { "method": "DELETE", "url": "https://xs2a-sandbox.triodos.com/xs2a-bg/:tenant/v1/payments/sepa-credit-transfers/:resource-id", "headers": [ { "name": "X-Request-ID", "value": "" }, { "name": "TPP-Redirect-URI", "value": "" } ], "params": [ { "name": "tenant", "value": "", "type": "path", "description": "Branch of the request." }, { "name": "resource-id", "value": "", "type": "path", "description": "ID of the payment." } ] }, "docs": "If the payment is not authorized yet, the payment request is directly cancelled. Otherwise a cancellation authorization sub-resource is created." }, { "info": { "name": "Get payment status", "type": "http" }, "http": { "method": "GET", "url": "https://xs2a-sandbox.triodos.com/xs2a-bg/:tenant/v1/payments/sepa-credit-transfers/:resource-id/status", "headers": [ { "name": "X-Request-ID", "value": "" }, { "name": "Signature", "value": "" }, { "name": "Digest", "value": "" } ], "params": [ { "name": "tenant", "value": "", "type": "path", "description": "Branch of the request." }, { "name": "resource-id", "value": "", "type": "path", "description": "ID of the payment." } ] }, "docs": "Can check the status of a payment initiation." }, { "info": { "name": "Initiate Sepa payment", "type": "http" }, "http": { "method": "POST", "url": "https://xs2a-sandbox.triodos.com/xs2a-bg/:tenant/v1/payments/sepa-credit-transfers", "headers": [ { "name": "X-Request-ID", "value": "" }, { "name": "Signature", "value": "" }, { "name": "Digest", "value": "" }, { "name": "PSU-IP-Address", "value": "" }, { "name": "TPP-Redirect-URI", "value": "" }, { "name": "Consent-ID", "value": "" }, { "name": "TPP-Signature-Certificate", "value": "" } ], "params": [ { "name": "tenant", "value": "", "type": "path", "description": "Branch of the request." } ] }, "docs": "Creates a Sepa payment initiation request and corresponding authorisation sub-resource." }, { "info": { "name": "Get authorisations", "type": "http" }, "http": { "method": "GET", "url": "https://xs2a-sandbox.triodos.com/xs2a-bg/:tenant/v1/payments/uk-domestic-transfers/:resource-id/authorisations", "headers": [ { "name": "X-Request-ID", "value": "" }, { "name": "Signature", "value": "" }, { "name": "Digest", "value": "" } ], "params": [ { "name": "tenant", "value": "", "type": "path", "description": "Branch of the request." }, { "name": "resource-id", "value": "", "type": "path", "description": "ID of the payment." } ] }, "docs": "Will deliver an array of resource ids of all generated authorisation sub-resources." }, { "info": { "name": "Create authorisation", "type": "http" }, "http": { "method": "POST", "url": "https://xs2a-sandbox.triodos.com/xs2a-bg/:tenant/v1/payments/uk-domestic-transfers/:resource-id/authorisations", "headers": [ { "name": "X-Request-ID", "value": "" }, { "name": "Signature", "value": "" }, { "name": "Digest", "value": "" }, { "name": "TPP-Redirect-URI", "value": "" } ], "params": [ { "name": "tenant", "value": "", "type": "path", "description": "Branch of the request." }, { "name": "resource-id", "value": "", "type": "path", "description": "ID of the payment to create authorisation sub-resource for." } ] }, "docs": "Creates a payment authorisation sub-resource." }, { "info": { "name": "Get authorisation status", "type": "http" }, "http": { "method": "GET", "url": "https://xs2a-sandbox.triodos.com/xs2a-bg/:tenant/v1/payments/uk-domestic-transfers/:resource-id/authorisations/:authorisation-id", "headers": [ { "name": "X-Request-ID", "value": "" }, { "name": "Signature", "value": "" }, { "name": "Digest", "value": "" } ], "params": [ { "name": "tenant", "value": "", "type": "path", "description": "Branch of the request." }, { "name": "resource-id", "value": "", "type": "path", "description": "ID of the payment." }, { "name": "authorisation-id", "value": "", "type": "path", "description": "ID of the authorisation sub-resource." } ] }, "docs": "Checks the SCA status of an authorisation sub-resource." }, { "info": { "name": "Submit payment authorisation", "type": "http" }, "http": { "method": "PUT", "url": "https://xs2a-sandbox.triodos.com/xs2a-bg/:tenant/v1/payments/uk-domestic-transfers/:resource-id/authorisations/:authorisation-id", "headers": [ { "name": "X-Request-ID", "value": "" }, { "name": "Signature", "value": "" }, { "name": "Digest", "value": "" }, { "name": "Authorization", "value": "" } ], "params": [ { "name": "tenant", "value": "", "type": "path", "description": "Branch of the request." }, { "name": "resource-id", "value": "", "type": "path", "description": "ID of the payment" }, { "name": "authorisation-id", "value": "", "type": "path", "description": "ID of the authorisation sub-resource" } ] }, "docs": "Submits an access token to authorise a payment initiation." }, { "info": { "name": "Get cancellation authorisations", "type": "http" }, "http": { "method": "GET", "url": "https://xs2a-sandbox.triodos.com/xs2a-bg/:tenant/v1/payments/uk-domestic-transfers/:resource-id/cancellation-authorisations", "headers": [ { "name": "X-Request-ID", "value": "" }, { "name": "Signature", "value": "" }, { "name": "Digest", "value": "" } ], "params": [ { "name": "tenant", "value": "", "type": "path", "description": "Branch of the request." }, { "name": "resource-id", "value": "", "type": "path", "description": "ID of the payment to get cancellation authorisations for." } ] }, "docs": "Will deliver an array of resource ids of all generated cancellation authorisation sub-resources." }, { "info": { "name": "Create cancellation authorisation", "type": "http" }, "http": { "method": "POST", "url": "https://xs2a-sandbox.triodos.com/xs2a-bg/:tenant/v1/payments/uk-domestic-transfers/:resource-id/cancellation-authorisations", "headers": [ { "name": "X-Request-ID", "value": "" }, { "name": "Signature", "value": "" }, { "name": "Digest", "value": "" }, { "name": "TPP-Redirect-URI", "value": "" } ], "params": [ { "name": "tenant", "value": "", "type": "path", "description": "Branch of the request." }, { "name": "resource-id", "value": "", "type": "path", "description": "ID of the payment to create cancellation authorisation sub-resource for." } ] }, "docs": "Creates a payment cancellation authorisation sub-resource." }, { "info": { "name": "Get cancellation authorisation status", "type": "http" }, "http": { "method": "GET", "url": "https://xs2a-sandbox.triodos.com/xs2a-bg/:tenant/v1/payments/uk-domestic-transfers/:resource-id/cancellation-authorisations/:authorisation-id", "headers": [ { "name": "X-Request-ID", "value": "" }, { "name": "Signature", "value": "" }, { "name": "Digest", "value": "" } ], "params": [ { "name": "tenant", "value": "", "type": "path", "description": "Branch of the request." }, { "name": "resource-id", "value": "", "type": "path", "description": "ID of the payment." }, { "name": "authorisation-id", "value": "", "type": "path", "description": "ID of the cancellation authorisation sub-resource." } ] }, "docs": "Checks the SCA status of a cancellation authorisation sub-resource." }, { "info": { "name": "Update payment cancellation authorisation with access token", "type": "http" }, "http": { "method": "PUT", "url": "https://xs2a-sandbox.triodos.com/xs2a-bg/:tenant/v1/payments/uk-domestic-transfers/:resource-id/cancellation-authorisations/:authorisation-id", "headers": [ { "name": "X-Request-ID", "value": "" }, { "name": "Signature", "value": "" }, { "name": "Digest", "value": "" } ], "params": [ { "name": "tenant", "value": "", "type": "path", "description": "Branch of the request." }, { "name": "resource-id", "value": "", "type": "path", "description": "ID of the payment to cancel" }, { "name": "authorisation-id", "value": "", "type": "path", "description": "ID of the cancellation authorisation sub-resource" } ] }, "docs": "Updates the payment cancellation data on the server by PSU data, if requested by the ASPSP. Also cancels the payment if sufficient privileges are present." }, { "info": { "name": "Cancel payment", "type": "http" }, "http": { "method": "DELETE", "url": "https://xs2a-sandbox.triodos.com/xs2a-bg/:tenant/v1/payments/uk-domestic-transfers/:resource-id", "headers": [ { "name": "X-Request-ID", "value": "" }, { "name": "TPP-Redirect-URI", "value": "" } ], "params": [ { "name": "tenant", "value": "", "type": "path", "description": "Branch of the request." }, { "name": "resource-id", "value": "", "type": "path", "description": "ID of the payment." } ] }, "docs": "If the payment is not authorized yet, the payment request is directly cancelled. Otherwise a cancellation authorization sub-resource is created." }, { "info": { "name": "Get payment status", "type": "http" }, "http": { "method": "GET", "url": "https://xs2a-sandbox.triodos.com/xs2a-bg/:tenant/v1/payments/uk-domestic-transfers/:resource-id/status", "headers": [ { "name": "X-Request-ID", "value": "" }, { "name": "Signature", "value": "" }, { "name": "Digest", "value": "" } ], "params": [ { "name": "tenant", "value": "", "type": "path", "description": "Branch of the request." }, { "name": "resource-id", "value": "", "type": "path", "description": "ID of the payment." } ] }, "docs": "Can check the status of a payment initiation." }, { "info": { "name": "Initiate UK Domestic payment", "type": "http" }, "http": { "method": "POST", "url": "https://xs2a-sandbox.triodos.com/xs2a-bg/:tenant/v1/payments/uk-domestic-transfers", "headers": [ { "name": "X-Request-ID", "value": "" }, { "name": "Signature", "value": "" }, { "name": "Digest", "value": "" }, { "name": "PSU-IP-Address", "value": "" }, { "name": "TPP-Redirect-URI", "value": "" }, { "name": "Consent-ID", "value": "" }, { "name": "TPP-Signature-Certificate", "value": "" } ], "params": [ { "name": "tenant", "value": "", "type": "path", "description": "Branch of the request." } ] }, "docs": "Creates a UK Domestic payment initiation request and corresponding authorisation sub-resource." }, { "info": { "name": "Get authorisations", "type": "http" }, "http": { "method": "GET", "url": "https://xs2a-sandbox.triodos.com/xs2a-bg/:tenant/v1/periodic-payments/sepa-credit-transfers/:resource-id/authorisations", "headers": [ { "name": "X-Request-ID", "value": "" }, { "name": "Signature", "value": "" }, { "name": "Digest", "value": "" } ], "params": [ { "name": "tenant", "value": "", "type": "path", "description": "Branch of the request." }, { "name": "resource-id", "value": "", "type": "path", "description": "ID of the payment." } ] }, "docs": "Will deliver an array of resource ids of all generated authorisation sub-resources." }, { "info": { "name": "Create authorisation", "type": "http" }, "http": { "method": "POST", "url": "https://xs2a-sandbox.triodos.com/xs2a-bg/:tenant/v1/periodic-payments/sepa-credit-transfers/:resource-id/authorisations", "headers": [ { "name": "X-Request-ID", "value": "" }, { "name": "Signature", "value": "" }, { "name": "Digest", "value": "" }, { "name": "TPP-Redirect-URI", "value": "" } ], "params": [ { "name": "tenant", "value": "", "type": "path", "description": "Branch of the request." }, { "name": "resource-id", "value": "", "type": "path", "description": "ID of the payment to create authorisation sub-resource for." } ] }, "docs": "Creates a payment authorisation sub-resource." }, { "info": { "name": "Get authorisation status", "type": "http" }, "http": { "method": "GET", "url": "https://xs2a-sandbox.triodos.com/xs2a-bg/:tenant/v1/periodic-payments/sepa-credit-transfers/:resource-id/authorisations/:authorisation-id", "headers": [ { "name": "X-Request-ID", "value": "" }, { "name": "Signature", "value": "" }, { "name": "Digest", "value": "" } ], "params": [ { "name": "tenant", "value": "", "type": "path", "description": "Branch of the request." }, { "name": "resource-id", "value": "", "type": "path", "description": "ID of the payment." }, { "name": "authorisation-id", "value": "", "type": "path", "description": "ID of the authorisation sub-resource." } ] }, "docs": "Checks the SCA status of an authorisation sub-resource." }, { "info": { "name": "Submit payment authorisation", "type": "http" }, "http": { "method": "PUT", "url": "https://xs2a-sandbox.triodos.com/xs2a-bg/:tenant/v1/periodic-payments/sepa-credit-transfers/:resource-id/authorisations/:authorisation-id", "headers": [ { "name": "X-Request-ID", "value": "" }, { "name": "Signature", "value": "" }, { "name": "Digest", "value": "" }, { "name": "Authorization", "value": "" } ], "params": [ { "name": "tenant", "value": "", "type": "path", "description": "Branch of the request." }, { "name": "resource-id", "value": "", "type": "path", "description": "ID of the payment" }, { "name": "authorisation-id", "value": "", "type": "path", "description": "ID of the authorisation sub-resource" } ] }, "docs": "Submits an access token to authorise a payment initiation." }, { "info": { "name": "Get cancellation authorisations", "type": "http" }, "http": { "method": "GET", "url": "https://xs2a-sandbox.triodos.com/xs2a-bg/:tenant/v1/periodic-payments/sepa-credit-transfers/:resource-id/cancellation-authorisations", "headers": [ { "name": "X-Request-ID", "value": "" }, { "name": "Signature", "value": "" }, { "name": "Digest", "value": "" } ], "params": [ { "name": "tenant", "value": "", "type": "path", "description": "Branch of the request." }, { "name": "resource-id", "value": "", "type": "path", "description": "ID of the payment to get cancellation authorisations for." } ] }, "docs": "Will deliver an array of resource ids of all generated cancellation authorisation sub-resources." }, { "info": { "name": "Create cancellation authorisation", "type": "http" }, "http": { "method": "POST", "url": "https://xs2a-sandbox.triodos.com/xs2a-bg/:tenant/v1/periodic-payments/sepa-credit-transfers/:resource-id/cancellation-authorisations", "headers": [ { "name": "X-Request-ID", "value": "" }, { "name": "Signature", "value": "" }, { "name": "Digest", "value": "" }, { "name": "TPP-Redirect-URI", "value": "" } ], "params": [ { "name": "tenant", "value": "", "type": "path", "description": "Branch of the request." }, { "name": "resource-id", "value": "", "type": "path", "description": "ID of the payment to create cancellation authorisation sub-resource for." } ] }, "docs": "Creates a payment cancellation authorisation sub-resource." }, { "info": { "name": "Get cancellation authorisation status", "type": "http" }, "http": { "method": "GET", "url": "https://xs2a-sandbox.triodos.com/xs2a-bg/:tenant/v1/periodic-payments/sepa-credit-transfers/:resource-id/cancellation-authorisations/:authorisation-id", "headers": [ { "name": "X-Request-ID", "value": "" }, { "name": "Signature", "value": "" }, { "name": "Digest", "value": "" } ], "params": [ { "name": "tenant", "value": "", "type": "path", "description": "Branch of the request." }, { "name": "resource-id", "value": "", "type": "path", "description": "ID of the payment." }, { "name": "authorisation-id", "value": "", "type": "path", "description": "ID of the cancellation authorisation sub-resource." } ] }, "docs": "Checks the SCA status of a cancellation authorisation sub-resource." }, { "info": { "name": "Update payment cancellation authorisation with access token", "type": "http" }, "http": { "method": "PUT", "url": "https://xs2a-sandbox.triodos.com/xs2a-bg/:tenant/v1/periodic-payments/sepa-credit-transfers/:resource-id/cancellation-authorisations/:authorisation-id", "headers": [ { "name": "X-Request-ID", "value": "" }, { "name": "Signature", "value": "" }, { "name": "Digest", "value": "" } ], "params": [ { "name": "tenant", "value": "", "type": "path", "description": "Branch of the request." }, { "name": "resource-id", "value": "", "type": "path", "description": "ID of the payment to cancel" }, { "name": "authorisation-id", "value": "", "type": "path", "description": "ID of the cancellation authorisation sub-resource" } ] }, "docs": "Updates the payment cancellation data on the server by PSU data, if requested by the ASPSP. Also cancels the payment if sufficient privileges are present." }, { "info": { "name": "Cancel payment", "type": "http" }, "http": { "method": "DELETE", "url": "https://xs2a-sandbox.triodos.com/xs2a-bg/:tenant/v1/periodic-payments/sepa-credit-transfers/:resource-id", "headers": [ { "name": "X-Request-ID", "value": "" }, { "name": "TPP-Redirect-URI", "value": "" } ], "params": [ { "name": "tenant", "value": "", "type": "path", "description": "Branch of the request." }, { "name": "resource-id", "value": "", "type": "path", "description": "ID of the payment." } ] }, "docs": "If the payment is not authorized yet, the payment request is directly cancelled. Otherwise a cancellation authorization sub-resource is created." }, { "info": { "name": "Get payment status", "type": "http" }, "http": { "method": "GET", "url": "https://xs2a-sandbox.triodos.com/xs2a-bg/:tenant/v1/periodic-payments/sepa-credit-transfers/:resource-id/status", "headers": [ { "name": "X-Request-ID", "value": "" }, { "name": "Signature", "value": "" }, { "name": "Digest", "value": "" } ], "params": [ { "name": "tenant", "value": "", "type": "path", "description": "Branch of the request." }, { "name": "resource-id", "value": "", "type": "path", "description": "ID of the payment." } ] }, "docs": "Can check the status of a payment initiation." }, { "info": { "name": "Initiate Sepa Periodic Payment", "type": "http" }, "http": { "method": "POST", "url": "https://xs2a-sandbox.triodos.com/xs2a-bg/:tenant/v1/periodic-payments/sepa-credit-transfers", "headers": [ { "name": "X-Request-ID", "value": "" }, { "name": "Signature", "value": "" }, { "name": "Digest", "value": "" }, { "name": "PSU-IP-Address", "value": "" }, { "name": "TPP-Redirect-URI", "value": "" }, { "name": "Consent-ID", "value": "" }, { "name": "TPP-Signature-Certificate", "value": "" } ], "params": [ { "name": "tenant", "value": "", "type": "path", "description": "Branch of the request." } ] }, "docs": "Creates a Sepa periodic payment initiation request and corresponding authorisation sub-resource." }, { "info": { "name": "Get authorisations", "type": "http" }, "http": { "method": "GET", "url": "https://xs2a-sandbox.triodos.com/xs2a-bg/:tenant/v1/periodic-payments/uk-domestic-transfers/:resource-id/authorisations", "headers": [ { "name": "X-Request-ID", "value": "" }, { "name": "Signature", "value": "" }, { "name": "Digest", "value": "" } ], "params": [ { "name": "tenant", "value": "", "type": "path", "description": "Branch of the request." }, { "name": "resource-id", "value": "", "type": "path", "description": "ID of the payment." } ] }, "docs": "Will deliver an array of resource ids of all generated authorisation sub-resources." }, { "info": { "name": "Create authorisation", "type": "http" }, "http": { "method": "POST", "url": "https://xs2a-sandbox.triodos.com/xs2a-bg/:tenant/v1/periodic-payments/uk-domestic-transfers/:resource-id/authorisations", "headers": [ { "name": "X-Request-ID", "value": "" }, { "name": "Signature", "value": "" }, { "name": "Digest", "value": "" }, { "name": "TPP-Redirect-URI", "value": "" } ], "params": [ { "name": "tenant", "value": "", "type": "path", "description": "Branch of the request." }, { "name": "resource-id", "value": "", "type": "path", "description": "ID of the payment to create authorisation sub-resource for." } ] }, "docs": "Creates a payment authorisation sub-resource." }, { "info": { "name": "Get authorisation status", "type": "http" }, "http": { "method": "GET", "url": "https://xs2a-sandbox.triodos.com/xs2a-bg/:tenant/v1/periodic-payments/uk-domestic-transfers/:resource-id/authorisations/:authorisation-id", "headers": [ { "name": "X-Request-ID", "value": "" }, { "name": "Signature", "value": "" }, { "name": "Digest", "value": "" } ], "params": [ { "name": "tenant", "value": "", "type": "path", "description": "Branch of the request." }, { "name": "resource-id", "value": "", "type": "path", "description": "ID of the payment." }, { "name": "authorisation-id", "value": "", "type": "path", "description": "ID of the authorisation sub-resource." } ] }, "docs": "Checks the SCA status of an authorisation sub-resource." }, { "info": { "name": "Submit payment authorisation", "type": "http" }, "http": { "method": "PUT", "url": "https://xs2a-sandbox.triodos.com/xs2a-bg/:tenant/v1/periodic-payments/uk-domestic-transfers/:resource-id/authorisations/:authorisation-id", "headers": [ { "name": "X-Request-ID", "value": "" }, { "name": "Signature", "value": "" }, { "name": "Digest", "value": "" }, { "name": "Authorization", "value": "" } ], "params": [ { "name": "tenant", "value": "", "type": "path", "description": "Branch of the request." }, { "name": "resource-id", "value": "", "type": "path", "description": "ID of the payment" }, { "name": "authorisation-id", "value": "", "type": "path", "description": "ID of the authorisation sub-resource" } ] }, "docs": "Submits an access token to authorise a payment initiation." }, { "info": { "name": "Get cancellation authorisations", "type": "http" }, "http": { "method": "GET", "url": "https://xs2a-sandbox.triodos.com/xs2a-bg/:tenant/v1/periodic-payments/uk-domestic-transfers/:resource-id/cancellation-authorisations", "headers": [ { "name": "X-Request-ID", "value": "" }, { "name": "Signature", "value": "" }, { "name": "Digest", "value": "" } ], "params": [ { "name": "tenant", "value": "", "type": "path", "description": "Branch of the request." }, { "name": "resource-id", "value": "", "type": "path", "description": "ID of the payment to get cancellation authorisations for." } ] }, "docs": "Will deliver an array of resource ids of all generated cancellation authorisation sub-resources." }, { "info": { "name": "Create cancellation authorisation", "type": "http" }, "http": { "method": "POST", "url": "https://xs2a-sandbox.triodos.com/xs2a-bg/:tenant/v1/periodic-payments/uk-domestic-transfers/:resource-id/cancellation-authorisations", "headers": [ { "name": "X-Request-ID", "value": "" }, { "name": "Signature", "value": "" }, { "name": "Digest", "value": "" }, { "name": "TPP-Redirect-URI", "value": "" } ], "params": [ { "name": "tenant", "value": "", "type": "path", "description": "Branch of the request." }, { "name": "resource-id", "value": "", "type": "path", "description": "ID of the payment to create cancellation authorisation sub-resource for." } ] }, "docs": "Creates a payment cancellation authorisation sub-resource." }, { "info": { "name": "Get cancellation authorisation status", "type": "http" }, "http": { "method": "GET", "url": "https://xs2a-sandbox.triodos.com/xs2a-bg/:tenant/v1/periodic-payments/uk-domestic-transfers/:resource-id/cancellation-authorisations/:authorisation-id", "headers": [ { "name": "X-Request-ID", "value": "" }, { "name": "Signature", "value": "" }, { "name": "Digest", "value": "" } ], "params": [ { "name": "tenant", "value": "", "type": "path", "description": "Branch of the request." }, { "name": "resource-id", "value": "", "type": "path", "description": "ID of the payment." }, { "name": "authorisation-id", "value": "", "type": "path", "description": "ID of the cancellation authorisation sub-resource." } ] }, "docs": "Checks the SCA status of a cancellation authorisation sub-resource." }, { "info": { "name": "Update payment cancellation authorisation with access token", "type": "http" }, "http": { "method": "PUT", "url": "https://xs2a-sandbox.triodos.com/xs2a-bg/:tenant/v1/periodic-payments/uk-domestic-transfers/:resource-id/cancellation-authorisations/:authorisation-id", "headers": [ { "name": "X-Request-ID", "value": "" }, { "name": "Signature", "value": "" }, { "name": "Digest", "value": "" } ], "params": [ { "name": "tenant", "value": "", "type": "path", "description": "Branch of the request." }, { "name": "resource-id", "value": "", "type": "path", "description": "ID of the payment to cancel" }, { "name": "authorisation-id", "value": "", "type": "path", "description": "ID of the cancellation authorisation sub-resource" } ] }, "docs": "Updates the payment cancellation data on the server by PSU data, if requested by the ASPSP. Also cancels the payment if sufficient privileges are present." }, { "info": { "name": "Cancel payment", "type": "http" }, "http": { "method": "DELETE", "url": "https://xs2a-sandbox.triodos.com/xs2a-bg/:tenant/v1/periodic-payments/uk-domestic-transfers/:resource-id", "headers": [ { "name": "X-Request-ID", "value": "" }, { "name": "TPP-Redirect-URI", "value": "" } ], "params": [ { "name": "tenant", "value": "", "type": "path", "description": "Branch of the request." }, { "name": "resource-id", "value": "", "type": "path", "description": "ID of the payment." } ] }, "docs": "If the payment is not authorized yet, the payment request is directly cancelled. Otherwise a cancellation authorization sub-resource is created." }, { "info": { "name": "Get payment status", "type": "http" }, "http": { "method": "GET", "url": "https://xs2a-sandbox.triodos.com/xs2a-bg/:tenant/v1/periodic-payments/uk-domestic-transfers/:resource-id/status", "headers": [ { "name": "X-Request-ID", "value": "" }, { "name": "Signature", "value": "" }, { "name": "Digest", "value": "" } ], "params": [ { "name": "tenant", "value": "", "type": "path", "description": "Branch of the request." }, { "name": "resource-id", "value": "", "type": "path", "description": "ID of the payment." } ] }, "docs": "Can check the status of a payment initiation." }, { "info": { "name": "Initiate UK Domestic Periodic Payment", "type": "http" }, "http": { "method": "POST", "url": "https://xs2a-sandbox.triodos.com/xs2a-bg/:tenant/v1/periodic-payments/uk-domestic-transfers", "headers": [ { "name": "X-Request-ID", "value": "" }, { "name": "Signature", "value": "" }, { "name": "Digest", "value": "" }, { "name": "PSU-IP-Address", "value": "" }, { "name": "TPP-Redirect-URI", "value": "" }, { "name": "Consent-ID", "value": "" }, { "name": "TPP-Signature-Certificate", "value": "" } ], "params": [ { "name": "tenant", "value": "", "type": "path", "description": "Branch of the request." } ] }, "docs": "Creates a UK Domestic periodic payment initiation request and corresponding authorisation sub-resource." } ] }, { "info": { "name": "Confirmation of Funds Service", "type": "folder" }, "items": [ { "info": { "name": "Confirmation of funds", "type": "http" }, "http": { "method": "POST", "url": "https://xs2a-sandbox.triodos.com/xs2a-bg/:tenant/v1/funds-confirmations", "headers": [ { "name": "X-Request-ID", "value": "" }, { "name": "Signature", "value": "" }, { "name": "Digest", "value": "" }, { "name": "Consent-ID", "value": "" } ], "params": [ { "name": "tenant", "value": "", "type": "path", "description": "Branch of the request." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a confirmation of funds request at the ASPSP." }, { "info": { "name": "Get authorisations", "type": "http" }, "http": { "method": "GET", "url": "https://xs2a-sandbox.triodos.com/xs2a-bg/:tenant/v2/consents/confirmation-of-funds/:resource-id/authorisations", "headers": [ { "name": "X-Request-ID", "value": "" }, { "name": "Signature", "value": "" }, { "name": "Digest", "value": "" } ], "params": [ { "name": "tenant", "value": "", "type": "path", "description": "Branch of the request." }, { "name": "resource-id", "value": "", "type": "path", "description": "ID of the consent." } ] }, "docs": "Will deliver an array of resource ids of all generated authorisation sub-resources." }, { "info": { "name": "Create authorisation", "type": "http" }, "http": { "method": "POST", "url": "https://xs2a-sandbox.triodos.com/xs2a-bg/:tenant/v2/consents/confirmation-of-funds/:resource-id/authorisations", "headers": [ { "name": "X-Request-ID", "value": "" }, { "name": "Signature", "value": "" }, { "name": "Digest", "value": "" }, { "name": "TPP-Redirect-URI", "value": "" } ], "params": [ { "name": "tenant", "value": "", "type": "path", "description": "Branch of the request." }, { "name": "resource-id", "value": "", "type": "path", "description": "ID of the consent to create authorisation sub-resource for." } ] }, "docs": "Creates a consent authorisation sub-resource." }, { "info": { "name": "Get authorisation status", "type": "http" }, "http": { "method": "GET", "url": "https://xs2a-sandbox.triodos.com/xs2a-bg/:tenant/v2/consents/confirmation-of-funds/:resource-id/authorisations/:authorisation-id", "headers": [ { "name": "X-Request-ID", "value": "" }, { "name": "Signature", "value": "" }, { "name": "Digest", "value": "" } ], "params": [ { "name": "tenant", "value": "", "type": "path", "description": "Branch of the request." }, { "name": "resource-id", "value": "", "type": "path", "description": "ID of the consent." }, { "name": "authorisation-id", "value": "", "type": "path", "description": "ID of the authorisation sub-resource." } ] }, "docs": "Checks the SCA status of an authorisation sub-resource." }, { "info": { "name": "Update consent authorisation with access token", "type": "http" }, "http": { "method": "PUT", "url": "https://xs2a-sandbox.triodos.com/xs2a-bg/:tenant/v2/consents/confirmation-of-funds/:resource-id/authorisations/:authorisation-id", "headers": [ { "name": "X-Request-ID", "value": "" }, { "name": "Signature", "value": "" }, { "name": "Digest", "value": "" } ], "params": [ { "name": "tenant", "value": "", "type": "path", "description": "Branch of the request." }, { "name": "resource-id", "value": "", "type": "path", "description": "ID of the consent." }, { "name": "authorisation-id", "value": "", "type": "path", "description": "ID of the authorisation sub-resource" } ] }, "docs": "Updates the confirmation of funds consent authorisation with an access token. If the access token has sufficient privileges, the consent will be authorized" }, { "info": { "name": "Get consent", "type": "http" }, "http": { "method": "GET", "url": "https://xs2a-sandbox.triodos.com/xs2a-bg/:tenant/v2/consents/confirmation-of-funds/:resource-id", "headers": [ { "name": "X-Request-ID", "value": "" }, { "name": "Signature", "value": "" }, { "name": "Digest", "value": "" } ], "params": [ { "name": "tenant", "value": "", "type": "path", "description": "Branch of the request." }, { "name": "resource-id", "value": "", "type": "path", "description": "ID of the consent." } ] }, "docs": "Returns the content of a confirmation of funds consent object. This is returning the data for the TPP especially in cases, where the consent was directly managed between ASPSP and PSU e.g. in a re-direct SCA Approach." }, { "info": { "name": "Delete consent", "type": "http" }, "http": { "method": "DELETE", "url": "https://xs2a-sandbox.triodos.com/xs2a-bg/:tenant/v2/consents/confirmation-of-funds/:resource-id", "headers": [ { "name": "X-Request-ID", "value": "" }, { "name": "Signature", "value": "" }, { "name": "Digest", "value": "" } ], "params": [ { "name": "tenant", "value": "", "type": "path", "description": "Branch of the request." }, { "name": "resource-id", "value": "", "type": "path", "description": "ID of the consent." } ] }, "docs": "Deletes a given consent." }, { "info": { "name": "Get consent status", "type": "http" }, "http": { "method": "GET", "url": "https://xs2a-sandbox.triodos.com/xs2a-bg/:tenant/v2/consents/confirmation-of-funds/:resource-id/status", "headers": [ { "name": "X-Request-ID", "value": "" }, { "name": "Signature", "value": "" }, { "name": "Digest", "value": "" } ], "params": [ { "name": "tenant", "value": "", "type": "path", "description": "Branch of the request." }, { "name": "resource-id", "value": "", "type": "path", "description": "ID of the consent." } ] }, "docs": "Check the status of a confirmation of funds consent resource." }, { "info": { "name": "Register consent", "type": "http" }, "http": { "method": "POST", "url": "https://xs2a-sandbox.triodos.com/xs2a-bg/:tenant/v2/consents/confirmation-of-funds", "headers": [ { "name": "X-Request-ID", "value": "" }, { "name": "Signature", "value": "" }, { "name": "Digest", "value": "" }, { "name": "PSU-IP-Address", "value": "" }, { "name": "TPP-Redirect-URI", "value": "" }, { "name": "TPP-Signature-Certificate", "value": "" } ], "params": [ { "name": "tenant", "value": "", "type": "path", "description": "Branch of the request." } ] }, "docs": "Creates a confirmation of funds consent resource at the ASPSP regarding access to accounts specified in this request." } ] }, { "info": { "name": "Extended Account Information Service", "type": "folder" }, "items": [ { "info": { "name": "Read Savings Account Details", "type": "http" }, "http": { "method": "GET", "url": "https://xs2a-sandbox.triodos.com/xs2a-bg/:tenant/v2/savings/:account-id", "headers": [ { "name": "X-Request-ID", "value": "" }, { "name": "Signature", "value": "" }, { "name": "Digest", "value": "" }, { "name": "PSU-IP-Address", "value": "" }, { "name": "Consent-ID", "value": "" } ], "params": [ { "name": "tenant", "value": "", "type": "path", "description": "Branch of the request." }, { "name": "account-id", "value": "", "type": "path", "description": "ID of account." }, { "name": "withBalance", "value": "", "type": "query", "description": "Not supported, should be unset" } ] }, "docs": " Reads details about a savings account, with balances where required.\n It is assumed that a consent of the PSU to this access is already given and stored on the ASPSP system.\n The addressed details of this account depends then on the stored consent addressed by consentId, respectively the OAuth2 access token.\n" }, { "info": { "name": "Get accounts", "type": "http" }, "http": { "method": "GET", "url": "https://xs2a-sandbox.triodos.com/xs2a-bg/:tenant/v2/savings", "headers": [ { "name": "X-Request-ID", "value": "" }, { "name": "Signature", "value": "" }, { "name": "Digest", "value": "" }, { "name": "PSU-IP-Address", "value": "" }, { "name": "Consent-ID", "value": "" } ], "params": [ { "name": "tenant", "value": "", "type": "path", "description": "Branch of the request." }, { "name": "withBalance", "value": "", "type": "query", "description": "Not supported, should be unset" } ] }, "docs": "Reads a list of savings accounts, with balances where required. It is assumed that a consent of the PSU to this access is already given and stored on the ASPSP system. The addressed list of accounts depends then on the PSU ID and the stored consent addressed by consentId, respectively the OAuth2 access token." }, { "info": { "name": "Get savings account balances", "type": "http" }, "http": { "method": "GET", "url": "https://xs2a-sandbox.triodos.com/xs2a-bg/:tenant/v2/savings/:account-id/balances", "headers": [ { "name": "X-Request-ID", "value": "" }, { "name": "Signature", "value": "" }, { "name": "Digest", "value": "" }, { "name": "PSU-IP-Address", "value": "" }, { "name": "Consent-ID", "value": "" } ], "params": [ { "name": "tenant", "value": "", "type": "path", "description": "Branch of the request." }, { "name": "account-id", "value": "", "type": "path", "description": "ID of account." } ] }, "docs": "Reads savings account data from a given savings account addressed by \"account-id\"." }, { "info": { "name": "Get savings account transactions", "type": "http" }, "http": { "method": "GET", "url": "https://xs2a-sandbox.triodos.com/xs2a-bg/:tenant/v2/savings/:account-id/transactions", "headers": [ { "name": "X-Request-ID", "value": "" }, { "name": "Signature", "value": "" }, { "name": "Digest", "value": "" }, { "name": "PSU-IP-Address", "value": "" }, { "name": "Consent-ID", "value": "" } ], "params": [ { "name": "tenant", "value": "", "type": "path", "description": "Branch of the request." }, { "name": "account-id", "value": "", "type": "path", "description": "ID of account." }, { "name": "bookingStatus", "value": "", "type": "query", "description": "Permitted codes are \"booked\", \"pending\" and \"both\", mandated if no delta access is required." }, { "name": "dateFrom", "value": "", "type": "query", "description": "Starting date (inclusive the date dateFrom) of the transaction list, mandated if no delta access is required." }, { "name": "dateTo", "value": "", "type": "query", "description": "End date (inclusive the date dateTo) of the transaction list, default is now if not given." }, { "name": "withBalance", "value": "", "type": "query", "description": "Not supported, should be unset" }, { "name": "entryReferenceFrom", "value": "", "type": "query", "description": "Not supported, should be unset" }, { "name": "deltaList", "value": "", "type": "query", "description": "Not supported, should be unset" }, { "name": "edgeToken", "value": "", "type": "query", "description": "Pagination edge token, to be used when paging through transactions" } ] }, "docs": "Reads savings account data from a given saving account addressed by \"account-id\"." } ] } ], "bundled": true }