Payment Method

Payment Method: Grant

See also the Payment Method response object.

availability

The Grant API is currently in a limited release. Contact us to determine whether it's right for your needs and to request access to the API.

The Grant API allows you to give another Braintree merchant controlled access to one of your customer's payment methods.

  1. Node
const gateway = new braintree.BraintreeGateway({
  accessToken: accessTokenForRecipient
});

gateway.paymentMethod.grant(
  "the_payment_method_token",
  { allow_vaulting: false, include_billing_postal_code: true },
  (err, grantResult) => {
    const nonceToSendToRecipient = grantResult.paymentMethodNonce.nonce;
    // ...
  }
);
Arguments
sharedPaymentMethodTokenrequired, String
The alphanumeric value that references a specific payment method stored in your Vault.
Additional Parameters
allowVaultingboolean
Whether or not the receiving merchant may use the resulting nonce to store the payment method in their own Vault for future use.
includeBillingPostalCodeboolean
If true, any payment methods or transactions created using the nonce will include the billing postal code from your Vault record.
revokeAfterString

A date/time after which the grant will automatically be revoked. The time must be at least 24 hours after the grant occurs and specified to the hour (minutes and seconds should both be 0). The date/time should be in ISO 8601 format. If you wish to revoke sooner or at a specific time, use Payment Method: Revoke.