Synswi
  1. Payment instruments
Synswi
  • Guides
    • Getting Started With the API
  • API Reference
    • Accounts
      • Onboarding forms
        • Create a Onboarding Form
      • Get account setting
      • Update account setting
      • Get profile
      • Create new profile
      • Register webhook
    • Devices
      • Get Devices
    • Dispute
      • Get disputes
    • Payment instruments
      • Create a payment instrument
      • Get payment instruments
        GET
      • Get a payment instrument by id
        GET
      • Create a Payment Instrument
        POST
    • Transactions
      • Get a transaction by id
      • Get transactions
      • Create a transaction
      • Update a transaction
    • Fees
      • Get current fee profile
    • Settlements
      • get settlements
      • get settlement entries
    • Identity
      • Register an user
      • Login
      • Validate Token
      • Create an api key
      • List api keys
      • Get Users
    • Programs
      • Accounts
    • Permission
      • Verify user permissions
      • Get Account Users
      • List Accounts
  1. Payment instruments

Get a payment instrument by id

GET
https://api-dev.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

Request Code 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-dev.synswi.com/payment-instruments/' \
--header 'Authorization: Bearer <token>'

Responses

🟢200Success
application/json
Body

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
Create a Payment Instrument
Built with