Request a limit increase

curl --request POST \
  --url https://api-sandbox.lumx.io/customers/{id}/limit-requests \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "OFFRAMP",
  "requested": {
    "single": "15000.00",
    "daily": "60000.00",
    "monthly": "120000.00"
  },
  "supportingDocumentId": "9d1e2f3a-4b5c-6d7e-8f90-1a2b3c4d5e6f"
}
'

import requests

url = "https://api-sandbox.lumx.io/customers/{id}/limit-requests"

payload = {
    "type": "OFFRAMP",
    "requested": {
        "single": "15000.00",
        "daily": "60000.00",
        "monthly": "120000.00"
    },
    "supportingDocumentId": "9d1e2f3a-4b5c-6d7e-8f90-1a2b3c4d5e6f"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    type: 'OFFRAMP',
    requested: {single: '15000.00', daily: '60000.00', monthly: '120000.00'},
    supportingDocumentId: '9d1e2f3a-4b5c-6d7e-8f90-1a2b3c4d5e6f'
  })
};

fetch('https://api-sandbox.lumx.io/customers/{id}/limit-requests', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-sandbox.lumx.io/customers/{id}/limit-requests",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'type' => 'OFFRAMP',
    'requested' => [
        'single' => '15000.00',
        'daily' => '60000.00',
        'monthly' => '120000.00'
    ],
    'supportingDocumentId' => '9d1e2f3a-4b5c-6d7e-8f90-1a2b3c4d5e6f'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api-sandbox.lumx.io/customers/{id}/limit-requests"

	payload := strings.NewReader("{\n  \"type\": \"OFFRAMP\",\n  \"requested\": {\n    \"single\": \"15000.00\",\n    \"daily\": \"60000.00\",\n    \"monthly\": \"120000.00\"\n  },\n  \"supportingDocumentId\": \"9d1e2f3a-4b5c-6d7e-8f90-1a2b3c4d5e6f\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api-sandbox.lumx.io/customers/{id}/limit-requests")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"type\": \"OFFRAMP\",\n  \"requested\": {\n    \"single\": \"15000.00\",\n    \"daily\": \"60000.00\",\n    \"monthly\": \"120000.00\"\n  },\n  \"supportingDocumentId\": \"9d1e2f3a-4b5c-6d7e-8f90-1a2b3c4d5e6f\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-sandbox.lumx.io/customers/{id}/limit-requests")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"type\": \"OFFRAMP\",\n  \"requested\": {\n    \"single\": \"15000.00\",\n    \"daily\": \"60000.00\",\n    \"monthly\": \"120000.00\"\n  },\n  \"supportingDocumentId\": \"9d1e2f3a-4b5c-6d7e-8f90-1a2b3c4d5e6f\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "b2e1a2d4-1234-4a3b-9c4d-5e6f7a8b9c0d",
  "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "type": "OFFRAMP",
  "requested": {
    "single": "15000.00",
    "daily": "60000.00",
    "monthly": "120000.00"
  },
  "approved": {
    "single": null,
    "daily": null,
    "monthly": null
  },
  "supportingDocumentType": "LIMIT_REQUEST_BANK_STATEMENT",
  "supportingDocumentId": "9d1e2f3a-4b5c-6d7e-8f90-1a2b3c4d5e6f",
  "status": "IN_REVIEW",
  "reviewComment": null,
  "createdAt": "2024-01-15T10:00:00Z",
  "updatedAt": "2024-01-15T10:00:00Z"
}

Customers

Request a limit increase

This endpoint creates a limit-increase request for a customer. Upload the supporting document first with POST /customers//documents and pass the returned documentId as supportingDocumentId. Each request raises the limits of one transaction type (type), and approval changes only that type’s limits. A customer can have one pending request per type; creating a second pending request for the same type returns 409 with code LIMIT_REQUEST_ALREADY_PENDING.

POST

customers

{id}

limit-requests

Request a limit increase

curl --request POST \
  --url https://api-sandbox.lumx.io/customers/{id}/limit-requests \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "OFFRAMP",
  "requested": {
    "single": "15000.00",
    "daily": "60000.00",
    "monthly": "120000.00"
  },
  "supportingDocumentId": "9d1e2f3a-4b5c-6d7e-8f90-1a2b3c4d5e6f"
}
'

import requests

url = "https://api-sandbox.lumx.io/customers/{id}/limit-requests"

payload = {
    "type": "OFFRAMP",
    "requested": {
        "single": "15000.00",
        "daily": "60000.00",
        "monthly": "120000.00"
    },
    "supportingDocumentId": "9d1e2f3a-4b5c-6d7e-8f90-1a2b3c4d5e6f"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    type: 'OFFRAMP',
    requested: {single: '15000.00', daily: '60000.00', monthly: '120000.00'},
    supportingDocumentId: '9d1e2f3a-4b5c-6d7e-8f90-1a2b3c4d5e6f'
  })
};

