Cancelar Operações em Lote


Este endpoint realiza o cancelamento em lote operações pendentes de aprovação e/ou operações agendadas para uma conta.

POST https://sandbox-api.openbank.stone.com.br/api/v1/accounts/{account_id}/operations/actions/cancel

Existem 2 ações possíveis nessa API:

  • cancel_only: cancela apenas as operações passadas no campo operations
  • cancel_all_except cancela todas as operações dessa conta exceto as passadas na lista operations

Esta API tem um limite de 1000 operações na lista.

Tipos de operações que podem ser canceladas:

  • external_transfer (TED)
  • internal_transfer (Pagamento Interno)
  • barcode_payment (Pagamento de Boleto)
  • pix_payment (Pix)(Beta)
  • refund_for_pix_payment (Devolução de um Pix)

HEADERS

x-stone-idempotency-key string
Chave de idempotência

authorization string
Bearer Token

User-Agent string
Nome da sua aplicacão


QUERY PARAMS

account_id string
Identificador da conta


BODY PARAMS


action string

operations list

operations
Dados das operações
    id string
    type string


- Para cancelar um pagamento Pix

{
  "action": "cancel_only",
  "operations": [{
      "id": "b14bd4ba-4476-43ef-baf6-58c8524830b3/",
      "type": "pix_payment"
  }]
}



Response

202 ACCEPTED
content-type: application/json

Body

{
  "number_of_cancellations": 1
}


Última modificação: 13.01.2022