Update Plan by Number
PUT/:installmentPlanNumber/updateorder
Locate a plan by installment number then carry out post-authorization activities related to the plan, such as updating the order number, updating the tracking number, updating shipping status, or updating the plan amount (if it hasn't been captured yet). You can also use this endpoint to capture the first installment from a plan that has only been authorized but not yet captured.
Request
Responses
- 200
- 401
- 403
- 404
- 422
- 500
- 400-503
- 400-561
- 400-578
- 400-599
- 400-640
- 400-1041
- 400-5911
Success
Unauthorized Request: Token is not authorized or is expired
Resource Does Not Exist: Plan or service does not exist; for all APIs, if an invalid plan number is passed in the URL, this error will be returned
General Server Error: Server encountered an unexpected condition
InvalidInstallmentPlanStatus: Status does not allow updating order (example: request capture for plan that was already captured).
The input parameters or parameter combination for the updated plan is not supported. (New amount is lower than original amount, can only be higher)
InvalidPlanStrategy: We are sorry for the inconvenience, but this plan is not available.
General Error: Sorry. There has been an error. Please try again.
GtwyMerchantDataProblem: Sorry, but there has been a processing error with this merchant. Please contact our support for assistance.
IdempotencyHashMismatchError: Same Idempotency key with different payload identified.
InvalidInternalUrlSentToOms: Plan is not in the correct state to process this request.