--- api: 'Open Banking API' --- # Retrieve a file payment consent Get the details of a file payment consent. See also [Tutorials: Create a file payment](/docs/guides/build-banking-apps/tutorials/create-a-file-payment). ## Endpoint GET `/file-payment-consents/{ConsentId}` ## Parameters ### header parameters - `x-fapi-financial-id` (string, required) The unique ID of the [ASPSP](/docs/guides/build-banking-apps/glossary) that the request is issued to. The ID of Revolut is `001580000103UAvAAM`. - `x-fapi-customer-last-logged-time` (string, optional) The date and time when the [PSU](/docs/guides/build-banking-apps/glossary) last logged in with the [TPP](/docs/guides/build-banking-apps/glossary). All dates in the HTTP headers are represented as [RFC 7231](https://datatracker.ietf.org/doc/html/rfc7231#section-7.1.1.1) Full Dates. For example: `Sun, 10 Sep 2017 19:43:31 UTC`. - `x-fapi-customer-ip-address` (string, optional) The IP address of the [PSU](/docs/guides/build-banking-apps/glossary) if the PSU is logged in with the [TPP](/docs/guides/build-banking-apps/glossary). - `x-fapi-interaction-id` (string, optional) An [RFC4122](https://datatracker.ietf.org/doc/html/rfc4122) UUID used as a correlation ID. - `Authorization` (string, required) The access token that you've generated. For more information, see [Generate an access token](/docs/guides/build-banking-apps/get-started/get-access-token). - `x-customer-user-agent` (string, optional) The user agent that the [PSU](/docs/guides/build-banking-apps/glossary) is using. ### path parameters - `ConsentId` (string, required) The ID of the account access consent. ## Returns ### 200 File Payment Consents Read #### Response attributes - `Data` (object) - `Data.ConsentId` (string) The unique ID that the [ASPSP](/docs/guides/build-banking-apps/glossary) assigns to identify the consent resource. - `Data.CreationDateTime` (string) The date and time when the resource was created. All dates in the JSON payloads are represented in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time format. All date-time fields in responses must include the timezone. For example: `2017-04-05T10:43:07+00:00`. - `Data.Status` (enum) The status of the consent. Possible enum values: - `Authorised` - `AwaitingAuthorisation` - `AwaitingUpload` - `Consumed` - `Rejected` - `Data.StatusUpdateDateTime` (string) The date and time when the consent resource status was updated. All dates in the JSON payloads are represented in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time format. All date-time fields in responses must include the timezone. For example: `2017-04-05T10:43:07+00:00`. - `Data.Initiation` (object) The initiation payload that the initiating party sends to the [ASPSP](/docs/guides/build-banking-apps/glossary), which is used to request movement of funds using a payment file. - `Data.Initiation.FileType` (string) The payment file type. - `Data.Initiation.FileHash` (string) A base64 encoding of a SHA256 hash of the file to be uploaded. - `Data.Initiation.FileReference` (string, optional) Reference for the file. - `Data.Initiation.RequestedExecutionDateTime` (string, optional) The date and time when the initiating party requests the clearing agent to process the payment. This is the date the debtor's account is to be debited. All dates in the JSON payloads are represented in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time format. All date-time fields in responses must include the timezone. For example: `2017-04-05T10:43:07+00:00`. - `Data.Initiation.LocalInstrument` (string, optional) User community specific instrument. Use this element to specify a local instrument, local clearing option and/or further qualify the service or service level. - `Data.Initiation.RemittanceInformation` (object, optional) The information used for matching an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system. - `Data.Initiation.RemittanceInformation.Unstructured` (string, optional) The information used for matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form. - `Data.Initiation.RemittanceInformation.Reference` (string, optional) The unique reference that the creditor assigns to unambiguously identify the payment transaction. If available, the initiating party should provide this reference in the structured remittance information to enable reconciliation by the creditor upon receipt of the amount of money. If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification. :::note Faster Payments Scheme can accept only 18 characters for the `Reference` field. ::: :::warning Only one reference should be provided, if both `Reference` and `Unstructured` parameters are provided, then the `Unstructured` parameter will be ignored. ::: - `Data.Initiation.DebtorAccount` (object, optional) The details to identify the account from which the payment consent can be approved. If provided in the consent, the [PSU](/docs/guides/build-banking-apps/glossary) will only be able to approve the payment consent from an account which matches the provided account identifier. - `Data.Initiation.DebtorAccount.SchemeName` (enum) The name of the identification scheme. Possible enum values: - `UK.OBIE.IBAN` - `UK.OBIE.SortCodeAccountNumber` - `US.RoutingNumberAccountNumber` - `US.BranchCodeAccountNumber` - `Data.Initiation.DebtorAccount.Identification` (string) The identifier assigned to the account, which is known by the account owner. - `Data.Initiation.DebtorAccount.Name` (string, optional) The name or names of the account owner(s) represented at an account level. The account name is not the product name or the nickname of the account. :::warning The name value is not validated against the actual owner name of the account. ::: - `Data.Initiation.DebtorAccount.SecondaryIdentification` (string, optional) The secondary account ID that the account servicing institution assigns. Building societies can use this ID to identify accounts with a roll number in addition to a sort code and account number combination. - `Links` (object) Links relevant to the payload. - `Links.Self` (string) The absolute URI to the resource. - `Links.Next` (string, optional) The absolute URI to the next pagination resource. - `Links.Prev` (string, optional) The absolute URI to the previous pagination resource. - `Meta` (object) Meta data relevant to the payload. - `Meta.TotalPages` (integer, optional) Used for pagination. Indicates how many pages of results are available. ## Error responses | HTTP status code | Description | | --- | --- | | 400 | Bad request | | 401 | Unauthorized | | 403 | Forbidden | | 405 | Method Not Allowed | | 406 | Not Acceptable | | 429 | Too Many Requests | | 500 | Internal Server Error |