Get bank field limits

Per-field length limits the destination rail imposes on bank details, keyed by form field name, or `limits: null` when the rail imposes none. A pure cached read (unlike transaction.getTransferRequirements, which registers upstream state), so the UI can call it on form open to cap inputs.

Request Body

application/jsonRequired

typeRequiredstring

Value in:

"AUD_NPP" | "USD_ACH" | "USD_WIRE" | "USD_SWIFT" | "SGD_SWIFT" | "HKD_SWIFT" | "HKD_FPS" | "HKD_CHATS" | "CNY_SWIFT" | "MXN_SPEI" | "MXN_SWIFT" | "COP_SWIFT" | "BRL_PIX" | "BRL_SWIFT" | "GBP_FPS" | "EUR_SEPA" | "EUR_SWIFT" | "INR_IMPS" | "INR_SWIFT" | "AED_SWIFT" | "IDR_SWIFT"

recipient_idstring

Response Body

Successful response

TypeScript Definitions

Use the response body type in TypeScript.

dataRequiredobject

Error response

TypeScript Definitions

Use the response body type in TypeScript.

errorRequiredobject

curl -X POST "/v1/account.external.bank.fieldLimits" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "AUD_NPP",
    "recipient_id": "string"
  }'

const body = JSON.stringify({
  "type": "AUD_NPP",
  "recipient_id": "string"
})

fetch("/v1/account.external.bank.fieldLimits", {
  body
})

package main

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

func main() {
  url := "/v1/account.external.bank.fieldLimits"
  body := strings.NewReader(`{
    "type": "AUD_NPP",
    "recipient_id": "string"
  }`)
  req, _ := http.NewRequest("POST", url, body)
  req.Header.Add("Content-Type", "application/json")
  res, _ := http.DefaultClient.Do(req)
  defer res.Body.Close()
  body, _ := ioutil.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))
}

import requests

url = "/v1/account.external.bank.fieldLimits"
body = {
  "type": "AUD_NPP",
  "recipient_id": "string"
}
response = requests.request("POST", url, json = body, headers = {
  "Content-Type": "application/json"
})

print(response.text)

{
  "data": {
    "limits": {
      "property1": {
        "max_length": 0
      },
      "property2": {
        "max_length": 0
      }
    }
  }
}

{
  "error": {
    "code": "PARSE_ERROR",
    "message": "string"
  }
}