POST — Send Data To Create Or Process Something

POST — Send Data To Create Or Process Something

Used when you want to submit information to the server — for example, to create a payment, start a transaction, or send user details.

In Simple Terms: You are sending data to the system so it can do something with it.

GET — Request Data From The System

GET — Request Data From The System

Used when you want to retrieve information — for example, to check payment status or view transaction details.

In Simple Terms: You are asking the system to give you information.

POST /api/transaction/pay-in

POST /api/transaction/pay-in

Headers

  • KEY-ID – user UUID (required)
  • SIGN – signature of the full request URL concatenated with the request body, signed with your private key (required)
Body (JSON) JSON
{
  "currency": "BTC",
  "provider": "bitpay",
  "amount": 1.0,
  "fail_url": "https://example.com/fail",
  "success_url": "https://example.com/success"
}
200 OK • Example response JSON
{
  "status": "pending",
  "internal_id": "qwertyuiop12345678asdf",
  "pay_url": "https://provider.example/pay/abc123"
}

Returns created transaction and provider invoice URL.

GET /api/transaction

GET /api/transaction

Headers

  • KEY-ID – user UUID (required)
  • SIGN – signature of the full request URL concatenated with the request body, signed with your private key (required)

Query params (all optional)

  • status – "failed" | "success" | "pending"
  • currency – string
  • provider – "bitpay" | "crypto_processing" | "payment_four" | "mollie" | "adyen" | "btcpay"
  • from, to – ISO-8601 datetime
  • limit, offset – integer
  • type – "pay_in" | "pay_out"
200 OK • Example response JSON
[
  {
    "amount": 13.0,
    "currency": {
      "id": 1,
      "name": "EUR"
    },
    "internal_id": "9bd2f186-df45-42e9-82df-908b6078af87",
    "payment_system": {
      "id": 4,
      "name": "bitpay"
    },
    "status": "pending",
    "user": {
      "name": "First Test",
      "uuid": "11111111-1111-1111-1111-111111111111"
    }
  }
]

Returns paginated transactions (fields may vary).

POST /api/transaction/pay-out

POST /api/transaction/pay-out

Headers

  • KEY-ID – user UUID (required)
  • SIGN – signature of the full request URL concatenated with the request body, signed with your private key (required)
Body (JSON) JSON
{
  "address": "bc1qexampleaddresstest000000000000000000",
  "currency": "BTC",
  "provider": "crypto_processing",
  "amount": 1.0e-5,
  "receiver_data": {
    "date_of_birth": "1985-01-12",
    "first_name": "Friedrich",
    "last_name": "Müller"
  },
  "receiver_type": "natural",
  "sender_data": {
    "email": "ops@example.com",
    "country_of_registration": "DEU",
    "legal_name": "Example GmbH"
  },
  "sender_type": "legal",
  "user_uuid": "11111111-1111-1111-1111-111111111111"
}
200 OK • Example response JSON
{
  "status": "pending",
  "transaction_id": "55e7540c-e24a-41ff-beeb-0e042f8ac9ff"
}

Creates a pay-out transaction and returns its status.

You must be logged in to start testing

Testing features are available only for authenticated users. Please sign in to access the test environment.

You must be logged in to start testing

Start testing with confidence

Get a free guide that walks you through every step of the payment gateway testing process.

Download testing manual