Quickstart Guide

This guide walks you through the essential first steps to integrate with Cashii: setting up your accounts and making your first API calls to create and check payments. For a deeper understanding, refer to:

Authentication: Generating and using API keys.
Core Concepts: Understanding Remote Payments and workflows.
Payment Flow: Handling user redirection and callbacks.

1. Account Setup

Before you can use the API, you need the correct Cashii accounts.

Creating a personal account

First, ensure you have a verified Cashii personal account. Follow the steps outlined in the account creation video if you don’t have one.

Request a commercial account

Next, you need a commercial account to generate API keys. Request one from your personal account using this guide:

Once your commercial account is approved, you can proceed to generate an API key as described in the Authentication guide.

2. Basic API Calls

With your API key, you can now interact with the Remote Payments API.

Create a Remote Payment

This is the fundamental step to initiate a payment request. Endpoint: POST /api/v1/remote-payments Host: https://api.cashii.app Headers: Authorization: Bearer YOUR_API_KEY Request Body:

{
  "amount": 10098, // 100.98 in the specified currency (smallest unit)
  "currency": "SYP", // e.g., SYP, USD, TRY, EUR
  "note": "Payment for Order #ORD-12345",
  "metadata": { // Optional: Store your internal references
    "orderId": "ORD-12345",
    "customerId": "CUST-678"
  }
}

curl -X POST https://api.cashii.app/api/v1/remote-payments \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
        "amount": 10098,
        "currency": "SYP",
        "note": "Payment for Order #ORD-12345",
        "metadata": {
          "orderId": "ORD-12345",
          "customerId": "CUST-678"
        }
      }'

{
  "amount": 10098, // 100.98
  "currency": "SYP",
  "note": "Payment for Order #ORD-12345",
  "metadata": {
    "orderId": "ORD-12345",
    "customerId": "CUST-678"
  }
}

Successful Response (201 Created): Cashii returns the unique id for this payment request.

{
  "data": {
    "id": "1234567890123456" // Store this ID!
  }
}

{
  "data": {
    "id": "1234567890123456"
  }
}

You’ll use this id to redirect the user. See Payment Flow.

Retrieve Remote Payment Information

Use this endpoint to check the status and details of a payment request, especially after the user returns to your site. Endpoint: GET /api/v1/remote-payments/{paymentId} Host: https://api.cashii.app Headers: Authorization: Bearer YOUR_API_KEY Path Parameter:

paymentId: The 16-digit ID obtained when creating the payment.

curl https://api.cashii.app/api/v1/remote-payments/1234567890123456 \
  -H "Authorization: Bearer YOUR_API_KEY"

Successful Response (200 OK): Returns the full details of the Remote Payment, including the crucial status.

{
  "data": {
    "_id": "1234567890123456",
    "amount": 10098,
    "currency": "SYP",
    "status": "paid", // Check this status!
    "to": "YOUR_COMMERCIAL_ACCOUNT_NUMBER",
    "from": "CUSTOMER_ACCOUNT_NUMBER", // Populated after payment
    "note": "Payment for Order #ORD-12345",
    "metadata": {
      "orderId": "ORD-12345",
      "customerId": "CUST-678"
    },
    // ... other fields like timestamps
  }
}

{
  "data": {
    "_id": "1234567890123456",
    "amount": 10098,
    "currency": "SYP",
    "status": "paid",
    "to": "YOUR_COMMERCIAL_ACCOUNT_NUMBER",
    "from": "CUSTOMER_ACCOUNT_NUMBER",
    "note": "Payment for Order #ORD-12345",
    "metadata": {
      "orderId": "ORD-12345",
      "customerId": "CUST-678"
    }
  }
}

This call is essential for server-side verification of the payment status. See Payment Flow.

Next Steps

Explore the full API Reference for all available endpoints and details.
Review the Payment Flow guide for handling user redirection.
Consult the Glossary for term definitions.

Introduction

Integration Guide

Quickstart Guide

1. Account Setup

2. Basic API Calls

Create a Remote Payment

Retrieve Remote Payment Information

Next Steps

​1. Account Setup

​2. Basic API Calls

​Create a Remote Payment

​Retrieve Remote Payment Information

​Next Steps

1. Account Setup

2. Basic API Calls

Create a Remote Payment

Retrieve Remote Payment Information

Next Steps