Introduction

Welcome to gotipay.

The gotipay API is based on REST principles, offering a predictable and flexible integration experience for developers embedding financial flows into their applications.

The API suite offers a diverse range of products, including global business accounts, payments acceptance, spend management, and more. Sandbox accounts are available for testing integrations in a secure environment. For more details, see Sandbox environment overview.

API EndpointEnvironment
https://api-demo.gotipay.com/api/v1/Sandbox
https://api.gotipay.com/api/v1/Production

Getting Started

An example workflow is set out below for guidance on how the gotipay API operates in practice.

In this example, we want to make a HKD$10,000 transfer in HKD to a beneficiary in HK, funded by an available account balance in USD. Sandbox environment overview.

1. Authentication

To begin you will need to obtain an access token. Using your unique Client ID and API key (found in the API menu in the gotipay Web App) you can call the Authentication API endpoint. On success, an access token will be granted.

curl -X POST https://api-demo.gotipay.com/api/v1/authentication/login \ -H "Content-Type: application/json" \ -d '{"client_id":"YOUR_CLIENT_ID","api_key":"YOUR_API_KEY"}'
curl -X POST https://api-demo.gotipay.com/api/v1/authentication/login \ -H "Content-Type: application/json" \ -d '{"client_id":"YOUR_CLIENT_ID","api_key":"YOUR_API_KEY"}'

Data Types

This section describes the data types and formats used consistently in the API.

DATA TYPES

Dates

Dates (without time/timezone information) in YYYY-MM-DD format. Sample use cases: conversion_date, payment_date

Timestamps

Date & time in YYYY-MM-DDTHH:mm:ssZ format (ISO 8601). Sample use cases: settlement_cutoff_time, created_at, last_updated_at

Country Codes

Two-letter ISO 3166-2 country code.

Currency Codes

Three-letter ISO 4217 currency code.
Example values
Date2017-03-26
Timestamp2017-03-26T16:30:00+1100
Country CodeAU
Country CodeAUD