/transactions

List transactions. Each row includes the latest Ramp provider attempt and server-owned payment and recovery action capabilities with disabled reasons.

Required scope: transactions:read

Authorization

apiKey

X-API-Key<token>

API key provided in dashboard

In: header

Query Parameters

type?string

Public transaction type. Transfers are internal bank-to-bank movements; payouts represent owner or manager distributions.

Value in"deposit" | "expense" | "transfer" | "payout"

isOpeningBalance?boolean

status?string

Value in"active" | "inactive"

includeLines?boolean

accountId?string

last4?string

Length4 <= length <= 4

isLocked?boolean

hasActiveJournalEntries?boolean

connectionId?string

connection id or 'null' for manual transactions

amount?string

Amount in cents with signed 32-bit magnitude; also accepts ranges like 100...200

Match^(?:(?:>=|<=|>|<)?-?\d+|-?\d+\.\.\.-?\d+)$

paidAtRange?string

Date range string. Accepted syntax: YYYY, YYYY-MM, YYYY-MM-DD, or range YYYY-MM-DD...YYYY-MM-DD (legacy comma separator also accepted). Single values expand to the full year, month, or day.

Formatvrp-date-range

matchedBankRecordDateRange?string

Filter transactions by linked bank record date.

Formatvrp-date-range

dateRangeCondition?string

Controls how dateRange and paidAtRange are applied. all applies both filters together, and or matches transaction date OR paid date.

Default"all"

Value in"all" | "or"

dateRange?string

Date range string. Accepted syntax: YYYY, YYYY-MM, YYYY-MM-DD, or range YYYY-MM-DD...YYYY-MM-DD (legacy comma separator also accepted). Single values expand to the full year, month, or day.

Formatvrp-date-range

isDateRangeEndInclusive?boolean

Whether the end date in dateRange or paidAtRange is treated as inclusive (true) or exclusive (false).

Defaulttrue

uniqueRefs?string

Comma-separated transaction unique refs.

Formatvrp-csv

shortRefs?string

ids?string

search?string

recurringTemplateId?string

Match

^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Formatuuid

paidStatus?string

Value in"unpaid" | "underpaid" | "overpaid" | "paid"

matchedByBankRule?boolean

reconciled?boolean|string

Filter transactions by reconciled state. True only returns reconciled transactions. Candidate returns unreconciled match candidates for accountId.

contactId?string

Match

^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Formatuuid

listingIds?string

listingScope?string

Controls listingIds filter expansion. withChildren includes direct child listings when a parent listing is selected; exact only matches the selected listing ids.

Value in"exact" | "withChildren"

limit?integer

Default100

Range1 <= value <= 250

page?integer

Range1 <= value <= 9007199254740991

offset?integer

Range0 <= value <= 9007199254740991

Response Body

`application/json`

curl -X GET "https://api.vrplatform.app/transactions"

curl -X GET "https://api.vrplatform.app/transactions"

