# The braintree gateway object

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

## Fields

| Field                                 | Type       | Description                                                                                                                                                                                         |
| ------------------------------------- | ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **type**                              | `string`   | `braintree_gateways`                                                                                                                                                                                |
| **id**                                | `string`   | The braintree gateway unique identifier                                                                                                                                                             |
| links.**self**                        | `string`   | The braintree gateway endpoint URL                                                                                                                                                                  |
| attributes.**name**                   | `string`   | The payment gateway's internal name.                                                                                                                                                                |
| attributes.**force\_payments**        | `boolean`  | Indicates if the payment source is forced on the editable order upon receiving a successful event from the gateway.                                                                                 |
| attributes.**\_disable**              | `boolean`  | Send this attribute if you want to mark this resource as disabled.                                                                                                                                  |
| attributes.**\_enable**               | `boolean`  | Send this attribute if you want to mark this resource as enabled.                                                                                                                                   |
| attributes.**disabled\_at**           | `datetime` | Time at which this resource was disabled.                                                                                                                                                           |
| 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.                                        |
| attributes.**merchant\_account\_id**  | `string`   | The gateway merchant account ID.                                                                                                                                                                    |
| attributes.**merchant\_id**           | `string`   | The gateway merchant ID.                                                                                                                                                                            |
| attributes.**public\_key**            | `string`   | The gateway API public key.                                                                                                                                                                         |
| attributes.**private\_key**           | `string`   | The gateway API private key.                                                                                                                                                                        |
| attributes.**descriptor\_name**       | `string`   | The dynamic descriptor name. Must be composed by business name (3, 7 or 12 chars), an asterisk (\*) and the product name (18, 14 or 9 chars), for a total length of 22 chars.                       |
| attributes.**descriptor\_phone**      | `string`   | The dynamic descriptor phone number. Must be 10-14 characters and can only contain numbers, dashes, parentheses and periods.                                                                        |
| attributes.**descriptor\_url**        | `string`   | The dynamic descriptor URL.                                                                                                                                                                         |
| attributes.**webhook\_endpoint\_url** | `string`   | The gateway webhook URL, generated automatically.                                                                                                                                                   |
| relationships.**payment\_methods**    | `array`    | The associated payment methods.                                                                                                                                                                     |
| relationships.**versions**            | `array`    | The associated changes.                                                                                                                                                                             |
| relationships.**event\_stores**       | `array`    | The associated event stores.                                                                                                                                                                        |
| relationships.**braintree\_payments** | `array`    | The associated payments.                                                                                                                                                                            |
| meta.**mode**                         | `string`   | The resource environment (can be one of `test` or `live`)                                                                                                                                           |