Type OB

This integration is not available for all merchants. Check availability with your manager.

What's different from a regular order?

This is a regular order creation in EUR, but you add extra fields in customer. The rest of the fields (amount, currency, successUrl, failUrl, etc.) remain the same as in a regular order creation.

Additional fields for a regular order

Field	Type	Description
`customer`	object	Buyer's data (name, country, email)

Customer object fields

Field	Type	Description
`firstName`	string	First name (required)
`lastName`	string	Last name (required)
`country`	string	Country code for the payment (required)
`email`	string	Buyer's email (optional)

Supported currencies and countries

Country	Currency	Country code
EU countries	`EUR`	ISO 3166-1 alpha-2 (e.g. `DE`)

Example request

{
  "purpose": "Payment for order #1234",
  "amount": "1000.5",
  "externalId": "external_id",
  "externalUserId": "external_user_id",
  "successUrl": "https://example.com",
  "failUrl": "https://example.com",
  "callbackUrl": "https://example.com",
  "currency": "EUR",
  "isFeeOnUser": false,
  "customer": {
    "lastName": "Doe",
    "firstName": "John",
    "country": "DE",
    "email": "john.doe@example.com"
  }
}

Example response

{
  "id": "a1b2c3d4-e5f6-7g8h-i9j0-k1l2m3n4o5p6",
  "status": "CREATED",
  "statusMessage": "Ok",
  "purpose": "Payment for order #1234",
  "amount": "1000.5",
  "currency": "EUR",
  "paymentType": null,
  "shopId": "a1b2c3d4-e5f6-7g8h-i9j0-k1l2m3n4o5p6",
  "terminalId": "a1b2c3d4-e5f6-7g8h-i9j0-k1l2m3n4o5p6",
  "fingerprint": null,
  "ipAddress": null,
  "gatewayTransactionId": null,
  "merchantId": "a1b2c3d4-e5f6-7g8h-i9j0-k1l2m3n4o5p6",
  "externalId": "external_id",
  "externalUserId": "external_user_id",
  "paymentLink": "https://example.com/payment",
  "successUrl": "https://example.com",
  "failUrl": "https://example.com",
  "metadata": null,
  "callbackUrl": "https://example.com",
  "payedAt": null,
  "updatedAt": "2023-03-21T12:34:56Z",
  "createdAt": "2023-03-21T12:34:56Z"
}

Type OB

Before you start

How to authorize your requests

How to create regular orders