...
Payments can also be posted when orders are placed.
Note |
---|
Note: Payments of type |
...
|
...
will fail, even in Sandbox, if you have not yet signed up for the Braintree gateway. |
Parameters
Name | Description | Value Type | Required | Other | |||||||
---|---|---|---|---|---|---|---|---|---|---|---|
| The type amount of the payment to be posted. Available types:
| String | Required. Will be created for order total if omitted. | Decimal | Optional | Maximum 2 decimal places | |||||
| ID of a Client Address which is the billing address for the credit card being used. | Integer | Required if type is "credit_card" | ||||||||
| Automatically transition state from "pending" to "completed" after creation | Boolean | Optional | ||||||||
| Create payment in the opposite direction, where the order seller will refund money to the buyer. | Boolean | Optional | ||||||||
| ID of the order on which the payment will be created | Integer | Optional | ||||||||
or
or
| Currently usable when your you are using our Braintree 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 us in way that does not require sending other credit card information through our API. | StringOptional | Required when | Only usable on /v9 and when | |||||||
| ID | The type of the order on which the payment will be created | integer | Required |
| Create payment in the opposite direction, where the order seller will refund money to the buyer. | boolean | Optional | |||
| The amount of the payment. Will be created for order total if omitted. | Decimal | Optional | Maximum 2 decimal places | |||||||
| ID of an address | integer | Required if type is "credit_card" |
| Automatically transition state from "pending" to "completed" after creation | boolean | Optional | to be posted. Available types:
| String | Required |
Examples
Request | Response | /v9/payments|||||
---|---|---|---|---|---|---|
| See Payments / Index |
...