From 0cb4b02adaf645e8f535429e51647b283a9a4f91 Mon Sep 17 00:00:00 2001 From: Travis Semple Date: Mon, 3 Mar 2025 15:54:32 -0800 Subject: [PATCH 1/4] update pay spec version --- web/site/public/pay/payment-spec.yaml | 60 ++++++++++++++++++++++++--- 1 file changed, 54 insertions(+), 6 deletions(-) diff --git a/web/site/public/pay/payment-spec.yaml b/web/site/public/pay/payment-spec.yaml index 8daa90c5..1105191f 100644 --- a/web/site/public/pay/payment-spec.yaml +++ b/web/site/public/pay/payment-spec.yaml @@ -11,14 +11,14 @@ info: \ statements
  • Generate account transactions reports
    • \n

    All requests\ \ must include a BC Registries issued API key.

    \n

    All requests must include\ \ an Account ID.

    " - version: "1.0.1" + version: "1.0.3" contact: name: "BC Registries" servers: - - url: "https://sandbox.api.connect.gov.bc.ca" - description: "Test" - - url: "https://api.connect.gov.bc.ca" - description: "Production" +- url: "https://sandbox.api.connect.gov.bc.ca" + description: "Test" +- url: "https://api.connect.gov.bc.ca" + description: "Production" paths: /pay/api/v1/fees/{business_type}/{filing_type}: get: @@ -1476,16 +1476,50 @@ components: description: "username of the account" createdBy: type: "string" - description: "invoice creation date" + description: "name of user who created" + createdName: + type: "string" + description: "user 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 status code was set" + disbursementReversalDate: + type: "string" + description: "date when disbursement reversal status code was set" + 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: From 8bfffffb58a4d4a2e9d89b0a286e4985a2e2b79e Mon Sep 17 00:00:00 2001 From: Travis Semple Date: Mon, 3 Mar 2025 15:56:17 -0800 Subject: [PATCH 2/4] tweaks --- web/site/public/pay/payment-spec.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/web/site/public/pay/payment-spec.yaml b/web/site/public/pay/payment-spec.yaml index 1105191f..59b31706 100644 --- a/web/site/public/pay/payment-spec.yaml +++ b/web/site/public/pay/payment-spec.yaml @@ -1473,13 +1473,13 @@ components: description: "id of the account" corpTypeCode: type: "string" - description: "username of the account" + description: "type of invoice" createdBy: type: "string" - description: "name of user who created" + description: "username who created" createdName: type: "string" - description: "user who created" + description: "name who created" createdOn: type: "string" description: "date made payment" From 7336c1d715ca47cf59588fdd0e18f8db40f8d6f7 Mon Sep 17 00:00:00 2001 From: Travis Semple Date: Mon, 3 Mar 2025 15:56:45 -0800 Subject: [PATCH 3/4] fix spacing --- web/site/public/pay/payment-spec.yaml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/web/site/public/pay/payment-spec.yaml b/web/site/public/pay/payment-spec.yaml index 59b31706..cdffc4ac 100644 --- a/web/site/public/pay/payment-spec.yaml +++ b/web/site/public/pay/payment-spec.yaml @@ -15,10 +15,10 @@ info: contact: name: "BC Registries" servers: -- url: "https://sandbox.api.connect.gov.bc.ca" - description: "Test" -- url: "https://api.connect.gov.bc.ca" - description: "Production" + - url: "https://sandbox.api.connect.gov.bc.ca" + description: "Test" + - url: "https://api.connect.gov.bc.ca" + description: "Production" paths: /pay/api/v1/fees/{business_type}/{filing_type}: get: From 38c743628209167aa4a0f541ee9eb3d1b5594cb6 Mon Sep 17 00:00:00 2001 From: Travis Semple Date: Mon, 3 Mar 2025 16:25:57 -0800 Subject: [PATCH 4/4] Update payment-spec.yaml --- web/site/public/pay/payment-spec.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/web/site/public/pay/payment-spec.yaml b/web/site/public/pay/payment-spec.yaml index cdffc4ac..aa5f7214 100644 --- a/web/site/public/pay/payment-spec.yaml +++ b/web/site/public/pay/payment-spec.yaml @@ -1494,10 +1494,10 @@ components: type: "string" disbursementDate: type: "string" - description: "date when disbursement status code was set" + description: "date when disbursement to partner" disbursementReversalDate: type: "string" - description: "date when disbursement reversal status code was set" + 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."