availability

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 our Business Development team.

The Grant API provides visibility into facilitated transactions created with granted payment information.

Grantor

With the appropriate rights, the grantor can search for transactions that the recipient has created with granted payment information. Facilitated transaction searches behave the same as any other transaction search, but are limited to only those transactions that the recipient has created with the granted payment information. To enable facilitated transaction search, configure the connection with the recipient to include the read_facilitated_transactions OAuth scope.

Recipient

The recipient can also search for transactions created with granted payment information.

Control Panel search

If the recipient has connected to any grantors, those grantors will show up as options on the Advanced Search page under Payment Method Source. These grantors can be used as parameters in Advanced Search like any other transaction sources. If the recipient is connected to multiple grantors, they can include or exclude transactions created with payment methods from any combination of grantors.

API search

A recipient can search for facilitated transactions via the API by passing the source search parameter and setting it to the grantor's OAuth application client ID. This value can be found on the Connected OAuth Applications page in the Control Panel, as well as in the facilitator details returned in transaction response objects.

note

The grantor's OAuth application client ID is different from the name that appears in the Control Panel under Payment Method Source.

See also

Next Page: Vaulting →

Still have questions?

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