Create a payment - Hellgate Cloud Platform

POST

payments

Create a payment

curl --request POST \
  --url https://commerce1.on-hellgate.dev/payments \
  --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
}
'

{
  "additional_information": {},
  "amount": 123,
  "continuation": {
    "error": "<string>",
    "success": "<string>"
  },
  "created_at": "2023-11-07T05:31:56Z",
  "currency": "<string>",
  "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "distributions": [
    {
      "amount": 123,
      "description": "<string>",
      "seller_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ],
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "metadata": {},
  "order_id": "<string>",
  "payment_method": {
    "data": {},
    "token": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "processing": {
    "requirement": {
      "action": "<string>",
      "message": "<string>",
      "options": [
        {}
      ]
    }
  },
  "processor": {
    "amount_authorized": 123,
    "amount_captured": 123,
    "amount_refunded": 123,
    "merchant_id": "<string>",
    "name": "<string>"
  },
  "refunds": [
    {
      "amount": 123,
      "created_at": "2023-11-07T05:31:56Z",
      "currency_code": "<string>",
      "distributions": [
        {
          "amount": 123,
          "description": "<string>",
          "seller_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        }
      ],
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "status": "<string>"
    }
  ],
  "settlements": [
    {
      "amount": 123,
      "currency_code": "<string>",
      "date": "2023-11-07T05:31:56Z",
      "settlement_item_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "settlement_report_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "type": "<string>"
    }
  ],
  "transactions": [
    {
      "amount": 123,
      "ended_at": "2023-11-07T05:31:56Z",
      "failure_reasons": [
        {
          "classifier": "<string>",
          "message": "<string>"
        }
      ],
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "processor_name": "<string>",
      "processor_transaction_id": "<string>",
      "started_at": "2023-11-07T05:31:56Z"
    }
  ]
}

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).

X-Idempotency-Key

string

Idempotency key

Body

application/json

Body

PaymentIntentParams
PaymentIntentParams

amount

integer

required

Required range: x >= 0

continuation

object

required

Show child attributes

currency_code

string

required

order_id

string

required

additional_information

object

customer_id

string<uuid>

distributions

object[]

Show child attributes

metadata

object

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

Show child attributes

payment_method

object

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

Show child attributes

vault_payment_method

boolean

When true, customer_id is required.

Response

Success

additional_information

object

amount

integer

continuation

object

Show child attributes

created_at

string<date-time>

currency

string

customer_id

string<uuid>

distributions

DistributionResponse · object[]

Show child attributes

string<uuid>

metadata

object

order_id

string

payment_method

PaymentInstrumentResponse · object

Show child attributes

processing

ProcessingResponse · object

Show child attributes

processor

ProcessorResponse · object

Show child attributes

refunds

RefundResponse · object[]

Show child attributes

settlements

SettlementResponse · object[]

Show child attributes

status

enum<string>

Available options:

OPEN,

AUTHORIZED,

ACCEPTED,

FAILED,

COMPLETED,

VOIDED

transactions

TransactionResponse · object[]

Show child attributes

Get a payment

⌘I

Create a payment

curl --request POST \
  --url https://commerce1.on-hellgate.dev/payments \
  --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
}
'

{
  "additional_information": {},
  "amount": 123,
  "continuation": {
    "error": "<string>",
    "success": "<string>"
  },
  "created_at": "2023-11-07T05:31:56Z",
  "currency": "<string>",
  "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "distributions": [
    {
      "amount": 123,
      "description": "<string>",
      "seller_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ],
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "metadata": {},
  "order_id": "<string>",
  "payment_method": {
    "data": {},
    "token": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "processing": {
    "requirement": {
      "action": "<string>",
      "message": "<string>",
      "options": [
        {}
      ]
    }
  },
  "processor": {
    "amount_authorized": 123,
    "amount_captured": 123,
    "amount_refunded": 123,
    "merchant_id": "<string>",
    "name": "<string>"
  },
  "refunds": [
    {
      "amount": 123,
      "created_at": "2023-11-07T05:31:56Z",
      "currency_code": "<string>",
      "distributions": [
        {
          "amount": 123,
          "description": "<string>",
          "seller_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        }
      ],
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "status": "<string>"
    }
  ],
  "settlements": [
    {
      "amount": 123,
      "currency_code": "<string>",
      "date": "2023-11-07T05:31:56Z",
      "settlement_item_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "settlement_report_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "type": "<string>"
    }
  ],
  "transactions": [
    {
      "amount": 123,
      "ended_at": "2023-11-07T05:31:56Z",
      "failure_reasons": [
        {
          "classifier": "<string>",
          "message": "<string>"
        }
      ],
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "processor_name": "<string>",
      "processor_transaction_id": "<string>",
      "started_at": "2023-11-07T05:31:56Z"
    }
  ]
}