Paycose

Wallet API Reference, enriched with practical guides.

Read the guides Browse the API

For End Users

Overview

What PaymentGateway is, what it can do, and who it's for.

Glossary

Plain-language definitions of the core PaymentGateway terms.

For Merchant Developers

Quick guide

Create an account, get your service-account keys, and make your first authenticated PaymentGateway API request.

Authentication

How to authenticate to the PaymentGateway API — secret keys, OAuth bearer tokens, test/live mode, and required headers.

Core concepts

The resource model, identifiers, livemode, pagination, idempotency, expand, and multi-tenancy basics every integrator should know.

Errors

The PaymentGateway error envelope, error-code ranges, and the live error catalog.

Expand

expand[] objects on retrieve and list responses.

Provider capability matrix

What each payment provider supports across the unified API — capture, refunds, disputes, settlement, and billing mode.

Webhook events by provider

Which webhook events each provider emits, which ones drive your payment state, and provider-specific caveats — starting with Stripe and Omise.

Charge events

What data you get for charge.created, charge.paid, charge.captured, charge.canceled, charge.expired, charge.refunded, and charge.requires_action.

Charge dispute events

What data you get for charge.dispute.created, .updated, .closed, .funds_withdrawn, and .funds_reinstated.

Checkout session events

What data you get for checkout.session.completed and checkout.session.expired.

Payment intent events

What data you get for payment_intent.canceled.

Payment link events

What data you get for payment_link.expired.

Refund events

What data you get for refund.created, refund.updated, and refund.failed.

Payout events

What data you get for payout.created, payout.pending, payout.sent, payout.canceled, and payout.failed.

Transfer events

What data you get for transfer.created, transfer.paid, transfer.captured, transfer.canceled, and transfer.reversed.

Bank account events

What data you get for bank_account.created and bank_account.deleted.

Provider credential events

What data you get for provider.credentials_invalid and provider.credentials_restored.

Subscription events

What data you get for subscription.created, .updated, .resumed, .paused, .canceled, and .trial_will_end.

Subscription schedule events

subscription_schedule.* events are reserved for a future feature and not sent yet.

Invoice events

What data you get for invoice.created, .finalized, .finalization_failed, .paid, .payment_failed, .payment_action_required, .overdue, .updated, .uncollectible, .void, and .creditnote.updated.

Billing portal events

What data you get for billing_portal.configuration.created, .configuration.updated, and .session.created.

Credit note events

What data you get for credit_note.created, credit_note.updated, and credit_note.canceled.

Customer events

What data you get for customer.created, .updated, .deleted, and customer.tax_id.created/.updated/.deleted.

Payment method events

What data you get for payment_method.created, payment_method.updated, and payment_method.deleted.

Product events

What data you get for product.created, product.updated, and product.deleted.

Price events

What data you get for price.created, price.updated, and price.deleted.

Coupon events

What data you get for coupon.created, coupon.updated, and coupon.deleted.

Promotion code events

What data you get for promotion_code.created, .updated, and .deleted.

Discount events

discount.applied and discount.removed are reserved and not sent yet.

Shipping rate events

What data you get for shipping_rate.created, .updated, and .deleted.

Tax rate events

tax_rate.created and tax_rate.updated carry no tax rate data.

Quote events

What data you get for quote.created, quote.finalized, quote.accepted, and quote.canceled.

Checkout SDK

Embeddable checkout for React, Vue, Svelte, SvelteKit, Nuxt, Solid, Angular, Next.js, jQuery and vanilla JS — card entry stays inside a cross-origin iframe.