Jump to Content
API Reference
v1.0
Log In
API Reference
Log In
v1.0
API Reference
Retrieve a user
Search
JUMP TO
🏁 QUICK START
Getting started with Kulipa
Basics
Versioning
Authentication
Errors
Idempotency
Pagination
Rate Limiting
Request IDs
Introduction
Users
Wallet
KYC
Cards
Transactions
Webhooks
Webhook Events
B2B (company) cards
3D Secure (3DS)
About users
User
List users
get
Create a new User.
post
Retrieve a user
get
Retrieve a user balance
get
Set the phone number of a user
put
Set the email address of a user
put
Set the address of a user
put
Set the shipping address of a user
put
Card Payments
CardPayment
List all card payments
get
Simulation
Simulate a card authorization
post
Simulate an incremental card authorization
post
Simulate a card authorization clearing
post
Simulate a card authorization reversal
post
Simulate a card refund
post
Simulate a 3DS request
post
About kyc
KYC
Initiate a new KYC Verification for an existing User.
put
List KYC processes
get
Retrieve a KYC Process.
get
Force a KYC Process outcome (testing and sandbox ONLY).
post
About cards
Card
Create a new virtual or physical card
post
List all cards
get
Retrieve a card
get
Activate a card - a card in status `inactive`.
put
Mark as shipped a card - a card in status `inactive` (testing and sandbox ONLY).
put
Freeze a card
put
Unfreeze a card
put
Revoke a card
put
Generate a token to view a card's PIN code
post
Generate a token to view a card's PAN
post
Generate card data which can be sent to Apple Pay for tokenization.
post
Generate card data which can be sent to Google Pay for tokenization.
post
Activate the Apple Pay or Google Pay tokenization for a card after successful authentication.
post
About Wallet
Wallet
List all wallets
get
Create a wallet
post
Retrieve a wallet
get
Verify a wallet
put
Withdraw funds to a wallet (Prepaid program ONLY)
post
List withdrawals from a wallet (Prepaid program ONLY)
get
Introduction to Webhooks
Webhook Subscription
Create a webhook subscription
post
List webhook subscriptions
get
Verify a webhook subscription
post
Retrieve a webhook subscription
get
Update a webhook subscription
put
Delete a webhook subscription
delete
Webhook Event
Webhook public key information
get
Webhook events
post
3DS Card Authentication Decision
3DS
Accept 3DS authentication
post
Reject 3DS authentication
post
About companies
Company
List companies
get
Retrieve a company
get
Powered by
Retrieve a user
get
https://example.com/users/
{id}
Retrieve a User entity via its ID.
Language
JavaScript
Node
Kotlin
Swift
Objective-C
Credentials
Header
Header
