Quick Start

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).

Authenticate yourself

All your request must be authenticated, we will provide the required fields for this step.

Without authenticating yourself first, you won't be able to use our API.

Obtain your token before start interacting with our API

POST/auth

Body

application/json

accessId*string

Your private access identification

Example: "13lk24jk14j"

secretId*string

Your private access secret identification

Example: "A13IAKSPTOLXM1"

merchantId*number

Your ID

Example: 123

externalClientIdstring

User external client ID

Example: "ABCD"

Response

200500

Your access token, required to do requests

Body

application/json

accessToken*string

Access token, used for authentication

Example: "=12039124JUKASKNAUJRWRHRNA"

expiresIn*number

Lifetime for the token in seconds

Example: 3600

tokenType*string

Authentication type

Example: "Bearer"

Request

JavaScriptCurlPython

const response = await fetch('/auth', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "accessId": "13lk24jk14j",
      "secretId": "A13IAKSPTOLXM1",
      "merchantId": 123
    }),
});
const data = await response.json();

Response

200

{
  "accessToken": "=12039124JUKASKNAUJRWRHRNA",
  "expiresIn": 3600,
  "tokenType": "Bearer"
}

---

Create a user

We need to know about your user existence.

Create a new User

POST/user

Authorization

bearer

Body

application/json

firstName*string

User first name

Example: "John"

lastName*string

User last name

Example: "Doe"

email*string

User email

Example: "[e-mail]"

address*string

User address

Example: "Harcourt 4567"

city*string

User city

Example: "Toronto"

stateProvince*string

User state/province

Example: "Ontario"

countryCode*string

User ISO 3166 country code

Example: "CAN"

postalCode*string

User postal code

Example: "M4C"

Response

200401500

Created user

Body

application/json

externalClientId*string

External provider client identifier

Example: "ABC-123"

id*number

Internal client identifier

Example: 1

Request

JavaScriptCurlPython

const response = await fetch('/user', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "firstName": "John",
      "lastName": "Doe",
      "email": "[e-mail]",
      "address": "Harcourt 4567",
      "city": "Toronto",
      "stateProvince": "Ontario",
      "countryCode": "CAN",
      "postalCode": "M4C"
    }),
});
const data = await response.json();

Response

200

{
  "externalClientId": "ABC-123",
  "id": 1
}

---

Create a Form for the user, allowing him to complete the required information.

Before the new user can engage with us, we must verify their identity successfully.

Get a form to register a user KYC

GET/kyc/register/{kycLevel}/{zone}

Authorization

bearer

Path parameters

kycLevel*enum

The KYC Level wanted for the KYC form instance

noKycfirstLevelsecondLevel

zone*enum

The zone for the KYC form instance

CANEUR

Response

200401500

HTML response with the KYC form, used by a user to register their KYC

Request

JavaScriptCurlPython

const response = await fetch('/kyc/register/{kycLevel}/{zone}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

About our KYC form

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.

---

Create the order

You will need to know the information required to create the order.

Find order requirements

GET/order/intent

Authorization

bearer

Body

application/json

sendFiat*FiatCode (enum)

CADPHPMXN

receiveFiat*FiatCode (enum)

CADPHPMXN

Response

200401500

Required fields to create an order

Body

application/json

rateCode*string

Required rate code, will have information about the order

Example: "A valid rate code provided by the app"

senderDetails*all of

Required fields for the sender

receiverDetails*all of

Required fields for the receiver

Request

JavaScriptCurlPython

const response = await fetch('/order/intent', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "sendFiat": "CAD",
      "receiveFiat": "CAD"
    }),
});
const data = await response.json();

Response

200

