|
7286 | 7286 | "$ref": "#/components/schemas/EventStatus" |
7287 | 7287 | }, |
7288 | 7288 | "amount": { |
7289 | | - "$ref": "#/components/schemas/AmountEvent" |
| 7289 | + "description": "Amount of the event.", |
| 7290 | + "type": "number", |
| 7291 | + "format": "float" |
7290 | 7292 | }, |
7291 | 7293 | "timestamp": { |
7292 | | - "$ref": "#/components/schemas/TimestampEvent" |
| 7294 | + "description": "Date and time of the transaction event.", |
| 7295 | + "type": "string", |
| 7296 | + "format": "date-time" |
7293 | 7297 | }, |
7294 | 7298 | "fee_amount": { |
7295 | 7299 | "description": "Amount of the fee related to the event.", |
|
7874 | 7878 | "$ref": "#/components/schemas/EventStatus" |
7875 | 7879 | }, |
7876 | 7880 | "amount": { |
7877 | | - "$ref": "#/components/schemas/AmountEvent" |
| 7881 | + "description": "Amount of the event.", |
| 7882 | + "type": "string", |
| 7883 | + "format": "double" |
7878 | 7884 | }, |
7879 | 7885 | "timestamp": { |
7880 | | - "$ref": "#/components/schemas/TimestampEvent" |
| 7886 | + "description": "Date and time of the transaction event.", |
| 7887 | + "type": "string", |
| 7888 | + "format": "date-time" |
7881 | 7889 | }, |
7882 | 7890 | "receipt_no": { |
7883 | 7891 | "type": "string" |
|
8006 | 8014 | "type": "object", |
8007 | 8015 | "properties": { |
8008 | 8016 | "name": { |
8009 | | - "description": "Product name.", |
8010 | | - "type": "string" |
8011 | | - }, |
8012 | | - "description": { |
8013 | | - "description": "Product description.", |
8014 | | - "type": "string" |
| 8017 | + "description": "Product name", |
| 8018 | + "type": "string", |
| 8019 | + "example": "Coffee" |
8015 | 8020 | }, |
8016 | 8021 | "price": { |
8017 | | - "description": "Product price.", |
8018 | | - "type": "number", |
8019 | | - "format": "float" |
| 8022 | + "description": "Product price", |
| 8023 | + "type": "string", |
| 8024 | + "format": "double", |
| 8025 | + "example": "150.0" |
| 8026 | + }, |
| 8027 | + "vat_rate": { |
| 8028 | + "description": "VAT rate", |
| 8029 | + "type": "string", |
| 8030 | + "format": "double", |
| 8031 | + "example": "0.0" |
| 8032 | + }, |
| 8033 | + "single_vat_amount": { |
| 8034 | + "description": "VAT amount for a single product", |
| 8035 | + "type": "string", |
| 8036 | + "format": "double", |
| 8037 | + "example": "0.0" |
| 8038 | + }, |
| 8039 | + "price_with_vat": { |
| 8040 | + "description": "Product price including VAT", |
| 8041 | + "type": "string", |
| 8042 | + "format": "double", |
| 8043 | + "example": "150.0" |
| 8044 | + }, |
| 8045 | + "vat_amount": { |
| 8046 | + "description": "VAT amount", |
| 8047 | + "type": "string", |
| 8048 | + "format": "double", |
| 8049 | + "example": "0.0" |
8020 | 8050 | }, |
8021 | 8051 | "quantity": { |
8022 | | - "description": "Product quantity.", |
8023 | | - "type": "integer" |
| 8052 | + "description": "Product quantity", |
| 8053 | + "type": "integer", |
| 8054 | + "format": "int64", |
| 8055 | + "example": 1 |
8024 | 8056 | }, |
8025 | 8057 | "total_price": { |
8026 | | - "description": "Quantity x product price.", |
8027 | | - "type": "number", |
8028 | | - "format": "float" |
| 8058 | + "description": "Quantity x product price", |
| 8059 | + "type": "string", |
| 8060 | + "format": "double", |
| 8061 | + "example": "150.0" |
| 8062 | + }, |
| 8063 | + "total_with_vat": { |
| 8064 | + "description": "Total price including VAT", |
| 8065 | + "type": "string", |
| 8066 | + "format": "double", |
| 8067 | + "example": "150.0" |
8029 | 8068 | } |
8030 | 8069 | } |
8031 | 8070 | } |
|
8104 | 8143 | "$ref": "#/components/schemas/EventStatus" |
8105 | 8144 | }, |
8106 | 8145 | "amount": { |
8107 | | - "$ref": "#/components/schemas/AmountEvent" |
| 8146 | + "description": "Amount of the event.", |
| 8147 | + "type": "number", |
| 8148 | + "format": "float" |
8108 | 8149 | }, |
8109 | 8150 | "due_date": { |
8110 | 8151 | "description": "Date when the transaction event is due to occur.", |
|
8121 | 8162 | "type": "integer" |
8122 | 8163 | }, |
8123 | 8164 | "timestamp": { |
8124 | | - "$ref": "#/components/schemas/TimestampEvent" |
| 8165 | + "description": "Date and time of the transaction event.", |
| 8166 | + "type": "string", |
| 8167 | + "format": "date-time" |
8125 | 8168 | } |
8126 | 8169 | } |
8127 | 8170 | }, |
|
8531 | 8574 | } |
8532 | 8575 | } |
8533 | 8576 | }, |
8534 | | - "AmountEvent": { |
8535 | | - "description": "Amount of the event.", |
8536 | | - "type": "number", |
8537 | | - "format": "float" |
8538 | | - }, |
8539 | 8577 | "Currency": { |
8540 | 8578 | "description": "Three-letter [ISO4217](https://en.wikipedia.org/wiki/ISO_4217) code of the currency for the amount. Currently supported currency values are enumerated above.", |
8541 | 8579 | "type": "string", |
|
8630 | 8668 | "description": "Unique ID of the transaction.", |
8631 | 8669 | "type": "string" |
8632 | 8670 | }, |
8633 | | - "TimestampEvent": { |
8634 | | - "description": "Date and time of the transaction event.", |
8635 | | - "type": "string", |
8636 | | - "format": "date-time" |
8637 | | - }, |
8638 | 8671 | "Permissions": { |
8639 | 8672 | "description": "Permissions assigned to an operator or user.", |
8640 | 8673 | "type": "object", |
|
8721 | 8754 | "example": {}, |
8722 | 8755 | "additionalProperties": true |
8723 | 8756 | }, |
8724 | | - "CountryCode": { |
8725 | | - "description": "An [ISO3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)\ncountry code. This definition users `oneOf` with a two-character string\ntype to allow for support of future countries in client code.", |
8726 | | - "type": "string", |
8727 | | - "example": "BR", |
8728 | | - "maxLength": 2, |
8729 | | - "minLength": 2 |
| 8757 | + "Problem": { |
| 8758 | + "description": "A RFC 9457 problem details object.\n\nAdditional properties specific to the problem type may be present.\n", |
| 8759 | + "type": "object", |
| 8760 | + "properties": { |
| 8761 | + "type": { |
| 8762 | + "description": "A URI reference that identifies the problem type.", |
| 8763 | + "type": "string", |
| 8764 | + "format": "uri", |
| 8765 | + "example": "https://developer.sumup.com/problem/not-found" |
| 8766 | + }, |
| 8767 | + "title": { |
| 8768 | + "description": "A short, human-readable summary of the problem type.", |
| 8769 | + "type": "string", |
| 8770 | + "example": "Requested resource couldn't be found." |
| 8771 | + }, |
| 8772 | + "status": { |
| 8773 | + "description": "The HTTP status code generated by the origin server for this occurrence of the problem.", |
| 8774 | + "type": "integer", |
| 8775 | + "example": 404 |
| 8776 | + }, |
| 8777 | + "detail": { |
| 8778 | + "description": "A human-readable explanation specific to this occurrence of the problem.", |
| 8779 | + "type": "string", |
| 8780 | + "example": "The requested resource doesn't exist or does not belong to you." |
| 8781 | + }, |
| 8782 | + "instance": { |
| 8783 | + "description": "A URI reference that identifies the specific occurrence of the problem.", |
| 8784 | + "type": "string", |
| 8785 | + "format": "uri" |
| 8786 | + } |
| 8787 | + }, |
| 8788 | + "additionalProperties": true, |
| 8789 | + "required": [ |
| 8790 | + "type" |
| 8791 | + ] |
8730 | 8792 | }, |
8731 | 8793 | "Address": { |
8732 | 8794 | "description": "An address somewhere in the world. The address fields used depend on the country conventions. For example, in Great Britain, `city` is `post_town`. In the United States, the top-level administrative unit used in addresses is `state`, whereas in Chile it's `region`.\nWhether an address is valid or not depends on whether the locally required fields are present. Fields not supported in a country will be ignored.", |
|
8856 | 8918 | "country" |
8857 | 8919 | ] |
8858 | 8920 | }, |
| 8921 | + "CountryCode": { |
| 8922 | + "description": "An [ISO3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)\ncountry code. This definition users `oneOf` with a two-character string\ntype to allow for support of future countries in client code.", |
| 8923 | + "type": "string", |
| 8924 | + "example": "BR", |
| 8925 | + "maxLength": 2, |
| 8926 | + "minLength": 2, |
| 8927 | + "pattern": "^[A-Z]{2}$" |
| 8928 | + }, |
8859 | 8929 | "PersonalIdentifier": { |
8860 | 8930 | "type": "object", |
8861 | 8931 | "properties": { |
8862 | 8932 | "ref": { |
8863 | 8933 | "description": "The unique reference for the personal identifier type.", |
8864 | 8934 | "type": "string", |
8865 | | - "example": "br.cpf" |
| 8935 | + "example": "br.cpf", |
| 8936 | + "maxLength": 32 |
8866 | 8937 | }, |
8867 | 8938 | "value": { |
8868 | 8939 | "description": "The company identifier value.", |
8869 | 8940 | "type": "string", |
8870 | | - "example": "847.060.136-90" |
| 8941 | + "example": "847.060.136-90", |
| 8942 | + "maxLength": 128 |
8871 | 8943 | } |
8872 | 8944 | }, |
8873 | 8945 | "example": { |
|
8879 | 8951 | "value" |
8880 | 8952 | ] |
8881 | 8953 | }, |
8882 | | - "Problem": { |
8883 | | - "description": "A RFC 9457 problem details object.\n\nAdditional properties specific to the problem type may be present.\n", |
8884 | | - "type": "object", |
8885 | | - "properties": { |
8886 | | - "type": { |
8887 | | - "description": "A URI reference that identifies the problem type.", |
8888 | | - "type": "string", |
8889 | | - "format": "uri" |
8890 | | - }, |
8891 | | - "title": { |
8892 | | - "description": "A short, human-readable summary of the problem type.", |
8893 | | - "type": "string" |
8894 | | - }, |
8895 | | - "status": { |
8896 | | - "description": "The HTTP status code generated by the origin server for this occurrence of the problem.", |
8897 | | - "type": "integer", |
8898 | | - "example": 400, |
8899 | | - "exclusiveMaximum": true, |
8900 | | - "maximum": 600, |
8901 | | - "minimum": 400 |
8902 | | - }, |
8903 | | - "detail": { |
8904 | | - "description": "A human-readable explanation specific to this occurrence of the problem.", |
8905 | | - "type": "string" |
8906 | | - }, |
8907 | | - "instance": { |
8908 | | - "description": "A URI reference that identifies the specific occurrence of the problem.", |
8909 | | - "type": "string", |
8910 | | - "format": "uri" |
8911 | | - } |
8912 | | - }, |
8913 | | - "additionalProperties": true, |
8914 | | - "required": [ |
8915 | | - "type" |
8916 | | - ] |
8917 | | - }, |
8918 | 8954 | "MembershipStatus": { |
8919 | 8955 | "description": "The status of the membership.", |
8920 | 8956 | "type": "string", |
|
0 commit comments