Stop a Transaction

post

https://sandbox-api.prioritycommerce.com/v1/passport/v1/transaction/{idType}/{id}/stop

Stop a CHECK transaction that is already in PROCESSING, IN_DELIVERY, or DELIVERED status — for example when a check is lost or was sent for the wrong amount.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

idType

string

enum

required

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

Allowed:

string

required

Unique identifier of the CHECK transaction to stop.

Body Params

Stop request details including reason and optional comment.

reason

string

enum

required

Reason for stopping the check.

Allowed:

comment

string

Additional comment. Required when reason is OTHERS.

Headers

PromiseMode

string

enum

required

Controls response timing. Use NEVER for an immediate synchronous response or ALWAYS for asynchronous processing.

Allowed:

Responses

204

Stop request accepted. The check transaction will be halted.

400

The request could not be processed. The transaction may not be a CHECK or may not be in a stoppable status.

401

Authentication failed. Verify that the Authorization header contains a valid Bearer token.

403

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

404

The requested transaction was not found.

500

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