Sign in

v1

latestOpenAPI 3.0.12026-07-245303882.5 MB
Payment Initiation

Execute PIX payment

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.

post/open-keys/itp/api/v2/payments/v4/payment-initiation/{id}/pix

Path parameters

idstring required

ID is the unique identifier of ITP

Request body

Example request

{
  "data": [
    {
      "endToEndId": "E9040088820210128000800123873170",
      "localInstrument": "DICT",
      "payment": {
        "currency": "BRL",
        "amount": "1.12"
      },
      "creditorAccount": {
        "accountType": "CACC",
        "ispb": "00000000",
        "issuer": "0001",
        "number": "0001234567"
      },
      "qrCode": "\n\t\t\t\t\t\t  00020104141234567890123426660014BR.GOV.BCB.PIX014466756C616E6F32303139406578616D706C652E636F6D27300012\n\t\t\t\t\t\t  BR.COM.OUTRO011001234567895204000053039865406123.455802BR5915NOMEDORECEBEDOR6008BRASILIA61087007490062\n\t\t\t\t\t\t  530515RP12345678-201950300017BR.GOV.BCB.BRCODE01051.0.080450014BR.GOV.BCB.PIX0123PADRAO.URL.PIX/0123AB\n\t\t\t\t\t\t  CD81390012BR.COM.OUTRO01190123.ABCD.3456.WXYZ6304EB76",
      "proxy": "11223344556",
      "cnpjInitiator": "11222333000181",
      "transactionIdentification": "E00038166201907261559y6j6",
      "ibgeTownCode": "5300108",
      "authorisationFlow": "HYBRID_FLOW"
    }
  ]
}

Response

PIX payment execution initiated successfully.

brandIdstring 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.

redirectUrlstring 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.

directoryCallbackboolean

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.

applicationIdstring 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.

journeySessionIdstring required

Unique identifier of the journey session associated with the FIDO2 authorization. This ID tracks the user's authentication flow from initiation to completion.

paymentInitiationApistring required

Version of the payment initiation API used in the authorization. Indicates which API specification was used to process this payment initiation request.

tokenIdstring 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.

createdAtstring required

Creation date and time of the FIDO2 authorization record. Indicates when the authorization process was initiated.

updatedAtstring required

Last update date and time of the FIDO2 authorization record. Shows when the authorization was completed or last modified.

authorizationUrlstring 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.

ofConsentIdstring required

Internal identifier of the Open Finance Brasil consent. This ID references the consent object that manages authorization permissions for this enrollment.

idempotencyKeystring

Unique idempotency key to prevent duplicate processing of the authorization. This UUID ensures that retry attempts don't result in multiple authorization records.

idstring required

Unique identifier of the authorized payment initiation record. This ID represents the completed enrollment authorization in the system.

Example response

