Orders

You need a Rate Code first: In order to create an order, you need to provide a Rate Code, this Rate will contain information about the amounts and currencies for the Order.

Find required fields to create an 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

JavaScriptCurlPythonHTTP

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

Create an Order

Before creating a new Order, you must know what sender and receiver details fields are required for a pair of currencies. Both (sender and receiver) might need personDetails, financialDetails and orderDetails.

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

JavaScriptCurlPythonHTTP

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"
}

Get an Order by ID

Find a Order by ID

GET/order/{id}

Authorization

bearer

Path parameters

id*number

Response

200401500

The found 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

JavaScriptCurlPythonHTTP

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

Response

200

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

Get all orders for the user

Find all Orders for a user

GET/order/all

Authorization

bearer

Query parameters

Response

200401500

The list of Orders for that user

Body

application/json

data*array of OrderDto (object)

meta*PageMetaDto (object)

Request

JavaScriptCurlPythonHTTP

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

Response

200

{
  "data": [
    {
      "id": 1,
      "userId": 1,
      "amountIn": 100,
      "amountOut": 100,
      "fiatIn": "CAD",
      "fiatOut": "CAD",
      "serviceFee": 10,
      "status": "INITIATED"
    }
  ],
  "meta": {
    "page": 0,
    "take": 0,
    "itemCount": 0,
    "pageCount": 0,
    "hasPreviousPage": false,
    "hasNextPage": false
  }
}

Cancel an Order by ID

Cancel a order by ID

PATCH/order/cancel/{id}

Authorization

bearer

Path parameters

id*number

Response

200401500

Ok

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/order/cancel/{id}', {
    method: 'PATCH',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();