Release candidate

v2.2-rc2 is not ratified and MUST NOT be used for production. Current: v2.1. Changelog

This is v2.2-rc2 — a release candidate for the v2.2 standards, published for review and not yet ratified. It MUST NOT be used as the basis for a production implementation. For the current standards, switch to v2.1 using the version selector. See the v2.1 → v2.2-rc2 changelog for every change in this version.

Validate · Enforce · Trust

Payment Refunds — Requirements v2.2-rc22 min read

The tables below list the validation rules that apply to the Payment Refunds API. The Validated by column indicates where each rule is enforced.

All requests require an active Trust Framework application with the BSIP role, a valid transport certificate presented on every request via mTLS, and an active signing key for JWT signing.

01 Endpoint

Retrieve Refund Account

GET/payment-consents/{ConsentId}/refund
#
Field
Rule
Validated by
1
Authorization
Must contain a valid Bearer access token obtained via a client_credentials grant with the payments scope.
API Hub
2
ConsentId (path)
The consent record linked to the ConsentId must include the ReadRefundAccount permission.
API Hub
3
Account state
An account that is not Active is not reported as an error. The refund account is returned whatever its status, and Data.AccountStatus carries that status — as Status does on GET /accounts. A 403 is no longer returned because the debtor account is blocked from receiving payments; the account's state is conveyed by Data.AccountStatus instead.
LFI
4
Data.AccountStatus in response
Always present on a refund response, alongside RefundAccount. Carries the status of the refund account at the LFI, using the statuses that apply to current and savings accounts: Active, Inactive, Dormant, Unclaimed, Deceased, Suspended or Closed, with the same meanings as Status on the account resource. The value is supplied by the LFI.
API Hub
5
x-fapi-interaction-id
Should be included. Should be a valid UUID (RFC 4122). An invalid value will not cause a failure but tracing will not be possible.
N/A