> For the complete documentation index, see [llms.txt](https://docs.commercelayer.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.commercelayer.io/core-api-reference/braintree_payments/object.md).

# The braintree payment object

A comprehensive list of the braintree payment resource's attributes and relationships

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**            | `string`  | Time at which the resource was created.                                                                                                                                                             |
| attributes.**updated\_at**            | `string`  | 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.**event\_stores**       | `array`   | The associated event stores.                                                                                                                                                                        |
| meta.**mode**                         | `string`  | The resource environment (can be one of `test` or `live`)                                                                                                                                           |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.commercelayer.io/core-api-reference/braintree_payments/object.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.