Retrieve contact channels

Return currently available payment methods, limits, fees and blockers. Capabilities are a point-in-time eligibility read, not a transfer quote.

GET /contacts/{contactId}/capabilities

Retrieve contact channels

cURL

curl --request GET \
  --url https://api.example.com/contacts/{contactId}/capabilities \
  --header 'Authorization: Bearer <token>'

200

{
  "contactId": "ct_9f2c1ab84d7e4f1fa3c65b0e7d9a2c41",
  "available": true,
  "options": [
    {
      "method": "<string>",
      "currency": "<string>",
      "available": true,
      "minAmount": "500.00",
      "bankId": "bnk_9f2c1ab84d7e4f1fa3c65b0e7d9a2c41",
      "maxAmount": "500.00",
      "feeBps": 0,
      "fixedFee": "500.00",
      "purposeRequired": false,
      "memoRequired": false,
      "documentsRequired": false,
      "blockers": [
        {
          "code": "contact_details_missing",
          "message": "<string>",
          "field": "<string>"
        }
      ]
    }
  ],
  "blockers": [
    {
      "code": "contact_details_missing",
      "message": "<string>",
      "field": "<string>"
    }
  ]
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-Hevn-Account · string | null

The client account to act for, as a cl_… id. Omit it to act as yourself.

Example:

"cl_9f2c1ab84d7e4f1fa3c65b0e7d9a2c41"

x-api-key · string | null

Path Parameters

contactId · string · required

Query Parameters

amount · string | null

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

Example:

"500.00"

Response

200

application/json

Successful Response

contactId · string · required

Saved contact associated with these capabilities.

Pattern: ^(?:ct_)?[A-Za-z0-9._:\-]{1,216}$

Example:

"ct_9f2c1ab84d7e4f1fa3c65b0e7d9a2c41"

available · boolean · required

Whether at least one payout option is currently available.

options · ContactCapabilityOption · object[]

Available transfer options.

Show child attributes

blockers · ContactBlockerView · object[]

Contact-wide blockers.

Show child attributes