API keys
Permission scopes
When you create an API key, you must assign it scopes and give it an alias to identify it. Each scope corresponds to endpoints that the key has permission to:
- READ, via GET calls
- WRITE, via POST and PUT calls
For more details about managing scopes, see the API key management guide.
This page lists the endpoints in each scope.
Notes on scope evolution:
- Each endpoint belongs to only one scope.
- Endpoints will not be moved from their current scope.
- If a new endpoint is added to an existing scope, keys already assigned to the scope automatically gain access to the new endpoint. This also applies to scope permissions that contain no endpoints today.
- If a new sub-scope is created, e.g.
Bankaccounts.Xxxx, then keys previously assigned theBankaccountsscope inherit access to the new sub-scope.
Bankaccounts
WRITE
- POST Validate data for a Recipient
- POST Create a Recipient
- PUT Deactivate a Recipient
- POST Create an IBAN Bank Account
- POST Create a US Bank Account
- POST Create a CA Bank Account
- POST Create a GB Bank Account
- POST Create an OTHER Bank Account
- PUT Deactivate a Bank Account
READ
- GET View payout methods
- GET View the schema for a Recipient
- GET View a Recipient
- GET List Recipients for a User
- GET View a Bank Account
- GET List Bank Accounts for a User
- GET List Transactions for a Bank Account
Client
Client.Details
WRITE
READ
Client.Developers
WRITE
READ
Client.PayIns
WRITE
READ
- No endpoints with READ permission
Client.Permissions
WRITE
- POST Create a Permission Group
- PUT Update a Permission Group
- POST Create an SSO
- PUT Update an SSO
- PUT Extend an SSO invitation
READ
- GET View a Permission Group
- GET List all Permission Groups
- GET View an SSO
- GET List all SSOs
- GET List SSOs for a Permission Group
Client.Reports
WRITE
READ
Client.Wallets
WRITE
- No endpoints with WRITE permission
READ
- GET View a Client Wallet
- GET List all Client Wallets
- GET List Client Wallets by FundsType
- GET List Transactions for a Client Wallet
Conversions
WRITE
- POST Create a Quote
- POST Create a Quoted Conversion between user Wallets
- POST Create an Instant Conversion between user Wallets
- POST Create a Quoted Conversion between Client Wallets
- POST Create an Instant Conversion between Client Wallets
READ
Disputes
Disputes.General
WRITE
- PUT Submit a Dispute
- PUT Update a Dispute
- PUT Close a Dispute
- POST Create a Dispute Document
- PUT Submit a Dispute Document
- POST Create a Dispute Document Page
- POST Create a weblink to view the Pages of a Dispute Document
READ
- GET View a Dispute
- GET List all Disputes
- GET List Disputes pending settlement
- GET List Disputes for a PayIn
- GET List Disputes for a User
- GET List Disputes for a Wallet
- GET View a Dispute Document
- GET List all Dispute Documents
- GET List Documents for a Dispute
- GET List Transactions for a Dispute
- GET View a Repudiation
Disputes.Settlement
WRITE
READ
Payins
WRITE
- POST Create a Card Registration
- POST Tokenize the card
- PUT Update a Card Registration
- PUT Deactivate or edit a Card
- POST Look up metadata for a payment method
- POST Create a Card Validation
- POST Create a Direct Card PayIn
- POST Create a Recurring PayIn Registration (Card
- PUT Update a Recurring PayIn Registration
- POST Create a Recurring PayIn (CIT
- POST Create a Recurring PayIn (MIT
- POST Create a Preauthorization
- PUT Cancel or validate a Preauthorization
- POST Create a Preauthorized PayIn
- POST Create a Deposit Preauthorization
- PUT Cancel a Deposit Preauthorization or request a no-show
- POST Create a Deposit Preauthorized PayIn without complement
- POST Create a Deposit Preauthorized PayIn prior to complement
- POST Create a Deposit Preauthorized PayIn complement
- POST Create a Web Card PayIn
- POST Create a Bank Wire PayIn
- POST Create an IBAN Banking Alias
- PUT Deactivate a Banking Alias
- POST Create a Mandate
- PUT Cancel a Mandate
- POST Create a Direct Debit PayIn
- POST Create a Web Direct-Debit PayIn
- POST Create an Apple Pay PayIn
- POST Create a Bancontact PayIn
- POST Create a Bizum PayIn
- POST Create a BLIK PayIn (with code)
- POST Create a BLIK PayIn (without code)
- POST Create a Giropay PayIn
- POST Create a Google Pay PayIn
- POST Create an iDEAL PayIn
- POST Create a Klarna PayIn
- POST Create an MB WAY PayIn
- POST Create an Multibanco PayIn
- POST Create a Payconiq PayIn
- POST Create a PayPal PayIn
- PUT Add tracking information to a PayPal PayIn
- POST Create a Recurring PayIn Registration (PayPal)
- PUT Update a Recurring PayIn Registration (PayPal)
- GET View a Recurring PayIn Registration (PayPal)
- POST Create a Recurring PayPal PayIn (CIT)
- POST Create a Recurring PayPal PayIn (MIT)
- POST Create a Satispay PayIn
- POST Create a Swish PayIn
- POST Create a TWINT PayIn
READ
- GET View a PayIn (all payment methods)
- GET View a Card Registration
- GET View a Card
- GET List Cards for a User
- GET List Transactions for a Card
- GET List Cards for a Fingerprint
- GET List Transactions for a Card Fingerprint
- GET View a Card Validation
- GET View a Recurring PayIn Registration
- GET View a Preauthorization
- GET List Preauthorizations for a Card
- GET List Preauthorizations for a User
- GET List Transactions for a Preauthorization
- GET View a Deposit Preauthorization
- GET List Deposit Preauthorizations for a Card
- GET List Deposit Preauthorizations for a User
- GET List Transactions for a Deposit Preauthorization
- GET View card details for a Web Card PayIn
- GET View a Banking Alias
- GET View a Banking Alias for a Wallet
- GET View a Mandate
- GET List all Mandates
- GET List Mandates for a User
- GET List Mandates for a Bank Account
- GET List Transactions for a Mandate
Payouts
WRITE
READ
Refunds
Refunds.General
WRITE
- No endpoints with WRITE permission
READ
Refunds.Payins
WRITE
READ
Refunds.Payouts
WRITE
- No endpoints with WRITE permission
READ
Refunds.Repudiations
WRITE
- No endpoints with WRITE permission
READ
Refunds.Transfers
WRITE
READ
Transfers
WRITE
READ
Users
Users.Details
WRITE
- POST Create a Natural User (SCA)
- PUT Update a Natural User (SCA)
- PUT Categorize a Natural User
- POST Create a Legal User (SCA)
- PUT Update a Legal User (SCA)
- PUT Categorize a Legal User
- POST Enroll a User in SCA
- DELETE Close a Natural User
- DELETE Close a Legal User
- POST Create a Natural User
- PUT Update a Natural User
- POST Create a Legal User
- PUT Update a Legal User
READ
- GET View a User (SCA)
- GET View a User
- GET List all Users
- GET List Transactions for a User
- GET View a User Regulatory Status
- GET View User EMoney
- GET View Authorizations for a country
- GET List Authorizations for all countries
Users.Verification
WRITE
- POST Create an IDV Session
- POST Validate the format of User data
- POST Create a KYC Document
- POST Create a KYC Document Page
- PUT Submit a KYC Document
- POST Create a UBO Declaration
- POST Create a UBO
- PUT Submit a UBO Declaration
- PUT Update a UBO
READ
- GET View an IDV Session
- GET List IDV Sessions for a User
- GET View a KYC Document
- GET List KYC Documents for a User
- GET List all KYC Documents
- GET View a UBO Declaration
- GET View a UBO
- GET List UBO Declarations for a User
Wallet.Details
WRITE
READ