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 access_token. 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 access_token must include the right to grant payment methods to that merchant. When setting the connect_url, the grantor must include the OAuth scope grant_payment_method.

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 access_token must include the right to search facilitated transactions. As the grantor, be sure to include the OAuth scope read_facilitated_transactions, in addition to grant_payment_method, when setting the connect_url.

Reports

The grantor can also choose to view metrics on facilitated transactions by including the view_facilitated_transaction_metrics OAuth scope. This is less permissive than read_facilitated_transactions and allows the grantor to read reports on the number and volume of facilitated transactions. More information on Grant API reporting can be found in our support articles.

Next Page: Search →

Still have questions?

If you can’t find an answer, contact us