Preview reversing a transfer

Shows the records the reversal will delete or reverse: effects.deleted_records lists soft-deleted transfer bookings and any bank line Cybooks created as a counterpart; effects.reversed_records lists the original journal and lines whose amounts are reversed. effects.hidden_bank_transaction_ids identifies legacy counterparts hidden by soft undo. The commit also creates what the preview does not list: replacement bookings and a reversing journal, returned in its response; real bank lines are kept and go back to To review. Inspect these effects before committing with the returned confirmation_token and the same Idempotency-Key and actor. Requires the transfers:action OAuth scope.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Body Params

Proposed values used to preview reversing a transfer without persisting changes.

Headers
string
required
length ≤ 191

Required operation-specific request key. This requirement does not imply durable public API response replay.

Responses

Language
Credentials
OAuth2
Missing 1 required scope
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
*/*