See also the Braintree_PaymentMethod response object.


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

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

$gateway = new Braintree_Gateway([
    'accessToken' => accessTokenForRecipient,

$grantResult = $gateway->paymentMethod()->grant(
  ['allowVaulting' => false, 'includeBillingPostalCode' => true]
$nonceToSendToRecipient = $grantResult->paymentMethodNonce->nonce;
// ...
sharedPaymentMethodToken required, string

The alphanumeric value that references a specific payment method stored in your Vault.

Additional Parameters
'allowVaulting' boolean

Whether or not the receiving merchant may use the resulting nonce to store the payment method in their own Vault for future use.

'includeBillingPostalCode' boolean

If true, any payment methods or transactions created using the nonce will include the billing postal code from your Vault record.

'revokeAfter' DateTime

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 Braintree_PaymentMethod::revoke().

Still have questions?

If you can’t find an answer, contact our Support team