Orders

Get Orders

get

Get order router history for user using whatever filters are supplied

Authorizations

APIKeyHeader

x-api-keystringRequired

Query parameters

order_idany ofOptional

stringOptional

or

nullOptional

start_dateany ofOptional

stringOptional

or

nullOptional

end_dateany ofOptional

stringOptional

or

nullOptional

live_onlyany ofOptionalDefault: false

booleanOptional

or

nullOptional

sub_account_idany ofOptional

stringOptional

or

nullOptional

status_listany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

404

Not found

422

Validation Error

application/json

get

/v1/orders

HTTPcURLJavaScriptPython

GET /api/v1/orders HTTP/1.1
Host: 
x-api-key: YOUR_API_KEY
Accept: */*

No content

Create Order

post

Create an order from a quote

Authorizations

APIKeyHeader

x-api-keystringRequired

Body

application/json

quote_idstringRequired

sub_account_idany ofOptional

stringOptional

or

nullOptional

invoice_pathany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

404

Not found

422

Validation Error

application/json

post

/v1/orders

HTTPcURLJavaScriptPython

POST /api/v1/orders HTTP/1.1
Host: 
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 65

{
  "quote_id": "text",
  "sub_account_id": "text",
  "invoice_path": "text"
}

No content

Create Order Batch

post

Create orders from a batch of quotes

Authorizations

APIKeyHeader

x-api-keystringRequired

Bodyany[]

application/json

itemsanyOptional

Responses

200

Successful Response

application/json

Responseany

404

Not found

422

Validation Error

application/json

post

/v1/order/batch

HTTPcURLJavaScriptPython

POST /api/v1/order/batch HTTP/1.1
Host: 
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 2

[]

No content

Get Order By Id

get

Get single order router for user

Authorizations

APIKeyHeader

x-api-keystringRequired

Path parameters

order_idstringRequired

Responses

200

Successful Response

application/json

Responseany

404

Not found

422

Validation Error

application/json

get

/v1/orders/{order_id}

HTTPcURLJavaScriptPython

GET /api/v1/orders/{order_id} HTTP/1.1
Host: 
x-api-key: YOUR_API_KEY
Accept: */*

No content

Confirm User Transfer

post

This endpoint applies only for: Mexdollar -> USD payment

User confirms they have sent Mexdollar Via SPID for a Mexdollar -> USD payment

Authorizations

APIKeyHeader

x-api-keystringRequired

Body

application/json

order_idstringRequired

Responses

200

Successful Response

application/json

Responseany

404

Not found

422

Validation Error

application/json

post

/v1/orders/spid/confirm_transfer

HTTPcURLJavaScriptPython

POST /api/v1/orders/spid/confirm_transfer HTTP/1.1
Host: 
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 19

{
  "order_id": "text"
}

No content