# UTGL Developer Portal

## Docs

- [Add Assets to Account](https://developer.utgl.io/api-reference/accounts/add-assets-to-account.md): This endpoint is used to add one or more assets to an existing account. Assets that already exist in the given account will be ignored.
- [Create Account](https://developer.utgl.io/api-reference/accounts/create-account.md): Create Account
- [Get account credit summary](https://developer.utgl.io/api-reference/accounts/get-account-credit-summary.md): This endpoint is only available for funds accounts associated with fixed limit card accounts.
- [Get Accounts](https://developer.utgl.io/api-reference/accounts/get-accounts.md): Get a collection of Accounts based on provided search criteria.
- [Get Balances](https://developer.utgl.io/api-reference/accounts/get-balances.md): Retrieves the balances of account(s).
- [Remove Assets from Account](https://developer.utgl.io/api-reference/accounts/remove-assets-from-account.md): This endpoint is used to remove one or more assets from an existing account. Assets that do not exist in the given account will be ignored. Asset that have a balance or have transcated will not be removed.
- [Get bank data by Swift code](https://developer.utgl.io/api-reference/bank-info/get-bank-data-by-swift-code.md)
- [Aggregated card accounts balance](https://developer.utgl.io/api-reference/card-accounts/aggregated-card-accounts-balance.md): Get aggregated card accounts balance for all card accounts.
- [Balance Transfer](https://developer.utgl.io/api-reference/card-accounts/balance-transfer.md): Transfer balances between two card accounts. This applies to credit card accounts operating in accountType `prepaid`  only'
- [Create Card Account](https://developer.utgl.io/api-reference/card-accounts/create-card-account.md): Create a card account
- [Get Card Account Transactions](https://developer.utgl.io/api-reference/card-accounts/get-card-account-transactions.md): Get Card Account Transactions
- [Get Card Accounts](https://developer.utgl.io/api-reference/card-accounts/get-card-accounts.md): Get a list of Card Accounts
- [Get client identity information for a card account](https://developer.utgl.io/api-reference/card-accounts/get-client-identity-information-for-a-card-account.md): Retrieve the identity information of a cardholder associated with a specific card account.
- [Simulate client identity approval or rejection](https://developer.utgl.io/api-reference/card-accounts/simulate-client-identity-approval-or-rejection.md): Simulate approving or rejecting a client identity (KYC) for a card account in the Sandbox environment.
- [simulate repay card account](https://developer.utgl.io/api-reference/card-accounts/simulate-repay-card-account.md): Simulate repay card account
- [Top up account](https://developer.utgl.io/api-reference/card-accounts/top-up-account.md): Top up a card account with funds from an account. This applies to Card accounts of accountType `prepaid`  only
- [Update client identity information for a card account](https://developer.utgl.io/api-reference/card-accounts/update-client-identity-information-for-a-card-account.md): Update the identity information of a cardholder associated with a specific card account.
- [Update fixed limit for card accounts](https://developer.utgl.io/api-reference/card-accounts/update-fixed-limit-for-card-accounts.md): This endpoint allows updating the fixed limit for one or multiple card accounts.
- [Withdraw card account balance](https://developer.utgl.io/api-reference/card-accounts/withdraw-card-account-balance.md): Withdraw card account balance from card account to an account. This applies to Card accounts of accountType `prepaid` only
- [Confirm Card Binding](https://developer.utgl.io/api-reference/card-binding/confirm-card-binding.md): **Completes the Card Binding Process**
- [Initiate Card Binding Process](https://developer.utgl.io/api-reference/card-binding/initiate-card-binding-process.md): **Initiates Card Binding.** To initiate the card binding process, send the customer's full **PAN** within the payload. The response will include:   - **`verificationId`**: A unique identifier for this binding attempt.   - **`code`**: The verification code for confirmation. Ensure that the verificati…
- [Get card products inventory](https://developer.utgl.io/api-reference/card-products/get-card-products-inventory.md): Retrieve inventory of card products, optionally filtered by product IDs.
- [Get Whitelisted Card Products](https://developer.utgl.io/api-reference/card-products/get-whitelisted-card-products.md): Get a paginated list of card products that are whitelisted for the authenticated cobrander. This endpoint returns only the card products that the cobrander is authorized to offer to their customers.
- [Simulate a clearing of an authorized transaction](https://developer.utgl.io/api-reference/card-transaction-simulator/simulate-a-clearing-of-an-authorized-transaction.md): Simulate capturing a transaction
- [Simulate a decline transaction](https://developer.utgl.io/api-reference/card-transaction-simulator/simulate-a-decline-transaction.md): Simulate declining a transaction
- [Simulate a full reversal of an authorized transaction](https://developer.utgl.io/api-reference/card-transaction-simulator/simulate-a-full-reversal-of-an-authorized-transaction.md): Simulate full reversal of a transaction
- [Simulate a partial reversal of an authorized transaction](https://developer.utgl.io/api-reference/card-transaction-simulator/simulate-a-partial-reversal-of-an-authorized-transaction.md): Simulate partial reversal of a transaction
- [Simulate a refund transaction](https://developer.utgl.io/api-reference/card-transaction-simulator/simulate-a-refund-transaction.md): Simulate refunding a transaction
- [Simulate Authorization](https://developer.utgl.io/api-reference/card-transaction-simulator/simulate-authorization.md): Simulate a card authorization on a given card
- [Activate Card](https://developer.utgl.io/api-reference/cards/activate-card.md): Activate a card
- [Cancel a card](https://developer.utgl.io/api-reference/cards/cancel-a-card.md): Request card cancellation, if the card is active, it will be deactivated immediately and no further card charges will go through.
- [Change Card PIN](https://developer.utgl.io/api-reference/cards/change-card-pin.md): Change Card ATM PIN for a card. Card ATM pin is used for ATM withdrawals and is effective immediately.
- [Control Spending](https://developer.utgl.io/api-reference/cards/control-spending.md): By setting a value for these fields, the cardholder can ensure that their card spending is limited to a specified amount each day.
- [Get Card Notification Settings](https://developer.utgl.io/api-reference/cards/get-card-notification-settings.md): Retrieves the current notification settings for a card. The settings include the notification method for different types of transactions.
- [Get Card Sensitive Info](https://developer.utgl.io/api-reference/cards/get-card-sensitive-info.md)
- [Get Cards](https://developer.utgl.io/api-reference/cards/get-cards.md): Get Cards
- [Issue Card](https://developer.utgl.io/api-reference/cards/issue-card.md): Issue a card under the respective card account.
- [Lock Card](https://developer.utgl.io/api-reference/cards/lock-card.md): Lock a card. Immediately prevents further transactions. Card can be unlocked immediately using the unlock endpoint.
- [Suspend Card](https://developer.utgl.io/api-reference/cards/suspend-card.md): Suspend a card. Immediately prevents card from further transactions and can only be reactivated by operator using the unsuspend endpoint.
- [Unlock Card](https://developer.utgl.io/api-reference/cards/unlock-card.md): Unlock a locked card. Immediately allows subsequent card transactions upon unlocking.
- [Unsuspend Card](https://developer.utgl.io/api-reference/cards/unsuspend-card.md): Unsuspend a card
- [Update card email address](https://developer.utgl.io/api-reference/cards/update-card-email-address.md): Update the email address for a card.
- [Update Card Notification Settings](https://developer.utgl.io/api-reference/cards/update-card-notification-settings.md): Update the notification settings for different types of transactions. Can enable notifications for one method only: SMS, WhatsApp, or Auto (which means the notification will be sent using available information on a best effort basis) for each type of transaction, or turn off notifications entirely.
- [Update Card Phone Number](https://developer.utgl.io/api-reference/cards/update-card-phone-number.md): Update the phone number for a card.
- [Validate a card with card info.](https://developer.utgl.io/api-reference/cards/validate-a-card-with-card-info.md): Validate a card with it's product id, last 6 digits, expiry date.
- [Execute a trade](https://developer.utgl.io/api-reference/conversions/execute-a-trade.md): Execute a trade that has been previously quoted
- [Get a Quote](https://developer.utgl.io/api-reference/conversions/get-a-quote.md): Convert from one fungible asset to another and settle transactions without ever taking assets out of custody.
- [Get Countries](https://developer.utgl.io/api-reference/countries/get-countries.md): Get a list of Countries
- [Generate Deposit Address](https://developer.utgl.io/api-reference/digital-custody/generate-deposit-address.md): Generates a new blockchain deposit address for an account for a given asset/chain pair. UTGL may reuse addresses on blockchains that support reuse. For example, if you're generated two addresses for depositing USDC and USDC, both on Ethereum, you may see the same Ethereum address returned. This beha…
- [Get Deposit Addresses](https://developer.utgl.io/api-reference/digital-custody/get-deposit-addresses.md): Get a list of deposit addresses
- [Get Supported Blockchains](https://developer.utgl.io/api-reference/digital-custody/get-supported-blockchains.md): Get supported blockchains
- [Get Supported Digital Assets](https://developer.utgl.io/api-reference/digital-custody/get-supported-digital-assets.md): Get supported digital assets and networks
- [Charge Fee](https://developer.utgl.io/api-reference/fees/charge-fee.md): Instantly charge a fee to an account or card account. Fees charged will be reflected in the account balance immediately.
- [Get Fees](https://developer.utgl.io/api-reference/fees/get-fees.md): Retrieves the Fees list.
- [Waive a Fee](https://developer.utgl.io/api-reference/fees/waive-a-fee.md): Waive a charged fee entry. Fees wavied will be reflected in the account balance immediately.
- [Get exchange rates for a given base currency](https://developer.utgl.io/api-reference/get-exchange-rates-for-a-given-base-currency.md)
- [Test connectivity](https://developer.utgl.io/api-reference/health/test-connectivity.md): Test API Connectivity to Access API and retrieve server time
- [Test connectivity](https://developer.utgl.io/api-reference/health/test-connectivity-1.md): Test API Connectivity to Access API and retrieve server time
- [Get Occupations](https://developer.utgl.io/api-reference/occupations/get-occupations.md): Get a list of Occupations
- [Create Payout](https://developer.utgl.io/api-reference/payouts/create-payout.md): Create a payout to an external destination
- [Get Payout Banks by Country](https://developer.utgl.io/api-reference/payouts/get-payout-banks-by-country.md): Retrieve a list of available banks for payout in a specific country.
- [Get Payout Quotation](https://developer.utgl.io/api-reference/payouts/get-payout-quotation.md)
- [Get Payouts](https://developer.utgl.io/api-reference/payouts/get-payouts.md): Retrieve a list of payouts
- [Validate Payout Parameters](https://developer.utgl.io/api-reference/payouts/validate-payout-parameters.md): Validate payout parameters and destination before processing a payout request.
- [Get Positions](https://developer.utgl.io/api-reference/positions/get-positions.md): Get a list of Positions
- [Authorize Purchase Transaction](https://developer.utgl.io/api-reference/transactions/authorize-purchase-transaction.md): **Authorizes Purchase Transaction.** Provide **`cardId`**, **`amount`**, **`currency`**, **`description`**, and **`otpToken`** within the payload. On success, funds will be held and a **`transactionId`** is returned.
- [Capture Authorized Transaction](https://developer.utgl.io/api-reference/transactions/capture-authorized-transaction.md): **Captures Funds from a Previously Authorized Transaction**
- [Get Account Transactions](https://developer.utgl.io/api-reference/transactions/get-account-transactions.md): Retrieve a collection of account transactions in reverse chronological order.
- [Initiate Transaction](https://developer.utgl.io/api-reference/transactions/initiate-transaction.md): **Initiates a Transaction Verification Process**
- [Refund Captured Transaction](https://developer.utgl.io/api-reference/transactions/refund-captured-transaction.md): **Process a Refund for a Previously Captured Transaction**
- [Release (Void) Authorized Transaction](https://developer.utgl.io/api-reference/transactions/release-void-authorized-transaction.md): **Voids a Locked Transaction.**
- [Create a Transfer](https://developer.utgl.io/api-reference/transfers/create-a-transfer.md): Real-time off-chain funds transfers between two accounts on UTGL Network. The source account available balance must be able to cover the transfer amount.
- [Get Account Transfers](https://developer.utgl.io/api-reference/transfers/get-account-transfers.md): Retrieve a collection of account transfer in reverse chronological order
- [Create Webhook](https://developer.utgl.io/api-reference/webhooks/create-webhook.md): Create a Webhook to receive notifications when an event occurs
- [Get Webhook Stats](https://developer.utgl.io/api-reference/webhooks/get-webhook-stats.md): Retrieve Webhook Stats
- [List Webhooks](https://developer.utgl.io/api-reference/webhooks/list-webhooks.md): List all Webhooks
- [Remove Webhook](https://developer.utgl.io/api-reference/webhooks/remove-webhook.md): Remove a Webhook
- [Resume Suspended Webhook](https://developer.utgl.io/api-reference/webhooks/resume-suspended-webhook.md): Resume a webhook which has been suspended due to too many failures.
- [Set xmetadata](https://developer.utgl.io/api-reference/xmetadata/set-xmetadata.md): Set xmetadata for a entity id and type. The value passed to xid or xmetadata will replace the existing xid or xmetadata values respectively. To remove xid or xmetadata, pass in null value.
- [Changelog](https://developer.utgl.io/changelog.md): Latest updates and announcements for the UTGL Developer Portal
- [Authentication](https://developer.utgl.io/issuing/getting-started/authentication.md): Learn how to authenticate with the Issuing API
- [Idempotency](https://developer.utgl.io/issuing/getting-started/idempotency.md)
- [External ID and Metadata](https://developer.utgl.io/issuing/getting-started/metadata.md): Use external identifiers and metadata to enhance resource management and integration workflows
- [Overview](https://developer.utgl.io/issuing/getting-started/overview.md): Introduction to Issuing API for card issuing
- [Pagination](https://developer.utgl.io/issuing/getting-started/pagination.md)
- [Quickstart](https://developer.utgl.io/issuing/getting-started/quickstart.md): Get started with the Issuing API in 5 minutes
- [Rate Limiting](https://developer.utgl.io/issuing/getting-started/rate-limits.md)
- [Request Signing](https://developer.utgl.io/issuing/getting-started/request-signing.md): Learn how to authenticate API requests using RSA key pairs and JWT tokens
- [Requests & Responses](https://developer.utgl.io/issuing/getting-started/requests-responses.md): Complete guide to API request formatting, response structures, status codes, error handling, and best practices
- [Sandbox Environment](https://developer.utgl.io/issuing/getting-started/sandbox-environment.md)
- [OOB / Online Transactions](https://developer.utgl.io/issuing/guides/3ds-integration.md): Complete guide to integrating out-of-band (OOB) transaction verification for enhanced online payment security
- [Card Account Modes](https://developer.utgl.io/issuing/guides/card-account-modes.md): Understand prepaid, asset-link, and fixed-limit card account modes and choose the right one for your use case
- [Creating Cards](https://developer.utgl.io/issuing/guides/creating-cards.md): Step-by-step guide to creating and managing cards
- [Fee Group Setting](https://developer.utgl.io/issuing/guides/fee-group-setting.md): Apply different fee group to the card account
- [Google Pay Wallet Provisioning](https://developer.utgl.io/issuing/guides/google-pay-provisioning.md): Complete guide to integrating Google Pay card provisioning (Add to Google Wallet) with OTP verification
- [Handling Webhooks](https://developer.utgl.io/issuing/guides/handling-webhooks.md): Implement webhook handlers for real-time event notifications
- [KYC Requirements for Individual Cardholders](https://developer.utgl.io/issuing/guides/kyc-requirements.md): Mandatory KYC fields and supporting documents for individual card account applications
- [Resource Structure](https://developer.utgl.io/issuing/guides/retrieve-card-sensitive-info.md): A Comprehensive Guide to the UTGL Access API Resource Structure.
- [Transaction Lifecycle](https://developer.utgl.io/issuing/guides/transaction-lifecycle.md): Overview of card transaction lifecycle, flow, and types
- [Transaction Statuses](https://developer.utgl.io/issuing/guides/transaction-statuses.md): Detailed guide to transaction statuses, transitions, and handling each state
- [Webhook Events](https://developer.utgl.io/issuing/guides/webhook-events-1.md)
- [Overview](https://developer.utgl.io/issuing/guides/webhooks-1.md)
- [How to authenticate with the Issuing API using Go](https://developer.utgl.io/issuing/recipes/authentication-golang.md)
- [How to authenticate with the Issuing API using Java](https://developer.utgl.io/issuing/recipes/authentication-java.md)
- [How to authenticate with the Issuing API using Node.js](https://developer.utgl.io/issuing/recipes/authentication-nodejs.md)
- [How to authenticate with the Issuing API using PHP](https://developer.utgl.io/issuing/recipes/authentication-php.md)
- [Issuing: Retrieving full card info securely](https://developer.utgl.io/issuing/recipes/issuing-card-info-securely.md)
- [Verify webhook signature with Java](https://developer.utgl.io/issuing/recipes/verify-webhook-java.md)
- [Verify webhook signature with node.js](https://developer.utgl.io/issuing/recipes/verify-webhook-nodejs.md)
- [Partner Connect API](https://developer.utgl.io/merchant/partner-connect/index.md): Complete guide to integrating merchant payment processing with UTGL card services

## OpenAPI Specs

- [openapi](https://developer.utgl.io/api-reference/openapi.json)
- [partner-connect](https://developer.utgl.io/partner-connect.yaml)