Delete an account

delete

https://sandbox-api.prioritycommerce.com/v1/passport/v1/customer/{parentIdType}/{id}/account/{idType}/{accountId}

Permanently delete an account in INACTIVE status. Active accounts must first be closed before they can be deleted.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

parentIdType

string

enum

required

Identifier type for the parent entity. Use id for the Passport-assigned reference ID or externalId for the program manager-assigned identifier.

Allowed:

string

required

The customer's Passport-assigned ID or program manager-assigned external ID, based on the selected parentIdType.

idType

string

enum

required

Identifier type for the entity. Use id for the Passport-assigned reference ID or externalId for the program manager-assigned identifier.

Allowed:

accountId

string

required

The account's Passport-assigned ID or program manager-assigned external ID, based on the selected idType.

Headers

PromiseMode

string

enum

required

Required. Set to NEVER for a synchronous response or ALWAYS for asynchronous processing.

Allowed:

Responses

202

The request has been accepted for processing, but the processing has not been completed. The request might or might not be eventually acted upon, and may be disallowed when processing occurs. Expected for all requests with Promise Mode as ALWAYS.

400

The request could not be accepted by the Passport server due to a malformed syntax, which may be a missing required parameter or other syntactical error.

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200The Passport server successfully processed the request and the resource has been deleted.