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

Required

PaymentInitiationConsentGetRequest defines the request schema for /payment_initiation/consent/get

Parameters

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
required, string
The consent_id returned from /payment_initiation/consent/create.

Response

PaymentInitiationConsentGetResponse defines the response schema for /payment_initation/consent/get

Response Properties

consent_id
required, string
The consent ID.
status
required, string
The status of the payment consent. UNAUTHORISED: Consent created, but requires user authorisation. REJECTED: Consent authorisation was rejected by the user and/or 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
required, string
Consent creation timestamp, in ISO 8601 format.
recipient_id
required, string
The ID of the recipient the payment consent is for.
reference
required, string
A reference for the payment consent.
constraints
required, object
Limitations that will be applied to payments initiated using the payment consent.
valid_date_time
object
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
The date and time from which the consent should be active, in ISO 8601 format.
to
string
The date and time at which the consent expires, in ISO 8601 format.
max_payment_amount
required, object
Maximum amount of a single payment initiated using the payment consent.
periodic_amounts
required, array[object]
A list of amount limitations per period of time.
amount
required, object
Maximum cumulative amount for all payments in the specified interval.
interval
required, string
Payment consent periodic interval.
alignment
required, string
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
array[string]
Deprecated, use the ‘type’ field instead.
type
string
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
object
Details about external payment refund
name
required, string
The name of the account holder.
iban
required, string
The International Bank Account Number (IBAN) for the account.
bacs
required, object
An object containing a BACS account number and sort code. If an IBAN is not provided or if this recipient needs to accept domestic GBP-denominated payments, BACS data is required.
request_id
string
A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.