Page Comparison

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 a Client Address which is the billing address for the credit card being used.

Integer

Required if type is "credit_card"

is_completed

Automatically transition state from "pending" to "completed" after creation

Boolean

Optional

is_refund

Create payment in the opposite direction, where the order seller will refund money to the buyer.

Boolean

Optional

order_id

ID of the order on which the payment will be created

Integer

Optional

payment_method_token

or

payment_method_nonce

or

token (affiliates)

Currently usable when you are using our Braintree credit card gateway. 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 us in way that does not require sending other credit card information through our API.

String

Required when type is credit_card.

Only usable on /v9 and when type is credit_card.

type

The type of the payment to be posted. Available types:

• cash

• check

• credit_card

• evopay

• money_order

• offline

• paypal

• tbd

String

Required