---
updatedAt: 2026-07-22T09:35:36.000Z
agentTools:
  projectIndex: https://docs.moneyhubenterprise.com/llms.txt
---

# Retrieve a single payment file consent

Requires **pay_file_consent:read** scope.

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "description": "Swagger 2.0 docs for the authentication/authorization Moneyhub API",
    "title": "Moneyhub Identity Service",
    "version": "2.0.0"
  },
  "security": [
    {
      "Bearer": []
    }
  ],
  "paths": {
    "/pay-file-consent/{id}": {
      "get": {
        "summary": "Retrieve a single payment file consent",
        "description": "Requires **pay_file_consent:read** scope.",
        "parameters": [
          {
            "description": "The id of a specific pay file consent",
            "in": "path",
            "name": "id",
            "required": true,
            "example": "0b4e6488-6de0-420c-8f56-fee665707d57",
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful Pay File Consent response",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "data": {
                      "$ref": "#/components/schemas/PayFileConsent"
                    },
                    "meta": {
                      "type": "object"
                    }
                  },
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Unsuccessful Response - Not authorised - Missing authorization header - Invalid access Token",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "403": {
            "description": "Unsuccessful Response - Forbidden - Invalid scopes",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "404": {
            "description": "Unsuccessful Response - Resource Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "tags": [
          "pay-file"
        ]
      }
    }
  },
  "servers": [
    {
      "url": "https://identity.moneyhub.co.uk"
    }
  ],
  "components": {
    "securitySchemes": {
      "Bearer": {
        "type": "apiKey",
        "name": "Authorization",
        "in": "header"
      }
    },
    "schemas": {
      "PayFileConsent": {
        "additionalProperties": false,
        "type": "object",
        "properties": {
          "id": {
            "description": "The id of the pay file consent",
            "example": "c390a94f-2309-4cdf-8d02-b0c5304d9f66",
            "type": "string",
            "format": "uuid"
          },
          "status": {
            "enum": [
              "Authorised",
              "AwaitingAuthorisation",
              "AwaitingUpload",
              "Rejected",
              "Consumed"
            ],
            "type": "string"
          },
          "createdAt": {
            "description": "The date that the pay file consent was created",
            "example": "2020-07-10T12:00:00+00:00",
            "format": "date-time",
            "type": "string"
          },
          "payFileConsents": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "fileReference": {
                "description": "The name or description given to the recurring payment",
                "type": "string"
              },
              "numberOfTransactions": {
                "description": "The number of transactions within the file",
                "type": "integer"
              },
              "controlSum": {
                "description": "The total amount of the transactions within the file",
                "type": "string"
              }
            }
          }
        },
        "required": [
          "id",
          "createdAt",
          "payFileConsents"
        ]
      },
      "Error": {
        "additionalProperties": false,
        "properties": {
          "code": {
            "description": "The error code",
            "type": "string"
          },
          "message": {
            "description": "The error message",
            "type": "string"
          },
          "correlationId": {
            "description": "Id that identifies the request and can be used to ask for more details related to the error",
            "type": "string"
          }
        },
        "required": [
          "code"
        ],
        "type": "object"
      }
    }
  }
}
```