Iniciar uma nova tentativa de Desembolso

Esse endpoint permite a realização de uma tentativa de desembolso.

Parâmetros da URL

• application_id:ID da solicitação a ter uma tentativa de desembolso.
  

Parâmetros da Requisição

Não é necessário o envio de nenhum dado no corpo da requisição.

Resposta

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

• id (string/uuid v4): Identificador da requisição para tentativa de desembolso.
  
• status (string): Status da requisição.
  
• status_description (string): Descrição do status.
  
• payment_orders (object): Objeto contendo uma lista das ordens de pagamentos.
  
• requested_at (datetime): Data de envio da requisição
  
• processed_at (datetime): Data de processamento da requisição.
  
• created_at (datetime): Data da criação da tentativa de desembolso.
  
• updated_at (datetime): Data da última atualização realizada.
  
• version (int): Número de versionamento do registro da tentativa de desembolso.
  

Objeto "payment_orders"

• id (string/uuid v4): Identificador único da ordem de pagamento.
  
• amount (float): Valor a ser pago.
  
• type (string): Tipo da ordem de pagamento. Possíveis valores: PIX_OUT.
  
• status (string): Status do processamento da ordem de pagamento. Possíveis valores: READY_FOR_PROCESSING, ERROR.
  
• beneficiary_account (objeto): Objeto com os dados da conta bancária do beneficiário.
  

Objeto "beneficiary_account"

• registered_account_id: ID da conta registrada.
  
• holder -> name: Nome da carteira.
  
• holder -> taxpayer_id: Número do documento do operador da carteira.
  
• external_bank_account: Objeto contendo os dados da conta bancária para depósito.
  

Objeto "external_bank_account"

• bank_code (string): Código do banco.
  
• bank_account (string): Número da conta
  
• bank_account_digit (string): Dígito do número da conta.
  
• bank_branch (string): Número da agência.
  
• bank_account_type (string): Tipo da conta bancária.
  
• ispb_code (string): Código ISPB relacionado ao banco da conta informada.
  
• pix (object): Objeto contendo os dados de uma chave PIX.
  
• pix -> key (string): Chave PIX.
  
• pix -> key_type (string): Tipo da chave PIX. Valores aceitos: ALEATORY_KEY, EMAIL, PHONE_NUMBER, TAXPAYER_ID
  
• baas -> account_number: Número da conta bancária no baas
  

Exemplo de JSON:

{
  "id": "",
  "status": "ERROR",
  "status_description": "",
  "payment_orders": [
    {
      "id": "",
      "amount": "",
      "type": "PIX_OUT",
      "status": "READY_FOR_PROCESSING",
      "beneficiary_account": {
        "registered_account_id": "",
        "holder": {
          "name": "",
          "taxpayer_id": ""
        },
        "external_bank_account": {
          "bank_account": "",
          "bank_account_digit": "",
          "bank_branch": "",
          "bank_code": "",
          "bank_account_type": "SVGS",
          "ispb_code": ""
        },
        "pix": {
          "key": "",
          "key_type": "ALEATORY_KEY"
        },
        "baas": {
          "account_number": ""
        }
      },
      "beneficiary_type": "EXTERNAL_UNREGISTERED_ACCOUNT"
    },
    {
      "id": "",
      "amount": "",
      "type": "PIX_OUT",
      "status": "ERROR",
      "beneficiary_account": {
        "registered_account_id": "",
        "holder": {
          "name": "",
          "taxpayer_id": ""
        },
        "external_bank_account": {
          "bank_account": "",
          "bank_account_digit": "",
          "bank_branch": "",
          "bank_code": "",
          "bank_account_type": "CACC",
          "ispb_code": ""
        },
        "pix": {
          "key": "",
          "key_type": "EMAIL"
        },
        "baas": {
          "account_number": ""
        }
      },
      "beneficiary_type": "EXTERNAL_REGISTERED_ACCOUNT"
    }
  ],
  "requested_at": "",
  "processed_at": "",
  "application_managed_account_for_issuer_disbursement": {
    "baas": {
      "account_number": "",
      "holder_type": "PERSON"
    },
    "product_configuration": {
      "if_existing": "REUSE",
      "type": "BORROWER_ACOUNT_FOR_ORIGINATOR"
    }
  },
  "created_at": "",
  "updated_at": "",
  "version": ""
}