Check if a customer can create more autoramps

curl --request GET \
  --url https://api.sandbox.iron.xyz/api/autoramps/check-limit \
  --header 'X-API-Key: <api-key>'

{
  "can_create": true
}

GET

autoramps

check-limit

Check if a customer can create more autoramps

curl --request GET \
  --url https://api.sandbox.iron.xyz/api/autoramps/check-limit \
  --header 'X-API-Key: <api-key>'

{
  "can_create": true
}

X-API-Key

string

header

required

API Key

customer_id

string<uuid>

required

The customer ID

deposit_account_type

enum<string>

required

The type of deposit account intended (e.g., Iban, Wallet)

Available options:

Iban,

Wallet,

AchWire,

Pix,

Spei,

AfricanBankTransfer,

MobileMoney,

ChapsFps

is_third_party

boolean

required

Whether the intended autoramp is for a third party

Check successful

Can Create Autoramp Response

Indicates whether a customer can create a new autoramp.

can_create

boolean

required

Whether the customer can create a new autoramp based on the provided parameters.

⌘I