Sign in

v1

latestOpenAPI 3.1.02026-07-2478315484.9 KB
Standing Orders Raw Data

Get Standing Orders

Get the standing orders for a specific account given an accountId. The accountId can be found by making a call to the /accounts endpoint. Requires the following permissions: standing_orders

get/data/v2/accounts/{account_id}/standing-orders

Path parameters

account_idstring uuid required

The account_id used to fetch requested data

Query parameters

asyncboolean

When true the API will return a results_id which can be fetched from the /data/v2/results endpoint when ready. Note: it's recommended to use the sync flow (async=false) for all requests by adapting the data workflow for connected entities.

pageinteger

The page you're requesting - returns page 0 of a response if not specified.

sizeinteger

The number of objects you want to return as a page size.

entity_idstring uuid

The entity_id you're querying for, which is created by LinkSDK .connect() function.

metastring

Additional data you would like to store against the request. Example: {"foo": "val"}

Response

OK

status'OK' | 'PENDING' | 'FAILED' | 'CONSENT_EXPIRED' | 'RECONNECT_REQUIRED' | 'PROCESSING_STARTED' required

The status of the request

results_idstring uuid required

The unique identifier for the request

messagestring required

A message describing the status of the request

metaobject nullable

Meta information about the request

timestampstring date-time required

The datetime of when the request was made

refreshed_atstring date-time nullable

The datetime of when the data was refreshed

typestring nullable

The endpoint the original request was made to.

Example response

{
  "data": {
    "standing_orders": [
      {
        "first_payment_amount": {
          "currency": "AED"
        },
        "last_payment_amount": {
          "currency": "AED"
        },
        "next_payment_amount": {
          "currency": "AED"
        },
        "final_payment_amount": {
          "currency": "AED"
        }
      }
    ]
  }
}