Bankei BaaS Admin
  1. Pix Out
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
      POST
    • Preview Pix Key Payment
      POST
    • Confirm Pix Payment
      POST
  • Bill Payment
    • Line vs. Barcode
    • Bill Payment Preview
    • Create Bill Payment
  • 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. Pix Out

Preview Pix Key Payment

Developing
POST
/api/account/pix-out/key/preview

Request

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

Body Params application/json

Examples

Responses

🟢200Success
application/json
Body

🟠401Unsupported signature algorithm
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://baas-api.np.bankei.com.br/api/account/pix-out/key/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 '{
    "AccountIdentifier": "string",
    "PixKey": "string"
}'
Response Response Example
200 - Example 1
{}
Modified at 2026-01-12 11:54:22
Previous
Preview Pix BrCode Payment
Next
Confirm Pix Payment
Built with