Collect payment

Records a payment collection for an order. This action will also automatically create a corresponding transaction object.

To perform this action, you must be the account owner, or must be delegated with ROLE_RESERVATIONIST, or ROLE_RESERVATIONIST_LITE, or ROLE_SELLER_ADMIN.

Path Params
string
required

Order ID.

Body Params
float
required

Amount to collect.

string
required

Payment method. Possible values are cc, cash, check, gift, store_credit, other, or the id of a configured payment method.

card
object

Credit card to use for payment. Required if method is cc.

string

Optional description of the payment.

Language
Credentials
Header
Response
Click Try It! to start a request and see the response here!