# Gratify Pay Documentation

> Documentation for Gratify Pay

## Guides
- [Overview](https://docs.gratifypay.com/docs/features.md)
- [Configuration](https://docs.gratifypay.com/docs/configuration.md)
- [Data Sources](https://docs.gratifypay.com/docs/data-sources.md)
- [User Identity](https://docs.gratifypay.com/docs/user-identity.md)
- [Business Verification](https://docs.gratifypay.com/docs/business-verification.md)
- [Anti-Money Laundering (AML)](https://docs.gratifypay.com/docs/aml.md)
- [Fraud Detection](https://docs.gratifypay.com/docs/fraud.md)
- [Financial Verification](https://docs.gratifypay.com/docs/financial.md)
- [Document Analysis](https://docs.gratifypay.com/docs/document-analysis.md)
- [Custom Data Sources](https://docs.gratifypay.com/docs/custom.md)
- [Evidence](https://docs.gratifypay.com/docs/evidence.md)
- [Continuous Monitoring](https://docs.gratifypay.com/docs/continuous-monitoring.md)
- [What Is Gratify BNPL?](https://docs.gratifypay.com/docs/what-is-gratify-pay.md)
- [Platforms](https://docs.gratifypay.com/docs/platforms.md): Here you will learn about the e-commerce platforms that Gratify Pay integrates with.
- [Get Your Credentials](https://docs.gratifypay.com/docs/get-your-credentials.md)
- [Custom ECOM Integrations](https://docs.gratifypay.com/docs/custom-ecom-integrations.md)
- [White Label BNPL](https://docs.gratifypay.com/docs/white-label-bnpl.md)

## API Reference
- [Overview](https://docs.gratifypay.com/reference/overview-1.md)
- [Key Concepts](https://docs.gratifypay.com/reference/key-concepts.md)
- [Using the API](https://docs.gratifypay.com/reference/using-the-api.md)
- [Create a new merchant](https://docs.gratifypay.com/reference/post_merchants-1.md): Creates a new merchant entity. Updating merchants with inputs will trigger KYB data processing
- [List all merchants](https://docs.gratifypay.com/reference/get_merchants-1.md): Retrieves all merchants reverse sorted by creation date. Supports pagination and optional filtering by date range.
- [Retrieve a merchant](https://docs.gratifypay.com/reference/getmerchant.md): Retrieves details of a merchant identified by `merchantId`.
- [Update an existing merchant](https://docs.gratifypay.com/reference/patch_merchants-merchantid.md): Updates the details of an existing merchant identified by the `merchantId`.
- [Delete a merchant](https://docs.gratifypay.com/reference/delete_merchants-merchantid-1.md): Deletes a merchant entity identified by the `merchantId`.
- [Retrieve all inputs for a merchant](https://docs.gratifypay.com/reference/get_merchants-merchantid-inputs.md): Fetches all input data associated with a specific merchant, identified by the provided merchantId.   The inputs represent the data submitted for processing under the merchant's account.
- [Create or update input data for a merchant](https://docs.gratifypay.com/reference/put_merchants-merchantid-inputs.md): Allows creating new input data or updating existing input data for a specific merchant.   The input data can be submitted as a single object or an array of objects, depending on the use case.   Each input represents data submitted for processing under the merchant's account.
- [Create a temporary presigned POST URL for file upload](https://docs.gratifypay.com/reference/post_merchants-merchantid-inputs-file.md): Generates a temporary presigned POST URL for uploading files to Gratify. This operation requires the `key` (referencing the Input key) and `ext` (file extension) in the request body.
- [Retrieve all KYB results for a merchant](https://docs.gratifypay.com/reference/get_merchants-merchantid-results.md): Retrieves all KYB results generated from processing the provided input data using enrich, verify, analyze, and action configurations.
- [Delete KYB results by key](https://docs.gratifypay.com/reference/delete_merchants-merchantid-results.md): Deletes KYB results identified by the provided keys. The `keys` must be passed in the request body as an array
- [Create or overwrite KYB results](https://docs.gratifypay.com/reference/put_merchants-merchantid-results.md): Creates or overwrites multiple KYB results based on the array of results provided in the request body.  Each result in the array must include all required details. The `merchantId` is required as a path parameter.
- [Generate a presigned URL to download evidence](https://docs.gratifypay.com/reference/post_merchants-merchantid-results-key-auth.md): Generates a temporary presigned GET URL for downloading evidence files from Gratify. This operation requires the `key` (referencing the Result key) and `merchantId` in the path.
- [Retrieve all KYB configurations](https://docs.gratifypay.com/reference/get_configs.md): Fetches a list of all KYB configurations - including input, enrich, verify, analyze and action configurations. User this API to access configured input and result keys and review   The response will include one or more consumers that were found and returned. If no consumers are found, an empty list will be returned.
- [Retrieve a KYB configuration by key](https://docs.gratifypay.com/reference/get_configs-key.md): Fetches a specific KYB configuration based on the provided `key`. This allows access to a single configuration for input, enrich, verify, analyze, or action operations.  Use this API to review a configuration based on its unique key.
- [Welcome](https://docs.gratifypay.com/reference/overview.md): Welcome to the Gratify Partner API documentation
- [Getting Started](https://docs.gratifypay.com/reference/getting-started.md): Technical steps to get started
- [Retrieve all consumers](https://docs.gratifypay.com/reference/get_consumers.md): Fetches a list of Gratify consumers or end users that can be filtered by the optional email parameter.  Use this API call to access all registered consumers in the Gratify system or partner environment.  You can optionally provide an email parameter to filter the results and retrieve only the consumers with matching email addresses.   The response will include one or more consumers that were found and returned. If no consumers are found, an empty list will be returned.
- [Create a new consumer](https://docs.gratifypay.com/reference/post_consumers.md): Creates a new consumer entity in the Gratify system or partner environment.  The consumer entity is required to have a valid email address and mobile phone number and provide a supported ecommerce method for payment - either a credit card or an ACH bank account.
- [Retrieve a specific consumer](https://docs.gratifypay.com/reference/getconsumer.md): Fetches the details of a consumer identified by the `consumerId`.
- [Update an existing consumer](https://docs.gratifypay.com/reference/put_consumers-consumerid.md): Updates the details of an existing consumer identified by the `consumerId`.
- [Delete a consumer](https://docs.gratifypay.com/reference/delete_consumers-consumerid.md): Deletes a consumer identified by the `consumerId`.
- [Retrieve payment methods for a consumer](https://docs.gratifypay.com/reference/get_consumers-consumerid-payment-methods.md): Fetches the list of payment methods associated with a consumer identified by `consumerId`.
- [Update a payment method for a consumer](https://docs.gratifypay.com/reference/put_consumers-consumerid-payment-methods-paymentmethodid.md): Updates an existing payment method for a consumer, identified by `paymentMethodId`.
- [Delete a payment method for a consumer](https://docs.gratifypay.com/reference/delete_consumers-consumerid-payment-methods-paymentmethodid.md): Deletes an existing payment method for a consumer, identified by `paymentMethodId`. The payment method can only be deleted if it is not part of an ongoing order.
- [Retrieve a specific payment method for a consumer](https://docs.gratifypay.com/reference/get_consumers-consumerid-payment-methods-paymentmethodid.md): Fetches the details of a specific payment method associated with a consumer.
- [Retrieve consumer's orders](https://docs.gratifypay.com/reference/get_consumers-consumerid-orders.md): Retrieves all orders associated with a specific consumer, identified by `consumerId`.
- [List all accessible merchants](https://docs.gratifypay.com/reference/get_merchants.md): Retrieves a list of merchants.
- [Create a new merchant](https://docs.gratifypay.com/reference/post_merchants.md): Creates a new merchant entity, specifying the payment gateway to be used.
- [Retrieve a specific merchant](https://docs.gratifypay.com/reference/get_merchants-merchantid.md): Retrieves details of a merchant identified by the `merchantId`.
- [Update an existing merchant](https://docs.gratifypay.com/reference/put_merchants-merchantid.md): Updates the details of an existing merchant identified by the `merchantId`.
- [Delete a merchant](https://docs.gratifypay.com/reference/delete_merchants-merchantid.md): Deletes a merchant entity identified by the `merchantId`.
- [Retrieve merchant's orders](https://docs.gratifypay.com/reference/get_merchants-merchantid-orders.md): Retrieves all orders associated with a specific merchant, identified by `merchantId`.
- [Create a new order](https://docs.gratifypay.com/reference/post_orders.md): Creates a new order specifying the merchantId, consumerId, and payment method in the request body. Additional order-related fields should also be provided.
- [Retrieve an order by ID](https://docs.gratifypay.com/reference/get_orders-orderid.md): Retrieves the details of an order identified by `orderId`.
- [Process an order](https://docs.gratifypay.com/reference/post_orders-orderid-process.md): Kicks off order processing. Creates payment plan and charges first payment to payment-method defined on the order
- [Cancel an order which has not started processing yet](https://docs.gratifypay.com/reference/post_orders-orderid-cancel.md): Cancel an order which has not started processing yet. If order already started processing, this will return and error
- [Change payment method for a processing order.](https://docs.gratifypay.com/reference/post_orders-orderid-change-payment-method.md): Update the payment method for a processing order. New Payment method must belong to the same consumerId as the current payment method associated with the order. If the payment method is of type CREDIT_CARD, supply a valid cvvToken acquired by calling /orders/{orderId}/cvv in Secure PaymentData API. For a CREDIT_CARD payment method this will also immediately process the next payment.
- [List payments for a specific order](https://docs.gratifypay.com/reference/get_orders-orderid-payments.md): Retrieves all payments associated with a specific order, identified by `orderId`.
- [Retrieve a specific payment for an order](https://docs.gratifypay.com/reference/get_orders-orderid-payments-paymentid.md): Retrieves details of a specific payment for an order, identified by `paymentId` or `instalmentNumber`.
- [Adjust a specific payment for an order](https://docs.gratifypay.com/reference/post_orders-orderid-payments-paymentid-adjustment.md): Makes an adjustment to a specific payment, identified by `paymentId` or `instalmentNumber`, for an order.
- [Refund a specific payment for an order](https://docs.gratifypay.com/reference/post_orders-orderid-payments-paymentid-refund.md): Initiates a refund for a specific payment, identified by `paymentId` or `instalmentNumber`, for an order.
- [Schedule a specific payment for an order](https://docs.gratifypay.com/reference/post_orders-orderid-payments-paymentid-schedule.md): Schedules a specific payment, identified by `paymentId` or `instalmentNumber`, for an order.
- [List available payment gateway configurations](https://docs.gratifypay.com/reference/get_gateways.md): Retrieves a list of payment gateways that can be configured by the super admin for a tenant.
- [Create and securely store payment method information for a consumer](https://docs.gratifypay.com/reference/post_consumers-consumerid-payment-methods.md): Adds a new payment method for a consumer. The payment method can be either a CREDIT_CARD or BANK_ACCOUNT.
- [Securely store a CVV for a CREDIT_CARD payment method for the order](https://docs.gratifypay.com/reference/post_orders-orderid-cvv.md): Securely stores a CVV for a CREDIT_CARD payment method for a limited time to be used with the specified order. Use the returned cvvToken to execute processing of an order.
- [Adding Gratify to your Cart](https://docs.gratifypay.com/reference/integrating-into-your-cart.md)
- [Retrieve merchant settings](https://docs.gratifypay.com/reference/get_.md): This will retrieve the merchant object based on the authenticated merchant, which contains configuration values for the merchant. It also contains generic payment schedule details which are used in the offer text generation.
- [Retrieves a Payment Schedule Preview](https://docs.gratifypay.com/reference/get_payment-schedule.md): This will retrieve the specific payment schedule for this purchase, considering various Gratify merchant configurable values not visible to the plugin.
- [Create a Gratify Order](https://docs.gratifypay.com/reference/post_order-initialize.md): This will create a Gratify order. You pass in a return URL on success, shopping cart details, shipping details, etc. and receive an order map id. Once this API call is completed, the user should be redirected to the Gratify web app with this orderMapId as a parameter( ?o= ) to complete the purchase.
- [Refund a Gratify Order](https://docs.gratifypay.com/reference/post_order-refund.md): This will refund a Gratify order. A refund requires the order id, the amount, and a merchant refund ID for cross reference.