[POST] Get payment IDs

Request Description

POST /v1/order/search

The request allows you to get a list of payment identifiers that match the search criteria provided.

This request can also be used to get a list of order identifiers 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: POST

• Format: JSON

• Authorization: token-based

Header Parameters

content-type

string

required

MIME-type

It must be equal to "application/json".

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

Body Parameters

status

string

Payment status

Value options:

• not paid

• paid

• deleted

More details on payment statuses.

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_from

string

Period start date when payment object was created
The system finds the payments that meet the following condition: [date and time of payment object creation] ≥ [create_date_from].

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

create_date_to

string

Period end date when payment object was created
The system finds the payments that meet the following condition: [date and time of payment object creation] ≤ [create_date_to].
Format: YYYY-MM-DDThh:mm:ss±hh:mm.

pay_date_from

string

Period start date when payment has been successfully completed
The system finds the payments that meet the following condition: [date and time of payment successfully completed ≥ [pay_date_from].

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

pay_date_to

string

Period end date when payment has been successfully completed
The system finds the payments that meet the following condition: [date and time of payment successfully completed] ≤ [pay_date_to].
Format: YYYY-MM-DDThh:mm:ss±hh:mm.

currency

string

Currency code of payment

• Format: ISO 4217 alpha-3, 3 characters

• For the value options, see the reference guide

email

string

Customer's email

payment_method

string

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

limit

number

Quantity of payments to be returned in response
If the parameter is not transferred, the default value of payment quantity returns in response. Please contact our support team if you require to change this value.

offset

number

Offset: by how many payments you want to shift result outputting

• If not transferred or equal to 0, you will get the list that starts from the 1st payment found

• For example, if 10 is transferred, you will get the list that starts from the 11th payment found

Request Example

Example with parameters in request body

{
  "status": "not paid",
  "external_id": "12345",
  "create_date_from": "2022-01-01T00:00:00+00:00",
  "create_date_to": "2022-01-31T00:00:00+00:00",
  "pay_date_from": "2022-01-01T00:00:00+00:00",
  "pay_date_to": "2022-01-31T00:00:00+00:00",
  "currency": "EUR",
  "email": "customer@mail.com",
  "payment_method": "CreditCard",
  "limit": 100,
  "offset": 10
}

Example of request without parameters

{}

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К. Response body: list of found payment IDs in JSON format.

Body Parameters

count_all

number

required

Number of payments found

limit

number

Payment quantity in response

offset

number

Offset
Starting payment position followed by payments that return in response.

ids

array [numbers]

Array of payment IDs
The array may return empty if no payments are found, e.g.:

• No payments created

• Offset (offset) is greater than available payment quantity (count_all)

Successful Response Example

{
  "count_all": 155,
  "limit": 5,
  "offset": 5,
  "ids": [
    11111111,
    22222222,
    33333333
  ]
}

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.

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": 15010,
      "message": "Invalid field value: email"
    }
  ]
}

Noventiq Payments