Synswi
  1. Payment instruments
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. Payment instruments

Get a payment instrument by id

GET
https://api-sandbox.synswi.com/payment-instruments/{paymentInstrumentId}

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Path Params
paymentInstrumentId
string 
required

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 --request GET 'https://api-sandbox.synswi.com/payment-instruments/'

Responses

🟢200Success
application/json
Body
id
string 
required
type
string 
required
accountId
string 
required
owner
object 
required
name
object 
required
createdAt
string 
required
Example
{
    "id": "payment-instrument-7ca318bc-e84c-4c02-a1da-d520a05a8f68",
    "type": "card",
    "accountId": "acc-c068c34e-b12d-48b1-bc5f-c85edae9fc9b",
    "owner": {
        "name": {
            "fullName": "1231"
        }
    },
    "createdAt": "2025-01-07T00:35:22.353Z"
}
Previous
Get payment instruments
Next
Get a transaction by id
Built with