1. Other
Payswix | Agents API
  • Finance account
    • Getting started
    • Validation rules
    • Virtual IBANs
      • NACE codes
      • Create vIBAN for person or company
      • Get a list of vIBANs
    • Transactions
      • Create a SEPA transfer
      • Get transfer fee
      • Get all existing recipients
      • Get transaction information
      • Get a filtered list of transactions
    • Companies
      • Get specific company details
    • Accounts
      • Create a new account
      • Get all user accounts
      • Get user account information by account number
    • Other
      • Check if the server is alive
        GET
    • Webhooks
      • Transaction webhook
    • Schemas
      • Company vIBAN
      • Person vIBAN
      • Transaction
  • Standard account
    • Transactions
      • Create a SEPA transfer
      • Create a SWIFT transfer
    • Schemas
      • Transaction
  1. Other

Check if the server is alive

GET
/agents/v1/ping

Request

Authorization
API Key
Add parameter in header
X-API-KEY
Example:
X-API-KEY: ********************
or

Responses

🟢200OK
application/json
Bodyapplication/json

🟠401Unauthorized
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://demo-api.payswix.com/agents/v1/ping' \
--header 'X-API-KEY: <api-key>'
Response Response Example
200 - Success
{
    "is_success": true,
    "data": [],
    "message": null
}
Previous
Get user account information by account number
Next
Transaction webhook
Built with