Delete a customer account record

This synchronous operation deletes a customer account record from the Electrum account mirror. This is a permanent deletion.

Behaviour:

Electrum Account Mirror as Primary source of proxy data Electrum Account Mirror as Secondary source of proxy data Electrum Account Mirror deactivated
As per description. As per description. Not allowed
Request
header Parameters
traceparent
string (traceparent) ^[A-Fa-f0-9]{2}\-[A-Fa-f0-9]{32}\-[A-Fa-f0-9]...

A value used to trace an HTTP message within an Electrum Regulated Payments implementation. This field must be set as per the traceparent element defined in the (W3C Trace Context Level 2 specification (V2))[https://www.w3.org/TR/trace-context-2/].

tracestate
string (tracestate) ^[A-Za-z0-9=, _\*/@]{0,1024}$

A value used to provide context to an HTTP message as it is traced within an Electrum Regulated Payments implementation. This field must be set as per the traceparent element defined in the (W3C Trace Context Level 2 specification (V2))[https://www.w3.org/TR/trace-context-2/].

Request Body schema: application/json
namespace
string [ 1 .. 40 ] characters

An identifier's namespace provides a context for the identifier to distinguish different identifiers which may have the same value but be intended to identify different accounts. For example, a bank may use the same MSISDN (identifier) with different namespaces to distinguish between a customer's cheque or savings accounts.

This may be used by the following schemes:

  • ZA_RPP
schema
string

Indicates the schema of the identifier, e.g. MOBILE, CUSTOM.

value
required
string [ 1 .. 2048 ] characters
Responses
204

No content. RFC9110 - 204

400

Bad request. RFC9110 - 400

401

Unauthorized. RFC9110 - 401

403

Forbidden. RFC9110 - 403

404

Not Found. RFC9110 - 404

Indicates that the associated account cannot be found.

405

Method not allowed. RFC9110 - 405

429

Too Many Requests. RFC6585 - 429

500

Internal server error. RFC9110 - 500

503

Service unavailable. RFC9110 - 503

post/accounts/delete
Request samples
application/json
{
  • "namespace": "string",
  • "schema": "CUSTOM",
  • "value": "string"
}
Response samples
application/json
{
  • "detail": "string",
  • "message": "string",
  • "schema": "ErrorDetail"
}
Copyright © Electrum Payments (Pty) Ltd. 2019-2023. All right reserved.