BraintreePluginOptions

@vendure-community/braintree-plugin Source

Options for the Braintree plugin.

Signature

interface BraintreePluginOptions {    environment?: Environment;    storeCustomersInBraintree?: boolean;    extractMetadata?: (transaction: Transaction) => PaymentMetadata;    merchantAccountIds?: BraintreeMerchantAccountIds;}

environment

propertyEnvironment

Default:Environment.Sandbox

The Braintree environment being targeted, e.g. sandbox or production.

storeCustomersInBraintree

propertyboolean

Default:false

If set to true, a Customer object will be created in Braintree, which allows the secure storage ("vaulting") of previously-used payment methods. This is done by adding a custom field to the Customer entity to store the Braintree customer ID, so switching this on will require a database migration / synchronization.

Since v1.8, it is possible to override vaulting on a per-payment basis by passing includeCustomerId: false to the generateBraintreeClientToken mutation.

extractMetadata

property(transaction: Transaction) => PaymentMetadatav1.7.0

Allows you to configure exactly what information from the Braintree Transaction object (which is returned by the transaction.sale() method of the SDK) should be persisted to the resulting Payment entity metadata.

By default, the built-in extraction function will return a metadata object that looks like this:

Example

const metadata = {  "status": "settling",  "currencyIsoCode": "GBP",  "merchantAccountId": "my_account_id",  "cvvCheck": "Not Applicable",  "avsPostCodeCheck": "Not Applicable",  "avsStreetAddressCheck": "Not Applicable",  "processorAuthorizationCode": null,  "processorResponseText": "Approved",  // for Paypal payments  "paymentMethod": "paypal_account",  "paypalData": {    "payerEmail": "michael-buyer@paypalsandbox.com",    "paymentId": "PAYID-MLCXYNI74301746XK8807043",    "authorizationId": "3BU93594D85624939",    "payerStatus": "VERIFIED",    "sellerProtectionStatus": "ELIGIBLE",    "transactionFeeAmount": "0.54"  },  // for credit card payments  "paymentMethod": "credit_card",  "cardData": {    "cardType": "MasterCard",    "last4": "5454",    "expirationDate": "02/2023"  }  // publicly-available metadata that will be  // readable from the Shop API  "public": {    "cardData": {      "cardType": "MasterCard",      "last4": "5454",      "expirationDate": "02/2023"    },    "paypalData": {      "authorizationId": "3BU93594D85624939",    }  }}

merchantAccountIds

propertyBraintreeMerchantAccountIds

An optional mapping of currency codes to Braintree Merchant Account IDs. When set, the corresponding Merchant Account ID will be used for transactions in the given currency.