--- title: "Execute PIX payment" method: POST path: "/open-keys/itp/api/v2/payments/v4/payment-initiation/{id}/pix" tags: ["Payment Initiation"] --- # Execute PIX payment `POST /open-keys/itp/api/v2/payments/v4/payment-initiation/{id}/pix` ## Request - Base URL: `https://sandbox.openfinance.celcoin.dev` - URL: `https://sandbox.openfinance.celcoin.dev/open-keys/itp/api/v2/payments/v4/payment-initiation/{id}/pix` - Auth: OAuth 2 - Client credentials - Token URL: `http://localhost:8080/auth/realms/master/protocol/openid-connect/token` scopes: `app` Executes a PIX instant payment for a previously created payment initiation. Supports different local instruments including DICT (PIX key), QRDN and QRES (QR codes). Requires FIDO authentication flow for transaction authorization according to Open Finance Brasil regulations. ## Path parameters - `id` string, required ## Request body - ExecutePIXPaymentRequest - `data` PIXPaymentData[]: List of PIX payment data for processing - `endToEndId` string, required: Must be filled in the standard format ExxxxxxxxyyyyMMddHHmmkkkkkkkkkkk (32 characters; case sensitive, distinguishing upper and lower case letters) - `localInstrument` 'MANU' | 'DICT' | 'QRDN' | 'QRES' | 'INIC', required: Specifies the payment initiation method: - MANU - Manual insertion of transactional account data - DICT - Manual insertion of PIX key - QRDN - Dynamic QR code - QRES - Static QR code - INIC - Indicates that the receiver (creditor) hired the Payment Initiator specifically to perform payment initiations where the beneficiary is previously known. - `payment` PIXPaymentDataPayment, required - `currency` string, required: National currency code according to ISO-4217 model, i.e., 'BRL'. All monetary values reported are represented with Brazil's current currency. - `amount` string, required: Transaction value with 2 decimal places. The value must be the same as sent in the consent. For static QR Code with predetermined value in the QR Code or for dynamic QR Code with indication that the value cannot be changed: The amount field must be filled with the value established in the QR Code. If filled with a value different from the QR Code, an HTTP Status 422 error must be returned. - `creditorAccount` PIXPaymentDataCreditorAccount, required - `accountType` 'CACC' | 'TRAN' | 'SVGS', required: Account types used for payments. Traditional modalities provided by Resolution 4.753, not including linked accounts, foreign domiciled accounts, foreign currency accounts and electronic currency correspondent accounts. CACC - Current Account, SVGS - Savings Account, TRAN - Prepaid Payment Account. - `ispb` string, required: Must be filled with the ISPB (Brazilian Payment System Identifier) of the SPI (Instant Payment System) participant, numbers only. - `issuer` string: Bank branch code without digit. Branch is the facility intended for customer service, general public and credit union members in conducting institution activities, and cannot be mobile or transitory. [Restriction] Mandatory for account types: CACC (CONTA_DEPOSITO_A_VISTA) and SVGS (CONTA_POUPANCA). - `number` string, required: Account number of the receiving user, with check digit (if it exists). Any alphanumeric value should be converted to 0. - `qrCode` string - `proxy` string: Key registered in DICT belonging to the receiver. Key types can be: phone, email, cpf/cnpj or random key. For mobile phone, it must be informed in E.1641 standard. For email, it must have the format xxxxxxxx@xxxxxxx.xxx(.xx) and maximum 77 characters. For CPF, it must be informed with 11 numbers, without dots or dashes. For CNPJ, it must be informed with 14 numbers, without dots or dashes. For random key, the UUID generated by DICT must be informed, according to RFC41223 format. If informed, the account holder must validate the proxy in DICT when localInstrument equals DICT, QRDN or QRES and validate the creditorAccount field. This validation is optional if localInstrument equals INIC. [Restriction] If localInstrument equals MANU, the proxy field must not be filled. If localInstrument equals INIC, DICT, QRDN or QRES, the proxy field must always be filled with the PIX key. - `cnpjInitiator` string, required: CNPJ of the Payment Initiator duly authorized to provide PIX Initiation Service. - `transactionIdentification` string: This is a transaction identifier that must be retransmitted intact by the payer's PSP when generating the payment order. This information will allow the receiver to identify and correlate the transfer, when received, with the presentation of instructions to the payer. - `ibgeTownCode` string - `authorisationFlow` 'HYBRID_FLOW' | 'CIBA_FLOW' | 'FIDO_FLOW', required: Conditional field used to identify the authorization flow in which the payment was requested. [Restriction] If CIBA or FIDO, mandatory filling. If the field is not present in the payload, it is understood that the authorization flow used is HYBRID_FLOW. ## Response `200` PIX payment execution initiated successfully. - EnrollmentV2FidoAuthoriseResponse - `brandId` string, required: Unique identifier of the account holder financial institution brand. References the specific brand within the Open Finance Brasil directory that will process this enrollment authorization. - `redirectUrl` string, uri, required: Authorized callback URL for redirection after FIDO2 authorization. The user will be redirected to this URL after completing the enrollment authorization process at the account holder institution. - `directoryCallback` boolean: Indicates whether the redirection comes directly from the Open Finance Brasil directory or from a payment initiation flow. When true, the callback originates from the directory service. - `enrollment` EnrollmentV2FidoAuthoriseResponseEnrollment - `rp` string, required: Relying Party identifier for WebAuthn/FIDO2 authentication. This domain identifier ensures that credentials are bound to the correct service and prevents cross-origin attacks. - `platform` string, required: FIDO2 authenticator platform type used in the enrollment. Values: 'CROSS_PLATFORM' for external authenticators (USB keys, NFC), 'PLATFORM' for built-in authenticators (TouchID, FaceID, Windows Hello). - `enrollmentId` string, required: Unique identifier of this FIDO2 enrollment in the authorization context. This ID links the WebAuthn credentials to the specific enrollment record for payment authorization. - `data` PaymentsV4PaymentInitiationData, required - `loggedUser` PaymentsV4PaymentInitiationDataLoggedUser, required - `document` UserDocument, required - `identification` string, required: CPF number of the natural person, composed of 11 numeric digits without dots, dashes or spaces. Must be a valid CPF according to the Brazilian Federal Revenue validation algorithm. - `rel` string, required: Type of identification document. For Brazilian natural persons, always 'CPF' (Individual Taxpayer Registry). Identifies the type of document presented in the identification field. - `businessEntity` PaymentsV4PaymentInitiationDataBusinessEntity - `document` BusinessDocument, required - `identification` string, required: CNPJ number of the legal entity, composed of 14 numeric digits without dots, slashes or spaces. Must be a valid CNPJ according to the Brazilian Federal Revenue validation algorithm. - `rel` string, required: Type of identification document. For Brazilian legal entities, always 'CNPJ' (National Registry of Legal Entities). Identifies the type of document presented in the identification field. - `permissions` string[]: List of permissions assigned to the account link for payment initiation operations according to Open Finance Brasil specification. Must include 'PAYMENTS_INITIATE' to allow payment initiation. - `creditor` PaymentsV4PaymentInitiationDataCreditor - `cpfCnpj` string, required: Identification document (CPF or CNPJ) of the account holder. CPF: 11 numeric digits. CNPJ: 14 numeric digits. Both without formatting (dots, dashes or slashes). Must be valid according to Brazilian Federal Revenue algorithms. - `personType` 'PESSOA_NATURAL' | 'PESSOA_JURIDICA', required: Type of creditor account holder. PESSOA_NATURAL: Brazilian natural person identified by CPF. PESSOA_JURIDICA: Brazilian legal entity identified by CNPJ. This field determines the type of document expected in the cpfCnpj field and applicable validation rules. - `name` string, required: Name of the creditor account holder. For PESSOA_NATURAL: full name of the natural person as per official identity document. For PESSOA_JURIDICA: corporate name or trade name registered with Federal Revenue. Maximum 120 characters, accepts letters, numbers, accents and allowed special symbols. - `payment` PaymentsV4PaymentInitiationDataPayment, required - `type` 'PIX', required: Type of payment to be executed. Currently supports only PIX according to Central Bank of Brazil specification and Open Finance Brasil regulation. - `schedule` PaymentsV4PaymentInitiationDataPaymentSchedule - `single` PaymentsV4PaymentInitiationDataPaymentScheduleSingle - `date` string, required: Target settlement date for the payment. Uses Brasília time zone. Must be at least D+1 from consent date and at most D+730 from consent date, considering Brasília time zone. - `daily` PaymentsV4PaymentInitiationDataPaymentScheduleDaily - `startDate` string, required: Defines the start date of the recurring payment validity period. - `quantity` integer, required: Defines the quantity of payments that will be sent for settlement. - `weekly` PaymentsV4PaymentInitiationDataPaymentScheduleWeekly - `dayOfWeek` 'SEGUNDA_FEIRA' | 'TERCA_FEIRA' | 'QUARTA_FEIRA' | 'QUINTA_FEIRA' | 'SEXTA_FEIRA' | 'SABADO' | 'DOMINGO', required: Defines the planned day of the week for settlement occurrences. - `startDate` string, required: Defines the start date of the recurring payment validity period. - `quantity` integer, required: Defines the quantity of payments that will be sent for settlement. - `monthly` PaymentsV4PaymentInitiationDataPaymentScheduleMonthly - `dayOfMonth` integer, required: Defines the planned day of the month for settlement occurrences. - `startDate` string, required: Defines the start date of the recurring payment validity period. - `quantity` integer, required: Defines the quantity of payments that will be sent for settlement. - `custom` PaymentsV4PaymentInitiationDataPaymentScheduleCustom - `dates` string[], required: Defines the specific dates when settlement occurrences are planned. - `additionalInformation` string, required - `date` string: Date for payment execution in ISO 8601 format (YYYY-MM-DD). Required for single payments. Mutually exclusive with schedule object. Cannot be a past date or exceed maximum scheduling limits defined by Central Bank regulations. For immediate payments, use current date. - `currency` string, required: National currency code according to ISO-4217 standard. For Brazil, always 'BRL' (Brazilian Real). All monetary values are represented in the country's current currency. - `amount` string, required: PIX transaction monetary value with exactly 2 decimal places, formatted as string. Must exactly match the value authorized in the consent. For QR Codes with fixed value, must match the value encoded in the QR Code, otherwise will result in HTTP 422 error. - `ibgeTownCode` string: IBGE code of the payer's municipality (7 numeric digits). Optional field used by PIX arrangement to identify municipal and state holidays. When not informed, the receiving PSP assumes there are no local holidays. Corresponds to the 'codMun' field specified in the Central Bank's PIX Manual. - `details` PaymentsV4PaymentInitiationDataPaymentDetails, required - `localInstrument` 'MANU' | 'DICT' | 'QRDN' | 'QRES' | 'INIC', required: Specifies the local instrument used for PIX payment initiation as defined by the Central Bank of Brazil: MANU (manual account data entry), DICT (PIX key), QRDN (dynamic QR Code), QRES (static QR Code), INIC (initiation with pre-known beneficiary). - `qrCode` string: EMV string (PIX QR Code) for payment. Contains encoded data of the receiver, amount, PIX key and other information necessary for processing. Works with 'PIX Copy and Paste'. UTF-8 format, maximum 512 bytes. Required when localInstrument is QRDN or QRES. - `proxy` string: PIX key registered in DICT belonging to the recipient. Key types can be: phone, email, CPF/CNPJ or random key. Phone format E.164, email max 77 chars, CPF 11 digits, CNPJ 14 digits, random key as UUID RFC4122. Required for DICT, QRDN, QRES, INIC. Not allowed for MANU. - `creditorAccount` PaymentsV4PaymentInitiationDataPaymentDetailsCreditorAccount - `accountType` 'CACC' | 'TRAN' | 'SVGS', required: Account types used for payments. Traditional modalities provided by Resolution 4.753, not including linked accounts, foreign domiciled accounts, foreign currency accounts and electronic currency correspondent accounts. CACC - Current Account, SVGS - Savings Account, TRAN - Prepaid Payment Account. - `ispb` string, required: Must be filled with the ISPB (Brazilian Payment System Identifier) of the SPI (Instant Payment System) participant, numbers only. - `issuer` string: Bank branch code without digit. Branch is the facility intended for customer service, general public and credit union members in conducting institution activities, and cannot be mobile or transitory. [Restriction] Mandatory for account types: CACC (CONTA_DEPOSITO_A_VISTA) and SVGS (CONTA_POUPANCA). - `number` string, required: Account number of the receiving user, with check digit (if it exists). Any alphanumeric value should be converted to 0. - `debtorAccount` PaymentsV4PaymentInitiationDataDebtorAccount - `accountType` 'CACC' | 'TRAN' | 'SVGS', required: Account types used for payments. Traditional modalities provided by Resolution 4.753, not including linked accounts, foreign domiciled accounts, foreign currency accounts and electronic currency correspondent accounts. CACC - Current Account, SVGS - Savings Account, TRAN - Prepaid Payment Account. - `ispb` string, required: Must be filled with the ISPB (Brazilian Payment System Identifier) of the SPI (Instant Payment System) participant, numbers only. - `issuer` string: Bank branch code without digit. Branch is the facility intended for customer service, general public and credit union members in conducting institution activities, and cannot be mobile or transitory. [Restriction] Mandatory for account types: CACC (CONTA_DEPOSITO_A_VISTA) and SVGS (CONTA_POUPANCA). - `number` string, required: Account number of the receiving user, with check digit (if it exists). Any alphanumeric value should be converted to 0. - `remittanceInformation` string: Additional remittance information provided by the payer to be sent to the beneficiary along with the PIX payment. Maximum 140 characters. May contain payment description, invoice number, commercial reference, etc. - `applicationId` string, required: Unique identifier of the application that initiated the FIDO2 authorization. This ID links the authorization to the specific client application in the Open Finance ecosystem. - `journeySessionId` string, required: Unique identifier of the journey session associated with the FIDO2 authorization. This ID tracks the user's authentication flow from initiation to completion. - `paymentInitiationApi` string, required: Version of the payment initiation API used in the authorization. Indicates which API specification was used to process this payment initiation request. - `tokenId` string, required: Unique identifier of the authentication token used in the FIDO2 authorization. This token manages the session security and access control for the authorization process. - `createdAt` string, required: Creation date and time of the FIDO2 authorization record. Indicates when the authorization process was initiated. - `updatedAt` string, required: Last update date and time of the FIDO2 authorization record. Shows when the authorization was completed or last modified. - `authorizationUrl` string, uri, required: Account holder authorization URL to complete the consent process. This URL was used by the user to authorize the enrollment at the account holder institution. - `ofConsentId` string, required: Internal identifier of the Open Finance Brasil consent. This ID references the consent object that manages authorization permissions for this enrollment. - `idempotencyKey` string: Unique idempotency key to prevent duplicate processing of the authorization. This UUID ensures that retry attempts don't result in multiple authorization records. - `id` string, required: Unique identifier of the authorized payment initiation record. This ID represents the completed enrollment authorization in the system. - `ofConsent` OfConsent - `id` string, required: ID is the unique identifier of ITP Consent - `paymentInitiationId` string, required: ID is the unique identifier of ITP - `data` object, required: Regulatory consent data according to Open Finance Brasil specification - `brandId` string, required: Unique brand identifier of the participant institution - `consentId` string, required: Unique consent identifier at the account holder institution - `authorization_url` string, uri, required: Authorization URL for consent with the account holder institution - `status` 'AWAITING_AUTHORISATION' | 'AUTHORISED' | 'REJECTED' | 'CONSUMED', required: Returns the consent state, which at the moment of creation will be AWAITING_AUTHORISATION. This state will be changed after consent authorization at the payer's account holder to AUTHORISED or REJECTED. Consent becomes CONSUMED after payment initiation occurs. For expired consent, the holder should return REJECTED status. Possible states: AWAITING_AUTHORISATION - Awaiting authorization, AUTHORISED - Authorized, REJECTED - Rejected, CONSUMED - Consumed. - `access_token` string: Access token obtained after consent authorization - `organization_id` string: Organization identifier in the Open Finance directory. - `brand_id` string: Brand identifier of the account holder institution. - `creationDateTime` string: Timestamp when the consent was created. - `expirationDateTime` string: Timestamp when the consent expires. - `statusUpdateDateTime` string: Timestamp of the last status update. - `organizationName` string: Name of the account holder organization. - `organizationLogo` string, uri: URL of the account holder organization logo. - `nfc` boolean: Indicates whether the authentication device supports Near Field Communication (NFC). This information helps determine the appropriate authentication methods and user experience for FIDO2 operations. - `consent_id` string: Consent identifier at the account holder institution - `code_verifier` string: Code verifier for PKCE (Proof Key for Code Exchange) - `nonce` string: Nonce used in OpenID Connect authentication - `state` string: State used for OAuth2 security validation - `redirect_uri` string, uri: Redirect URI after authorization - `scope` string: Scope of requested permissions - `consentTerm` number, double: Consent term in time units - `consentTermUnit` string: Time unit for consent term (M=months, D=days) - `creditor` OfConsentCreditor - `cpfCnpj` string, required: Identification document (CPF or CNPJ) of the account holder. CPF: 11 numeric digits. CNPJ: 14 numeric digits. Both without formatting (dots, dashes or slashes). Must be valid according to Brazilian Federal Revenue algorithms. - `personType` 'PESSOA_NATURAL' | 'PESSOA_JURIDICA', required: Type of creditor account holder. PESSOA_NATURAL: Brazilian natural person identified by CPF. PESSOA_JURIDICA: Brazilian legal entity identified by CNPJ. This field determines the type of document expected in the cpfCnpj field and applicable validation rules. - `name` string, required: Name of the creditor account holder. For PESSOA_NATURAL: full name of the natural person as per official identity document. For PESSOA_JURIDICA: corporate name or trade name registered with Federal Revenue. Maximum 120 characters, accepts letters, numbers, accents and allowed special symbols. - `events` OfConsentEvents[]: Consent event history - `date` string, required: Event date and time - `event` string, required: Type of event occurred - `journey` string[]: User journey during consent process - `kind` string: Type of consent (PAYMENT, ACCOUNT_ACCESS, etc.) - `loggedUser` OfConsentLoggedUser - `document` UserDocument, required - `identification` string, required: CPF number of the natural person, composed of 11 numeric digits without dots, dashes or spaces. Must be a valid CPF according to the Brazilian Federal Revenue validation algorithm. - `rel` string, required: Type of identification document. For Brazilian natural persons, always 'CPF' (Individual Taxpayer Registry). Identifies the type of document presented in the identification field. - `ownerBrandId` string: Brand identifier of the account owner - `ownerId` string: Organization identifier of the account owner - `payment` OfConsentPayment - `type` 'PIX', required: Type of payment to be executed. Currently supports only PIX according to Central Bank of Brazil specification and Open Finance Brasil regulation. - `date` string: Date for payment execution in ISO 8601 format (YYYY-MM-DD). Required for single payments. Cannot be a past date or exceed maximum scheduling limits defined by Central Bank regulations. - `currency` string, required: National currency code according to ISO-4217 standard. For Brazil, always 'BRL' (Brazilian Real). - `amount` string, required: PIX transaction monetary value with exactly 2 decimal places, formatted as string. - `details` OfConsentPaymentDetails, required - `localInstrument` 'MANU' | 'DICT' | 'QRDN' | 'QRES' | 'INIC', required: Local instrument used for PIX payment initiation: DICT (PIX key), MANU (manual account data), QRDN (dynamic QR), QRES (static QR), INIC (pre-known beneficiary). - `proxy` string: PIX key registered in DICT belonging to the beneficiary. Can be phone, email, CPF/CNPJ or random key. - `creditorAccount` OfConsentPaymentDetailsCreditorAccount - `ispb` string, required: ISPB (Brazilian Payment System Identifier) of the SPI participant, numbers only. - `issuer` string: Bank branch code without digit. - `number` string, required: Account number of the receiving user, with check digit if it exists. - `accountType` 'CACC' | 'TRAN' | 'SVGS', required: Account types for payments. CACC - Current Account, SVGS - Savings Account, TRAN - Prepaid Payment Account. - `transactions` string[]: List of transactions associated with the consent - `rejectionReason` OfConsentRejectionReason - `code` 'TEMPO_EXPIRADO_AUTORIZACAO' | 'REJEITADO_USUARIO' | 'CONSENTIMENTO_NEGADO' | 'FALHA_INFRAESTRUTURA' | 'CONTA_NAO_PERMITE_PAGAMENTO' | 'SALDO_INSUFICIENTE' | 'VALOR_INVALIDO' | 'COBRANCA_INVALIDA' | 'PAGAMENTO_DIVERGENTE_CONSENTIMENTO', required: Standardized rejection reason code according to Open Finance Brasil specifications. TEMPO_EXPIRADO_AUTORIZACAO: Authorization time expired (5 minutes); REJEITADO_USUARIO: Rejected by user during authorization process; CONSENTIMENTO_NEGADO: Consent denied by account holder; FALHA_INFRAESTRUTURA: Infrastructure failure at holder institution; CONTA_NAO_PERMITE_PAGAMENTO: Account does not allow payment operations; SALDO_INSUFICIENTE: Insufficient account balance; VALOR_INVALIDO: Invalid payment amount; COBRANCA_INVALIDA: Invalid charge or billing; PAGAMENTO_DIVERGENTE_CONSENTIMENTO: Payment data divergent from consent. - `detail` string: Additional details about rejection reason - `ofPayments` OfPaymentResponse[]: List of PIX payments processed when processPix is true. Contains complete payment transaction data including status, amounts, and processing details for payments executed via this authorization. - `paymentInitiationId` string, required: ID is the unique identifier of ITP - `consentId` string, required: Unique identifier of the regulatory consent obtained during the authorization process. Links the payment request to the specific consent provided by the user according to Open Finance Brasil regulations. - `localInstrument` string, required: Local instrument used for PIX payment initiation. Values: DICT (PIX key), MANU (manual account data), QRDN (dynamic QR), QRES (static QR), INIC (pre-known beneficiary). - `payment` OfPaymentResponsePayment, required - `currency` string, required: Transaction currency code according to ISO-4217 standard. For Brazil, always 'BRL' (Brazilian Real). - `amount` string, required: PIX transaction monetary value with two decimal places, formatted as string. Represents the amount transferred in the payment. - `creditorAccount` OfPaymentResponseCreditorAccount, required - `number` string, required: Beneficiary account number at the financial institution. The specific account identifier for the receiving account. - `accountType` string, required: Beneficiary account type according to ISO 20022 standard. Common values: CACC (current account), SVGS (savings account). - `ispb` string, required: ISPB code of the beneficiary's financial institution. Unique identifier of the institution in the Brazilian Payment System. - `issuer` string, required: Beneficiary account issuer code at the financial institution. Identifies the specific branch or issuing unit. - `cnpjInitiator` string, required: CNPJ of the payment initiating institution responsible for this transaction. Identifies the institution that originated the payment request. - `proxy` string: PIX key used to identify the beneficiary's account in DICT. Can be phone, email, CPF/CNPJ or random key registered in the PIX directory. - `endToEndId` string, required: Unique end-to-end identifier of the PIX transaction in the Instant Payment System (SPI). Allows tracking the transaction from origin to destination. - `authorisationFlow` string, required: Type of authorization flow used to process this PIX payment. Indicates the authentication method used (e.g., FIDO_FLOW for FIDO2 authentication). - `creationDateTime` string, required: PIX transaction creation date and time in ISO 8601 format. Indicates when the payment was initiated and processed. - `debtorAccount` OfPaymentResponseDebtorAccount, required - `ispb` string, required: ISPB code of the payer's financial institution. Unique identifier of the institution in the Brazilian Payment System. - `issuer` string, required: Payer account issuer code at the financial institution. Identifies the specific branch or issuing unit. - `number` string, required: Payer account number at the financial institution. The specific account identifier for the sending account. - `accountType` string, required: Payer account type according to ISO 20022 standard. Common values: CACC (current account), SVGS (savings account). - `paymentId` string, required: Unique payment identifier generated by the account holder institution. Used to reference this specific transaction in the holder's system. - `status` string, required: Current status of the PIX transaction according to Open Finance Brasil specification. Values include RCVD (received), PDNG (pending), ACSC (accepted), RJCT (rejected). - `statusUpdateDateTime` string, required: Date and time of the last PIX transaction status update in ISO 8601 format. Shows when the transaction status was last modified. - `id` string, required: Unique internal identifier of the payment record in the system. Used for internal tracking and database operations. - `brand` Brand - `id` string, required: Unique identifier of the brand record in the local database - `createdAt` string, required: Record creation date and time - `updatedAt` string, required: Record last update date and time - `deletedAt` string, required: Record deletion date and time (soft delete) - `AuthorisationServerId` string, required: Unique identifier of the Open Finance Brasil participant institution's authorization server. Corresponds to the authorization server ID registered in the ecosystem's central directory. - `CustomerFriendlyDescription` string, required: Customer-friendly description of the brand directed to the end customer. Used to present clear information about the financial institution in the user interface during the consent and authentication process. - `CustomerFriendlyLogoUri` string, required: URL of the brand logo image for display to the end customer. Must be a valid and accessible URL pointing to the official logo of the financial institution as registered in the Open Finance Brasil directory. - `CustomerFriendlyName` string, required: Customer-friendly name of the brand as presented to the end customer. Represents the commercial name of the financial institution used in communication with users during consent and authentication flows in Open Finance Brasil. - `Flags` BrandFlags, required - `Suporta Contas PF` string[]: Array indicating support for individual person accounts - `Suporta Contas PJ` string[]: Array indicating support for legal entity accounts - `OpenIDDiscoveryDocument` string, required: URL of the OpenID Connect discovery document for the institution's authorization server. Contains metadata about the OAuth2/OIDC endpoints and capabilities. - `OrganisationId` string, required: Unique identifier of the parent organization in the Open Finance Brasil directory - `ParentAuthorisationServerId` string: Identifier of the parent authorization server, if this brand is part of a larger organization structure - `OrganisationName` string, required: Official legal name of the organization as registered in the Open Finance Brasil directory - `strId` string: Additional string identifier of the brand when available - `ApiFamilyType` BrandApiFamilyType, required - `payments-pix-recurring-payments-automatic` boolean: Indicates support for PIX automatic recurring payments API - `payments-pix` boolean: Indicates support for PIX payments API - `payments-pix-recurring-payments` boolean: Indicates support for PIX recurring payments API - `settings` BrandSettings - `brandId` string, required: Brand identifier associated with the settings. - `sandboxUsersTests` BrandSettingsSandboxUsersTests[]: List of test users available for sandbox environment. - `username` string, required: Username for sandbox environment testing. - `password` string, required: Password for sandbox environment testing. - `document` BrandSettingsSandboxUsersTestsDocument, required - `identification` string, required: Identification document number. - `rel` string, required: Type of identification document (CPF, CNPJ). - `updatedAt` string: Date and time of the last settings update. - `uptimeStatus` string: Operational status of the brand (OPERATIONAL, MAINTENANCE, etc.). - `id` string, required: Unique identifier of the settings. - `organisationBrands` BrandOrganisationBrands[]: List of other brands belonging to the same organization. - `AuthorisationServerId` string, required: Unique identifier of the brand's authorization server. - `CustomerFriendlyDescription` string, required: Customer-friendly description of the brand for display. - `CustomerFriendlyLogoUri` string, required: URL of the brand logo for customer display. - `CustomerFriendlyName` string, required: Customer-friendly name of the brand for display. - `Flags` object, required: Brand capability flags. - `OpenIDDiscoveryDocument` string, required: URL of the OpenID Connect discovery document. - `OrganisationId` string, required: Parent organization identifier. - `ParentAuthorisationServerId` string: Parent authorization server identifier. - `OrganisationName` string, required: Official name of the organization. - `strId` string: Additional string identifier of the brand when available. - `ApiFamilyType` object, required: API family types supported by the brand. - `id` string, required: Unique identifier of the brand. - `journeySession` EnrollmentsV2JourneySession - `id` string, required: ID is the unique identifier of journey - `createdAt` string, required: Record creation date and time - `updatedAt` string, required: Record last update date and time - `deletedAt` string, required: Record deletion date and time (soft delete) - `journeyId` string, required: ID is the unique identifier of journey - `redirectUrl` string, uri: The redirect address for the journey after the flow of the journey.It needs to be one of the registered in the application. - `brandId` string: ID is the unique identifier of brand - `externalId` string: ID is the unique identifier of journey - `expirationDateTime` string: Data e hora em que a jornada deve deixar de ser válido. Uma string com data e hora conforme especificação RFC-3339, sempre com a utilização de timezone UTC(UTC time format). - `tags` string: Tags que podem ser usadas para classificar a sessão da jornada. - `webhookHeaders` string: Headers que podem ser usadas para classificar a sessão da jornada. - `settings` EnrollmentsV2JourneySessionSettings[]: Lista de configurações da sessão da jornada - `key` 'PRIORITIES_BRANDS' | 'JOURNEY_RULES', required: Tipos de chaves usadas para a customização da sessão da jornada. - PRIORITIES_BRANDS - Lista de ids dos brands prioritátios - JOURNEY_RULES - Regras para execução da jornada. - `value` string, required: Configuration value. - `applicationClientId` string, required: The application clientId. - `applicationId` string, required: The application ID. It is an exclusive number that identifies the application. - `tokenId` string, required: The token id.It is an exclusive number that identifies the token. - `token` EnrollmentsV2JourneySessionToken - `id` string, required: ID is the unique identifier of journey - `createdAt` string, required: Record creation date and time - `updatedAt` string, required: Record last update date and time - `deletedAt` string, required: Record deletion date and time (soft delete) - `token` string, required: Access token to the journey session - `journeySessionUrl` string, uri, required: The URL of the Journey Session that must be opened to the user. - `status` 'PENDING' | 'CANCELLED' | 'EXPIRED' | 'AWAITING_AUTHORISATION' | 'AWAITING_AUTHORISATION_ACTION' | 'AUTHORISED' | 'CONSUMED' | 'REJECTED' | 'FINISHED', required: Status of the Journey Session. - `statusHistory` EnrollmentsV2JourneySessionStatusHistory[]: List with the status of the journey session status. - `updatedAt` string, required: Record last update date and time - `status` 'PENDING' | 'CANCELLED' | 'EXPIRED' | 'AWAITING_AUTHORISATION' | 'AWAITING_AUTHORISATION_ACTION' | 'AUTHORISED' | 'CONSUMED' | 'REJECTED' | 'FINISHED', required: Status of the Journey Session. - `journeySessionStageId` string: ID is the unique identifier of the stage of the Journey Session - `journeySessionStage` EnrollmentsV2JourneySessionJourneySessionStage - `id` string, required: ID is the unique identifier of journey - `persistedState` string: Represents the internal state of the actor. It is a JSON object with the dump of the machine state, restrained in case of recharging. - `logs` EnrollmentsV2JourneySessionJourneySessionStageLogs[]: List of events and states that the user passed on the journey. - `createdAt` string, required: Record creation date and time - `event` object, required: Event issued on the journey. - `stateName` string, required: State name. A state describes the machine status or mode. - `paymentInitiationId` string: ID is the unique identifier of ITP - `paymentInitiationApi` 'ENROLLMENTS_V2' | 'PAYMENTS_V4', required: Payment initiation API used in the journey session. ENROLLMENTS_V2 for simple enrollments, PAYMENTS_V4 for PIX payments through enrollment. - `paymentInitiationData` PaymentsV4PaymentInitiationData - `loggedUser` PaymentsV4PaymentInitiationDataLoggedUser, required - `document` UserDocument, required - `identification` string, required: CPF number of the natural person, composed of 11 numeric digits without dots, dashes or spaces. Must be a valid CPF according to the Brazilian Federal Revenue validation algorithm. - `rel` string, required: Type of identification document. For Brazilian natural persons, always 'CPF' (Individual Taxpayer Registry). Identifies the type of document presented in the identification field. - `businessEntity` PaymentsV4PaymentInitiationDataBusinessEntity - `document` BusinessDocument, required - `identification` string, required: CNPJ number of the legal entity, composed of 14 numeric digits without dots, slashes or spaces. Must be a valid CNPJ according to the Brazilian Federal Revenue validation algorithm. - `rel` string, required: Type of identification document. For Brazilian legal entities, always 'CNPJ' (National Registry of Legal Entities). Identifies the type of document presented in the identification field. - `permissions` string[]: List of permissions assigned to the account link for payment initiation operations according to Open Finance Brasil specification. Must include 'PAYMENTS_INITIATE' to allow payment initiation. - `creditor` PaymentsV4PaymentInitiationDataCreditor - `cpfCnpj` string, required: Identification document (CPF or CNPJ) of the account holder. CPF: 11 numeric digits. CNPJ: 14 numeric digits. Both without formatting (dots, dashes or slashes). Must be valid according to Brazilian Federal Revenue algorithms. - `personType` 'PESSOA_NATURAL' | 'PESSOA_JURIDICA', required: Type of creditor account holder. PESSOA_NATURAL: Brazilian natural person identified by CPF. PESSOA_JURIDICA: Brazilian legal entity identified by CNPJ. This field determines the type of document expected in the cpfCnpj field and applicable validation rules. - `name` string, required: Name of the creditor account holder. For PESSOA_NATURAL: full name of the natural person as per official identity document. For PESSOA_JURIDICA: corporate name or trade name registered with Federal Revenue. Maximum 120 characters, accepts letters, numbers, accents and allowed special symbols. - `payment` PaymentsV4PaymentInitiationDataPayment, required - `type` 'PIX', required: Type of payment to be executed. Currently supports only PIX according to Central Bank of Brazil specification and Open Finance Brasil regulation. - `schedule` PaymentsV4PaymentInitiationDataPaymentSchedule - `single` PaymentsV4PaymentInitiationDataPaymentScheduleSingle - `date` string, required: Target settlement date for the payment. Uses Brasília time zone. Must be at least D+1 from consent date and at most D+730 from consent date, considering Brasília time zone. - `daily` PaymentsV4PaymentInitiationDataPaymentScheduleDaily - `startDate` string, required: Defines the start date of the recurring payment validity period. - `quantity` integer, required: Defines the quantity of payments that will be sent for settlement. - `weekly` PaymentsV4PaymentInitiationDataPaymentScheduleWeekly - `dayOfWeek` 'SEGUNDA_FEIRA' | 'TERCA_FEIRA' | 'QUARTA_FEIRA' | 'QUINTA_FEIRA' | 'SEXTA_FEIRA' | 'SABADO' | 'DOMINGO', required: Defines the planned day of the week for settlement occurrences. - `startDate` string, required: Defines the start date of the recurring payment validity period. - `quantity` integer, required: Defines the quantity of payments that will be sent for settlement. - `monthly` PaymentsV4PaymentInitiationDataPaymentScheduleMonthly - `dayOfMonth` integer, required: Defines the planned day of the month for settlement occurrences. - `startDate` string, required: Defines the start date of the recurring payment validity period. - `quantity` integer, required: Defines the quantity of payments that will be sent for settlement. - `custom` PaymentsV4PaymentInitiationDataPaymentScheduleCustom - `dates` string[], required: Defines the specific dates when settlement occurrences are planned. - `additionalInformation` string, required - `date` string: Date for payment execution in ISO 8601 format (YYYY-MM-DD). Required for single payments. Mutually exclusive with schedule object. Cannot be a past date or exceed maximum scheduling limits defined by Central Bank regulations. For immediate payments, use current date. - `currency` string, required: National currency code according to ISO-4217 standard. For Brazil, always 'BRL' (Brazilian Real). All monetary values are represented in the country's current currency. - `amount` string, required: PIX transaction monetary value with exactly 2 decimal places, formatted as string. Must exactly match the value authorized in the consent. For QR Codes with fixed value, must match the value encoded in the QR Code, otherwise will result in HTTP 422 error. - `ibgeTownCode` string: IBGE code of the payer's municipality (7 numeric digits). Optional field used by PIX arrangement to identify municipal and state holidays. When not informed, the receiving PSP assumes there are no local holidays. Corresponds to the 'codMun' field specified in the Central Bank's PIX Manual. - `details` PaymentsV4PaymentInitiationDataPaymentDetails, required - `localInstrument` 'MANU' | 'DICT' | 'QRDN' | 'QRES' | 'INIC', required: Specifies the local instrument used for PIX payment initiation as defined by the Central Bank of Brazil: MANU (manual account data entry), DICT (PIX key), QRDN (dynamic QR Code), QRES (static QR Code), INIC (initiation with pre-known beneficiary). - `qrCode` string: EMV string (PIX QR Code) for payment. Contains encoded data of the receiver, amount, PIX key and other information necessary for processing. Works with 'PIX Copy and Paste'. UTF-8 format, maximum 512 bytes. Required when localInstrument is QRDN or QRES. - `proxy` string: PIX key registered in DICT belonging to the recipient. Key types can be: phone, email, CPF/CNPJ or random key. Phone format E.164, email max 77 chars, CPF 11 digits, CNPJ 14 digits, random key as UUID RFC4122. Required for DICT, QRDN, QRES, INIC. Not allowed for MANU. - `creditorAccount` PaymentsV4PaymentInitiationDataPaymentDetailsCreditorAccount - `accountType` 'CACC' | 'TRAN' | 'SVGS', required: Account types used for payments. Traditional modalities provided by Resolution 4.753, not including linked accounts, foreign domiciled accounts, foreign currency accounts and electronic currency correspondent accounts. CACC - Current Account, SVGS - Savings Account, TRAN - Prepaid Payment Account. - `ispb` string, required: Must be filled with the ISPB (Brazilian Payment System Identifier) of the SPI (Instant Payment System) participant, numbers only. - `issuer` string: Bank branch code without digit. Branch is the facility intended for customer service, general public and credit union members in conducting institution activities, and cannot be mobile or transitory. [Restriction] Mandatory for account types: CACC (CONTA_DEPOSITO_A_VISTA) and SVGS (CONTA_POUPANCA). - `number` string, required: Account number of the receiving user, with check digit (if it exists). Any alphanumeric value should be converted to 0. - `debtorAccount` PaymentsV4PaymentInitiationDataDebtorAccount - `accountType` 'CACC' | 'TRAN' | 'SVGS', required: Account types used for payments. Traditional modalities provided by Resolution 4.753, not including linked accounts, foreign domiciled accounts, foreign currency accounts and electronic currency correspondent accounts. CACC - Current Account, SVGS - Savings Account, TRAN - Prepaid Payment Account. - `ispb` string, required: Must be filled with the ISPB (Brazilian Payment System Identifier) of the SPI (Instant Payment System) participant, numbers only. - `issuer` string: Bank branch code without digit. Branch is the facility intended for customer service, general public and credit union members in conducting institution activities, and cannot be mobile or transitory. [Restriction] Mandatory for account types: CACC (CONTA_DEPOSITO_A_VISTA) and SVGS (CONTA_POUPANCA). - `number` string, required: Account number of the receiving user, with check digit (if it exists). Any alphanumeric value should be converted to 0. - `remittanceInformation` string: Additional remittance information provided by the payer to be sent to the beneficiary along with the PIX payment. Maximum 140 characters. May contain payment description, invoice number, commercial reference, etc. - `paymentInitiation` EnrollmentsV2JourneySessionPaymentInitiation ## Other responses - `401`: Authentication is required to access this resource. The client must provide valid credentials. - `403`: The server understood the request but refuses to authorize it. Access is permanently forbidden and tied to the application logic. - `409`: The request conflicts with the current state of the resource on the server. - `422`: The request was well-formed but business validations for PIX payments failed at the holder institution. - `500`: An unexpected error occurred on the server while processing the request. - `default`: Unexpected error. --- [API](https://skmtc.dev/celcoin/apis/api-para-transa-es.md) - [All operations](https://skmtc.dev/celcoin/apis/api-para-transa-es/llms.txt) - [OpenAPI document](https://skmtc.dev/celcoin/apis/api-para-transa-es/revisions/85dd6188a37b?raw)