Payments / Create

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
`payment_method_token` or `payment_method_nonce`	Currently usable when your credit card gateway is Braintree. Use the methods Braintree provides such as their Drop-in UI or Hosted Fields to retrieve either a reusable token or a single-use nonce and pass to use in way that does not require sending other credit card information through our API.	String	Optional	Only usable on /v9 and when `type` is `credit_card`.
`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

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