Skip to main content

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​

Path Parameters

    installmentPlanNumber stringrequired

Header Parameters

    X-Splitit-IdempotencyKey string

Body

    TrackingNumberstring
    RefOrderNumberstring

    A merchant-specific identifier value provided at creation of the plan by the merchant

    ShippingStatusstring

    Possible values: [Pending, Shipped, Delivered]

    Captureboolean

    Set this as true to capture the first payment for a plan that has been authorized but not captured.

    NewAmountnumber

    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​

Success

Schema

    RefOrderNumberstring
    InstallmentPlanNumberstring
    Statusstringrequired

    Possible values: [Initialized, PendingCapture, Active, Cleared, Canceled]

    ShippingStatusstringrequired

    Possible values: [Pending, Shipped, Delivered]