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