# The braintree payment object

A braintree payment object is returned as part of the response body of each successful list, retrieve, create or update API call to the `/api/braintree_payments` endpoint.

## Fields

| Field                                 | Type       | Description                                                                                                                                                                                         |
| ------------------------------------- | ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **type**                              | `string`   | `braintree_payments`                                                                                                                                                                                |
| **id**                                | `string`   | The braintree payment unique identifier                                                                                                                                                             |
| links.**self**                        | `string`   | The braintree payment endpoint URL                                                                                                                                                                  |
| attributes.**client\_token**          | `string`   | The Braintree payment client token. Required by the Braintree JS SDK.                                                                                                                               |
| attributes.**payment\_method\_nonce** | `string`   | The Braintree payment method nonce. Sent by the Braintree JS SDK.                                                                                                                                   |
| attributes.**payment\_id**            | `string`   | The Braintree payment ID used by local payment and sent by the Braintree JS SDK.                                                                                                                    |
| attributes.**local**                  | `boolean`  | Indicates if the payment is local, in such case Braintree will trigger a webhook call passing the "payment\_id" and "payment\_method\_nonce" in order to complete the transaction.                  |
| attributes.**options**                | `object`   | Braintree payment options, 'customer\_id' and 'payment\_method\_token'.                                                                                                                             |
| attributes.**payment\_instrument**    | `object`   | Information about the payment instrument used in the transaction.                                                                                                                                   |
| attributes.**created\_at**            | `datetime` | Time at which the resource was created.                                                                                                                                                             |
| attributes.**updated\_at**            | `datetime` | Time at which the resource was last updated.                                                                                                                                                        |
| attributes.**reference**              | `string`   | A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever. |
| attributes.**reference\_origin**      | `string`   | Any identifier of the third party system that defines the reference code.                                                                                                                           |
| attributes.**metadata**               | `object`   | Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.                                        |
| relationships.**order**               | `object`   | The order associated to the Braintree payment, that is set as its payment source.                                                                                                                   |
| relationships.**payment\_gateway**    | `object`   | The associated payment gateway, inherited by the order payment\_method.                                                                                                                             |
| relationships.**versions**            | `array`    | The associated changes.                                                                                                                                                                             |
| relationships.**event\_stores**       | `array`    | The associated event stores.                                                                                                                                                                        |
| meta.**mode**                         | `string`   | The resource environment (can be one of `test` or `live`)                                                                                                                                           |