Payments

Create payment

Creates a generic developer payment request. This endpoint does not create fulfillable product delivery. Use /dev/v1/orders when you need product line items and Shoppex fulfillment. If webhook is provided, the response includes webhook_secret once; use it to verify the order:paid callback for this specific payment/invoice after the payment reaches COMPLETED. For gateway=PANDABASE or gateway=AUTHORIZENET, Shoppex also creates the provider session and returns checkout_url plus session_id so the payment can complete automatically through the provider webhook flow. For merchant crypto providers (OXAPAY, CRYPTOMUS, NOWPAYMENTS), pass crypto_gateway to return a hosted checkout URL that opens the concrete coin or network directly. Native crypto uses the shop’s non-custodial wallet when crypto_gateway=BITCOIN|LITECOIN|USDT_TRC20|SOLANA|USDT_SOL|USDC_SOL is requested and a native wallet is active for that chain; send gateway=NATIVE_CRYPTO to require that path and fail if it is not configured. Sending crypto_gateway without gateway starts a crypto session on the shop’s active native wallet or connected crypto provider and fails when neither is configured. All crypto payments use the shop’s own accounts; Shoppex-managed white-label crypto has been removed.

POST

dev

payments

Create payment

curl --request POST \
  --url https://api.shoppex.io/dev/v1/payments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "Pandabase Payment",
  "email": "[email protected]",
  "value": 24.99,
  "currency": "USD",
  "gateway": "PANDABASE",
  "return_url": "https://app.example.com/payments/success",
  "cancel_url": "https://app.example.com/payments/cancelled",
  "webhook": "https://app.example.com/webhooks/payments",
  "white_label": false
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    title: 'Pandabase Payment',
    email: '[email protected]',
    value: 24.99,
    currency: 'USD',
    gateway: 'PANDABASE',
    return_url: 'https://app.example.com/payments/success',
    cancel_url: 'https://app.example.com/payments/cancelled',
    webhook: 'https://app.example.com/webhooks/payments',
    white_label: false
  })
};

fetch('https://api.shoppex.io/dev/v1/payments', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.shoppex.io/dev/v1/payments"

payload = {
    "title": "Pandabase Payment",
    "email": "[email protected]",
    "value": 24.99,
    "currency": "USD",
    "gateway": "PANDABASE",
    "return_url": "https://app.example.com/payments/success",
    "cancel_url": "https://app.example.com/payments/cancelled",
    "webhook": "https://app.example.com/webhooks/payments",
    "white_label": False
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.shoppex.io/dev/v1/payments",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'title' => 'Pandabase Payment',
    'email' => '[email protected]',
    'value' => 24.99,
    'currency' => 'USD',
    'gateway' => 'PANDABASE',
    'return_url' => 'https://app.example.com/payments/success',
    'cancel_url' => 'https://app.example.com/payments/cancelled',
    'webhook' => 'https://app.example.com/webhooks/payments',
    'white_label' => false
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.shoppex.io/dev/v1/payments"

	payload := strings.NewReader("{\n  \"title\": \"Pandabase Payment\",\n  \"email\": \"[email protected]\",\n  \"value\": 24.99,\n  \"currency\": \"USD\",\n  \"gateway\": \"PANDABASE\",\n  \"return_url\": \"https://app.example.com/payments/success\",\n  \"cancel_url\": \"https://app.example.com/payments/cancelled\",\n  \"webhook\": \"https://app.example.com/webhooks/payments\",\n  \"white_label\": false\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "data": {
    "uniqid": "33333333-3333-4333-8333-333333333333",
    "url": "https://checkout.shoppex.io/invoice/33333333-3333-4333-8333-333333333333",
    "url_branded": "https://pay.example.com/invoice/33333333-3333-4333-8333-333333333333",
    "checkout_url": "https://secure.pandabase.io/pay/stores/store_1/sids/pb_session_3",
    "session_id": "pb_session_3",
    "total": 24.99,
    "currency": "USD",
    "status": "PENDING",
    "created_at": 1711510800
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "doc_url": "<string>",
    "details": [
      {
        "field": "<string>",
        "message": "<string>"
      }
    ]
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "doc_url": "<string>",
    "details": [
      {
        "field": "<string>",
        "message": "<string>"
      }
    ]
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "doc_url": "<string>",
    "details": [
      {
        "field": "<string>",
        "message": "<string>"
      }
    ]
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "doc_url": "<string>",
    "details": [
      {
        "field": "<string>",
        "message": "<string>"
      }
    ]
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "doc_url": "<string>",
    "details": [
      {
        "field": "<string>",
        "message": "<string>"
      }
    ]
  }
}

Authorizations

Authorization

string

header

required

Use your Shoppex API key in the Authorization header.

Body

title

string

required

Required string length: 1 - 128

string<email>

required

value

number

required

Required range: x >= 0.01

currency

string

required

Required string length: 3

quantity

number

Required range: x >= 1

gateway

string

crypto_gateway

string

cryptoGateway

string

gateways

string[]

confirmations

number

Required range: x >= 1

webhook

string

return_url

string

cancel_url

string

custom_fields

object[]

customFields

object[]

product_id

string

productId

string

items

object[]

cart

string

products

object[]

customer_id

string

fraud_shield

object

Show child attributes

Response

Successful response

data

object

required

Option 1
Option 2

Show child attributes

Create checkout sessionStripe-style alias for `POST /dev/v1/payments`. Accepts `amount`, `success_url`, `cancel_url`, `customer_email`, and a single `product` descriptor; returns a session shape with `id`, `url`, and `status`. Internally delegates to the payments endpoint, so PSP orchestration, scopes, and webhook behavior are identical; `Idempotency-Key` replay is handled by this endpoint and returns the stored session response. For multi-item checkouts, build the cart on your side and call this endpoint with the aggregated amount.

Create payment

curl --request POST \
  --url https://api.shoppex.io/dev/v1/payments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "Pandabase Payment",
  "email": "[email protected]",
  "value": 24.99,
  "currency": "USD",
  "gateway": "PANDABASE",
  "return_url": "https://app.example.com/payments/success",
  "cancel_url": "https://app.example.com/payments/cancelled",
  "webhook": "https://app.example.com/webhooks/payments",
  "white_label": false
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    title: 'Pandabase Payment',
    email: '[email protected]',
    value: 24.99,
    currency: 'USD',
    gateway: 'PANDABASE',
    return_url: 'https://app.example.com/payments/success',
    cancel_url: 'https://app.example.com/payments/cancelled',
    webhook: 'https://app.example.com/webhooks/payments',
    white_label: false
  })
};

