# Kobble ## Docs - [Introduction](https://docs.apikobble.net/doc-666753.md): - API Fundamentals [Idempotency](https://docs.apikobble.net/doc-1820627.md): - API Fundamentals [Rate Limits](https://docs.apikobble.net/doc-1820637.md): - Authorization [Authorization](https://docs.apikobble.net/doc-768364.md): - Cards [Cards API](https://docs.apikobble.net/doc-768966.md): - Cards [Card Creation Flow — Developer Guide & Onboarding](https://docs.apikobble.net/doc-1946732.md): - Card Programs [Card Programs API](https://docs.apikobble.net/doc-769892.md): - Clients [Clients API](https://docs.apikobble.net/doc-771670.md): - Endusers [Endusers API](https://docs.apikobble.net/doc-769893.md): - Endusers [Usage of Metadata on Endusers](https://docs.apikobble.net/doc-1949255.md): - Transactions [Transactions API](https://docs.apikobble.net/doc-769894.md): - Wallets [Wallets API](https://docs.apikobble.net/doc-769895.md): - Relays [Relays API](https://docs.apikobble.net/doc-771683.md): - Webhooks [Webhooks API](https://docs.apikobble.net/doc-806843.md): - Webhooks [Webhook Signature Verification](https://docs.apikobble.net/doc-1798440.md): ## API Docs - API Fundamentals [Healthcheck](https://docs.apikobble.net/api-25228778.md): The Kobble API provides a health check endpoint at `GET /customers/v1/health` for monitoring system availability. Use this endpoint for availability monitoring instead of querying business endpoints. - Authorization [Get access token](https://docs.apikobble.net/api-12229608.md): Generate Access token for all other Kobble APIs - Authorization [Get access token](https://docs.apikobble.net/api-28190654.md): Generate Access token for all other Kobble APIs - Beneficiaries [List all beneficiaries](https://docs.apikobble.net/api-14139501.md): - Beneficiaries [Get beneficiary by ID](https://docs.apikobble.net/api-14295197.md): - Beneficiaries [Create beneficiary](https://docs.apikobble.net/api-14139509.md): The standard beneficiary creation endpoint. You must provide either person OR company details, but not both. - Beneficiaries [Update beneficiary](https://docs.apikobble.net/api-14284227.md): - Beneficiaries [Create Payid beneficiary](https://docs.apikobble.net/api-27000652.md): The payid beneficiary creation endpoint. You must provide either person OR company details, but not both. - Cards [Get all cards](https://docs.apikobble.net/api-10192216.md): Retrieve a list of all cards. - Cards [Create a new card](https://docs.apikobble.net/api-10192217.md): Create a new card with the specified wallet and program. - Cards [Get card by ID](https://docs.apikobble.net/api-10192218.md): Retrieve a card's details by its unique identifier. - Cards [Update card status](https://docs.apikobble.net/api-10192219.md): Update the status of a specific card (e.g., ACTIVE, SUSPENDED, STOLEN). - Cards [Replace or renew card](https://docs.apikobble.net/api-10192220.md): Renew or replace an existing card based on the action provided (replace or renew). - Cards [Generate card secret](https://docs.apikobble.net/api-12255079.md): To generate timebased secret for a card id - Cards [Generate MeaWallet widget session token](https://docs.apikobble.net/api-28190658.md): Returns a short-lived TOTP and widget URL for embedding the MeaWallet EasyLaunch iframe to display card details (PAN, CVV, expiry) securely. Requires authentication, valid card ownership, and an idempotency key. Use the response to build the iframe URL: `{widgetUrl}?cardId={cardId}&totp={totp}`. - Card Programs [Get all programs](https://docs.apikobble.net/api-10192221.md): Retrieve a list of all card programs. - Card Programs [Create a new program](https://docs.apikobble.net/api-10192222.md): Create a new card program. - Card Programs [Get program by ID](https://docs.apikobble.net/api-10192223.md): Retrieve a program's details by its unique identifier, including its card artworks. - Clients [Get all clients](https://docs.apikobble.net/api-12280696.md): Retrieve all clients - Clients [Get client by ID](https://docs.apikobble.net/api-12280699.md): - Clients [Create a new client](https://docs.apikobble.net/api-12280791.md): Create a client - Clients [Update client status](https://docs.apikobble.net/api-12280879.md): To update client status (ACTIVE, or INACTIVE) - Endusers [Get all endusers](https://docs.apikobble.net/api-10192224.md): Fetch a list of all endusers, along with their associated person or company entity and metadata information. - Endusers [Create a new enduser](https://docs.apikobble.net/api-10192225.md): Create a new enduser to with person or company entity and metadata. - Endusers [Get enduser by ID](https://docs.apikobble.net/api-10192226.md): Fetch detailed information for a specific enduser by their unique ID, including person or company-entity and metadata. - Endusers [Update enduser](https://docs.apikobble.net/api-32806880.md): Update mutable fields of an existing enduser. Only the provided fields will be updated. Supports updating person details (first_name, last_name, phone_number, birthday), company details (name), and metadata. - Transactions [Get all transactions](https://docs.apikobble.net/api-10192227.md): Retrieve a list of transactions, optionally filtered by wallet ID, date range, and other parameters. - Transactions [Create a transaction](https://docs.apikobble.net/api-10192228.md): Create a new transaction with the provided details. - Transactions [Get transaction by ID](https://docs.apikobble.net/api-10192229.md): Retrieve details of a specific transaction by its ID. - Transactions [Create manual credit transaction](https://docs.apikobble.net/api-10192230.md): Manually create a credit transaction with the specified details. - Transactions [Create manual debit transaction](https://docs.apikobble.net/api-10192231.md): Manually create a debit transaction with the specified details. - Wallets [Get all wallets](https://docs.apikobble.net/api-10192232.md): Retrieve a list of all wallets. - Wallets [Create a new wallet](https://docs.apikobble.net/api-10192233.md): Create a new wallet with the specified attributes. - Wallets [Get wallet by ID](https://docs.apikobble.net/api-10192234.md): Retrieve the details of a wallet by its unique ID. - Wallets [Update wallet](https://docs.apikobble.net/api-10192235.md): Update the status of a wallet by its ID. - Relays [Create subscription](https://docs.apikobble.net/api-12287941.md): To create relay subscription by passing a client url - Webhooks [Get all webhooks](https://docs.apikobble.net/api-13129041.md): - Webhooks [Create a webhook](https://docs.apikobble.net/api-13129088.md): - Webhooks [Delete a webhook](https://docs.apikobble.net/api-13129096.md): - Webhooks [Report completed](https://docs.apikobble.net/api-39806959.md): Sent to your subscribed webhook URL when a report you requested has finished generating. The payload is a notification only — fetch the report content from the relevant API endpoint. Respond with a 2xx status to acknowledge receipt. - Wallet Statements [Request a wallet statement](https://docs.apikobble.net/api-38047817.md): Request generation of a monthly wallet statement (CSV). The period must be a completed calendar month. Generation is asynchronous and idempotent per wallet and period; the returned job can be polled until it is COMPLETED. - Wallet Statements [List wallet statements](https://docs.apikobble.net/api-38047818.md): List wallet statement jobs for the authenticated client, optionally filtered by wallet. - Wallet Statements [Get a wallet statement](https://docs.apikobble.net/api-38047819.md): Retrieve a single wallet statement job by id. - Wallet Statements [Get a wallet statement download URL](https://docs.apikobble.net/api-38047820.md): Generate a time-limited presigned URL to download the statement in CSV (default) or PDF, chosen via the `format` query parameter. The statement must be in COMPLETED status. The PDF is generated on a best-effort basis; if a PDF is not available for the statement the request is rejected, so fall back to CSV. - Card Art [Get a card art upload URL](https://docs.apikobble.net/api-39806960.md): Request a presigned URL to upload a card art asset for the program. Requires the `administrator/write` scope. - Card Art [Register a card art](https://docs.apikobble.net/api-39806961.md): Register a previously uploaded card art asset (created in DRAFT status). Requires the `administrator/write` scope. - Card Art [List card arts](https://docs.apikobble.net/api-39806962.md): List all card arts registered for the program. Requires the `client/read`, `client/write`, `administrator/read` or `administrator/write` scope. - Card Art [Get a card art](https://docs.apikobble.net/api-39806963.md): Retrieve a single card art, including its CDN URL. Requires the `client/read`, `client/write`, `administrator/read` or `administrator/write` scope. - Card Art [Update a card art](https://docs.apikobble.net/api-39806964.md): Update the name or metadata of a card art. Requires the `administrator/write` scope. - Card Art [Activate a card art](https://docs.apikobble.net/api-39806965.md): Activate a DRAFT card art. Only one card art may be ACTIVE per program and type; activating fails with 409 if another of the same type is already active. Requires the `administrator/write` scope. - Card Art [Archive a card art](https://docs.apikobble.net/api-39806966.md): Archive an ACTIVE card art. Requires the `administrator/write` scope. ## Schemas - [CardWidgetSessionTokenResponse](https://docs.apikobble.net/schema-12953218.md): - [202 Accepted](https://docs.apikobble.net/schema-12953219.md): - [Webhook](https://docs.apikobble.net/schema-4804802.md): - [201 Created](https://docs.apikobble.net/schema-12953220.md): - [Relay](https://docs.apikobble.net/schema-4806523.md): - [Create Beneficiary with bank details](https://docs.apikobble.net/schema-12953221.md): - [Client](https://docs.apikobble.net/schema-4807488.md): - [Beneficiary](https://docs.apikobble.net/schema-5419976.md): - [Card](https://docs.apikobble.net/schema-3340758.md): - [CardCreateInputDto](https://docs.apikobble.net/schema-3340759.md): - [CardStatusUpdateDto](https://docs.apikobble.net/schema-3340760.md): - [CardRenewReplaceInputDto](https://docs.apikobble.net/schema-3340761.md): - [Program](https://docs.apikobble.net/schema-3340762.md): - [MetadataKobbleDebit1](https://docs.apikobble.net/schema-3340763.md): - [ProgramCreateInputDto](https://docs.apikobble.net/schema-3340764.md): - [Person](https://docs.apikobble.net/schema-3340765.md): - [Company](https://docs.apikobble.net/schema-3340766.md): - [Enduser](https://docs.apikobble.net/schema-3340767.md): - [EnduserCreatePersonInput](https://docs.apikobble.net/schema-3340768.md): - [EnduserCreateCompanyInput](https://docs.apikobble.net/schema-3340769.md): - [Metadata](https://docs.apikobble.net/schema-3340770.md): - [EnduserCreateInputDto](https://docs.apikobble.net/schema-3340771.md): - [Transaction](https://docs.apikobble.net/schema-3340772.md): - [TransactionCreateManualCreditInputDto](https://docs.apikobble.net/schema-3340773.md): - [TransactionCreateInputDto](https://docs.apikobble.net/schema-3340774.md): - [Wallet](https://docs.apikobble.net/schema-3340775.md): - [WalletCreateInputDto](https://docs.apikobble.net/schema-3340776.md): - [WalletUpdateInputDto](https://docs.apikobble.net/schema-3340777.md): - [WalletStatement](https://docs.apikobble.net/schema-15823745.md): - [WebhookNotification](https://docs.apikobble.net/schema-16354261.md): - [ReportCompletedEntity](https://docs.apikobble.net/schema-16354262.md): - [ReportCompletedNotification](https://docs.apikobble.net/schema-16354263.md): - [CardArt](https://docs.apikobble.net/schema-16354264.md): - [CardArtDetail](https://docs.apikobble.net/schema-16354265.md): - [CardArtUploadUrlInput](https://docs.apikobble.net/schema-16354266.md): - [CardArtUploadUrlResponse](https://docs.apikobble.net/schema-16354267.md): - [CardArtCreateInput](https://docs.apikobble.net/schema-16354268.md): - [CardArtPatchInput](https://docs.apikobble.net/schema-16354269.md):