[GET] Get payment data

Request description

GET /v1/order/[order id]

The request allows you to get payment data.

This request can also be used to get order data created via Noventiq Checkout. 

Connection Data

• Endpoint URL:

  • Production environment: https://api.ecommerce.noventiq.com/v1/order

  • Test environment: https://api.ecommerce.noventiq.com.demonqweb.com/v1/order

• Request Method: GET

• Authorization: token-based

URL Parameters

[order id]

required

Payment identifier (Payment ID)

You can get it from:

• Response to a request for creating payment object (order_id) or auto-payment processing (order_id)

• Webhooks (order_id)

• Response to a request for getting a list of payments (ids)

Example: /v1/order/123456

Header Parameters

AuthorizationJWT

required

Authorization token

• Format: Bearer [token]

• Replace [token] with the token value you get in response to the request sent to the Authentication API

Request Example

GET https://api.ecommerce.noventiq.com/v1/order/123456

Response Description

In response to the request, you receive the server response code corresponding to the processing result. Depending on the code, the response body may contain additional parameters.

Successful Response

If processing is successful, the following will return in response server response code: HTTP/1.1 200 OК and the payment data  in JSON format.

Response contains:

• General data

• Payment data

• Customer data

• (Optional) Refund data

• (Optional) Additional parameters

Body Parameters

order_id

number

required

Payment identifier (Payment ID)

For orders in Noventiq Checkout: order identifier

order_name

string

required

Extended payment identifier
In such a format prefixes can be added to identifiers.

For orders in Noventiq Checkout: extended order identifier

status

string

required

Payment status
More details on payment statuses.

Value options:

• not paid

• paid - payment successfully completed

• deleted (the status is also used if a full refund has been made)

For orders in Noventiq Checkout: order status

external_id

string

Payment identifiers on your end
This identifier you transferred when creating a payment (payment_id) or processing an auto-payment (payment_id).

For orders in Noventiq Checkout: Checkout identifier. It is used if an order for a product with dynamic characteristics has been placed.

create_date

string

required

Date and time of creation for payment object

Format: YYYY-MM-DDThh:mm:ss±hh:mm.

For orders in Noventiq Checkout: Date and time of creation for order object

pay_date

string

Date and time of successful payment completion

• Format: YYYY-MM-DDThh:mm:ss±hh:mm.

• If no payment has been made, the parameter is transferred having an empty value ("").

For orders in Noventiq Checkout: Date and time of successful order payment completion

currency

string

required

Currency code of payment

• Format: ISO 4217 alpha-3, 3 characters

• For the value options, see the reference guide

For orders in Noventiq Checkout: currency code of order

locale

string

required

Payment form interface language
For the value options, see the reference guide.

order_detail_url

string

required

Link leading to the payment form page
When receiving payment data in the test environment - links will be intended for the test environment (links will have the .demoslweb.com suffix added).

For orders in Noventiq Checkout: link leading to the order page

total_discount_amount

string

required

It is not used, parameter is transferred with value (0.00).

For orders in Noventiq Checkout: total discount amount

total_vat_amount

string

required

VAT amount in payment currency

Format: String contains numerals; value separating by point, with two decimal places.

total_amount

string

required

Total payment amount

• Transferred in payment currency

• VAT are included

• Format: Number with 2 decimals, separator - dot, transferred as string

For orders in Noventiq Checkout: total order price amount

payment

object

required

Payment data

payment / payment_method

string

required

Payment method code
For the value options, see the reference guide.

payment / payment_system_name

string

required

Payment method name (technical value)

payment / card_last_4

string

Last 4 digits of card number

The value can be transferred if the customer has paid with a bank card. Otherwise, the parameter is transferred having an empty value (null).

payment / card_expiration_date

string

Card expiration date

The value can be transferred if the customer has paid with a bank card. Otherwise, the parameter is transferred having an empty value ("").

Format: MM/YYYY. Example: 12/2026.

payment / is_installment_payment

boolean

required

It is not applicable. False value is always transferred.

For orders in Noventiq Checkout: Installment payment availability

customer

object

required

Customer data

customer / country

string

required

Customer's country code

• Format: ISO 3166-1 alpha-2

• For the value options, see the reference guide

customer / type

string

required

Customer type
Value options:

• physical - natural person

• juridical - legal person

customer / email

string

required

Customer's email

customer / first_name

string

required

Customer's name

customer / last_name

string

required

Customer's last name

customer / phone

string

Customer's phone number

If the parameter contains no value on our end, it is transferred empty ("").

customer / vat_number

string

Taxpayer identification number
E.g., it is used to transfer:

• DNI/CUIL or CUIT when payments are made in Argentine pesos

If the parameter contains no value on our end, it is transferred empty ("").

customer / company_name

string

Company name

If the parameter contains no value on our end, it is transferred empty ("").

customer / company_billing_address

string

Company's registered office address

If the parameter contains no value on our end, it is transferred empty ("").

customer / company_delivery_address

string

Company’s physical address

If the parameter contains no value on our end, it is transferred empty ("").

products

array [objects]

required

Additional payment data

For orders in Noventiq Checkout: product data

products / [object] / id

number

required

