Payments / Create

NamePayments Create
DescriptionCreate a payment on an order.
TypePOST
URL/v9/payments

Long Description

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.

Parameters

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
StringRequired
order_idID of the order on which the payment will be createdintegerRequired
is_refundCreate payment in the opposite direction, where the order seller will refund money to the buyer.booleanOptional
amountThe amount of the payment. Will be created for order total if omitted.Decimal

Optional

Maximum 2 decimal places
billing_address_idID of an addressintegerRequired if type is "credit_card"
is_completedAutomatically transition state from "pending" to "completed" after creationbooleanOptional


Examples

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


See Payments / Index