Create a transaction

POST

https://api-dev.synswi.com/transactions

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

Examples

Example 1Example 2

{}
    "amount": 2060,
    "paymentInstrumentId": "payment-instrument-eb769f34-b952-4ea0-ae4e-4666c1737995",
    "accountId": "{{accountId}}",
    "type": "pull",
    "method": "card",
    "channel": "online",
    "referenceId": "12113ff9daddda1dsx314d33",
    "tags": {
        "invoiceId": "test-invoice"
    }
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

cURL

Example 1Example 2

curl --location --request POST 'https://api-dev.synswi.com/transactions' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{}
    "amount": 2060,
    "paymentInstrumentId": "payment-instrument-eb769f34-b952-4ea0-ae4e-4666c1737995",
    "accountId": "acc-c068c34e-b12d-48b1-bc5f-c85edae9fc9b",
    "type": "pull",
    "method": "card",
    "channel": "online",
    "referenceId": "12113ff9daddda1dsx314d33",
    "tags": {
        "invoiceId": "test-invoice"
    }
}'

Responses

🟢200Success

application/json

Body

Example

{
    "id": "transaction-98a14246-1ca7-4e4f-ac6b-b19a540580f8",
    "accountId": "acc-c068c34e-b12d-48b1-bc5f-c85edae9fc9b",
    "amount": 200,
    "channel": "online",
    "createdAt": "2025-01-15T01:59:14.793Z",
    "currency": "USD",
    "method": "card",
    "paymentInstrumentId": "payment-instrument-7ca318bc-e84c-4c02-a1da-d520a05a8f68",
    "referenceId": "12113ff9a1131433",
    "status": "succeeded",
    "statusReason": "transaction succeeded",
    "type": "pull"
}

Get transactions

Update a transaction