Skip to main content
GET
/
transactions
/
pending
List pending transactions
curl --request GET \
  --url https://api.synctera.com/v2/transactions/pending
{
  "next_page_token": "<string>",
  "result": [
    {
      "account_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
      "account_no": "<string>",
      "created": "2023-11-07T05:31:56Z",
      "data": {
        "amount": 1,
        "auto_post_at": "2023-11-07T05:31:56Z",
        "avail_balance": 123,
        "available_balance": 123,
        "balance": 123,
        "currency": "<string>",
        "dc_sign": "debit",
        "effective_date": "2023-11-07T05:31:56Z",
        "expires_at": "2023-11-07T05:31:56Z",
        "external_data": {},
        "force_post": true,
        "history": [
          {
            "account_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
            "account_no": "<string>",
            "created": "2023-11-07T05:31:56Z",
            "data": {
              "amount": 1,
              "auto_post_at": "2023-11-07T05:31:56Z",
              "avail_balance": 123,
              "available_balance": 123,
              "balance": 123,
              "currency": "<string>",
              "dc_sign": "debit",
              "effective_date": "2023-11-07T05:31:56Z",
              "expires_at": "2023-11-07T05:31:56Z",
              "external_data": {},
              "force_post": true,
              "idemkey": "<string>",
              "memo": "<string>",
              "network": "<string>",
              "operation": "hold_new",
              "reason": "<string>",
              "req_amount": 1,
              "risk_info": {},
              "status": "PENDING",
              "subtype": "<string>",
              "total_amount": 1,
              "transaction_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "transaction_time": "2023-11-07T05:31:56Z",
              "type": "<string>",
              "user_data": {},
              "was_partial": true
            },
            "id": 123,
            "idemkey": "<string>",
            "offset_account_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
            "offset_account_no": "<string>",
            "reference_id": "<string>",
            "tenant": "abcdef_ghijkl",
            "updated": "2023-11-07T05:31:56Z",
            "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
          }
        ],
        "idemkey": "<string>",
        "memo": "<string>",
        "network": "<string>",
        "operation": "hold_new",
        "reason": "<string>",
        "req_amount": 1,
        "risk_info": {},
        "status": "PENDING",
        "subtype": "<string>",
        "total_amount": 1,
        "transaction_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "transaction_time": "2023-11-07T05:31:56Z",
        "type": "<string>",
        "user_data": {},
        "was_partial": true
      },
      "enhanced_transaction": {},
      "id": 123,
      "idemkey": "<string>",
      "offset_account_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
      "offset_account_no": "<string>",
      "reference_id": "<string>",
      "tenant": "abcdef_ghijkl",
      "updated": "2023-11-07T05:31:56Z",
      "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ]
}

Path Parameters

​
transaction_id
string<uuid>
required

Transaction ID in the ledger

Example:

"b01db9c7-78f2-4a99-8aca-1231d32f9b96"

Query Parameters

​
id
string<uuid>[]

Unique identifier for the resource. Multiple IDs can be provided as a comma-separated list.

Example:

"64438afd-fa20-4010-a573-2bbdca77cdb6,84ef251c-ab8f-47a5-bbfd-a16648f95157"

​
uuid_nin
string<uuid>[]

Transaction UUID(s) to exclude from the query. Multiple UUIDs can be provided as a comma-separated list.

Example:

"ba313a66-cbb6-4bc3-aa37-6548448ecb32,cadb3dd1-feb0-42c3-b545-afbbfa99eb7f"

​
idempotency_key
string[]

Transaction Idempotency Key(s). Multiple keys can be provided as a comma-separated list.

Example:

"ba313a66-cbb6-4bc3-aa37-6548448ecb32,cadb3dd1-feb0-42c3-b545-afbbfa99eb7f"

​
account_no
string

Account number

​
reference_id
string

Reference ID

​
account_id
string<uuid>[]

Account ID

​
card_id
string<uuid>

Card ID

Example:

"6dc0397d-1aba-4be9-9582-895a7a887d49"

​
from_date
string<date>

Only display transactions with a posting date greater than from_date

​
to_date
string<date>

Only display transactions with a posting date less than or equal to to_date

​
status
string

Status of the transaction

​
type
enum<string>[]

The type of documents. Multiple types can be provided as a comma-separated list.

​
subtype
string

Only display transactions matching the given subtype

​
cashback
boolean

If true, only transactions with cashback will be returned. If false, only transactions without cashback will be returned. If not provided, all transactions will be returned.

​
include_child_transactions
boolean

Include transactions from sub-accounts when listing transactions for a given account

​
exclude_jit_transactions
boolean

Hide "JIT funding" transactions from results

​
amount
integer

Only return transactions equal to the given amount

​
total_amount
integer

Only return transactions equal to the given total amount (in minor currency units, e.g., cents). This may differ from amount for holds with increases/decreases.

Required range: x >= 0
Example:

1200

​
limit
integer
default:100

Maximum number of objects to return per page. If the limit is greater than 100, then it will be set to 100.

Required range: x >= 1
Example:

100

​
page_token
string

Optional pagination token to be provided to retrieve subsequent pages, returned from previous get

Example:

"a8937a0d"

Response

Paginated list of pending transactions

​
next_page_token
string | null
required

If returned, use the next_page_token to query for the next page of results. Not returned if there are no more rows.

​
result
A pending transaction · object[]
required

List of pending transactions