{
  "data": [
    {
      "description": "string",
      "status": "active",
      "uniqueRef": "string",
      "isOpeningBalance": true,
      "type": "deposit",
      "date": "string",
      "lines": [
        {
          "uniqueRef": "string",
          "description": "string",
          "assignment": "accountsPayable",
          "amount": -9007199254740991,
          "ownerStatementId": "eccddabd-554b-48ab-a66d-28a57ff66fa9",
          "matchReservationConfirmationCode": "string",
          "matchReservationStripeGuestRef": "string",
          "matchReservationProcessorBookingRef": "string",
          "matchLineTypeClassification": "string",
          "id": "string",
          "issues": [
            {
              "code": "unassignedAccount",
              "severity": "error",
              "context": {
                "lineType": "string"
              }
            }
          ],
          "recurringTemplate": {
            "id": "string"
          },
          "total": 0,
          "listing": {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "name": "string",
            "uniqueRef": "string",
            "shortRef": "string"
          },
          "reservation": {
            "id": "string",
            "shortRef": "string",
            "confirmationCode": "string",
            "uniqueRef": "string",
            "status": "booked",
            "checkIn": "string",
            "checkOut": "string"
          },
          "account": {
            "id": "string",
            "name": "string",
            "uniqueRef": "string",
            "status": "active"
          },
          "party": "owners",
          "contact": {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "name": "string",
            "firstName": "string",
            "uniqueRef": "string",
            "shortRef": "string",
            "email": "user@example.com",
            "type": "owner"
          },
          "matchStatus": "string",
          "appliedAmount": {
            "taxRate": {
              "id": "string",
              "name": "string",
              "basisPoints": 100000
            }
          },
          "markup": {
            "amount": -9007199254740991,
            "taxBehavior": "excluded",
            "taxRate": {
              "id": "string",
              "name": "string",
              "basisPoints": 100000
            }
          },
          "lock": {
            "status": "locked",
            "booksClosed": {
              "date": "string"
            },
            "ownerStatement": {
              "ids": [
                "497f6eca-6276-4993-bfeb-53cbbbba6f08"
              ]
            },
            "reconciled": {
              "bankRecordIds": [
                "497f6eca-6276-4993-bfeb-53cbbbba6f08"
              ]
            },
            "statementPeriod": {
              "hits": [
                {
                  "listingId": "8c73d933-f7ed-437e-9da1-caac95adc1ae",
                  "txnAt": "string",
                  "openFrom": "string"
                }
              ]
            }
          }
        }
      ],
      "attachmentIds": [
        "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      ],
      "recurringTemplateId": "d73afa31-bf14-4baf-aede-be5f4b4ff489",
      "recreatedFromTransactionId": "000264af-6c3a-4ff1-8534-ade50aa8d7fb",
      "matchBankAccountLast4": "string",
      "id": "string",
      "shortRef": "string",
      "lock": {
        "status": "locked",
        "booksClosed": {
          "date": "string"
        },
        "ownerStatement": {
          "ids": [
            "497f6eca-6276-4993-bfeb-53cbbbba6f08"
          ]
        },
        "reconciled": {
          "bankRecordIds": [
            "497f6eca-6276-4993-bfeb-53cbbbba6f08"
          ]
        },
        "statementPeriod": {
          "hits": [
            {
              "listingId": "8c73d933-f7ed-437e-9da1-caac95adc1ae",
              "txnAt": "string",
              "openFrom": "string"
            }
          ]
        }
      },
      "issues": [
        {
          "code": "line_unassignedAccount",
          "severity": "error",
          "context": {}
        }
      ],
      "currency": "string",
      "amount": -9007199254740991,
      "recurringTemplate": {
        "id": "string"
      },
      "attachments": [
        {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "transactionId": "75906707-8c31-479c-b354-aa805c4cefbc",
          "createdAt": "2024-01-15T12:30:00.000+00:00",
          "filename": "string",
          "extension": "string",
          "contentType": "string",
          "byteSize": -9007199254740991,
          "isOwnerAccessible": true
        }
      ],
      "account": {
        "id": "string",
        "name": "string",
        "uniqueRef": "string",
        "status": "active"
      },
      "payment": {
        "bankRecordIds": [
          "string"
        ],
        "status": "unpaid",
        "lock": {
          "status": "locked",
          "booksClosed": {
            "date": "string"
          },
          "ownerStatement": {
            "ids": [
              "497f6eca-6276-4993-bfeb-53cbbbba6f08"
            ]
          },
          "reconciled": {
            "bankRecordIds": [
              "497f6eca-6276-4993-bfeb-53cbbbba6f08"
            ]
          },
          "statementPeriod": {
            "hits": [
              {
                "listingId": "8c73d933-f7ed-437e-9da1-caac95adc1ae",
                "txnAt": "string",
                "openFrom": "string"
              }
            ]
          }
        },
        "date": "string"
      },
      "connection": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string",
        "status": "active",
        "uniqueRef": "string",
        "appId": "string"
      },
      "contact": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string",
        "firstName": "string",
        "uniqueRef": "string",
        "shortRef": "string",
        "email": "user@example.com",
        "type": "owner"
      },
      "source": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "type": "string",
        "status": "active",
        "appId": "string",
        "appIcon": "string"
      },
      "matchStatus": "string",
      "matchedByBankRule": true,
      "returnedFromTransactionId": "edd2bee8-c5f7-4ff5-ae8f-fd9c96d50204",
      "returnEffectiveAt": "2024-01-15T12:30:00.000+00:00",
      "returnSummary": {
        "status": "none",
        "returnedAmount": -9007199254740991,
        "remainingReturnableAmount": -9007199254740991,
        "compensationTransactionIds": [
          "497f6eca-6276-4993-bfeb-53cbbbba6f08"
        ],
        "replacementTransactionId": "a44b4466-2c16-4884-a7c2-efd209c901e2"
      },
      "providerPayment": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "provider": "ramp",
        "connectionId": "84b500d7-71c8-4b1f-adf4-f1eb0000973d",
        "transactionId": "75906707-8c31-479c-b354-aa805c4cefbc",
        "syncId": "24d9ea7f-fdab-4f53-95fd-4deda2362964",
        "status": "requested",
        "providerStatus": "string",
        "providerTransferId": "string",
        "providerTransferStatus": "string",
        "externalRef": "string",
        "paymentReference": "string",
        "paymentMethod": "string",
        "destinationAccountLast4": "stri",
        "requestedArrivalDate": "string",
        "scheduledInitiationAt": "2024-01-15T12:30:00.000+00:00",
        "initiatedAt": "2024-01-15T12:30:00.000+00:00",
        "completedAt": "2024-01-15T12:30:00.000+00:00",
        "billArchivedAt": "2024-01-15T12:30:00.000+00:00",
        "failureReason": "string",
        "attemptId": "string",
        "attempt": 9007199254740991,
        "createdAt": "2024-01-15T12:30:00.000+00:00",
        "updatedAt": "2024-01-15T12:30:00.000+00:00"
      },
      "providerPaymentActions": {
        "pay": {
          "available": true,
          "reason": "string"
        },
        "cancel": {
          "available": true,
          "reason": "string"
        },
        "cancelAndArchive": {
          "available": true,
          "reason": "string"
        },
        "cancelAndRecreate": {
          "available": true,
          "reason": "string"
        },
        "archive": {
          "available": true,
          "reason": "string"
        },
        "archiveAndRecreate": {
          "available": true,
          "reason": "string"
        },
        "unarchive": {
          "available": true,
          "reason": "string"
        }
      },
      "operations": {
        "counts": {
          "total": 9007199254740991,
          "queued": 9007199254740991,
          "running": 9007199254740991,
          "completed": 9007199254740991,
          "failed": 9007199254740991
        },
        "items": [
          {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "type": "ach-verification",
            "status": "queued",
            "resource": {
              "type": "bank-rule",
              "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
              "role": "source",
              "url": "http://example.com"
            },
            "failure": {
              "code": "csvBlankHeader",
              "message": "CSV contains a blank header"
            },
            "initiator": {
              "type": "user",
              "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b"
            },
            "createdAt": "2024-01-15T12:30:00.000+00:00",
            "startedAt": "2024-01-15T12:30:00.000+00:00",
            "finishedAt": "2024-01-15T12:30:00.000+00:00"
          }
        ]
      }
    }
  ],
  "pagination": {
    "limit": 100,
    "page": 1,
    "total": 0,
    "totalPage": 0,
    "nextPage": 0
  }
}

{
  "code": "AUDIT_CURSOR_EXPIRED",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}

{
  "code": "AUDIT_CURSOR_EXPIRED",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}

{
  "code": "AUDIT_CURSOR_EXPIRED",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}

{
  "code": "AUDIT_CURSOR_EXPIRED",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}

{
  "code": "AUDIT_CURSOR_EXPIRED",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}

{
  "code": "AUDIT_CURSOR_EXPIRED",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}

{
  "code": "AUDIT_CURSOR_EXPIRED",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}

{
  "code": "MISDIRECTED_REQUEST",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": {
    "teamId": "a4ede8ba-7c0a-4485-8763-cbd9b282fbec",
    "dataRegion": "ap",
    "apiBaseUrl": "http://example.com"
  }
}

{
  "code": "AUDIT_CURSOR_EXPIRED",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}

{
  "code": "AUDIT_CURSOR_EXPIRED",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}

{
  "code": "AUDIT_CURSOR_EXPIRED",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}

/transactions

Authorization

Query Parameters

Response Body

200application/json

400application/json

401application/json

403application/json

404application/json

409application/json

410application/json

413application/json

421application/json

422application/json

500application/json

503application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`