API Reference
The Immersve API has endpoints, which your application calls to manage accounts, cards and funding, and webhook topics, which Immersve sends to your webhook listener when something changes.
Endpoints
The requests your application sends to the Immersve API.
Browse all 83 endpoints in 22 tags →Quickstart Endpoints
- getGet Supported Regions
/api/ accounts/ {partnerAccountId}/ supported-regions - postInitiate Login(Non-custodial integrator)
/auth/ login-init - postCreate Account(Custodial integrator)
/api/ accounts - putSubmit KYC Statement(Custodial integrator)
/api/ accounts/ {cardholderAccountId}/ partner-kyc-statement - postCreate Funding Source
/api/ funding-sources - postGet Spending Prerequisites
/api/ spending-prerequisites - getList Cards
/api/ accounts/ {accountId}/ cards - postCreate Card
/api/ cards - postSet Card PIN
/api/ cards/ {cardId}/ set-pin - getList Transactions
/api/ accounts/ {accountId}/ transactions - getGet Cardholder Blocks
/api/ accounts/ {cardholderAccountId}/ blocks
Quickstart Webhook Topics
- KYC SucceededTriggered when a cardholder's associated KYC Profile status is verified and a passed result occurs.
- KYC FailedTriggered when a cardholder's associated KYC Profile status is verified and a failed result occurs.
- KYC PendingTriggered when a cardholder submits KYC information for review.
- Card ShippedTriggered when a card is shipped to a cardholder.
- Card ActivatedTriggered when a card is activated for a cardholder.
- Card Block CreatedTriggered when a card is blocked/frozen.
- Cardholder Block CreatedTriggered when a cardholder block is created.
- Payment UpdatedTriggered when a payment is updated throughout its lifecycle.
- Payment 3DS OTPTriggered when a one-time password (OTP) is generated to authenticate cardholders during a 3D Secure (3DS) transaction. Subscribers should use this event to deliver the OTP to the cardholder in their preferred channel.
- Payment 3DS SCATriggered when a 3D Secure (3DS) Strong Customer Authentication (SCA) challenge is initiated for a card transaction. Subscribers should use this event to present the cardholder with a challenge to authenticate or decline the transaction.
- XPay Card Load OTPTriggered when a one-time password (OTP) is generated as part of the security challenge for provisioning an XPay card to a digital wallet (Apple Pay, Google Pay or similar). The challenge applies to both manual and in-app push provisioning and is presented dynamically based on card load risk scoring. Subscribers should use this event to deliver the OTP to the cardholder in their preferred channel.