For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.

Contact sales Dashboard

Integration Guides API reference

Integration Guides API reference

Overview
User management
User verification
Wallets
Cards
All pay-ins
Card pay-ins
Banking pay-ins
APM pay-ins
Transfers
Refunds
Disputes
Payouts
FX conversions
Transactions
Echo
Helpers
Platform account

Introduction
API keys
Scopes
Overview
Create OAuth bearer token
Create an access token for the Recipients embedded experience
Create an access token for Checkout SDK features
Rate limiting
Filtering and sorting
Pagination
Idempotency
Data formats
Data availability periods
The Natural User object (SCA)
Create a Natural User (SCA)
Update a Natural User (SCA)
Categorize a Natural User
The Legal User object (SCA)
Create a Legal User (SCA)
Update a Legal User (SCA)
Categorize a Legal User
Enroll a User in SCA
Manage proxy consent for a User
View the SCA status of a User
View a User (SCA)
List all Users
Close a Natural User
Close a Legal User
The Natural User object
Create a Natural User
Update a Natural User
The Legal User object
Create a Legal User
Update a Legal User
View a User
The User Regulatory Status object
View a User Regulatory Status
The User EMoney object
View User EMoney
The IDV Session object
Create an IDV Session
View an IDV Session
List IDV Sessions for a User
The User Data Format object
Validate the format of User data
The KYC Document object
Create a KYC Document
Create a KYC Document Page
Submit a KYC Document
View a KYC Document
List KYC Documents for a User
List all KYC Documents
The UBO Declaration object
Create a UBO Declaration
The UBO object
Create a UBO
Submit a UBO Declaration
Update a UBO
View a UBO Declaration
View a UBO
List UBO Declarations for a User
The Wallet object
Create a Wallet
Update a Wallet
View a Wallet
List Wallets for a User
The Client Wallet object
View a Client Wallet
List all Client Wallets
List Client Wallets by FundsType
The Card Registration object
Create a Card Registration
Tokenize the card
Update a Card Registration
View a Card Registration
The Card object
Deactivate or edit a Card
View a Card
List Cards for a User
List Cards for a Fingerprint
The Payment Method Metadata object
Look up metadata for a payment method
The Card Validation object
Create a Card Validation
View a Card Validation
View a PayIn
The Direct Card PayIn object
Create a Direct Card PayIn
The Recurring PayIn Registration object
Create a Recurring PayIn Registration
Update a Recurring PayIn Registration
View a Recurring PayIn Registration
The Recurring Card PayIn object
Create a Recurring Card PayIn (CIT or MIT)
The Preauthorization object
Create a Preauthorization
Cancel or validate a Preauthorization
View a Preauthorization
List Preauthorizations for a Card
List Preauthorizations for a User
The Preauthorized PayIn object
Create a Preauthorized PayIn
The Deposit Preauthorization object
Create a Card Deposit Preauthorization
Cancel a Deposit Preauthorization
View a Deposit Preauthorization
List Deposit Preauthorizations for a Card
List Deposit Preauthorizations for a User
The Deposit Preauthorized PayIn object
Create a Deposit Preauthorized PayIn
The Web Card PayIn object
Create a Web Card PayIn
The Extended Web Card PayIn object
View card details for a Web Card PayIn
The Bank Wire PayIn object
Create a Bank Wire PayIn
The Virtual Account object
View Virtual Account availabilities
Create a Virtual Account
Deactivate a Virtual Account
View a Virtual Account
List Virtual Accounts for a Wallet
The External Instruction Bank Wire PayIn object
The Banking Alias object
Create an IBAN Banking Alias
Deactivate a Banking Alias
View a Banking Alias
View a Banking Alias for a Wallet
The Pay by Bank PayIn object
View supported banks for Pay by Bank
Create a Pay by Bank PayIn
The Mandate object
Create a Mandate
Cancel a Mandate
View a Mandate
List all Mandates
List Mandates for a User
List Mandates for a Bank Account
The Direct Debit PayIn object
Create a Direct Debit PayIn
The Web Direct-Debit PayIn object
Create a Web Direct-Debit PayIn
The Apple Pay PayIn object
Create an Apple Pay PayIn
The Recurring Apple Pay PayIn object
Create a Recurring Apple Pay PayIn (CIT or MIT)
The Bancontact PayIn object
Create a Bancontact PayIn
The Bizum PayIn object
Create a Bizum PayIn
The BLIK PayIn object
Create a BLIK PayIn
The Giropay PayIn object
Create a Giropay PayIn
The Google Pay PayIn object
Create a Google Pay PayIn
The Recurring Google Pay PayIn object
Create a Recurring Google Pay PayIn (CIT or MIT)
The iDEAL PayIn object
Create an iDEAL PayIn
The Klarna PayIn object
Create a Klarna PayIn
The MB WAY PayIn object
Create an MB WAY PayIn
The Multibanco PayIn object
Create a Multibanco PayIn
The Payconiq PayIn object
Create a Payconiq PayIn
Submit data for a PayPal PayIn
View data submitted for a PayPal PayIn
The PayPal PayIn object
Create a PayPal PayIn
Create a PayPal PayIn
The Recurring PayPal PayIn object
Create a Recurring PayPal PayIn (CIT or MIT)
Create a PayPal Deposit Preauthorization
Add tracking information to a PayPal PayIn
The Satispay PayIn object
Create a Satispay PayIn
The Swish PayIn object
Create a Swish PayIn
The TWINT PayIn object
Create a TWINT PayIn
The Transfer object
Create a Transfer
View a Transfer
The Refund object
Create a Refund for a PayIn
Create a Refund for a Transfer
View a Refund
List Refunds for a PayIn
List Refunds for a Transfer
List Refunds for a Payout
List Refunds for a Repudiation
The Dispute object
View a Dispute
Submit a Dispute
Update a Dispute
Close a Dispute
List all Disputes
List Disputes pending settlement
List Disputes for a PayIn
List Disputes for a User
List Disputes for a Wallet
The Dispute Document object
Create a Dispute Document
View a Dispute Document
Submit a Dispute Document
List all Dispute Documents
Create a Dispute Document Page
Create a weblink to view the Pages of a Dispute Document
List Documents for a Dispute
The Repudiation object
View a Repudiation
The Settlement Transfer object
Create a Settlement Transfer
View a Settlement Transfer
Create a Bank Wire PayIn to the Repudiation Wallet
The Recipient object
View the schema for a Recipient
Validate data for a Recipient
Create a Recipient
Deactivate a Recipient
View a Recipient
List Recipients for a User
View payout methods
The Bank Account object
Create an IBAN Bank Account
Create a US Bank Account
Create a CA Bank Account
Create a GB Bank Account
Create an OTHER Bank Account
Deactivate a Bank Account
View a Bank Account
List Bank Accounts for a User
The Payout object
Create a Payout
View a Payout and check mode applied
View a Payout
Check Instant Payout eligibility
The Conversion Rate object (FX)
View an indicative Conversion Rate
The Quote object (Guaranteed FX)
Create a Quote
View a Quote
The Conversion object (FX)
Create a Quoted Conversion between user Wallets
Create an Instant Conversion between user Wallets
Create a Quoted Conversion between Client Wallets
Create an Instant Conversion between Client Wallets
View a Conversion
The Transaction object
List Transactions for a User
List Transactions for a Wallet
List Transactions for a Client Wallet
List Transactions for a Card
List Transactions for a Card Fingerprint
List Transactions for a Preauthorization
List Transactions for a Deposit Preauthorization
List Transactions for a Bank Account
List Transactions for a Mandate
List Transactions for a Dispute
Supported providers
Supported payment methods
The Intent object
Create an Intent
Cancel an Intent
Create an Intent Capture
Create an Intent Refund
Reverse an Intent Refund
Create an Intent Dispute
Update an Intent Dispute
View an Intent
List all Intents
Create an Intent Split
Update an Intent Split
Execute an Intent Split
Reverse an Intent Split
View an Intent Split
List all Intent Splits
Settlement file format requirements
The Settlement Object
Create a Settlement and generate a secure URL for file upload
Upload a settlement file to the secure URL
Update a Settlement and generate a new upload URL
Cancel a Settlement
View a Settlement
View validation errors for a Settlement
List all Settlements
The API Response object
View an API Response
The Country Authorizations object
View Authorizations for a country
List Authorizations for all countries
The Hook object
Create a Hook
Update a Hook
View a Hook
List all Hooks
The Event object
List all Events
The Report object
Create a Report
View a Report
List all Reports
The legacy Report object
Create a Transactions Report
Create a Wallets Report
View a Report
List all Reports
The Client object
Update a Client
Upload a Client logo
View a Client

Contact sales Dashboard

On this page

Description
Attributes

Platform account Client

The Client object

Description

The Client object represents your platform. There is one client object per ClientId.

Attributes

Was this page helpful?

List all Reports

Update a Client