swag-payments/spec/definitions/Payment.yaml
Andrew Mayorov 19713fc464 CAPI-125: Impose reasonable limits and enforce specs on model props (#62)
* CAPI-125: Impose reasonable limits and enforce specs on model props

* CAPI-125: Accomodate for ipv6-mapped ipv4 addresses

* CAPI-125: Fix standard id

* CAPI-125: Refine phone number format
2017-05-12 17:23:24 +03:00

65 lines
2.1 KiB
YAML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

type: object
allOf:
- $ref: '#/definitions/PaymentStatus'
- type: object
required:
- id
- invoiceID
- createdAt
- amount
- currency
- contactInfo
- paymentSession
- paymentToolToken
- paymentToolDetails
properties:
id:
description: Идентификатор платежа
type: string
invoiceID:
description: 'Идентификатор инвойса, в рамках которого был создан платеж'
type: string
createdAt:
description: Дата и время создания
type: string
format: date-time
amount:
description: >
Стоимость предлагаемых товаров или услуг, в минорных денежных
единицах,
например в копейках в случае указания российских рублей в качестве
валюты.
type: integer
format: int64
minimum: 1
currency:
description: |
Валюта, символьный код согласно
[ISO 4217](http://www.iso.org/iso/home/standards/currency_codes.htm).
type: string
pattern: '^[A-Z]{3}$'
contactInfo:
description: Контактные данные плательщика
allOf:
- $ref: '#/definitions/ContactInfo'
paymentSession:
description: Идентификатор платежной сессии
type: string
maxLength: 1000
paymentToolToken:
description: 'Токен платежного средства, предоставленного плательщиком'
type: string
maxLength: 1000
paymentToolDetails:
$ref: '#/definitions/PaymentToolDetails'
ip:
description: IP-адрес плательщика
type: string
format: ip-address
maxLength: 45
fingerprint:
description: Уникальный отпечаток user agent'а плательщика
type: string
maxLength: 1000