1. Finance account
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
    • Webhooks
      • Transaction webhook
    • Schemas
      • Company vIBAN
      • Person vIBAN
      • Transaction
  • Standard account
    • Transactions
      • Create a SEPA transfer
      • Create a SWIFT transfer
    • Schemas
      • Transaction
  1. Finance account

Getting started

Signing up#

Contact our sales team at [email protected] to sign up for Agents API.

API authentication#

Agents API can only be accessed with an API key, which has to be added as X-API-KEY header to each request.
headers = {
    "Content-Type": "application/json",
    "X-API-KEY": "{yourApiKey}"
}

How to obtain your API key#

1
User registration
Please register your user in Demo environment.
Register
2
Company onboarding
Login with the user created in 1st step, confirm your e-mail address, set up your 2FA method and fill out a test company onboarding form in Demo environment.
3
Company approval
Once the company onboarding form is completed, reach out to [email protected] for manual approval. Payswix Team will approve your company, add some test funds and issue the API key.
4
Create Virtual IBANs
After Company is approved by Payswix Team, please create a few Virtual IBANs. There are two ways to create Virtual IBANs:
1.
API: Create Virtual IBAN for person or company
2.
Internet Banking: log into your Payswix account, select your Company in the top-right selector, click on Settings, then Manage Virtual IBANs and then press Add Virtual IBAN button and fill out the form.
5
Virtual IBAN approval
Once a few of the virtual IBAN forms are completed, reach out to [email protected] for manual approval. Payswix Team will approve your virtual IBANs.
6
Full API access
After a few virtual IBANs are approved by Payswix Team, you are ready to fully test the Payswix Agents API.
1.
Get a list of virtual IBANs through API:
Get vIBANs
2.
Create transfers from a virtual IBAN:
Create a SEPA transfer
3.
Get your company statement and user virtual IBAN in filters:
Get a filtered list of transactions
Previous
Finance account
Next
Validation rules
Built with