/gateway/pix/qr-codes/dynamic - Preâmbulo Bank Conta Digital

Requisição

Parâmetros Header

Authorization

string

requerido

Exemplo:

Bearer {Token JWT}

Parâmetros Bodyapplication/json

reference

string

requerido

Código de controle interno do cliente.

<= 50 Caracteres

key

string | null

opcional

Chave Pix vinculada a conta, caso não informada será utilizada a chave informada no cadastro do usuário.

<= 77 Caracteres

amount

number <double>

requerido

Valor da operação.

dueDate

string <date-time>

requerido

Data de expiração da operação.

limitDays

integer <int32>

requerido

Este campo representa a data limite de pagamento, ou seja depois de quantos dias de vencimento ainda pode-se pagar.

>= 1

payer

object

requerido

Objeto com os dados do pagador.

name

string

requerido

Nome do pagador.

document

string

requerido

Documento (CPF ou CNPJ).

question

string | null

opcional

A mensagem enviada pelo pagador na liquidação do QR Code.

detail

object

requerido

Objeto com os detalhes sobre a transação.

title

string

requerido

Titulo da transação.

<= 50 Caracteres

content

string

requerido

Comentário da transação.

<= 200 Caracteres

Exemplo

{
    "reference": "string",
    "key": "string",
    "amount": 0,
    "dueDate": "2019-08-24T14:15:22Z",
    "limitDays": 1,
    "payer": {
        "name": "string",
        "document": "string",
        "question": "string"
    },
    "detail": {
        "title": "string",
        "content": "string"
    }
}

Exemplos de Requisição

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://api.contadigital.preambulobank.com.br/gateway/pix/qr-codes/dynamic' \
--header 'Authorization: Bearer {Token JWT}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "reference": "string",
    "key": "string",
    "amount": 0,
    "dueDate": "2019-08-24T14:15:22Z",
    "limitDays": 1,
    "payer": {
        "name": "string",
        "document": "string",
        "question": "string"
    },
    "detail": {
        "title": "string",
        "content": "string"
    }
}'

Respostas

🟢200Success

application/json

Body

alertas

array[object (IMensagemBase) {2}] | null

opcional

mensagem

string | null

opcional

tipo

enum<integer> <int32>

opcional

Valores permitidos:

123456789

erros

array[object (IMensagemErro) {4}] | null

opcional

mensagem

string | null

opcional

tipo

enum<integer> <int32>

opcional

Valores permitidos:

123456789

campoNome

string | null

opcional

elemento

string | null

opcional

retorno

object (GatewayResponsePixQrcodesDynamicDto)

opcional

emv

string | null

opcional

text

string | null

opcional

image

string | null

opcional

payloadURL

string | null

opcional

idDocument

string | null

opcional

createdDate

string <date-time> | null

opcional

reference

string | null

opcional

message

string | null

opcional

Exemplo

{
    "alertas": [
        {
            "mensagem": "string",
            "tipo": 1
        }
    ],
    "erros": [
        {
            "mensagem": "string",
            "tipo": 1,
            "campoNome": "string",
            "elemento": "string"
        }
    ],
    "retorno": {
        "emv": "string",
        "text": "string",
        "image": "string",
        "payloadURL": "string",
        "idDocument": "string",
        "createdDate": "2019-08-24T14:15:22Z",
        "reference": "string",
        "message": "string"
    }
}