Get restriction orders

curl --request GET \
  --url https://api.plais-sandbox.finventi.com/api/v1/orders

{
  "metadata": {
    "is_last_page": false,
    "page_items": 10,
    "page_number": 0,
    "page_size": 50,
    "total_items": 20
  },
  "orders": [
    {
      "data": {
        "payer": {
          "name": "John Doe",
          "account": "LT073111111111123123",
          "bic": "HABALT22TIP",
          "id": "<string>",
          "member_code": "<string>"
        },
        "status": "UNPROCESSED",
        "amount": 10000,
        "currency": "EUR",
        "fr_dspstn_amnt": 500,
        "fr_dspstn_cmmnt": "<string>",
        "payee": {
          "name": "John Doe",
          "account": "LT073111111111123123",
          "bic": "HABALT22TIP",
          "id": "<string>",
          "member_code": "<string>"
        },
        "remittance_information": {
          "date": "2023-12-25",
          "execute_date": "2023-12-25",
          "execute_id": "<string>",
          "execute_pid": "<string>",
          "execute_processing_date": "2023-12-25",
          "execute_reason": "<string>",
          "execute_type": "<string>",
          "id": "<string>"
        }
      },
      "header": {
        "date": "2020-01-01T12:00:00Z",
        "doc_id": "RC191234ABCDF999",
        "type": "block",
        "reference_doc_id": "RC194321AAAAA123"
      }
    }
  ]
}

GET

api

orders

Get restriction orders

curl --request GET \
  --url https://api.plais-sandbox.finventi.com/api/v1/orders

{
  "metadata": {
    "is_last_page": false,
    "page_items": 10,
    "page_number": 0,
    "page_size": 50,
    "total_items": 20
  },
  "orders": [
    {
      "data": {
        "payer": {
          "name": "John Doe",
          "account": "LT073111111111123123",
          "bic": "HABALT22TIP",
          "id": "<string>",
          "member_code": "<string>"
        },
        "status": "UNPROCESSED",
        "amount": 10000,
        "currency": "EUR",
        "fr_dspstn_amnt": 500,
        "fr_dspstn_cmmnt": "<string>",
        "payee": {
          "name": "John Doe",
          "account": "LT073111111111123123",
          "bic": "HABALT22TIP",
          "id": "<string>",
          "member_code": "<string>"
        },
        "remittance_information": {
          "date": "2023-12-25",
          "execute_date": "2023-12-25",
          "execute_id": "<string>",
          "execute_pid": "<string>",
          "execute_processing_date": "2023-12-25",
          "execute_reason": "<string>",
          "execute_type": "<string>",
          "id": "<string>"
        }
      },
      "header": {
        "date": "2020-01-01T12:00:00Z",
        "doc_id": "RC191234ABCDF999",
        "type": "block",
        "reference_doc_id": "RC194321AAAAA123"
      }
    }
  ]
}

Query Parameters

status

enum<string>

A filter for orders with a specific status

Available options:

UNPROCESSED,

CONFIRMED,

REJECTED

pageable

string

required

Paging options. e.g. /api/v1/orders?page=0&size=25&sort=createdAt,DESC

Response

Returned order list

metadata

object

required

Show child attributes

metadata.is_last_page

boolean

required

Whether this is the last page

Example:

false

metadata.page_items

integer<int32>

required

Current page order items

Example:

10

metadata.page_number

integer<int32>

required

Page number

Example:

0

metadata.page_size

integer<int32>

required

Page size

Example:

50

metadata.total_items

integer<int64>

required

Total amount of items

Example:

20

orders

object[]

required

Show child attributes

orders.data

object

required

Show child attributes

orders.data.payer

object

required

The participating entity of the restriction order

Show child attributes

orders.data.payer.name

string

required

Entity name

Example:

"John Doe"

orders.data.payer.account

string

Account number

Example:

"LT073111111111123123"

orders.data.payer.bic

string

BIC code

Example:

"HABALT22TIP"

orders.data.payer.id

string

Participant Entity code

orders.data.payer.member_code

string

PLAIS code

orders.data.status

enum<string>

required

The status of Restriction Order

Available options:

UNPROCESSED,

CONFIRMED,

REJECTED

orders.data.amount

integer<int64>

The amount to be restricted in minor currency units (cents), 10.50 EUR = 1050

Example:

10000

orders.data.currency

string

The currency of the restricted amount

Example:

"EUR"

orders.data.fr_dspstn_amnt

integer<int64>

The free available amount in minor currency units (cents), 5.50 EUR = 550

Example:

500

orders.data.fr_dspstn_cmmnt

string

The free available amount comment

orders.data.payee

object

The participating entity of the restriction order

Show child attributes

orders.data.payee.name

string

required

Entity name

Example:

"John Doe"

orders.data.payee.account

string

Account number

Example:

"LT073111111111123123"

orders.data.payee.bic

string

BIC code

Example:

"HABALT22TIP"

orders.data.payee.id

string

Participant Entity code

orders.data.payee.member_code

string

PLAIS code

orders.data.remittance_information

object

Remittance Information

Show child attributes

orders.data.remittance_information.date

string<date>

Remittance Date

orders.data.remittance_information.execute_date

string<date>

Remittance Execution Date

orders.data.remittance_information.execute_id

string

Remittance Execution ID

orders.data.remittance_information.execute_pid

string

Remittance Execution Processing ID

orders.data.remittance_information.execute_processing_date

string<date>

Remittance Execution Processing Date

orders.data.remittance_information.execute_reason

string

Remittance Execution Reason

orders.data.remittance_information.execute_type

string

Remittance Execution Type

orders.data.remittance_information.id

string

Remittance ID. Correlates with payment instruction's endToEndId.

orders.header

object

required

Show child attributes

orders.header.date

string<date-time>

required

Restriction order document date

Example:

"2020-01-01T12:00:00Z"

orders.header.doc_id

string

required

Unique restriction order document ID

Example:

"RC191234ABCDF999"

orders.header.type

enum<string>

required

Restriction order document type

Available options:

block,

change,

cancel,

ns

orders.header.reference_doc_id

string

Referred restriction order document ID

Example:

"RC194321AAAAA123"

Reject instruction Confirm order

⌘I

Getting Started

PLAIS

Query Parameters

Response