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

Authorizations

Body

sendFiatstring · enumrequired

FIAT currency user wants to send

Example: CAD

Options: CAD, PHP, MXN

receiveFiatstring · enumrequired

FIAT currency that will be received

Example: PHP

Options: CAD, PHP, MXN

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/order/intent' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "sendFiat": "CAD",
    "receiveFiat": "PHP"
  }'

200

401

500

200

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

Required fields to create an order

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

Authorizations

Body

rateCodestringrequired

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

Example: AHOQWIRTZXV12

senderDetailsall ofrequired

Details of the sender

receiverDetailsall ofrequired

Details of the Receiver

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/order' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "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"
      }
    }
  }'

200

401

500

200

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

The created Order

Get an Order by ID

Find a Order by ID

get

/order/{id}

Authorizations

Path parameters

idnumberrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/order/{id}' \
  --header 'Authorization: Bearer JWT'

200

401

500

200

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

The found Order

Get all orders for the user

Find all Orders for a user

get

/order/all

Authorizations

Query parameters

maxAmountnumber · min: 1 · default: 100000

minAmountnumber · min: 1 · default: 1

statusstring · enum

Options: INITIATED, PENDING USER, CASH IN PROCESSING, CASH IN PROCESSED, CASH OUT PROCESSING, CASH OUT PROCESSED, PROCESSED, FAILED, CANCELED

orderstring · enum · default: ASC

Options: ASC, DESC

pagenumber · min: 1 · default: 1

takenumber · min: 1 · max: 50 · default: 10

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/order/all' \
  --header 'Authorization: Bearer JWT'

200

401

500

200

{
  "data": [
    {
      "id": 1,
      "userId": 1,
      "amountIn": 100,
      "amountOut": 100,
      "fiatIn": "CAD",
      "fiatOut": "PHP",
      "serviceFee": 10,
      "status": "PENDING USER"
    }
  ],
  "meta": {
    "page": 1,
    "take": 1,
    "itemCount": 1,
    "pageCount": 1,
    "hasPreviousPage": true,
    "hasNextPage": true
  }
}

The list of Orders for that user

Cancel an Order by ID

Cancel a order by ID

patch

/order/cancel/{id}

Authorizations

Path parameters

idnumberrequired

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PATCH \
  --url '/order/cancel/{id}' \
  --header 'Authorization: Bearer JWT'

200

401

500

200

No body

Ok