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