Sandbox
Cancel a bulk deposit (preview)
Cancels a bulk deposit as a whole, with every deposit order it created, as long as no wire has funded it. A funded bulk deposit cannot be canceled, and its deposit orders cannot be canceled one by one. A wire quoting a canceled bulk deposit is returned to its sender. Preview available in the sandbox environment only; its contract may still change.
post/v0/sandbox/bulk-deposits/{paymentEntryId}/cancel
Request
- Base URLhttps://distributor-api.spiko.io
- AuthHTTP basic
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
paymentEntryIdstring uuid required
a Universally Unique Identifier
Response
Bulk deposit canceled
Changes
No recorded changes to this operation across all 4 revisions of this API.