{
  "brandId": "66f4d9e296f18bc4606e1618",
  "redirectUrl": "https://meuapp.exemplo.com/callback",
  "directoryCallback": true,
  "enrollment": {
    "rp": "webauthn-simulator.web.app",
    "platform": "CROSS_PLATFORM",
    "enrollmentId": "68a832f86629950011215237"
  },
  "data": {
    "loggedUser": {
      "document": {
        "identification": "11122233344",
        "rel": "CPF"
      }
    },
    "businessEntity": {
      "document": {
        "identification": "00000000000191",
        "rel": "CNPJ"
      }
    },
    "creditor": {
      "cpfCnpj": "12345678000199",
      "personType": "PESSOA_JURIDICA",
      "name": "João da Silva Santos"
    },
    "payment": {
      "type": "PIX",
      "schedule": {
        "single": {
          "date": "2023-08-23"
        },
        "daily": {
          "startDate": "2023-08-23"
        },
        "weekly": {
          "dayOfWeek": "QUINTA_FEIRA",
          "startDate": "2023-08-23"
        },
        "monthly": {
          "startDate": "2023-08-23"
        },
        "custom": {
          "additionalInformation": "Todas quintas e domingos por 6 meses"
        }
      },
      "date": "2024-03-05",
      "currency": "BRL",
      "amount": "1.12",
      "ibgeTownCode": "5300108",
      "details": {
        "localInstrument": "DICT",
        "qrCode": "\n\t\t\t\t\t\t  00020104141234567890123426660014BR.GOV.BCB.PIX014466756C616E6F32303139406578616D706C652E636F6D27300012\n\t\t\t\t\t\t  BR.COM.OUTRO011001234567895204000053039865406123.455802BR5915NOMEDORECEBEDOR6008BRASILIA61087007490062\n\t\t\t\t\t\t  530515RP12345678-201950300017BR.GOV.BCB.BRCODE01051.0.080450014BR.GOV.BCB.PIX0123PADRAO.URL.PIX/0123AB\n\t\t\t\t\t\t  CD81390012BR.COM.OUTRO01190123.ABCD.3456.WXYZ6304EB76",
        "proxy": "11223344556",
        "creditorAccount": {
          "accountType": "CACC",
          "ispb": "00000000",
          "issuer": "0001",
          "number": "0001234567"
        }
      }
    },
    "debtorAccount": {
      "accountType": "CACC",
      "ispb": "00000000",
      "issuer": "0001",
      "number": "0001234567"
    },
    "remittanceInformation": "Pagamento da nota XPTO035-002"
  },
  "applicationId": "6837161d86833f0011561f1c",
  "journeySessionId": "EXAMPLE-ENROLLMENT-ID-0001",
  "paymentInitiationApi": "PAYMENTS_V4",
  "tokenId": "EXAMPLE-ENROLLMENT-ID-0002",
  "createdAt": "2025-08-22T09:07:10.006Z",
  "updatedAt": "2025-08-22T09:08:27.824Z",
  "authorizationUrl": "https://api-openfinance.opb.bricks.demo.fsapps.io/orgs/bricks/auth?client_id=CSYrcp9dzeRdUWbuXLFiF&request_uri=urn%3Aietf%3Aparams%3Aoauth%3Arequest_uri%3AeZSX_E_6xCjnVG5dJJBYd",
  "ofConsentId": "EXAMPLE-CONSENT-ID-0001",
  "idempotencyKey": "783336ed-c1dd-40a8-b0b7-2e884b6221c2",
  "id": "EXAMPLE-PAYMENT-ID-0001",
  "ofConsent": {
    "authorization_url": "https://example.com",
    "status": "AWAITING_AUTHORISATION",
    "organizationLogo": "https://example.com",
    "redirect_uri": "https://example.com",
    "consentTerm": 0.123,
    "creditor": {
      "cpfCnpj": "12345678000199",
      "personType": "PESSOA_JURIDICA",
      "name": "João da Silva Santos"
    },
    "loggedUser": {
      "document": {
        "identification": "11122233344",
        "rel": "CPF"
      }
    },
    "payment": {
      "type": "PIX",
      "date": "2025-08-05",
      "currency": "BRL",
      "amount": "10.00",
      "details": {
        "localInstrument": "DICT",
        "proxy": "usuario@ficticio.com",
        "creditorAccount": {
          "ispb": "00000000",
          "issuer": "0001",
          "number": "0001234567",
          "accountType": "CACC"
        }
      }
    },
    "rejectionReason": {
      "code": "TEMPO_EXPIRADO_AUTORIZACAO"
    }
  },
  "ofPayments": [
    {
      "localInstrument": "DICT",
      "payment": {
        "currency": "BRL",
        "amount": "1.00"
      },
      "creditorAccount": {
        "number": "1234567890",
        "accountType": "CACC",
        "ispb": "12345678",
        "issuer": "1774"
      },
      "cnpjInitiator": "13935893000109",
      "proxy": "cliente-a00001@pix.bcb.gov.br",
      "endToEndId": "E13935893202511021042TKe1h8bM2FO",
      "authorisationFlow": "FIDO_FLOW",
      "creationDateTime": "2025-11-13T21:41:49Z",
      "debtorAccount": {
        "ispb": "12345678",
        "issuer": "0001",
        "number": "969139",
        "accountType": "CACC"
      },
      "paymentId": "9917ab8f-e134-490b-b2b5-59ecd4e0abd0",
      "status": "ACSC",
      "statusUpdateDateTime": "2025-11-13T21:41:56Z",
      "id": "EXAMPLE-PAYMENT-ID-0002"
    }
  ],
  "brand": {
    "createdAt": "2024-01-01T20:32:44.581Z",
    "updatedAt": "2024-01-01T20:32:44.581Z",
    "deletedAt": "2024-01-01T20:32:44.581Z",
    "settings": {
      "brandId": "66f4d9e296f18bc4606e1618",
      "sandboxUsersTests": [
        {
          "username": "usuario_teste",
          "password": "senha1234",
          "document": {
            "identification": "11122233344",
            "rel": "CPF"
          }
        }
      ],
      "updatedAt": "2024-09-26T03:51:03.642Z",
      "uptimeStatus": "OPERATIONAL",
      "id": "66f4da2796f18bc4606e2b87"
    }
  },
  "journeySession": {
    "id": "f362a873-c127-4122-b711-a37b24a36914",
    "createdAt": "2024-01-01T20:32:44.581Z",
    "updatedAt": "2024-01-01T20:32:44.581Z",
    "deletedAt": "2024-01-01T20:32:44.581Z",
    "redirectUrl": "http://localhost:8080/callback",
    "externalId": "8cbe7dfb-40d6-4a42-9e8b-d9df88ca55f5",
    "expirationDateTime": "2021-05-21T08:30:00Z",
    "settings": [
      {
        "key": "PRIORITIES_BRANDS"
      }
    ],
    "applicationClientId": "f362a873-c127-4122-b711-a37b24a36914",
    "applicationId": "f362a873-c127-4122-b711-a37b24a36914",
    "tokenId": "f362a873-c127-4122-b711-a37b24a36914",
    "token": {
      "id": "f362a873-c127-4122-b711-a37b24a36914",
      "createdAt": "2024-01-01T20:32:44.581Z",
      "updatedAt": "2024-01-01T20:32:44.581Z",
      "deletedAt": "2024-01-01T20:32:44.581Z",
      "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI2NWYyMjQ2MWY2ZTAxZDg5N2NkMTQ2Y2UiLCJpc3MiOiJvcGVuLWtleXMtaXRwLXYyIiwiYXpwIjoib3BlbmtleXNfNGE4M2ZkOTEtMWQ2Zi00ZTg2LTg0NDUtYWU1NWNkYjg4YjNkIiwic2NvcGUiOiJqb3VybmV5IiwiaWF0IjoxNzEwMzY3ODQxLCJleHAiOjIwNzA0Mjc4NDF9.VMobGtPbjCzwdL8HN2_26l-b4wg3Ci0P_K-TRpshiPY"
    },
    "journeySessionUrl": "http://localhost:9000?journeyId={journeyId}&id={id}&token={token}",
    "status": "PENDING",
    "statusHistory": [
      {
        "updatedAt": "2024-01-01T20:32:44.581Z",
        "status": "PENDING"
      }
    ],
    "journeySessionStageId": "f362a873-c127-4122-b711-a37b24a36914",
    "journeySessionStage": {
      "id": "f362a873-c127-4122-b711-a37b24a36914",
      "logs": [
        {
          "createdAt": "2024-01-01T20:32:44.581Z"
        }
      ]
    },
    "paymentInitiationId": "f362a873-c127-4122-b711-a37b24a36914",
    "paymentInitiationApi": "ENROLLMENTS_V2",
    "paymentInitiationData": {
      "loggedUser": {
        "document": {
          "identification": "11122233344",
          "rel": "CPF"
        }
      },
      "businessEntity": {
        "document": {
          "identification": "00000000000191",
          "rel": "CNPJ"
        }
      },
      "creditor": {
        "cpfCnpj": "12345678000199",
        "personType": "PESSOA_JURIDICA",
        "name": "João da Silva Santos"
      },
      "payment": {
        "type": "PIX",
        "schedule": {
          "single": {
            "date": "2023-08-23"
          },
          "daily": {
            "startDate": "2023-08-23"
          },
          "weekly": {
            "dayOfWeek": "QUINTA_FEIRA",
            "startDate": "2023-08-23"
          },
          "monthly": {
            "startDate": "2023-08-23"
          },
          "custom": {
            "additionalInformation": "Todas quintas e domingos por 6 meses"
          }
        },
        "date": "2024-03-05",
        "currency": "BRL",
        "amount": "1.12",
        "ibgeTownCode": "5300108",
        "details": {
          "localInstrument": "DICT",
          "qrCode": "\n\t\t\t\t\t\t  00020104141234567890123426660014BR.GOV.BCB.PIX014466756C616E6F32303139406578616D706C652E636F6D27300012\n\t\t\t\t\t\t  BR.COM.OUTRO011001234567895204000053039865406123.455802BR5915NOMEDORECEBEDOR6008BRASILIA61087007490062\n\t\t\t\t\t\t  530515RP12345678-201950300017BR.GOV.BCB.BRCODE01051.0.080450014BR.GOV.BCB.PIX0123PADRAO.URL.PIX/0123AB\n\t\t\t\t\t\t  CD81390012BR.COM.OUTRO01190123.ABCD.3456.WXYZ6304EB76",
          "proxy": "11223344556",
          "creditorAccount": {
            "accountType": "CACC",
            "ispb": "00000000",
            "issuer": "0001",
            "number": "0001234567"
          }
        }
      },
      "debtorAccount": {
        "accountType": "CACC",
        "ispb": "00000000",
        "issuer": "0001",
        "number": "0001234567"
      },
      "remittanceInformation": "Pagamento da nota XPTO035-002"
    }
  }
}