OAuth

Reference

Availability

OAuth is in closed beta in production, and open beta in sandbox. Contact us to express interest in the production beta release.

Resource-oriented OAuth scopes

Scope	Description
Address Resource
`address:create`	`Address: Create`
`address:delete`	`Address: Delete`
`address:find`	`Address: Find`
`address:update`	`Address: Update`
Apple Pay Resource
`apple_pay:manage_web_domains`	`Apple Pay: Register DomainApple Pay: Registered DomainsApple Pay: Unregister Domain`
Client Token Resource
`client_token:generate`	`Client Token: Generate`
Credit Card Verification Resource
`credit_card_verification:search`	`Credit Card Verification: Search`
Credit Card Resource
`credit_card:expiring_between`	`Credit Card: Expiring Between`
Customer Resource
`customer:create`	`Customer: Create`
`customer:delete`	`Customer: Delete`
`customer:find`	`Customer: Find`
`customer:search`	`Customer: Search`
`customer:update`	`Customer: Update`
Dispute Resource
`dispute:accept`	`Dispute: Accept` Also available as `dispute:accept/facilitated`, which only allows acting on the dispute if the connected OAuth application was a facilitator.
`dispute:add_evidence`	`Dispute: Add File EvidenceDispute: Add Text Evidence` Also available as `dispute:add_evidence/facilitated`, which only allows acting on the dispute if the connected OAuth application was a facilitator.
`dispute:finalize`	`Dispute: Finalize` Also available as `dispute:finalize/facilitated`, which only allows acting on the dispute if the connected OAuth application was a facilitator.
`dispute:find`	`Dispute: Find` Also available as `dispute:find/facilitated`, which only allows find the dispute if the connected OAuth application was a facilitator.
`dispute:remove_evidence`	`Dispute: Remove Evidence` Also available as `dispute:remove_evidence/facilitated`, which only allows acting on the dispute if the connected OAuth application was a facilitator.
`dispute:search`	Also available as `dispute:search/facilitated`, which only allows searching disputes where the connected OAuth application was a facilitator.
Document Upload
`document_upload:create`	`Document Upload: Create`
Merchant Account Resource
`merchant_account:all`	`Merchant Account: All`
`merchant_account:find`	`Merchant Account: Find`
Payment Method Resource
`payment_method:create`	`Payment Method: Create`
`payment_method:delete`	`Payment Method: Delete`
`payment_method:find`	`Payment Method: Find`
`payment_method:update`	`Payment Method: Update`
Payment Method Nonce Resource
`payment_method_nonce:create`	`Payment Method Nonce: Create`
`payment_method_nonce:find`	`Payment Method Nonce: Find`
Settlement Batch Summary Resource
`settlement_batch_summary:generate`	`Settlement Batch Summary: Generate`
Subscription Resource
`subscription:cancel`	`Subscription: Cancel`
`subscription:create`	`Subscription: Create`
`subscription:find`	`Subscription: Find`
`subscription:search`	`Subscription: Search`
`subscription:update`	`Subscription: Update`
Transaction Resource
`transaction:manage_escrow`	`Transaction: Cancel ReleaseTransaction: Hold In EscrowTransaction: Release From Escrow`
`transaction:clone`	`Transaction: Clone Transaction`
`transaction:find`	`Transaction: FindTransaction Line Item: Find All`
`transaction:refund`	`Transaction: Refund`
`transaction:sale`	`Transaction: Sale`
`transaction:search`	`Transaction: Search`
`transaction:manage_settlement`	`Transaction: Submit For Partial SettlementTransaction: Submit For Settlement`
`transaction:void`	`Transaction: Void`

Additional OAuth scopes

Scope	Description
`view_facilitated_transaction_metrics`	Allows grantor to view metrics on facilitated transactions
`grant_payment_method`	Allows usage of the Grant API
`read_facilitated_transactions`	Allows `Transaction: Search` but only returns results where the connected OAuth application was a facilitator
`shared_vault_transactions`	Allows Shared Vault