Skip to main content
API docs by Redocly

ND8 API (1.0.0)

Download OpenAPI specification:Download

Payment API flow: create payment (hosted checkout), webhooks (payment status updates), and get payment by id (amount, status, etc.).

Create payment

Start a payment (hosted checkout session)

Create payment (hosted checkout)

Create a payment session (hosted checkout). Returns checkout_url and token. Redirect the customer to checkout_url to complete payment. Requires API key with checkout:create scope.

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required
billing_country
required
string <= 2 characters
billing_postal_code
string
billing_first_name
required
string <= 100 characters
billing_last_name
required
string <= 100 characters
billing_email
required
string <email>
billing_phone
string
currency
required
string
Enum: "USD" "EUR"
required
Array of objects or objects (ProductItem)
successUrl
string <uri>
failedUrl
string <uri>
cancelUrl
string <uri>

Responses

Request samples

Content type
application/json
{
  • "billing_country": "US",
  • "billing_postal_code": "string",
  • "billing_first_name": "string",
  • "billing_last_name": "string",
  • "billing_email": "user@example.com",
  • "billing_phone": "string",
  • "currency": "USD",
  • "products": [
    ],
  • "successUrl": "http://example.com",
  • "failedUrl": "http://example.com",
  • "cancelUrl": "http://example.com"
}

Response samples

Content type
application/json
{}

Get payment

Retrieve payment by ID (amount, status, etc.)

Get payment by ID

Retrieve a payment by its public ID (e.g. TXabc123) or numeric ID. Returns amount, status, currency, products, and timestamps. Requires API key.

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Payment ID — use public ID (e.g. TXabc123) or numeric transaction ID

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "amount": "99.00",
  • "status": "string",
  • "currency": "USD",
  • "payer_email": "user@example.com",
  • "products": [
    ],
  • "created_at": "2019-08-24T14:15:22Z"
}