---
title: "Read payment information"
method: POST
path: "/read_payment_information"
tags: ["Other"]
---

# Read payment information

`POST /read_payment_information`

This endpoint reads payment information from the document contained in
the request body.

The following documents are currencly supported:

- Content of QR code found in QR bills

## Response `200`

Payment information

- object
  - `amount` string — Decimal number. Output amount of the exchange; amount to be received by the output object. The output amount is all inclusive. Costs and fees are included.
  - `bic_swift` string
  - `currency` string
  - `iban` string
  - `owner` union
    - object
      - `name` string
      - `address` string
      - `address_complement` string
      - `city` string
      - `country` string — Two-letter country code (ISO 3166-1 alpha-2).
      - `state` string
      - `zip` string
    - object
      - `name` string
      - `building_name` string
      - `building_number` string
      - `country` string — Two-letter country code (ISO 3166-1 alpha-2).
      - `country_subdivision` string — Identifies a subdivision of the country such as a state or region.
      - `department` string — Identifies a part of large organization or large building.
      - `district_name` string — Identifies a subdivision of the country subdivision.
      - `floor` string
      - `post_box` string
      - `post_code` string
      - `room` string
      - `street_name` string
      - `subdepartment` string — Identifies a subdivision within a department of a large organization or large building.
      - `town_location_name` string — Identifies a location within a town.
      - `town_name` string
  - `qr_reference` string — QR Bill reference (QR reference)
  - `reference` string
  - `structured_creditor_reference` string — Structured creditor reference (ISO 11649).
  - `type` 'bank_account', required
  - `ultimate_debtor` union
    - object — Information about the ultimate debtor.
      - `name` string
      - `address` string
      - `address_complement` string
      - `city` string
      - `country` string — Two-letter country code (ISO 3166-1 alpha-2).
      - `state` string
      - `zip` string
    - object — Information about the ultimate debtor.
      - `name` string
      - `building_name` string
      - `building_number` string
      - `country` string — Two-letter country code (ISO 3166-1 alpha-2).
      - `country_subdivision` string — Identifies a subdivision of the country such as a state or region.
      - `department` string — Identifies a part of large organization or large building.
      - `district_name` string — Identifies a subdivision of the country subdivision.
      - `floor` string
      - `post_box` string
      - `post_code` string
      - `room` string
      - `street_name` string
      - `subdepartment` string — Identifies a subdivision within a department of a large organization or large building.
      - `town_location_name` string — Identifies a location within a town.
      - `town_name` string

## Other responses

- `400` — Error

---

[API](https://skmtc.dev/bity/apis/bity-exchange-api.md) · [All operations](https://skmtc.dev/bity/apis/bity-exchange-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/bity/bity-exchange-api/revisions/fd48443fbac2/schema)