API Reference

Getting Started Guide

Getting Started Guide

Welcome to our API's Getting Started guide! This guide will walk you through the initial steps you need to take to start interacting with our API and get the most out of it.

Prerequisites

Please ensure that you meet the following prerequisites:

  • Have an active account on our platform. If you do not have one, you can create it here.

  • Have basic knowledge of how APIs work, including GET and POST requests.

  • Have a program like Postman installed to make HTTP requests.

  • Access our latest versions of our APIs through our Swagger.ui

Step 1: Obtain Your API Key

In order to use our API, you'll need an API key. This key acts like a password providing you access to our API.

To obtain your API key:

  1. Access our latest versions of our APIs through our Swagger.ui
  2. Navigate to the "Authentication" section, then "POST/authentication".
  3. Click within the "Example Value" which will populate "{"password": "string", "username": "string"}" within request body window.
  4. Change "string" to your password
  5. Change the second "string" to your username
  6. Select "Try it out!" button to send the request.
  7. copy the Bearer Token key in the request body response.
  8. scroll to the top of the page and select the "Authorize" button
  9. In the value button type "Bearer YOUR_API_KEY"
  10. Click "Authorize"

Note: Keep your API key secure. Do not share it with anyone, and do not expose it in public places like GitHub.

Step 2: Make Your First Request

With your API key now entered, you're now authorized and ready to make your first API request.

Here is an example of a POST request:

{
  "accountNumber": "string",
  "addenda": "string",
  "amount": 0,
  "counterpartyId": 0,
  "description": "string",
  "externalId": "string",
  "secCode": "CCD",
  "service": "STANDARD"
}

For more information on this requestion please visit our POST/transaction/ach/pull page.

Step 3: Handle Responses

Our API returns responses in JSON format. Here's an example of what a successful response might look like:

{
    "data": [
        {
            "id": "123",
            "attribute_one": "value1",
            "attribute_two": "value2"
        },
        {
            "id": "124",
            "attribute_one": "value3",
            "attribute_two": "value4"
        }
    ]
}

In the case of an error, you might receive a response like the below:

{
  "status": 404,
  "message": "Not Found",
  "error": "Entity not found."
}

You can handle these responses in your application according to your business logic.

Next Steps

Congratulations! You've now made your first successful API request. For more details on the various endpoints available and how to interact with them, check our Counterparty and Transaction sections of our API Reference guide. If you have any questions or issues, don't hesitate to [contact our support team](Send an email!

).

Happy coding!