Skip to main content

Reference

Query

ping
Returns the literal string 'pong'.
output:
pingInStoreReader
Triggers a beep on a connected Reader and returns the Reader information or an error if unable to ping the device.
args:
  • readerId: ID!
output:
viewer
The currently authenticated viewer.
output:
clientConfiguration
The client-side environment and payment method configuration.
output:
node
Fetch any object that extends the Node interface using its ID.
args:
output:
idFromLegacyId
Get a GraphQL ID from a legacy ID that was returned from an SDK or a legacyId field. Does not verify existence except for payment methods.
args:
output:
report
A collection of the available reports. Each field on the `Report` type is a different report that can be queried with its own input parameters.
output:
search
A collection of the available searches. Each field on the `Search` type is a different search that can be queried with its own input parameters.
output:
paypalFinancingOptions
Retrieve PayPal financing options that include payment installment plans.
args:
output:
inStoreLocations
Retrieve a paginated list of all in-store locations.
args:
output:

Mutation

authorizePaymentMethod
Authorize an eligible payment method and return a payload that includes details of the resulting transaction.
args:
output:
authorizePayPalAccount
Authorize an eligible PayPal account and return a payload that includes details of the resulting transaction.
args:
output:
authorizeVenmoAccount
Authorize an eligible Venmo account and return a payload that includes details of the resulting transaction.
args:
output:
authorizeCreditCard
Authorize a credit card of any origin and return a payload that includes details of the resulting transaction.
args:
output:
captureTransaction
Capture an authorized transaction and return a payload that includes details of the transaction.
args:
output:
chargePaymentMethod
Charge any payment method and return a payload that includes details of the resulting transaction.
args:
output:
chargeUsBankAccount
Charge a US bank account and return a payload that includes details of the resulting transaction. See https://developers.braintreepayments.com/guides/ach/configuration for information on eligibility and setup.
args:
output:
chargePayPalAccount
Charge a PayPal account and return a payload that includes details of the resulting transaction.
args:
output:
chargeVenmoAccount
Charge a Venmo account and return a payload that includes details of the resulting transaction. See https://articles.braintreepayments.com/guides/payment-methods/venmo for information on eligibility and setup.
args:
output:
chargeCreditCard
Charge a credit card of any origin and return a payload that includes details of the resulting transaction.
args:
output:
vaultPaymentMethod
Vault payment information from a single-use payment method and return a payload that includes a new multi-use payment method. When vaulting a credit card, by default, this mutation will also verify that card before vaulting.
args:
output:
vaultUsBankAccount
Vault payment information from a single-use US bank account payment method and return a payload that includes a new multi-use payment method.
args:
output:
vaultCreditCard
Vault payment information from a single-use credit card and return a payload that includes a new multi-use payment method. By default, this mutation will also verify the card before vaulting.
args:
output:
refundTransaction
Refund a settled transaction and return a payload that includes details of the refund.
args:
output:
reverseTransaction
Reverse a transaction and return a payload that includes either the voided transaction or a refund.
args:
output:
reverseRefund
Reverse a refund and return a payload that includes voided refund.
args:
output:
refundCreditCard
Create a detached refund (unassociated with any previous Braintree payment) to a credit card and return a payload that includes details of the refund. We have previously referred to this as issuing a "detached credit," and it is disallowed by default. See the [documentation](https://articles.braintreepayments.com/control-panel/transactions/refunds-voids-credits#detached-credits) for more information regarding eligibility and configuration.
args:
output:
refundUsBankAccount
Create a detached refund (unassociated with any previous Braintree payment) to a US Bank Account and return a payload that includes details of the refund. We have previously referred to this as issuing a "detached credit," and it is disallowed by default. See the [documentation](https://articles.braintreepayments.com/control-panel/transactions/refunds-voids-credits#detached-credits) for more information regarding eligibility and configuration.
args:
output:
updateTransactionCustomFields
Update custom fields on a transaction. Custom fields are [defined in the Control Panel](https://articles.braintreepayments.com/control-panel/custom-fields#store-and-pass-back-fields).
args:
output:
verifyPaymentMethod
Run a verification on a multi-use payment method.
args:
output:
verifyCreditCard
Run a verification on a multi-use credit card payment method.
args:
output:
verifyUsBankAccount
Run a verification on a multi-use US bank account payment method.
args:
output:
confirmMicroTransferAmounts
Confirm micro-transfer amounts initiated by vaultUsBankAccount or verifyUsBankAccount, completing the verification process for a US Bank Account via micro-transfer.
args:
output:
deletePaymentMethodFromVault
Delete a multi-use payment method from the vault.
args:
output:
createClientToken
Create a client token that can be used to initialize a client in order to tokenize payment information.
args:
output:
createUniversalAccessToken
Create a PayPal access token that can be used to make additional API calls or initialize a client.
args:
output:
partialCaptureTransaction
Partially capture funds from a transaction that was successfully authorized and return a payload that includes a new transaction with information about the capture. This is available for [Venmo](https://developers.braintreepayments.com/guides/venmo/submit-for-partial-settlement) and [PayPal](https://articles.braintreepayments.com/guides/payment-methods/paypal/processing#multiple-partial-settlements) transactions.
args:
output:
tokenizeCustomActionsPaymentMethod
Tokenize Custom Actions fields and return a payload that includes a single-use payment method.
args:
output:
tokenizeCreditCard
Tokenize credit card fields and return a payload that includes a single-use payment method.
args:
output:
tokenizeCvv
Tokenize a credit card's CVV and return a payload that includes a single-use payment method.
args:
output:
tokenizeNetworkToken
Tokenize a network tokenized payment instrument and return a payload that includes a single-use payment method.
args:
output:
tokenizeSamsungPayCard
Tokenize Samsung Pay card fields and return a payload that includes a single-use payment method.
args:
output:
tokenizeUsBankAccount
Tokenize US bank account fields and return a payload that includes a single-use payment method.
args:
output:
tokenizeUsBankLogin
Tokenize US bank login fields and return a payload that includes a single-use payment method.
args:
output:
tokenizePayPalOneTimePayment
Tokenize PayPal One-Time Payment and return a payload that includes a single-use payment method.
args:
output:
createPayPalOneTimePayment
Set up a PayPal One-Time Payment for approval by a PayPal user. See [documentation](https://developer.paypal.com/braintree/docs/guides/paypal/checkout-with-paypal) for more information. Your account must be enabled for this feature.
args:
output:
tokenizePayPalBillingAgreement
Tokenize PayPal account and return a payload that includes a single-use payment method.
args:
output:
createPayPalBillingAgreement
Set up a PayPal Billing Agreement Token for approval by a PayPal user.
args:
output:
createCustomer
Create a customer for storing individual customer information and/or grouping transactions and multi-use payment methods.
args:
output:
updateCustomer
Update a customer's information.
args:
output:
deleteCustomer
Delete a customer, breaking association between any of the customer's transactions. Will not delete if the customer has existing payment methods.
args:
output:
updateCreditCardBillingAddress
Set a new billing address for a multi-use credit card payment method. By default, this mutation will also verify the card with the new billing address before updating.
args:
output:
performThreeDSecureLookup
Attempt to perform 3D Secure Authentication on credit card payment method. This may consume the payment method and return a new single-use payment method.
args:
output:
acceptDispute
Accepts a dispute and returns a payload that includes the dispute that was accepted. Only disputes with a status of OPEN can be accepted.
args:
output:
finalizeDispute
Finalizes a dispute and returns a payload that includes the dispute that was finalized. Only disputes with a status of OPEN can be finalized.
args:
output:
createDisputeTextEvidence
Creates text evidence to a dispute and returns a payload that includes the evidence that was created. Only disputes with a status of OPEN can have text evidence created for them.
args:
output:
deleteDisputeEvidence
Deletes evidence from a dispute.
args:
output:
createDisputeFileEvidence
Uploads an evidence file and associates it with a dispute. **Note:**: file upload requires a special request format. See the ['Uploading Files' integration guide](https://graphql.braintreepayments.com/integration_guides/uploading_files) for instructions on how to perform this mutation.
args:
output:
vaultPayPalBillingAgreement
Vault an existing PayPal Billing Agreement that was not created through Braintree. Only use this mutation if you need to import PayPal Billing Agreements from an existing PayPal integration into your Braintree account.
args:
output:
sandboxSettleTransaction
Force a transaction to settle in the sandbox environment. Generates an error elsewhere.
args:
output:
createInStoreLocation
Creates a new In-Store Location to associate Readers.
args:
output:
updateInStoreLocation
Updates an In-Store Location.
args:
output:
pairInStoreReader
Pairs a Reader to an account and In-Store Location.
args:
output:
updateInStoreReader
Updates an In-Store Reader.
args:
output:
requestChargeFromInStoreReader
Request an in-store reader to begin the charge flow.
args:
output:
requestCancelFromInStoreReader
Request an in-store reader to cancel the charge flow.
args:
output:
requestRefundFromInStoreReader
Request an in-store reader to start an unreferenced refund flow.
args:
output:
requestVaultFromInStoreReader
Request an in-store reader to vault a payment method.
args:
output:
requestTextDisplayFromInStoreReader
Request an in-store reader to display text.
args:
output:
requestItemDisplayFromInStoreReader
Request an in-store reader to display line items.
args:
output:
requestFirmwareUpdateFromInStoreReader
Request an in-store reader to update to the latest version of software.
args:
output:
requestSignaturePromptFromInStoreReader
Request an in-store reader to display a signature prompt.
args:
output:
requestConfirmationPromptFromInStoreReader
Request an in-store reader to display a confirmation prompt.
args:
output:
updateTransactionAmount
Updates the authorization amount of the transaction.
args:
output:
generateExchangeRateQuote
Generate a customized currency exchange rate quote for items on a merchant's page. This allows merchants to advertise products in their customer's currency. Your account must be enabled to use this feature.
args:
output:
createNonInstantLocalPaymentContext
Creates a non-instant local payment context. Your account must be enabled to use this feature.
args:
output:

Interfaces

DisputeEvidence
Evidence provided by a merchant to respond to a dispute.
fields:
  • id: ID!
    Unique identifier.
  • legacyId: ID!
    Legacy unique identifier.
  • createdAt: Timestamp
    Date and time when the evidence was created with Braintree.
  • sentToProcessorAt: Timestamp
    Date and time when the evidence was sent to the processor.
  • category: DisputeEvidenceCategory
    The evidence category.
Implementations:
InStoreContextResult
Reference object for an in-store request.
fields:
  • id: ID!
    A unique ID for this in-store request.
  • reader: InStoreReader
    The reader associated with the in-store request.
Implementations:
InStoreReaderOriginDetails
Additional information about the payment method supplied by an in-store payment reader.
fields:
  • authorizationMode: InStoreReaderAuthorizationMode
    The authorization mode used to perform the transaction on the payment reader.
  • pinVerified: Boolean
    An indicator for whether the transaction was verified via pin.
  • inputMode: PaymentReaderInputMode
    The input mode used on the payment reader to facilitate an in-store transaction.
  • terminalId: String
    The ID of the terminal that was processed this transaction.
Implementations:
Node
Relay compatible Node interface.
fields:
  • id: ID!
    Global ID for a given object.
Implementations:
Payment
A merchant-initiated movement of money between the merchant and a customer, by way of a payment method. Payments can represent money moving either from a customer to the merchant by charging a payment method (a Transaction), or from the merchant back to a customer by refunding a previous transaction (a Refund).
fields:
  • id: ID!
    Unique identifier.
  • legacyId: ID!
    Legacy unique identifier.
  • createdAt: Timestamp
    Date and time when the payment was created.
  • amount: MonetaryAmount
    The amount charged or credited to the payment method. Note that in the case of a Transaction, this amount will represent the amount moving from the customer to the merchant, and in the case of a Refund, will represent the amount moving from the merchant back to the customer.
  • orderId: String
    The order ID.
  • status: PaymentStatus
    The current status of this payment.
  • statusHistory: [PaymentStatusEvent!]
    The records of all statuses this payment has passed through, with additional information on why each status occurred. Returned in reverse chronological order, with the most recent event first in the list.
  • merchantAccountId: ID
    The ID of the merchant account that processed this payment.
  • source: PaymentSource
    How the payment was created.
  • paymentMethodSnapshot: PaymentMethodSnapshot
    Snapshot of payment method details used to create the payment, preserved at the time the transaction was created. This will always be present.
Implementations:
PaymentContext
Context associated with a transaction.
fields:
  • id: ID!
    Unique identifier.
  • createdAt: Timestamp!
    Date and time when the payment context was created.
  • updatedAt: Timestamp!
    Date and time when the payment context was updated.
Implementations:
PaymentStatusEvent
Status event in the [lifecycle of a payment](https://articles.braintreepayments.com/get-started/transaction-lifecycle).
fields:
  • status: PaymentStatus
    New status of the payment.
  • timestamp: Timestamp
    Date and time when the status event occurred.
  • amount: MonetaryAmount
    The payment amount applicable to the status. For instance, the amount when a transaction is `SUBMITTED_FOR_SETTLEMENT` might be less than the amount for which it was `AUTHORIZED`.
  • source: PaymentSource
    Source that caused the status event to occur.
  • terminal: Boolean
    Whether this is the final state for the payment. If false, this transaction will pass into another subsequent state.
Implementations:

Enums

ACHStandardEntryClassCode
A NACHA standard entry class (SEC) code, which designates how an ACH transaction was authorized.
enum values:
  • CCD
    Corporate credit or debit.
  • PPD
    Prearranged payment and deposit.
  • TEL
    Telephone-initiated.
  • WEB
    Internet-initiated/mobile.
ACRType
The authentication context class reference that indcates how a universal access token can be used.
enum values:
  • CLIENT
  • SERVER
AccountCreationStatus
The status of the business account creation request.
enum values:
  • COMPLETED
  • DECLINED
  • IN_SETUP
  • IN_VETTING
  • SUBMITTED
ApplePayStatus
The environment being used for Apple Pay.
enum values:
  • MOCK
  • OFF
  • PRODUCTION
  • mock
  • off
  • production
ApplicationBankAccountPurpose
The purpose of the merchant application bank account.
enum values:
  • CHECKING
  • SAVINGS
ApplicationStatus
The status of a merchant account application.
enum values:
  • APPROVED
  • PROCESSING
  • REJECTED
AvsCvvResponseCode
Response codes from the processing bank's Address Verification System (AVS) and CVV verification.
enum values:
  • BYPASS
    AVS or CVV checks were skipped via the API.
  • DOES_NOT_MATCH
  • ISSUER_DOES_NOT_PARTICIPATE
  • MATCHES
  • NOT_APPLICABLE
  • NOT_PROVIDED
  • NOT_VERIFIED
  • SYSTEM_ERROR
BinRecordValue
A boolean-like value that includes `UNKNOWN` in the case where the information isn't available.
enum values:
  • NO
  • UNKNOWN
  • YES
  • No
  • Unknown
  • Yes
BusinessType
The type of the business.
enum values:
  • GOVERNMENT_AGENCY
  • LIMITED_LIABILITY_CORPORATION
  • NONPROFIT
  • PARTNERSHIP
  • PRIVATE_CORPORATION
  • PUBLIC_CORPORATION
  • SOLE_PROPRIETORSHIP
CardAccountType
The type of account to be used when transacting with a combo card.
enum values:
  • CREDIT
  • DEBIT
Challenge
A list of challenges that are required by the current merchant to process a given credit card.
enum values:
  • CVV
  • POSTAL_CODE
  • cvv
  • postal_code
ChargebackProtectionLevel
The chargeback protection level indicates the transaction or dispute's protection status.
enum values:
  • EFFORTLESS
    The transaction or dispute is protected by the effortless chargeback protection product.
  • NOT_PROTECTED
    The merchant has not enrolled any chargeback protection products, or the merchant is registered, but the transaction or dispute is not protected.
  • STANDARD
    The transaction or dispute is protected by the standard chargeback protection product.
ClientConfigurationEnvironment
The client configuration environment being used.
enum values:
  • DEVELOPMENT
  • PRODUCTION
  • QA
  • SANDBOX
  • TEST
  • development
  • production
  • qa
  • sandbox
  • test
ClientFeature
A value used by Braintree client SDKs to determine what operations are supported through this GraphQL API.
enum values:
  • TOKENIZE_CREDIT_CARDS
  • tokenize_credit_cards
ConfirmMicroTransferAmountsStatus
The status of a micro-transfer amount confirmation.
enum values:
  • AMOUNTS_DO_NOT_MATCH
  • CONFIRMED
  • TOO_MANY_ATTEMPTS
ConfirmationPromptAlignment
The alignment of the confirmation prompt text when displayed on the in-store reader.
enum values:
  • CENTER
  • LEFT
CreditCardBrandCode
A code identifying the card brand.
enum values:
  • AMERICAN_EXPRESS
  • CITI
  • DINERS
  • DISCOVER
  • ELO
  • HIPER
  • HIPERCARD
  • INTERNATIONAL_MAESTRO
  • JCB
  • MASTERCARD
  • SOLO
  • SWITCH
  • UK_MAESTRO
  • UNION_PAY
  • UNKNOWN
  • VISA
  • american_express
  • citi
  • diners
  • discover
  • elo
  • hiper
  • hipercard
  • international_maestro
  • jcb
  • mastercard
  • solo
  • switch
  • uk_maestro
  • union_pay
  • unknown
  • visa
CustomerAuthenticationIndicator
A value indicating when to perform further customer authentication.
enum values:
  • OPTIONAL
    Indicates further authentication is optional.
  • REQUIRED
    Indicates further authentication should be performed.
  • UNAVAILABLE
    Customer authentication indicator information is unavailable at this time.
CustomerAuthenticationRegulationEnvironment
The customer authentication regulation environment that applies to the transaction, such as [PSD2](https://www.braintreepayments.com/blog/understanding-and-preparing-for-psd2-strong-customer-authentication/).
enum values:
  • PSDTWO
    EU Regulation [PSD2 Strong Customer Authentication](https://www.braintreepayments.com/blog/understanding-and-preparing-for-psd2-strong-customer-authentication/) applies to this transaction.
  • RBI
    Reserve Bank of India regulations apply to this transactions.
  • UNAVAILABLE
    Customer authentication regulation environment information is unavailable for this transaction at this time.
  • UNREGULATED
    No customer authentication regulations apply to this transaction.
DisplayItemType
The display item type to be displayed on the in-store reader.
enum values:
  • CHARGE
  • DISCOUNT
  • LINE_BREAK
  • TEXT
DisputeEvidenceCategory
The evidence category that specifies which requirement it satisfies.
enum values:
  • AVS_RESPONSE
  • CARRIER_NAME
  • CARRIER_NAME_OTHER
  • CREDIT_ISSUED_AMOUNT
  • CREDIT_ISSUED_DATE_TIME
  • DEVICE_ID
  • DEVICE_NAME
  • DOWNLOAD_DATE_TIME
  • EVIDENCE_TYPE
  • GENERAL
  • GEOGRAPHICAL_LOCATION
  • LEGIT_PAYMENTS_FOR_SAME_MERCHANDISE
  • MERCHANT_WEBSITE_OR_APP_ACCESS
  • PRIOR_DIGITAL_GOODS_TRANSACTION_ARN
  • PRIOR_DIGITAL_GOODS_TRANSACTION_DATE_TIME
  • PRIOR_DIGITAL_GOODS_TRANSACTION_ID
  • PRIOR_NON_DISPUTED_TRANSACTION_ARN
  • PRIOR_NON_DISPUTED_TRANSACTION_DATE_TIME
  • PRIOR_NON_DISPUTED_TRANSACTION_EMAIL_ADDRESS
  • PRIOR_NON_DISPUTED_TRANSACTION_ID
  • PRIOR_NON_DISPUTED_TRANSACTION_IP_ADDRESS
  • PRIOR_NON_DISPUTED_TRANSACTION_PHONE_NUMBER
  • PRIOR_NON_DISPUTED_TRANSACTION_PHYSICAL_ADDRESS
  • PROFILE_SETUP_OR_APP_ACCESS
  • PROOF_OF_3D_SECURE
  • PROOF_OF_AUTHORIZED_SIGNER
  • PROOF_OF_DELIVERY
  • PROOF_OF_DELIVERY_EMP_ADDRESS
  • PROOF_OF_POSSESSION_OR_USAGE
  • PURCHASER_EMAIL_ADDRESS
  • PURCHASER_IP_ADDRESS
  • PURCHASER_NAME
  • RECURRING_TRANSACTION_ARN
  • RECURRING_TRANSACTION_DATE_TIME
  • RECURRING_TRANSACTION_ID
  • REFUND_ID
  • SIGNED_DELIVERY_FORM
  • SIGNED_ORDER_FORM
  • TICKET_PROOF
  • TRACKING_NUMBER
  • TRACKING_URL
DisputeFileEvidenceCategory
For file evidence: the evidence category that specifies which requirement it satisfies.
enum values:
  • GENERAL
  • LEGIT_PAYMENTS_FOR_SAME_MERCHANDISE
  • MERCHANT_WEBSITE_OR_APP_ACCESS
  • PROFILE_SETUP_OR_APP_ACCESS
  • PROOF_OF_3D_SECURE
  • PROOF_OF_AUTHORIZED_SIGNER
  • PROOF_OF_DELIVERY
  • PROOF_OF_DELIVERY_EMP_ADDRESS
  • PROOF_OF_POSSESSION_OR_USAGE
  • SIGNED_DELIVERY_FORM
  • SIGNED_ORDER_FORM
  • TICKET_PROOF
DisputeReason
The reason a customer opened a chargeback, pre-arbitration, or retrieval.
enum values:
  • CANCELLED_RECURRING_TRANSACTION
  • CREDIT_NOT_PROCESSED
  • DUPLICATE
  • FRAUD
  • GENERAL
  • INVALID_ACCOUNT
  • NOT_RECOGNIZED
  • PRODUCT_NOT_RECEIVED
  • PRODUCT_UNSATISFACTORY
  • RETRIEVAL
  • TRANSACTION_AMOUNT_DIFFERS
DisputeStatus
The status of the dispute.
enum values:
  • ACCEPTED
  • DISPUTED
  • EXPIRED
  • LOST
  • OPEN
  • WON
DisputeTextEvidenceCategory
For text evidence: the evidence category that specifies which requirement it satisfies.
enum values:
  • AVS_RESPONSE
  • CREDIT_ISSUED_AMOUNT
  • CREDIT_ISSUED_DATE_TIME
  • DEVICE_ID
  • DEVICE_NAME
  • DOWNLOAD_DATE_TIME
  • GEOGRAPHICAL_LOCATION
  • PRIOR_DIGITAL_GOODS_TRANSACTION_ARN
  • PRIOR_DIGITAL_GOODS_TRANSACTION_DATE_TIME
  • PRIOR_DIGITAL_GOODS_TRANSACTION_ID
  • PRIOR_NON_DISPUTED_TRANSACTION_ARN
  • PRIOR_NON_DISPUTED_TRANSACTION_DATE_TIME
  • PRIOR_NON_DISPUTED_TRANSACTION_EMAIL_ADDRESS
  • PRIOR_NON_DISPUTED_TRANSACTION_ID
  • PRIOR_NON_DISPUTED_TRANSACTION_IP_ADDRESS
  • PRIOR_NON_DISPUTED_TRANSACTION_PHONE_NUMBER
  • PRIOR_NON_DISPUTED_TRANSACTION_PHYSICAL_ADDRESS
  • PURCHASER_EMAIL_ADDRESS
  • PURCHASER_IP_ADDRESS
  • PURCHASER_NAME
  • RECURRING_TRANSACTION_ARN
  • RECURRING_TRANSACTION_DATE_TIME
  • RECURRING_TRANSACTION_ID
DisputeType
Type of dispute.
enum values:
  • CHARGEBACK
  • PRE_ARBITRATION
    A [second challenge to a charge](https://articles.braintreepayments.com/risk-and-security/chargebacks-retrievals/overview#pre-arbitrations), in the case that you have won an initial chargeback.
  • RETRIEVAL
ExternalVaultStatus
A credit card's assocation with an external vault.
enum values:
  • VAULTED
    The payment method for this transaction has been vaulted in an external vault.
  • WILL_VAULT
    The payment method has not been vaulted in an exernal vault, but it will be if this transaction is successfully processed.
FraudServiceProvider
The fraud service provider used to generate the risk decision.
enum values:
  • CHARGEBACK_PROTECTION
  • EFFORTLESS_CHARGEBACK_PROTECTION
  • FRAUD_PROTECTION
  • FRAUD_PROTECTION_ADVANCED
  • FRAUD_PROTECTION_ENTERPRISE
  • KOUNT
GatewayRejectionReason
Possible reasons why a transaction was rejected by the gateway.
enum values:
  • APPLICATION_INCOMPLETE
  • AVS
  • AVS_AND_CVV
  • CVV
  • DUPLICATE
  • FRAUD
  • MANUAL_TRANSACTIONS_DISABLED
  • PAYMENT_METHOD_BLOCKED
  • RISK_THRESHOLD
  • THREE_D_SECURE
  • TOKEN_ISSUANCE
  • TOO_MANY_CONFIRMATION_ATTEMPTS
  • UNION_PAY_ENROLLMENT_REQUIRED
GooglePayEnvironment
The environment being used for Google Pay.
enum values:
  • PRODUCTION
  • SANDBOX
  • production
  • sandbox
InStoreContextStatus
Potential statuses of a context created as part of an in-store request.
enum values:
  • CANCELLED
    The context was successfully canceled.
  • COMPLETE
    Successful. The context was ended.
  • FAILED
    Not successful. The context was ended.
  • PENDING
    Flow in-progress. Waiting for reader or point of sale interaction.
  • PROCESSING
    Payment flow in-progress. Customer payment method submitted for transaction processing.
InStoreReaderAuthorizationMode
The authorization mode used to perform the transaction.
enum values:
  • CARD
  • ISSUER
LegacyIdType
The type of object the legacy ID represents when converting it to a global ID.
enum values:
  • CUSTOMER
  • DISPUTE
  • MERCHANT_ACCOUNT_APPLICATION
  • PAYMENT_CONTEXT
  • PAYMENT_METHOD
  • REFUND
  • TRANSACTION
  • US_BANK_ACCOUNT_VERIFICATION
  • VERIFICATION
LiabilityShiftCondition
If enrolled in Effortless Chargeback Protection, and in the event the transaction is disputed, these are the specific conditions under which the responsible party assumes liability for that chargeback.
enum values:
  • ITEM_NOT_RECEIVED
  • UNAUTHORIZED
LiabilityShiftResponsibleParty
If enrolled in Effortless Chargeback Protection, and in the event the transaction is disputed, these are the possible parties which can assume liability.
enum values:
  • ISSUER
  • PAYPAL
LocalPaymentMethodType
A value identifying the type of regional payment method.
enum values:
  • ALIPAY
  • BANCONTACT
  • BLIK
  • BOLETOBANCARIO
  • EPS
  • GIROPAY
  • GRABPAY
  • IDEAL
  • MULTIBANCO
  • MYBANK
  • OXXO
  • P24
  • PAYU
  • SATISPAY
  • SEPA
  • SOFORT
  • SWISH
  • TRUSTLY
  • VERKKOPANKKI
  • VIPPS
  • WECHAT_PAY
MVVAcceptanceChannel
Means by which customers by their bills.
enum values:
  • FACE_TO_FACE
  • MAIL
  • PHONE
  • WEB
MVVRegistrationType
Supported MVV (Merchant Verification Value) programs.
enum values:
  • LOAN_VPP
  • TAX_DEBIT
  • UTIL_RATE
  • UTIL_VPP
MVVUtilityType
Supported MVV (Merchant Verification Value) utility types.
enum values:
  • ELECTRIC
  • GAS
  • TRASH
  • WATER
MandateType
Mandate type for SEPA Direct Debit Account.
enum values:
  • ONE_OFF
  • RECURRENT
MerchantAccountStatus
The status of a merchant account. This determines whether the merchant account can be used to create a Payment, and whether funds can continue to flow to the associated bank account.
enum values:
  • ACTIVE
    The merchant account can be used to create transactions and refunds.
  • PENDING
    The merchant account is still being set up, and cannot be used to create transactions or refunds yet.
  • SUSPENDED
    The merchant account cannot be used to process transactions or refunds.
NetworkTokenOrigin
The source of the network token.
enum values:
  • APPLE_PAY
  • GOOGLE_PAY
  • NETWORK_TOKEN
NonInstantLocalPaymentMethodType
A value identifying the type of non-instant regional payment method.
enum values:
  • BOLETOBANCARIO
  • MULTIBANCO
  • OXXO
OAuthTokenType
OAuth access token type.
enum values:
  • BEARER
OwnerAddressType
The owner's address type.
enum values:
  • HOME
  • MAILING
OwnerIDType
The type of identity number provided for the owner.
enum values:
  • SOCIAL_SECURITY_NUMBER
OwnerPhoneType
The owner's phone type.
enum values:
  • HOME
  • MOBILE
OwnerPosition
The position that the owner holds in the business.
enum values:
  • BENEFICIAL_OWNER
  • CHAIRMAN
  • DIRECTOR
  • PARTNER
  • SECRETARY
  • TREASURER
OwnerRole
The role that the owner holds in the business.
enum values:
  • BENEFICIAL_OWNER
  • SIGNIFICANT_RESPONSIBILITY
PayPalEnvironment
The environment being used for PayPal.
enum values:
  • CUSTOM
  • LIVE
  • OFFLINE
  • custom
  • live
  • offline
PayPalFinancingCreditProductIdentifier
Possible identifiers for credit products provided via PayPal.
enum values:
  • CREDIT_CARD_INSTALLMENTS_BR
    Brazil Credit Card Installments.
  • CREDIT_CARD_INSTALLMENTS_MX
    Mexico Credit Card Installments.
  • CREDIT_CARD_US
    United States Credit Card.
  • PAYPAL_CREDIT_DE
    Germany PayPal Credit.
  • PAYPAL_CREDIT_UK
    United Kingdom PayPal Credit.
  • PAYPAL_CREDIT_US
    United States PayPal Credit.
  • PAY_LATER_FR
    France Pay Later.
  • PAY_LATER_GB
    Great Britain Pay Later.
  • PAY_LATER_US
    United States Pay Later.
  • PAY_UPON_INVOICE_DE
    Germany Pay Upon Invoice.
PayPalFinancingOptionCreditType
PayPal Financing option credit type.
enum values:
  • INSTALLMENT
  • NO_INTEREST
  • PAY_UPON_INVOICE
  • SAME_AS_CASH
PayPalIntent
The intent for PayPal payments.
enum values:
  • AUTHORIZE
    Merchant will authorize the payment, but the funds will be captured separately.
  • ORDER
    Merchant will create a PayPal Order. This validates the transaction without an authorization (i.e. without holding funds). Useful for authorizing and capturing funds up to 90 days after the order has been placed.
  • SALE
    Merchant will authorize and captures funds simultaneously.
PayPalLandingPageType
The type of landing page to display on the PayPal site for user checkout.
enum values:
  • BILLING
  • DEFAULT
  • LOGIN
PayPalRetailAppUsedForScanning
The app used to scan an in-store QR code.
enum values:
  • PAYPAL
  • VENMO
PayPalShippingOptionType
The method by which the payer wants to receive their items.
enum values:
  • PICKUP
  • SHIPPING
PaymentInitiator
The initiator of the payment. Payment can either be merchant-initiated or customer-initiated.
enum values:
  • MOTO
    Transactions that are initiated by the customer via the merchant by mail or telephone.
  • RECURRING
    Transactions for subsequent recurring payments (e.g. subscriptions with a fixed amount on a predefined schedule).
  • RECURRING_FIRST
    Transactions that represent the first in a series of recurring payments or subscription.
  • UNSCHEDULED
    Transactions for unscheduled payments that are not recurring on a predefined schedule or amount (e.g. balance top-up).
PaymentMethodDeletionInitiator
Initiator of a payment method delete request.
enum values:
  • CUSTOMER
  • MERCHANT
PaymentMethodOriginType
A value identifying the third-party origin from which a customer provided their payment method.
enum values:
  • APPLE_PAY
  • GOOGLE_PAY
  • IN_STORE_READER
  • MASTERPASS
  • NETWORK_TOKEN
  • PAYPAL
  • SAMSUNG_PAY
  • VISA_CHECKOUT
PaymentMethodSnapshotSearchType
A value identifying the type of payment method used for a transaction. For certain payment methods such as credit cards, this value also encodes the origin from which a customer provided that payment method.
enum values:
  • ALIPAY_VIA_PAYPAL
  • BANCONTACT_VIA_PAYPAL
  • BLIK_VIA_PAYPAL
  • BOLETOBANCARIO_VIA_PAYPAL
  • CREDIT_CARD
  • CREDIT_CARD_VIA_APPLE_PAY
  • CREDIT_CARD_VIA_GOOGLE_PAY
  • CREDIT_CARD_VIA_MASTERPASS
  • CREDIT_CARD_VIA_NETWORK_TOKEN
  • CREDIT_CARD_VIA_SAMSUNG_PAY
  • CREDIT_CARD_VIA_VISA_CHECKOUT
  • EPS_VIA_PAYPAL
  • GIROPAY_VIA_PAYPAL
  • GRABPAY_VIA_PAYPAL
  • IDEAL_VIA_PAYPAL
  • LOCAL_PAYMENT
  • MULTIBANCO_VIA_PAYPAL
  • MYBANK_VIA_PAYPAL
  • OXXO_VIA_PAYPAL
  • P24_VIA_PAYPAL
  • PAYPAL
  • PAYU_VIA_PAYPAL
  • SATISPAY_VIA_PAYPAL
  • SEPA_DIRECT_DEBIT
  • SEPA_VIA_PAYPAL
  • SOFORT_VIA_PAYPAL
  • SWISH_VIA_PAYPAL
  • TRUSTLY_VIA_PAYPAL
  • US_BANK_ACCOUNT
  • VENMO_ACCOUNT
  • VERKKOPANKKI_VIA_PAYPAL
  • VIPPS_VIA_PAYPAL
  • WECHAT_PAY_VIA_PAYPAL
PaymentMethodUsage
Possible usages for payment methods.
enum values:
  • MULTI_USE
  • SINGLE_USE
PaymentReaderInputMode
The input mode used on the payment reader to facilitate an in-store transaction.
enum values:
  • CONTACT
  • CONTACTLESS
  • MAGSTRIPE
  • MAGSTRIPE_FALLBACK
  • MANUAL_KEY_ENTRY
  • VAULT
PaymentSearchType
The type of a Payment, based primarily on implementing type.
enum values:
  • DETACHED_REFUND
    Only use this field if you have processed [detached credits](https://articles.braintreepayments.com/control-panel/transactions/refunds-voids-credits#detached-credits). The payment is a Refund, and represents a refund of a transaction not processed through your Braintree account.
  • REFUND
    The payment is a Refund, and represents a refund of a transaction present in this Braintree account. Unless you have processed any [detached credits](https://articles.braintreepayments.com/control-panel/transactions/refunds-voids-credits#detached-credits), this type encompasses all refunds.
  • TRANSACTION
    The payment is a Transaction.
PaymentSource
The origin of a request that created or changed a transaction or refund.
enum values:
  • API
  • CONTROL_PANEL
  • PAYMENT_READER
  • RECURRING
  • UNKNOWN
PaymentStatus
The status of the payment, indicating its success or failure, and where it is in its [lifecycle](https://articles.braintreepayments.com/get-started/transaction-lifecycle). For further details on why any given status occurred, consult the corresponding `PaymentStatusEvent` in the payment's `statusHistory`.
enum values:
  • AUTHORIZATION_EXPIRED
    The transaction spent too much time in the `AUTHORIZED` status and was marked as expired. Expiration [time frames](https://developers.braintreepayments.com/reference/general/statuses#authorization-expired) differ by card type, transaction type, and, in some cases, merchant category.
  • AUTHORIZED
    The processor authorized the transaction, putting your customer's funds on hold. Your customer may see a pending charge on his or her account. However, before the customer is actually charged and before you receive the funds, you must use the `captureTransaction` mutation. If you do not want to capture the transaction, you should use the `reverseTransaction` mutation to avoid a misuse of authorization fee.
  • AUTHORIZING
    If a payment remains in a status of `AUTHORIZING`, [contact us for assistance](https://help.braintreepayments.com?issue=TransactionProcessingQuestion).
  • FAILED
    An error occurred when sending the payment to the downstream processor. See the payment's `statusHistory` for the exact error.
  • GATEWAY_REJECTED
    The transaction was [rejected](https://articles.braintreepayments.com/control-panel/transactions/gateway-rejections) based on one or more settings or rules in your Braintree gateway. See the transaction's `statusHistory` to determine which resulted in the decline.
  • PROCESSOR_DECLINED
    The processor declined the transaction while attempting to authorize it. See the transaction's `statusHistory` to determine what reason the processor gave for the decline.
  • SETTLED
    The payment has been settled. For transactions, this means your customer has been charged and the process of disbursing the funds to your bank account has begun. For refunds, it means that the process of disbursing funds back to the customer has begun.
  • SETTLEMENT_CONFIRMED
    The transaction was captured partially and will not be submitted to processor for settling. Its child transaction(s) has been successfully captured and will be included in the next settlement batch.
  • SETTLEMENT_DECLINED
    The processor declined the payment while attempting to capture it. See the payment's `statusHistory` to determine why it wasn't settled. This status is rare, and only certain types of transactions can be affected.
  • SETTLEMENT_PENDING
    The transaction has not yet fully settled. This status is rare, and will generally resolve to a status of `SETTLED`. Only certain types of transactions can be affected.
  • SETTLING
    The payment is in the process of being settled. This is a transitory state, and will resolve to a status of `SETTLED`.
  • SUBMITTED_FOR_SETTLEMENT
    The payment has been successfully captured, and will be included in the next settlement batch, at which time it will become settled.
  • VOIDED
    The payment has been voided or canceled. For transactions, this means it's no longer authorized, your customer's funds are no longer on hold, and you can't use the `captureTransaction` mutation on this transaction. For refunds, it means the customer will not receive the funds from the refund.
ProcessorDeclineType
Whether the decline is likely to be temporary or persistent. Can be taken into consideration when determining whether to retry a declined charge.
enum values:
  • HARD
    Hard declines are the result of an error or issue which can't be resolved immediately; the decline is not temporary and subsequent charges on the same payment method will likely not be successful.
  • SOFT
    Soft declines result from a temporary issue and can be retried; subsequent charges on the same payment method may be successful.
ReaderStatus
Indicates the status of a Reader.
enum values:
  • OFFLINE
  • ONLINE
RecurringType
The type of recurring payment a transaction represents.
enum values:
  • FIRST
  • SUBSEQUENT
  • UNSCHEDULED
RefundPolicy
Supported refund policies.
enum values:
  • EXCHANGE_ONLY
  • NO_REFUND_OR_EXCHANGE
  • REFUND_CARDHOLDER
RiskDecision
The risk decision provides further context on how a transaction was scored for risk by Braintree.
enum values:
  • APPROVE
  • DECLINE
  • NOT_EVALUATED
  • REVIEW
SamsungPayEnvironment
The environment being used for Samsung Pay.
enum values:
  • PRODUCTION
  • SANDBOX
SandboxSettlementState
The settlement state when forcing transaction settlement in the sandbox environment.
enum values:
  • SETTLED
  • SETTLEMENT_DECLINED
ScaExemptionType
The type of Strong Customer Authentication Exemption.
enum values:
  • LOW_VALUE
  • SECURE_CORPORATE
  • TRANSACTION_RISK_ANALYSIS
  • TRUSTED_BENEFICIARY
TaxInfoType
The type of tax identifier.
enum values:
  • BR_CNPJ
  • BR_CPF
ThreeDSecureAuthenticationAcsWindowSize
An override field that a merchant can pass in to set the challenge window size to display to the end cardholder. The ACS will reply with content that is formatted appropriately to this window size to allow for the best user experience. The sizes are width x height in pixels of the window displayed in the cardholder browser window.
enum values:
  • FULL_PAGE
  • W250_H400
  • W390_H400
  • W500_H600
  • W600_H400
ThreeDSecureAuthenticationDeliveryTimeframe
Indicates the delivery timeframe if applicable.
enum values:
  • ELECTRONIC_DELIVERY
  • OVERNIGHT_SHIPPING
  • SAME_DAY_SHIPPING
  • TWO_OR_MORE_DAY_SHIPPING
ThreeDSecureAuthenticationMerchantProductCode
Merchant product code.
enum values:
  • ACCOMMODATION_RETAIL
  • AIRLINE
  • CAR_RENTAL
  • CASH_DISPENSING
  • DIGITAL_GOODS
  • FUEL
  • GENERAL_RETAIL
  • LUXURY_RETAIL
  • OTHER
  • RESTAURANT
  • SERVICES
  • TRAVEL
ThreeDSecureAuthenticationShippingType
Indicates the shipping type for the transaction.
enum values:
  • DIGITAL_GOODS
  • OTHER
  • SHIP_TO_ADDRESS_ON_FILE
  • SHIP_TO_BILLING_ADDRESS
  • SHIP_TO_OTHER_ADDRESS
  • SHIP_TO_STORE
  • TICKETS_NOT_SHIPPED
ThreeDSecureAuthenticationStatus
The 3D Secure authentication status of the card.
enum values:
  • AUTHENTICATE_ATTEMPT_SUCCESSFUL
  • AUTHENTICATE_ERROR
  • AUTHENTICATE_FAILED
  • AUTHENTICATE_FAILED_ACS_ERROR
  • AUTHENTICATE_FRICTIONLESS_FAILED
  • AUTHENTICATE_REJECTED
  • AUTHENTICATE_SIGNATURE_VERIFICATION_FAILED
  • AUTHENTICATE_SUCCESSFUL
  • AUTHENTICATE_UNABLE_TO_AUTHENTICATE
  • AUTHENTICATION_BYPASSED
  • AUTHENTICATION_UNAVAILABLE
  • CHALLENGE_REQUIRED
  • DATA_ONLY_SUCCESSFUL
  • LOOKUP_BYPASSED
  • LOOKUP_CARD_ERROR
  • LOOKUP_ENROLLED
  • LOOKUP_ERROR
  • LOOKUP_FAILED_ACS_ERROR
  • LOOKUP_NOT_ENROLLED
  • LOOKUP_SERVER_ERROR
  • UNSUPPORTED_ACCOUNT_TYPE
  • UNSUPPORTED_CARD
  • UNSUPPORTED_THREE_D_SECURE_VERSION
ThreeDSecureAuthenticationStatusIndicator
Indicates the current status of the 3D Secure authentication.
enum values:
  • AUTHENTICATION_REJECTED
  • CHALLENGE_REQUIRED_DECOUPLED_AUTHENTICATION
  • CHALLENGE_REQUIRED_FOR_AUTHENTICATION
  • FAILED_AUTHENTICATION
  • INFORMATIONAL_CHALLENGE_PREFERENCE_ACKNOWLEDGED
  • SUCCESSFUL_ATTEMPTS_TRANSACTION
  • SUCCESSFUL_AUTHENTICATION
  • UNABLE_TO_COMPLETE_AUTHENTICATION
ThreeDSecureAuthenticationTransactionType
Indicates the type of transaction for 3D Secure authentication.
enum values:
  • ADD_CARD
  • CARDHOLDER_VERIFICATION
  • INSTALLMENT
  • MAINTAIN_CARD
  • PAYMENT
  • RECURRING
ThreeDSecureCardEnrolled
Indicates whether the card is enrolled in a 3D Secure program.
enum values:
  • BYPASS
    Authentication has been bypassed. This status will be returned if you set up bypass rules with CardinalCommerce, and they are triggered.
  • ERROR
    There was an error in determining whether the card is enrolled in a 3D Secure program.
  • NO
    The card is not enrolled.
  • UNAVAILABLE
    The DS (directory server) or ACS (access control server) is not available for authentication at the time of the request.
  • YES
    The card is enrolled.
ThreeDSecureLookupShippingMethod
Indicates the shipping method chosen for the transaction in the 3D Secure lookup.
enum values:
  • ELECTRONIC_DELIVERY
  • GROUND
  • OVERNIGHT_EXPEDITED
  • PRIORITY
  • SAME_DAY
  • SHIP_TO_STORE
TransactionInstallmentAdjustmentType
Transaction Installment Adjustment type to indicate the reason for the adjustment.
enum values:
  • DISPUTE
    Dispute.
  • REFUND
    Refund.
TransactionLineItemType
Indicates whether a transaction line item is a debit (sale) or credit (refund).
enum values:
  • CREDIT
  • DEBIT
UsBankAccountOwnershipType
The ownership type of US Bank Account.
enum values:
  • BUSINESS
  • PERSONAL
UsBankAccountType
The type of US Bank Account.
enum values:
  • CHECKING
  • SAVINGS
  • UNKNOWN
UsBankAccountVerificationMethod
The type of verification on a US bank account payment method. See our [ACH guide](https://articles.braintreepayments.com/guides/payment-methods/ach#verification-methods).
enum values:
  • INDEPENDENT_CHECK
    Verification conducted independently by the merchant, not through Braintree.
  • MICRO_TRANSFERS
    Verification by micro-deposits transferred to the bank account, which the customer must then confirm. The most reliable method, but takes additional time.
  • NETWORK_CHECK
    Verification via account information. Will complete the verification process immediately, but is not supported by all banks.
  • TOKENIZED_CHECK
    Verification at the point of tokenization. Requires integration with a third-party provider. Because this requires a different tokenization flow, this method of verification is only supported for vaulting tokenized US bank account logins, and is not supported when re-verifying a US bank account payment method.
UsStateCode
A two-letter code representing a US state or territory.
enum values:
  • AK
  • AL
  • AR
  • AS
  • AZ
  • CA
  • CO
  • CT
  • DC
  • DE
  • FL
  • GA
  • GU
  • HI
  • IA
  • ID
  • IL
  • IN
  • KS
  • KY
  • LA
  • MA
  • MD
  • ME
  • MI
  • MN
  • MO
  • MP
  • MS
  • MT
  • NC
  • ND
  • NE
  • NH
  • NJ
  • NM
  • NV
  • NY
  • OH
  • OK
  • OR
  • PA
  • PR
  • RI
  • SC
  • SD
  • TN
  • TX
  • UM
  • UT
  • VA
  • VI
  • VT
  • WA
  • WI
  • WV
  • WY
UserStatus
The status of the user.
enum values:
  • ACTIVE
  • DELETED
  • PASSIVE
  • PENDING
  • SUSPENDED
VaultPaymentMethodCriteria
Defines criteria for vaulting a single-use payment method after transacting with it.
enum values:
  • ALWAYS
    Always store the single-use payment method after transacting, regardless of the status of the transaction.
  • ON_SUCCESSFUL_TRANSACTION
    Only store the single-use payment method if it was successfully authorized.
VaultQRCOverride
The override options for QR code vaulting.
enum values:
  • HIDE_QRC
    Do not show QR code as a payment option, even if it is enabled.
  • SHOW_QRC_NO_VAULT
    If QR codes are enabled, show as a payment option, but do not vault.
VenmoEnvironment
The environment being used for Venmo.
enum values:
  • PRODUCTION
  • SANDBOX
  • production
  • sandbox
VerificationStatus
The status of the verification, indicating whether the payment method was successfully verified. Braintree recommends only vaulting payment methods with successful verifications.
enum values:
  • FAILED
    Indicates the verification was unsuccessful because of an issue communicating with the processor.
  • GATEWAY_REJECTED
    Indicates that the verification was unsuccessful because the payment method failed one or more fraud checks. In this case, the `gatewayRejectionReason` will indicate which fraud check failed.
  • PENDING
    Indicates that the verification is pending.
  • PROCESSOR_DECLINED
    Indicates that the verification was unsuccessful based on the response from the processor.
  • VERIFIED
    Indicates that the verification was successful.
  • VERIFYING
    Indicates that the verification is in the process of verifying.

Inputs

AcceptDisputeInput
Top-level input fields for accepting a dispute.
input:
  • clientMutationId: String
    An identifier used to reconcile requests and responses. 255 characters maximum.
  • disputeId: ID!
    The ID of the dispute to be accepted.
AccountCreationStatusSearchInput
Input fields for searching for BusinessAccountCreationRequests by their `AccountCreationStatus`.
input:
AddressInput
Input fields for an Address.
input:
  • company: String
    Company name. 255 character maximum.
  • streetAddress: String
    The street address. 255 character maximum.
  • addressLine1: String
    The first line of the street address, such as street number, street name. 255 character maximum.
  • extendedAddress: String
    Extended address information, such as an apartment or suite number. 255 character maximum.
  • addressLine2: String
    Extended address information, such as apartment number or suite number. 255 character maximum.
  • firstName: String
    First name. 255 character maximum.
  • lastName: String
    Last name. 255 character maximum.
  • locality: String
    Locality/city. 255 character maximum.
  • adminArea2: String
    A city, town or village. 255 character maximum.
  • region: String
    State or province. 255 character maximum.
  • adminArea1: String
    Highest level subdivision, such as state, province or ISO-3166-2 subdivision. 255 character maximum.
  • postalCode: String
    Postal code in any country's format, otherwise known as CAP, CEP, Eircode, NPA, PIN, PLZ, or ZIP code. Nine alphanumeric characters maximum, may also contain spaces and hyphens. *Required for Level 3 processing*.
  • countryCode: CountryCode
    Country code for the address. *Required for Level 3 processing*.
AuthenticationInsightInput
Input fields when requesting authentication insight for a payment method.
input:
  • merchantAccountId: ID!
    ID of the merchant account that will be used when charging this payment method.
  • amount: Amount
    The intended transaction amount to be authorized on this payment method.
  • recurringCustomerConsent: Boolean
    A flag indicating whether the customer has consented to further recurring transactions.
  • recurringMaxAmount: Amount
    The maximum amount permitted for recurring transactions set by the customer.
AuthorizeCreditCardInput
Top-level input fields for creating a transaction by authorizing a credit card.
input:
  • clientMutationId: String
    An identifier used to reconcile requests and responses. 255 characters maximum.
  • paymentMethodId: ID!
    ID of a credit card payment method to be authorized.
  • options: CreditCardTransactionOptionsInput
    Input fields related to the credit card being authorized.
  • transaction: TransactionInput!
    Input fields for the authorization, with details that will define the resulting transaction.
AuthorizePayPalAccountInput
Top-level input fields for creating a transaction by authorizing a PayPal account.
input:
  • clientMutationId: String
    An identifier used to reconcile requests and responses. 255 characters maximum.
  • paymentMethodId: ID!
    ID of a PayPal payment method to be authorized.
  • options: AuthorizePayPalAccountOptionsInput
    Input fields related to the PayPal account being authorized.
  • transaction: TransactionInput!
    Input fields for the authorization, with details that will define the resulting transaction.
AuthorizePayPalAccountOptionsInput
Input fields for authorizing a PayPal account.
input:
  • customField: String
    Variable passed directly to PayPal for your own tracking purposes. Customers do not see this value.
  • description: String
    Description of the transaction that is displayed to customers in PayPal email receipts.
AuthorizePaymentMethodInput
Top-level input fields for creating a transaction by authorizing a payment method.
input:
  • clientMutationId: String
    An identifier used to reconcile requests and responses. 255 characters maximum.
  • paymentMethodId: ID!
    ID of a payment method to be authorized.
  • transaction: TransactionInput!
    Input fields for the authorization, with details that will define the resulting transaction.
AuthorizeVenmoAccountInput
Top-level input fields for creating a transaction by authorizing a Venmo account.
input:
  • clientMutationId: String
    An identifier used to reconcile requests and responses. 255 characters maximum.
  • paymentMethodId: ID!
    ID of a Venmo payment method to be authorized.
  • options: AuthorizeVenmoAccountOptionsInput
    Input fields related to the Venmo account being authorized.
  • transaction: TransactionInput!
    Input fields for the authorization, with details that will define the resulting transaction.
AuthorizeVenmoAccountOptionsInput
Input fields for authorizing a Venmo account.
input:
  • profileId: String
    Specifies which Venmo business profile to use for the transaction.
BusinessAccountCreationRequestSearchInput
Input fields for searching for BusinessAccountCreationRequests.
input:
CaptureTransactionInput
Top-level input fields for capturing an authorized transaction.
input:
  • clientMutationId: String
    An identifier used to reconcile requests and responses. 255 characters maximum.
  • transactionId: ID!
    ID of the transaction to be captured.
  • transaction: CaptureTransactionOptionsInput
    Input fields for the capture, with details that will define the resulting transaction.
CaptureTransactionOptionsInput
Input fields for a capture, with details that will define the resulting transaction.
input:
  • amount: Amount
    The amount to capture on the transaction. Must be greater than 0. You can't capture more than the authorized amount unless your industry and processor support settlement adjustment (capturing a certain percentage over the authorized amount); [contact us for assistance](https://help.braintreepayments.com?issue=TransactionProcessingQuestion). If you capture an amount that is less than what was authorized, the transaction object will return the amount captured.
  • descriptor: TransactionDescriptorInput
    Fields used to define what will appear on a customer's bank statement for a specific purchase. If specified, this will update the existing descriptor on the transaction.
  • discountAmount: String
    Discount amount that was included in the total transaction amount. Does not add to the total amount the payment method will be charged. This value can't be negative. Please note that this field is not used on PayPal transactions. *Required for Level 3 processing*.
  • lineItems: [TransactionLineItemInput!]
    Line items for this transaction. Up to 249 line items may be specified. *Required for Level 3 processing*.
  • orderId: String
    Additional information about the transaction. On PayPal transactions, this field maps to the PayPal invoice number. PayPal invoice numbers must be unique in your PayPal business account. Maximum 255 characters or 127 for PayPal transactions. If specified, this will update the existing order ID on the transaction.
  • purchaseOrderNumber: String
    A purchase order identification value you associate with this transaction. *Required for Level 2 processing*.
  • shipping: TransactionShippingInput
    Shipping information. *Required for Level 3 processing*.
  • tax: TransactionTaxInput
    Tax information about the transaction. *Required for Level 2 processing*.
ChargeCreditCardInput
Top-level input fields for creating a transaction by charging a credit card.
input:
  • clientMutationId: String
    An identifier used to reconcile requests and responses. 255 characters maximum.
  • paymentMethodId: ID!
    ID of a credit card payment method to be charged.
  • options: CreditCardTransactionOptionsInput
    Input fields for creating a credit card transaction.
  • transaction: TransactionInput!
    Input fields for the charge, with details that will define the resulting transaction.
ChargePayPalAccountInput
Top-level input fields for creating a transaction by charging a PayPal account.
input:
  • clientMutationId: String
    An identifier used to reconcile requests and responses. 255 characters maximum.
  • paymentMethodId: ID!
    The ID of an existing PayPal account.
  • options: ChargePayPalAccountOptionsInput
    Input fields related to the PayPal account being charged.
  • transaction: TransactionInput!
    Input fields for the charge, with details that will define the resulting transaction.
ChargePayPalAccountOptionsInput
Input fields for creating a transaction with a PayPal account.
input:
  • customField: String
    Variable passed directly to PayPal for your own tracking purposes. Customers do not see this value.
  • description: String
    Description of the transaction that is displayed to customers in PayPal email receipts.
  • selectedFinancingOption: SelectedPayPalFinancingOptionInput
    Buyer selected PayPal financing option.
ChargePaymentMethodInput
Top-level input fields for creating a transaction by charging a payment method.
input:
  • clientMutationId: String
    An identifier used to reconcile requests and responses. 255 characters maximum.
  • paymentMethodId: ID!
    ID of a payment method to be charged.
  • transaction: TransactionInput!
    Input fields for the charge, with details that will define the resulting transaction.
ChargeUsBankAccountInput
Top-level input fields for creating a transaction by charging a US bank account.
input:
  • clientMutationId: String
    An identifier used to reconcile requests and responses. 255 characters maximum.
  • paymentMethodId: ID!
    The ID of an existing US bank account.
  • options: ChargeUsBankAccountOptionsInput
    Input fields related to the US bank account being charged.
  • transaction: TransactionInput!
    Input fields for the charge, with details that will define the resulting transaction.
ChargeUsBankAccountOptionsInput
Input fields for creating a transaction with a US bank account.
input:
  • standardEntryClassCode: ACHStandardEntryClassCode
    A NACHA standard entry class (SEC) code, which designates how the transaction was authorized. Most internet-based sales should use the `WEB` code.
ChargeVenmoAccountInput
Top-level input fields for creating a transaction by charging a Venmo account.
input:
  • clientMutationId: String
    An identifier used to reconcile requests and responses. 255 characters maximum.
  • paymentMethodId: ID!
    The ID of an existing Venmo account.
  • options: ChargeVenmoAccountOptionsInput
    Input fields for creating a Pay with Venmo transaction.
  • transaction: TransactionInput!
    Input fields for the charge, with details that will define the resulting transaction.
ChargeVenmoAccountOptionsInput
Input fields for creating a Pay with Venmo transaction.
input:
  • profileId: String
    Specifies which Venmo business profile to use for the transaction.
ClientTokenInput
Input fields for creating a client token.
input:
  • merchantAccountId: ID
    The merchant account ID used to create the client token. Defaults to your default merchant account ID.
  • customerId: ID
    The ID of an existing customer. Including this will allow your customer to vault and manage their payment methods.
ConfirmMicroTransferAmountsInput
Top-level input field for confirming micro-transfer values.
input:
  • clientMutationId: String
    An identifier used to reconcile requests and responses. 255 characters maximum.
  • verificationId: ID!
    The ID of the verification from vaulting the bank account.
  • amountsInCents: [Int!]!
    The amounts, in cents, of two deposits made into the customer's bank account after initiating a MICRO_TRANSFERS verification. These values should be collected from your customer.
CreateClientTokenInput
Top-level input field for generating a client token.
input:
  • clientMutationId: String
    An identifier used to reconcile requests and responses. 255 characters maximum.
  • clientToken: ClientTokenInput
    Input fields for creating a client token.
CreateCustomerInput
Top-level field for creating a customer.
input:
  • clientMutationId: String
    An identifier used to reconcile requests and responses. 255 characters maximum.
  • customer: CustomerInput
    Input fields for creating a customer.
CreateDisputeFileEvidenceInput
Top-level input fields for adding file evidence to a dispute.
input:
  • clientMutationId: String
    An identifier used to reconcile requests and responses. 255 characters maximum.
  • disputeId: ID!
    The ID of the dispute to be accepted.
  • category: DisputeFileEvidenceCategory
    The category for the evidence file.
CreateDisputeTextEvidenceInput
Top-level input fields for creating text evidence for a dispute.
input:
  • clientMutationId: String
    An identifier used to reconcile requests and responses. 255 characters maximum.
  • disputeId: ID!
    The ID of the dispute to create the evidence for.
  • category: DisputeTextEvidenceCategory
    The category of the text evidence.
  • content: String!
    The content of the text evidence.
CreateInStoreLocationInput
Input fields for creating an in store location.
input:
  • clientMutationId: String
    An identifier used to reconcile requests and responses. 255 characters maximum.
  • location: InStoreLocationInput!
    Input fields to create an in-store Location.
CreateNonInstantLocalPaymentContextInput
Top-level input fields for creating a non-instant local payment context.
input:
  • clientMutationId: String
    An identifier used to reconcile requests and responses. 255 characters maximum.
  • paymentContext: NonInstantLocalPaymentContextInput!
    Input fields for creating a non-instant local payment context.
CreatePayPalBillingAgreementInput
Top-level input field for creating a PayPal Billing Agreement Token.
input:
  • clientMutationId: String
    An identifier used to reconcile requests and responses. 255 characters maximum.
  • merchantAccountId: ID
    Braintree merchant account ID associated with the PayPal account to be used for the Billing Agreement creation.
  • returnUrl: URL!
    URL for redirect back to merchant app on the client indicating successful approval.
  • cancelUrl: URL!
    URL for redirect back to merchant app on the client indicating unsuccessful approval.
  • description: String
    Description of the PayPal Billing Agreement, displayed to the PayPal user on paypal.com and other PayPal user experiences.
  • email: EmailAddress
    Email of the payer (if known). This will prepopulate the input field in the PayPal approval page.
  • offerPayPalCredit: Boolean
    Indicates whether PayPal Credit should be offered in the PayPal approval flow.
  • paypalRiskCorrelationId: ID
    PayPal Risk correlation ID (also known as the Client Metadata ID).
  • paypalExperienceProfile: PayPalExperienceProfileInput
    Defines the experience profile used to render the approval flow.
  • shippingAddress: AddressInput
    Merchant-provided shipping address. Fields addressLine1, adminArea2, and countryCode are required for Billing Agreements.
CreatePayPalOneTimePaymentInput
Top-level input field for creating a PayPal One-Time Payment.
input:
  • clientMutationId: String
    An identifier used to reconcile requests and responses. 255 characters maximum.
  • merchantAccountId: ID
    Braintree merchant account ID associated with the PayPal account to be used for the One-Time payment creation.
  • amount: MonetaryAmountInput!
    Total amount for payment to be charged to consumer.
  • cancelUrl: URL!
    URL for redirect back to merchant app on the client indicating unsuccessful approval.
  • email: EmailAddress
    Email of the payer. This will prepopulate the input field in the PayPal approval login page.
  • intent: PayPalIntent!
    The payment intent.
  • lineItems: [PayPalLineItemInput!]
    The line items for this transaction. Maximum 249 line items.
  • offerPayLater: Boolean
    Indicates whether PayPal Pay Later should be offered in the PayPal approval flow.
  • paypalRiskCorrelationId: ID
    PayPal Risk correlation ID (also known as the Client Metadata ID).
  • paypalExperienceProfile: PayPalExperienceProfileInput
    Defines the experience profile used to render the approval flow.
  • requestBillingAgreement: Boolean
    Indicates whether this payment uses the [Billing Agreement with Purchase flow](https://developers.braintreepayments.com/guides/paypal/checkout-with-paypal/javascript/v3#checkout-using-paypal-billing-agreement-with-purchase-flow). This will request Billing Agreement approval from the customer, and a multi-use PayPal payment method will be created alongside the transaction.
  • billingAgreementDescription: String
    A description of the Billing Agreement being requested. This is displayed to the customer on paypal.com when `requestBillingAgreement` is true. Maximum 127 characters.
  • returnUrl: URL!
    URL for redirect back to merchant app on the client indicating successful approval.
  • shippingAddress: AddressInput
    Merchant-provided shipping address. If passing a shipping address, fields addressLine1, adminArea2, and countryCode are required.
  • shippingOptions: [PayPalShippingOptionInput!]
    List of shipping options offered by the payee or merchant to the payer to ship or pick up their items. **Note:** `shippingOptions` may not be passed with intent `ORDER` payments.
CreateUniversalAccessTokenInput
Top-level input field for generating a PayPal access token.
input:
  • clientMutationId: String
    An identifier used to reconcile requests and responses. 255 characters maximum.
  • customerId: ID
    The ID of an existing customer. Including this will allow the access token to interact with this customer's data.
  • type: ACRType!
    Authentication context class reference for the universal access token.
CreditCardFraudToolsOptionsInput
Input fields that allow you to skip certain fraud checks. These will override Control Panel settings.
input:
  • skipCvv: Boolean
    Skip CVV checks. Will result in a `cvvResponse` of `BYPASS` in the response from the processor.
  • skipAvs: Boolean
    Skip AVS checks. Will result in an `avsPostalCodeResponse` of `BYPASS` in the response from the processor.
  • skipAdvancedFraudChecking: Boolean
    Skip [advanced fraud checks](https://developers.braintreepayments.com/guides/advanced-fraud-management-tools/overview).
CreditCardInput
Input fields for a credit card.
input:
  • number: String
    The 12-to-19-digit value that uniquely identifies this credit card, also known as the primary account number or PAN.
  • expirationYear: String
    The two- or four-digit year associated with a credit card, formatted `YYYY` or `YY`.
  • expirationMonth: String
    The expiration month of a credit card, formatted `MM`.
  • cvv: String
    A three- or four-digit card verification value assigned to credit cards. The CVV will never be stored, but it can be provided with one-time requests to verify the card.
  • cardholderName: String
    When supplied, the cardholder name that will be tokenized with the contents of the fields.
  • billingAddress: AddressInput
    The billing address for the credit card.
CreditCardTransactionOptionsInput
Input fields for creating a transaction by authorizing or charging a credit card.
input:
  • externalVault: TransactionExternalVaultOptionsInput
    Details about this transaction if it's being created from a credit card that is or will be stored in an non-Braintree vault.
  • billingAddress: AddressInput
    A billing address to use for the transaction. If a billing address was provided when tokenizing or is present on the vaulted credit card, it will be *merged* with this input value, with priority given to this input value.
  • accountType: CardAccountType
    The type of account to be used when transacting with a combo card.
  • tokenizedCvv: ID
    The CVV for the credit card to be used when creating this transction, securely tokenized with the `tokenizeCvv` mutation.
  • fraudTools: CreditCardFraudToolsOptionsInput
    Control which fraud tools will be applied to this transaction. Fraud tools cannot be retroactively applied to a transaction if skipped.
  • threeDSecureAuthentication: ThreeDSecureAuthenticationInput
    3D Secure authentication information performed for this transaction. Only use these fields if you are charging or authorizing a single-use payment method ID that was *not* generated by a 3DS flow on on the client.
  • scaExemption: ScaExemptionType
    The type of Strong Customer Authentication Exemption requested.
  • installmentCount: Int
    Number of monthly installments (can be anywhere between 2 and 12).
CreditCardVerificationOptionsInput
Input fields that specify options for verifying the credit card.
input:
  • accountType: CardAccountType
    The type of account to be used when verifying a combo card.
  • riskData: RiskDataInput
    Customer device information, which is sent directly to supported processors for fraud analysis.
  • fraudTools: CreditCardFraudToolsOptionsInput
    Control which fraud tools will be applied to this verification. Fraud tools cannot be retroactively applied to a verification if skipped.
  • tokenizedCvv: ID
    The CVV for the credit card to be used when verifying the credit card, securely tokenized with the `tokenizeCvv` mutation.
  • amount: Amount
    The amount to use to verify the credit card.
  • skip: Boolean
    Whether to opt out of verifying the credit card. Defaults to `false`. Clients should only pass `true` in the uncommon scenario that the credit card has been verified externally to Braintree.
CustomActionsPaymentContextFieldInput
Fields that are provided when creating the payment context.
input:
  • name: String!
    An alphanumeric string used as a key to lookup a CustomField value (255 characters maximum).
  • value: String!
    An alphanumeric string used to store a CustomField value (7168 characters maximum).
CustomActionsPaymentMethodFieldInput
Fields that are provided during tokenization and are presented to the invoked action to be consumed.
input:
  • name: String!
    The name of this field. e.g. "accountNumber".
  • value: String!
    The value of this field. e.g. "123456789".
  • displayValue: String!
    The value displayed in the Control Panel or API. e.g. "*****6789".
CustomActionsPaymentMethodInput
Input fields for a Custom Actions payment method.
input:
CustomFieldInput
Custom field name/value pairs. Maximum 255 characters. You must [set up each custom field in the Control Panel](https://articles.braintreepayments.com/control-panel/custom-fields#creating-a-custom-field) prior to passing it with a request.
input:
  • name: CustomFieldName!
    Name of the custom field as defined in the Control Panel.
  • value: String
    Value for the named custom field. A null value will ignore (on create) or remove (on update) the custom field.
CustomerInput
Input fields for creating or updating a customer. On update, omitted fields will not be updated. Passing a null value will assign null to that field.
input:
  • company: String
    Company or business name associated with the customer.
  • customFields: [CustomFieldInput!]
    Collection of custom field/value pairs. You must [set up each custom field in the Control Panel](https://articles.braintreepayments.com/control-panel/custom-fields#creating-a-custom-field) prior to passing it with a request.
  • email: String
    Email address for the customer.
  • firstName: String
    Customer's first name.
  • lastName: String
    Customer's last name.
  • phoneNumber: String
    The customer's phone number.
  • taxIdentifiers: [CustomerTaxIdentifierInput!]
    A set of country code ID pairs, analogous to Social Security numbers in the United States. A customer may have multiple tax identifiers, but only one per tax jurisdiction. The values provided for an update will be stored and previous entries will be updated. **Note:** You will only need to use these fields for processing in certain countries.
CustomerSearchInput
Input fields for searching for customers.
input:
CustomerTaxIdentifierInput
The customer's tax identifer for a given tax jurisdiction.
input:
  • identifier: String!
    The identifier provided in the format required for the given tax jurisdiction.
  • countryCode: CountryCode!
    The country code of the tax jurisdiction for this tax identifier.
DeleteCustomerInput
Top-level input fields for deleting a customer.
input:
  • clientMutationId: String
    An identifier used to reconcile requests and responses. 255 characters maximum.
  • customerId: ID!
    The ID of the customer to be deleted.
DeleteDisputeEvidenceInput
Input fields for deleting dispute evidence.
input:
  • clientMutationId: String
    An identifier used to reconcile requests and responses. 255 characters maximum.
  • evidenceId: ID!
    The ID of the evidence to be deleted.
  • disputeId: ID!
    The ID of the dispute that the evidence belongs to.
DeletePaymentMethodFromSingleUseTokenInput
Top-level input fields for deleting a payment method referenced by a single-use token.
input:
  • clientMutationId: String
    An identifier used to reconcile requests and responses. 255 characters maximum.
  • singleUseTokenId: ID!
    A single-use token ID referencing a payment method.
DeletePaymentMethodFromVaultInput
Top-level input fields for deleting a multi-use payment method from the vault.
input:
  • clientMutationId: String
    An identifier used to reconcile requests and responses. 255 characters maximum.
  • paymentMethodId: ID!
    The ID of the multi-use payment method to be deleted.
  • initiatedBy: PaymentMethodDeletionInitiator
    Indicates whether this deletion was initiated by the merchant or the customer (via the merchant site/app).
  • deleteRelatedPaymentMethods: Boolean
    Additionally request deletion of all related payment methods (ones that store the same underlying payment instrument as the one specified by `paymentMethodId`) across all customers for current merchant.
  • fraudRelated: Boolean
    Indicates if this deletion is related to suspected fraud, as determined by the merchant.
DetachedRefundInput
Specific input fields for describing a detached refund.
input:
  • amount: Amount!
    The amount to refund.
  • orderId: String
    The refund's order ID.
  • merchantAccountId: ID
    ID of the merchant account that will be used when performing the refund.
  • customFields: [CustomFieldInput!]
    Collection of custom field/value pairs. You must [set up each custom field in the Control Panel](https://articles.braintreepayments.com/control-panel/custom-fields#creating-a-custom-field) prior to passing it with a request.
  • descriptor: TransactionDescriptorInput
    Fields used to define what will appear on a customer's statement (for instance, credit card or bank statement) for this refund. This should match the original transaction if possible.
DisputeSearchInput
Input fields for searching for Disputes.
input:
DisputeTransactionSearchInput
Transaction input fields for searching for disputes.
input:
  • transactionId: SearchValueInput
    Find disputes for a transaction id or ids.
  • customerId: SearchValueInput
    Find disputes for a customer id or ids.
  • transactionSource: SearchTransactionSourceInput
    Find disputes with a given transaction source.
  • paymentMethodSnapshotType: SearchPaymentMethodSnapshotTypeInput
    Find disputes on transactions charging payment methods of the given type.
  • facilitatorOAuthApplicationClientId: SearchValueInput
    Find disputes on transactions created by a third party via the Grant API using a given OAuth application client ID.
  • disbursementDate: SearchDateInput
    Find disputes by the transaction's disbursement date.
  • merchantAccountId: SearchValueInput
    Find disputes on transactions associated with a merchant account ID or IDs.
ExchangeRateQuoteInput
Input to generate the exchange rate quote.
input:
  • baseCurrency: CurrencyCodeAlpha!
    The currency code from which the exchange rate will be used to convert to the `quoteCurrency`.
  • quoteCurrency: CurrencyCodeAlpha!
    The currency code to which the exchange rate will be used to convert from `baseCurrency`.
  • baseAmount: Amount
    The amount in the `baseCurrency` to be converted to the `quoteCurrency`. If this is provided, the result will include the converted amount properly rounded.
  • markup: Percentage
    A percentage added into the exchange rate. This allows the merchant to settle for more than the quoted `tradeRate`.
FinalizeDisputeInput
Top-level input fields for finalizing a dispute.
input:
  • clientMutationId: String
    An identifier used to reconcile requests and responses. 255 characters maximum.
  • disputeId: ID!
    The ID of the dispute to be finalized.
GenerateExchangeRateQuoteInput
Input to generate a list of exchange rate quotes.
input:
  • clientMutationId: String
    An identifier used to reconcile requests and responses. 255 characters maximum.
  • quotes: [ExchangeRateQuoteInput!]!
    Base and quote currency combinations for which the quote will be generated.
GeoCoordinatesInput
Coordinates describing a geographic position.
input:
  • latitude: Float!
    The angular distance of a place north or south of the earth's equator. A positive value is north of the equator, a negative value is south of the equator.
  • longitude: Float!
    The angular distance of a place east or west of the meridian at Greenwich, England. A positive value is east of the prime meridian, a negative value is west of the prime meridian.
InStoreDisplayItemInput
Input fields for an individual display item on an in-store reader.
input:
  • kind: DisplayItemType!
    The display item type to be displayed on the in-store reader.
  • description: String
    The display item text to be displayed on the in-store reader. 35 character maximum.
  • quantity: Float
    The number of units for a CHARGE or DISCOUNT item. Must be greater than 0.
  • amount: Amount
    The total amount of a CHARGE or DISCOUNT item.
InStoreLocationAddressInput
Input fields for an in-store Location Address.
input:
  • streetAddress: String!
    The street address.
  • extendedAddress: String
    Extended address information, such as an apartment or suite number.
  • locality: String!
    Locality/city.
  • region: String!
    State or province.
  • postalCode: String!
    Postal code in any country's format, otherwise known as CAP, CEP, Eircode, NPA, PIN, PLZ, or ZIP code.
  • countryCode: CountryCode!
    Country code for the address.
InStoreLocationAddressUpdateInput
Input fields for an in-store Location Address update.
input:
  • streetAddress: String
    The street address.
  • extendedAddress: String
    Extended address information, such as an apartment or suite number.
  • locality: String
    Locality/city.
  • region: String
    State or province.
  • postalCode: String
    Postal code in any country's format, otherwise known as CAP, CEP, Eircode, NPA, PIN, PLZ, or ZIP code.
  • countryCode: CountryCode
    Country code for the address.
InStoreLocationInput
Fields required for an instore location.
input:
  • name: String!
    The publicly visible label of this Location.
  • internalName: String!
    Name assigned by the merchant to uniquely identify this Location.
  • address: InStoreLocationAddressInput!
    The address of the in-store Location.
  • geoCoordinates: GeoCoordinatesInput!
    The coordinates of this location.
  • payerId: ID
    The PayPal account ID to which this Location will be added.
  • enableQRCodePayments: Boolean!
    Whether QR code payments will be enabled for this location.
InStoreLocationUpdateInput
Fields required to update an in-store location.
input:
  • name: String
    The publicly visible label of this location.
  • internalName: String
    Name assigned by the merchant to uniquely identify this location.
  • address: InStoreLocationAddressUpdateInput
    The address of the location.
  • geoCoordinates: GeoCoordinatesInput
    The coordinates of this location.
  • payerId: ID
    The PayPal account ID to which this location will be added.
  • enableQRCodePayments: Boolean
    Whether QR code payments will be enabled for this location.
InStoreReaderSearchInput
Input fields for searching for in-store readers.
input:
InStoreReaderSetupInput
Fields that are reader specific for pairing a reader.
input:
  • locationId: ID!
    In-Store Location to attach Reader to.
  • name: String
    Name given to the Reader.
InStoreRefundInput
Input fields for creating an in-store transaction.
input:
  • amount: Amount!
    Refund amount of the request. This value must be greater than 0, and must match the currency format of the merchant account. This can only contain numbers and one decimal point (e.g. x.xx). Can't be greater than the maximum allowed by the processor.
  • merchantAccountId: ID
    Merchant account ID used to process the refund. Currency is also determined by merchant account ID. If no merchant account ID is specified, we will use your default merchant account.
  • orderId: String
    Additional information about the refund. On PayPal refunds, this field maps to the PayPal invoice number. PayPal invoice numbers must be unique in your PayPal business account. Maximum 255 characters or 127 for PayPal refunds.
  • customFields: [CustomFieldInput!]
    Collection of custom field/value pairs. You must [set up each custom field in the Control Panel](https://articles.braintreepayments.com/control-panel/custom-fields#creating-a-custom-field) prior to passing it with a request.
  • descriptor: TransactionDescriptorInput
    Fields used to define what will appear on a customer's bank statement for a specific purchase.
InStoreTransactionInput
Input fields for creating an in-store transaction.
input:
  • amount: Amount!
    Billing amount of the request. This value must be greater than 0, and must match the currency format of the merchant account. This can only contain numbers and one decimal point (e.g. x.xx). Can't be greater than the maximum allowed by the processor.
  • merchantAccountId: ID
    Merchant account ID used to process the transaction. Currency is also determined by merchant account ID. If no merchant account ID is specified, we will use your default merchant account.
  • orderId: String
    Additional information about the transaction. On PayPal transactions, this field maps to the PayPal invoice number. PayPal invoice numbers must be unique in your PayPal business account. Maximum 255 characters or 127 for PayPal transactions.
  • customFields: [CustomFieldInput!]
    Collection of custom field/value pairs. You must [set up each custom field in the Control Panel](https://articles.braintreepayments.com/control-panel/custom-fields#creating-a-custom-field) prior to passing it with a request.
  • descriptor: TransactionDescriptorInput
    Fields used to define what will appear on a customer's bank statement for a specific purchase.
  • customerId: ID
    If charging a single-use payment method, optional ID of a customer to associate the transaction with. If vaulting the single-use payment method, this customer will be associated with the resulting multi-use payment method.
  • vaultPaymentMethodAfterTransacting: VaultInStorePaymentMethodAfterTransactingInput
    When a single-use payment method is used to create this transaction, it can be automatically stored in the vault after transacting. If this field is left blank, the single-use payment method will not be vaulted.
  • channel: String
    For partners and shopping carts only. If you are a shopping cart provider or other Braintree partner, pass a string identifier for your service. For PayPal transactions, this maps to paypal.bn_code.
LocalPaymentAddressInput
Input fields for local payment addresses.
input:
  • streetAddress: String
    The street address.
  • extendedAddress: String
    Extended address information, such as an apartment or suite number.
  • locality: String
    Locality/city.
  • region: String
    State or province.
  • postalCode: String
    Postal code in any country's format, otherwise known as CAP, CEP, Eircode, NPA, PIN, PLZ, or ZIP code.
  • countryCode: CountryCode
    Country code for the address.
LocalPaymentPayerInfoInput
Input fields for the payer of a local payment.
input:
MerchantAccountSearchInput
Input fields for searching for merchant accounts.
input:
MonetaryAmountInput
Input fields representing an amount with currency.
input:
  • value: Amount!
    The amount of money, either a whole number or a number with up to 3 decimal places.
  • currencyCode: CurrencyCodeAlpha!
    The currency code for the monetary amount.
MonetaryAmountSearchInput
Input fields for searching for a transaction or refund amount.
input:
NameInput
The name of the party.
input:
  • prefix: String
    The prefix, or title, to the party name.
  • givenName: String!
    The party's given, or first, name. Required if the party is a person.
  • surname: String!
    The party's surname or family name. Also known as the last name. Required if the party is a person. Use also to store multiple surnames including the matronymic, or mother's, surname.
  • middleName: String
    The party's middle name. Use also to store multiple middle names including the patronymic, or father's, middle name.
  • suffix: String
    The suffix for the party's name.
  • alternateFullName: String
    The party's alternate name. Can be a business name, nickname, or any other name that cannot be split into first, last name. Required for a business party name.
NetworkTokenInput
Input fields for a network tokenized card.
input:
  • cryptogram: String!
    A one-time-use string generated by the token requester to validate the transaction.
  • eCommerceIndicator: ECommerceIndicator
    A two-digit string that should be passed along in the authorization message.
  • expirationMonth: Month!
    A two-digit string representing the expiration month of the DPAN.
  • expirationYear: Year!
    A four-digit string representing the expiration year of the DPAN.
  • number: CreditCardNumber!
    The card number used in processing. This is a device PAN (DPAN), not the backing card number (FPAN).
  • originDetails: NetworkTokenOriginDetailsInput!
    Additional information about a network token.
NetworkTokenOriginDetailsInput
Information about the network token, such as the origin of the network token, source card details, and other token requestor data.
input:
  • origin: NetworkTokenOrigin!
    The origin of the network token.
  • sourceCardDescription: String
    A string, suitable for display, that describes the backing card.
  • sourceCardLast4: CreditCardLast4
    The last 4 digits of the backing card number (FPAN).
  • sourceCardType: CreditCardBrandCode
    The card type of the backing card.
  • tokenRequestorId: String
    The token requestor ID of the entity that generated this network token.
  • transactionId: String
    The transaction ID for this network token.
NonInstantLocalPaymentContextInput
Input fields for non-instant local payment context.
input:
  • orderId: String
    The order id of the eventual Braintree transaction and the invoice number of the local payment context. Maximum 127 characters.
  • amount: MonetaryAmountInput!
    The amount of the local payment.
  • type: NonInstantLocalPaymentMethodType!
    The type of the non-instant local payment.
  • countryCode: CountryCode
    The country code of the local payment. For local payments supported in multiple countries, this value may determine which banks are presented to the customer.
  • locale: Language
    The language tag for the language in which to localize the error-related strings.
  • returnUrl: String!
    The URL where the customer is redirected after the customer approves the payment.
  • cancelUrl: String!
    The URL where the customer is redirected after the customer cancels the payment.
  • merchantAccountId: ID
    ID of the PayPal merchant account that will be used when charging this payment method.
  • payerInfo: LocalPaymentPayerInfoInput!
    The payer's information.
  • expiryDate: Date
    Overrides the default date at which the local payment context will expire. MULTIBANCO is not overridable.
PairInStoreReaderInput
Input fields for pairing an in store reader.
input:
  • clientMutationId: String
    An identifier used to reconcile requests and responses. 255 characters maximum.
  • userCode: String!
    Code displayed on Reader during pairing.
  • reader: InStoreReaderSetupInput!
    Inputs for Reader.
PartialCaptureTransactionInput
Top-level input fields for capturing outstanding funds authorized by a transaction.
input:
  • clientMutationId: String
    An identifier used to reconcile requests and responses. 255 characters maximum.
  • transactionId: ID!
    ID of the original authorized transaction to be partially captured.
  • transaction: PartialCaptureTransactionOptionsInput
    Input fields for the capture, with details that will define the resulting capture transaction.
PartialCaptureTransactionOptionsInput
Input fields for the capture, with details that will define the resulting capture transaction.
input:
  • amount: Amount!
    The amount to capture on the transaction against the parent authorization transaction. Must be greater than 0. You can perform multiple partial capture transactions as long as the cumulative amount of those transactions is less than or equal to the amount authorized by the parent transaction. You can't capture more than the authorized amount unless your industry and processor support settlement adjustment (capturing a certain percentage over the authorized amount); [contact us for assistance](https://help.braintreepayments.com?issue=TransactionProcessingQuestion).
  • discountAmount: String
    Discount amount that was included in the total transaction amount. Does not add to the total amount the payment method will be charged. This value can't be negative. Please note that this field is not on PayPal transactions. *Required for Level 3 processing*.
  • lineItems: [TransactionLineItemInput!]
    Line items for this transaction. Up to 249 line items may be specified. *Required for Level 3 processing*.
  • orderId: String
    Additional information about the transaction. On PayPal transactions, this field maps to the PayPal invoice number. PayPal invoice numbers must be unique in your PayPal business account. Maximum 255 characters or 127 for PayPal transactions. If specified, this will update the existing order ID on the transaction.
  • purchaseOrderNumber: String
    A purchase order identification value you associate with this transaction. *Required for Level 2 processing*.
  • shipping: TransactionShippingInput
    Shipping information. *Required for Level 3 processing*.
  • tax: TransactionTaxInput
    Tax information about the transaction. *Required for Level 2 processing*.
  • descriptor: TransactionDescriptorInput
    Fields used to define what will appear on a customer's bank statement for a specific purchase. If specified, this will update the existing descriptor on the transaction.
PayPalAccountInput
Input for identifying a PayPal account.
input:
  • payerId: ID
    The unique PayPal ID of the PayPal account.
PayPalBillingAgreementInput
Input fields for a PayPal account to be vaulted.
input:
  • billingAgreementToken: ID!
    The Billing Agreement token.
PayPalExperienceProfileInput
Controls the experience in a PayPal approval flow.
input:
  • brandName: String
    Merchant brand name to be displayed on the PayPal approval pages.
  • collectShippingAddress: Boolean
    Indicates whether a shipping address will be collected from the customer during the agreement approval flow.
  • landingPageType: PayPalLandingPageType
    Specifies the PayPal page to display when a user lands on the PayPal site to complete the payment.
  • locale: Language
    Locale of the PayPal payment approval experience.
  • shippingAddressEditable: Boolean
    Indicates whether to enable user editing of the shipping address. Only applies when shipping address is provided by merchant.
PayPalFinancingOptionsInput
Input fields for requesting information about PayPal financing options.
input:
  • paymentMethodId: ID!
    ID of an existing multi-use PayPal payment method to request financing options for.
  • amount: MonetaryAmountInput!
    The transaction currency and total amount to finance.
  • countryCode: CountryCodeAlpha2!
    The financing country code.
PayPalLineItemInput
Line items for a PayPal payment.
input:
  • name: String!
    Item name. Maximum 127 characters.
  • quantity: Int!
    Number of units of the item purchased. This value can't be negative or zero.
  • unitAmount: Amount!
    Per-unit price of the item. Can include up to 2 decimal places. This value can't be negative or zero.
  • type: TransactionLineItemType!
    Indicates whether the line item is a debit (sale) or credit (refund or discount) to the customer.
  • description: String
    Item description. Maximum 127 characters.
  • productCode: String
    Product or UPC code for the item. Maximum 127 characters.
  • unitTaxAmount: Amount!
    Per-unit tax price of the item. Can include up to 2 decimal places. This value can't be negative or zero.
  • url: URL
    The URL to product information.
PayPalOneTimePaymentInput
Input fields for a PayPal account for a One-Time payment.
input:
  • intent: PayPalIntent!
    The payment intent.
  • payerId: ID!
    The PayPal payer ID.
  • paymentId: ID!
    The PayPal payment ID. This ID is prefixed with "PAYID-".
  • paymentToken: ID!
    The PayPal payment token, also known as an Express Checkout token. This token is prefixed with "EC-".
PayPalPayeeOptionsInput
Input fields for a PayPal account receiving transaction funds.
input:
  • email: String
    The email address associated with the payee PayPal account.
PayPalShippingOptionInput
A shipping option for a PayPal One-Time payment.
input:
  • amount: MonetaryAmountInput!
    The cost for this shipping option.
  • id: ID!
    A unique ID that identifies a shipping option.
  • description: String!
    The shipping option description. Localize this description to the payer's locale. For example, `Free Shipping`, `USPS Priority Shipping`, `Expédition prioritaire USPS`, or `USPS yōuxiān fā huò`.
  • selected: Boolean!
    Indicates which shipping option is selected by default when the payer views the shipping options within the PayPal checkout experience. Only one shipping option can be selected at a time.
  • type: PayPalShippingOptionType!
    The method by which the payer wants to receive their items.
PaymentMethodVerificationOptionsInput
Input fields that specify options for verifying the vaulted payment method. Only applicable for payment method types that suport verification.
input:
  • merchantAccountId: ID
    ID of the merchant account to use when verifying the payment method. The verification will use the default merchant account if this field is left blank.
  • skip: Boolean
    Whether to opt out of verifying the payment method. Defaults to `false` for payment methods that support verification. Clients should only pass `true` in the uncommon scenario that the payment method has been verified externally to Braintree.
PaymentSearchInput
Input fields for searching for any type of Payment.
input:
PerformThreeDSecureLookupInput
Top-level fields for performing a 3D Secure Lookup.
input:
  • clientMutationId: String
    An identifier used to reconcile requests and responses. 255 characters maximum.
  • merchantAccountId: ID
    ID of the merchant account that will be used when charging the payment method.
  • dfReferenceId: String
    Reference ID used by our MPI provider CardinalCommerce to connect the lookup request to the device data that was previously collected.
  • paymentMethodId: ID!
    ID of a payment method to perform the lookup on.
  • amount: Amount!
    The amount you plan to charge the payment method after the 3D Secure authentication.
  • transactionInformation: ThreeDSecureLookupTransactionInformationInput
    Additional information about the transaction when authenticating through 3D Secure.
  • cardholderInformation: ThreeDSecureLookupCardholderInformationInput
    Additional information about the cardholder when authenticating through 3D Secure.
  • requestAuthenticationChallenge: Boolean
    When set to true, requests a 3D Secure authentication challenge from the issuer. A challenge will result in the acsUrl field being populated on the response, requiring you to open the challenge on the client side.
  • clientInformation: ThreeDSecureLookupClientInformationInput
    Information about the client-side lookup process.
  • dataOnlyRequested: Boolean
    When set to true, the data-only 3D Secure call will be created. The status of [DATA_ONLY_SUCCESSFUL](https://developers.braintreepayments.com/guides/3d-secure/advanced-options#using-data-only-3d-secure) will be returned as `ThreeDSecureAuthenticationStatus` for a successful response.
  • cardAdd: Boolean
    If set to true, a card-add challenge will be requested from the issuer to confirm adding new card to the merchant's vault. This flag should only be used when adding a card to a merchant’s vault and not for creating transactions.
PhoneInput
The phone number in its international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en).
input:
  • countryPhoneCode: String!
    The country calling code (CC), in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en). The combined length of the CC and the national number must not be greater than 15 digits. The national number consists of a national destination code (NDC) and subscriber number (SN).
  • phoneNumber: String!
    The phone number, in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en). The combined length of the country calling code (CC) and the national number must not be greater than 15 digits. The national number consists of a national destination code (NDC) and subscriber number (SN).
  • extensionNumber: String
    The extension number.
RefundCreditCardInput
Top-level input fields for creating a detached refund on a credit card.
input:
  • clientMutationId: String
    An identifier used to reconcile requests and responses. 255 characters maximum.
  • paymentMethodId: ID!
    ID of the credit card to be refunded.
  • refund: DetachedRefundInput!
    Input fields containing details about the refund.
RefundInput
Specific input fields for describing a refund.
input:
  • amount: Amount
    The amount to refund. Must be less than or equal to the amount of the original transaction. Defaults to the total amount of the original transaction.
  • orderId: String
    The refund's order ID. Defaults to the order ID of the original transaction.
  • merchantAccountId: ID
    ID of the merchant account that will be used when performing the refund.
  • description: String
    Description of the refund that is displayed to customers in PayPal email receipts.
  • reason: String
    Reason of the refund transaction. This field maps to the PayPal refund reason.
  • lineItems: [TransactionLineItemInput!]
    Line items for this refund. Up to 249 line items may be specified. Only allowed for Custom Actions transactions.
RefundSearchInput
Input fields for searching for refunds.
input:
RefundTransactionInput
Top-level input fields for refunding a transaction.
input:
  • clientMutationId: String
    An identifier used to reconcile requests and responses. 255 characters maximum.
  • transactionId: ID!
    The ID of a transaction to be refunded.
  • refund: RefundInput
    Input fields for the details of the refund.
RefundUsBankAccountInput
Top-level input fields for creating a detached refund on a US Bank Account.
input:
  • clientMutationId: String
    An identifier used to reconcile requests and responses. 255 characters maximum.
  • paymentMethodId: ID!
    ID of the US Bank Account to be refunded.
  • options: ChargeUsBankAccountOptionsInput
    Input fields related to the US bank account being charged.
  • refund: DetachedRefundInput!
    Input fields containing details about the refund.
RequestCancelFromInStoreReaderInput
Input fields for requesting a cancel during an in-store charge flow.
input:
  • clientMutationId: String
    An identifier used to reconcile requests and responses. 255 characters maximum.
  • inStoreContextId: ID!
    Unique ID for the charge flow.
RequestChargeFromInStoreReaderInput
Input fields for beginning the in-store charge flow.
input:
  • clientMutationId: String
    An identifier used to reconcile requests and responses. 255 characters maximum.
  • readerId: ID!
    ID of the Reader to request a charge from.
  • transaction: InStoreTransactionInput!
    Information about the requested in-store transaction.
RequestConfirmationPromptFromInStoreReaderInput
Input fields for requesting a confirmation prompt on an in-store reader.
input:
  • clientMutationId: String
    An identifier used to reconcile requests and responses. 255 characters maximum.
  • readerId: ID!
    ID of the Reader to request a confirmation prompt from.
  • title: String!
    Title to be displayed on the in-store reader. 50 character maximum.
  • text: String!
    Text to be displayed on the in-store reader. 65536 character maximum. '\n' line breaks will be respected.
  • alignment: ConfirmationPromptAlignment
    The way the text is aligned when displayed on an in-store reader. Defaults to CENTER.
  • cancellationText: String
    Text for the cancellation option to be displayed on the in-store reader. 20 character maximum.
  • confirmationText: String
    Text for the confirmation option to be displayed on the in-store reader. 20 character maximum.
RequestFirmwareUpdateFromInStoreReaderInput
Input fields for requesting a firmware update for an in-store reader.
input:
  • clientMutationId: String
    An identifier used to reconcile requests and responses. 255 characters maximum.
  • readerId: ID!
    The in-store reader to receive the firmware update.
RequestItemDisplayFromInStoreReaderInput
Input fields for beginning the in-store display line items flow.
input:
  • clientMutationId: String
    An identifier used to reconcile requests and responses. 255 characters maximum.
  • readerId: ID!
    ID of the Reader to display items on.
  • displayItems: [InStoreDisplayItemInput!]
    Items to be displayed on the in-store reader. Up to 249 items may be specified.
  • tax: Amount!
    The total tax amount for the entire transaction, including all display line items.
  • amount: Amount!
    The total amount for the entire transaction, including tax.
  • discountAmount: Amount
    The total discount amount for the entire transaction.
RequestRefundFromInStoreReaderInput
Input fields for beginning the in-store refund flow.
input:
  • clientMutationId: String
    An identifier used to reconcile requests and responses. 255 characters maximum.
  • readerId: ID!
    ID of the Reader to request a refund from.
  • refund: InStoreRefundInput!
    Information about the requested in-store refund.
RequestSignaturePromptFromInStoreReaderInput
Input fields for requesting a signature prompt on an in-store reader.
input:
  • clientMutationId: String
    An identifier used to reconcile requests and responses. 255 characters maximum.
  • readerId: ID!
    ID of the Reader to request a signature prompt from.
  • title: String
    Title to be displayed on the in-store reader. 50 character maximum.
  • cancellationText: String
    Text for the cancellation option to be displayed on the in-store reader. 20 character maximum.
  • confirmationText: String
    Text for the confirmation option to be displayed on the in-store reader. 20 character maximum.
RequestTextDisplayFromInStoreReaderInput
Input fields for beginning the in-store display text flow.
input:
  • clientMutationId: String
    An identifier used to reconcile requests and responses. 255 characters maximum.
  • readerId: ID!
    ID of the Reader to request a text display from.
  • text: String!
    Text to be displayed on the in-store reader. 255 character maximum. '\n' line breaks will be respected.
RequestVaultFromInStoreReaderInput
Input fields for beginning the in-store charge flow.
input:
  • clientMutationId: String
    An identifier used to reconcile requests and responses. 255 characters maximum.
  • readerId: ID!
    ID of the Reader to request a vault from.
  • verification: PaymentMethodVerificationOptionsInput
    Input fields that specify options for verifying the payment method before vaulting. Only applicable if the payment method is of a type that supports verification. For supported types, verification is performed by default. If the verification fails, the payment method will not be vaulted.
  • customerId: ID
    ID of the customer to associate the resulting multi-use payment method with.
ReverseRefundInput
Input fields for reversing a refund.
input:
  • clientMutationId: String
    An identifier used to reconcile requests and responses. 255 characters maximum.
  • refundId: ID!
    The ID of the refund to reverse.
ReverseTransactionInput
Input fields for reversing a transaction.
input:
  • clientMutationId: String
    An identifier used to reconcile requests and responses. 255 characters maximum.
  • transactionId: ID!
    The ID of the transaction to reverse.
RiskDataInput
Input fields for data used by processors for risk analysis.
input:
  • customerBrowser: String
    The User-Agent header provided by the customer's browser, which gives information about the browser. Maximum 255 characters.
  • customerIp: String
    The customer's IP address.
  • deviceData: String
    Customer device information. Required when creating transactions using cards (only if using Advanced Fraud Tools), PayPal (only for one-time Vaulted PayPal transactions), and Venmo payment method types. This value will contain a Fraud Merchant ID as the unique, numeric identifier for a Kount account and a Device Session ID as the unique identifier for a customer device. For PayPal and Venmo transactions, this value will also include a PayPal Correlation ID.
SamsungPayCardInput
Input fields for a Samsung Pay card.
input:
  • cryptogram: String!
    A one-time-use string generated by the token requester to validate the transaction.
  • eCommerceIndicator: ECommerceIndicator!
    A two-digit string that should be passed along in the authorization message.
  • expirationMonth: Month!
    A two-digit string representing the expiration month of the DPAN.
  • expirationYear: Year!
    A four-digit string representing the expiration year of the DPAN.
  • number: CreditCardNumber!
    The card number provided by Samsung and used in processing. This is a digitized PAN (DPAN), not the backing card number (FPAN).
  • sourceCardLast4: CreditCardLast4!
    The last four digits of the FPAN (the cardholder's backing card).
SandboxSettleTransactionInput
Top-level input fields for settling a transaction in the sandbox environment.
input:
  • clientMutationId: String
    An identifier used to reconcile requests and responses. 255 characters maximum.
  • transactionId: ID!
    Id of the transaction to force settlement in the sandbox environment.
  • settlementState: SandboxSettlementState
    The target settlement state for the transaction in the sandbox environment.
SearchChargebackProtectionLevelInput
Input fields for searching for a dispute with a given chargeback protection level.
input:
SearchCreditCardBrandCodeInput
Input fields for searching for payments by credit card brand.
input:
SearchCreditCardExpirationDateInput
Input fields for searching for payments by payment method snapshot credit card expiration date criteria.
input:
SearchCreditCardExpirationMonthYearInput
Input fields for searching for payments by payment method snapshot credit card expiration date criteria.
input:
  • expirationMonth: String!
    The month of the credit card expiration as MM.
  • expirationYear: String!
    The year of the credit card expiration as YYYY.
SearchCreditCardNumberInput
Input fields for searching for payments by payment method snapshot credit card number criteria.
input:
  • startsWith: String
    Up to the first six digits of the credit card number (the credit card's BIN).
  • endsWith: String
    Up to four digits of the last four digits of the credit card number.
SearchDateInput
Input fields for searching for a date. These ranges are precise to the day.
input:
  • greaterThanOrEqualTo: Date
    Date is greater than or equal to this value.
  • lessThanOrEqualTo: Date
    Date is less than or equal to this value.
SearchDisputeReasonInput
Input fields for searching for a dispute with a given reason description.
input:
SearchDisputeStatusInput
Input fields for searching for a dispute with a given status.
input:
SearchDisputeTypeInput
Input fields for searching for a dispute with a given type.
input:
  • is: DisputeType
    The dispute type is exactly this value.
  • in: [DisputeType!]
    The dispute type is one of these values.
SearchPaymentCreditCardDetailsInput
Input fields for searching for payments by payment method snapshot credit card details criteria.
input:
SearchPaymentCustomerInput
Input fields for searching payments by customer.
input:
SearchPaymentMethodSnapshotTypeInput
Input fields for searching transactions by payment method snapshot type.
input:
  • is: PaymentMethodSnapshotSearchType
    This value represents the payment method type used to create a transaction. In the case of credit cards, this value also encode the origin from which a customer provided that payment method.
  • in: [PaymentMethodSnapshotSearchType!]
    These values represent the payment method type used to create a transaction. In the case of credit cards, these values also encode the origin from which a customer provided that payment method.
SearchPaymentPayPalDetailsInput
Input fields for searching for payments by payment method snapshot PayPal details criteria.
input:
SearchPaymentPaymentMethodInput
Input fields for searching for payments by payment method criteria.
input:
SearchPaymentPaymentMethodSnapshotInput
Input fields for searching for payments by payment method snapshot criteria.
input:
  • type: SearchPaymentMethodSnapshotTypeInput
    Find payments based on the payment instrument type.
  • creditCardDetails: SearchPaymentCreditCardDetailsInput
    Find payments made with credit cards, based on the details of the credit card used for the payment. Passing an object with non-empty, non-null fields will scope your search to *only* credit card payment methods. This overrides the `type` field.
  • payPalDetails: SearchPaymentPayPalDetailsInput
    Find payments made with PayPal, based on the PayPal details used for the payment. Passing a value here will scope your search to *only* PayPal payment methods. This overrides the `type` field.
  • sepaDirectDebitDetails: SearchPaymentSEPADirectDebitDetailsInput
    Find SEPA payments with SEPA details. Passing a value here will scope your search to *only* SEPA Direct Debit payment methods. This overrides the `type` field.
SearchPaymentSEPADirectDebitDetailsInput
Input field for searching for payments by payment method snapshot SEPA Direct Debit details criteria.
input:
SearchPaymentSourceInput
Input fields for searching for a transaction or refund created with a given source.
input:
  • in: [PaymentSource!]
    The transaction source is one of these values.
SearchPaymentStatusInput
Input fields for searching for a transaction or refund with a given status.
input:
  • in: [PaymentStatus!]
    The transaction status is one of these values.
SearchPaymentStatusTransitionInput
Payment status transition times.
input:
SearchPaymentTypeInput
Input fields for searching for payments by implementing type.
input:
SearchRangeInput
Input fields for searching for a range.
input:
  • is: String
    Field is exactly this value.
  • greaterThanOrEqualTo: String
    Field is greater than or equal to this value.
  • lessThanOrEqualTo: String
    Field is less than or equal to this value.
SearchSoftwareVersionInput
Input fields for searching for a version number.
input:
  • is: String
    Field is exactly this value.
  • isNot: String
    Field is not this value.
  • startsWith: String
    Field starts with this value.
  • contains: String
    Field contains this value.
SearchTextInput
Input fields for searching text fields.
input:
  • is: String
    Field is exactly this value.
  • isNot: String
    Field is not this value.
  • startsWith: String
    Field starts with this value.
  • endsWith: String
    Field ends with this value.
  • contains: String
    Field contains this value.
SearchTimestampInput
Input fields for searching by timestamp. These ranges are precise to the minute; the results of searching for an object created between 12/17/2015 17:00 and 12/17/2015 17:00 (i.e., the same minute) will include objects created at 12/17/2015 17:00:59. If no timezone is provided, it will be assumed to be UTC.
input:
  • greaterThanOrEqualTo: Timestamp
    Timestamp is greater than or equal to this value.
  • lessThanOrEqualTo: Timestamp
    Timestamp is less than or equal to this value.
SearchTransactionSourceInput
Input fields for searching for a transaction created with a given source.
input:
  • in: [PaymentSource!]
    The transaction source is one of these values.
SearchTransactionStatusInput
Input fields for searching for a transaction with a given status.
input:
SearchTransactionStatusTransitionInput
Transaction status transition times.
input:
SearchValueInput
Input fields for searching for specific values.
input:
  • is: String
    Field is exactly this value.
  • in: [String!]
    Field is one of these values.
SearchVerificationStatusInput
Input fields for searching for a verification with a given status.
input:
SelectedPayPalFinancingOptionInput
Input fields indicating a selected financing option by a PayPal buyer.
input:
  • term: Int!
    Total number of payments over which to finance the transaction.
  • currencyCode: CurrencyCodeAlpha!
    The currency code for the monthly payment and discount amount.
  • monthlyPayment: Amount!
    The amount for each monthly payment.
  • discountPercentage: Percentage
    The percent discount off the total transaction amount due to the selected financing option.
  • discountAmount: Amount
    The amount reduced from the total transaction amount.
TaxInfoInput
Input fields for local payment tax information.
input:
  • identifier: String!
    The payer's tax identifier value.
  • type: TaxInfoType!
    The payer's tax identifier type.
ThreeDSecureAuthenticationInput
Input fields for passing auxillary 3D Secure information manually, as opposed to tokenized on a single-use payment method ID.
input:
  • authenticationId: String
    Braintree unique ID of the 3D Secure authentication performed for this transaction. You will only need to use this field if you are charging or authorizing a vaulted payment method ID.
  • passThrough: ThreeDSecurePassThroughInput
    Results of a merchant-performed 3D Secure authentication. You will only need to use these fields if you've performed your own integration with a 3D Secure MPI provider (e.g. Cardinal Centinel). Otherwise, Braintree's SDKs handle this for you in our standard 3D Secure integration.
ThreeDSecureLookupBillingAddressInput
The billing address of the cardholder sent with 3D Secure Lookup requests.
input:
  • givenName: String
    The given (first) name associated with the billing address used for verification.
  • surname: String
    The surname (last name) associated with the billing address used for verification.
  • phoneNumber: String
    The billing phone number used for verification.
  • line1: String
    Line 1 of the billing address used for verification.
  • line2: String
    Line 2 of the billing address used for verification.
  • line3: String
    Line 3 of the billing address used for verification.
  • locality: String
    City or locality of billing address used for verification.
  • region: String
    State or region of billing address used for verification.
  • countryCode: String
    Country code of billing address used for verification.
  • postalCode: String
    Postal code of billing address used for verification.
ThreeDSecureLookupCardholderInformationInput
Additional information about the cardholder when authenticating through 3D Secure.
input:
ThreeDSecureLookupClientInformationInput
Information about the client side lookup process.
input:
  • sdkVersion: String
    Version of the Braintree client-side SDK being used.
  • requestedThreeDSecureVersion: String
    Version of 3D Secure requested when performing the lookup.
  • issuerDeviceDataCollectionMillisecondsElapsed: Int
    Number of milliseconds taken for the issuer to collect device data.
  • issuerDeviceDataCollectionResult: Boolean
    Whether device data collection by the issuer succeeded.
  • threeDSecureServerDeviceDataCollectionMillisecondsElapsed: Int
    Number of milliseconds taken for the 3D Secure server to collect device data.
ThreeDSecureLookupShippingAddressInput
The shipping address of the transaction to be sent with 3D Secure Lookup requests.
input:
  • givenName: String
    The given (first) name associated with the shipping address used for verification.
  • surname: String
    The surname (last name) associated with the shipping address used for verification.
  • phoneNumber: String
    The shipping phone number used for verification.
  • line1: String
    Line 1 of the shipping address used for verification.
  • line2: String
    Line 2 of the shipping address used for verification.
  • line3: String
    Line 3 of the shipping address used for verification.
  • locality: String
    City or locality of shipping address used for verification.
  • region: String
    State or region of shipping address used for verification.
  • countryCode: String
    Country code of shipping address used for verification.
  • postalCode: String
    Postal code of shipping address used for verification.
ThreeDSecureLookupTransactionInformationInput
Additional information about the transaction when authenticating through 3D Secure.
input:
  • email: String
    The email associated with the transaction.
  • shippingMethod: ThreeDSecureLookupShippingMethod
    Indicates the shipping method chosen for the transaction in the 3D Secure lookup.
  • phoneNumber: String
    The phone number associated with the transaction.
  • shippingAddress: ThreeDSecureLookupShippingAddressInput
    The shipping address for the transaction.
  • workPhoneNumber: String
    The work phone number associated with the transaction.
  • transactionType: ThreeDSecureAuthenticationTransactionType
    Indicates the type of transaction.
  • deliveryTimeframe: ThreeDSecureAuthenticationDeliveryTimeframe
    Indicates the delivery timeframe if applicable.
  • deliveryEmail: String
    For electronic delivery, email address to which the product was delivered.
  • shippingType: ThreeDSecureAuthenticationShippingType
    Indicates shipping type chosen for the transaction.
  • productCode: ThreeDSecureAuthenticationMerchantProductCode
    Merchant product code.
  • reorderIndicator: Boolean
    Indicates whether the cardholder is reordering merchandise purchased in a previous order.
  • preorderIndicator: Boolean
    Indicates whether cardholder is placing an order with a future availability or release date.
  • preorderDate: Date
    Expected date that a pre-ordered purchase will be available.
  • giftCardAmount: Amount
    The purchase amount total for prepaid gift cards.
  • giftCardCurrencyCode: CurrencyCodeAlpha
    ISO 4217 currency code for the gift card purchased.
  • giftCardCount: Int
    Total count of individual prepaid gift cards purchased.
  • accountCreatedDuringTransaction: Boolean
    Indicates whether the cardholder created the account during this transaction.
  • accountCreateDate: Date
    Date the cardholder opened the account.
  • accountChangedDuringTransaction: Boolean
    Indicates whether the cardholder changed the account during this transaction. This includes changes to the billing or shipping address, new payment accounts or new users added.
  • accountChangeDate: Date
    Date the cardholder's account was last changed. This includes changes to the billing or shipping address, new payment accounts or new users added.
  • accountPasswordChangedDuringTransaction: Boolean
    Indicates whether the cardholder changed or reset the password on the account during this transaction.
  • accountPasswordChangeDate: Date
    Date the cardholder changed or reset the password on the account.
  • firstUseOfShippingAddress: Boolean
    Indicates whether this transaction represents the first use of this shipping address.
  • shippingAddressFirstUsageDate: Date
    Date when the shipping address used for this transaction was first used.
  • transactionCountDay: Int
    Number of transactions (successful or incomplete) for this cardholder account within the last 24 hours.
  • transactionCountYear: Int
    Number of transactions (successful or incomplete) for this cardholder account within the last year.
  • addCardAttempts: Int
    Number of attempts that have been made to add a card to this account in the last 24 hours.
  • accountPurchases: Int
    Number of purchases with this cardholder account during the previous six months.
  • suspiciousActivityObserved: Boolean
    Indicates whether the merchant experienced suspicious activity (including previous fraud) on the account.
  • accountNameMatchesShippingName: Boolean
    Indicates if the cardholder name on the account is identical to the shipping name used for the transaction.
  • paymentMethodAddedDuringTransaction: Boolean
    Indicates whether the payment method was added to the cardholder account during this transaction.
  • paymentMethodAddedToAccountDate: Date
    Date the payment method was added to the cardholder account.
  • acsWindowSize: ThreeDSecureAuthenticationAcsWindowSize
    An override field that a merchant can pass in to set the challenge window size to display to the end cardholder. The ACS will reply with content that is formatted appropriately to this window size to allow for the best user experience. The sizes are width x height in pixels of the window displayed in the cardholder browser window.
  • sdkMaxTimeout: Int
    This field indicates the maximum amount of time for all 3DS 2.0 messages to be communicated between all components (in minutes). Minimum is 05. Defaults to 15.
  • billingAddressMatchesShippingAddress: Boolean
    Indicates whether cardholder billing and shipping addresses match.
  • accountId: String
    Additional cardholder account information.
  • ipAddress: String
    The IP address of the cardholder. Both IPv4 and IPv6 formats are supported.
  • orderDescription: String
    Brief Description of items purchased.
  • taxAmount: Amount
    Tax amount.
  • userAgent: String
    The exact content of the HTTP user agent header.
  • installment: Int
    Indicates the maximum number of authorizations for installment payments. An integer value greater than 1 indicating the maximum number of permitted authorizations for installment payments.
  • purchaseDate: Timestamp
    Datetime of original purchase.
  • recurringEnd: Date
    The date after which no further recurring authorizations should be performed.
  • recurringFrequency: Int
    Integer value indicating the minimum number of days between recurring authorizations. A frequency of monthly is indicated by the value 28. Multiple of 28 days will be used to indicate months. Example: 6 months = 168.
ThreeDSecurePassThroughInput
Results of a merchant-performed 3D Secure authentication.
input:
  • eciFlag: ECommerceIndicator!
    The value of the electronic commerce indicator (ECI) flag, which indicates the outcome of the 3D Secure authentication.
  • cavv: String
    Cardholder authentication verification value or CAVV. The main encrypted message issuers and card networks use to verify authentication has occurred. Mastercard uses an AVV (Authentication Verification Value) message and American Express uses an AEVV (American Express Verification Value) message, each of which should also be passed in the cavv parameter.
  • xId: String
    Transaction identifier resulting from 3D Secure authentication. Uniquely identifies the transaction and sometimes required in the authorization message. Must be base64-encoded. This field will no longer be used in 3D Secure 2 authentications.
  • threeDSecureServerTransactionId: String
    3D Secure server transaction identifier resulting from 3D Secure authentication.
  • version: ThreeDSecureVersion
    The version of 3D Secure authentication used for the transaction. Required on Visa and Mastercard authentications.
  • authenticationResponse: ThreeDSecureStatusCode
    The 3D Secure authentication response status code.
  • directoryServerResponse: ThreeDSecureStatusCode
    The 3D Secure directory server response.
  • cavvAlgorithm: ThreeDSecureCavvAlgorithm
    The algorithm used to generate the CAVV value. This is only returned for Mastercard SecureCode transactions (3DS 1.0).
  • directoryServerTransactionId: String
    A unique identifier for the 3D Secure 2 interaction with the card brand directory server. This field must be supplied for Mastercard Identity Check.
TokenizeCreditCardInput
Top-level input fields for tokenizing a credit card.
input:
TokenizeCreditCardOptionsInput
Credit card tokenization options.
input:
  • validate: Boolean
    Whether to run validations on credit card fields. Validations are not run by default.
TokenizeCustomActionsPaymentMethodInput
Top-level input fields for tokenizing Custom Actions.
input:
  • clientMutationId: String
    An identifier used to reconcile requests and responses. 255 characters maximum.
  • customActionsPaymentMethod: CustomActionsPaymentMethodInput!
    Input fields for a Custom Actions payment method.
TokenizeCvvInput
Top-level input fields for tokenizing a CVV, otherwise known as CSC or CVC.
input:
  • clientMutationId: String
    An identifier used to reconcile requests and responses. 255 characters maximum.
  • cvv: CVV!
    A 3 or 4 digit card verification value assigned to credit cards. The CVV will never be stored, but it can be provided with one-time requests to verify the card.
TokenizeNetworkTokenInput
Top-level input field for tokenizing a network token.
input:
  • clientMutationId: String
    An identifier used to reconcile requests and responses. 255 characters maximum.
  • networkToken: NetworkTokenInput!
    Input fields for a network token object.
TokenizePayPalBillingAgreementInput
Top-level input fields for tokenizing a PayPal account.
input:
  • clientMutationId: String
    An identifier used to reconcile requests and responses. 255 characters maximum.
  • billingAgreement: PayPalBillingAgreementInput!
    Input fields for a PayPal Billing Agreement.
TokenizePayPalOneTimePaymentInput
Top-level input fields for tokenizing a PayPal account.
input:
  • clientMutationId: String
    An identifier used to reconcile requests and responses. 255 characters maximum.
  • paypalOneTimePayment: PayPalOneTimePaymentInput!
    Input fields for a PayPal One-Time Payment.
TokenizeSamsungPayCardInput
Top-level input field for tokenizing a Samsung Pay card.
input:
  • clientMutationId: String
    An identifier used to reconcile requests and responses. 255 characters maximum.
  • samsungPayCard: SamsungPayCardInput!
    Input fields for a Samsung Pay card.
TokenizeUsBankAccountInput
Top-level input fields for tokenizing a US bank account.
input:
  • clientMutationId: String
    An identifier used to reconcile requests and responses. 255 characters maximum.
  • usBankAccount: UsBankAccountInput!
    Input fields for a US bank account object.
TokenizeUsBankLoginInput
Top-level input fields for tokenizing a US bank login.
input:
  • clientMutationId: String
    An identifier used to reconcile requests and responses. 255 characters maximum.
  • usBankLogin: UsBankLoginInput!
    Input fields for a US bank login.
TransactionCustomerDetailsInput
Customer details to be stored on the transaction itself, if the transaction is not associated with a customer. Used for fraud detection purposes.
input:
  • email: String
    Email address for the customer.
  • phoneNumber: String
    Phone number for the customer.
TransactionDescriptorInput
Fields used to define what will appear on a customer's bank statement for a specific purchase.
input:
  • name: String
    The value in the business name field of a customer's statement.
  • phone: String
    The value in the phone number field of a customer's statement.
  • url: String
    The value in the URL/web address field of a customer's statement.
TransactionExternalVaultOptionsInput
Input for transactions created with credit cards vaulted in an external vault, not the Braintree Vault. Do not use for transactions created from Braintree multi-use payment methods, or from single-use payment methods which will not be stored in an external vault.
input:
  • status: ExternalVaultStatus!
    The credit card's assocation with an external vault.
  • verifyingNetworkTransactionId: String
    The network transaction ID of the first _transaction_ after which this payment method was stored in the external vault. If the `status` is `WILL_VAULT`, do not pass this value; the network transaction ID of the resulting transaction can be passed in this field for _subsequent_ transactions. If the `status` is `VAULTED`, but the customer is directly initiating the charge, do not pass this value.
TransactionInput
Input fields for creating a transaction.
input:
  • amount: Amount!
    Billing amount of the request. This value must be greater than 0, and must match the currency format of the merchant account. This can only contain numbers and one decimal point (e.g. x.xx). Can't be greater than the maximum allowed by the processor.
  • merchantAccountId: ID
    Merchant account ID used to process the transaction. Currency is also determined by merchant account ID. If no merchant account ID is specified, we will use your default merchant account.
  • orderId: String
    Additional information about the transaction. On PayPal transactions, this field maps to the PayPal invoice number. PayPal invoice numbers must be unique in your PayPal business account. Maximum 255 characters or 127 for PayPal transactions.
  • exchangeRateQuoteId: ID
    ID of exchange rate quote to be used for the transaction.
  • purchaseOrderNumber: String
    A purchase order identification value you associate with this transaction. *Required for Level 2 processing*.
  • riskData: RiskDataInput
    Customer device information, which is sent directly to supported processors for fraud analysis.
  • customFields: [CustomFieldInput!]
    Collection of custom field/value pairs. You must [set up each custom field in the Control Panel](https://articles.braintreepayments.com/control-panel/custom-fields#creating-a-custom-field) prior to passing it with a request.
  • descriptor: TransactionDescriptorInput
    Fields used to define what will appear on a customer's bank statement for a specific purchase.
  • paymentInitiator: PaymentInitiator
    The initiator of the payment. Payment can either be merchant-initiated or customer-initiated.
  • channel: String
    For partners and shopping carts only. If you are a shopping cart provider or other Braintree partner, pass a string identifier for your service. For PayPal transactions, this maps to paypal.bn_code.
  • customerId: ID
    If charging a single-use payment method, optional ID of a customer to associate the transaction with. If vaulting the single-use payment method, this customer will be associated with the resulting multi-use payment method.
  • shipping: TransactionShippingInput
    Shipping information. *Required for Level 3 processing*.
  • tax: TransactionTaxInput
    Tax information about the transaction. *Required for Level 2 processing*.
  • discountAmount: String
    Discount amount that was included in the total transaction amount. Does not add to the total amount the payment method will be charged. This value can't be negative. Please note that this field is not used on PayPal transactions. *Required for Level 3 processing*.
  • lineItems: [TransactionLineItemInput!]
    Line items for this transaction. Up to 249 line items may be specified. *Required for Level 3 processing*.
  • vaultPaymentMethodAfterTransacting: VaultPaymentMethodAfterTransactingInput
    When a single-use payment method is used to create this transaction, it can be automatically stored in the vault after transacting. If this field is left blank, the single-use payment method will not be vaulted.
  • customerDetails: TransactionCustomerDetailsInput
    Customer information to be stored on the transaction and used for fraud protection. Use this if you wish to pass customer information on a transaction without creating an independent stored customer record in the vault. This parameter can only be used if you do not pass `customerId`, and if you are not using a vaulted/multi-use payment method. In other words, this field is only valid when the transaction will not be associated with an existing customer. If `vaultPaymentMethodAfterTransacting` is also passed, these values will be used when creating a new customer for the newly-vaulted payment method.
TransactionLineItemInput
Data for individual line items on a transaction.
input:
  • name: String!
    Item name. Maximum 35 characters, or 127 characters for PayPal transactions. *Required for Level 3 processing*.
  • kind: TransactionLineItemType!
    Indicates whether the line item is a sale or refund. *Required for Level 3 processing*.
  • quantity: String!
    Number of units of the item purchased. Can include up to 4 decimal places. This value can't be negative or zero. *Required for Level 3 processing*.
  • unitAmount: String!
    Per-unit price of the item. Maximum 4 decimal places, or 2 decimal places for PayPal transactions. This value can't be negative or zero. *Required for Level 3 processing*.
  • totalAmount: String!
    Total price amount for the line item: quantity multiplied by unitAmount. Can include up to 2 decimal places. *Required for Level 3 processing*.
  • unitTaxAmount: String
    Per-unit tax price of the item. Can include up to 2 decimal places. This value can't be negative or zero. *Required for Level 3 processing*.
  • taxAmount: String
    Tax amount for the line item. Can include up to 2 decimal places. This value can't be negative. *Required for Level 3 processing*.
  • discountAmount: String
    Amount of discount for the line item. Can include up to 2 decimal places. This value can't be negative. Please note that this field is not used on PayPal transactions. *Required for Level 3 processing*.
  • unitOfMeasure: String
    The unit of measure or the unit of measure code. Maximum 12 characters. *Required for Level 3 processing*.
  • productCode: String
    Product or UPC code for the item. Maximum 12 characters, or 127 characters for PayPal transactions. *Required for Level 3 processing*.
  • commodityCode: String
    Code used to classify items purchased and track the total amount spent across various categories of products and services. Different corporate purchasing organizations may use different standards, but the [United Nations Standard Products and Services Code (UNSPSC)](https://www.unspsc.org/) is frequently used. Maximum 12 characters. *Required for Level 3 processing*.
  • description: String
    Item description. Maximum 127 characters. *Required for Level 3 processing*.
  • url: String
    A URL to information about the product. *Required for Level 3 processing*.
  • itemType: String
    The type of the line item, i.e., physical, digital etc.
  • imageUrl: String
    URL to an image that represents the product. Max 1024 characters.
TransactionSearchInput
Input fields for searching for transactions.
input:
TransactionShippingInput
Information related to shipping a physical product.
input:
  • shippingAddress: AddressInput
    Shipping destination address information. *Required for Level 3 processing*.
  • shippingAmount: String
    Shipping cost on the entire transaction. *Required for Level 3 processing*.
  • shipsFromPostalCode: String
    The postal code of the source shipping location, in any country's format. *Required for Level 3 processing*.
TransactionTaxInput
Information related to taxes on the transaction.
input:
  • taxAmount: Amount
    Amount of tax that was included in the total transaction amount. Does not add to the total amount the payment method will be charged. *Required for Level 2 processing* unless `taxExempt` is `true`.
  • taxExempt: Boolean
    Whether the transaction should be considered eligible for tax exemption. *Required for Level 2 processing*.
UpdateCreditCardBillingAddressInput
Top-level input fields for updating a multi-use credit card to use a new billing address.
input:
  • clientMutationId: String
    An identifier used to reconcile requests and responses. 255 characters maximum.
  • paymentMethodId: ID!
    The multi-use credit card for which the billing address will be updated or added.
  • billingAddress: AddressInput
    The new billing address.
  • merchantAccountId: ID
    ID of the merchant account that will be used when verifying the credit card with the new billing address.
  • verification: CreditCardVerificationOptionsInput
    Input fields that specify options for verifying the credit card with the new billing address. By default, a verification will be performed. If the verification fails, the update will not be performed.
UpdateCustomerInput
Top-level field for updating a customer.
input:
  • clientMutationId: String
    An identifier used to reconcile requests and responses. 255 characters maximum.
  • customerId: ID!
    ID of the customer to be updated.
  • customer: CustomerInput
    Input fields for the updates to be made on the customer.
UpdateInStoreLocationInput
Input fields for updating an in-store location.
input:
  • clientMutationId: String
    An identifier used to reconcile requests and responses. 255 characters maximum.
  • locationId: ID!
    ID of the location to be updated.
  • location: InStoreLocationUpdateInput!
    Input fields to update an in-store location.
UpdateInStoreReaderInput
Input fields for updating an in-store reader.
input:
  • clientMutationId: String
    An identifier used to reconcile requests and responses. 255 characters maximum.
  • readerId: ID!
    The ID of the in-store reader to update.
  • name: String
    The new name for the in-store reader.
  • locationId: ID
    The new location ID for the in-store reader.
UpdateTransactionAmountInput
Top-level input fields for a updating a transaction's amount.
input:
  • clientMutationId: String
    An identifier used to reconcile requests and responses. 255 characters maximum.
  • transactionId: ID!
    ID of the transaction on which to perform the adjustment.
  • amount: Amount!
    The new total amount to be authorized on a transaction. This value must be greater than 0, and must match the currency format of the merchant account, and cannot be greater than the maximum allowed by the processor.
UpdateTransactionCustomFieldsInput
Input for creating or updating custom fields on a transaction.
input:
  • clientMutationId: String
    An identifier used to reconcile requests and responses. 255 characters maximum.
  • transactionId: ID!
    The ID of the transaction to update.
  • customFields: [CustomFieldInput!]!
    The list of custom fields to update. You must [set up each custom field in the Control Panel](https://articles.braintreepayments.com/control-panel/custom-fields#creating-a-custom-field) prior to passing it with a request.
UsBankAccountBillingAddressInput
A billing address for a US bank account. This is a subset of the fields required on `AddressInput`.
input:
  • streetAddress: String!
    The street address.
  • extendedAddress: String
    The extended address information—such as an apartment or suite number.
  • city: String!
    The city.
  • state: UsStateCode!
    The state.
  • zipCode: UsZipCode!
    The ZIP code.
UsBankAccountBusinessOwnerInput
The name of the owner of a business US bank account.
input:
  • businessName: String!
    The name of the business that owns the account.
UsBankAccountIndividualOwnerInput
The name of the owner of a personal US bank account.
input:
  • firstName: String!
    The first name of the accountholder.
  • lastName: String!
    The last name of the accountholder.
UsBankAccountInput
Input fields for a US bank account object.
input:
UsBankLoginInput
Input fields for a US bank login object.
input:
  • publicToken: String!
    The public token returned from the bank login.
  • accountId: String!
    The login provider account ID used for the bank login.
  • accountType: UsBankAccountType!
    The type of account.
  • businessOwner: UsBankAccountBusinessOwnerInput
    Information about the business that owns the account. This should only be specified for business accounts.
  • individualOwner: UsBankAccountIndividualOwnerInput
    Information about the individual that owns the account. This should only be specified for individual accounts.
  • billingAddress: UsBankAccountBillingAddressInput
    The billing address of the account.
  • achMandate: String!
    Language used to prove that you have the customer's explicit permission to debit their bank account.
VaultCreditCardExternalVaultOptionsInput
Options used to indicate when a credit card is externally vaulted.
input:
  • verifyingNetworkTransactionId: String
    For use if this credit card is stored in an external vault. The network transaction ID of the first _transaction_ after which this credit card was stored in the external vault.
VaultCreditCardInput
Top-level input field for vaulting a credit card so it can be used multiple times.
input:
  • clientMutationId: String
    An identifier used to reconcile requests and responses. 255 characters maximum.
  • paymentMethodId: ID!
    ID of an existing single-use credit card payment method to be vaulted.
  • verification: VaultCreditCardVerificationOptionsInput
    Input fields that specify options for verifying the credit card before vaulting. By default, a verification will be performed. If the verification fails, the credit card will not be vaulted.
  • externalVault: VaultCreditCardExternalVaultOptionsInput
    Options used to indicate when a credit card is externally vaulted.
  • customerId: ID
    ID of the customer to associate the resulting multi-use payment method with.
  • accountType: CardAccountType
    The type of account to be used when verifying a combo card.
  • billingAddress: AddressInput
    A billing address to associate with the vaulted credit card. If billing address data was included when tokenizing the credit card, it will be *merged* with this input value.
  • threeDSecurePassThrough: ThreeDSecurePassThroughInput
    Results of a merchant-performed 3D Secure authentication. You will only need to use these fields if you've performed your own integration with a 3D Secure MPI provider (e.g. Cardinal Centinel). Otherwise, Braintree's SDKs handle this for you in our standard 3D Secure integration.
  • riskData: RiskDataInput
    Customer device information, which is sent directly to supported processors for fraud analysis.
VaultCreditCardVerificationOptionsInput
Input fields that specify options for verifying the vaulted credit card.
input:
  • merchantAccountId: ID
    ID of the merchant account to use when verifying the credit card. The verification will use the default merchant account if this field is left blank.
  • skip: Boolean
    Whether to opt out of verifying the credit card. Defaults to `false` for credit cards that support verification. Clients should only pass `true` in the uncommon scenario that the credit card has been verified externally to Braintree.
  • amount: Amount
    The amount to use to verify the credit card.
  • fraudTools: CreditCardFraudToolsOptionsInput
    Control which fraud tools will be applied to this transaction. Fraud tools cannot be retroactively applied to a transaction if skipped.
VaultInStorePaymentMethodAfterTransactingInput
Specifies behavior for vaulting a single-use payment method for an in-store transaction.
input:
VaultLimitedUsePayPalAccountOptionsInput
Input fields that provide information about the resulting PayPal account.
input:
  • amount: Amount
    The total amount of the order. This will be the limit to how much may be captured on the resulting payment method.
  • customField: String
    Variable passed directly to PayPal for your own tracking purposes. Customers do not see this value.
  • description: String
    Description of the transaction that is displayed to customers in PayPal email receipts.
  • orderId: String
    The PayPal invoice number. It must be unique in your PayPal business account and can contain a maximum of 127 characters. If specified, transactions created from the resulting payment method will have this orderId.
  • shippingAddress: AddressInput
    Shipping destination address information.
VaultPayPalBillingAgreementInput
Top-level input fields for importing and vaulting a PayPal Billing Agreement.
input:
  • clientMutationId: String
    An identifier used to reconcile requests and responses. 255 characters maximum.
  • billingAgreementId: String!
    ID of a PayPal Billing Agreement, that was not created through Braintree, to import and vault.
  • customerId: ID
    Optional ID of the customer to associate the resulting payment method with.
  • merchantAccountId: ID
    Optional ID of the merchant account associated with the linked PayPal account to be used to retrieve billing agreement details from PayPal. Only used for merchants with the PayPal multi-account feature enabled in Braintree.
  • indirectPayee: PayPalAccountInput
    The merchant (payee) PayPal account associated with the PayPal Billing Agreement being vaulted. Only used when the specified merchant account is specially configured to handle indirect PayPal accounts.
VaultPaymentMethodAfterTransactingInput
Specifies behavior for vaulting a single-use payment method after transacting with it.
input:
VaultPaymentMethodInput
Top-level input field for vaulting a payment method so it can be used multiple times.
input:
  • clientMutationId: String
    An identifier used to reconcile requests and responses. 255 characters maximum.
  • paymentMethodId: ID!
    ID of an existing single-use payment method to be vaulted.
  • verification: PaymentMethodVerificationOptionsInput
    Input fields that specify options for verifying the payment method before vaulting. Only applicable if the payment method is of a type that supports verification. For supported types, verification is performed by default. If the verification fails, the payment method will not be vaulted. For additional, payment method-specific verification options, please see other verification mutations such as `verifyCreditCard` or `verifyUsBankAccount`.
  • customerId: ID
    ID of the customer to associate the resulting multi-use payment method with.
  • threeDSecurePassThrough: ThreeDSecurePassThroughInput
    Results of a merchant-performed 3D Secure authentication. You will only need to use these fields if you've performed your own integration with a 3D Secure MPI provider (e.g. Cardinal Centinel). Otherwise, Braintree's SDKs handle this for you in our standard 3D Secure integration.
  • riskData: RiskDataInput
    Customer device information, which is sent directly to supported processors for fraud analysis.
VaultUsBankAccountInput
Top-level input field for vaulting a bank account so it can be used multiple times.
input:
  • clientMutationId: String
    An identifier used to reconcile requests and responses. 255 characters maximum.
  • paymentMethodId: ID!
    ID of an existing single-use payment method to be vaulted.
  • verificationMerchantAccountId: ID
    ID of the merchant account to use when verifying the payment method.
  • customerId: ID
    ID of the customer to associate the resulting multi-use payment method with.
  • verificationMethod: UsBankAccountVerificationMethod!
    Type of US bank account verification to perform.
VenmoPayerInfoInput
Information about a payer's Venmo account.
input:
  • firstName: String
    The payer's first name.
  • lastName: String
    The payer's last name.
  • phoneNumber: String
    The payer's phone number.
  • email: EmailAddress
    The payer's email address.
  • externalId: String
    The external ID of the payer's Venmo account.
  • userName: String
    The username of the payer's Venmo account.
  • billingAddress: AddressInput
    The payer's billing address.
  • shippingAddress: AddressInput
    The payer's shipping address.
VerificationSearchInput
Input fields for searching for verifications.
input:
VerifyCreditCardInput
Top-level input field for verifying a multi-use credit card.
input:
  • clientMutationId: String
    An identifier used to reconcile requests and responses. 255 characters maximum.
  • paymentMethodId: ID!
    ID of an existing multi-use payment method to be vaulted.
  • merchantAccountId: ID
    ID of the merchant account to use when verifying the credit card.
  • options: CreditCardVerificationOptionsInput
    Input fields for verifying a credit card.
VerifyPaymentMethodInput
Top-level input field for verifying a multi-use payment method.
input:
  • clientMutationId: String
    An identifier used to reconcile requests and responses. 255 characters maximum.
  • paymentMethodId: ID!
    ID of an existing multi-use payment method to be verified.
  • merchantAccountId: ID
    ID of the merchant account to use when verifying the payment method.
VerifyUsBankAccountInput
Top-level input field for retrying a verification on a bank account.
input:
  • clientMutationId: String
    An identifier used to reconcile requests and responses. 255 characters maximum.
  • paymentMethodId: ID!
    ID of an existing multi-use payment method to be vaulted.
  • merchantAccountId: ID
    ID of the merchant account to use when verifying the payment method.
  • verificationMethod: UsBankAccountVerificationMethod!
    Type of US bank account verification to perform.

Objects

AcceptDisputePayload
Top-level field returned when accepting a dispute.
fields:
  • clientMutationId: String
    An identifier used to reconcile requests and responses. 255 characters maximum.
  • dispute: Dispute
    Information about the dispute that was accepted.
AccessToken
An OAuth access token.
fields:
  • accessToken: String
    The access token.
  • refreshToken: String
    The refresh token for getting a new access token.
  • tokenType: OAuthTokenType
    The type of token.
  • expiresAt: String
    Expiration in ISO time format.
Address
Representation of an address.
fields:
  • company: String
    Company name.
  • addressLine1: String
    The first line of the street address, such as street number, street name.
  • addressLine2: String
    Extended address information, such as an apartment number or suite number.
  • fullName: String
    Full name.
  • adminArea2: String
    A city, town, or village.
  • adminArea1: String
    Highest level subdivision, such as state, province, or ISO-3166-2 subdivison.
  • postalCode: String
    Postal code, otherwise known as CAP, CEP, Eircode, NPA, PIN, PLZ, or ZIP code.
  • countryCode: CountryCode
    Country code for the address.
  • phoneNumber: String
    Phone number.
ApplePayConfiguration
Configuration for Apple Pay on iOS.
fields:
  • status: ApplePayStatus
    The environment being used for Apple Pay.
  • countryCode: CountryCodeAlpha2
    The country code of the acquiring bank where the transaction is likely to be processed.
  • currencyCode: CurrencyCodeAlpha
    The merchant's Apple Pay currency code.
  • merchantIdentifier: String
    The merchant identifier that must be supplied when making an Apple Pay request.
  • supportedCardBrands: [CreditCardBrandCode!]
    A list of card brands supported by the merchant for Apple Pay.
ApplePayOriginDetails
Additional information about the payment method specific to Apple Pay.
fields:
  • paymentInstrumentName: String
    A human-readable description of the Apple Pay payment method. This usually consists of the Apple Pay card type and its last four digits. If there is no underlying credit card, this will describe the customer's payment method and the parent CreditCardDetail object's last4 field will be null.
  • bin: String
    The first 6 digits of the credit card, known as the Bank Identification Number. This BIN may differ from the BIN of the customer's actual card.
ApplePayWebConfiguration
Configuration for Apple Pay on web.
fields:
  • countryCode: CountryCodeAlpha2
    The merchant's Apple Pay country code.
  • currencyCode: CurrencyCodeAlpha
    The merchant's Apple Pay currency code.
  • merchantIdentifier: String
    The merchant identifier that must be supplied when making an Apple Pay request.
  • supportedCardBrands: [CreditCardBrandCode!]
    A list of card brands supported by the merchant for Apple Pay.
AuthenticationInsight
Information about the [customer authentication regulation environment](https://developers.braintreepayments.com/guides/3d-secure/migration/javascript/v3#authentication-insight) that applies to the payment method when processed with the provided merchant account.
fields:
  • merchantAccountId: String
    The merchant account used to determine authentication insight.
  • customerAuthenticationRegulationEnvironment: CustomerAuthenticationRegulationEnvironment
    The customer authentication regulation environment that applies when transacting with this payment method and merchant account.
  • customerAuthenticationIndicator: CustomerAuthenticationIndicator
    A value indicating when to perform further customer authentication.
AuthorizationAdjustment
Records of authorization adjustments performed when a transaction is captured for less or more than its original authorization amount.
fields:
AuthorizationExpiredEvent
Accompanying information for an authorization expired transaction.
fields:
  • status: PaymentStatus
    The new status of the transaction.
  • timestamp: Timestamp
    Date and time when the authorization for this transaction was marked expired.
  • amount: MonetaryAmount
    The amount of the transaction for this status event.
  • source: PaymentSource
    The source for the transaction change to the new status.
  • terminal: Boolean
    Whether or not this is the final state for the transaction.
interfaces:
AuthorizedEvent
Accompanying information for an authorized transaction.
fields:
  • status: PaymentStatus
    The new status of the transaction.
  • timestamp: Timestamp
    Date and time when the transaction was authorized.
  • amount: MonetaryAmount
    The amount the transaction was authorized for. This will match the amount on the transaction itself. In most cases, you can't request to settle more than this amount.
  • source: PaymentSource
    The source for the transaction change to the new status.
  • processorResponse: TransactionAuthorizationProcessorResponse
    Fields describing the payment processor response to the authorization request.
  • networkResponse: PaymentNetworkResponse
    Fields describing the network response to the authorization request.
  • riskDecision: RiskDecision
    Risk decision for this transaction.
  • terminal: Boolean
    Whether or not this is the final state for the transaction.
  • authorizationExpiresAt: Timestamp
    The date/time the transaction will expire if it has the authorized status. For more details on authorization expiration timeframes, see the [Statuses reference](https://developers.braintreepayments.com/reference/general/statuses#authorization-expired).
interfaces:
BinRecord
Information about the credit card based on its BIN.
fields:
  • prepaid: BinRecordValue
    Whether or not the card is prepaid, such as a gift card.
  • healthcare: BinRecordValue
    Whether the card is designated only to be used for healthcare expenses.
  • debit: BinRecordValue
    Whether or not the card is a debit card.
  • durbinRegulated: BinRecordValue
    Whether the card is regulated by the Durbin Amendment due to the bank's assets, and therefore has a maximum interchange rate.
  • commercial: BinRecordValue
    Whether or not the card is a commercial card and capable of processing Level 2 transactions.
  • payroll: BinRecordValue
    Whether or not the card is designated for employee wages.
  • issuingBank: String
    The name of the bank that issued the card.
  • countryOfIssuance: CountryCode
    The country code of the country that issued the card.
  • productId: String
    A code representing any special program from the card issuer the card is part of.
BraintreeApiConfiguration
Configuration for payment methods in legacy clients.
fields:
  • url: String
    The URL for tokenizing payment methods.
  • accessToken: String
    The authentication for tokenizing payment methods.
BusinessAccountCreationRequest
Record of onboarding request.
fields:
  • id: ID!
    Unique identifier generated by PayPal for the onboarding request.
  • merchantAccount: MerchantAccount
    Information about the merchant account that is being created as a result of the request.
  • creationStatus: AccountCreationStatus
    The account creation status for this account.
interfaces:
BusinessAccountCreationRequestConnection
A paginated list of BusinessAccountCreationRequests.
fields:
BusinessAccountCreationRequestConnectionEdge
A BusinessAccountCreationRequest within a BusinessAccountCreationRequestConnection.
fields:
  • cursor: String
    This BusinessAccountCreationRequest's location within the BusinessAccountCreationRequestConnection. Used for requesting additional pages.
  • node: BusinessAccountCreationRequest
    The business account creation request.
CardPresentOriginDetails
Additional information about a card present payment method supplied by an in-store payment reader.
fields:
  • authorizationMode: InStoreReaderAuthorizationMode
    The authorization mode used to perform the transaction on the payment reader.
  • pinVerified: Boolean
    An indicator for whether the transaction was verified via pin.
  • inputMode: PaymentReaderInputMode
    The input mode used on the payment reader to facilitate an in-store transaction.
  • terminalId: String
    The ID of the terminal that was processed this transaction.
interfaces:
ChildCapture
A partial capture's relationship to its original authorization transaction.
fields:
  • parentAuthorization: Transaction
    The original authorization whose funds have been partially captured.
ClientConfiguration
Top-level fields returned from the client configuration query.
fields:
ConfirmMicroTransferAmountsPayload
Top-level output field from confirming micro-transfer amounts on bank account.
fields:
  • clientMutationId: String
    An identifier used to reconcile requests and responses. 255 characters maximum.
  • verification: Verification
    The verification that was run on the payment method prior to vaulting.
  • status: ConfirmMicroTransferAmountsStatus
    The status of the micro-transfer amounts confirmation.
CreateClientTokenPayload
Top-level fields returned when creating a client token.
fields:
  • clientMutationId: String
    An identifier used to reconcile requests and responses. 255 characters maximum.
  • clientToken: String
    A Base64 encoded string used to initialize client SDKs.
CreateCustomerPayload
Top-level fields returned when creating a customer.
fields:
  • clientMutationId: String
    An identifier used to reconcile requests and responses. 255 characters maximum.
  • customer: Customer
    Information about the customer that was created. Can be used when vaulting payment methods or creating transactions to associate those objects.
CreateDisputeFileEvidencePayload
Top-level field returned when creating file evidence for a dispute.
fields:
  • clientMutationId: String
    An identifier used to reconcile requests and responses. 255 characters maximum.
  • evidence: DisputeFileEvidence
    The evidence object created.
  • dispute: Dispute
    Information about the dispute the evidence is attached to.
CreateDisputeTextEvidencePayload
Top-level field returned when creating text evidence for a dispute.
fields:
  • clientMutationId: String
    An identifier used to reconcile requests and responses. 255 characters maximum.
  • evidence: DisputeTextEvidence
    The evidence object created.
CreateInStoreLocationPayload
Top-level fields returned when creating an in-store location.
fields:
  • clientMutationId: String
    An identifier used to reconcile requests and responses. 255 characters maximum.
  • location: InStoreLocation
    The in-store location.
CreateNonInstantLocalPaymentContextPayload
The result of a request to make a local payment context.
fields:
  • clientMutationId: String
    An identifier used to reconcile requests and responses. 255 characters maximum.
  • paymentContext: LocalPaymentContext
    Details about the local payment context.
CreatePayPalBillingAgreementPayload
Top-level fields returned from setting up a PayPal Billing Agreement Token.
fields:
  • clientMutationId: String
    An identifier used to reconcile requests and responses. 255 characters maximum.
  • billingAgreementToken: ID
    The Billing Agreement token.
  • approvalUrl: URL
    The URL for getting user approval of the PayPal Billing Agreement.
CreatePayPalOneTimePaymentPayload
Top-level fields returned from setting up a PayPal One-Time Payment.
fields:
  • clientMutationId: String
    An identifier used to reconcile requests and responses. 255 characters maximum.
  • approvalUrl: URL
    The URL for getting user approval of the PayPal payment.
  • paymentId: String
    The PayPal payment ID. This ID is prefixed with "PAYID-".
CreateUniversalAccessTokenPayload
Top-level fields returned when creating a universal access token.
fields:
  • clientMutationId: String
    An identifier used to reconcile requests and responses. 255 characters maximum.
  • accessToken: AccessToken
    The created universal access token.
CreditCardConfiguration
Configuration for credit card tokenization.
fields:
  • supportedCardBrands: [CreditCardBrandCode!]
    A list of card brands supported by the merchant for credit card processing.
  • challenges: [Challenge!]
    A list of challenges that are required by the merchant to process a given credit card.
  • threeDSecure: ThreeDSecureConfiguration
    Configuration for 3D Secure.
  • fraudDataCollectionEnabled: Boolean
    Whether or not fraud data collection is enabled for the merchant.
CreditCardDetails
Details about a credit card.
fields:
  • brandCode: CreditCardBrandCode
    A static code identifying the card brand.
  • last4: String
    The last four digits of the card number.
  • bin: String
    The first 6 digits of the credit card number, known as the Bank Identification Number. If this card originates from a third party such as a wallet provider, this BIN may not be present and the PaymentMethodOriginDetails will contain a BIN instead.
  • binData: BinRecord
    Information about the card based on its BIN.
  • expirationMonth: String
    The month of the expiration date, formatted MM.
  • expirationYear: String
    The year of the expiration date, formatted YYYY.
  • cardholderName: String
    The cardholder's name.
  • uniqueNumberIdentifier: String
    An identifier that uniquely represents any credit card number, for cards stored in a merchant's vault. If the same credit card is added to a merchant's vault multiple times, each will have the same identifier. This identifier will only be returned if the field "origin" is null.
  • origin: PaymentMethodOrigin
    Additional information if the credit card was provided from a third-party origin, such as Apple Pay, Google Pay, or another digital wallet.
  • billingAddress: Address
    The billing address associated with the credit card.
  • threeDSecure: ThreeDSecureDetails
    3D Secure information for the payment method.
  • cardOnFileNetworkTokenized: Boolean
    Indicates whether the card on file is network tokenized.
CreditCardTransactionDetails
Credit card specific details on a transaction or verification.
fields:
  • creditCard: CreditCardDetails
    The details of the credit card itself.
  • networkTransactionId: String
    The network transaction identifier provided by the payment network. If this transaction was created in order to verify a payment method before storing it in an external vault, then this value can be pased when creating subsequent transactions with the same payment method.
  • accountType: CardAccountType
    For combo cards, what account type was used for this specific transaction.
  • acquirerReferenceNumber: String
    Reference value assigned to a card transaction once it has been processed.
  • processedWithCardOnFileNetworkToken: Boolean
    Indicates whether the transaction was processed with a card on file network token.
  • accountBalance: MonetaryAmount
    The remaining balance in the account after this transaction. This field is only returned for payment methods such as prepaid cards.
CreditCardVerificationDetails
Information specific to verifications of credit card payment methods.
fields:
  • amount: MonetaryAmount
    The amount used when performing the verification. May be 0.
CustomActionsPaymentContext
Top-level fields returned from a Custom Actions payment context.
fields:
  • id: ID!
    The identifier of the payment context.
  • createdAt: Timestamp!
    Date and time when the payment context was created.
  • updatedAt: Timestamp!
    Date and time when the payment context was updated.
  • customFields: [CustomActionsPaymentContextField!]
    A list of fields stored on a PaymentContext during execution of a Custom Actions handler (Five (5) entries maximum).
interfaces:
CustomActionsPaymentContextField
Fields returned by the createPaymentContext custom actions event handler.
fields:
  • name: String!
    An alphanumeric string used as a key to lookup a CustomField value (255 characters maximum).
  • value: String!
    An alphanumeric string used to store a CustomField value (7168 characters maximum).
CustomActionsPaymentMethodDetails
Details about a custom actions payment method.
fields:
CustomActionsPaymentMethodField
Fields that are provided during tokenization and are presented to the invoked action to be consumed.
fields:
  • name: String
    The name of this field, e.g. "accountNumber".
  • displayValue: String
    The value displayed in the Control Panel or API, e.g. "*****6789".
CustomField
A merchant-defined custom field to store additional information.
fields:
  • name: String
    The name of the custom field.
  • value: String
    The value of the custom field.
Customer
Information about a customer and their associated payment methods and transactions.
fields:
  • id: ID!
    Unique identifier.
  • legacyId: ID!
    Legacy unique identifier.
  • company: String
    Company or business name associated with this customer.
  • createdAt: Timestamp
    Date and time at which the customer was created.
  • customFields: [CustomField!]
    Collection of custom field/value pairs. Custom fields are [defined in the Control Panel](https://articles.braintreepayments.com/control-panel/custom-fields#store-and-pass-back-fields).
  • defaultPaymentMethod: PaymentMethod
    Customer's default payment method.
  • email: String
    Email address for this customer.
  • firstName: String
    Customer's first name.
  • lastName: String
    Customer's last name.
  • phoneNumber: String
    The phone number for this customer.
  • paymentMethods: PaymentMethodConnection
    args:
    Payment methods belonging to this customer.
  • transactions: TransactionConnection
    args:
    Transactions associated with this customer. This includes transactions created by charging a vaulted payment method that belongs or belonged to the customer, or by passing a customer ID when charging a single-use payment method.
interfaces:
CustomerConnection
A paginated list of customers.
fields:
CustomerConnectionEdge
A customer within a CustomerConnection.
fields:
  • cursor: String
    This customer's location within the CustomerConnection. Used for requesting additional pages.
  • node: Customer
    The customer.
DeleteCustomerPayload
Top-level output field from deleting a customer.
fields:
  • clientMutationId: String
    An identifier used to reconcile requests and responses. 255 characters maximum.
DeleteDisputeEvidencePayload
Top-level field returned when deleting evidence from a dispute.
fields:
  • clientMutationId: String
    An identifier used to reconcile requests and responses. 255 characters maximum.
DeletePaymentMethodFromSingleUseTokenPayload
Top-level output field from deleting a payment method referenced by a single-use token.
fields:
  • clientMutationId: String
    An identifier used to reconcile requests and responses. 255 characters maximum.
DeletePaymentMethodFromVaultPayload
Top-level output field from deleting a multi-use payment method.
fields:
  • clientMutationId: String
    An identifier used to reconcile requests and responses. 255 characters maximum.
DisbursementBankAccount
Details about the disbursement bank account.
fields:
  • last4: String
    The last four digits of the bank account number.
  • routingNumber: String
    The routing number of the bank.
DisbursementDetails
Disbursement details contain information about how and when the transaction was disbursed, including timing and currency information. This field is only available if you have an eligible merchant account.
fields:
  • date: Date
    The date that the funds associated with this transaction were disbursed.
  • amount: MonetaryAmount
    Amount of money disbursed in the settlement currency, which may be different than the transaction's [presentment currency](https://articles.braintreepayments.com/get-started/currencies).
  • exchangeRate: String
    The exchange rate from the presentment currency to the settlement currency. If the currencies are the same, this will be 1.
  • fundsHeld: Boolean
    Indicates whether funds have been withheld from a disbursement to the merchant's account.
Dispute
[A case raised by a customer to either request information about or to challenge a charge](https://articles.braintreepayments.com/risk-and-security/chargebacks-retrievals/overview). These are initiated via a customer's payment provider, such as their bank, and require a merchant to provide evidence or further information.
fields:
  • id: ID!
    Unique identifier.
  • legacyId: ID!
    Legacy unique identifier.
  • amountDisputed: MonetaryAmount
    The amount of money from the original charge that the customer is disputing. Can be 0. This amount is debited from a merchant's account and held in a third-party account until the dispute is resolved, at which time it is sent to either the merchant or customer.
  • amountWon: MonetaryAmount
    If an amount was disputed, the amount of money awarded back to the merchant if the dispute was reversed.
  • caseNumber: String
    The case number for the dispute.
  • createdAt: Timestamp
    Date and time at which the dispute was created.
  • receivedDate: Date
    Date the dispute was received by the merchant.
  • referenceNumber: String
    The transaction reference number for the dispute.
  • responseDeadline: Timestamp
    The deadline for the merchant to submit a response to the dispute.
  • replyByDate: Date
    The reply by date for the merchant to submit a response to the dispute.
  • type: DisputeType
    The type of dispute.
  • evidence: [DisputeEvidence!]
    Evidence records submitted by the merchant for the dispute.
  • originalDispute: Dispute
    If this dispute is a follow-up to a previous chargeback or retrieval, the original dispute.
  • processorResponse: DisputeProcessorResponse
    Additional information from the payment processor.
  • status: DisputeStatus
    The status of the dispute.
  • statusHistory: [DisputeStatusEvent!]
    A log of history events containing status changes by date for this dispute.
  • transaction: Transaction
    The disputed transaction which the customer is either requesting further information on or challenging.
  • chargebackProtectionLevel: ChargebackProtectionLevel
    The chargeback protection status of the dispute.
interfaces:
DisputeConnection
A paginated list of disputes.
fields:
DisputeConnectionEdge
A dispute within a DisputeConnection.
fields:
  • cursor: String
    This dispute's location within the DisputeConnection. Used for requesting additional pages.
  • node: Dispute
    The dispute.
DisputeFileEvidence
Images, files, or other evidence supporting a dispute case.
fields:
  • id: ID!
    Unique identifier.
  • legacyId: ID!
    Legacy unique identifier.
  • createdAt: Timestamp
    Date and time at which the evidence was created with Braintree.
  • sentToProcessorAt: Timestamp
    Date and time at which the evidence was sent to the processor.
  • url: String
    A URL where you can retrieve the dispute evidence.
  • category: DisputeEvidenceCategory
    The evidence category.
interfaces:
DisputeProcessorResponse
Information about the dispute provided by the processor.
fields:
  • processorComments: String
    Additional comments forwarded by the processor.
  • reason: DisputeReason
    The reason the dispute was created.
  • reasonCode: String
    The reason code provided by the processor.
  • reasonDescription: String
    The reason code description based on the `reasonCode`.
  • receivedDate: Date
    Date the dispute was received by the merchant.
  • referenceNumber: String
    The string value representing the reference number provided by the processor (if any).
DisputeStatusEvent
A record of a status the dispute has passed through.
fields:
  • disbursementDate: Date
    The date any funds associated with this event were disbursed.
  • status: DisputeStatus
    The status of the dispute.
  • timestamp: Timestamp
    Date and time when the status event occurred.
  • effectiveDate: Date
    The date the status event took effect.
DisputeTextEvidence
Text evidence supporting a dispute case.
fields:
  • id: ID!
    Unique identifier.
  • legacyId: ID!
    Legacy unique identifier.
  • createdAt: Timestamp
    Date and time at which the evidence was created with Braintree.
  • sentToProcessorAt: Timestamp
    Date and time at which the evidence was sent to the processor.
  • content: String
    The body for text evidence.
  • category: DisputeEvidenceCategory
    The evidence category.
interfaces:
EmvCardOriginDetails
Additional information about an integrated circuit card (ICC) payment method supplied by an in-store payment reader.
fields:
  • authorizationMode: InStoreReaderAuthorizationMode
    The authorization mode used to perform the transaction on the payment reader.
  • pinVerified: Boolean
    An indicator for whether the transaction was verified via pin.
  • inputMode: PaymentReaderInputMode
    The input mode used on the payment reader to facilitate an in-store transaction.
  • terminalId: String
    The ID of the terminal that was processed this transaction.
  • applicationPreferredName: String
    The preferred name associated with the application used to process an EMV transaction.
  • applicationIdentifier: String
    The identifier specifying which EMV application was used to process the transaction.
  • terminalVerificationResult: String
    A status code representing the result of a series of validations performed against an EMV enabled credit card.
  • cardSequenceNumber: String
    A unique identifier for credit cards that share the same PAN.
  • applicationInterchangeProfile: String
    An indicator of the credit card's capabilities within the processing application.
  • terminalTransactionDate: String
    The local date that the transaction requested authorization from the payment reader, formatted YYMMDD.
  • terminalTransactionType: String
    An indicator of the type of transaction specified during authorization processing.
  • cashbackAmount: String
    An additional amount associated with the transaction that represents the cashback amount requested by the cardholder.
  • applicationUsageControl: String
    An indicator used to specify an issuer's restrictions for processing in a geographic region.
  • terminalCountryCode: String
    The country code indicated by the payment reader to process the transaction with.
  • applicationCryptogram: String
    The cryptogram provided by an integrated circuit card (ICC) used for processing the transaction.
  • cryptogramInformationData: String
    An indicator for the type of application cryptogram provided by an integrated circuit card (ICC) to process the transaction.
  • cardholderVerificationMethodResults: String
    An indicator of the cardholder verification method and if it was successful or unsuccessful.
  • applicationTransactionCounter: String
    A counter managed by an integrated circuit card (ICC) that provides a reference to each transaction using that card.
  • unpredictableNumber: String
    A value used to uniquely differentiate an application cryptogram used during authorization processing.
  • issuerActionCodeDefault: String
    An indicator of the conditions that caused a transaction to be offline declined by the issuer, in a scenario where the transaction may have authorized if the payment reader made a processor request but was unable to.
  • issuerActionCodeDenial: String
    An indicator of the conditions that caused a transaction to be offline declined by the issuer, in a scenario where the payment reader did not attempt to make a processor request.
  • issuerActionCodeOnline: String
    An indicator of the conditions that caused the payment reader to attempt to make a processor request.
interfaces:
ExchangeRateQuote
Details of the generated exchange rate quote.
fields:
  • id: ID!
    Unique identifier, which must be passed in the payment request in order to honor the exchange rate during settlement.
  • baseAmount: MonetaryAmount
    The amount in the `baseCurrency` to be converted to the `quoteCurrency`. If no amount was provided, then this amount is 1 unit of `baseCurrency`.
  • quoteAmount: MonetaryAmount
    The amount in the `quoteCurrency` converted from the `baseCurrency`. If no amount was provided, then this amount is converted from 1 unit of `baseCurrency`, which will be the same as `exchangeRate` after rounding-off.
  • exchangeRate: ExchangeRate
    This much of `quoteCurrency` is required to buy 1 unit of `baseCurrency`. This includes merchant `markupPercentage` if any. If a `markupPercentage` is specified, this field will be the sum of that percentage and the `tradeRate`.
  • tradeRate: ExchangeRate
    This is the rate at which PayPal will settle with the merchant.
  • expiresAt: Timestamp
    When the exchange rate quote represents expires.
  • refreshesAt: Timestamp
    When the exchange rate quote represents will be refreshed.
ExchangeRateQuotePayload
Exchange rate quotes for a specific customer.
fields:
  • clientMutationId: String
    An identifier used to reconcile requests and responses. 255 characters maximum.
  • quotes: [ExchangeRateQuote!]
    Exchange rate quote details for each base and quote currency combination.
FacilitatorDetails
Fields capturing information about a third party that provided payment information for this transaction via the Grant API, Shared Vault, or Google Pay.
fields:
  • oauthApplication: OAuthApplication
    The OAuth application that owns the payment information used to create the transaction.
FailedEvent
Accompanying information for a transaction that failed because it could not be successfully sent to the processor.
fields:
  • status: PaymentStatus
    The new status of the transaction.
  • timestamp: Timestamp
    Date and time when the transaction failed.
  • amount: MonetaryAmount
    The amount of the transaction for this status event.
  • source: PaymentSource
    The source for the transaction change to the new status.
  • processorResponse: TransactionAuthorizationProcessorResponse
    Fields describing the payment processor response, or an explanation for the lack thereof.
  • networkResponse: PaymentNetworkResponse
    Fields describing the network response to the authorization request.
  • riskDecision: RiskDecision
    Risk decision for this transaction.
  • terminal: Boolean
    Whether or not this is the final state for the transaction.
interfaces:
FinalizeDisputePayload
Top-level field returned when finalizing a dispute.
fields:
  • clientMutationId: String
    An identifier used to reconcile requests and responses. 255 characters maximum.
  • dispute: Dispute
    Information about the dispute that was finalized.
FraudProviderConfiguration
Configuration for fraud protection provider.
fields:
  • merchantId: String
    The merchant ID used by the fraud protection provider to identify the fraud data collection request.
  • name: String
    The name of the fraud provider.
GatewayRejectedEvent
Accompanying information for a gateway rejected transaction.
fields:
  • status: PaymentStatus
    The new status of the transaction.
  • timestamp: Timestamp
    Date and time when the transaction was rejected by the gateway.
  • amount: MonetaryAmount
    The amount of the transaction for this status event.
  • source: PaymentSource
    The source for the transaction change to the new status.
  • gatewayRejectionReason: GatewayRejectionReason
    The reason the transaction was rejected, based on your gateway settings.
  • processorResponse: TransactionAuthorizationProcessorResponse
    Fields describing the payment processor response. Depending on your gateway settings, the AVS and CVV responses may be the reason for the rejection.
  • networkResponse: PaymentNetworkResponse
    Fields describing the network response to the authorization request.
  • riskDecision: RiskDecision
    Risk decision for this transaction. If the gatewayRejectionReason is fraud, this may be the reason for the rejection.
  • terminal: Boolean
    Whether or not this is the final state for the transaction.
  • duplicateOf: Transaction
    The original transaction if the gateway rejection reason was `DUPLICATE`.
interfaces:
GeoCoordinates
Coordinates describing a geographic position.
fields:
  • latitude: Float
    The angular distance of a place north or south of the earth's equator. A positive value is north of the equator, a negative value is south of the equator.
  • longitude: Float
    The angular distance of a place east or west of the meridian at Greenwich, England. A positive value is east of the prime meridian, a negative value is west of the prime meridian.
GooglePayConfiguration
Configuration for Google Pay on Android and the web.
fields:
  • countryCode: CountryCodeAlpha2
    The country code of the acquiring bank where the transaction is likely to be processed.
  • displayName: String
    A string used to identify the merchant to the customer.
  • environment: GooglePayEnvironment
    The environment being used for Google Pay.
  • paypalClientId: String
    A string used to identify the merchant's PayPal account when generating a PayPal Closed Loop Token.
  • supportedCardBrands: [CreditCardBrandCode!]
    A list of card brands supported by the merchant for Google Pay.
GooglePayOriginDetails
Additional information about the payment method specific to Google Pay.
fields:
  • googleTransactionId: String
    A reference ID for the Google transaction.
  • bin: String
    The first 6 digits of the credit card, known as the Bank Identification Number. This BIN may differ from the BIN of the customer's actual card.
HyperwalletAccountDetails
Details about a Hyperwallet account.
fields:
  • userId: String
    The ID of the Hyperwallet account.
IDealConfiguration
Configuration for iDEAL.
fields:
  • routeId: String
    The route ID used to process an iDEAL payment.
  • assetsUrl: String
    A URL used to redirect the customer to the bank's web page.
InStoreContext
Reference object for an in-store request.
interfaces:
InStoreContextPayload
Top-level fields returned when requesting a state change on an in-store reader.
fields:
  • clientMutationId: String
    An identifier used to reconcile requests and responses. 255 characters maximum.
  • id: ID!
    A unique ID for this in-store context request.
  • reader: InStoreReader
    The reader associated with the in-store request.
  • status: InStoreContextStatus!
    The status of the context created.
InStoreLocation
An in-store location.
fields:
  • id: ID!
    Unique identifier.
  • name: String
    Name of the in-store location.
  • internalName: String
    A merchant-assigned internal name of this location, unique to this merchant.
  • address: InStoreLocationAddress
    The address of the in-store location.
  • geoCoordinates: GeoCoordinates
    The coordinates of this location.
  • payerId: ID
    The PayPal account ID to which this location was added.
  • qrCodePaymentsEnabled: Boolean
    Whether QR code payments will be enabled for this location.
InStoreLocationAddress
Input fields for an in-store location address.
fields:
  • streetAddress: String
    The street address.
  • extendedAddress: String
    Extended address information, such as an apartment or suite number.
  • locality: String
    Locality/city.
  • region: String
    State or province.
  • postalCode: String
    Postal code in any country's format, otherwise known as CAP, CEP, Eircode, NPA, PIN, PLZ, or ZIP code.
  • countryCode: CountryCode
    Country code for the address.
InStoreLocationConnection
A paginated list of in-store locations.
fields:
InStoreLocationConnectionEdge
An in-store location within an InStoreLocationConnection.
fields:
  • cursor: String
    The in-store locations's location within the InStoreLocationConnection. Used for requesting additional pages.
  • node: InStoreLocation
    The in-store location.
InStoreReader
An in-store payment card reader.
fields:
  • id: ID!
    Unique identifier.
  • name: String
    Name given to the reader.
  • vendor: InStoreReaderVendor
    Vendor-specific information about the reader.
  • location: InStoreLocation
    The in-store location the reader is attached to.
  • status: ReaderStatus
    Current status of the reader.
  • pairedAt: Timestamp
    Date and time when the reader was paired.
  • lastSeenAt: Timestamp
    Date and time when the reader last established a connection.
  • offlineSince: Timestamp
    Date and time when the reader last disconnected.
  • softwareVersion: String
    The version of the payment application running on the Reader.
InStoreReaderConnection
A paginated list of in-store readers.
fields:
InStoreReaderConnectionEdge
An in-store reader within an InStoreReaderConnection.
fields:
  • cursor: String
    The in-store reader's location within the InStoreReaderConnection. Used for requesting additional pages.
  • node: InStoreReader
    The in-store reader.
InStoreReaderPayload
Top-level fields returned for an in-store reader.
fields:
  • clientMutationId: String
    An identifier used to reconcile requests and responses. 255 characters maximum.
  • reader: InStoreReader
    The reader.
KountConfiguration
Configuration for Kount fraud tools.
fields:
  • merchantId: String
    The Kount merchant ID used to identify the fraud data collection request.
LiabilityShift
A scenario detailing which party assumes liability for certain conditions in the event of a transaction being disputed.
fields:
LocalPaymentContext
The LocalPayment object.
fields:
  • id: ID!
    Unique identifier for the payment context.
  • legacyId: ID!
    Legacy unique identifier.
  • type: LocalPaymentMethodType
    The type of the local payment.
  • approvalUrl: String
    The URL to which a customer should be redirected to approve the local payment.
  • amount: MonetaryAmount
    The amount charged in this local payment.
  • merchantAccountId: String
    The merchant account used to create the payment context.
  • transactedAt: Timestamp
    Date and time when the local payment context was used to create a transaction.
  • approvedAt: Timestamp
    Date and time when the local payment context was approved by the customer.
  • createdAt: Timestamp!
    Date and time when the local payment context was created.
  • updatedAt: Timestamp!
    Date and time when the local payment context was updated.
  • expiredAt: Timestamp
    Date and time when the local payment context was expired.
  • paymentId: String!
    Unique identifier for the local payment.
  • orderId: String
    The PayPal Invoice ID.
interfaces:
LocalPaymentDetails
Local payment specific details on a transaction.
fields:
  • origin: PaymentMethodOrigin
    Additional information about the local payment method provided from a third-party origin, such as PayPal or another regional payment method provider.
  • type: LocalPaymentMethodType
    Regional payment method selected by the customer.
  • displayName: String
    Description of the payment method that can be displayed to customers.
MasterpassConfiguration
Configuration for Masterpass.
fields:
  • merchantCheckoutId: String
    The Masterpass merchant checkout ID used to identify the merchant in Masterpass requests.
  • supportedCardBrands: [CreditCardBrandCode!]
    A list of card brands supported by the merchant for Masterpass.
MasterpassOriginDetails
Additional information about the payment method specific to Masterpass.
fields:
  • bin: String
    The first 6 digits of the credit card, known as the Bank Identification Number. This BIN may differ from the BIN of the customer's actual card.
Merchant
Details about a merchant and its current settings.
fields:
MerchantAccount
Information about a merchant account associated with a merchant.
fields:
  • id: ID!
    Unique identifier for the merchant account. Used to determine what merchant account processed or will process a given Payment.
  • bankAccount: DisbursementBankAccount
    The disbursement bank account linked with the merchant account.
  • currencyCode: CurrencyCodeAlpha
    The ISO code for the currency the merchant account uses.
  • dbaName: String
    Business name of the account.
  • externalId: String
    A unique identifier for this account in external systems.
  • status: MerchantAccountStatus
    The status of a merchant account. This determines whether the merchant account can be used to create a Payment.
  • isDefault: Boolean
    Whether this merchant account is the default for this merchant. The default merchant account is used to process all Payments where a merchant account ID is not specified.
  • paypalAccount: PayPalAccountDetails
    The PayPal account linked with the merchant account.
  • hyperwalletAccount: HyperwalletAccountDetails
    The Hyperwallet account linked with the merchant account.
  • venmoAccount: VenmoAccountDetails
    The Venmo account linked with the merchant account.
  • threeDSecure: MerchantAccountThreeDSecureConfiguration
    The 3D Secure configuration for the merchant account.
MerchantAccountApplication
A record of a merchant account application.
fields:
  • id: ID!
    A unique ID for the account application. Can be used to query the status of the onboarding request in the future.
  • legacyId: ID!
    Legacy unique ID.
  • status: ApplicationStatus
    The status of the application.
MerchantAccountConnection
A paginated list of merchant accounts.
fields:
MerchantAccountConnectionEdge
A merchant account within a MerchantAccountConnection.
fields:
  • cursor: String
    This merchant account's location within the MerchantAccountConnection. Used for requesting additional pages.
  • node: MerchantAccount
    The merchant account.
MerchantAccountThreeDSecureConfiguration
Details about the 3D Secure configuration of the merchant account.
fields:
MerchantAccountThreeDSecureVersionConfiguration
Details about the configuration of a version of 3D Secure for the merchant account.
fields:
MonetaryAmount
A monetary amount with currency.
fields:
  • value: Amount
    The amount of money, either a whole number or a number with up to 3 decimal places.
  • currencyCode: CurrencyCodeAlpha
    The currency code for the monetary amount.
Mutation
The top-level Mutation type. Mutations are used to make requests that create or modify data.
fields:
NetworkTokenOriginDetails
Additional information about the payment method specific to Network Token.
fields:
  • bin: String
    The first 6 digits of the credit card, known as the Bank Identification Number. This BIN may differ from the BIN of the customer's actual card.
OAuthApplication
Information about an OAuth Application.
fields:
  • clientId: String
    The unique identifier of the OAuth application.
  • name: String
    The name of the OAuth application.
PageInfo
The page information for a connection.
fields:
  • hasNextPage: Boolean!
    Whether or not there is a next page available.
  • hasPreviousPage: Boolean!
    Always false; backwards pagination is not supported. Present to comply with Relay specifications.
  • startCursor: String
    The cursor for the first item in the connection page.
  • endCursor: String
    The cursor for the last item in the connection page.
ParentAuthorization
An original authorization's relationship to all its partial capture transactions.
fields:
  • childCaptures: [Transaction!]
    The captures on a partially captured authorization.
  • totalAmountAuthorized: MonetaryAmount
    The total amount authorized by this transaction. This amount will not change as this transaction is partially captured.
PartialCaptureTransactionPayload
Top-level output field from partially capturing a transaction.
fields:
  • clientMutationId: String
    An identifier used to reconcile requests and responses. 255 characters maximum.