Agendar transferência

Use este endpoint para agendar uma transferência financeira.

curl --location --request POST 'https://horizon-api-sb.app.rpe.tech/api/v1/pixcard/transferencias/agendamento' \ --header 'Accept: */*' \ --header 'Authorization: Bearer eyJhbGciOiJIUzUxMiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIwZDI1NmI2MS03Y2RhLTQ5MzItYjVmNS1hZGIxOGUyNzc3MDQifQ.eyJleHAiOjE3NDI1ODE3NTMsImlhdCI6MTc0MjU2Mzc1MywianRpIjoiMDljMmMwMWUtNmMyNS00NTg5LWIyODUtZGZlMzIxZjUzZDhlIiwiaXNzIjoiaHR0cDovL3ZwYy1saW5rLXNiLmFwcC5ycGUudGVjaC9yZWFsbXMvcnBlIiwic3ViIjoiNGY2YmM0ZTgtMTRjYi00YmU4LWI4M2MtOWNiMTNhM2NiOWQwIiwidHlwIjoiQmVhcmVyIiwiYXpwIjoicnBlY2xpZW50Iiwic2Vzc2lvbl9zdGF0ZSI6IjEzMWY5OWNjLWQ1ZjgtNDYzYS1hMDdmLWM0MDYwOTNkYjdjZCIsInNjb3BlIjoicHJvZmlsZSIsInNpZCI6IjEzMWY5OWNjLWQ1ZjgtNDYzYS1hMDdmLWM0MDYwOTNkYjdjZCIsImlzc3VlcmlkIjoxLCJyb2xlcyI6WyJST0xFX1NJU1RFTUEiLCJST0xFX1BBQ09URV9TTVNfQ09OU1VMVEFfTElTVEEiLCJST0xFX0NPTlNVTFRBUl9QT1JUQURPUiIsIlJPTEVfQ0FSVE9FU19BRE1JTiIsIlJPTEVfdGVzdGUtcm9sZSIsIlJPTEVfUEFDT1RFX1NNU19DT05TVUxUQV9QQUNPVEVTX0RJU1BPTklWRUlTIiwiUk9MRV9QQUNPVEVfU01TX0FMVEVSQUNBT19SRUNFQkVfQk9OVVNfQ0VMVUxBUiIsIlJPTEVfdW1hX3Byb3RlY3Rpb24iLCJST0xFX1BBQ09URV9TTVNfQ0FEQVNUUk9fQ09OVFJBVEFDQU9fUEFDT1RFIiwiUk9MRV9QQUNPVEVfU01TX0NBREFTVFJPX0NFTFVMQVJfU01TIiwiUk9MRV9QQUNPVEVfU01TX0NPTlNVTFRBX1BBQ09URVNfQ09OVFJBVEFET1MiLCJST0xFX0FETUlOIiwiUk9MRV9QQUNPVEVfU01TX1JFTU9DQU9fUEFDT1RFIl0sInVzZXJuYW1lIjoicnBlLXNhbmRib3gifQ.DtxNXDEFD4R7hP8XusdDNqGNvI2_NtwR5tZAjbYYEb2SWSANiPx8kRLMzVcqkvCWf57PqEAIEO6uQN9mbcYBwQ' \ --header 'Content-Type: application/json' \ --data-raw '{ "idAccount": 1634554, "transferType": 0, "payee": { "ispb": 12345678, "bankAccountNumber": "1634554", "bankBranchNumber": "2020", "bankAccountType": "CC", "beneficiaryType": "F", "nationalRegistration": "03967703045", "payeeName": "Akato Santos", "key": "seiyadepegaso@deathena.com.br" }, "finalAmount": 1000, "payerAnswer": "Campo para preenchimento", "idTx": "DOCK20200103002166189523", "schedulingDate": "2020-12-14T12:05:39.502Z", "idEndToEnd": "58D5E212165B4CA0909BC86B9CEE0112" }'

{ "idEndToEnd": "58D5E212165B4CA0909BC86B9CEE0112", "schedulingCode": "123fert343412", "schedulingDate": "2024-12-14T12:05:39.502Z", "createDate": "2023-12-14T12:05:39.502Z", "status": "SCHEDULED ", "amount": 1000, "payeeName": "Luigi Bros" }

Requisição

Authorization

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

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

Parâmetros Header

string

requerido

Tipo de conteúdo aceito.

Exemplo:

