Payca beta API — all operations

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/offramp-deposit Offramp deposit (master credit + transfer)
• GET /v1/accounts/{id}/transactions Retrieve Account Transactions
• GET /v2/accounts Retrieve Accounts with Enabled BINs
• 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
• 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

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

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}/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

Wallets

Wallet pool management for crypto deposits (offramp).

• POST /v1/wallets/allocate Allocate a wallet for deposit
• POST /v1/wallets/deposit Confirm a deposit
• POST /v1/wallets/maintenance/release-expired Release expired wallet allocations
• POST /v1/wallets/release Release an allocated wallet
• GET /v1/wallets/stats Get wallet pool statistics
• GET /v1/wallets/{address}/balance Get wallet information

GasStation

Gas station operations for fund collection (admin).

• GET /v1/gas-station/config/{chain} Get chain configuration
• PUT /v1/gas-station/config/{chain} Update chain configuration
• POST /v1/gas-station/generate Generate new wallets
• GET /v1/gas-station/operations List pending operations
• POST /v1/gas-station/operations Create a sweep operation
• GET /v1/gas-station/operations/history List all operations
• GET /v1/gas-station/operations/{id} Get operation details
• POST /v1/gas-station/operations/{id}/confirm Confirm sweep operation
• GET /v1/gas-station/operations/{id}/export Export sweep data for manual execution
• POST /v1/gas-station/operations/{id}/fail Mark operation as failed
• GET /v1/gas-station/station-topups List station topup records
• POST /v1/gas-station/station-topups/scan Scan for station topups
• GET /v1/gas-station/status/{chain} Get gas station status
• GET /v1/gas-station/sweep-candidates List wallets eligible for sweeping
• GET /v1/gas-station/sweep-preflight/{walletId} Preflight check for sweep
• GET /v1/gas-station/topup-candidates List wallets needing gas refill
• POST /v1/gas-station/topup-operations Create gas topup operation
• POST /v1/gas-station/topup-operations/{id}/confirm Confirm gas topup operation
• GET /v1/gas-station/topup-operations/{id}/export Export gas topup data for manual execution
• POST /v1/gas-station/topup-operations/{id}/fail Fail gas topup operation
• PUT /v1/gas-station/wallet Set gas station wallet
• POST /v1/gas-station/wallet/generate Generate gas station wallet
• GET /v1/gas-station/wallets List all wallets in the pool

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

Networks

• GET /v1/networks List all network configurations
• GET /v1/networks/{chain} Get network configuration for a chain
• PUT /v1/networks/{chain} Update network configuration

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

WalletPool

• PUT /v1/wallets/{address}/gas-balance Update wallet gas balance