{
  "rateCode": "A valid rate code provided by the app",
  "senderDetails": {
    "personDetails": {
      "emailAddress": {
        "description": "<p>Email address</p>",
        "__$markdownParsed": true
      },
      "firstName": {
        "description": "<p>Family or last name</p>",
        "__$markdownParsed": true
      },
      "lastName": {
        "description": "<p>Given or first name</p>",
        "__$markdownParsed": true
      },
      "address": {
        "description": "<p>Entire address (country, state, postal code, street address, etc...) as a multi-line string</p>",
        "__$markdownParsed": true
      },
      "country": {
        "description": "<p>Name of country</p>",
        "__$markdownParsed": true
      },
      "city": {
        "description": "<p>Name of city/town</p>",
        "__$markdownParsed": true
      },
      "stateOrProvince": {
        "description": "<p>Name of state/province/region/prefecture</p>",
        "__$markdownParsed": true
      },
      "idCountryCode": {
        "description": "<p>Country issuing passport or photo ID as ISO 3166-1 alpha-3 code</p>",
        "__$markdownParsed": true
      },
      "postalCode": {
        "description": "<p>Postal or other code identifying user's locale</p>",
        "__$markdownParsed": true
      }
    },
    "financialDetails": {
      "bankAccountNumber": {
        "description": "<p>Number identifying bank account</p>",
        "__$markdownParsed": true
      },
      "bankCode": {
        "description": "<p>Bank code to determine which bank the funds will arrive at</p>",
        "__$markdownParsed": true
      },
      "holderName": {
        "description": "<p>Bank account holder name</p>",
        "__$markdownParsed": true
      }
    },
    "orderDetails": {
      "purpose": {
        "description": "<p>Purpose or reason for this transaction</p>",
        "__$markdownParsed": true
      },
      "relationshipWithBeneficiary": {
        "description": "<p>Relationship with beneficiary</p>",
        "__$markdownParsed": true
      },
      "method": {
        "description": "<p>Method of payment: PAY-TO-ACCOUNT-REAL-TIME or PAY-TO-ACCOUNT-NON-REAL-TIME</p>",
        "__$markdownParsed": true
      }
    }
  },
  "receiverDetails": {
    "personDetails": {
      "emailAddress": {
        "description": "<p>Email address</p>",
        "__$markdownParsed": true
      },
      "firstName": {
        "description": "<p>Family or last name</p>",
        "__$markdownParsed": true
      },
      "lastName": {
        "description": "<p>Given or first name</p>",
        "__$markdownParsed": true
      },
      "address": {
        "description": "<p>Entire address (country, state, postal code, street address, etc...) as a multi-line string</p>",
        "__$markdownParsed": true
      },
      "country": {
        "description": "<p>Name of country</p>",
        "__$markdownParsed": true
      },
      "city": {
        "description": "<p>Name of city/town</p>",
        "__$markdownParsed": true
      },
      "stateOrProvince": {
        "description": "<p>Name of state/province/region/prefecture</p>",
        "__$markdownParsed": true
      },
      "idCountryCode": {
        "description": "<p>Country issuing passport or photo ID as ISO 3166-1 alpha-3 code</p>",
        "__$markdownParsed": true
      },
      "postalCode": {
        "description": "<p>Postal or other code identifying user's locale</p>",
        "__$markdownParsed": true
      }
    },
    "financialDetails": {
      "bankAccountNumber": {
        "description": "<p>Number identifying bank account</p>",
        "__$markdownParsed": true
      },
      "bankCode": {
        "description": "<p>Bank code to determine which bank the funds will arrive at</p>",
        "__$markdownParsed": true
      },
      "holderName": {
        "description": "<p>Bank account holder name</p>",
        "__$markdownParsed": true
      }
    },
    "orderDetails": {
      "purpose": {
        "description": "<p>Purpose or reason for this transaction</p>",
        "__$markdownParsed": true
      },
      "relationshipWithBeneficiary": {
        "description": "<p>Relationship with beneficiary</p>",
        "__$markdownParsed": true
      },
      "method": {
        "description": "<p>Method of payment: PAY-TO-ACCOUNT-REAL-TIME or PAY-TO-ACCOUNT-NON-REAL-TIME</p>",
        "__$markdownParsed": true
      }
    }
  }
}

Now, You will create a rate with the amount and currency the user wants to send.

Create a Rate

POST/rates

Authorization

bearer

Body

application/json

fiatIn*FiatCode (enum)

CADPHPMXN

fiatOut*FiatCode (enum)

CADPHPMXN

amountIn*number

The Amount of fiatIn to be sent by the user

Example: 100

