Avis Bank API (v1)

Download OpenAPI specification:Download

Please read our Terms and Conditions and Privacy policy.

Avis Bank Access APIs allows authorized individuals to automate various tasks related to Avis Bank accounts of various types. This means being able to initiate contributions and disbursements, or organize and verify the identity of contacts that will be interacting with accounts.

Overview

When making basic CRUD-style requests, endpoints usually conform to basic REST principles. For instance, when working with contacts the following endpoints are used:

GET    /v2/contacts     # Shows all accessible contacts
POST   /v2/contacts     # Creates a new contact
GET    /v2/contacts/:id # Shows a contact
PATCH  /v2/contacts/:id # Updates a contact
DELETE /v2/contacts/:id # Archives a contact

Most endpoints support most or all of these calls. Note specifically that PATCH is used and not PUT for updates (PUT is not supported at all). Very little data in the system is ever actually destroyed, so DELETE calls are almost always used to take a particular resource out of commission, whether that means archiving a contact so it's no longer part of index views or cancelling a disbursement request, it tends to render a particular object as "no longer usable" rather than actually destroyed.

Additionally, there are certain special actions in the API that don't map very well to a REST pattern. They usually come in the form of a POST call to a nested endpoint that operates more like an RPC (Remote Procedure Call). An example of this would be updating the password for a user:

POST /v2/users/current/password

This is used to create a new password for a user. However, there is no related GET request and the resource that is returned will be a user. Some of these endpoints may create a new resource from an existing resource and others will modify an existing resource. Aside from looking at the id returned from the endpoint, special actions that create a new resource will return a 201 and those that update a resource will return a 200.

Getting Started

Sandbox requests should use sandbox.avisbank.com whereas production requests should use api.avisbank.com. This document uses paths relative to those hosts.

If you are using one of the Product APIs see the getting started section as well for that set of APIs for more specific information on opening and approving accounts.

A setup at a high level will go as follows:

1. Create a user.
2. Create a JWT with your user.
3. Interact with the authenticated APIs.