Get chain by id

GET

/dr/v1/chains/{chainID}

const url = 'https://sender.sandbox-api.kivra.com/dr/v1/chains/example';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://sender.sandbox-api.kivra.com/dr/v1/chains/example

Fetches information on the given chain

Access scope

PARTNER

Parameters

Path Parameters

chainID

required

string

Chain ID

Responses

200

Successfully fetched chain

application/json

GetChainResponse

object

chain_id

string

partner_id

string

name

string

vat

string

phone

string

icon_url

string

logo_url

string

greenbin_activated

boolean

retained_activated

boolean

address

object

street1

string

street2

string

street3

string

postalcode

string

city

string

state

string

country

string

Example

{
  "chain_id": "012345678901234567890123456789012345678901",
  "partner_id": "1561724304c592809e0b614d33a5258cf697a55fc9",
  "name": "Demo chain",
  "vat": "SE012345678989",
  "address": {
    "street1": "Gatan 1",
    "postalcode": "13254",
    "city": "onebuying",
    "country": "SWE"
  },
  "icon_url": "https://test.url.net/api/v1/resources/156257243392d65d706e044b56b168c452809d68f6",
  "logo_url": "https://test.url.net/api/v1/resources/156257243392d65d706e044b56b168c452809d68f6",
  "greenbin_activated": false,
  "retained_activated": true
}

401

Unauthorized

application/json

ErrorResponse

object

error_code

string

short_message

string

long_message

string

error_detail

Array<string>

Examples

unauthorized

{
  "error_code": "40100",
  "short_message": "unauthorized",
  "long_message": "permission denied"
}

404

Not found

application/json

ErrorResponse

object

error_code

string

short_message

string

long_message

string

error_detail

Array<string>

Examples

resource_not_found

{
  "error_code": "40400",
  "short_message": "not found",
  "long_message": "the requested resource could not be found"
}

500

Internal server error

application/json

ErrorResponse

object

error_code

string

short_message

string

long_message

string

error_detail

Array<string>

Example

{
  "error_code": "50000",
  "short_message": "internal server error",
  "long_message": "unknown error ocurred"
}