openapi: 3.1.0 info: title: Commerce Layer addresses braintree_gateways API version: 7.10.1 contact: name: API Support url: https://commercelayer.io email: support@commercelayer.io description: Headless Commerce for Global Brands. servers: - url: https://{your_organization_slug}.commercelayer.io/api description: API - url: https://core.commercelayer.io/users/sign_in description: Sign in - url: https://docs.commercelayer.io/api description: API reference security: - bearerAuth: [] tags: - name: braintree_gateways description: resource type paths: /braintree_gateways: get: operationId: GET/braintree_gateways summary: List all braintree gateways description: List all braintree gateways tags: - braintree_gateways responses: '200': description: A list of braintree gateway objects content: application/vnd.api+json: schema: $ref: '#/components/schemas/braintreeGatewayResponseList' post: operationId: POST/braintree_gateways summary: Create a braintree gateway description: Create a braintree gateway tags: - braintree_gateways requestBody: required: true content: application/vnd.api+json: schema: $ref: '#/components/schemas/braintreeGatewayCreate' responses: '201': description: The created braintree gateway object content: application/vnd.api+json: schema: $ref: '#/components/schemas/braintreeGatewayResponse' /braintree_gateways/{braintreeGatewayId}: get: operationId: GET/braintree_gateways/braintreeGatewayId summary: Retrieve a braintree gateway description: Retrieve a braintree gateway tags: - braintree_gateways parameters: - name: braintreeGatewayId in: path schema: type: string required: true description: The resource's id responses: '200': description: The braintree gateway object content: application/vnd.api+json: schema: $ref: '#/components/schemas/braintreeGatewayResponse' patch: operationId: PATCH/braintree_gateways/braintreeGatewayId summary: Update a braintree gateway description: Update a braintree gateway tags: - braintree_gateways parameters: - name: braintreeGatewayId in: path schema: type: string required: true description: The resource's id requestBody: required: true content: application/vnd.api+json: schema: $ref: '#/components/schemas/braintreeGatewayUpdate' responses: '200': description: The updated braintree gateway object content: application/vnd.api+json: schema: $ref: '#/components/schemas/braintreeGatewayResponse' delete: operationId: DELETE/braintree_gateways/braintreeGatewayId summary: Delete a braintree gateway description: Delete a braintree gateway tags: - braintree_gateways parameters: - name: braintreeGatewayId in: path schema: type: string required: true description: The resource's id responses: '204': description: No content components: schemas: braintreeGatewayResponseList: type: object properties: data: type: array items: $ref: '#/components/schemas/braintreeGatewayResponse/properties/data' braintreeGateway: properties: data: properties: attributes: type: object properties: name: type: string description: The payment gateway's internal name. example: US payment gateway nullable: false force_payments: type: boolean description: Indicates if the payment source is forced on the editable order upon receiving a successful event from the gateway. example: true nullable: true credential_keys: type: object description: The payment gateway's API credential keys last digits. example: api_key: '********BW989' nullable: true disabled_at: type: string description: Time at which this resource was disabled. example: '2018-01-01T12:00:00.000Z' nullable: true created_at: type: string description: Time at which the resource was created. example: '2018-01-01T12:00:00.000Z' nullable: false updated_at: type: string description: Time at which the resource was last updated. example: '2018-01-01T12:00:00.000Z' nullable: false reference: type: string description: 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. example: ANY-EXTERNAL-REFEFERNCE nullable: true reference_origin: type: string description: Any identifier of the third party system that defines the reference code. example: ANY-EXTERNAL-REFEFERNCE-ORIGIN nullable: true metadata: type: object description: 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. example: foo: bar nullable: true descriptor_name: type: string description: 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. example: company*productabc1234 nullable: true descriptor_phone: type: string description: The dynamic descriptor phone number. Must be 10-14 characters and can only contain numbers, dashes, parentheses and periods. example: '3125551212' nullable: true descriptor_url: type: string description: The dynamic descriptor URL. example: company.com nullable: true webhook_endpoint_url: type: string description: The gateway webhook URL, generated automatically. example: https://core.commercelayer.co/webhook_callbacks/braintree_gateways/xxxxx nullable: true braintreeGatewayCreate: required: - data type: object properties: data: type: object required: - type - attributes properties: type: type: string description: The resource's type enum: - braintree_gateways attributes: type: object properties: name: type: string description: The payment gateway's internal name. example: US payment gateway force_payments: type: boolean description: Indicates if the payment source is forced on the editable order upon receiving a successful event from the gateway. example: true _disable: type: boolean description: Send this attribute if you want to mark this resource as disabled. example: true _enable: type: boolean description: Send this attribute if you want to mark this resource as enabled. example: true reference: type: string description: 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. example: ANY-EXTERNAL-REFEFERNCE reference_origin: type: string description: Any identifier of the third party system that defines the reference code. example: ANY-EXTERNAL-REFEFERNCE-ORIGIN metadata: type: object description: 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. example: foo: bar _check: type: boolean description: Send this attribute if you want to check the credentials against the payment gateway's APIs. example: true merchant_account_id: type: string description: The gateway merchant account ID. example: xxxx-yyyy-zzzz merchant_id: type: string description: The gateway merchant ID. example: xxxx-yyyy-zzzz public_key: type: string description: The gateway API public key. example: xxxx-yyyy-zzzz private_key: type: string description: The gateway API private key. example: xxxx-yyyy-zzzz descriptor_name: type: string description: 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. example: company*productabc1234 descriptor_phone: type: string description: The dynamic descriptor phone number. Must be 10-14 characters and can only contain numbers, dashes, parentheses and periods. example: '3125551212' descriptor_url: type: string description: The dynamic descriptor URL. example: company.com required: - name - merchant_account_id - merchant_id - public_key - private_key relationships: type: object properties: braintree_payments: required: - data type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - braintree_payments id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN braintreeGatewayResponse: type: object properties: data: type: object properties: id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN type: type: string description: The resource's type enum: - braintree_gateways links: type: object properties: self: type: string description: URL attributes: $ref: '#/components/schemas/braintreeGateway/properties/data/properties/attributes' relationships: type: object properties: payment_methods: type: object properties: links: type: object properties: self: type: string description: URL related: type: string description: URL data: type: object properties: type: type: string description: The resource's type enum: - payment_methods id: type: string description: The resource ID event_stores: type: object properties: links: type: object properties: self: type: string description: URL related: type: string description: URL data: type: object properties: type: type: string description: The resource's type enum: - event_stores id: type: string description: The resource ID braintree_payments: type: object properties: links: type: object properties: self: type: string description: URL related: type: string description: URL data: type: object properties: type: type: string description: The resource's type enum: - braintree_payments id: type: string description: The resource ID braintreeGatewayUpdate: required: - data type: object properties: data: type: object required: - type - id - attributes properties: type: type: string description: The resource's type enum: - braintree_gateways id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN attributes: type: object properties: name: type: string description: The payment gateway's internal name. example: US payment gateway nullable: false force_payments: type: boolean description: Indicates if the payment source is forced on the editable order upon receiving a successful event from the gateway. example: true nullable: false _disable: type: boolean description: Send this attribute if you want to mark this resource as disabled. example: true nullable: false _enable: type: boolean description: Send this attribute if you want to mark this resource as enabled. example: true nullable: false reference: type: string description: 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. example: ANY-EXTERNAL-REFEFERNCE nullable: true reference_origin: type: string description: Any identifier of the third party system that defines the reference code. example: ANY-EXTERNAL-REFEFERNCE-ORIGIN nullable: true metadata: type: object description: 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. example: foo: bar nullable: true _check: type: boolean description: Send this attribute if you want to check the credentials against the payment gateway's APIs. example: true nullable: false merchant_account_id: type: string description: The gateway merchant account ID. example: xxxx-yyyy-zzzz merchant_id: type: string description: The gateway merchant ID. example: xxxx-yyyy-zzzz public_key: type: string description: The gateway API public key. example: xxxx-yyyy-zzzz private_key: type: string description: The gateway API private key. example: xxxx-yyyy-zzzz descriptor_name: type: string description: 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. example: company*productabc1234 nullable: true descriptor_phone: type: string description: The dynamic descriptor phone number. Must be 10-14 characters and can only contain numbers, dashes, parentheses and periods. example: '3125551212' nullable: true descriptor_url: type: string description: The dynamic descriptor URL. example: company.com nullable: true relationships: type: object properties: braintree_payments: required: - data type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - braintree_payments id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT