Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.orkesta.com.tr/llms.txt

Use this file to discover all available pages before exploring further.

This guide walks you through making your first API call and creating a payment with Orkesta. You will be up and running in under 10 minutes.

​
Before you begin

You need the following before starting:
  • An active Orkesta account. Sign up at orkesta.com.tr if you do not have one.
  • An API key from Settings → API Keys in your workspace dashboard.
Use the sandbox base URL https://sandbox.api.orkesta.com.tr/v1 during development. Sandbox payments do not move real funds.

​
Steps

1

Obtain your API key

In your Orkesta workspace, go to Settings → API Keys and click New key. Give the key a name, set an optional expiry date, and click Create.Copy the key immediately — it is shown only once. Store it in an environment variable or a secrets manager.
export ORKESTA_API_KEY="your_api_key_here"
2

Make your first API call

Verify your key is working by fetching your accounts list.
curl -X GET https://api.orkesta.com.tr/v1/accounts \
  -H "Authorization: Bearer YOUR_API_KEY"
A successful response returns an array of account objects:
[
  {
    "id": "acc_01hx3k9qze4p7vb2ntcm6d8faj",
    "name": "Main Operating Account",
    "currency": "TRY",
    "balance": 125000.00
  },
  {
    "id": "acc_01hx3kbr7mfq2wc5gtdn9e0spu",
    "name": "Payables Account",
    "currency": "TRY",
    "balance": 48750.50
  }
]
3

Create a payment

Send a POST request to /payments with the payment details in the request body. Use the account IDs returned in the previous step.
curl -X POST https://api.orkesta.com.tr/v1/payments \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "amount": 1500,
    "currency": "TRY",
    "method": "bank_transfer",
    "from_account": "acc_xxxx",
    "to_account": "acc_yyyy",
    "description": "Invoice #1001"
  }'
Orkesta creates the payment and returns it with a pending status:
{
  "id": "pay_01hx3m2n4qvw8yz6ruet7c5dbk",
  "amount": 1500,
  "currency": "TRY",
  "method": "bank_transfer",
  "status": "pending",
  "description": "Invoice #1001",
  "created_at": "2026-05-20T09:14:33Z"
}
4

Check the payment status

Use the payment id from the previous response to poll the payment’s current status.
curl -X GET https://api.orkesta.com.tr/v1/payments/pay_01hx3m2n4qvw8yz6ruet7c5dbk \
  -H "Authorization: Bearer YOUR_API_KEY"
The response includes the current status and any updates since creation:
{
  "id": "pay_01hx3m2n4qvw8yz6ruet7c5dbk",
  "amount": 1500,
  "currency": "TRY",
  "method": "bank_transfer",
  "status": "completed",
  "description": "Invoice #1001",
  "created_at": "2026-05-20T09:14:33Z",
  "completed_at": "2026-05-20T09:15:01Z"
}

​
Next steps

Authentication

Learn about key scopes, rotation, and error handling.

Payments overview

Explore all payment methods and lifecycle states.

API reference

Full reference for every Orkesta endpoint.