# UQPAY Docs

## Docs

- [Sign in via API](https://docs.uqpay.org/api-reference/auth/signin.md): Authenticates and authorizes a user to the UQPAY API. The authentication token is required to make requests to all other endpoints in the UQPAY API. Tokens expire after 10 minutes of inactivity.
- [Authentication](https://docs.uqpay.org/api-reference/authentication.md): Use API keys to authenticate your client requests when utilizing UQPAY APIs.
- [Retrieve a bank details](https://docs.uqpay.org/api-reference/balance/bank_details.md): This endpoint returns a bank details of a balance based on the currency.
- [Create a balance](https://docs.uqpay.org/api-reference/balance/create.md): This endpoint create a currency balance.
- [List all balances](https://docs.uqpay.org/api-reference/balance/list.md): This endpoint returns a list of balances for opened currency.
- [Retrieve a balance](https://docs.uqpay.org/api-reference/balance/retrieve.md): This endpoint returns a balance based on the currency.
- [Create a beneficiary](https://docs.uqpay.org/api-reference/beneficiaries/create.md): This endpoint create a beneficiary.
- [Delete a beneficiary](https://docs.uqpay.org/api-reference/beneficiaries/delete.md): This endpoint delete a beneficiary.
- [List all beneficiaries](https://docs.uqpay.org/api-reference/beneficiaries/list.md): Get list of beneficiaries.
- [Query a beneficiary](https://docs.uqpay.org/api-reference/beneficiaries/query_v1.1.md): This endpoint query a beneficiary.
- [Retrieve a beneficiary by id](https://docs.uqpay.org/api-reference/beneficiaries/retrieve.md): This endpoint returns a beneficiary based on the id.
- [Update a beneficiary](https://docs.uqpay.org/api-reference/beneficiaries/update.md): This endpoint update a beneficiary.
- [Cancel a card](https://docs.uqpay.org/api-reference/card/cancel.md): This endpoint cancel a card by card id. The remaining balance of the card will be refunded to the corresponding currency account.
- [Create a card](https://docs.uqpay.org/api-reference/card/create.md): This endpoint is used to create a card(prepaid,debit,credit). Only `USD` is supported for now.
- [Freeze a card](https://docs.uqpay.org/api-reference/card/freeze.md): This endpoint freeze a card by card id. No transactions can be made on frozen cards.
- [List all cards](https://docs.uqpay.org/api-reference/card/list.md): This endpoint get list of cards issued under an account.
- [List Card Products](https://docs.uqpay.org/api-reference/card/products.md): This endpoint get all activated card products under the current account, choose one when creating a card.
- [Recharge a card](https://docs.uqpay.org/api-reference/card/recharge.md): This endpoint recharge a card. Add money to your card using your account balance.
- [Retrieve card operation result](https://docs.uqpay.org/api-reference/card/record.md): This endpoint retrieve the results of card open, card recharge, and card withdraw by unique_request_id.
- [Retrieve card details](https://docs.uqpay.org/api-reference/card/retrieve.md): This endpoint retrieve card details by card id.
- [Retrieve sensitive card details](https://docs.uqpay.org/api-reference/card/secure.md): Retrieves the secure information for a specific card identified by `card_id`. This information includes details such as `expire date` and `CVV2`.
- [Unfreeze a card](https://docs.uqpay.org/api-reference/card/unfreeze.md): This endpoint unfreeze a card by card id.
- [Update a card](https://docs.uqpay.org/api-reference/card/update.md): This endpoint update a card name by card id.
- [Withdraw a card](https://docs.uqpay.org/api-reference/card/withdraw.md): This endpoint allows for withdrawals from the card balance.
- [List all card transactions](https://docs.uqpay.org/api-reference/card_transactions/list.md): This endpoint get list of card transactions.
- [Create a cardholder](https://docs.uqpay.org/api-reference/cardholder/create.md): This endpoint create a cardholder. Cardholders are individuals with the ability to own cards. Creation of cardholders involves passing our KYC (Know-Your-Customer) process and so individuals are required to present contact details.
- [List all cardholders](https://docs.uqpay.org/api-reference/cardholder/list.md): This endpoint get list of cardholders.
- [Delete a cardholder](https://docs.uqpay.org/api-reference/cardholder/remove.md): This endpoint delete a cardholder by cardholder id.
- [Retrieve cardholder details](https://docs.uqpay.org/api-reference/cardholder/retrieve.md): This endpoint retrieve cardholder details by cardholder id.
- [Idempotent Requests](https://docs.uqpay.org/api-reference/idempotent-requests.md): Ensure that you ensure your transactions are executed only once in case they need to be retried.
- [Get list of payers](https://docs.uqpay.org/api-reference/payer/list.md): This endpoint returns a list of payers.
- [Create a new payout](https://docs.uqpay.org/api-reference/payout/create_v1.1.md): This endpoint create a new payout to a beneficiary. The payout only supported the same currency between payer and beneficiary.
- [List all payouts](https://docs.uqpay.org/api-reference/payout/list_v1.1.md): This endpoint returns a list of payouts.
- [Get a list of payment methods](https://docs.uqpay.org/api-reference/payout/paymentmethods_v1.1.md): This endpoint returns a list of payment methods.
- [Retrieve a payout by id](https://docs.uqpay.org/api-reference/payout/retrieve_v1.1.md): This endpoint returns a payout based on the id.
- [Check payment validation](https://docs.uqpay.org/api-reference/payout/validation_v1.1.md): This endpoint returns payment validation.
- [List all transactions](https://docs.uqpay.org/api-reference/transactions/list.md): List all transactions related to the account.
- [Beneficiaries webhooks](https://docs.uqpay.org/api-reference/webhooks/beneficiaries/beneficiaries_webhooks_1.1.md): We will send the following header and body to the provided Url in a post request
- [Payout webhooks](https://docs.uqpay.org/api-reference/webhooks/payout/webhooks_1.1.md): We will send the following header and body to the provided Url in a post request
- [Introduction](https://docs.uqpay.org/introduction.md): Welcome to the home of your new documentation

## Optional

- [Github](https://github.com/uqpay)
- [Linkedin](https://www.linkedin.com/company/uqpay/)
- [Official Website](https://www.uqpay.com)