OPopenbankinguk
Funds Confirmation Consents

Get a Funds Confirmation Consent

Changed on

Enables a CBPII to retrieve the status of a Funds Confirmation Consent resource.

On success (HTTP 200), the response contains the consent ConsentId, CreationDateTime, current Status, StatusUpdateDateTime, optional StatusReason, optional ExpirationDateTime, and the DebtorAccount associated with the consent.

Note: This operation is read-only. It does not change the consent status, authorise the consent, revoke the consent, or perform a funds availability check.

get/funds-confirmation-consents/{ConsentId}

Request

  • Base URL
    /open-banking/v4.0/cbpii (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /open-banking/v4.0/cbpii/funds-confirmation-consents/{ConsentId}
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://authserver.example/token scopes: fundsconfirmations

Path parameters

ConsentIdstring required
Example:FCC-20260401-0001

ConsentId

Headers

x-fapi-auth-datestring
Example:Wed, 01 Apr 2026 10:15:30 GMT

The time when the PSU last logged in with the TPP.

All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:

Sun, 10 Sep 2017 19:43:31 UTC

x-fapi-customer-ip-addressstring
Example:203.0.113.42

The PSU's IP address if the PSU is currently logged in with the TPP.

x-fapi-interaction-idstring
Example:93bac548-d2de-4546-b106-880a5018460d

An RFC4122 UID used as a correlation id.

Authorizationstring required
Example:Bearer <access-token>

An Authorisation Token as per https://datatracker.ietf.org/doc/html/rfc6750

x-customer-user-agentstring
Example:Mozilla/5.0 (Example PSU Device)

Indicates the user-agent that the PSU is using.

x-jws-signaturestring
Example:eyJhbGciOiJQUzI1NiIsInR5cCI6IkpPU0UiLCJraWQiOiJUYTRPbGp6d1dpWFNWV0V6NmYwT2lBUzJqMEkiLCJjdHkiOiJhcHBsaWNhdGlvbi9qc29uIiwiaHR0cDovL29wZW5iYW5raW5nLm9yZy51ay9pYXQiOjE3ODk3MjcwMDEsImh0dHA6Ly9vcGVuYmFua2luZy5vcmcudWsvaXNzIjoiMDAxNTgwMDAwMTA0MVJIQUFZIiwiaHR0cDovL29wZW5iYW5raW5nLm9yZy51ay90YW4iOiJvcGVuYmFua2luZy5vcmcudWsiLCJjcml0IjpbImh0dHA6Ly9vcGVuYmFua2luZy5vcmcudWsvaWF0IiwiaHR0cDovL29wZW5iYW5raW5nLm9yZy51ay9pc3MiLCJodHRwOi8vb3BlbmJhbmtpbmcub3JnLnVrL3RhbiJdfQ..2L_TlbsBGKWVZ4g9EDDJP5TDe5spMxToBrZf9WxnLzgYZXwXWmD0bc3__5MnZE4t4gt_azsn0wDMuVgnCxfpKTCIehtLkXrgtD9XCP0UM37pwoEODqBnPVNnENwU2_dSvHmvjOHi0zVbNLK_bHY-fo2enDjKfVk0DWyPuKX8zgsEvQrouPtB2yP4zbCl89YrY2TriKSkem6YlQd3KkSK6vtWKVJU_Ec11W2KVd6V_TA6goVZZkTx5uLVD_ygfsHMPHKD7t4u_2IleXOtgRoXxOZ0kFF0Ghsk9IbGJbcLYg7LudsIGMBFt-577sNJNJmPSXv4W5AC6Avmn2te-AInjw

A detached JWS signature of the body of the payload.

x-client-idstring
Example:cbpii-client-12345

Only used if an ASPSP requires the client ID in order to return rate limit headers.

TPPs must refer to ASPSP developer portals for further information on any rate limit policies, if the headers are supported and any additional requirements.

This header must not be used for client authentication

Response

Funds Confirmation Consent Read

Example response

{
  "Data": {
    "ConsentId": "FCC-20260401-0001",
    "CreationDateTime": "2026-04-01T10:15:30+00:00",
    "Status": "AUTH",
    "StatusReason": [
      {
        "StatusReasonCode": "U009",
        "StatusReasonDescription": "The consent is not in a status that allows funds confirmation.",
        "Path": "Data.ConsentId"
      }
    ],
    "StatusUpdateDateTime": "2026-04-01T10:20:30+00:00",
    "ExpirationDateTime": "2026-10-01T10:15:30+00:00",
    "DebtorAccount": {
      "SchemeName": "UK.OBIE.SortCodeAccountNumber",
      "Identification": "30949301273801",
      "Name": "Jane Smith",
      "SecondaryIdentification": "Roll 56988",
      "Proxy": {
        "Identification": "+441632960540",
        "Code": "TELE",
        "Type": "Telephone"
      }
    }
  }
}

Changes

  • 2acd18792686Revision changes
    • info

      added the new optional header request parameter x-jws-signature

  • ee60c3b2d7f5Revision changes
    • warning

      the optional response header x-jws-signature removed for the status 200

    • warning

      the optional response header x-jws-signature removed for the status 400

    • warning

      the optional response header x-jws-signature removed for the status 401

    • warning

      the optional response header x-jws-signature removed for the status 403

    • warning

      the optional response header x-jws-signature removed for the status 405

    • warning

      the optional response header x-jws-signature removed for the status 406

    • warning

      the optional response header x-jws-signature removed for the status 429

    • warning

      the optional response header x-jws-signature removed for the status 500

    • warning

      deleted the header request parameter x-jws-signature