Checkouts

Get the status of a checkout

Read. Whether a checkout created through this API is awaiting payment, paid, still processing, or expired. Report a payment as complete only when status is paid; if it is still awaiting payment, offer the same checkout_url instead of creating another checkout. Returns no payer details.

get/checkouts/{checkout_id}

Request

  • Base URL: https://www.laboratory.love/api/v1
  • URL: https://www.laboratory.love/api/v1/checkouts/{checkout_id}
  • Auth: none required

Path parameters

checkout_idstring required

checkout_id from a checkout response.

Response

Status.

checkout_idstring required

Checkout id.

kind'crowdfund_contribution' | 'testing_order' required

What is being bought.

status'awaiting_user_payment' | 'paid' | 'payment_processing' | 'expired' required

awaiting_user_payment, paid, payment_processing, or expired. Only paid means payment succeeded.

amountnumber required

USD.

currencystring required

Currency.

created_atstring date-time nullable required

Created.

expires_atstring date-time nullable required

Expires.

checkout_urlstring uri nullable required

Still-usable payment page (only while awaiting payment).

product_idstring nullable

Crowdfunding product id (contributions).

tier_idstring

Tier id (testing orders).

receiptstring nullable required

Where the receipt goes once paid.

support_urlstring uri required

Support for payment questions, disputes, and refunds.

Changes

No recorded changes to this operation across all 1 revision of this API.