/gateway/pix/transfers - 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.

key

string

requerido

Chave pix de destino.

amount

number <double>

requerido

Valor da operação.

description

string | null

opcional

Descrição.

<= 140 Caracteres

schedule

string <date-time> | null

opcional

Data de agendamento.

Exemplo

{
    "reference": "string",
    "key": "string",
    "amount": 0,
    "description": "string",
    "schedule": "2019-08-24T14:15:22Z"
}

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/transfers' \
--header 'Authorization: Bearer {Token JWT}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "reference": "string",
    "key": "string",
    "amount": 0,
    "description": "string",
    "schedule": "2019-08-24T14:15:22Z"
}'

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

opcional

id

string | null

opcional

status

enum<string> | enum<null>

opcional

Valores permitidos:

pendingscheduledprocessingexecutedfailedpartially_refundedfully_refundedcanceled

amount

string | null

opcional

description

string | null

opcional

reference

string | null

opcional

createdDate

string <date-time> | null

opcional

message

string | null

opcional

Exemplo

{
    "alertas": [
        {
            "mensagem": "string",
            "tipo": 1
        }
    ],
    "erros": [
        {
            "mensagem": "string",
            "tipo": 1,
            "campoNome": "string",
            "elemento": "string"
        }
    ],
    "retorno": {
        "id": "string",
        "status": "pending",
        "amount": "string",
        "description": "string",
        "reference": "string",
        "createdDate": "2019-08-24T14:15:22Z",
        "message": "string"
    }
}