Skip to main content

Braintree CreditCard

This page provides an overview of the payments methods provided by the Braintree CreditCard adapter in the IXOPAY platform. It also includes a full list of all configuration options available to you when integrating Braintree CreditCard within your payments landscape, as well as an overview of the parameters required when submitting a transaction via IXOPAY's API.

Provider Test-Cards:

Payment Methods

Payment MethodTransaction FlowsTransaction Types
CreditCard incl. GooglePay and ApplePaypayment.js IntegrationAll

Notes

GooglePay via Braintree CreditCard currently only works with 3DS_CRYPTOGRAM tokens (via mobile phone application) and not with PAN_ONLY (via web).

Connector Config

Parameter / NameTypeRequiredDescription
publicKeystringtrueThe Braintree Public Key - to be found in the Braintree Merchant Portal
privateKeystringtrueThe Braintree Private Key - to be found in the Braintree Merchant Portal
merchantIdstringfalseThe Braintree Merchant Id - to be found in the Braintree Merchant Portal
ignoreDisputesboolfalseDetermine if incoming Disputes (part of Callback) should be handled at all.
sendDescriptionInCustomFieldstringfalseRequired if you want to add a description to your Transaction (checkout Further Config Parameter Description down below).
sendMerchantTransactionIdInCustomFieldstringfalseRequired if you want to pass a Merchant-Transaction-Id to your Transaction (checkout Further Config Parameter Description down below).
useBtDescriptorboolfalseto map additionalId1 to Braintree's descriptor.name
useAvsboolfalseto use Braintree's Address Verification Service

Further Config Parameter Description

  • To be able to use sendDescriptionInCustomField or sendMerchantTransactionIdInCustomField, you will have to set up "Custom Fields" in the Braintree Merchant Portal (please check out the official Braintree Documentation, see Custom Fields).

Add a new Custom Field and pass the "Api Name" of the representing field in the Connector Config (e.g 'merchant_tx_id' for sendMerchantTransactionIdInCustomField).

  • When useAvs is active, a request to Braintree's verifyCreditCard Service will happen before charging the payment, without affecting the payment process. In addition to activating that setting, you need to correctly set up the AVS options at Fraud Management in the Braintree Merchant Portal. If everything is set correctly, an extraData field avs_result will be added to the result with the value that indicates the AVS status which has been retrieved from this request.

Required parameters

  • transaction.indicator: mandatory for card on file, card on file merchant initiated, recurring (see Recurring Transactions)

Required parameters for Level2/Level3

  • Send Level 2/3 Data must be checked
Parameter / NameTxTypeRequiredDescription
extraData.purchaseOrderNumberdebit, preauthorize, capturefalse
extraData.shipsFromPostalCodedebit, preauthorize, capturetrue
extraData.taxExemptdebit, preauthorize, capturefalsetrue/ false, if not set: false
Level 2/3 data.Discount Amountdebit, preauthorize, capturetrueif not set: 0.00
Level 2/3 data.Tax Amountdebit, preauthorize, capturetrueif not set: 0.00
Level 2/3 data.Freight Amountdebit, preauthorize, capturetrueif not set: 0.00
Itemdebit, preauthorize, capture, refundtrueone Item at least is required and the following are the required fields for each Transaction Type
Item.namedebit, preauthorize, capture, refundtrue
Item.quantitydebit, preauthorize, capture, refundtrue
Item.pricedebit, preauthorize, capture, refundtrue
Item.identificationdebit, preauthorize, capture, refundtrue
Item.descriptiondebit, preauthorize, capture, refundtrue
Item.l2l3Data.unitdebit, preauthorize, capture, refundtrue
Item.l2l3Data.unitPricedebit, preauthorize, capture, refundfalse
Item.extraData.unitTaxAmountdebit, preauthorize, capture, refundtrueif not set: 0.00
Item.l2l3Data.taxAmountdebit, preauthorize, capture, refundtrueif not set: 0.00
Item.l2l3Data.discountdebit, preauthorize, capture, refundtrueif not set: 0.00
Item.l2l3Data.commodityCodedebit, preauthorize, capture, refundtrue
Item.extraData.urldebit, preauthorize, capture, refundtrue
Item.l2l3Data.typedebit, preauthorize, capture, refundfalse
Item.extraData.imageUrldebit, preauthorize, capture, refundfalse
Customer.Shipping Addressdebit, preauthorizetrueCustomer Shipping Address is required, and the following are the required fields for each Transaction Type
Customer.shippingFirstNamedebit, preauthorizetrue
Customer.shippingLastNamedebit, preauthorizetrue
Customer.shippingAddress1debit, preauthorizetrue
Customer.shippingAddress2debit, preauthorizefalse
Customer.shippingCitydebit, preauthorizetrue
Customer.shippingPostcodedebit, preauthorizetrue
Customer.shippingStatedebit, preauthorizetrue
Customer.shippingCountrydebit, preauthorizetrue

Optional Parameters

Parameter / NameTypeTxTypeDescription
additionalId1stringdebit, preauthorizethis will map to Braintree descriptor

GooglePay & ApplePay

Further Information on how to process GooglePay & ApplePay Tokens.