Skip to content

Unlink a deposit from its reference​

DELETE
/v2/wallet/fiat/{currency}/payment/deposits/{publicId}/reference

Requires COLLECTIONS_DELETE, granted by COLLECTIONS_WRITE (bundles)

Removes the link between a deposit and its reference. The deposit stays credited, but no longer counts as a matched deposit for any reference.

Parameters​

Path Parameters

currency*

Fiat currency of the deposits, e.g. ZAR.

Type
string
Required
Example"ZAR"
publicId*

The deposit's publicId.

Type
string
Required
Example"3f1c2a9e-8b4d-4c1e-9f2a-6d7e8b9c0a1b"
Format
"uuid"

Responses​

No content

Samples​

Errors

HTTPErrorWhen
400-11INVALID_REQUESTThe deposit ID isn't a valid UUID.
404-15118FIAT_DEPOSIT_NOT_FOUNDNo deposit with this ID exists on your collections account.

Plus the errors common to all signed endpoints.