The Velo Payments Developer Hub

Welcome to the Velo Payments developer hub. You'll find comprehensive guides and documentation to help you start working with Velo as quickly as possible. You will also have access to support if you get stuck. Let's jump right in!

Get Started    

API Reference

Glossary

Object/Call Name

Description

Client

Business that originates transfers.

Recipient

Individual/Company that receives transfers.

Wallet

The payout method.

Transfer

Payouts that are sent to recipients.

Authentication

API Key Authentication

The Velo API is authenticated with the simple inclusion of an api-key as an HTTP header value.

You can generate and access API keys in the Velo Client Portal under the User Permissions area of your account profile.

You can have multiple API keys and with different permission levels.

Deleted API keys expire immediately.

~$ curl "https://api.gobold.com/v1/recipients"
  -H "api-key: [API-KEY]"

Responses

HTTP Response Codes

The Velo API uses standard HTTP response codes. Additional error information may be included in the response body.

HTTP Code

Meaning

Description

200

OK

The request was successful.

400

Bad Request

The request was invalid.

401

Unauthorized

The Authentication failed. This could be an issue with the API-KEY, Secret, or IP address whitelisting.

403

Forbidden

The API-KEY does not have the proper access level to use that resource.

404

Not Found

The specified resource could not be found.

405

Method Not Allowed

You tried to access an invalid method.

422

Unprocessable Entity

The data sent is invalid.

429

Too Many Requests

The API-KEY has been throttled. Try submitting requests less frequently.

500

Internal Server Error

We had a problem with our server. Please notify support and try again later.

Response Structure

Data Envelope

Success API calls will return an HTTP 200 OK server response.

The data envelope will contain the requested data either as a single object or an array as shown.

{
  "data": {
    "id": "577dc059a9204f0600f9aa2e",
    "type": "individual",
    "name": "",
    "first_name": "John",
    "last_name": "Smith",
    "email": "[email protected]",
    "remote_id": "jsmith-001",
    "created_at": 1467859033,
    ...
  }
}
{
  "data": 
    {
      "id": "577dc059a9204f0600f9aa2e",
      "type": "individual",
      "name": "",
      "first_name": "John",
      "last_name": "Smith",
      "email": "[email protected]",
      "remote_id": "jsmith-001",
      "created_at": 1467859033,
      ...
    },
    {
      "id": "577dc059a9204f0600f9aa2e",
      "type": "company",
      "name": "Acme Co",
      "first_name": "",
      "last_name": "",
      "email": "acmeco-041",
      "remote_id": "[email protected]",
      "created_at": 1467859033,
      ...
    }
  ]
}

Error Structure

Error Responses

API calls that generate an error will return an HTTP error code and additional information about the nature of the error including a human-readable message.

{
  "error": {
    "message": "Recipient not found.",
    "type": "not_found_error",
    "code": 404
  }
}

Updated 2 years ago

API Reference


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.