Quick Start
Last updated
Last updated
Learn how to operate with our API. In this example, the process begins from zero and ends when a user makes a CAD (Canadian Dollar) payment, receiving it in PHP (Philippine peso).
Without authenticating yourself first, you won't be able to use our API.
Before the new user can engage with us, we must verify their identity successfully.
The user will encounter a form similar to this one and must provide all the necessary information:
After all the information has been provided and submitted, we will proceed to validate it.
Once we successfully validate it, the user will be notified.
If necessary, because we cannot validate the user's information on the first attempt, we will request it again.
Once the user completes the payment with their bank, we will proceed to transfer the agreed-upon funds to the receiver's bank.
Please refer to our Webhooks reference to receive orders and KYC notifications. We will notify you when a user has successfully validated their identity and when an order has been paid and processed.
/auth
Your private access identification
13lk24jk14j
Your private access secret identification
A13IAKSPTOLXM1
Your ID
123
User external client ID
ABCD
/user
User first name
John
User last name
Doe
User email
johndoe@example.com
User address
Harcourt 4567
User city
Toronto
User state/province
Ontario
User ISO 3166 country code
CAN
User postal code
M4C
/kyc/register/{kycLevel}//{zone}
The KYC Level wanted for the KYC form instance
noKyc
, firstLevel
, secondLevel
The zone for the KYC form instance
CAN
, EUR
No body
/order/intent
FIAT currency user wants to send
CAD
CAD
, PHP
, MXN
FIAT currency that will be received
PHP
CAD
, PHP
, MXN
/rates
The FIAT currency to be sent by the user
CAD
CAD
, PHP
, MXN
The FIAT currency to be received
PHP
CAD
, PHP
, MXN
The Amount of fiatIn to be sent by the user
100
/order
The Rate code that contains the currencies and amounts of the order
AHOQWIRTZXV12
Details of the sender
Details of the Receiver