fetch('https://api-sandbox.lumx.io/customers/{id}/limit-requests', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-sandbox.lumx.io/customers/{id}/limit-requests",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'type' => 'OFFRAMP',
    'requested' => [
        'single' => '15000.00',
        'daily' => '60000.00',
        'monthly' => '120000.00'
    ],
    'supportingDocumentId' => '9d1e2f3a-4b5c-6d7e-8f90-1a2b3c4d5e6f'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api-sandbox.lumx.io/customers/{id}/limit-requests"

	payload := strings.NewReader("{\n  \"type\": \"OFFRAMP\",\n  \"requested\": {\n    \"single\": \"15000.00\",\n    \"daily\": \"60000.00\",\n    \"monthly\": \"120000.00\"\n  },\n  \"supportingDocumentId\": \"9d1e2f3a-4b5c-6d7e-8f90-1a2b3c4d5e6f\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api-sandbox.lumx.io/customers/{id}/limit-requests")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"type\": \"OFFRAMP\",\n  \"requested\": {\n    \"single\": \"15000.00\",\n    \"daily\": \"60000.00\",\n    \"monthly\": \"120000.00\"\n  },\n  \"supportingDocumentId\": \"9d1e2f3a-4b5c-6d7e-8f90-1a2b3c4d5e6f\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-sandbox.lumx.io/customers/{id}/limit-requests")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"type\": \"OFFRAMP\",\n  \"requested\": {\n    \"single\": \"15000.00\",\n    \"daily\": \"60000.00\",\n    \"monthly\": \"120000.00\"\n  },\n  \"supportingDocumentId\": \"9d1e2f3a-4b5c-6d7e-8f90-1a2b3c4d5e6f\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "b2e1a2d4-1234-4a3b-9c4d-5e6f7a8b9c0d",
  "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "type": "OFFRAMP",
  "requested": {
    "single": "15000.00",
    "daily": "60000.00",
    "monthly": "120000.00"
  },
  "approved": {
    "single": null,
    "daily": null,
    "monthly": null
  },
  "supportingDocumentType": "LIMIT_REQUEST_BANK_STATEMENT",
  "supportingDocumentId": "9d1e2f3a-4b5c-6d7e-8f90-1a2b3c4d5e6f",
  "status": "IN_REVIEW",
  "reviewComment": null,
  "createdAt": "2024-01-15T10:00:00Z",
  "updatedAt": "2024-01-15T10:00:00Z"
}

Authorizations

Authorization

string

header

required

Bearer authentication header on the format Bearer <API_KEY>.

Headers

Idempotency-Key

string<uuid>

Optional UUID v4 idempotency key. If you resend the same key with a different request body, the API returns a 409 error. Cached responses include the header X-Idempotency-Cached: true. Keys expire after 24 hours.

Path Parameters

string<uuid>

required

Customer's unique identifier.

Body

application/json

type

enum<string>

required

Transaction type whose limits the request raises. Approval changes only this type's limits. Each type can have one pending request at a time.

Available options:

ONRAMP,

OFFRAMP,

TRANSFER

Example:

"OFFRAMP"

requested

object

required

Show child attributes

supportingDocumentId

string<uuid>

required

documentId returned by POST /customers/{id}/documents for the uploaded supporting document.

Example:

"9d1e2f3a-4b5c-6d7e-8f90-1a2b3c4d5e6f"

Response

201 - application/json

Resource successfully created.

string<uuid>

Limit request's unique identifier.

Example:

"b2e1a2d4-1234-4a3b-9c4d-5e6f7a8b9c0d"

customerId

string<uuid>

Customer's unique identifier.

Example:

"3c90c3cc-0d44-4b50-8888-8dd25736052a"

type

enum<string> | null

Transaction type whose limits the request raises. Null for requests created before limits were split by transaction type.

Available options:

ONRAMP,

OFFRAMP,

TRANSFER,

null

Example:

"OFFRAMP"

requested

object

Limits requested by the customer.

Show child attributes

approved

object

Limits approved by compliance. Each value is null until reviewed.

Show child attributes

supportingDocumentType

string | null

Example:

"LIMIT_REQUEST_BANK_STATEMENT"

supportingDocumentId

string | null

Example:

"9d1e2f3a-4b5c-6d7e-8f90-1a2b3c4d5e6f"

status

enum<string>

Current status of the limit request.

Available options:

IN_REVIEW,

APPROVED,

PARTIALLY_APPROVED,

REJECTED

Example:

"IN_REVIEW"

reviewComment

string | null

Compliance's comment. Set when rejected or partially approved.

Example:

null

createdAt

string<date-time>

Example:

"2024-01-15T10:00:00Z"

updatedAt

string<date-time>

Also the review timestamp once the request leaves IN_REVIEW.

Example:

"2024-01-15T10:00:00Z"

Customers

Accounts

Destinations

Exchange Rates

Transactions

Partner Fees

Autoconversion Rules

Request a limit increase

Authorizations

Headers

Path Parameters

Body

Response