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 ApplePay.RegisterDomain() ApplePay.RegisteredDomains() ApplePay.UnregisterDomain()
Client Token Resource
client_token:generate ClientToken.Generate()
Credit Card Verification Resource
credit_card_verification:search CreditCardVerification.Search()
Credit Card Resource
credit_card:expiring_between CreditCard.ExpiringBetween()
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.AddFileEvidence() Dispute.AddTextEvidence()
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.RemoveEvidence()
Also available as dispute:remove_evidence/facilitated, which only allows acting on the dispute if the connected OAuth application was a facilitator.
dispute:search 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 DocumentUpload.Create()
Payment Method Resource
payment_method:create PaymentMethod.Create()
payment_method:delete PaymentMethod.Delete()
payment_method:find PaymentMethod.Find()
payment_method:update PaymentMethod.Update()
Payment Method Nonce Resource
payment_method_nonce:create PaymentMethodNonce.Create()
payment_method_nonce:find PaymentMethodNonce.Find()
Settlement Batch Summary Resource
settlement_batch_summary:generate SettlementBatchSummary.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.CancelRelease() Transaction.HoldInEscrow() Transaction.ReleaseFromEscrow()
transaction:clone Transaction.CloneTransaction()
transaction:find Transaction.Find() TransactionLineItem.FindAll()
transaction:refund Transaction.Refund()
transaction:sale Transaction.Sale()
transaction:search Transaction.Search()
transaction:manage_settlement Transaction.SubmitForPartialSettlement() Transaction.SubmitForSettlement()
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