The Afinis sandbox is an isolated test environment where you can try out the standardized APIs. Below are instructions on how to make your first API call within this sandbox, or an API REST tool like Postman (see below). A sample set of data is available for each API to allow you to simulate an API call in a production environment.


API Calls


A series of fields are enabled to customize the call for each API. All API calls are structured with the following components:

Resource URL

Header Parameters

Try it out!

Some APIs will also include a Query Parameter.



Return Codes


The API will always return an HTTP STATUS. The table below summarizes the general response codes that are returned in the APIs.





The API call was successful.


The API call had an error. The error will be encoded in the body of the response.


The API call was unsuccessful. You should retry later.



Specific Return Codes


  HTTP Code



Bad request

The request could not be understood or required parameters were missing



Invalid JSON Structure



“Field name” is missing or invalid



Invalid date



Invalid combination of fields submitted. Check the API specification for eligible combinations



“Field name” cannot be more than [max] characters



Authentication failed or user doesn’t have permissions for requested operation



API key is missing, invalid or expired



API token is invalid, expired, or account associated with key does not have access to that API



Access denied, the operation is not allowed  


Not Found

Resource was not found.


Method Not Allowed

The request method is known by the server but has been disabled and cannot be used.


Invalid Accept

Web server doesn't find any content that conforms to the criteria given by the user agent.


Content Type

The media format of the requested data is not supported by the server, so the server is rejecting the request.



Unprocessable request due to "%%"



Internal server error


Service Unavailable

Service is temporarily unavailable


API Testing

Select the API that you want to test:

Account Validation 

Account Validation Plus Name 

Authorize to Initiate Payment

Bank Contact

Bank Contact v2

Corporate Account Balances

Corporate Transaction Detail

Corporate Transaction History

Pay Me

Payee Profile

Payment Initiation

Real-Time Billing Account Validation

Request Proof of Authorization

Request for WSUD

Transaction Status

Wire Status





Try it out!


Set API Key information as previously provided in the Getting Started page. 


Insert the following information in the open dialogue box:

  1. Name = "apikey" (all lowercase)
  2. Set value copied from the “Consumer Key” (make sure there is no space before or after the string of characters)
  3. Select “Query”



After customizing the call components, click the “SEND” button to execute the API call. The “RESET” button will reset all the fields to the ones used by default.








In this section, we take a look at how to make direct HTTP requests by using Postman.   If you are new to Postman, see the Postman documentation and tutorials.


For a GET request like Bank Contact API insert the Resource URL and set the Consumer Key “?apikey=” with the appropriate credentials, followed by the reason i.e., “&reason=ACH_FRAUD” as shown below:



For a POST request like Account Validation, information has to be passed in the header and the body of the HTTP request (changing the values as required) as shown below.



The header includes the Resource URL and Consumer Key with raw json content sent in the request body.

*NOTE: In order to send json in the request body, select the radio button raw and set the text to “JSON(application/json).”