Update Plan by Number

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.

Path Parameters
installmentPlanNumber string — REQUIRED

Header Parameters
X-Splitit-IdempotencyKey string

Request Body
TrackingNumber string
RefOrderNumber string A merchant-specific identifier value provided at creation of the plan by the merchant
ShippingStatus string Possible values: [Pending, Shipped, Delivered]
Capture boolean Set this as true to capture the first payment for a plan that has been authorized but not captured.
NewAmount number Use to update plan amount if plan amount hasn't been captured yet (i.e. AutoCapture was set to false in the Initiate or Create operation). In addition, 1. amount must be more than original amount 2. first email to customer will be sent upon capture

Responses
200 Success Schema — OPTIONAL RefOrderNumber string — OPTIONAL InstallmentPlanNumber string — OPTIONAL Status string Possible values: [Initialized, PendingCapture, Active, Cleared, Canceled] ShippingStatus string Possible values: [Pending, Shipped, Delivered]
401 Unauthorized Request: Token is not authorized or is expired Schema — OPTIONAL TraceId string — OPTIONAL Error object — OPTIONAL Code string — OPTIONAL Message string — OPTIONAL AdditionalInfo string — OPTIONAL ExtraData object — OPTIONAL
403 Schema — OPTIONAL TraceId string — OPTIONAL Error object — OPTIONAL Code string — OPTIONAL Message string — OPTIONAL AdditionalInfo string — OPTIONAL ExtraData object — OPTIONAL
404 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 Schema — OPTIONAL TraceId string — OPTIONAL Error object — OPTIONAL Code string — OPTIONAL Message string — OPTIONAL AdditionalInfo string — OPTIONAL ExtraData object — OPTIONAL
500 General Server Error: Server encountered an unexpected condition Schema — OPTIONAL TraceId string — OPTIONAL Error object — OPTIONAL Code string — OPTIONAL Message string — OPTIONAL AdditionalInfo string — OPTIONAL ExtraData object — OPTIONAL
400-503 InvalidInstallmentPlanStatus: Status does not allow updating order (example: request capture for plan that was already captured). Schema — OPTIONAL TraceId string — OPTIONAL Error object — OPTIONAL Code string — OPTIONAL Message string — OPTIONAL AdditionalInfo string — OPTIONAL ExtraData object — OPTIONAL
400-561 The input parameters or parameter combination for the updated plan is not supported. (New amount is lower than original amount, can only be higher) Schema — OPTIONAL TraceId string — OPTIONAL Error object — OPTIONAL Code string — OPTIONAL Message string — OPTIONAL AdditionalInfo string — OPTIONAL ExtraData object — OPTIONAL
400-578 InvalidPlanStrategy: We are sorry for the inconvenience, but this plan is not available. Schema — OPTIONAL TraceId string — OPTIONAL Error object — OPTIONAL Code string — OPTIONAL Message string — OPTIONAL AdditionalInfo string — OPTIONAL ExtraData object — OPTIONAL
400-599 General Error: Sorry. There has been an error. Please try again. Schema — OPTIONAL TraceId string — OPTIONAL Error object — OPTIONAL Code string — OPTIONAL Message string — OPTIONAL AdditionalInfo string — OPTIONAL ExtraData object — OPTIONAL
400-640 GtwyMerchantDataProblem: Sorry, but there has been a processing error with this merchant. Please contact our support for assistance. Schema — OPTIONAL TraceId string — OPTIONAL Error object — OPTIONAL Code string — OPTIONAL Message string — OPTIONAL AdditionalInfo string — OPTIONAL ExtraData object — OPTIONAL
400-1041 IdempotencyHashMismatchError: Same Idempotency key with different payload identified. Schema — OPTIONAL TraceId string — OPTIONAL Error object — OPTIONAL Code string — OPTIONAL Message string — OPTIONAL AdditionalInfo string — OPTIONAL ExtraData object — OPTIONAL
400-5911 InvalidInternalUrlSentToOms: Plan is not in the correct state to process this request. Schema — OPTIONAL TraceId string — OPTIONAL Error object — OPTIONAL Code string — OPTIONAL Message string — OPTIONAL AdditionalInfo string — OPTIONAL ExtraData object — OPTIONAL