GET /service/points-of-sale/:pointOfSaleId

Point of sale details

Get point of sale details

Path Parameters

pointOfSaleId string required

Point of Sale to accept payment (i.e. target account)

Responses

• 200
• 401
• 404

---

Returns a point of sale

application/json

Schema

Example (from schema)

---

Schema

id string

Point of sale unique id

tenant object

Additional Tenant information as configured.

name string

Name of tenant - as configured in administration - Settings

companyName string

Company legal name. As configured in administration - Company info

addressStreet string

Company address street. As configured in administration - Company info

addressStreetNumber string

Company address street number. As configured in administration - Company info

addressCity string

Company address city name. As configured in administration - Company info

addressZipCode string

Company address city ZIP code. As configured in administration - Company info

addressCountry string

Company address country code. As configured in administration - Company info

name string

Point of sale display name as display to the user

iban IBAN

Possible values: >= 15 characters and <= 34 characters

IBAN account number with country prefix

currency CurrencyCode

ISO 4217 currency code.

enabled boolean

Is point of sale enabled (true/false)? If point of sale is disabled than payments against the given point of sale can't be performed.

{
  "id": "my-point-of-sale-123",
  "tenant": {
    "name": "string",
    "companyName": "string",
    "addressStreet": "string",
    "addressStreetNumber": "string",
    "addressCity": "string",
    "addressZipCode": "string",
    "addressCountry": "string"
  },
  "name": "Account top-up",
  "iban": "AT483200000012345865",
  "currency": "EUR",
  "enabled": false
}

Unauthorized

application/json

Schema

Example (from schema)

Example

---

Schema

errorMessage string required

Description of error

errorCode ErrorCode required

Possible values: [invalid_parameter, unauthorized, forbidden, not_found, not_allowed, bad_request, other]

Error code of a specific error. For more details visit https://documentation.fliqa.io/api/errors/{errorCode}

errorSubCode ErrorSubCode

Possible values: [api_key_secret_header_must_be_provided, authorization_header_must_be_provided, access_not_allowed, domain_not_allowed, access_token_expired, invalid_access_scope, not_authorized, phone_or_email_not_registered, phone_number_start_with_plus_and_country, phone_number_invalid, email_invalid, email_or_phone_number_required, invalid_pin, could_not_interpret_numbers_after_plus, supplied_string_not_phone_number, string_supplied_too_short_to_be_phone_number, string_supplied_too_long_to_be_phone_number, string_supplied_was_too_long_to_parse, unspecified]

Error sub code of a specific error. For more details visit https://documentation.fliqa.io/api/errors/{errorCode}#{errorSubCode}

documentationUrl uri

Link to documentation if available, typically https://documentation.fliqa.io/api/errors/{errorCode}

requestId RequestId

Unique request id

resourceId ResourceId

Unique resource id

{
  "errorMessage": "string",
  "errorCode": "unauthorized",
  "errorSubCode": "phone_or_email_not_registered",
  "documentationUrl": "string",
  "requestId": "554099e7d0b648d7b96bc31c148425b8",
  "resourceId": "9c14c6f2f0ee4a54a280be3c18ec1dba"
}

{
  "errorCode": "unauthorized",
  "errorMessage": "Not authorized",
  "documentationUrl": "https://documentation.fliqa.io/api/errors/unauthorized"
}

Point of sale not found

application/json

Schema

Example (from schema)

Example

---

Schema

errorMessage string required

Description of error

errorCode ErrorCode required

Possible values: [invalid_parameter, unauthorized, forbidden, not_found, not_allowed, bad_request, other]

Error code of a specific error. For more details visit https://documentation.fliqa.io/api/errors/{errorCode}

errorSubCode ErrorSubCode

Possible values: [api_key_secret_header_must_be_provided, authorization_header_must_be_provided, access_not_allowed, domain_not_allowed, access_token_expired, invalid_access_scope, not_authorized, phone_or_email_not_registered, phone_number_start_with_plus_and_country, phone_number_invalid, email_invalid, email_or_phone_number_required, invalid_pin, could_not_interpret_numbers_after_plus, supplied_string_not_phone_number, string_supplied_too_short_to_be_phone_number, string_supplied_too_long_to_be_phone_number, string_supplied_was_too_long_to_parse, unspecified]

Error sub code of a specific error. For more details visit https://documentation.fliqa.io/api/errors/{errorCode}#{errorSubCode}

documentationUrl uri

Link to documentation if available, typically https://documentation.fliqa.io/api/errors/{errorCode}

requestId RequestId

Unique request id

resourceId ResourceId

Unique resource id

{
  "errorMessage": "string",
  "errorCode": "unauthorized",
  "errorSubCode": "phone_or_email_not_registered",
  "documentationUrl": "string",
  "requestId": "554099e7d0b648d7b96bc31c148425b8",
  "resourceId": "9c14c6f2f0ee4a54a280be3c18ec1dba"
}

{
  "errorCode": "not_found",
  "errorMessage": "Can't find point of sale 'my_point_of_sale'",
  "documentationUrl": "https://documentation.fliqa.io/api/errors/not_found"
}

Loading...