start_payment_consent
Initiates an Open Finance Brasil PIX payment consent by creating the consent and returning a bank authorization URL for user approval.
Instructions
Starts the Open Finance Brasil Payments API consent flow for one specific PIX payment.
Creates a payment consent describing exactly this payment, then
builds a FAPI-BR compliant (PAR + JAR) authorization URL. The user
must open this URL, log in, and authorize this specific payment at
the bank. Once redirected back, call complete_payment_consent
with the resulting URL, then initiate_pix to actually create
the payment.
Args: subject_id: Payer's CPF (digits only) or internal ID. bank: Identifier of the participating bank. amount: Payment amount in BRL (e.g. '150.00'). creditor_key: PIX key of the recipient. creditor_key_type: Type of the recipient's key. debtor_account_id: ID of the account to debit. ctx: MCP request context, providing access to shared dependencies. description: Payment description/reason (max 140 chars). request_url_elicitation: Ask a compatible MCP client to open the bank authorization URL using URL-mode elicitation. The URL is still returned for clients that use the manual flow.
Returns: The payment consent ID and the URL the user must open to authorize it.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| bank | Yes | ||
| amount | Yes | BRL amount serialized with exactly two decimal places. | |
| subject_id | Yes | ||
| description | No | ||
| creditor_key | Yes | ||
| creditor_key_type | Yes | ||
| debtor_account_id | Yes | ||
| request_url_elicitation | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| bank | Yes | ||
| consent_id | Yes | ||
| authorization_url | Yes | ||
| expires_in_minutes | Yes |