Criando QRCode PIX
POST
https://api.valut.baas/banking/pix/qrcode
| property | type | required | description |
|---|---|---|---|
| amount | integer | yes | Valor para recebimento do PIX em centavos. |
| type | string | yes | Tipo do PIX: "dynamic" ou "static". |
| external_id | string | no | ID de referência. Utilizado para idenficação do PIX na sua plataforma. |
| expiration_date | datetime | no | Data de expiração do PIX. |
Observações: 1. Quando o expiration_datefor menor que o tempo atual, será considerado PIX com tempo de expiração padrão do banco.
| type | description | |
|---|---|---|
| pix_id | integer | Id do PIX. |
| type | string | Tipo do PIX: "dynamic" ou "static". |
| paid | bool | Flag para identificar o pagamento do PIX. |
| base64 | string | Imagem em BASE64 do QRCode PIX. |
| qrcode | string | QRCode PIX. Também conhecido como PIX Copia e Cola. |
| amount | integer | Valor em centavos; |
| expiration_date | datetime | Data de expiração do PIX. |
| created_at | datetime | Data de criação do PIX. |
Habilitando retorno da imagem PIX
O Campobase64funciona para facilitar o retorno do PIX, já retornando da API com a imagem para recebimento. Para habilitar essa funcionalidade deve enviar na QueryString o parâmetrowithImagecom o valortrue.Assim o response vai conter o campo base64, caso contrário esse campo será nulo.
Requisição
Parâmetros de Consulta
Parâmetros Bodyapplication/json
Respostas
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.valut.baas/banking/pix/qrcode?withImage=false' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
"amount": 62,
"type": "dynamic",
"external_id": "15f5170b-a64e-47a3-8727-6608305728b3",
"expiration_date": "2024-08-17 19:48:44"
}'Response Response Example
200 - Criando QRCode PIX - Criando QRCode PIX
{
"pix_id": "1112229912249ce869381ede361b7af",
"type": null,
"paid": false,
"base64": null,
"qrcode": "string",
"amount": 5049,
"expiration_date": "2022-01-12T14:50:35.0682132-03:00",
"created_at": "2022-01-12T14:50:35.2221029-03:00"
}Modificado em 2024-12-09 08:26:00