API Overview & Reference

The Swipe Aras API allows you to integrate payment acceptance, transaction queries, refunds, and account management directly into your systems.

The Swipe Aras API allows you to integrate payment acceptance, transaction queries, refunds, and account management directly into your own systems.

Full API Reference

📘 api.araspayment.com/api-docs The full OpenAPI specification — all endpoints, request/response schemas, and live examples.

Base URL

https://api.araspayment.com/api/v1

API Coverage

The Swipe Aras API covers four main areas:

Tag

What It Does

Onboarding

Create accounts, check status, generate hosted onboarding links

Stores

Query stores by account holder

Checkout

Create and manage checkout sessions

Transactions

Query transactions and issue refunds

Getting Started with the API

  1. Create an API key in your dashboard — see Authentication & API Keys

  2. Make your first request using the X-API-Key header

  3. Reference the full spec for endpoint details

Request Format

All POST, PUT, and PATCH requests require:

Content-Type: application/json

All requests require authentication via the X-API-Key header.

Did this answer your question?
😞
😐
😁