Reference
  1. Custom Checkout

Renew a custom checkout

post
https://test-api.bill.pro/api/v2/profiles//orders//custom_checkout

Issues a fresh checkout for an order, for when the checkout the payment form was loaded with has expired, or the customer needs another try. See Host a checkout on your website.

  • Use it on a draft, pending or rejected order that has no successful payment. Any order on your profile qualifies, wherever it was created. A failed order can't be renewed.
  • The body is optional. Send redirect_success_url or redirect_failed_url only to change them. After the change, the order must hold both.
  • Renewing doesn't change the order's status and sends no webhook. Every call issues a new checkout: use the newest one.
  • If the gateway fails, you still get 201. checkout.result says why and the other checkout fields are null. Renew again.

A checkout expires 30 minutes after it's created, or as soon as the customer pays with it. Renew it when it's more than 30 minutes old.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required
≥ 1

Your merchant profile ID. Required in every request.

Find it in the BillPro dashboard address, after /profiles/. For example, in /profiles/1234/orders the profile ID is 1234.

integer
required
≥ 1

ID of the order.

Body Params
uri
length ≤ 2048

Optional. Replaces the stored success return URL: where the customer is sent after an approved payment, and with status=pending when the outcome couldn't be confirmed. Leave it out to keep the stored value. null or an empty string is refused. Must be an absolute https URL, up to 2048 characters. Your own query string is kept.

uri
length ≤ 2048

Optional. Replaces the stored failed return URL: where the customer is sent after a declined payment. Leave it out to keep the stored value. Same rules as redirect_success_url.

Responses

Updated 19 days ago

Did this page help you?
Language
Credentials
Bearer
API token
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 19 days ago

Did this page help you?