diff --git a/web/site/public/pay/payment-spec.yaml b/web/site/public/pay/payment-spec.yaml index 8daa90c5..aa5f7214 100644 --- a/web/site/public/pay/payment-spec.yaml +++ b/web/site/public/pay/payment-spec.yaml @@ -11,7 +11,7 @@ info: \ statements
All requests\ \ must include a BC Registries issued API key.
\nAll requests must include\ \ an Account ID.
" - version: "1.0.1" + version: "1.0.3" contact: name: "BC Registries" servers: @@ -1473,19 +1473,53 @@ components: description: "id of the account" corpTypeCode: type: "string" - description: "username of the account" + description: "type of invoice" createdBy: type: "string" - description: "invoice creation date" + description: "username who created" + createdName: + type: "string" + description: "name who created" createdOn: type: "string" description: "date made payment" + details: + type: "array" + items: + type: "object" + properties: + label: + type: "string" + value: + type: "string" + disbursementDate: + type: "string" + description: "date when disbursement to partner" + disbursementReversalDate: + type: "string" + description: "date when disbursement reversal to partner" + isPaymentActionRequired: + type: "boolean" + description: "Flag to indicate if a user action/redirection is needed to complete the payment." + isOnlineBankingAllowed: + type: "boolean" + overdueDate: + type: "string" + description: "date when payment is overdue (EFT)" paid: type: "number" description: "amount paid" + paymentDate: + type: "string" + description: "date when invoice was marked as paid" + paymentMethod: + type: "string" refund: type: "number" description: "reference number" + refundDate: + type: "string" + description: date when received confirmation invoice was refunded serviceFees: type: "number" description: "service fees" @@ -1497,6 +1531,14 @@ components: - "PAID" - "DELETED" - "CREATED" + - "APPROVED" + - "COMPLETED" + - "REFUND_REQUESTED" + - "REFUNDED" + - "SETTLEMENT_SCHED" + - "CANCELLED" + - "CREDITED" + - "OVERDUE" references: type: "array" items: @@ -1509,6 +1551,12 @@ components: type: "array" items: $ref: "#/components/schemas/LineItem" + updatedOn: + type: "string" + updatedBy: + type: "string" + updatedName: + type: "string" title: "Invoice" description: "Object to hold invoice information
" Transaction: