Jump to Content
Guides
API Reference
Changelog
FAQ
Country Coverage
v3
➦ Back to Tazapay
Log In
API Reference
➦ Back to Tazapay
Log In
v3
Guides
API Reference
Changelog
FAQ
Country Coverage
Ready event
All
Pages
Start typing to search…
JUMP TO
API Overview
Introduction
Endpoints and Environments
Authentication
Webhooks
Idempotent Requests
Tazapay MCP Server
Errors
Error Codes
Error Codes by Core Resource
Checkout
Escrow
Customers
Refunds
Metadata
Document
Payment Attempts
Payout
Entity
Balance Transaction
Error Code by Payment Methods
Tazapay API
Collect
Fetch Collect
get
Collect Webhooks
Payout
Create Payout
post
Fetch payout
get
Funding a Payout
post
Payout Quote
post
Confirm Payout
post
Simulating Payouts on Test Environment (Sandbox)
Payout Webhooks
Payin
Create Payin
post
Confirm Payin
post
Update Payin
put
Cancel Payin
post
Fetch Payin
get
Payin Webhooks
Checkout
Create Checkout Session
Update Checkout
put
Fetch Checkout
get
Expire Checkout
post
Checkout Webhooks
Customers
Create Customer
post
Update Customer
put
Add Billing/Shipping
post
Fetch Customer Details
get
Refund
Initiate Refund
post
Update Refund
put
Fetch Refund
Cancel Refund
post
Refund Webhooks
Metadata
Collection Methods
get
Collection Methods Fields
Fetch External Account Details
Fetch Exchange Rates
get
Payout Bank
get
Document
Upload Document to Tazapay
get
Add Document to a Resource
post
Payment Attempts
Fetch Payment Attempt
get
Update Payment Attempt
put
Beneficiary
Create Beneficiary
Fetch Beneficiary
Update Beneficiary
put
Beneficiary Webhooks
Collection Account
Collection Account Webhooks
Balance
Fetch Balance
Balance Transaction
Fetch Balance Transaction
get
List Balance Transactions
get
Entity
Create Entity
post
Submit Entity
post
Fetch Entity
get
Update Entity
put
List entity
get
Entity Webhooks
Settlements
Fetch Payins
get
Fetch Refunds
get
Fetch Collects
get
Fetch Adjustments
get
Fetch Payouts
get
Settlement Webhooks
Quote
Create a quote
Fetch Quote
get
⚡
Lightning Invoice
Create a lightning invoice
post
Fetch a lightning invoice
Update a lightning invoice
put
Common Object Schemas
FX Transaction Object
Phone Object
Address Object
JAVASCRIPT SDK
SDK Overview
How the SDK Works
Specifying Payment Methods
Managing Exchange Rates (FX)
Integrating into your Project
Integrating Client-Side
Developer Recomendations
Integrating only for cards
Flow
List to card embed events
Change event
Ready event
Focus event
Blur event
Escape event
Card Embed Methods
cardEmbed.lock()
cardEmbed.unlock()
Style Customisation
Container Styles
Button Styles
Input Styles
Element Styles
Modal Styles
Version history
Integrate with risk SDK
APPENDIX
Simulating Payments
Test Cards
Alternate Payment Methods
Payout Failure Reasons
Payout Reversal Reasons
Ready event
Ask AI
