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:
- Valid Card Numbers
- Card Numbers for Unsuccessful Verification
- Card Numbers with type Indicators
- Card Numbers with other Information
Payment Methods
Payment Method | Transaction Flows | Transaction Types |
---|---|---|
CreditCard incl. GooglePay and ApplePay | payment.js Integration | All |
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 / Name | Type | Required | Description |
---|---|---|---|
publicKey | string | true | The Braintree Public Key - to be found in the Braintree Merchant Portal |
privateKey | string | true | The Braintree Private Key - to be found in the Braintree Merchant Portal |
merchantId | string | false | The Braintree Merchant Id - to be found in the Braintree Merchant Portal |
ignoreDisputes | bool | false | Determine if incoming Disputes (part of Callback) should be handled at all. |
sendDescriptionInCustomField | string | false | Required if you want to add a description to your Transaction (checkout Further Config Parameter Description down below). |
sendMerchantTransactionIdInCustomField | string | false | Required if you want to pass a Merchant-Transaction-Id to your Transaction (checkout Further Config Parameter Description down below). |
useBtDescriptor | bool | false | to map additionalId1 to Braintree's descriptor.name |
useAvs | bool | false | to use Braintree's Address Verification Service |
Further Config Parameter Description
- To be able to use
sendDescriptionInCustomField
orsendMerchantTransactionIdInCustomField
, 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 fieldavs_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 / Name | TxType | Required | Description |
---|---|---|---|
extraData.purchaseOrderNumber | debit, preauthorize, capture | false | |
extraData.shipsFromPostalCode | debit, preauthorize, capture | true | |
extraData.taxExempt | debit, preauthorize, capture | false | true / false , if not set: false |
Level 2/3 data.Discount Amount | debit, preauthorize, capture | true | if not set: 0.00 |
Level 2/3 data.Tax Amount | debit, preauthorize, capture | true | if not set: 0.00 |
Level 2/3 data.Freight Amount | debit, preauthorize, capture | true | if not set: 0.00 |
Item | debit, preauthorize, capture, refund | true | one Item at least is required and the following are the required fields for each Transaction Type |
Item.name | debit, preauthorize, capture, refund | true | |
Item.quantity | debit, preauthorize, capture, refund | true | |
Item.price | debit, preauthorize, capture, refund | true | |
Item.identification | debit, preauthorize, capture, refund | true | |
Item.description | debit, preauthorize, capture, refund | true | |
Item.l2l3Data.unit | debit, preauthorize, capture, refund | true | |
Item.l2l3Data.unitPrice | debit, preauthorize, capture, refund | false | |
Item.extraData.unitTaxAmount | debit, preauthorize, capture, refund | true | if not set: 0.00 |
Item.l2l3Data.taxAmount | debit, preauthorize, capture, refund | true | if not set: 0.00 |
Item.l2l3Data.discount | debit, preauthorize, capture, refund | true | if not set: 0.00 |
Item.l2l3Data.commodityCode | debit, preauthorize, capture, refund | true | |
Item.extraData.url | debit, preauthorize, capture, refund | true | |
Item.l2l3Data.type | debit, preauthorize, capture, refund | false | |
Item.extraData.imageUrl | debit, preauthorize, capture, refund | false | |
Customer.Shipping Address | debit, preauthorize | true | Customer Shipping Address is required, and the following are the required fields for each Transaction Type |
Customer.shippingFirstName | debit, preauthorize | true | |
Customer.shippingLastName | debit, preauthorize | true | |
Customer.shippingAddress1 | debit, preauthorize | true | |
Customer.shippingAddress2 | debit, preauthorize | false | |
Customer.shippingCity | debit, preauthorize | true | |
Customer.shippingPostcode | debit, preauthorize | true | |
Customer.shippingState | debit, preauthorize | true | |
Customer.shippingCountry | debit, preauthorize | true |
Optional Parameters
Parameter / Name | Type | TxType | Description |
---|---|---|---|
additionalId1 | string | debit, preauthorize | this will map to Braintree descriptor |
GooglePay & ApplePay
Further Information on how to process GooglePay & ApplePay Tokens.