Page Comparison

Page Properties

label	api_docs_payments

Endpoint to create payments on existing orders.

Payments can also be posted when orders are placed.

Note: Payments of type 'credit_card' will fail, even in Sandbox, if you have not yet signed up for the Braintree gateway.

Name	Description	Value Type	Required	Other
type	The type of the payment to be posted. Available types: `cash` `check` `paypal` `money_order` `tbd` `evopay` `credit_card` `offline`	String	Required
order_id	ID of the order on which the payment will be created	integer	Required
is_refund	Create payment in the opposite direction, where the order seller will refund money to the buyer.	boolean	Optional
amount	The amount of the payment. Will be created for order total if omitted.	Decimal	Optional	Maximum 2 decimal places
billing_address_id	ID of an address	integer	Required if type is "credit_card"
is_completed	Automatically transition state from "pending" to "completed" after creation	boolean	Optional

Request

Response

/v9/payments

Code Block

language	ruby
theme	Confluence

{
  "payments":[
    {
      "order_id":"75155",
      "type":"cash",
      "amount":"15"
    }
  ]
}

Versions Compared