Cadastrar agendamento de um Pix

POST

/api/Pix/CadastrarAgendamento

Pix

Funcionalidade principal

O endpoint CadastrarAgendamento permite que o usuário programe uma transferência Pix para uma data futura. O sistema reserva os dados da transação e, na data agendada, o motor de pagamentos tenta realizar a liquidação, desde que haja saldo disponível na conta no momento da execução.

Casos de uso comuns

Pagamento de aluguel ou prestação: O usuário agenda o envio do valor para o dia exato do vencimento, evitando esquecimentos e multas.

Mesada ou repasse fixo: Programação de transferências para familiares ou dependentes em datas específicas.

Gestão de fluxo de caixa: Empresas que agendam pagamentos a fornecedores para datas de vencimento futuras.

Requisição

Authorization

Adicionar o parâmetro

Authorization

a Cabeçalhos, cujo valor é concatenar o Token após o Bearer.

Exemplo:

Authorization: Bearer ********************

Parâmetros Header

Parâmetros Bodyapplication/jsonNecessário

Examples

Respostas

🟢200Correto

application/json

Bodyapplication/json

Request Example

Shell

JavaScript

Java

Swift

curl --location '/api/Pix/CadastrarAgendamento' \
--header 'UserName;' \
--header 'RequestOrigin;' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "Data": {
        "CodigoCanal": 0,
        "CodigoCliente": 0,
        "Valor": 0,
        "DataAgendada": "string",
        "TipoPessoa": "Fisica",
        "TipoPagamento": 0,
        "PagamentoBanco": {
            "NomeRazaoSocial": "string",
            "CpfCnpj": 0,
            "Banco": 0,
            "Agencia": "stri",
            "NumeroConta": "string",
            "TipoConta": 0
        },
        "Tipokey": "CPF",
        "Key": "string",
        "TextoQrCode": "string",
        "InfoEntreUsuarios": "string",
        "IdentificadorExterno": "string",
        "KeyOwnerCpfCnpj": "string",
        "KeyOwnerName": "string"
    }
}'

Response Example

{
    "Data": {
        "IdComprovante": 0,
        "IdAgendamento": 0
    },
    "ResultCode": 0,
    "Message": "string",
    "ValidationData": {
        "ResultCode": 0,
        "Message": "string",
        "Errors": [
            {
                "ErrorMessage": "string",
                "FieldName": "string"
            }
        ]
    }
}

Modificado em 2026-03-03 15:13:48

Página anterior

Consultar Pix por lote ou identificador

Próxima página

Cadastrar novo favorecido para Pix

Cadastrar agendamento de um Pix

Funcionalidade principal#

Casos de uso comuns#

Requisição

Respostas

Funcionalidade principal

Casos de uso comuns