It is not applicable (a technical value is transferred)

For orders in Noventiq Checkout: product identifiers

products / [object] / vendor_code

string

It is not applicable (an empty value ("") or a technical value is transferred)

For orders in Noventiq Checkout: your product identifiers

products / [object] / sku

string

It is not applicable (an empty value ("") or a technical value is transferred)

For orders in Noventiq Checkout: your product SKU

products / [object] / business_segment

string

It is not applicable (an empty value ("") or a technical value is transferred)

For orders in Noventiq Checkout: product sales business segment

products / [object] / name

string

required

Payment descriptions
This description is filled with values of the payment_description parameter when creating a payment object (payment_description) or processing an auto-payment (payment_description).

For orders in Noventiq Checkout: full names of products

products / [object] / price

string

required

Payment amount excluding VAT

• Transferred in payment currency

• VAT is excluded

• Format: Number with 2 decimals, separator - dot, transferred as string

For orders in Noventiq Checkout: price per product unit

products / [object] / quantity

number

required

It is not applicable. "1" is always transferred.

For orders in Noventiq Checkout: product unit quantities

products / [object] / discount_percent

string

It is not applicable. Empty value ("") is always transferred.

For orders in Noventiq Checkout: product discount percentage

products / [object] / discount_amount

string

It is not applicable. Empty value ("") is always transferred.

For orders in Noventiq Checkout: product discount amount

products / [object] / vat_percent

string

required

VAT percentage

products / [object] / vat_amount

string

required

VAT amount in payment currency

Format: String contains numerals; value separating by point, with two decimal places.

products / [object] / amount

string

required

Total payment amount

• Transferred in payment currency

• Including VAT

• Format: String contains numerals; value separating by point, with two decimal places

For orders in Noventiq Checkout: product total price

products / [object] / margin

string

required

You profit margin from sales in payment currency

Format: String contains numerals; value separating by point, with two decimal places.

products / [object] / return

object

Refund data
It is transferred if the refund has been made. Otherwise, it is not transferred.

products / [object] / return / type

string

required*

Action type

* - Required, if the products.return parameter is transferred.

Value options:

• returned - refund/chargeback

• removed - not used in Noventiq Payments

products / [object] / return / date

required*

Date and time of event

• * - Required, if the products.return parameter is transferred

• Format: YYYY-MM-DDThh:mm:ss±hh:mm

products / [object] / return / reason

string

required*

Reason description for event

* - Required, if the products.return parameter is transferred.

additional_data

array [objects]

Additional parameters
These parameters can be filled out when creating payment objects (additional_data) or during processing. Please note that the time for storing additional parameters in payments is limited.

additional_data / [object] / name

string

required*

Parameter name

* - Required, if the additional_data parameter is transferred.

additional_data / [object] / value

string

required*

Parameter value

* - Required, if the additional_data parameter is transferred.

Successful Response

{
  "order_id": 6666666,
  "order_name": "A0006666666",
  "status": "delete",
  "external_id": "TEST12025",
  "create_date": "2021-08-13T09:16:35+03:00",
  "pay_date": "2021-08-13T09:20:05+03:00",
  "currency": "EUR",
  "locale": "en_EN",
  "order_detail_url": "https://shop.com/order/status/6666666/1a97507",
  "total_discount_amount": "0.0",
  "total_vat_amount": "0.00",
  "total_amount": "200.00",
  "payment": {
    "payment_method": "CreditCard",
    "payment_system_name": "Bank Card",
    "card_last_4": "1234",
    "card_expiration_date": "12/26",
    "is_installment_payment": false
  },
  "customer": {
    "country": "FR",
    "type": "physical",
    "email": "customer@gmail.com",
    "first_name": "Marcel",
    "last_name": "Laporte",
    "phone": "",
    "vat_number": "",
    "company_name": "",
    "company_billing_address": "",
    "company_delivery_address": ""
  },
  "products": [
    {
      "id": 111111,
      "vendor_code": "",
      "sku": "",
      "business_segment": "b2c",
      "name": "Demo Payment",
      "price": "100.00",
      "quantity": 1,
      "discount_percent": "",
      "discount_amount": "",
      "vat_amount": "0.00",
      "amount": "100.00",
      "margin": "95.00",
      "return": {
        "type": "returned",
        "reason": "test purchase",
        "date": "2022-08-14T09:16:35+03:00"
      }
    }
  ],
  "additional_data": [
    {
      "name": "referer2",
      "value": "test"
    },
    {
      "name": "referer3",
      "value": "TEST12025"
    }
  ]
}

Error Response

If an error occurs while processing the request, you receive a server response code corresponding to the result of processing.

Depending on the code, the response body may contain additional parameters.

HTTP Server Response Error Code

Additional Error Codes for HTTP 400

Additional Error Codes for HTTP 401

The errors are the same for all the APIs that use token authorization.

Additional Error Codes for HTTP 404

Body Parameters

errors

array [objects]

required

Error list

errors / [error object] / error

number

required

Error code

errors / [error object] / message

string

Error description

Example of Error Response

{
  "errors": [{
      "error": 15020,
      "message": "Order not found."
    }
  ]
}

Noventiq Payments