mirror of
https://github.com/valitydev/swag-payments.git
synced 2024-11-06 01:25:22 +00:00
5760b7eab1
* OPS-474: Extends invoice creation randomization options * Retires 'rounding' option in amount randomization * Camelcases new fields in randomization opts * Retires 'cartNotSupported' in favour of HG's invalid request exception throw through
79 lines
2.0 KiB
YAML
79 lines
2.0 KiB
YAML
get:
|
|
description: Get invoice by specified external identifier.
|
|
tags:
|
|
- Invoices
|
|
operationId: getInvoiceByExternalID
|
|
parameters:
|
|
- $ref: "#/parameters/requestID"
|
|
- $ref: "#/parameters/deadline"
|
|
- name: externalID
|
|
description: External invoice identifier
|
|
in: query
|
|
required: true
|
|
type: string
|
|
maxLength: 40
|
|
minLength: 1
|
|
responses:
|
|
"200":
|
|
description: Invoice
|
|
schema:
|
|
$ref: "#/definitions/Invoice"
|
|
"404":
|
|
$ref: "#/responses/NotFound"
|
|
"401":
|
|
$ref: "#/responses/Unauthorized"
|
|
"400":
|
|
$ref: "#/responses/DefaultLogicError"
|
|
post:
|
|
description: Create a new invoice.
|
|
tags:
|
|
- Invoices
|
|
operationId: createInvoice
|
|
parameters:
|
|
- $ref: "#/parameters/requestID"
|
|
- $ref: "#/parameters/deadline"
|
|
- name: invoiceParams
|
|
description: Invoice parameters
|
|
in: body
|
|
required: true
|
|
schema:
|
|
$ref: "#/definitions/InvoiceParams"
|
|
responses:
|
|
"201":
|
|
description: Invoice created
|
|
schema:
|
|
$ref: "#/definitions/InvoiceAndToken"
|
|
"401":
|
|
$ref: "#/responses/Unauthorized"
|
|
"400":
|
|
description: Invalid data for invoice creation
|
|
schema:
|
|
type: object
|
|
required:
|
|
- code
|
|
- message
|
|
properties:
|
|
code:
|
|
description: >
|
|
[Error code](#tag/Error-Codes)
|
|
type: string
|
|
enum:
|
|
- invalidPartyID
|
|
- invalidShopID
|
|
- invalidRequest
|
|
- invalidDeadline
|
|
- invalidPartyStatus
|
|
- invalidShopStatus
|
|
- invalidInvoiceCart
|
|
- invalidAllocation
|
|
- allocationNotPermitted
|
|
- invalidInvoiceCost
|
|
- invoiceTermsViolated
|
|
- ambiguousPartyID
|
|
message:
|
|
description: Human-readable description of the error
|
|
type: string
|
|
example: Shop not found or inaccessible
|
|
"409":
|
|
$ref: "#/responses/ExternalIDConflict"
|