Search

API Documentation (Excerpt)

API Documentation (Excerpt)

icon
A set of guidelines, instructions, and examples that describe how to use and integrate an API (Application Programming Interface).

Upload videos

Terms and Definitions

Throughout this document and the Trelio platform the following terms are used:

  • Payor. An entity (typically a corporation) which wishes to pay funds to one or more payees via a payout.
  • Payee. The recipient of funds paid out by a payor.
  • Payment. A single transfer of funds from a payor to a payee.
  • Payout. A batch of Payments, typically used by a payor to logically group payments (e.g., by business day). Technically there need be no relationship between the payments in a payout – a single payout can contain payments to multiple payees and/or multiple payments to a single payee.
  • Sandbox. An integration environment provided by Trelio Payments which offers a similar API experience to the production environment, but all funding and payment events are simulated, along with many other services such as OFAC sanctions list checking.

Overview

The Trelio Payments API allows a payor to perform a number of operations. The following is a list of the main capabilities in a natural order of execution:

  1. Authenticate with the Trelio platform
  2. Maintain a collection of payees
  3. Query the payor’s current balance of funds within the platform and perform additional funding
  4. Issue payments to payees
  5. Query the platform for a history of those payments

This document describes the main concepts and APIs required to get up and running with the Trelio Payments platform. It is not an exhaustive API reference. For that, please see the separate Trelio Payments API Reference.

API Considerations

The Trelio Payments API is REST based and uses the JSON format for requests and responses.

Most calls are secured using OAuth 2 security and require a valid authentication access token for successful operation. See the Authentication section for details.

Where a dynamic value is required in the examples below, the {token} format is used, suggesting that the caller needs to supply the appropriate value of the token in question (without including the { or } characters).

Where curl examples are given, the –d @filename.json approach is used, indicating that the request body should be placed into a file named filename.json in the current directory. Each of the curl examples in this document should be considered a single line on the command line, regardless of how they appear in print.

Payor Service Public API endpoints

Get Payor

GET /v1/payors/{payorId}

Get a Single Payor by Id.

→ Authorization

User access token required.

→ Path parameters

Parameter
Type
Optional
Description
payorId
Object
false
The payor id (UUID).

→ Query parameters

No parameters.

→ Request fields

No request body.

→ Response fields

Path
Type
Optional
Description
payorId
String
false
The payor id (UUID).
payorName
String
false
The name of the payor.
address
Object
false
The address of the payor.
address.line1
String
false
Size must be between 2 and 255 inclusive.
address.line2
String
true
Size must be between 0 and 255 inclusive.
address.line3
String
true
Size must be between 0 and 255 inclusive.
address.line4
String
true
Size must be between 0 and 255 inclusive.
address.city
String
false
Size must be between 2 and 100 inclusive.
address.countyOrProvince
String
true
Size must be between 2 and 100 inclusive.
address.zipOrPostcode
String
true
Size must be between 2 and 30 inclusive.
address.country
String
false
Size must be between 2 and 50 inclusive.
primaryContactName
String
false
Name of primary contact for the payor.
primaryContactPhone
String
false
Primary contact phone number for the payor.
primaryContactEmail
String
false
Primary contact email for the payor.
logicalAccountId
String
true
The logical account id (UUID) for the payor.
fundingRef
String
true
The funding reference to be used for the payor.
kycState
String
true
The kyc state of the payor.Must be one of [FAILED_KYC, PASSED_KYC, REQUIRES_KYC].
manualLockout
Boolean
true
Whether or not the payor has been manually locked by the backoffice.

→ Example request

$ curl 'https://api.velopayments.com/v1/payors/d5a97608-6eaf-45c2-b299-6cd7faac74cf' -i \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer aea0144b-9e07-4b6a-84a0-85cfcd65abf9'

→ Example response

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 536

{
  "payorId" : "d5a97608-6eaf-45c2-b299-6cd7faac74cf",
  "payorName" : "FooBar",
  "address" : {
    "line1" : "101 California Street",
    "line2" : null,
    "line3" : null,
    "line4" : null,
    "city" : "San Francisco",
    "countyOrProvince" : "California",
    "zipOrPostcode" : "94111",
    "country" : "US"
  },
  "primaryContactName" : "Foo Bar",
  "primaryContactPhone" : "+1234567890",
  "primaryContactEmail" : "foo@example.com",
  "fundingRef" : "myFundingRef",
  "kycState" : "REQUIRES_KYC",
  "manualLockout" : false
}

← Previous

Replace Link

Next →

Replace Link