Get limitations

GET

limitations

Get limitations

const options = {
  method: 'GET',
  headers: {'Melio-Entity-Id': '<melio-entity-id>', 'api-key': '<api-key>'}
};

fetch('https://api.melio.com/v2/limitations', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.melio.com/v2/limitations"

headers = {
    "Melio-Entity-Id": "<melio-entity-id>",
    "api-key": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

require 'uri'
require 'net/http'

url = URI("https://api.melio.com/v2/limitations")

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

request = Net::HTTP::Get.new(url)
request["Melio-Entity-Id"] = '<melio-entity-id>'
request["api-key"] = '<api-key>'

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

package main

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

func main() {

	url := "https://api.melio.com/v2/limitations"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Melio-Entity-Id", "<melio-entity-id>")
	req.Header.Add("api-key", "<api-key>")

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

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

	fmt.Println(string(body))

}

{
  "capabilities": [
    {
      "operation": "payment.domestic:write",
      "allowed": false,
      "reasons": [
        {
          "code": "MissingInformation",
          "message": "Additional information is required before this business can send payments.",
          "missingFields": [
            "taxInfo"
          ]
        }
      ]
    },
    {
      "operation": "account.internal:write",
      "allowed": true,
      "reasons": []
    },
    {
      "operation": "account.external:write",
      "allowed": true,
      "reasons": []
    }
  ]
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "VALIDATION_ERROR",
    "message": "<string>",
    "details": {}
  }
}

Authorizations

api-key

string

header

required

Headers

Melio-Entity-Id

string

required

Entity the request operates on — an entity id (ent_<uuid>) or me (the partner's sole entity).

Response

Limitations.

The business's per-operation capabilities. Every entry reports whether a write operation (create/update/delete) is allowed today and, if not, why. Only limitable operations are listed; read operations are always allowed and never appear. New operations will be added over time.

capabilities

object[]

required

Hide child attributes

capabilities.operation

enum<string>

required

The operation a capability gates, named inline as resource.subtype:action. write covers create, update and delete; only write operations can be limited. Read operations are always allowed and are never listed. New operations will be added to this enum over time; treat unknown values leniently.

payment.domestic:write and payment.international:write are decided independently — which one applies to a payment is determined by the receiving account's rail, so a business may be able to pay domestically while being blocked internationally, or the reverse. payment.international:write also reports the onboarding data still outstanding (see PUT /entities/{entityId}/beneficial-owners), not only risk restrictions.

Available options:

payment.domestic:write,

payment.international:write,

account.internal:write,

account.external:write

capabilities.allowed

boolean

required

Whether the business may perform this operation today.

capabilities.reasons

object[]

required

The reasons this operation is not allowed. Empty when allowed is true.

Hide child attributes

capabilities.reasons.code

enum<string>

required

Machine-readable reason code. New codes will be added over time; treat unknown values leniently.

Available options:

MissingInformation,

EntityBlocked,

EntityUnderReview,

EntityUnresponsive,

OutstandingBalance,

LocationRestricted

capabilities.reasons.message

string

required

Static, English-language message, safe to show to your users.

capabilities.reasons.missingFields

string[]

required

Dot-paths to the Entity fields that must be completed to lift this reason, e.g. "taxInfo". Empty when the reason is not about missing information.

capabilities.reasons.contactEmail

string

Melio contact address for resolving this reason. Present only when a contact address is available for the limitation; omitted otherwise.

Get limitations

const options = {
  method: 'GET',
  headers: {'Melio-Entity-Id': '<melio-entity-id>', 'api-key': '<api-key>'}
};

fetch('https://api.melio.com/v2/limitations', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.melio.com/v2/limitations"

headers = {
    "Melio-Entity-Id": "<melio-entity-id>",
    "api-key": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

require 'uri'
require 'net/http'

url = URI("https://api.melio.com/v2/limitations")

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

request = Net::HTTP::Get.new(url)
request["Melio-Entity-Id"] = '<melio-entity-id>'
request["api-key"] = '<api-key>'

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

package main

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

func main() {

	url := "https://api.melio.com/v2/limitations"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Melio-Entity-Id", "<melio-entity-id>")
	req.Header.Add("api-key", "<api-key>")

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

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

	fmt.Println(string(body))

}

{
  "capabilities": [
    {
      "operation": "payment.domestic:write",
      "allowed": false,
      "reasons": [
        {
          "code": "MissingInformation",
          "message": "Additional information is required before this business can send payments.",
          "missingFields": [
            "taxInfo"
          ]
        }
      ]
    },
    {
      "operation": "account.internal:write",
      "allowed": true,
      "reasons": []
    },
    {
      "operation": "account.external:write",
      "allowed": true,
      "reasons": []
    }
  ]
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "VALIDATION_ERROR",
    "message": "<string>",
    "details": {}
  }
}

Entities

Accounts

Attachments

Payments

Tools

Authorizations

Headers

Response