Delete Transaction

delete

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

Delete a transaction in SCHEDULED or PENDING status. Once deleted, the transaction cannot be recovered.

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 reference ID or externalId for the program manager-assigned identifier.

Allowed:

customerId

string

required

Unique identifier of the customer. The value corresponds to the identifier type specified in parentIdType.

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 transaction. The value corresponds to the identifier type specified in idType.

Headers

PromiseMode

string

enum

required

This is a mandatory field, user must provide input either 'ALWAYS' or 'NEVER'. 'NEVER' - For immediate response, 'ALWAYS' - For later response.

Allowed:

Responses

202

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

400

The request could not be processed. Check for missing required fields, invalid values, or incorrect data formats.

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.

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

200The transaction was deleted successfully.