Home
API Reference
Endpoints
Accounts
post
Create Account
get
Get Account
post
Resolve Login Identities
Authentication
post
Complete Login
post
Complete SIWE Login
post
Create Challenge
post
Exchange Auth Token
post
Initiate Login
post
Initiate SIWE Login
post
Logout
post
Sign Up
Card Inquiries
get
Get Card Inquiry
get
List Card Inquiries
Card Tokens
post
Approve Card Token
get
Get Card Token
get
List Card Tokens
Cardholder Blocks
get
Get Cardholder Blocks
Cards
post
Activate Card
post
Cancel Card
post
Create Card
post
Freeze Card
post
Generate Card Secure Details Code
get
Get Card
get
List Cards
post
Provision Card to Apple Pay
post
Reissue Card
post
Set Card Funding Sources
post
Set Card PIN
post
Unfreeze Card
Client Applications
get
Get Client Application
get
List Client Applications
post
Update Allowed Origins
Contact Details
get
Get Contact Details
patch
Update Contact Details
Currency
get
Get Currency Conversion
get
List Currencies
Fault Injection
delete
Delete Fault Config
get
List Fault Configs
get
List Fault Types
put
Set Fault Config
File Uploads
get
Get File Upload
post
Upload File
Funding Channels
post
Create Funding Channel
get
Get Funding Channel
get
List Funding Channels
Funding Sources
post
Create Funding Source
post
Create Withdrawal Intent
get
Get Funding Source
get
List Funding Source Interactions
get
List Funding Sources
KYC
get
Get Expected Spend Amount
get
Get KYC Profile
get
Get KYC Statement
get
Get Residential Addresses
put
Submit KYC Statement
post
Submit Residential Addresses
post
Update Expected Spend Amount
Partner Profiles
post
Configure Partner Profile
get
Get Partner Profile
Payments
get
Get Payment Notification
get
Get Transaction
get
List Payment Notifications
get
List Transactions
post
Submit 3DS Challenge Outcome
Prerequisites
post
Get Spending Prerequisites
Regions
get
Get Supported Regions
Reports
post
Create Report Download URL
get
Get Report
get
List Reports
Simulator
post
Execute Simulator Deposit
post
Execute Simulator Withdrawal
post
Submit Simulator Authorization
post
Submit Simulator Clearing
post
Submit Simulator Reversal
Support
post
Create Support Session
Webhooks
post
Add Webhook Topic Subscription
post
Create Webhook Listener
delete
Delete Webhook Listener
get
Get Webhook Listener
get
List Webhook Listeners
get
List Webhook Notifications
post
Remove Webhook Topic Subscription
post
Send Webhook Test Notification
Webhook Topics
Card Inquiries
Card Inquiry Updated
Card Tokens
Card Token Updated
Cardholders
Cardholder Block Created
Cardholder Block Released
Cards
Card Activated
Card Block Created
Card Block Released
Card Canceled
Card Created
Card Expiry Upcoming
Card Reissue Failed
Card Reissue Succeeded
Card Shipped
Card Tracking Updated
KYC
KYC Failed
KYC Pending
KYC Succeeded
Payments
Payment 3DS OTP
Payment 3DS SCA
Payment Updated
Reports
Report Completed
Test Webhooks
Asynchronous Test
Transactional Test
XPay
XPay Card Load Confirmed
XPay Card Load OTP
Immersve Docs
Guides
APIs
Support
Search
/
Cancel
Github
X
Home
API Reference
Endpoints
Accounts
post
Create Account
get
Get Account
post
Resolve Login Identities
Authentication
post
Complete Login
post
Complete SIWE Login
post
Create Challenge
post
Exchange Auth Token
post
Initiate Login
post
Initiate SIWE Login
post
Logout
post
Sign Up
Card Inquiries
get
Get Card Inquiry
get
List Card Inquiries
Card Tokens
post
Approve Card Token
get
Get Card Token
get
List Card Tokens
Cardholder Blocks
get
Get Cardholder Blocks
Cards
post
Activate Card
post
Cancel Card
post
Create Card
post
Freeze Card
post
Generate Card Secure Details Code
get
Get Card
get
List Cards
post
Provision Card to Apple Pay
post
Reissue Card
post
Set Card Funding Sources
post
Set Card PIN
post
Unfreeze Card
Client Applications
get
Get Client Application
get
List Client Applications
post
Update Allowed Origins
Contact Details
get
Get Contact Details
patch
Update Contact Details
Currency
get
Get Currency Conversion
get
List Currencies
Fault Injection
delete
Delete Fault Config
get
List Fault Configs
get
List Fault Types
put
Set Fault Config
File Uploads
get
Get File Upload
post
Upload File
Funding Channels
post
Create Funding Channel
get
Get Funding Channel
get
List Funding Channels
Funding Sources
post
Create Funding Source
post
Create Withdrawal Intent
get
Get Funding Source
get
List Funding Source Interactions
get
List Funding Sources
KYC
get
Get Expected Spend Amount
get
Get KYC Profile
get
Get KYC Statement
get
Get Residential Addresses
put
Submit KYC Statement
post
Submit Residential Addresses
post
Update Expected Spend Amount
Partner Profiles
post
Configure Partner Profile
get
Get Partner Profile
Payments
get
Get Payment Notification
get
Get Transaction
get
List Payment Notifications
get
List Transactions
post
Submit 3DS Challenge Outcome
Prerequisites
post
Get Spending Prerequisites
Regions
get
Get Supported Regions
Reports
post
Create Report Download URL
get
Get Report
get
List Reports
Simulator
post
Execute Simulator Deposit
post
Execute Simulator Withdrawal
post
Submit Simulator Authorization
post
Submit Simulator Clearing
post
Submit Simulator Reversal
Support
post
Create Support Session
Webhooks
post
Add Webhook Topic Subscription
post
Create Webhook Listener
delete
Delete Webhook Listener
get
Get Webhook Listener
get
List Webhook Listeners
get
List Webhook Notifications
post
Remove Webhook Topic Subscription
post
Send Webhook Test Notification
Webhook Topics
Card Inquiries
Card Inquiry Updated
Card Tokens
Card Token Updated
Cardholders
Cardholder Block Created
Cardholder Block Released
Cards
Card Activated
Card Block Created
Card Block Released
Card Canceled
Card Created
Card Expiry Upcoming
Card Reissue Failed
Card Reissue Succeeded
Card Shipped
Card Tracking Updated
KYC
KYC Failed
KYC Pending
KYC Succeeded
Payments
Payment 3DS OTP
Payment 3DS SCA
Payment Updated
Reports
Report Completed
Test Webhooks
Asynchronous Test
Transactional Test
XPay
XPay Card Load Confirmed
XPay Card Load OTP
API
›
Endpoints
Card Tokens
get
List Card Tokens
/
api/
cards/
{cardId}/
tokens
get
Get Card Token
/
api/
card-tokens/
{cardTokenId}
post
Approve Card Token
/
api/
card-tokens/
{cardTokenId}/
approve