Agendar transferência Pix
Segue o mesmo princípio da transferência pix, tendo como principal diferença que deve ser enviado o schedule_date e nesse caso você receberá a schedule_key.
Request
ENDPOINT
/baas/pix_transferMÉTODO
POST- Manual
- Chave
Request Body: Transferência Manual
{
"pix_transfer_type": "manual",
"source_account": {
"account_branch": "0001",
"account_digit": "2",
"account_number": "2359934",
"owner_document_number": "09080702000105"
},
"schedule_date": "2023-08-24",
"target_account": {
"bank_code": "104",
"account_branch": "0001",
"account_digit": "4",
"account_number": "6717606",
"owner_document_number": "60744463000190",
"owner_name": "Qi Tech",
"account_type": "checking",
"ispb": "32402502"
},
"transaction_amount": 15
}
Response
STATUS
200Response Body: Transferência manual
{
"data": {
"operation_key": "8cb70dea-9fb0-4a68-9572-99a72849c8d6",
"status": "pending",
"event_datetime": "2021-08-04 20:05:54",
"pix_transfer_key": "8cb70dea-9fb0-4a68-9572-99a72849c8d6",
"pix_transaction": {
"pix_message": "",
"pix_transfer_key": "8cb70dea-9fb0-4a68-9572-99a72849c8d6",
"transaction_amount": 1891268.97,
"source_account": {
"account_branch": "0001",
"account_digit": "3",
"account_number": "24339",
"owner_document_number": "32402502000135",
"owner_name": "Qi Tech",
"account_type": "checking"
},
"target_account": {
"target_account": "78340-6",
"financial_institution_code": "329",
"owner_document_number": "32402502000135",
"owner_name": "QI Tech",
"target_account_type": "checking_account",
"owner_person_type": "legal",
"trading_name": "QITech"
},
"fee_amount": 0,
"schedule_date": "2020-08-04"
}
}
}
Request Body: Transferência Chave
{
"pix_transfer_type": "key",
"source_account": {
"account_branch": "0001",
"account_digit": "2",
"account_number": "2359934",
"owner_document_number": "09080702000105"
},
"schedule_date": "2023-08-24",
"end_to_end_id": "E32402502202308231745g1goFJ577mp",
"pix_key":"52720072800",
"target_account": {
"bank_code": "104",
"account_branch": "0001",
"account_digit": "4",
"account_number": "6717606",
"owner_document_number": "60744463000190",
"owner_name": "Qi Tech",
"ispb": "32402502"
},
"transaction_amount": 15
}
Response
STATUS
200Response Body: Transferência chave
{
"data": {
"end_to_end_id": "E32402502202308231825nkKhXiA9DEA",
"fee_amount": 1,
"pix_message": "",
"pix_transfer_key": "c32ad14a-6bfe-43f4-b5a1-4f335dcdd543",
"source_account": {
"account_brach": "0001",
"account_digit": "2",
"account_number": "2359934",
"account_type": "checking",
"owner_document_number": "09080702000105",
"owner_name": "VOVO LUCIA CONVENIENCIA LTDA"
},
"target_account": {
"document_number": "***.951.18*-**",
"financial_institution": "CAIXA ECONOMICA FEDERAL"
},
"transaction_amount": 15,
"transfer_purpose": "transfer"
},
"event_datetime": "2023-08-23 15:25:36",
"operation_key": "b37224f2-9a8c-4816-b446-acb213bfe5f0",
"schedule_key": "c32ad14a-6bfe-43f4-b5a1-4f335dcdd543",
"status": "pending_approval"
}
Body Params
| Campo | Tipo | Descrição | Caracteres |
|---|---|---|---|
pix_transfer_type * | string | O Pix possui diferentes tipos de iniciação, o "manual" onde o usuário deve enviar os campos da conta de destino e conta de origem e o "key" onde o usuário deve enviar os campos da chave Pix do recebedor (conta de destino) e os dados da conta de origem. | 10 |
source_account * | Object | Conta de origem. | Objeto source_account |
target_account | Object | Conta destino - Só deve ser enviada em transações do tipo "manual". | Objeto target_account |
transaction_amount * | string | Valor da transferencia. | 10 |
schedule_date | date | Data de agendamento da transação (caso não seja enviado a transferência é realizada no momento da aprovação). | 10 |
receiver_conciliation_id | string | Identicação de conciliação do recebedor. | 10 |
is_chargeback | string | Flag de identificação de uma devolução de transação Pix (booleano True ou False). | 10 |
requester_document_identification * | string | CPF do usuário quem está solicitando a transferência. | 10 |
pix_transfer_key | string | Chave de idempotência de uma transação Pix - só deve ser enviado se o tipo de transferência for "key". | 10 |
chargeback_amount | string | Valor da devolução - Este campo deve ser enviado apenas em caso de chargeback e exclui a obrigatoriedade do campo "transaction_amount". | 10 |
chargeback_other_reason | string | Motivo de devolução ( Este campo deve ser enviado apenas em caso de chargeback). | 10 |
chargeback_message | string | Campo para usuário inserir mensagem durante a devolução ( Este campo deve ser enviado apenas em caso de chargeback). | 10 |
Objeto source_account
| Campo | Tipo | Descrição | Caracteres |
|---|---|---|---|
account_branch * | string | Número Agência. | 0 |
branch_digit | string | Dígito da Agência. | 0 |
account_digit * | string | Dígito da conta. | 0 |
account_number * | string | Número da conta. | 0 |
owner_document_number * | string | CPF ou CNPJ (apenas números) do titular da conta. | 0 |
Objeto target_account
| Campo | Tipo | Descrição | Caracteres |
|---|---|---|---|
account_branch * | string | Agência. | 10 |
account_digit * | string | Dígito da conta | 10 |
account_number * | string | Número da conta. | 10 |
owner_document_number * | string | CPF ou CNPJ (apenas números) do titular da conta. | 10 |
owner_name * | string | Nome do titular da conta. | 10 |
account_type * | string | CPF ou CNPJ (apenas números) do titular da conta. | 10 |
trading_name | string | Nome fantasia para pessoa jurídica. | 10 |
ispb | string | Código de oito dígitos que identifica os bancos no sistema de transferência de reserva do Banco Central. | 10 |
Response
STATUS
400Response Body
{
"data": "{\"title\": \"Bad Request\", \"description\": \"Invalid request body.\", \"translation\": \"Corpo da requisição inválido.\", \"extra_fields\": {}, \"code\": \"LEG000069\"}"
}