# Gnosis Pay Documentation

## Docs

- [Introduction](https://docs.gnosispay.com/index.md): Welcome to GnosisPay Documentation
- [Integrating Gnosis Pay APIs](https://docs.gnosispay.com/integration-model.md): Whether you’re building as a developer or looking to launch a whitelisted branded solution, Gnosis Pay is designed to be flexible and accessible for all developers and businesses.
- [Authentication Flow](https://docs.gnosispay.com/auth.md): Use Sign-In with Ethereum (SIWE) to authenticate API requests.
- [Onboard Users to Gnosis Pay](https://docs.gnosispay.com/onboarding-flow.md): How to onboard new Users to Gnosis Pay.
- [Accounts on Gnosis Pay](https://docs.gnosispay.com/account/index.md): How the Gnosis Pay Safe works
- [Adding a new wallet for authentication](https://docs.gnosispay.com/account/update-authenticated-account.md): Link an additional wallet address to a Gnosis Pay user
- [Managing Safe Ownership](https://docs.gnosispay.com/account/adding-safe-owner.md): Add a new owner to a Gnosis Pay Safe Account
- [On/Off Ramp Integrations](https://docs.gnosispay.com/on-off-ramps/index.md): Complete guide to fiat-to-crypto conversions with Gnosis Pay's integrated ramp partners
- [IBAN Integration](https://docs.gnosispay.com/on-off-ramps/iban-integration.md): IBAN cash-in to the Gnosis Pay Account via Monerium
- [KYC sharing for GP Partners](https://docs.gnosispay.com/on-off-ramps/kyc-sharing.md): This guide explains how to share existing Gnosis Pay KYC data with GP Partners using Sumsub's reusable token system.
- [Cards Concepts](https://docs.gnosispay.com/cards/concepts.md): Core concepts for card management, PINs, and merchant categories
- [Create Physical Cards](https://docs.gnosispay.com/cards/create-physical-cards.md): Order physical cards for your Users.
- [Create Virtual Cards](https://docs.gnosispay.com/cards/create-virtual-cards.md): Virtual cards work either online or tap in presence (with Apple Pay and Google Pay).
- [Card Order State Transitions](https://docs.gnosispay.com/cards/card-order-state-transitions.md): Understanding the card order state transitions
- [Partner Secure Elements (PSE) Integration](https://docs.gnosispay.com/cards/pse-integration.md): Access sensitive Card information from your client application.
- [Card Transactions Overview](https://docs.gnosispay.com/transactions/index.md): Comprehensive guide to understanding card transaction types, lifecycle, and integration patterns
- [Transaction Lifecycle](https://docs.gnosispay.com/transactions/lifecycle.md): Deep dive into the authorization and clearing process for card transactions
- [Transaction Integration Guide](https://docs.gnosispay.com/transactions/integration-guide.md): Complete examples and best practices for integrating with Gnosis Pay transaction APIs
- [Overview](https://docs.gnosispay.com/gp-onchain/overview.md): Understanding the on-chain integration options for Gnosis Pay, including the Account Kit SDK and direct contract integration approaches.
- [About GP Safe](https://docs.gnosispay.com/gp-onchain/about-GP-safe.md): Gnosis Pay's on-chain infrastructure is built on top of the [Safe protocol](https://safe.global), providing a secure and programmable foundation for digital payments. Each user gets a unique Safe account that acts as their on-chain wallet, with additional modules that enable spending limits, time de…
- [Sign Messages with GP Safe](https://docs.gnosispay.com/gp-onchain/sign-message.md): Learn how to sign messages using your GP Safe account with the delay module for enhanced security.
- [Change GP Safe daily spending limit](https://docs.gnosispay.com/gp-onchain/daily-limit.md): Manage daily spending limits for Gnosis Pay Safe accounts
- [Withdraw funds from GP Safe](https://docs.gnosispay.com/gp-onchain/withdraw-funds-from-safe.md): How to send funds from the Gnosis Pay Safe to your EOA or somewhere else.
- [Third-Party Bridges](https://docs.gnosispay.com/gp-onchain/third-party-bridges.md)
- [Introduction](https://docs.gnosispay.com/webhooks/introduction.md): Learn how to integrate with Gnosis Pay webhooks to receive real-time event notifications.
- [Working with Webhooks](https://docs.gnosispay.com/webhooks/getting-started.md): Step-by-step guide to set up and implement webhooks in your application.
- [Events](https://docs.gnosispay.com/webhooks/events.md)
- [API Reference Introduction](https://docs.gnosispay.com/api-reference/intro.md): General guidelines on how to integrate with GnosisPay.
- [Authentication Helper App](https://docs.gnosispay.com/api-reference/auth-app.md): Use this app to generate and sign a message using your ethereum wallet.
- [Retrieve Account Balance](https://docs.gnosispay.com/api-reference/account-management/retrieve-account-balance.md): Retrieves the balance information for the authenticated user (total, spendable and pending balances)
- [Get current daily spending limit](https://docs.gnosispay.com/api-reference/account-management/get-current-daily-spending-limit.md): Retrieves the current daily spending limit for the authenticated user's Safe account.
- [Set new daily spending limit](https://docs.gnosispay.com/api-reference/account-management/set-new-daily-spending-limit.md): Sets a new daily spending limit for the authenticated user's Safe account.
- [Get EIP-712 typed data for setting daily limit](https://docs.gnosispay.com/api-reference/account-management/get-eip-712-typed-data-for-setting-daily-limit.md): Returns the EIP-712 typed data that needs to be signed by the user's wallet to set a new daily limit. 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. Submit th…
- [Retrieve Onchain Daily Limit](https://docs.gnosispay.com/api-reference/account-management/retrieve-onchain-daily-limit.md): This endpoint is deprecated and will be removed in a future version. Please use `GET /api/v1/accounts/daily-limit` instead.
- [Change Onchain Daily Limit with Signature](https://docs.gnosispay.com/api-reference/account-management/change-onchain-daily-limit-with-signature.md): This endpoint is deprecated and will be removed in a future version. Please use `PUT /api/v1/accounts/daily-limit` instead.
- [Retrieve Transaction Data for changing Daily Limit](https://docs.gnosispay.com/api-reference/account-management/retrieve-transaction-data-for-changing-daily-limit.md): This endpoint is deprecated and will be removed in a future version. Please use `GET /api/v1/accounts/daily-limit/transaction-data` instead.
- [Withdraw from Safe with Signature](https://docs.gnosispay.com/api-reference/account-management/withdraw-from-safe-with-signature.md): Withdraws ERC20 tokens or native tokens (xDAI) from the user's Safe account.
- [Retrieve Transaction Data for Withdrawing from Safe](https://docs.gnosispay.com/api-reference/account-management/retrieve-transaction-data-for-withdrawing-from-safe.md): Returns the EIP-712 typed data that needs to be signed by the user's wallet to withdraw ERC20 tokens or native tokens (xDAI) from the user's Safe account.
- [List authenticated account addresses](https://docs.gnosispay.com/api-reference/account-management/list-authenticated-account-addresses.md): Returns a list of addresses associated with the authenticated user.
- [Add a new account address for authentication](https://docs.gnosispay.com/api-reference/account-management/add-a-new-account-address-for-authentication.md): Registers a new authenticated account address for the authenticated user. This address can be used to sign in via SIWE and to start new API sessions.
- [Remove account address for authentication](https://docs.gnosispay.com/api-reference/account-management/remove-account-address-for-authentication.md): Removes the account address associated with the authenticated user.
- [Generate nonce](https://docs.gnosispay.com/api-reference/authentication/generate-nonce.md)
- [Verify SIWE signature](https://docs.gnosispay.com/api-reference/authentication/verify-siwe-signature.md)
- [Create a new User](https://docs.gnosispay.com/api-reference/authentication/create-a-new-user.md): This endpoint creates a new `User` associating it with the provided email address.
- [Request OTP for email verification](https://docs.gnosispay.com/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.
- [Activate a Card](https://docs.gnosispay.com/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://docs.gnosispay.com/api-reference/card-management/freeze-a-card.md): This will prevent the card from being used for any transactions.
- [Report a Card as lost](https://docs.gnosispay.com/api-reference/card-management/report-a-card-as-lost.md)
- [Get a Card status](https://docs.gnosispay.com/api-reference/card-management/get-a-card-status.md)
- [Report a Card as stolen](https://docs.gnosispay.com/api-reference/card-management/report-a-card-as-stolen.md)
- [Revert a Card freeze](https://docs.gnosispay.com/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://docs.gnosispay.com/api-reference/card-management/void-a-virtual-card.md): Void a virtual card. Only virtual cards can be voided using this endpoint.
- [List all Cards](https://docs.gnosispay.com/api-reference/card-management/list-all-cards.md)
- [Create a Virtual Card](https://docs.gnosispay.com/api-reference/card-management/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.
- [Link physical card to user](https://docs.gnosispay.com/api-reference/card-management/link-physical-card-to-user.md): Verifies a card by decrypting PAN details and associating it with the authenticated user
- [List Card Transactions](https://docs.gnosispay.com/api-reference/transactions/list-card-transactions.md): Retrieves paginated transactions for all activated cards of the authenticated user.
- [Dispute a Transaction](https://docs.gnosispay.com/api-reference/transactions/dispute-a-transaction.md): Create a ticket to dispute a transaction. The list of available dispute reason keys can be found in the `GET /api/v1/transactions/dispute` endpoint. If the dispute reason is `unrecognized_transaction_report_fraudulent`, the user's card will be restricted.
- [List Dispute Reasons](https://docs.gnosispay.com/api-reference/transactions/list-dispute-reasons.md): Returns a list of available dispute reasons keys with their human-readable text. The keys need to be used in the dispute reason field when creating a dispute.
- [List Transactions (without pagination)](https://docs.gnosispay.com/api-reference/transactions/list-transactions-without-pagination.md): This endpoint is deprecated. Please use [/api/v1/cards/transactions](#/Transactions/get_api_v1_cards_transactions) instead. Retrieves transactions for all activated cards of the authenticated user
- [List Delayed Transactions](https://docs.gnosispay.com/api-reference/safe-management/list-delayed-transactions.md): Returns an array of delayed transactions associated with the authenticated user, excluding failed transactions.
- [Retrieve Safe Configuration](https://docs.gnosispay.com/api-reference/safe-management/retrieve-safe-configuration.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.
- [Get the Safe deployment status.](https://docs.gnosispay.com/api-reference/safe-management/get-the-safe-deployment-status.md): Returns the deployment status of the Safe account for the authenticated user.
- [Deploy and Setup a Safe](https://docs.gnosispay.com/api-reference/safe-management/deploy-and-setup-a-safe.md): Deploys and sets up the Safe account for the authenticated user. The User needs to be KYC approved.
- [Reset Safe Account](https://docs.gnosispay.com/api-reference/safe-management/reset-safe-account.md): Permanently deletes the Safe account for the authenticated user. This operation is irreversible and should be used with caution.
- [Retrieve Safe migration status](https://docs.gnosispay.com/api-reference/safe-management/retrieve-safe-migration-status.md): Returns the current safe, previous safe (if migrated), and migration status for the authenticated user.
- [Set Safe Currency](https://docs.gnosispay.com/api-reference/safe-management/set-safe-currency.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.
- [List Safe Owners](https://docs.gnosispay.com/api-reference/safe-management/list-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.
- [Add Safe Owner](https://docs.gnosispay.com/api-reference/safe-management/add-safe-owner.md): Adds a new owner to the user's Safe account.
- [Remove Safe Owner](https://docs.gnosispay.com/api-reference/safe-management/remove-safe-owner.md): Removes an existing owner from the user's Safe account.
- [Get typed data for adding a Safe Owner](https://docs.gnosispay.com/api-reference/safe-management/get-typed-data-for-adding-a-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://docs.gnosispay.com/api-reference/safe-management/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…
- [List Physical Card Orders](https://docs.gnosispay.com/api-reference/physical-card-order/list-physical-card-orders.md): Retrieves all physical card orders for the authenticated user
- [Create a Physical Card](https://docs.gnosispay.com/api-reference/physical-card-order/create-a-physical-card.md): The last step in the physical card creation process.
- [Register payment for a Physical Card Order](https://docs.gnosispay.com/api-reference/physical-card-order/register-payment-for-a-physical-card-order.md): This endpoint associates a provided on-chain transaction hash with an existing card order by its `orderId`. If the card is free, you can skip this step.
- [Attach a coupon to a Physical Card Order](https://docs.gnosispay.com/api-reference/physical-card-order/attach-a-coupon-to-a-physical-card-order.md): This endpoint associates a provided coupon code with an existing card order by its `orderId`. Use the `GPDOCS` coupon code to get the card for free.
- [Retrieve details of a Physical Card Order](https://docs.gnosispay.com/api-reference/physical-card-order/retrieve-details-of-a-physical-card-order.md): This endpoint retrieves details of a card order by its `orderId`.
- [Confirm the payment for a Physical Card Order](https://docs.gnosispay.com/api-reference/physical-card-order/confirm-the-payment-for-a-physical-card-order.md): This endpoint marks the Card Order with `orderId` as paid. Even if the card is free, you need to call this endpoint to confirm the payment.
- [Cancel a Physical Card Order](https://docs.gnosispay.com/api-reference/physical-card-order/cancel-a-physical-card-order.md): This endpoint transitions the card order to the cancelled state.
- [Create Physical Card Order](https://docs.gnosispay.com/api-reference/physical-card-order/create-physical-card-order.md): Orders a new physical card for the authenticated user. This is the first step in the physical card order process, the card is not created yet.
- [Retrieve Source of Funds questions](https://docs.gnosispay.com/api-reference/kyc/retrieve-source-of-funds-questions.md)
- [Answer Source of Funds questions](https://docs.gnosispay.com/api-reference/kyc/answer-source-of-funds-questions.md)
- [Verify a Phone Number (with OTP Code)](https://docs.gnosispay.com/api-reference/kyc/verify-a-phone-number-with-otp-code.md)
- [Retrieve an OTP code to verify a Phone Number](https://docs.gnosispay.com/api-reference/kyc/retrieve-an-otp-code-to-verify-a-phone-number.md): This call replaces the existing phone number for a user if it exists, whether it's verified or not.
- [Retrieve Link for Web Integration](https://docs.gnosispay.com/api-reference/kyc/retrieve-link-for-web-integration.md): Retrieve the specification to follow with the KYC integration.
- [Retrieve Access Token for Sumsub SDK Integration](https://docs.gnosispay.com/api-reference/kyc/retrieve-access-token-for-sumsub-sdk-integration.md): Retrieve the specification to follow with the KYC integration.
- [Retrieve a KYC Sharing Token for Sumsub Partners](https://docs.gnosispay.com/api-reference/kyc/retrieve-a-kyc-sharing-token-for-sumsub-partners.md)
- [Retrieve Cashback Information](https://docs.gnosispay.com/api-reference/cashback/retrieve-cashback-information.md): Returns user's OG status, GNO balance of Safe, cashback rate, and weekly spending cap. The cashback rate is based on GNO balance tiers and includes the OG NFT holder bonus if applicable.
- [Check IBAN Availability](https://docs.gnosispay.com/api-reference/iban/check-iban-availability.md): Returns whether the user is eligible to enable an IBAN on their account.
- [Get the message that needs to be signed for IBAN activation](https://docs.gnosispay.com/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.
- [Create a new Monerium integration](https://docs.gnosispay.com/api-reference/iban/create-a-new-monerium-integration.md): Creates a new Monerium integration for the authenticated user and associates it with the authenticated user's EOA address. All operations on Monerium are done through their API, this endpoint is just a way to reuse the GP KYC to open an account on Monerium.
- [Retrieve IBAN details](https://docs.gnosispay.com/api-reference/iban/retrieve-iban-details.md): Returns IBAN details including the IBAN number, BIC, and Status.
- [Retrieve a list of Monerium IBAN orders](https://docs.gnosispay.com/api-reference/iban/retrieve-a-list-of-monerium-iban-orders.md): Returns a list of IBAN orders associated with the authenticated user.
- [Retrieve Rewards Information](https://docs.gnosispay.com/api-reference/rewards/retrieve-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.
- [Retrieve all Terms and Conditions](https://docs.gnosispay.com/api-reference/terms/retrieve-all-terms-and-conditions.md): This endpoint provides public access to terms information including type, current version, URL, and name.
- [Get card public key](https://docs.gnosispay.com/api-reference/user/get-card-public-key.md)
- [Retrieve Terms and Conditions Status](https://docs.gnosispay.com/api-reference/user/retrieve-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.
- [Accept Terms and Conditions](https://docs.gnosispay.com/api-reference/user/accept-terms-and-conditions.md): Accept specific terms and conditions based on type and version.
- [Retrieve User profile](https://docs.gnosispay.com/api-reference/user/retrieve-user-profile.md): Get the User profile information.
- [Retrieve Message to Sign for Webhook Subscription](https://docs.gnosispay.com/api-reference/webhooks/retrieve-message-to-sign-for-webhook-subscription.md): Generates a message for the user to sign. This message must be sent on `POST /api/v1/webhooks/subscribe/{partnerId}` to subscribe to webhook notifications.
- [Subscribe to Webhooks](https://docs.gnosispay.com/api-reference/webhooks/subscribe-to-webhooks.md): Allows a partner to receive webhook notifications for the authenticated user.
- [Check if authenticated user is subscribed to partner webhooks](https://docs.gnosispay.com/api-reference/webhooks/check-if-authenticated-user-is-subscribed-to-partner-webhooks.md): Allows the authenticated user to check if they are subscribed to a partner's webhook notifications.
- [Generate a new ephemeral token](https://docs.gnosispay.com/api-reference/endpoints/generate-a-new-ephemeral-token.md): Generates a new ephemeral token for secure PCI operations.

## OpenAPI Specs

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