Payments / Apply

Owned by Don Pflaster (Unlicensed)
Last updated: Jul 12, 2013Version comment
NamePayments Apply
DescriptionApply a pending payment to an order, making it complete.
TypeGET
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_numberAdds check number while applying (only relevant for Check Transactions)integerOptional

 

Examples

RequestResponse
/v9/payments/49932/apply?check_number=123 

 

 

See Payments / Show