fetch('https://api.shoppex.io/dev/v1/payments', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.shoppex.io/dev/v1/payments"

payload = {
    "title": "Pandabase Payment",
    "email": "[email protected]",
    "value": 24.99,
    "currency": "USD",
    "gateway": "PANDABASE",
    "return_url": "https://app.example.com/payments/success",
    "cancel_url": "https://app.example.com/payments/cancelled",
    "webhook": "https://app.example.com/webhooks/payments",
    "white_label": False
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.shoppex.io/dev/v1/payments",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'title' => 'Pandabase Payment',
    'email' => '[email protected]',
    'value' => 24.99,
    'currency' => 'USD',
    'gateway' => 'PANDABASE',
    'return_url' => 'https://app.example.com/payments/success',
    'cancel_url' => 'https://app.example.com/payments/cancelled',
    'webhook' => 'https://app.example.com/webhooks/payments',
    'white_label' => false
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.shoppex.io/dev/v1/payments"

	payload := strings.NewReader("{\n  \"title\": \"Pandabase Payment\",\n  \"email\": \"[email protected]\",\n  \"value\": 24.99,\n  \"currency\": \"USD\",\n  \"gateway\": \"PANDABASE\",\n  \"return_url\": \"https://app.example.com/payments/success\",\n  \"cancel_url\": \"https://app.example.com/payments/cancelled\",\n  \"webhook\": \"https://app.example.com/webhooks/payments\",\n  \"white_label\": false\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "data": {
    "uniqid": "33333333-3333-4333-8333-333333333333",
    "url": "https://checkout.shoppex.io/invoice/33333333-3333-4333-8333-333333333333",
    "url_branded": "https://pay.example.com/invoice/33333333-3333-4333-8333-333333333333",
    "checkout_url": "https://secure.pandabase.io/pay/stores/store_1/sids/pb_session_3",
    "session_id": "pb_session_3",
    "total": 24.99,
    "currency": "USD",
    "status": "PENDING",
    "created_at": 1711510800
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "doc_url": "<string>",
    "details": [
      {
        "field": "<string>",
        "message": "<string>"
      }
    ]
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "doc_url": "<string>",
    "details": [
      {
        "field": "<string>",
        "message": "<string>"
      }
    ]
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "doc_url": "<string>",
    "details": [
      {
        "field": "<string>",
        "message": "<string>"
      }
    ]
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "doc_url": "<string>",
    "details": [
      {
        "field": "<string>",
        "message": "<string>"
      }
    ]
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "doc_url": "<string>",
    "details": [
      {
        "field": "<string>",
        "message": "<string>"
      }
    ]
  }
}

Introduction

Account & Auth

Affiliates

Resellers

Analytics

Blacklist

Categories

Coupons

Customers

Email Marketing

Disputes & Escrow

Groups

Invoices

Licenses

Orders

Payment Links

Payments

Products

Reviews

Security

Store

Themes

Telegram

Subscriptions

Tickets

Webhook Endpoints

Replacements

Create payment

Authorizations

Body

Response