API Operations - PayCA API Reference

Health

Service liveness/health probe.

GET /health Health check

Accounts

Operations for listing accounts and their balances.

GET /v1/accounts Retrieve Accounts
POST /v1/accounts/admin-deposit Admin deposit (correction credit to an account)
POST /v1/accounts/admin-withdrawal Admin withdrawal (write-off from an account)
POST /v1/accounts/offramp-deposit Offramp deposit (master credit + transfer)
GET /v1/accounts/{id}/transactions Retrieve Account Transactions
GET /v1/client/settings What the calling client's accounts can do
GET /v2/accounts Retrieve Accounts with Enabled BINs
GET /v2/accounts/{accountId}/balance Retrieve an account balance
POST /v2/accounts/{accountId}/exchange-quote Price an exchange between two accounts
POST /v2/accounts/{accountId}/exchanges Exchange between two accounts
POST /v2/accounts/{id}/topup/card Top up an account using an external payment card
GET /v2/accounts/{id}/topup/{txId} Retrieve account card top-up status
POST /v2/accounts/{id}/withdraw/card Withdraw funds from an account to an external payment card
GET /v2/accounts/{id}/withdraw/{txId} Retrieve account card withdrawal status

Cards

Issue, manage, and retrieve cards and details.

GET /v1/cards List Cards
POST /v1/cards Issue a New Card
GET /v1/cards/{id} Retrieve Card by ID
DELETE /v1/cards/{id} Close Card
GET /v1/cards/{id}/decline-rate Card Decline Rate
POST /v1/cards/{id}/freeze Freeze Card
GET /v1/cards/{id}/sensitive Get card sensitive info
POST /v1/cards/{id}/tokenize Start Card Tokenization
POST /v1/cards/{id}/topup Top Up Card
GET /v1/cards/{id}/transactions Retrieve Card Transactions
POST /v1/cards/{id}/unfreeze Unfreeze Card
POST /v1/cards/{id}/withdraw Withdraw from Card
GET /v2/accounts/{id}/transactions Read versioned mixed account history
POST /v2/cards Accept a buffered card issuance quote
GET /v2/cards/issue/capability Read selected client, source and programme admission
POST /v2/cards/issue/quote Quote explicit buffered issuance
GET /v2/cards/operations/{operation_id} Read an accepted operation and its exact financial result
GET /v2/cards/{id} Read card balance separately from its buffer
DELETE /v2/cards/{id} Request provider-confirmed closure
POST /v2/cards/{id}/freeze Freeze with a manual or insufficient-funds reason while preserving buffer and other blocks
POST /v2/cards/{id}/topup Accept a buffered card funding quote
POST /v2/cards/{id}/topup/quote Quote card-directed funding with at most fifty percent allocation
GET /v2/cards/{id}/transactions Read versioned mixed card history
POST /v2/cards/{id}/unfreeze Remove the manual or insufficient-funds freeze reason
POST /v2/cards/{id}/withdraw Withdraw card principal without accessing the buffer

Transactions

Retrieve transactions and related activity.

GET /v1/cards/transactions/{id} Retrieve Transaction

Deposits

Provider-independent account deposits (top-ups from outside Payca).

The funding provider is an internal routing decision and never appears in the API. Statuses are normalised: a deposit reads as completed only once settlement was confirmed AND the balance credit was recorded, so a browser returning from a checkout page never means funds are available.

Integrations discover an available route, quote it, create an idempotent deposit order, redirect the payer to hosted checkout, and then use deposit status and webhooks to reconcile the final outcome.

POST /v2/accounts/{accountId}/deposit-quote Quote a deposit
GET /v2/accounts/{accountId}/deposits List deposits for an account
POST /v2/accounts/{accountId}/deposits Create a deposit
GET /v2/accounts/{accountId}/deposits/{depositId} Retrieve a deposit
GET /v2/accounts/{accountId}/funding-options List funding options for an account

Webhooks

Configure and manage webhooks.

GET /v1/webhooks List Webhooks
POST /v1/webhooks Set Webhook URL
DELETE /v1/webhooks Delete Webhook
POST /v1/webhooks/resend Resend Webhooks

Sandbox

Endpoints for sandbox/testing flows.

POST /sandbox/transactions Create sandbox transaction

Bins

Deprecated endpoints to retrieve BINs and fees.

