Configuration

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 uses OAuth to connect a granting Braintree merchant and a receiving Braintree merchant. Once the recipient goes through these flows and consents to receiving granted payment methods, the grantor will receive an accessToken. This token contains encoded information about the recipient, information to the Grant API connection, and the actions the grantor can take on the recipient's behalf. To use the Grant API with the recipient, the accessToken must include the right to grant payment methods to that merchant. When setting the connectUrl, the grantor must include the OAuth scope grantPaymentMethod.

Configuring OAuth scopes

Search for transactions

The recipient can search for any transactions they've created using granted payment methods, but in order for the grantor to access this data, the accessToken must include the right to search facilitated transactions. As the grantor, be sure to include the OAuth scopereadFacilitatedTransactions, in addition to grantPaymentMethod, when setting the connectUrl.