Esse endpoint permite a criação de uma solicitação para uma transação na conta escrow.
Essa transação poderá ser do tipo TED, PIX ou o pagamento de um boleto bancário.

Parâmetros da requisição

• accountId(string, obrigatório): ID único para identificação da conta de origem dos recursos da transação.

• amount(float, obrigatório): O valor total da transação para a solicitação.

• scheduledDate(datetime): A data de agendamento para processamento da solicitação.

• type(string, obrigatório): O tipo da transação que está sendo solicitada. Valores aceitos: TED, PIX e BOLETO.

• accountDestinationId(string): ID único para identificação da conta de destino dos recursos da transação.

• barCode(string): Código de barras do boleto bancário que está sendo pago. Campo de preenchimento obrigatório se tipo (type) for "BOLETO".

• billpaymentBeneficiary(string): O nome do beneficiário do boleto bancário. Campo de preenchimento obrigatório se tipo (type) for "BOLETO".

• billpaymentPayer(string): O nome do pagador do boleto bancário. Campo de preenchimento obrigatório se tipo (type) for "BOLETO".

• billpaymentTxnIdAuth(string): ID de autorização da transação gerada para o boleto bancário. Campo de preenchimento obrigatório se tipo (type) for "BOLETO". Esse ID é retornado pelo endpoint "GET - Consultar os detalhes de um código de barras de boleto".

• clientFinality(string, obrigatório): A finalidade que descreve a transação feita na solicitação. Possíveis valores: 1 - Pagamento de Impostos, Tributos e Taxas; 3 - Pagamentos de Dividendos; 4 - Pagamento de Salários; 5 - Pagamento de Fornecedores; 7 - Pagamento de Aluguéis e Taxas de Condomínio; 9 - Pagamento de Mensalidade Escolar; 10 - Crédito em Conta; 100 - Depósito Judicial; 110 - Transferência entre contas de mesma titularidade; 99999 - Outros

• description(string): Descrição, detalhamento sobre a solicitação de transação que está sendo realizada.

• automaticallyApprove(boolean): Campo do tipo boleano que indica se a solicitação que está sendo realizada deverá ser processada de forma automática ou não.

Resposta

Se a requisição for processada com sucesso será retornado um código 200 e um JSON no seguinte formato:

• id(string): ID para identificação da solicitação que foi criada na escrow.

Exemplo de JSON:

{
  "id": "string"
}

{
  "accountId": "<string>",
  "amount": "<number>",
  "scheduledDate": "<date>",
  "type": "BOLETO",
  "accountDestinationId": "<string>",
  "barCode": "<string>",
  "billpaymentBeneficiary": "<string>",
  "billpaymentPayer": "<string>",
  "billpaymentTxnIdAuth": "<string>",
  "clientFinality": "<string>",
  "description": "<string>",
  "automaticallyApprove": false
}