Response

200401500

The created rate

Body

application/json

fiatIn*FiatCode (enum)

CADPHPMXN

fiatOut*FiatCode (enum)

CADPHPMXN

amountIn*number

The Amount of fiatIn to be sent by the user

Example: 100

amountOut*number

The Amount of fiatOut to be received

Example: 100

rate*number

The Unit price

Example: 1

code*string

The Code for this rate, required when creating Orders

Example: "APIWQRQWKZXV"

expirationDate*string (date-time)

The Expiration Date for this rate, passed this time Rate will be useless

Example: "2024-04-15T12:37:34.794Z"

Request

JavaScriptCurlPython

const response = await fetch('/rates', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "fiatIn": "CAD",
      "fiatOut": "CAD",
      "amountIn": 100
    }),
});
const data = await response.json();

Response

200

{
  "fiatIn": "CAD",
  "fiatOut": "CAD",
  "amountIn": 100,
  "amountOut": 100,
  "rate": 1,
  "code": "APIWQRQWKZXV",
  "expirationDate": "2024-04-15T12:37:34.794Z"
}

Now, the order can be created.

Create a new Order

POST/order

Authorization

bearer

Body

application/json

rateCode*string

The Rate code that contains the currencies and amounts of the order

Example: "AHOQWIRTZXV12"

senderDetails*all of

Details of the sender

receiverDetails*all of

Details of the Receiver

Response

200401500

The created Order

Body

application/json

id*number

The Order ID

Example: 1

userId*number

The User ID, owner of the order

Example: 1

amountIn*number

The amount of fiatIn for the order

Example: 100

amountOut*number

The amount of fiatOut for the order

Example: 100

fiatIn*FiatCode (enum)

CADPHPMXN

fiatOut*FiatCode (enum)

CADPHPMXN

serviceFee*number

The service fee for the order

Example: 10

status*OrderStatus (enum)

INITIATEDPENDING USERCASH IN PROCESSINGCASH IN PROCESSEDCASH OUT PROCESSINGCASH OUT PROCESSEDPROCESSEDFAILEDCANCELED

Request

JavaScriptCurlPython

const response = await fetch('/order', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "rateCode": "AHOQWIRTZXV12",
      "senderDetails": {
        "personDetails": {
          "firstName": "John",
          "lastName": "Doe",
          "address": "123 Main Street",
          "city": "Toronto",
          "stateOrProvince": "Ontario",
          "idCountryCode": "CAN",
          "country": "Canada",
          "postalCode": "18934"
        },
        "financialDetails": {
          "bankCountryId": "CAN",
          "bankName": "BBVA",
          "holderName": "John Doe",
          "bankRoutingNumber": "123-45678",
          "bankAccountNumber": "3456789",
          "achCode": "ACH",
          "swiftBicCode": "SWIFT"
        },
        "orderDetails": {
          "purpose": "Gift",
          "relationshipWithBeneficiary": "Colleague",
          "method": "PAY-TO-ACCOUNT-REAL-TIME"
        }
      },
      "receiverDetails": {
        "personDetails": {
          "firstName": "John",
          "lastName": "Doe",
          "address": "123 Main Street",
          "city": "Toronto",
          "stateOrProvince": "Ontario",
          "idCountryCode": "CAN",
          "country": "Canada",
          "postalCode": "18934"
        },
        "financialDetails": {
          "bankCountryId": "CAN",
          "bankName": "BBVA",
          "holderName": "John Doe",
          "bankRoutingNumber": "123-45678",
          "bankAccountNumber": "3456789",
          "achCode": "ACH",
          "swiftBicCode": "SWIFT"
        },
        "orderDetails": {
          "purpose": "Gift",
          "relationshipWithBeneficiary": "Colleague",
          "method": "PAY-TO-ACCOUNT-REAL-TIME"
        }
      }
    }),
});
const data = await response.json();

Response

200

{
  "id": 1,
  "userId": 1,
  "amountIn": 100,
  "amountOut": 100,
  "fiatIn": "CAD",
  "fiatOut": "CAD",
  "serviceFee": 10,
  "status": "INITIATED"
}

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.

Webhooks