Atualizar Ordem de Pagamento na Solicitação

Esse endpoint permite a atualização dos dados bancários do beneficiário para uma determinada Solicitação.

Parâmetros da URL

• application_id:ID da solicitação a ser consultada.

• payment_order_id: ID da ordem de pagamento associada a Solicitação.

Parâmetros da Requisição

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

Resposta

Se a requisição for processada com sucesso será retornado um status 200 com os dados detalhados da solicitação alterada.

Exemplo de JSON:

{
    "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": "TRAN",
            "ispb_code": ""
        },
        "pix": {
            "key": "",
            "key_type": "EMAIL"
        },
        "baas": {
            "account_number": ""
        }
    },
    "beneficiary_type": "EXTERNAL_UNREGISTERED_ACCOUNT"
}