OpenAPI 3.1.04 эндпоинта

Northstar Payments API

Create and retrieve payments in the Northstar sandbox.

Скачать точную спецификациюЗакреплена за этой рабочей публикацией

Версия2.4.0

Base URLhttps://sandbox-api.northstar.example

Показать 1 сервер

https://sandbox-api.northstar.example
Sandbox

Безопасный обозреватель

Try It выполняет только локальную симуляцию в браузере, не обращается к указанным серверам и не сохраняет учётные данные.

Эндпоинты

GET

List payments

/v1/payments

ID операции listPayments

Ответы

200Ответ 200

A paginated list of payments

POST

Create a payment

/v1/payments

Creates a payment and returns its current processing state.

ID операции createPayment

Тело запроса обязательно

application/json

Схема

{
  "type": "object",
  "required": [
    "amount",
    "currency"
  ],
  "properties": {
    "amount": {
      "type": "integer",
      "minimum": 1,
      "description": "Amount in the currency's minor unit."
    },
    "currency": {
      "type": "string",
      "pattern": "^[A-Z]{3}$"
    },
    "reference": {
      "type": "string",
      "maxLength": 128
    }
  }
}

Пример

{
  "amount": 4200,
  "currency": "USD",
  "reference": "order_1048"
}

Ответы

201Ответ 201

Payment created

application/json

Схема

{
  "type": "object",
  "required": [
    "id",
    "amount",
    "currency",
    "status",
    "created_at"
  ],
  "properties": {
    "id": {
      "type": "string",
      "example": "pay_01JQ4Z8K7VMG2"
    },
    "amount": {
      "type": "integer",
      "example": 4200
    },
    "currency": {
      "type": "string",
      "example": "USD"
    },
    "status": {
      "type": "string",
      "enum": [
        "pending",
        "succeeded",
        "failed",
        "refunded"
      ]
    },
    "created_at": {
      "type": "string",
      "format": "date-time"
    }
  }
}

Пример

{
  "id": "pay_01JQ4Z8K7VMG2",
  "amount": 4200,
  "currency": "USD",
  "status": "pending",
  "created_at": "2026-01-01T00:00:00Z"
}

400Ответ 400

Invalid request

401Ответ 401

Missing or invalid credentials

GET

Retrieve a payment

/v1/payments/{paymentId}

ID операции getPayment

Параметры

Имя	Расположение	Тип	Описание
`paymentId`обязательно	path	`string`	—

Ответы

200Ответ 200

Payment found

application/json

Схема

{
  "type": "object",
  "required": [
    "id",
    "amount",
    "currency",
    "status",
    "created_at"
  ],
  "properties": {
    "id": {
      "type": "string",
      "example": "pay_01JQ4Z8K7VMG2"
    },
    "amount": {
      "type": "integer",
      "example": 4200
    },
    "currency": {
      "type": "string",
      "example": "USD"
    },
    "status": {
      "type": "string",
      "enum": [
        "pending",
        "succeeded",
        "failed",
        "refunded"
      ]
    },
    "created_at": {
      "type": "string",
      "format": "date-time"
    }
  }
}

Пример

{
  "id": "pay_01JQ4Z8K7VMG2",
  "amount": 4200,
  "currency": "USD",
  "status": "pending",
  "created_at": "2026-01-01T00:00:00Z"
}

404Ответ 404

Payment not found

POST

Refund a payment

/v1/payments/{paymentId}/refunds

ID операции refundPayment

Ответы

201Ответ 201

Refund created

Схемы

CreatePaymentRequestobject

3 свойства · обязательных: 2

Paymentobject

5 свойств · обязательных: 5