Synswi
  1. Transactions
Synswi
  • Invoice
    • Get invoice by id
      GET
    • Get invoices
      GET
    • Create an invoice
      POST
    • Pay an invoice
      POST
    • Send Invoice
      POST
    • Update an invoice
      POST
  • Payment instruments
    • Create a payment instrument
    • Get payment instruments
      GET
    • Get a payment instrument by id
      GET
  • Transactions
    • Get a transaction by id
      GET
    • Get transactions
      GET
    • Create a transaction
      POST
  1. Transactions

Get transactions

GET
https://api-sandbox.synswi.com/transactions

Request

Query Params
offset
string 
required
Example:
0
limit
string 
required
Example:
10
accountId
string 
required
Example:
{{accountId}}
type
string 
required
Example:
pull
subtype
string 
optional
Example:
refund
parentTransactionId
string 
optional
Example:
transaction-f2782b3b-528e-494d-99bc-189a7ec77c2e

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request GET 'https://api-sandbox.synswi.com/transactions?limit=10&accountId=acc-c068c34e-b12d-48b1-bc5f-c85edag8tgiut&parentTransactionId=transaction-f2782b3b-528e-494d-99bc-189a7ec77c2e'

Responses

🟢200Success
application/json
Body
transactions
array [object {12}] 
required
id
string 
required
accountId
string 
required
amount
integer 
required
channel
string 
required
createdAt
string 
required
currency
string 
required
method
string 
required
referenceId
string 
required
status
string 
required
type
string 
required
paymentInstrumentId
string 
optional
statusReason
string  | null 
optional
totalCount
integer 
required
Example
{
    "transactions": [
        {
            "id": "transaction-e0fc560c-4c71-49e7-baaa-87d2725a5569",
            "accountId": "acc-c068c34e-b12d-48b1-bc5f-c85edae9fc9b",
            "amount": 200,
            "channel": "in person",
            "createdAt": "2025-02-09T08:37:46.281Z",
            "currency": "USD",
            "method": "card",
            "referenceId": "TR4kCdh4ibQ6sTNBa3dveU1S",
            "status": "succeeded",
            "type": "pull"
        },
        {
            "id": "transaction-b68b44f8-ea0d-459a-8a5b-d6c1164e400f",
            "accountId": "acc-c068c34e-b12d-48b1-bc5f-c85edae9fc9b",
            "amount": 2360,
            "channel": "in person",
            "createdAt": "2025-02-09T08:25:12.715Z",
            "currency": "USD",
            "method": "card",
            "referenceId": "TRcUc8YPs1xTSyUiXwMSsHV3",
            "status": "succeeded",
            "type": "pull"
        },
        {
            "id": "transaction-e7d32e31-6166-4c33-b8b5-c04baed06fbd",
            "accountId": "acc-c068c34e-b12d-48b1-bc5f-c85edae9fc9b",
            "amount": 5500,
            "channel": "online",
            "createdAt": "2025-02-08T07:54:26.711Z",
            "currency": "USD",
            "method": "card",
            "paymentInstrumentId": "payment-instrument-4fd69fcc-e398-42c7-8dde-5432b1f7b97b",
            "referenceId": "185d1f21-b7b6-4cdf-9e99-f31f2caa358b",
            "status": "succeeded",
            "statusReason": null,
            "type": "pull"
        },
        {
            "id": "transaction-8a1ca5c2-4977-4cc5-95be-016949562c98",
            "accountId": "acc-c068c34e-b12d-48b1-bc5f-c85edae9fc9b",
            "amount": 800,
            "channel": "online",
            "createdAt": "2025-02-06T03:57:19.846Z",
            "currency": "USD",
            "method": "ach",
            "paymentInstrumentId": "payment-instrument-75359708-3227-4466-8809-146f60bbbf60",
            "referenceId": "invoice-e7311112-efae-439a-ba19-0a8cfbe646f9",
            "status": "succeeded",
            "statusReason": null,
            "type": "pull"
        },
        {
            "id": "transaction-637577c6-8b7c-4130-842f-c39cc8047ee4",
            "accountId": "acc-c068c34e-b12d-48b1-bc5f-c85edae9fc9b",
            "amount": 800,
            "channel": "online",
            "createdAt": "2025-02-06T03:22:57.420Z",
            "currency": "USD",
            "method": "ach",
            "paymentInstrumentId": "payment-instrument-75359708-3227-4466-8809-146f60bbbf60",
            "referenceId": "invoice-47dec1cf-34fd-4ab6-a07c-b4dfc21cb4a9",
            "status": "succeeded",
            "statusReason": null,
            "type": "pull"
        }
    ],
    "total": 57
}
Previous
Get a transaction by id
Next
Create a transaction
Built with