How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

braintree Transactions API

Operations for creating, capturing, voiding, refunding, and retrieving payment transactions.

braintree Transactions API is one of 14 APIs that Braintree publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Transaction. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 5 operations across 5 paths, and defines 11 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 2 base URLs: https://api.braintreegateway.com/merchants/{merchantId}, https://api.sandbox.braintreegateway.com/merchants/{merchantId}.

5 operations 5 paths 11 schemas 1 GET2 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://api.braintreegateway.com
Authentication
HTTP Basic
Terms of Service
Resource Areas
1

Authentication & Security 1

braintree Transactions API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (basicAuth). By default, every request must be authenticated.

  • basicAuth — HTTP Basic Authentication using the merchant's public API key as the username and private API key as the password, Base64-encoded per RFC 7617.

Paths & Operations 5

Across 5 paths, the API surfaces 5 operations — 1 GET, 2 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Transactions 5

Operations for creating, capturing, voiding, refunding, and retrieving payment transactions.

POST
/transactions
Create a transaction
createTransaction body → 201400401422
GET
/transactions/{transactionId}
Get a transaction
getTransaction 1 param → 200401404
PUT
/transactions/{transactionId}/submit_for_settlement
Submit transaction for settlement
submitTransactionForSettlement 1 param body → 200400401404
PUT
/transactions/{transactionId}/void
Void a transaction
voidTransaction 1 param → 200400401404
POST
/transactions/{transactionId}/refund
Refund a transaction
refundTransaction 1 param body → 201400401404

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are Transaction (22 properties), TransactionRequest (16 properties), Customer (12 properties), CustomerRequest (10 properties). Each schema is shown below with its type and property counts.

Descriptor
object
Dynamic descriptor fields that appear on the customer's bank or credit card statement to identify the merchant and transaction.
3 properties
TransactionOptions
object
Configuration options that modify transaction processing behavior.
6 properties
Address
object
A billing or shipping address associated with a transaction or customer.
9 properties
CustomerRequest
object
Request body for creating or updating a customer record in the Braintree Vault. All fields are optional.
10 properties
LineItem
object
A line item representing a single product or service in a transaction, used for Level 3 processing data.
9 properties 5 required
TransactionRequest
object
Request body for creating a new payment transaction. Either paymentmethodnonce, paymentmethodtoken, or customerid is required.
16 properties
CreditCardDetails
object
Details of the credit or debit card used in a transaction, with sensitive fields masked.
7 properties
Customer
object
Represents a customer record stored in the Braintree Vault. Customers serve as containers for vaulted payment methods and provide a way to associate transactio…
12 properties
Error
object
Standard error response returned by the Braintree API.
2 properties
Transaction
object
Represents a payment transaction in the Braintree gateway. A transaction captures the full lifecycle from authorization through settlement, refund, or void.
22 properties
PaymentMethod
object
Represents a payment method stored in the Braintree Vault. This is a polymorphic object that may represent a credit card, PayPal account, Venmo account, or oth…
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

braintree-transactions-api-openapi.yml Raw ↑

Other APIs Braintree publishes across the network.

Braintree GraphQL API
Braintree JavaScript Client SDK
Braintree iOS SDK
Braintree Android SDK
Braintree Webhooks
braintree Add-Ons API
braintree Client Tokens API
braintree Customers API
braintree Discounts API
braintree Disputes API
braintree Payment Methods API
braintree Plans API
Where this information came from

This is an independent, third-party profile of braintree Transactions API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.