Quickstart

This guide walks you through creating your first payment and checking its status. You'll need your API keys.

1. Create a payment

Send a POST request to /payments with the amount, currency, requisite type and customer.

Use the Idempotency-Key header so a retried request never creates a duplicate payment.

2. Read the response

The payment is returned immediately with a status of processing:

{
  "data": {
    "id": "txn_2n1TLgiZFvF7DZuL",
    "type": "payment",
    "requested": {
      "amount": "1000.00",
      "currency": "XTS"
    },
    "initialized": {
      "amount": "1000.00",
      "currency": "XTS"
    },
    "processed": {
      "amount": "0.00",
      "currency": "XTS"
    },
    "refunded": {
      "amount": "0.00",
      "currency": "XTS"
    },
    "requisite": {
      "type": "card",
      "card": "4242424242424242",
      "holder": "Test User",
      "bank": "Test Bank"
    },
    "status": "processing",
    "status_code": "processing",
    "created_at": "2026-01-01T00:21:56Z",
    "expires_at": "2026-01-01T00:22:56Z",
    "finalized_at": null,
    "metadata": {}
  }
}

Store the returned id — you'll use it to track the payment.

3. Check the status

The payment settles asynchronously. Retrieve it by id to see its current status:

When the payment reaches a terminal status such as paid, it's settled:

{
  "data": {
    "id": "txn_2n1TLgiZFvF7DZuL",
    "type": "payment",
    "requested": {
      "amount": "1000.00",
      "currency": "XTS"
    },
    "initialized": {
      "amount": "1000.00",
      "currency": "XTS"
    },
    "processed": {
      "amount": "1000.00",
      "currency": "XTS"
    },
    "refunded": {
      "amount": "0.00",
      "currency": "XTS"
    },
    "requisite": {
      "type": "card",
      "card": "4242424242424242",
      "holder": "Test User",
      "bank": "Test Bank"
    },
    "status": "paid",
    "status_code": "paid",
    "created_at": "2026-01-01T00:21:56Z",
    "expires_at": "2026-01-01T00:22:56Z",
    "finalized_at": "2026-01-01T00:34:12Z",
    "metadata": {}
  }
}

1. Create a payment#

2. Read the response#

3. Check the status#

1. Create a payment

2. Read the response

3. Check the status