Quickstart Guide

Get up and running with fype in under 10 minutes. This guide will walk you through creating your first test payment.

Prerequisites

A fype Merchant account.
Your fype API Key (Test mode).

1. Get Your API Key

Log in to the fype Dashboard.
Navigate to Developers > API Keys.
Create a new Test Key.
Copy the key (it starts with fype_test_).

2. Create a Payment

Use the fype API to create a payment. You can use curl or one of our SDKs.

Using cURL

curl -X POST https://api.fype.dev/v1/payments \
 -H "Authorization: Bearer YOUR_TEST_KEY" \
 -H "Content-Type: application/json" \
 -d '{
 "amount": 50000,
 "currency": "INR",
 "customer_email": "customer@example.com",
 "success_url": "https://your-site.com/success?id={CHECKOUT_SESSION_ID}",
 "cancel_url": "https://your-site.com/cancel",
 "reference_id": "order_12345"
 }'

Note: Amounts are in the smallest currency unit (e.g., 50000 paise = ₹500.00).

3. Redirect the Customer

The API response will contain a checkout_url:

{
 "id": "...",
 "status": "created",
 "checkout_url": "https://checkout.fype.dev/checkout/8ec7...",
 "amount": 50000,
 "currency": "INR"
}

Redirect your customer to this URL.

4. Simulate Success (Test Mode)

Since you are in test mode, the checkout page will show a “Simulator” gateway.

Click Simulate Success.
fype will transition the payment to succeeded.
You will be redirected back to your success_url.

5. Verify the Payment

You can verify the status of the payment via API:

curl https://api.fype.dev/v1/payments/PAYMENT_ID \
 -H "Authorization: Bearer YOUR_TEST_KEY"

Next: Learn about Webhooks to automate your order fulfillment.

​Quickstart Guide

​Prerequisites

​1. Get Your API Key

​2. Create a Payment

​Using cURL

​3. Redirect the Customer

​4. Simulate Success (Test Mode)

​5. Verify the Payment