*/*

Content-Type

string

opcional

Tipo de mídia do corpo da solicitação.

Exemplo:

application/json

Authorization

string

opcional

Header HTTP utilizado para autenticação do cliente. O valor deve ser um token JWT válido precedido do prefixo Bearer

Exemplo:

Bearer eyJhbGciOiJIUzUxMiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIwZDI1NmI2MS03Y2RhLTQ5MzItYjVmNS1hZGIxOGUyNzc3MDQifQ.eyJleHAiOjE3NDI1ODE3NTMsImlhdCI6MTc0MjU2Mzc1MywianRpIjoiMDljMmMwMWUtNmMyNS00NTg5LWIyODUtZGZlMzIxZjUzZDhlIiwiaXNzIjoiaHR0cDovL3ZwYy1saW5rLXNiLmFwcC5ycGUudGVjaC9yZWFsbXMvcnBlIiwic3ViIjoiNGY2YmM0ZTgtMTRjYi00YmU4LWI4M2MtOWNiMTNhM2NiOWQwIiwidHlwIjoiQmVhcmVyIiwiYXpwIjoicnBlY2xpZW50Iiwic2Vzc2lvbl9zdGF0ZSI6IjEzMWY5OWNjLWQ1ZjgtNDYzYS1hMDdmLWM0MDYwOTNkYjdjZCIsInNjb3BlIjoicHJvZmlsZSIsInNpZCI6IjEzMWY5OWNjLWQ1ZjgtNDYzYS1hMDdmLWM0MDYwOTNkYjdjZCIsImlzc3VlcmlkIjoxLCJyb2xlcyI6WyJST0xFX1NJU1RFTUEiLCJST0xFX1BBQ09URV9TTVNfQ09OU1VMVEFfTElTVEEiLCJST0xFX0NPTlNVTFRBUl9QT1JUQURPUiIsIlJPTEVfQ0FSVE9FU19BRE1JTiIsIlJPTEVfdGVzdGUtcm9sZSIsIlJPTEVfUEFDT1RFX1NNU19DT05TVUxUQV9QQUNPVEVTX0RJU1BPTklWRUlTIiwiUk9MRV9QQUNPVEVfU01TX0FMVEVSQUNBT19SRUNFQkVfQk9OVVNfQ0VMVUxBUiIsIlJPTEVfdW1hX3Byb3RlY3Rpb24iLCJST0xFX1BBQ09URV9TTVNfQ0FEQVNUUk9fQ09OVFJBVEFDQU9fUEFDT1RFIiwiUk9MRV9QQUNPVEVfU01TX0NBREFTVFJPX0NFTFVMQVJfU01TIiwiUk9MRV9QQUNPVEVfU01TX0NPTlNVTFRBX1BBQ09URVNfQ09OVFJBVEFET1MiLCJST0xFX0FETUlOIiwiUk9MRV9QQUNPVEVfU01TX1JFTU9DQU9fUEFDT1RFIl0sInVzZXJuYW1lIjoicnBlLXNhbmRib3gifQ.DtxNXDEFD4R7hP8XusdDNqGNvI2_NtwR5tZAjbYYEb2SWSANiPx8kRLMzVcqkvCWf57PqEAIEO6uQN9mbcYBwQ

Parâmetros Bodyapplication/json

idAccount

integer <int32>

requerido

Identificador da conta.

<= 14

Exemplo:

1634554

transferType

integer <int32>

requerido

Tipo de transferência.

0 = Manual

1 = Chave Pix

2 = QR Code estático

3 = QR Code dinâmico

Exemplo:

payee

object

requerido

Informações do beneficiário.

ispb

integer <int32>

requerido

Identificador de Sistema de Pagamentos Brasileiro.

<= 8

Exemplo:

12345678

bankAccountNumber

string

requerido

Número da conta bancária.

>= 1 Caracteres<= 20 Caracteres

Exemplo:

1634554

bankBranchNumber

string

opcional

Número da agência bancária.

>= 1 Caracteres<= 4 Caracteres

Exemplo:

2020

bankAccountType

enum<string>

requerido

Tipo da conta bancária.

CC = conta corrente

PA = conta de pagamento

SA = conta poupança

Valores permitidos:

CCPASA

Exemplo:

beneficiaryType

enum<string>

requerido

Tipo do beneficiário.

F = CPF

J = CNPJ

Valores permitidos:

Exemplo:

nationalRegistration

string

requerido

Número do documento de registro, a depender do campo beneficiaryType.

>= 11 Caracteres<= 14 Caracteres

Exemplo:

03967703045

payeeName

string

requerido

Nome do beneficiário.

<= 100 Caracteres

Exemplo:

Akato Santos

key

string

requerido

Chave utilizada na transferência.

<= 77 Caracteres

Exemplo:

seiyadepegaso@deathena.com.br

finalAmount

number

opcional

Valor final da transferência, incluindo taxas, juros e descontos.

<= 10

Exemplo:

1000

payerAnswer

string

opcional

Campo aberto para informações adicionais.

Exemplo:

Campo para preenchimento

idTx

string

opcional

Identificador para conciliação bancária.

>= 25 Caracteres<= 35 Caracteres

Exemplo:

DOCK20200103002166189523

schedulingDate

string <date-time>

opcional

Data do agendamento, no formato yyyy-MM-dd'T'HH.

Exemplo:

2020-12-14T12:05:39.502Z

idEndToEnd

string

opcional

Identificador end-to-end desta transação.

<= 32 Caracteres

Exemplo:

58D5E212165B4CA0909BC86B9CEE0112

Examples

Respostas

🟢201Criado

application/json

Sucesso

Body

idEndToEnd

string

opcional

Identificador end-to-end da transação.

<= 32 Caracteres

Exemplo:

58D5E212165B4CA0909BC86B9CEE0112

schedulingCode

string

opcional

Código do agendamento.

Exemplo:

123fert343412

schedulingDate

string <date-time>

opcional

Data do agendamento, no formato yyyy-MM-dd'T'HH.

Exemplo:

2024-12-14T12:05:39.502Z

createDate

string <date-time>

opcional

Data de criação da solicitação para agendamento do Pix.

Exemplo:

2023-12-14T12:05:39.502Z

status

enum<string>

opcional

Status da requisição de agendamento.

SCHEDULED = Agendada

CANCELLED = Cancelada

SCHEDULED_EXECUTED = Agendada e executada

FAILED = Falha

Valores permitidos:

SCHEDULED CANCELLED SCHEDULED_EXECUTED FAILED

Exemplo:

SCHEDULED

amount

integer <int32>

opcional

Valor total a ser transferido, inclundo taxas, descontos e juros.

<= 10

Exemplo:

1000

payeeName

string

opcional

Nome do beneficiário.

<= 100 Caracteres

Exemplo:

Luigi Bros

🟠400Pedido inválido

🟠401Não autorizado

🟠403Proibido

🟠404Registro não encontrado

🔴500Erro do servidor