Skip to main content
POST
/
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": "<string>",
  "email": "[email protected]",
  "value": 1.01,
  "currency": "<string>",
  "quantity": 1,
  "gateway": "<string>",
  "gateways": [
    "<string>"
  ],
  "confirmations": 1,
  "webhook": "<string>",
  "return_url": "<string>",
  "cancel_url": "<string>",
  "white_label": true,
  "custom_fields": [
    {}
  ],
  "customerId": "<string>",
  "fraud_shield": {
    "ip": "<string>",
    "user_agent": "<string>",
    "user_language": "<string>"
  },
  "product_addons": [
    {}
  ],
  "product_variants": [
    {}
  ]
}
'
{
  "data": {
    "url": "<string>",
    "url_branded": "<string>",
    "uniqid": "<string>",
    "id": "<string>",
    "shop_id": "<string>",
    "type": "<string>",
    "customer_id": "<string>",
    "gateway": "<string>",
    "gateways": [
      "<string>"
    ],
    "quantity": 123,
    "total": 123,
    "total_display": 123,
    "currency": "<string>",
    "exchange_rate": 123,
    "crypto_exchange_rate": 123,
    "customer_email": "<string>",
    "crypto_address": "<string>",
    "crypto_amount": 123,
    "crypto_received": 123,
    "crypto_uri": "<string>",
    "crypto_confirmations_needed": 123,
    "custom_fields": [
      "<unknown>"
    ],
    "is_developer_invoice": true,
    "developer_title": "<string>",
    "developer_webhook": "<string>",
    "developer_return_url": "<string>",
    "developer_cancel_url": "<string>",
    "status": "<string>",
    "created_at": 123,
    "updated_at": 123
  }
}

Authorizations

Authorization
string
header
required

Use your API key with the Bearer scheme. Get your key from Dashboard → Settings → API Keys. Format: Authorization: Bearer shx_...

Body

application/json
title
string
required
Required string length: 1 - 128
email
string<email>
required
value
number
required
Required range: x >= 0.01
currency
string
required
Required string length: 2 - 10
quantity
integer
default:1
Required range: x >= 1
gateway
string
gateways
string[]
confirmations
integer
default:1
Required range: x >= 0
webhook
string<uri>
Maximum string length: 255
return_url
string<uri>
Maximum string length: 255
cancel_url
string<uri>
Maximum string length: 500
white_label
boolean
default:true
custom_fields
object[]
customerId
string
Maximum string length: 255
fraud_shield
object
product_addons
object[]
product_variants
object[]

Response

Default Response

data
object
required