Update Transaction

post

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

Update a transaction in SCHEDULED or PENDING status. Supports modifying amount, purpose, processing details, and linked documents.

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.

Body Params

Details required to update the transaction.

externalId

string

Reference ID assigned by the program manager.

comment

string

Comments passed by the user.

amount

float

The dollar value of the transaction. Must be greater than zero.

purpose

string

Purpose of the transaction.

allowDuplicate

boolean

Confirmation to allow creation of a duplicate transaction.

linkedSchedule

object

processingDetail

object

linkedDocument

array of objects

Authorization documents linked to the transaction.

linkedDocument

tags

string

Labels or tags assigned to the transaction.

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.

299

The transaction was updated successfully, but the action may impact transacting. Check the warning details.

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

204The transaction was updated successfully. No content returned.