Bankei BaaS Admin
  1. Invoice
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
    • Create Bill Payment
  • Invoice
    • Generate Invoice
      POST
  • 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. Invoice

Generate Invoice

POST
/api/invoice
To issue invoices, you need an agreement code. If you want to use this feature, please contact our sales team.

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

🟠401Unsupported signature algorithm
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://baas-api.np.bankei.com.br/api/invoice' \
--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",
  "agreementCode": "string",
  "originalAmount": 0,
  "finalAmount": 0,
  "dueDate": "2025-08-08T19:38:58.152Z",
  "daysAfterExpiration": 0,
  "payer": {
    "taxId": "65664736887",
    "legalName": "João Silva",
    "email": "joao.silva@bankei.com.br",
    "phoneAreaCode": "11",
    "phoneNumber": "912341234",
    "address": {
      "postalCode": "13058769",
      "city": "Campinas",
      "neighborhood": "Residencial São Luís",
      "state": "SP",
      "streetName": "Rua Anderson Santos Rocha",
      "streetNumber": "930",
      "complement": null
    }
  },
  "metadata": {
    "UserId": "1234",
    "OtherInfo": "abc-xyz"
  }
}'
Response Response Example
200 - Success
{
    "invoice": {
        "id": "01989b8c-37cc-740a-a2cb-16d1805d3ad9",
        "accountId": "01972e60-6c33-7b79-8d05-d0e402b54172",
        "agreementId": "019881a9-ef11-7ec9-923c-ef4fa25f7cad",
        "originalAmount": 1589,
        "discountAmount": 0,
        "rebateAmount": 0,
        "latePaymentInterestAmount": 0,
        "finePenaltyAmount": 0,
        "finalAmount": 1589,
        "dueDate": "2025-08-30T03:00:00+00:00",
        "daysAfterExpiration": 30,
        "payer": {
            "taxId": "65664736887",
            "legalName": "João Silva",
            "email": "joao.silva@bankei.com.br",
            "phoneAreaCode": "11",
            "phoneNumber": "912341234",
            "address": {
                "postalCode": "13058769",
                "city": "Campinas",
                "neighborhood": "Residencial São Luís",
                "state": "SP",
                "streetName": "Rua Anderson Santos Rocha",
                "streetNumber": "930",
                "complement": null
            }
        },
        "metadata": {
            "UserId": "1234",
            "OtherInfo": "abc-xyz"
        },
        "txId": "573196fe-5908-43f7-8d0c-894756576dad",
        "barcode": "40698118900000015890001090150010104000667210",
        "line": "40690.00109 90150.010107 40006.672105 8 11890000001589",
        "pdf": "bankei-statics-cdn-hml::payments/invoice/01989b8c-37cc-740a-a2cb-16d1805d3ad9.pdf",
        "brCode": "00020101021226940014br.gov.bcb.pix2572qrcodes-h.accredito-scd.com.br/cobv/cf80820e-cd30-4914-922f-ee4e8010f1c35204000053039865802BR5925BANKEI SOLUCOES EM TECNOL6009Sao Paulo6107475702562070503***63049D9D",
        "status": "CREATED",
        "createdAt": "2025-08-11T23:51:54.5728804+00:00",
        "updatedAt": null
    },
    "signedPdf": {
        "name": "01989b8c-37cc-740a-a2cb-16d1805d3ad9.pdf",
        "resourceKey": "bankei-statics-cdn-hml::payments/invoice/01989b8c-37cc-740a-a2cb-16d1805d3ad9.pdf",
        "utcExpiration": "2025-08-12T00:51:56.4677937Z",
        "preSignedUrl": "https://bankei-statics-cdn-hml.s3.us-east-1.amazonaws.com/payments/invoice/01989b8c-37cc-740a-a2cb-16d1805d3ad9.pdf?X-Amz-Expires=3600&X-Amz-Security-Token=IQoJb3JpZ2luX2VjEMD%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaCXVzLWVhc3QtMSJHMEUCIF5Rc36WGGfnin0ZOtxs4Dq2MiwkUXKNDJsT42v0Sjg1AiEA72UzDPcqin%2BG%2BF24rhPSUSJr5edEttONi5sIqu9mPRkqpwMI%2Bf%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FARAAGgw0NDgwNDk4MDA1NDMiDPjUIDcUz38RlI3gpSr7AkcHFPdIDqMLx0LZz0bWDoqmUBJnfEmibd8D1sYOdaV1yfJ%2F76vq%2B5alBebDYbg%2FklcQPqXTKYt%2FHQBz169Geeo%2BuFGerMOVSO09MtGNZYKhrmd4z1dz%2Fj9RbDjmYCuRYJUIoEGAXUIIniD7NpKR9TdLsQamCxOR9XLlSVYQYFFI4TXIU6jjJkjI9j7U%2F46kOYPSsUUohpAwBfo1n5%2F2vtFSoOe%2FnRbr13vbqkkAtSBqJQmrZJj9P4Z5BwoNJn4D2CXZjyU2JNRT0JVS3gZ%2BkPKQTTJdTFKoaur9wE20qEd49UkAbFQ1DRaSupcju%2BVmstRVQSkCSruZnugYmfDtQpGNRncEcXhBhNx4AJIxoyzi9f07lEQWY9SSZ2H7cG%2FIfv3FmKRsdAzbkJgUlPnUZDkdHkCNvoknVdf1kfZtveWQ6M3Zbzkqn32v%2B4VY3TEgyMQZiUbvsa9raJGx31kCyo6Yg5069Z3TMUneSiDNyJElhLM3%2BZ7BQ2iCmS4wm4TqxAY6pgEzTyoPZGrRgbCItjHckL2UjONyFIqZ%2F57325nk2d6%2Bfj9HfwRxEhheGW%2Fskatx%2BWh2311fQ6WBajLpf%2BjSNG4NV2yHeT8Z%2Ba4KBMzQWkvxRZexYtkC%2B86DG2ezgzD6yaeNxlBpBJ6XUMczKezPljVCilom%2Ba9TuTbIaxpaLQnmOYIly%2FSwzFBjT1ENYb3ov2iM4qGd3gNeSZhRSJpcx6PLl%2FnLy%2Fsv&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASIAWQUOZMVPS7YCNQFH%2F20250811%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20250811T235156Z&X-Amz-SignedHeaders=host&X-Amz-Signature=9b48aa315b9c47ad545fd02b269ec25dba99863f6fd7c381df60be2363c5dc35"
    }
}
Modified at 2026-01-12 11:55:01
Previous
Create Bill Payment
Next
Get Transaction Receipt
Built with