Generate Pix Key

POST

/api/account/pix/key

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

🟢200OK

application/json

Body

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://baas-api.np.bankei.com.br/api/account/pix/key' \
--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 '{
  "account": "",
  "type": "EVP"
}'

Response Example

{
    "id": "0196eab2-2cb6-7230-942f-04e3859a2a93",
    "brCode": "00020101021226580014BR.GOV.BCB.PIX01360196e657-b494-77cd-9629-2a1a65eb357c520400005303986540510.855802BR5925SOULPRIME TECNOLOGIA LTDA6009SAO PAULO6230052601JVNB4B5P65ZE008C52WY40BK6304D6B7",
    "pixKey": "0196e657-b494-77cd-9629-2a1a65eb357c",
    "amount": 1085,
    "accountId": "0196e5ed-f9e6-71e1-b647-c19aca14bae8",
    "txId": "01JVNB4B5P65ZE008C52WY40BK",
    "metadata": {
        "external_trx_id": "105236",
        "external_user_id": "1234"
    },
    "createdAt": "2025-05-19T22:37:47.5744615Z",
    "updatedAt": null
}

Modified at 2026-01-12 11:54:00

Get Account Pix Keys

Preview Pix BrCode Payment