1. Bill Payment
Bankei BaaS Admin
  • Introduction
  • API Security and Authentication
  • Handling Monetary Values in Our System
  • Secure API Credential Exchange Process
  • Organization
    • Get Organization
      GET
  • Admin Account
    • Get Account Information
      GET
  • User
    • Create User - Basic
      POST
    • Get User
      GET
  • KYC
    • Request KYC Analisys - Company
      POST
    • Request KYC Analisys - Consumer
      POST
    • Send KYC Document
      POST
    • Get KYC Analisys Status
      GET
  • Account
    • Create Account
      POST
    • Get Account Balance
      GET
    • Get Account Transactions
      GET
    • Get Account Information
      GET
  • Transaction
    • Internal Transfer V2
      POST
  • Card
    • Get Card Groups
      GET
    • Create Nominated Card
      POST
    • Get Cards
      GET
    • Get Card Shipping
      GET
    • Activate Nominated Card
      POST
    • Temporary Disable Card
      POST
    • Enable Temporary Disable Card
      POST
    • Block Card
      POST
    • Get Card Sensitive Information
      GET
  • Pix
    • Generate Pix-In Static BR Code
    • Generate Pix-In Dynamic Cob BR Code
    • Generate Pix-In Dynamic CobV BR Code
    • Get Account Pix Keys
    • Generate Pix Key
  • Pix Out
    • Preview Pix BrCode Payment
    • Preview Pix Key Payment
    • Confirm Pix Payment
  • Bill Payment
    • Line vs. Barcode
    • Bill Payment Preview
      POST
    • Confirm Bill Payment
      POST
  • Invoice
    • Generate Invoice
  • Receipt
    • Get Transaction Receipt
  • Webhook
    • Bill Payment Webhook Events
    • Create Webhook Subscription
    • Dispatch Webhook Events
    • Get Webhook Subscriptions
    • Get Webhook Events
    • Get Webhook Send Attempts
    • Get Webhook Send Attempt Detail
    • Get Webhook Event Detail
    • Delete Webhook Subscription
  • Checking Account - Deprecated
    • Get Account Information
    • Get Account Balance
    • Create Checking Account
    • Get Account Transactions
  • Sandbox
    • Pay Pix BrCode [Sandbox Only]
    • Confirm Bill Payment [Sandbox Only]
    • Reject Bill Payment [Sandbox Only]
    • Approve Kyc Analisys [Sandbox Only]
  • Schemas
    • Account
    • Asset
    • Metadata
    • Address
    • Consumer
  1. Bill Payment

Confirm Bill Payment

POST
/api/account/payments/bill/confirm
Use this endpoint to create a bill payment.
Remember that in addition to the API key, you will need to sign the request. API Security and Authentication
You can enter any information you deem necessary in the metadata field, and use these fields later to track the payment.

Request

Authorization
Add parameter in header
x-api-key
Example:
x-api-key: ********************
Header Params

Body Params application/json

Examples

Responses

🟢200Success
application/json
Bodyapplication/json

Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://baas-api.np.bankei.com.br/api/account/payments/bill/confirm' \
--header 'x-signature: ' \
--header 'x-timestamp: ' \
--header 'x-endpoint: ' \
--header 'x-org-id: ' \
--header 'x-api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
    "accountIdentifier": "019cde23-d7f1-71f1-b496-45b4c0678431",
    "finalPayerTaxId": "392333226723737",
    "paymentToken": "F4qP9w3LYfLJjLhq6RnF7y",
    "description": "Pagamento de boleto",
    "amount": 20000,
  "metadata": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  }
}'
Response Response Example
{}
Modified at 2026-03-11 18:26:10
Previous
Bill Payment Preview
Next
Generate Invoice
Built with