Welcome to the Gratify Partner API documentation
Overview
This Partner API is used by Gratify payment partners to create integrations between the Gratify backend and partner client environments. The Partner API serves as a bridge between Gratify's backend system our partners systems.
As a technical manager or systems architect, understanding the relationships between Gratify Consumers, Merchants, PaymentProviders and other key entities is helpful for effectively utilizing the Gratify API.
- Consumers: Gratify Consumers are end users of the Gratify Pay services. They can access various payment options, including the Buy Now Pay Later (BNPL) scheme and immediate payment. Consumers are required to have a valid email address, mobile number, and supported ecommerce payment method such as a credit card or ACH bank account. The API allows API clients to create and retrieve consumer entities, update consumer details, manage consumer payment methods, and delete consumers.
- Merchants: Merchants are businesses that integrate with Gratify Pay to offer payment services to their customers. The API enables API clients to manage merchant details, create new merchant entities, retrieve specific merchant information, and list available merchants. API clients can also retrieve all orders associated with a specific merchant and process new orders.
- PaymentProviders: PaymentProviders are the financial institutions or services that handle payment transactions. The API supports integrations with different payment providers and allows API clients to retrieve payment gateways associated with a tenant, manage payment methods such as credit cards and bank accounts, and handle payment-related operations for orders. Each payment provider has a group of associated Merchants.
- Orders: Orders are created by merchants and represent a purchase of goods or services by a consumer. The API allows API clients to create new orders, retrieve specific orders, and list orders associated with a specific merchant or consumer.
- Payments: Payments are created when an order is processed. The API enables API clients to retrieve payments associated with a specific order, retrieve specific payments, and perform payment-related operations such as adjustments and refunds.
- PaymentMethods: PaymentMethods are the payment instruments used by consumers to pay for orders. The API allows API clients to create and retrieve payment methods, update payment method details, and delete payment methods.
Key Use Cases
With an understanding of the Gratify entities, the Gratify Partner API provides the solution the following use cases.
Use Case: Whitelabeling Consumer Checkout
Gratify Partners can fully customize and whitelabel their own Consumer Checkout experience. This includes branding the checkout flow with their own logo, colors, and design elements. API clients can also customize the payment options available to consumers, such as Buy Now Pay Later (BNPL) or immediate payment, and enhance the overall user experience.
Use Case: Streamlining Back-Office and Merchant Onboarding
Gratify Partners have the ability to whitelabel the back-offince tools , merchant reporting views or merchant onboarding processes. This allows Partner businesses to provide their own branding and user interface for thier merchants while integrating with the Gratify platform. API clients can customize the merchant onboarding flow, including the collection of required information and verification processes, to align with their own branding and requirements.
Use Case: Other Custom Integrations
API clients can build custom integrations between their own systems and the Gratify platform. This includes integrating with partner systems such as CRM, ERP, or order management systems to optimize data exchange and provide a seamless experience for merchants, consumers and Partner business users.
Lets Get Started!
By utilizing the Gratify Partner API, clients can effectively whitelabel the BNPL Consumer Checkout experience, streamline the back-office tools and merchant onboarding process, and create custom integrations with their client systems.
This enables businesses to provide a branded and tailored experience to their merchants and consumers while leveraging the capabilities of the Gratify platform.
Contact [email protected] to get started!