# Gnosis Pay Documentation

## Docs

- [Accounts on Gnosis Pay](https://gnosispay-feat-changelog-feature.mintlify.site/account/accounts.md): How the Gnosis Pay Safe works
- [IBAN Integration](https://gnosispay-feat-changelog-feature.mintlify.site/account/iban-integration.md): IBAN cash-in to the GnosisPay Account via Monerium
- [Onchain Daily Limit](https://gnosispay-feat-changelog-feature.mintlify.site/account/onchain-daily-limit.md): Manage daily spending limits for Gnosis Pay Safe accounts
- [Send funds from GP Safe](https://gnosispay-feat-changelog-feature.mintlify.site/account/send-funds-from-safe.md): How to withdraw from the Gnosis Pay Safe
- [Create a new EOA account for the current user](https://gnosispay-feat-changelog-feature.mintlify.site/api-reference/account-management/create-a-new-eoa-account-for-the-current-user.md): Registers a new externally owned account (EOA) address for the authenticated user.
- [Delete an EOA account](https://gnosispay-feat-changelog-feature.mintlify.site/api-reference/account-management/delete-an-eoa-account.md): Removes an externally owned account (EOA) address associated with the authenticated user.
- [Get current onchain daily limit](https://gnosispay-feat-changelog-feature.mintlify.site/api-reference/account-management/get-current-onchain-daily-limit.md): Retrieves the current onchain daily spending limit for the authenticated user's Safe account.
- [Get transaction data for setting daily limit](https://gnosispay-feat-changelog-feature.mintlify.site/api-reference/account-management/get-transaction-data-for-setting-daily-limit.md): Returns the transaction data that needs to be signed by the user's wallet to set a new onchain daily limit. This endpoint is used as part of a three-step process: 1. Call this endpoint to get the transaction data 2. Sign the transaction data with the user's wallet 3. Submit the signature to the PUT…
- [Get typed data for withdrawing from the user's Safe account](https://gnosispay-feat-changelog-feature.mintlify.site/api-reference/account-management/get-typed-data-for-withdrawing-from-the-users-safe-account.md): Returns the EIP-712 typed data that needs to be signed by the user's wallet to withdraw from the user's Safe account. This endpoint is used as part of a three-step process: 1. Call this endpoint to get the EIP-712 typed data 2. Sign the typed data with the user's wallet using EIP-712 signature stand…
- [Retrieve the account balance for a user](https://gnosispay-feat-changelog-feature.mintlify.site/api-reference/account-management/retrieve-the-account-balance-for-a-user.md): Retrieves the balance information for a given user (total balance, spendable balance and pending balance)
- [Retrieve the EOA accounts for the current user](https://gnosispay-feat-changelog-feature.mintlify.site/api-reference/account-management/retrieve-the-eoa-accounts-for-the-current-user.md): Returns a list of externally owned account (EOA) addresses associated with the authenticated user.
- [Retrieve the list of delayed transactions for the authenticated user](https://gnosispay-feat-changelog-feature.mintlify.site/api-reference/account-management/retrieve-the-list-of-delayed-transactions-for-the-authenticated-user.md): Returns an array of delayed transactions associated with the authenticated user, excluding failed transactions.
- [Set onchain daily limit](https://gnosispay-feat-changelog-feature.mintlify.site/api-reference/account-management/set-onchain-daily-limit.md): Sets a new onchain daily spending limit for the authenticated user's Safe account. This endpoint requires a valid signature from the user's wallet to authorize the change.
- [Withdraw from the user's Safe account](https://gnosispay-feat-changelog-feature.mintlify.site/api-reference/account-management/withdraw-from-the-users-safe-account.md): Withdraws from the user's Safe account.
- [Create a new User](https://gnosispay-feat-changelog-feature.mintlify.site/api-reference/authentication/create-a-new-user.md): This endpoint creates a new `User` associating it with the provided email address. During transition period, OTP verification is optional.
- [Generate nonce](https://gnosispay-feat-changelog-feature.mintlify.site/api-reference/authentication/generate-nonce.md)
- [Request OTP for email verification](https://gnosispay-feat-changelog-feature.mintlify.site/api-reference/authentication/request-otp-for-email-verification.md): This endpoint generates and sends a one-time password (OTP) to the provided email address for verification purposes.
- [Verify SIWE signature](https://gnosispay-feat-changelog-feature.mintlify.site/api-reference/authentication/verify-siwe-signature.md)
- [Activate a Card](https://gnosispay-feat-changelog-feature.mintlify.site/api-reference/card-management/activate-a-card.md): ## Prerequisites - Card must have not been activated - A Safe Account should be set for the authenticated user
- [Freeze a Card](https://gnosispay-feat-changelog-feature.mintlify.site/api-reference/card-management/freeze-a-card.md): This will prevent the card from being used for any transactions.
- [Get a Card status](https://gnosispay-feat-changelog-feature.mintlify.site/api-reference/card-management/get-a-card-status.md)
- [Get paginated transactions for activated cards](https://gnosispay-feat-changelog-feature.mintlify.site/api-reference/card-management/get-paginated-transactions-for-activated-cards.md): Retrieves paginated transactions for all activated cards of the authenticated user. The final number might differ a little bit, as one thread might contain multiple transactions.
- [Get transactions for activated cards](https://gnosispay-feat-changelog-feature.mintlify.site/api-reference/card-management/get-transactions-for-activated-cards.md): This endpoint is deprecated. Please use [/api/v1/cards/transactions](#/Card%20Management/get_api_v1_cards_transactions) instead. Retrieves transactions for all activated cards of the authenticated user
- [List all Cards](https://gnosispay-feat-changelog-feature.mintlify.site/api-reference/card-management/list-all-cards.md)
- [Report a Card as lost](https://gnosispay-feat-changelog-feature.mintlify.site/api-reference/card-management/report-a-card-as-lost.md)
- [Report a Card as stolen](https://gnosispay-feat-changelog-feature.mintlify.site/api-reference/card-management/report-a-card-as-stolen.md)
- [Revert a Card freeze](https://gnosispay-feat-changelog-feature.mintlify.site/api-reference/card-management/revert-a-card-freeze.md): This will allow the card to be used for transactions. The card needs to be active and in a frozen state.
- [Void a Virtual Card](https://gnosispay-feat-changelog-feature.mintlify.site/api-reference/card-management/void-a-virtual-card.md): Void a virtual card. Only virtual cards can be voided using this endpoint.
- [Attach a coupon to a Card Order](https://gnosispay-feat-changelog-feature.mintlify.site/api-reference/card-order/attach-a-coupon-to-a-card-order.md): This endpoint associates a provided coupon code with an existing card order by its `orderId`.
- [Attach an on-chain transaction to a Card Order](https://gnosispay-feat-changelog-feature.mintlify.site/api-reference/card-order/attach-an-on-chain-transaction-to-a-card-order.md): This endpoint associates a provided on-chain transaction hash with an existing card order by its `orderId`.
- [Cancel a Card Order](https://gnosispay-feat-changelog-feature.mintlify.site/api-reference/card-order/cancel-a-card-order.md): This endpoint transitions the card order to the cancelled state.
- [Create a card out of a card order](https://gnosispay-feat-changelog-feature.mintlify.site/api-reference/card-order/create-a-card-out-of-a-card-order.md): The last step in the card creation process.
- [Create a new card order](https://gnosispay-feat-changelog-feature.mintlify.site/api-reference/card-order/create-a-new-card-order.md)
- [Create a virtual card](https://gnosispay-feat-changelog-feature.mintlify.site/api-reference/card-order/create-a-virtual-card.md): Creates a virtual card without requiring a card order. Virtual cards are free and activated immediately. No shipping address or payment validation is required.
- [Marks a Card Order as paid](https://gnosispay-feat-changelog-feature.mintlify.site/api-reference/card-order/marks-a-card-order-as-paid.md): This endpoint marks the Card Order with `orderId` as paid.
- [Retrieve details of a Card Order](https://gnosispay-feat-changelog-feature.mintlify.site/api-reference/card-order/retrieve-details-of-a-card-order.md): This endpoint retrieves details of a card order by its `orderId`.
- [Retrieves all card orders](https://gnosispay-feat-changelog-feature.mintlify.site/api-reference/card-order/retrieves-all-card-orders.md): Retrieves all card orders for the authenticated user
- [Generate a new ephemeral token](https://gnosispay-feat-changelog-feature.mintlify.site/api-reference/endpoints/generate-a-new-ephemeral-token.md): Generates a new ephemeral token for secure PCI operations.
- [Check IBAN Availability](https://gnosispay-feat-changelog-feature.mintlify.site/api-reference/iban/check-iban-availability.md): Returns whether the user is eligible to enable an IBAN on their account.
- [Create a new Monerium profile](https://gnosispay-feat-changelog-feature.mintlify.site/api-reference/iban/create-a-new-monerium-profile.md): This endpoint attempts to create a new Monerium profile for the authenticated user. If the user already has a Monerium profile, it will return a redirect URL for the OAuth flow to link the existing profile.
- [Get the message that needs to be signed for IBAN activation](https://gnosispay-feat-changelog-feature.mintlify.site/api-reference/iban/get-the-message-that-needs-to-be-signed-for-iban-activation.md): Returns the standard message that users need to sign with their wallet to verify ownership for Monerium IBAN activation.
- [Resets the IBAN integration for this User](https://gnosispay-feat-changelog-feature.mintlify.site/api-reference/iban/resets-the-iban-integration-for-this-user.md): Remove the IBAN information from our DB and deletes the User's IBAN functionality.
- [Retrieve a list of Monerium IBAN orders](https://gnosispay-feat-changelog-feature.mintlify.site/api-reference/iban/retrieve-a-list-of-monerium-iban-orders.md): Returns a list of IBAN orders associated with the authenticated user.
- [Retrieve IBAN details](https://gnosispay-feat-changelog-feature.mintlify.site/api-reference/iban/retrieve-iban-details.md): Returns IBAN details including the IBAN number, BIC, and Status.
- [Retrieves the redirect URL for the Monerium oAuth flow](https://gnosispay-feat-changelog-feature.mintlify.site/api-reference/iban/retrieves-the-redirect-url-for-the-monerium-oauth-flow.md): This is the same URL we return on /monerium-profile, in the case something goes wrong you have this endpoint if you need to redirect your users without calling /monerium-profile.
- [Request an OTP to verify a Phone Number. This call replaces the existing phone number for a user if it exists, whether it's verified or not.](https://gnosispay-feat-changelog-feature.mintlify.site/api-reference/kyc/request-an-otp-to-verify-a-phone-number-this-call-replaces-the-existing-phone-number-for-a-user-if-it-exists-whether-its-verified-or-not.md)
- [Retrieve a reusable token from SumSub.](https://gnosispay-feat-changelog-feature.mintlify.site/api-reference/kyc/retrieve-a-reusable-token-from-sumsub.md)
- [Retrieve the Source of Funds questions.](https://gnosispay-feat-changelog-feature.mintlify.site/api-reference/kyc/retrieve-the-source-of-funds-questions.md)
- [Retrieves KYC integration specification.](https://gnosispay-feat-changelog-feature.mintlify.site/api-reference/kyc/retrieves-kyc-integration-specification.md): Retrieve the specification to follow with the KYC integration.
- [Retrieves KYC integration specification for SDK.](https://gnosispay-feat-changelog-feature.mintlify.site/api-reference/kyc/retrieves-kyc-integration-specification-for-sdk.md): Retrieve the specification to follow with the KYC integration.
- [Submit answers to the Source of Funds questionnaire.](https://gnosispay-feat-changelog-feature.mintlify.site/api-reference/kyc/submit-answers-to-the-source-of-funds-questionnaire.md)
- [Validates an OTP Code to verify a Phone Number.](https://gnosispay-feat-changelog-feature.mintlify.site/api-reference/kyc/validates-an-otp-code-to-verify-a-phone-number.md)
- [Retrieve user rewards information](https://gnosispay-feat-changelog-feature.mintlify.site/api-reference/rewards/retrieve-user-rewards-information.md): Returns user's OG status, GNO balance of Safe, and calculated base cashback rate. Note that the cashbackRate returned does not include the +1% bonus for OG NFT holders - to get the total cashback rate, add 1% to the cashbackRate if isOg is true.
- [Create or deploy a Safe account for the authenticated user](https://gnosispay-feat-changelog-feature.mintlify.site/api-reference/safe-management/create-or-deploy-a-safe-account-for-the-authenticated-user.md): This endpoint serves two purposes - it first checks if a Safe account exists for the user. If no account exists, it creates one and initiates deployment. If an account already exists but is not deployed, it initiates the deployment process.
- [Deploy Safe modules with a user signature](https://gnosispay-feat-changelog-feature.mintlify.site/api-reference/safe-management/deploy-safe-modules-with-a-user-signature.md): Takes an EIP-712 signature provided by the user's wallet and executes the account setup transaction. This is the second step in the account setup process, after obtaining the signature data from the GET /api/v1/account/signature-payload endpoint.
- [Get signature data for account setup](https://gnosispay-feat-changelog-feature.mintlify.site/api-reference/safe-management/get-signature-data-for-account-setup.md): Returns the domain, types, and message objects needed for EIP-712 typed data signing. This is typically used to prepare the data that needs to be signed by the user's wallet to set up account allowances and delays.
- [Retrieve the Safe configuration for the authenticated user](https://gnosispay-feat-changelog-feature.mintlify.site/api-reference/safe-management/retrieve-the-safe-configuration-for-the-authenticated-user.md): Returns the configuration of the Safe account associated with the authenticated user, including deployment status, approvals, and account status and allowance details from the chain.
- [Set the currency for a user's Safe account based on their country](https://gnosispay-feat-changelog-feature.mintlify.site/api-reference/safe-management/set-the-currency-for-a-users-safe-account-based-on-their-country.md): This endpoint sets the appropriate token symbol (currency) for a user's Safe account based on their country. It should be called after deploying a Safe account using the /api/v1/account endpoint.
- [Add a new owner to the Safe](https://gnosispay-feat-changelog-feature.mintlify.site/api-reference/safe-owners/add-a-new-owner-to-the-safe.md): Adds a new owner to the user's Safe account.
- [Get the list of Safe owners](https://gnosispay-feat-changelog-feature.mintlify.site/api-reference/safe-owners/get-the-list-of-safe-owners.md): Returns the list of addresses that are owners of the user's Safe account. These owners have the ability to sign transactions and manage the Safe.
- [Get typed data for adding a new Safe owner](https://gnosispay-feat-changelog-feature.mintlify.site/api-reference/safe-owners/get-typed-data-for-adding-a-new-safe-owner.md): Returns the EIP-712 typed data that needs to be signed by the user's wallet to add a new owner to the Safe. This endpoint is used as part of a three-step process: 1. Call this endpoint to get the EIP-712 typed data 2. Sign the typed data with the user's wallet using EIP-712 signature standard 3. Sub…
- [Get typed data for removing a Safe owner](https://gnosispay-feat-changelog-feature.mintlify.site/api-reference/safe-owners/get-typed-data-for-removing-a-safe-owner.md): Returns the EIP-712 typed data that needs to be signed by the user's wallet to remove an owner from the Safe. This endpoint is used as part of a three-step process: 1. Call this endpoint to get the EIP-712 typed data 2. Sign the typed data with the user's wallet using EIP-712 signature standard 3. S…
- [Remove an owner from the Safe](https://gnosispay-feat-changelog-feature.mintlify.site/api-reference/safe-owners/remove-an-owner-from-the-safe.md): Removes an existing owner from the user's Safe account.
- [Accept terms and conditions](https://gnosispay-feat-changelog-feature.mintlify.site/api-reference/user/accept-terms-and-conditions.md): Accept specific terms and conditions based on type and version.
- [Get or create user's referral code](https://gnosispay-feat-changelog-feature.mintlify.site/api-reference/user/get-or-create-users-referral-code.md): Returns existing referral code or generates a new one if none exists.
- [Get terms and conditions status](https://gnosispay-feat-changelog-feature.mintlify.site/api-reference/user/get-terms-and-conditions-status.md): Returns the status of all terms and conditions, including whether the user has accepted the latest version, when they were accepted, and links to the terms documents.
- [Get the User profile](https://gnosispay-feat-changelog-feature.mintlify.site/api-reference/user/get-the-user-profile.md): Get the User profile
- [Get user's referral status](https://gnosispay-feat-changelog-feature.mintlify.site/api-reference/user/get-users-referral-status.md): Returns the user's referral status, including pending and completed referrals.
- [Authentication Flow](https://gnosispay-feat-changelog-feature.mintlify.site/auth.md): Use Sign-In with Ethereum (SIWE) to authenticate API requests.
- [Cards Concepts](https://gnosispay-feat-changelog-feature.mintlify.site/cards/concepts.md): A quick overview of core concepts for the Card Industry
- [Partner Secure Elements (PSE) Integration](https://gnosispay-feat-changelog-feature.mintlify.site/cards/pse-integration.md): Access sensitive Card information from your client application.
- [Changelog](https://gnosispay-feat-changelog-feature.mintlify.site/changelog.md): Product updates and announcements
- [Introduction](https://gnosispay-feat-changelog-feature.mintlify.site/index.md): Welcome to GnosisPay Documentation
- [Onboard Users to Gnosis Pay](https://gnosispay-feat-changelog-feature.mintlify.site/onboarding-flow.md): How to onboard new Users to Gnosis Pay.

## OpenAPI Specs

- [spec](https://api.gnosispay.com/api-docs/spec.json)