Skip to main content
POST
/
payments-verification
Verify a payment
curl --request POST \
  --url https://commerce1.on-hellgate.dev/payments-verification \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "amount": 1,
  "continuation": {
    "error": "<string>",
    "success": "<string>"
  },
  "currency_code": "<string>",
  "order_id": "<string>",
  "additional_information": {},
  "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "distributions": [
    {
      "amount": 2,
      "seller_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "description": "<string>"
    }
  ],
  "metadata": {},
  "vault_payment_method": true
}
'
{
  "amount": 1,
  "continuation": {
    "error": "<string>",
    "success": "<string>"
  },
  "currency_code": "<string>",
  "order_id": "<string>",
  "additional_information": {},
  "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "distributions": [
    {
      "amount": 2,
      "seller_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "description": "<string>"
    }
  ],
  "metadata": {},
  "payment_method": {
    "type": "FIRST_PAYMENT",
    "first_payment_reference": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "token": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "vault_payment_method": true
}

Authorizations

X-API-Key
string
header
required

Headers

X-Account-ID
string

Identifies the account. Required when authenticating via mTLS — omit when using an API key (account is inferred from the key).

Body

application/json

Body

amount
integer
required
Required range: x >= 0
continuation
object
required
currency_code
string
required
order_id
string
required
additional_information
object
customer_id
string<uuid>
distributions
object[]
metadata
object

Key-value pairs. Max 20 entries. Keys max 20 characters, values must be strings max 80 characters. No nested objects.

payment_method
object

Token is required for all types except BANK_TRANSFER. For BANK_TRANSFER, token must not be provided.

vault_payment_method
boolean

When true, customer_id is required.

Response

Success

amount
integer
required
Required range: x >= 0
continuation
object
required
currency_code
string
required
order_id
string
required
additional_information
object
customer_id
string<uuid>
distributions
object[]
metadata
object

Key-value pairs. Max 20 entries. Keys max 20 characters, values must be strings max 80 characters. No nested objects.

payment_method
object

Token is required for all types except BANK_TRANSFER. For BANK_TRANSFER, token must not be provided.

vault_payment_method
boolean

When true, customer_id is required.