Get a Bank Account Access Consent by ID

GET https://secure.mintpayments.com/mpay/v5/open-banking/bank-account-access-consent/{bank_account_access_consent}

Retrieve a specific Bank Account Access Consent by its consent ID.

About Bank Account Access Consent Retrieval

This endpoint allows you to check the current status and details of a Bank Account Access Consent:

• Status Monitoring: Check if the consent is pending, authorized, expired, revoked, or failed
• Authorization Details: Get the authorization URL if still pending
• Timestamps: View creation and authorization timestamps
• Return URI: See the configured return URI for the consent
• Linked Bank Accounts: View associated bank accounts for authorized/revoked/expired consents

Linked Bank Accounts

The linked_bank_accounts field contains the full bank accounts that were connected through this consent:

• pending/failed consents: linked_bank_accounts will be empty (no accounts linked yet)
• authorized consents: Contains the full bank accounts the customer authorized access to
• revoked consents: Shows the full accounts that were previously accessible before revocation
• expired consents: Shows the full accounts that were previously authorized but have reached end of life

Note: Bank Account Access Consents can only be created against full bank accounts (not placeholder accounts). Each linked bank account includes complete account details with full IBAN or routing/account number information.

Consent Status Information

• pending: Consent created, customer can still authorize using the authorization URL
• authorized: Customer has successfully authorized access to their bank account
• expired: Previously authorized consent has reached its end of life (natural expiration)
• revoked: Consent has been revoked by customer or system
• failed: Authorization process failed

Consent Lifecycle

The typical Bank Account Access Consent lifecycle follows this pattern:

1. pending → authorized: Customer completes authorization successfully
2. authorized → expired: Consent reaches its natural end of life (e.g., 90 days)
3. authorized → revoked: Customer or system revokes access
4. pending → failed: Authorization process fails or is rejected

Note: Only consents that were previously authorized can become expired. Consents that never received authorization will transition to failed instead.