Skip to content

Delete a deposit reference​

DELETE
/v2/wallet/fiat/{currency}/payment/references/{referenceCode}

Requires COLLECTIONS_DELETE, granted by COLLECTIONS_WRITE (bundles)

Deletes a deposit reference, so it no longer appears in your list or search results and can't be retrieved or updated. Deleted references don't count towards your maximum number of references.

Parameters​

Path Parameters

currency*

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

Type
string
Required
Example"ZAR"
referenceCode*

The reference code returned when the reference was created.

Type
string
Required
Example"VPAY-7K2Q9RT"

Responses​

No content

Samples​

Errors

HTTPErrorWhen
404-15114UNIQUE_DEPOSIT_REFERENCE_NOT_FOUNDNo reference with this code exists on your account.
503-15117UNIQUE_DEPOSIT_REFERENCES_FEATURE_DISABLEDDeposit references are temporarily unavailable.

Plus the errors common to all signed endpoints.