Getting Started

Introduction

Selamat datang di OrcaPay API — dokumentasi resmi untuk mengintegrasikan payment gateway OrcaPay ke dalam aplikasi Anda.

1 Tentang OrcaPay API

OrcaPay API adalah layanan REST yang memungkinkan Anda untuk membuat transaksi deposit, penarikan saldo (withdraw), dan memeriksa saldo akun secara programatik. Semua endpoint menggunakan protokol HTTPS dan mengembalikan response dalam format JSON.

Base URL

https://orcapay.web.id

2 Fitur Utama

Deposit

Buat request deposit, cek status, dan batalkan deposit kapan saja.

Withdraw

Lihat daftar provider, ajukan penarikan saldo, dan cek statusnya.

Balance

Periksa saldo akun Anda secara real-time melalui endpoint.

Security

Dilindungi API Key & IP whitelist untuk keamanan maksimal.

3 Autentikasi

Setiap request ke API harus menyertakan API Key Anda di header X-API-Key. API Key dapat Anda ambil dari halaman Profile pada dashboard OrcaPay.

HTTP Headers

Content-Type: application/json
X-API-Key: YOUR_API_KEY

Jaga Kerahasiaan API Key

Jangan pernah membagikan API Key Anda kepada siapa pun. Jika merasa bocor, segera reset di halaman Profile.

4 Format Response

Semua endpoint mengembalikan response dengan struktur konsisten:

JSON

{
  "success": true,
  "data": { ... },
  "message": "Success message"
}

Field	Type	Description
success	boolean	Status keberhasilan request (true/false)
data	object	Data payload (bisa berupa object, array, atau null)
message	string	Pesan human-readable (muncul di error atau info)

5 Contoh Request Pertama

Berikut contoh request untuk memeriksa saldo akun Anda:

GET /api/balance

cURL

curl -X GET "https://orcapay.web.id/api/balance" \
  -H "X-API-Key: YOUR_API_KEY"

6 Error Handling

API menggunakan HTTP status code standar untuk menandakan status request:

Status	Description
200 OK	Request berhasil
400 Bad Request	Parameter tidak lengkap atau tidak valid
401 Unauthorized	API Key tidak valid atau tidak disertakan
403 Forbidden	IP tidak diizinkan (whitelist)
404 Not Found	Resource tidak ditemukan
500 Server Error	Terjadi kesalahan pada server

7 Langkah Selanjutnya

Sekarang Anda sudah siap untuk mulai menggunakan OrcaPay API! Jelajahi dokumentasi endpoint berikutnya:

Deposit — Buat, cek status, dan batalkan transaksi deposit
Withdraw — Lihat provider, ajukan penarikan, cek status
Balance — Periksa saldo akun Anda

Back to Docs Deposit