---
title: "Retrieve all file payment consents created by an API client"
method: GET
path: "/pay-file-consent"
tags: ["pay-file"]
---

# Retrieve all file payment consents created by an API client

`GET /pay-file-consent`

Requires **pay_file_consent:read** scope.

## Query parameters

- `limit` integer
- `offset` integer
- `userId` string

## Response `200`

Successful File Payment Consent Response

- object
  - `data` PayFileConsent
    - `id` string, uuid, required — The id of the pay file consent
    - `status` 'Authorised' | 'AwaitingAuthorisation' | 'AwaitingUpload' | 'Rejected' | 'Consumed'
    - `createdAt` string, date-time, required — The date that the pay file consent was created
    - `payFileConsents` object, required
      - `fileReference` string — The name or description given to the recurring payment
      - `numberOfTransactions` integer — The number of transactions within the file
      - `controlSum` string — The total amount of the transactions within the file
  - `meta` Meta
    - `limit` integer
    - `offset` integer
    - `total` integer

## Other responses

- `401` — Unsuccessful Response - Not authorised - Missing authorization header - Invalid access Token
- `403` — Unsuccessful Response - Forbidden - Invalid scopes

---

[API](https://skmtc.net/moneyhubenterprise/apis/moneyhub-identity-service.md) · [All operations](https://skmtc.net/moneyhubenterprise/apis/moneyhub-identity-service/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/moneyhubenterprise/moneyhub-identity-service/revisions/8841721f7aae/schema)