Create a Bank Account Access Consent

POST https://secure.mintpayments.com/mpay/v5/open-banking/bank-account-access-consent

Initiate a Bank Account Access Consent for a business unit.

About Bank Account Access Consents

Bank Account Access Consents enable secure access to bank account information through regulated banking APIs. This endpoint initiates the process for customers to authorize access to their bank account data:

• Regulatory Compliance: Bank Account Access Consents comply with banking regulations (e.g., PSD2 in Europe, Open Banking in UK)
• Customer Authorization: Customers must explicitly authorize access through their bank's secure interface
• Secure Access: Once authorized, enables secure retrieval of account information and transaction data

Consent Process Flow

1. Create Bank Account Access Consent: This endpoint creates a pending Bank Account Access Consent with optional return URI
2. Customer Authorization: Customer uses the provided authorization URL to grant access via their bank
3. Consent Activation: Once authorized, the consent becomes active and can be used to access account data
4. Authorization Completion: After authorization, customer is redirected to the specified return URI (if provided)
5. Data Access: Authorized consents enable access to bank account transactions and information

Return URI Handling

The optional return_uri parameter allows you to specify where the customer should be redirected after completing the bank authorization process:

• Success Flow: Customer completes authorization → Redirected to return_uri with success parameters
• Error Flow: Authorization fails → Redirected to return_uri with error parameters
• No Return URI: If not provided, customer remains on Mint's completion page
• Security: Return URI should use HTTPS for production applications, however response is informational only, merchant servers should check status via API

Example Return URI with Parameters:

• Success: https://myapp.com/account/connected?status=success&consent=BAAC.7n42DGM5Tflk9n8mt7Fhc7
• Error: https://myapp.com/account/connected?status=error&error=access_denied

Note: This endpoint only initiates the consent - no bank account details are required at this stage. The customer will provide their bank account information during the authorization process.
If bank accounts are already known to the Mint System the consents will be attached to the existing Bank Accounts. If new Bank Accounts are identified in the account information, new Bank Account records will be created and associated to the provided Business Unit.