---
title: "Get PIX payment initiation by ID"
method: GET
path: "/open-keys/itp/api/v2/payments/v4/payment-initiation/{id}"
tags: ["Payment Initiation"]
---

# Get PIX payment initiation by ID

`GET /open-keys/itp/api/v2/payments/v4/payment-initiation/{id}`

Retrieves a specific PIX payment initiation by its unique identifier. Returns detailed payment information including status, amount, creditor data, and execution details according to Open Finance Brasil specifications.

## Path parameters

- `id` string, required

## Response `200`

PIX payment initiation details successfully returned.

- PaymentsV4PaymentInitiation
  - `id` string, required — ID is the unique identifier of ITP
  - `paymentInitiationApi` 'PAYMENTS_V4', required — Payment initiation API version identifier. Specifies which version of the Open Finance Brasil payment initiation API specification is being used for this transaction. Currently supports only PAYMENTS_V4 according to Central Bank of Brazil regulations.
  - `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)
  - `brandId` string, required — ID is the unique identifier of brand
  - `journeySessionId` string — ID is the unique identifier of journey
  - `redirectUrl` string, uri — The redirect URI authorized by the application.
  - `directoryCallback` boolean — Indicates if the redirect is direct from the directory
  - `enrollment` PaymentsV4PaymentInitiationEnrollment
    - `rp` string, required — Unique identifier of the Relying Party, corresponding to the CN value of the initiator's transport certificate.
    - `platform` 'ANDROID' | 'BROWSER' | 'CROSS_PLATFORM' | 'IOS', required — Indicates the platform on which the user is using the FIDO2 credential. This field allows the FIDO server to include extensions according to the platform used.
    - `enrollmentId` string, required — ID is the unique identifier of Enrollment
  - `tags` string — Custom tags for payment initiation categorization and tracking. Allows classifying transactions by specific business criteria such as origin channel, marketing campaign, customer type, etc. Limitations applied to avoid conflicts with system reserved parameters.
  - `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.
  - `journeySession` Journey
    - `id` string, required — The journey ID. It is an exclusive number that identifies the 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)
    - `alias` string, required — Journey Identification Alias.
    - `acceptPaymentInitiationApis` string[] — List of payment initiation APIs accepted by this journey. Defines which versions and types of payment initiation can be processed: PAYMENTS_V4 (PIX v4), AUTOMATIC_PAYMENTS_V2 (recurring payments v2), ENROLLMENTS_V2 (enrollments v2).
    - `name` string, required — Journey Identification Name.
    - `description` string — Journey Description
    - `settings` JourneySettings[] — Journey configuration list
      - `key` 'JOURNEY_RULES' | 'PRIORITIES_BRANDS' | 'ALLOWED_CPF' | 'DISABLE_BRANDS', required — Types of keys used for journey customization. - JOURNEY_RULES - Rules for journey execution. - PRIORITIES_BRANDS - List of priority brand IDs
      - `value` string, required — Configuration value.
  - `applicationId` string, required — Unique identifier of the payment initiator application registered in the Open Finance Brasil directory. Corresponds to the software_statement_id registered during the DCR (Dynamic Client Registration) process.
  - `tokenId` string, required — Unique identifier of the access token for the payment session
  - `authorizationUrl` string, uri, required — Authorization URL for consent with the account holder institution
  - `ofConsentId` string, required — Unique identifier of the Open Finance consent
  - `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
  - `idempotencyKey` string, required — Idempotency key used to ensure duplicate requests are not processed multiple times. Prevents duplicate transactions in case of network failures or timeouts. Should be a unique UUID per transaction.
  - `ofPayments` OfPayment[] — List of Open Finance payments associated with this initiation. Contains details of payments actually processed by the account holder institution, including status, amounts and settlement information.
    - `id` string, required — ID is the unique identifier of ITP Payment
    - `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` OfPaymentPayment, 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` OfPaymentCreditorAccount, 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` OfPaymentDebtorAccount, 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.
  - `httpCalls` PaymentsV4PaymentInitiationHttpCalls[] — History of HTTP calls made during the payment initiation process. Includes requests and responses to account holder institution APIs, useful for auditing, troubleshooting and transaction traceability.
    - `id` string, required — Unique HTTP call identifier
    - `externalId` string, required — Reference ID of the object that requested the call
    - `request` PaymentsV4PaymentInitiationHttpCallsRequest, required
      - `url` string, required — Target URL of the HTTP request
      - `method` string, required — HTTP method used in the request (GET, POST, PUT, DELETE)
      - `headers` PaymentsV4PaymentInitiationHttpCallsRequestHeaders, required
        - `x-fapi-interaction-id` string — FAPI interaction identifier for request tracking
        - `x-correlation-id` string — Correlation identifier for distributed request tracing
    - `response` PaymentsV4PaymentInitiationHttpCallsResponse, required
      - `data` object — Response data. Inserted only in case of error.
      - `status` string, required — HTTP response status code
      - `statusText` string, required — Descriptive text of the HTTP response status
      - `headers` object, required
    - `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)

## 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 contains invalid or malformed data that cannot be processed.
- `500` — An unexpected error occurred on the server while processing the request.
- `default` — Unexpected error.

---

[API](https://skmtc.net/celcoin/apis/api-para-transa-es.md) · [All operations](https://skmtc.net/celcoin/apis/api-para-transa-es/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/celcoin/api-para-transa-es/versions/85dd6188a37b/schema)