GET /v1/bins List the BIN catalog
GET /v1/bins/{bin}/capacity Get per-cardholder issuance capacity on a BIN
GET /v1/bins/{bin}/cardholder-registration Can a new cardholder be registered on this BIN right now

Users

User management: create, update, and retrieve users and their accounts.

GET /v1/users List Users
POST /v1/users Create User
POST /v1/users/transfer Transfer between Payca accounts
GET /v1/users/{id} Get User by ID
GET /v1/users/{id}/account/transactions List User Account Transactions
POST /v1/users/{id}/accounts Open a user account in another currency
POST /v1/users/{id}/bins Upsert User BIN
GET /v1/users/{id}/card/transactions List User Card Transactions
GET /v1/users/{id}/cardholder Get User Cardholder
POST /v1/users/{id}/cardholder Create User Cardholder
PATCH /v1/users/{id}/status Update User Status

Cardholders

Cardholder management: list, get, create cardholders. Reference data for registration (cities, occupations, regions) and file upload.

GET /v1/cardholders List Client Cardholders
GET /v1/cardholders/cities List Cardholder Cities
POST /v1/cardholders/files Upload Cardholder File
GET /v1/cardholders/occupations List Cardholder Occupations
GET /v1/cardholders/regions List Cardholder Regions
GET /v1/cardholders/{id} Get Cardholder
PATCH /v1/cardholders/{id} Update Cardholder Data
POST /v1/cardholders/{id}/photos Upload Cardholder Photos
POST /v1/cardholders/{id}/retry Retry Submission of a Failed Cardholder
POST /v1/cardholders/{id}/submit Submit Cardholder to Provider

KYC

KYC verification for B2C card issuance. Upload identity documents and selfie, submit for admin review, track status via webhooks.

GET /v1/users/{id}/kyc Get User KYC Status
GET /v1/users/{id}/kyc/documents List KYC Documents
POST /v1/users/{id}/kyc/documents Upload KYC Document
GET /v1/users/{id}/kyc/documents/{docId} Get KYC Document
DELETE /v1/users/{id}/kyc/documents/{docId} Delete KYC Document
GET /v1/users/{id}/kyc/documents/{docId}/content Download KYC Document Content
PATCH /v1/users/{id}/kyc/documents/{docId}/status Update KYC Document Status (Admin)
PATCH /v1/users/{id}/kyc/notes Update User KYC Notes (Admin)
PATCH /v1/users/{id}/kyc/status Update User KYC Status (Admin)
POST /v1/users/{id}/kyc/submit Submit KYC for Review

Exchange

Exchange operations (rates, orders, withdrawals) and settlement balance queries.

POST /v1/exchange/orders Create exchange order
GET /v1/exchange/orders/{orderId} Get exchange order status
GET /v1/exchange/rates Get exchange rates
GET /v1/exchange/settlement/balance Get settlement balance
POST /v1/exchange/settlement/check-increase Check settlement balance increase
GET /v1/exchange/withdrawal-destinations List allowed withdrawal destinations
POST /v1/exchange/withdrawals Create fiat withdrawal
GET /v1/exchange/withdrawals/{withdrawalId} Get withdrawal status

Virtual IBAN

A dedicated EUR IBAN for your company: receive SEPA payments and pay out by SEPA. PayCA opens the IBAN for you after your company verification and sets it up individually; until then every call returns 403 capability_disabled. Fees, including monthly ones, are deducted from the IBAN balance.

Step-by-step flow, statuses and error codes: Virtual IBAN guide.

GET /v1/corporate-banking/{companyId}/account Get virtual IBAN
POST /v1/corporate-banking/{companyId}/payouts Pay out by SEPA
GET /v1/corporate-banking/{companyId}/payouts/{payoutId} Get a payout
POST /v1/corporate-banking/{companyId}/quote Quote a payout
POST /v1/corporate-banking/{companyId}/transfers Move money to your own EUR account

Payouts

GET /v2/accounts/{accountId}/payout-options List payout options for an account
POST /v2/accounts/{accountId}/payout-quote Price a payout without creating it
GET /v2/accounts/{accountId}/payouts List payouts for an account
POST /v2/accounts/{accountId}/payouts Create a payout
GET /v2/accounts/{accountId}/payouts/{payoutId} Retrieve a payout

Payca beta API — all operations