Close an Account

post

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

Initiate closure of an active account. Once closed, the account will no longer process transactions and must be deleted separately if removal is needed.

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.

Body Params

Account closure request details.

outstandingBalanceInstruction

object

required

Details for moving the balance amount.

reason

string

required

Reason for initiating account closure.

comment

string

Reason(s) for initiating account closure, other than the ones provided by system.

cancelUnprocessedSchedules

boolean

Instruction to cancel unprocessed schedules.

Headers

PromiseMode

string

enum

required

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

Allowed:

Responses

200

Request completed successfully as expected.

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!