Skip to content

Update pay spec version #196

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Mar 4, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 51 additions & 3 deletions web/site/public/pay/payment-spec.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ info:
\ statements</li><li>Generate account transactions reports</li></ul>\n<p>All requests\
\ must include a BC Registries issued API key.</p>\n<p>All requests must include\
\ an Account ID.</p>"
version: "1.0.1"
version: "1.0.3"
contact:
name: "BC Registries"
servers:
Expand Down Expand Up @@ -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"
Expand All @@ -1497,6 +1531,14 @@ components:
- "PAID"
- "DELETED"
- "CREATED"
- "APPROVED"
- "COMPLETED"
- "REFUND_REQUESTED"
- "REFUNDED"
- "SETTLEMENT_SCHED"
- "CANCELLED"
- "CREDITED"
- "OVERDUE"
references:
type: "array"
items:
Expand All @@ -1509,6 +1551,12 @@ components:
type: "array"
items:
$ref: "#/components/schemas/LineItem"
updatedOn:
type: "string"
updatedBy:
type: "string"
updatedName:
type: "string"
title: "Invoice"
description: "<p>Object to hold invoice information </p>"
Transaction:
Expand Down
Loading