Payments / Apply
Name | Payments Apply |
|---|---|
Description | Apply a pending payment to an order, making it complete. |
Type | GET |
URL | /v9/payments/:id/apply |
Long Description
By default, a payment is created in the pending state. This means it has been prepared, but is not yet applied to the order. The order's pending balance will reflect that it exists, but it will not affect the order balance.
Applying the payment will attempt to transition it to the completed state, after which the order balance will be adjusted.
Parameters
Name | Description | Value Type | Required |
|---|---|---|---|
check_number | Adds check number while applying (only relevant for Check Transactions) | integer | Optional |
Examples
Request | Response |
|---|---|
/v9/payments/49932/apply?check_number=123 |
|
| See Payments / Show |