---
title: "Get payment consent"
method: POST
path: "/payment_initiation/consent/get"
tags: ["plaid"]
---

# Get payment consent

`POST /payment_initiation/consent/get`

The `/payment_initiation/consent/get` endpoint can be used to check the status of a payment consent, as well as to receive basic information such as recipient and constraints.

## Request body

- PaymentInitiationConsentGetRequest — PaymentInitiationConsentGetRequest defines the request schema for `/payment_initiation/consent/get`
  - `client_id` string — Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
  - `secret` string — Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.
  - `consent_id` string, required — The `consent_id` returned from `/payment_initiation/consent/create`.

## Response `200`

OK

- PaymentInitiationConsentGetResponse — PaymentInitiationConsent defines a payment initiation consent.
  - `consent_id` string, required — The consent ID.
  - `status` 'UNAUTHORISED' | 'AUTHORISED' | 'REVOKED' | 'REJECTED' | 'EXPIRED', required — The status of the payment consent. `UNAUTHORISED`: Consent created, but requires user authorisation. `REJECTED`: Consent authorisation was rejected by the bank. `AUTHORISED`: Consent is active and ready to be used. `REVOKED`: Consent has been revoked and can no longer be used. `EXPIRED`: Consent is no longer valid.
  - `created_at` string, date-time, required — Consent creation timestamp, in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format.
  - `recipient_id` string, required — The ID of the recipient the payment consent is for.
  - `reference` string, required — A reference for the payment consent.
  - `constraints` PaymentInitiationConsentConstraints, required — Limitations that will be applied to payments initiated using the payment consent.
    - `valid_date_time` PaymentConsentValidDateTime, nullable — Life span for the payment consent. After the `to` date the payment consent expires and can no longer be used for payment initiation.
      - `from` string, date-time, nullable — The date and time from which the consent should be active, in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format.
      - `to` string, date-time, nullable — The date and time at which the consent expires, in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format.
    - `max_payment_amount` PaymentConsentMaxPaymentAmount, required — The amount and currency of a payment
      - `currency` 'GBP' | 'EUR' | 'PLN' | 'SEK' | 'DKK' | 'NOK', required — The ISO-4217 currency code of the payment. For standing orders and payment consents, `"GBP"` must be used. For Poland, Denmark, Sweden and Norway, only the local currency is currently supported.
      - `value` number, double, required — The amount of the payment. Must contain at most two digits of precision e.g. `1.23`. Minimum accepted value is `1`.
    - `periodic_amounts` PaymentConsentPeriodicAmount[], required — A list of amount limitations per period of time.
      - `amount` PaymentConsentPeriodicAmountAmount, required — The amount and currency of a payment
        - `currency` 'GBP' | 'EUR' | 'PLN' | 'SEK' | 'DKK' | 'NOK', required — The ISO-4217 currency code of the payment. For standing orders and payment consents, `"GBP"` must be used. For Poland, Denmark, Sweden and Norway, only the local currency is currently supported.
        - `value` number, double, required — The amount of the payment. Must contain at most two digits of precision e.g. `1.23`. Minimum accepted value is `1`.
      - `interval` 'DAY' | 'WEEK' | 'MONTH' | 'YEAR', required — Payment consent periodic interval.
      - `alignment` 'CALENDAR' | 'CONSENT', required — Where the payment consent period should start. If the institution is Monzo, only `CONSENT` alignments are supported. `CALENDAR`: line up with a calendar. `CONSENT`: on the date of consent creation.
  - `scopes` PaymentInitiationConsentScope[] — Deprecated, use the 'type' field instead.
  - `type` 'SWEEPING' | 'COMMERCIAL' — Payment consent type. Defines possible use case for payments made with the given consent. `SWEEPING`: Allows moving money between accounts owned by the same user. `COMMERCIAL`: Allows initiating payments from the user's account to third parties.
  - `payer_details` ExternalPaymentRefundDetails, nullable — Details about external payment refund
    - `name` string, required — The name of the account holder.
    - `iban` string, nullable, required — The International Bank Account Number (IBAN) for the account.
    - `bacs` RecipientBACSNullable, nullable, required — The account number and sort code of the recipient's account.
      - `account` string — The account number of the account. Maximum of 10 characters.
      - `sort_code` string — The 6-character sort code of the account.
  - `request_id` string, required — A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.

## Other responses

- `default` — Error response

---

[API](https://skmtc.net/plaid/apis/the-plaid-api.md) · [All operations](https://skmtc.net/plaid/apis/the-plaid-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/plaid/the-plaid-api/versions/64c4514ea59b/schema)