Use the Order management API to extend the order’s payment due date.
When you want to give your customers more time to pay for their purchase, you have to extend the order's payment due date.
To get an extension for the payment date, follow these steps:
As we relate every capture with an individual invoice for the customer, you can extend the payment due date per capture.
This is a paid feature. Given that the order extension increases the credit costs, we charge a fee. For more information, see the pricing section.
Extending the payment date is only possible for orders associated with a pay-later method, such as Pay in 30 days or Pay in 4 installments.
To get the available options for extending an order's payment due date, send a GET request to the {apiUrl}/ordermanagement/v1/orders/{order_id}/captures/{capture_id}/extend-due-date-options endpoint.
Provide order_id and capture_id as path parameters. The order_id is the identifier you get in a successful response when placing a new order, and the capture_id is the identifier you get when successfully capturing an order.
You don't need a request body for this POST method.
If your request is successful, you'll receive a response body including number_of_days for the amount of days this order can be extended.
{
"currency": "usd",
"options": [
{
"amount": 0,
"number_of_days": 0
}
]
}Sample of a successful response to get the extension options.
If your request contains errors, you'll receive an error response. Ensure the order_id and the capture_id values you provided are valid and correctly formatted.
You can use the correlation_id and the order_id value to troubleshoot the call in the Merchant portal logs section.
{
"correlation_id": "string",
"error_code": "string",
"error_messages": [
"string"
]
}Sample of an error response to get the extension options.
To extend the payment due date for a specific order, send a PATCH request to the {apiUrl}/ordermanagement/v1/orders/{order_id}/captures/{capture_id}/extend-due-date-options endpoint.
Provide one of the extension options you got as number_of_days from Step 1.
{
"number_of_days": 0
}Sample of a request to extend the payment due date.
If the request is successful, you'll receive a 204 No content response.
If your request contains errors, you'll receive an error response. Ensure the order_id and the capture_id values you provided are valid and correctly formatted.
You can use the correlation_id and the order_id value to troubleshoot the call in the Merchant portal logs section.
{
"correlation_id": "string",
"error_code": "string",
"error_messages": [
"string"
]
}Sample of an error response to extend the payment due date.
Ready to send this request? See the API reference of this call.