Skip to main content
POST
/
v3
/
api
/
transfer-rule
/
wallets
Retrieve transfer rules
curl --request POST \
  --url https://api.custody.api-zodia.io/v3/api/transfer-rule/wallets \
  --header 'Content-Type: application/json' \
  --header 'X-Signature: <api-key>' \
  --header 'submitter-id: <submitter-id>' \
  --data '
{
  "ids": [
    "<string>"
  ],
  "walletIds": [
    "ZTEST-NOBENF-W5NZ2XCZMF"
  ],
  "statuses": [
    "ACTIVE"
  ],
  "companyIds": [
    "ZTEST"
  ],
  "enforcingCompanyIds": [
    "<string>"
  ],
  "transferRuleTypes": [
    "DESTINATION"
  ],
  "createdBy": [
    "api-maker@zodia.io"
  ],
  "updatedAt": "2021-05-11T04:43:43Z",
  "paginationLimit": 10,
  "paginationOffset": 123
}
'
[
  {
    "total": 123,
    "items": [
      {
        "id": "<string>",
        "walletId": "<string>",
        "walletName": "<string>",
        "walletType": "<string>",
        "companyId": "<string>",
        "isTrading": true,
        "enforcingCompanyId": "<string>",
        "transferRuleType": "DESTINATION",
        "status": "ACTIVE",
        "updatedAt": "2021-05-11 04:43:43",
        "updatedBy": "<string>",
        "walletOwner": "<string>",
        "transferRuleDefinition": [
          {
            "allowedDestinations": [
              {
                "value": "<string>",
                "name": "<string>",
                "address": "<string>",
                "type": "WALLET_ID"
              }
            ]
          }
        ],
        "currencyId": "<string>",
        "currency": "<string>",
        "expiresAt": "2021-05-11 04:43:43",
        "tradingVenueId": "<string>"
      }
    ]
  }
]

Authorizations

X-Signature
string
header
required

Headers

submitter-id
string
required

Email of API user submitting the request

Example:

"api-maker@zodia.io"

Body

application/json
ids
string[]

Search by transfer rule IDs

walletIds
string[]

Search by wallet IDs on which transfer rules are applied

statuses
enum<string>[]

Search by status

Available options:
ACTIVE,
DEACTIVATED,
EXPIRED
companyIds
string[]

Search by company IDs

enforcingCompanyIds
string[]

Search by enforcing company IDs

transferRuleTypes
enum<string>[]

Search by transfer rule types

Available options:
DESTINATION
createdBy
string[]

Search by transfer rule creator

updatedAt
string

Search by time of last update

Example:

"2021-05-11T04:43:43Z"

paginationLimit
number

Number of items in response (default is 10)

Example:

10

paginationOffset
number

Response

OK

total
integer
required
items
object[]
required