Block External Account

post

https://sandbox-api.prioritycommerce.com/v1/passport/v1/customer/{parentIdType}/{customerId}/externalAccount/{idType}/{id}/block

Block an external account in ACTIVE or INACTIVE status by providing the appropriate reason.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

parentIdType

string

enum

required

Identifier type for the customer. Use 'id' for the Passport-assigned ID or 'externalId' for the program manager-assigned ID.

Allowed:

customerId

string

required

The customer identifier value, corresponding to the selected parentIdType.

idType

string

enum

required

Identifier type for the external account. Use 'id' for the Passport-assigned ID or 'externalId' for the program manager-assigned ID.

Allowed:

string

required

The external account identifier value, corresponding to the selected idType.

Body Params

Reason and optional comments for blocking the external account.

reason

string

enum

required

The reason for blocking the external account.

Allowed:

comments

string

Additional comments for the block action.

Headers

PromiseMode

string

enum

required

Controls response timing. NEVER returns an immediate response; ALWAYS defers processing.

Allowed:

Responses

202

The request has been accepted for processing. Expected when PromiseMode is ALWAYS.

299

The external account was blocked, but the action may impact transacting. Check the warning details.

400

The request could not be processed due to invalid or missing parameters.

401

The request lacks valid authentication credentials. Verify the API key and authorization header.

403

The authenticated user does not have permission to perform this operation.

500

An unexpected error occurred on the Passport server while processing the request.

Language

Credentials

Header

Loading…

Response

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

application/json

204The external account was blocked successfully. No content returned.