Efetuar Transferencia Assíncrona para Pix Manual

Request Manual

ENDPOINT

/account/ACCOUNT_KEY/alias/ALIAS_KEY/pix_transfer

MÉTODO

POST

Request Body

{
    "request_control_key": "6e290347-330d-4b3a-8ebb-2ac217ad6eb3",
    "pix_transfer_type": "manual",
    "target_account": {
      "account_branch": "0001",
      "account_digit": "1",
      "account_number": "2983779",
      "account_type": "checking_account",
      "ispb": "99999004",
      "owner_document_number": "36188081866",
      "owner_name": "USER PF LIMIT LEDGER",
      "owner_person_type": "natural"
    },
    "pix_message": "Bom dia", 
    "transaction_amount": 500.00,
    "schedule_date": "2021-08-04"
}

Body Param

Campo	Tipo	Descrição	Caracteres
request_control_key *	uuidv4	UUID4 para fins de consulta sobre a requisição feita.	36
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.	6
target_account *	Object	Conta destino - Só deve ser enviada em transações do tipo "manual".	Objeto target_account
pix_message	string	Mensagem opcional que acompanhará o Pix	140
transaction_amount *	float	Valor da transação realizada	20
schedule_date	date	Data de agendamento da transação (caso não seja enviado a transferência é realizada no momento da aprovação).	10

Objeto target_account

Campo	Tipo	Descrição	Caracteres
account_branch *	string	Agência.	4
account_digit *	string	Dígito da conta	1
account_number *	string	Número da conta.	8
owner_document_number *	string	CPF ou CNPJ (apenas números) do titular da conta.	14
owner_name *	string	Nome do titular da conta.	120
account_type *	string	Tipo de conta, podendo ser checking_account, deposit_account, guaranteed_account, investment_account, saving_account	20
owner_trading_name	string	Nome fantasia para pessoa jurídica. Usado somente para CNPJ	10
ispb *	string	Código de oito dígitos que identifica os bancos no sistema de transferência de reserva do Banco Central.	8

HTTP Status 202 Accepted

No pix assíncrono, toda transação retorna http status 202 Accepted, a solicitação de Pix não deve ser retentada. Neste cenário, a transação será efetuada oportunamente e será atualizada por meio do Webhook de Atualização de Transação. É possível ainda consultar o status da transação por meio do endpoint /account/ACCOUNT_KEY/alias/ALIAS_KEY/pix_transfer/PIX_TRANSFER_KEY.

Response

STATUS

202 Accepted

Response Body: Transferência manual

{
  "request_control_key": "6e290347-330d-4b3a-8ebb-2ac217ad6eb3",
  "pix_transfer_key": "8cb70dea-9fb0-4a68-9572-99a72849c8d6",
  "pix_transfer_status": "pending_confirmation",
  "created_at": "2021-10-22T20:30:23.459Z"
}

STATUS

400

Response Body

{
  "data": {
    "title": "Bad Request",
    "description": "Invalid request body.",
    "translation": "Corpo da requisição inválido.",
    "extra_fields": {},
    "code": "LEG000069"
  }
}