Sign in
Bank transaction

Dequeue one

Dequeues a bank transaction

patch/v1/banking/bank_transactions/{bank_transaction_id}/dequeue

Parameters

#/paths/~1v1~1banking~1bank_keys/get/parameters/0 — unresolved $ref
#/paths/~1v1~1banking~1bank_transactions~1%7Bbank_transaction_id%7D/get/parameters/1 — unresolved $ref

Request body

bank_key_idstring required

The id of the bank key to be used.

decline_motivestring required

motive to destroy/dequeue the transaction

sender_idstring uuid

The id of the bank account involved

Example request

{
  "bank_key_id": "47b93e3d-36a6-423a-acbe-c23b5484c3ed",
  "decline_motive": "wrong amount"
}

Response

The dequeue was accepted. If the transaction still exists (it was already sent to the bank), the dequeued transaction is returned. If the transaction was only queued and got removed as part of the dequeue, the body is instead {"message": "Transaction deleted"}.

OR

Changes

No recorded changes to this endpoint across all 1 revision of this API.