Bankei BaaS Admin
  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
    • Get KYC Analisys Status
      GET
    • Request KYC Analisys - Consumer
      POST
    • Send KYC Document
      POST
  • Checking Account
    • Get Account Information
      GET
    • Get Account Balance
      GET
    • Create Checking Account
      POST
    • Get Account Transactions
      GET
  • 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
    • Create Bill Payment
      POST
  • Invoice
    • Generate Invoice
  • Receipt
    • Get Transaction Receipt
  • Webhook
    • Bill Payment Webhook Events
    • Create Webhook Subscription
    • Get Webhook Subscriptions
    • Delete Webhook Subscription
    • Get Webhook Events
    • Get Webhook Event Detail
    • Get Webhook Send Attempts
    • Get Webhook Send Attempt Detail
    • Dispatch Webhook Events
  • 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

Bill Payment Preview

POST
/api/account/payments/bill/preview
Use this endpoint to get information of a bill payment
Remember that in addition to the API key, you will need to sign the request. API Security and Authentication

Request

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

Body Params application/json

Examples

Responses

🟢200OK
application/json
Body

Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://baas-api.np.bankei.com.br/api/account/payments/bill/preview' \
--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-raw '{
  "line": "string",
  "barCode": "string"
}'
Response Response Example
{"paymentToken":"5992427F3C19415DB3FB4F227702D163DAABCCA0DEAD430080505C7225E40C009552D57AD654449C87CD0C540A3AC46A0CACB5673B454E92AE63E20EBFE25334","type":"Sanitation","data":{"line":"826000000008743900970919095587510389000045845732","barCode":"82600000000743900970910955875103800004584573","taxId":null,"receiverName":"SABESP","receiverBankNumber":null,"receiverBankName":null,"expiration":"2025-06-24T00:00:00","amount":7439,"discountAmount":0,"rebateAmount":0,"bonusAmount":0,"latePaymentInterestAmount":0,"finePenaltyAmount":0,"finalAmount":7439,"billPaymentType":"Sanitation","description":"Água e Esgoto"}}
Modified at 2026-01-12 11:54:43
Previous
Line vs. Barcode
Next
Create Bill Payment
Built with