From 7fec8438f1e322e75e9ce1495298e30c3d4069fc Mon Sep 17 00:00:00 2001 From: Shreya Thapa Date: Wed, 13 Aug 2025 16:37:46 -0500 Subject: [PATCH] Method name signature updates + remove ODTA file from transfers folder --- openapi.yml | 189 +++++++++--------- .../labels/createLabelReallocation.yml | 2 +- .../labels/retrieveLabelLedgerEntry.yml | 4 +- .../labels/retrieveLabelReallocation.yml | 4 +- .../mass-payments/retrieveMassPaymentItem.yml | 4 +- .../createOnDemandTransferAuthorization.yml | 64 ------ specs/spec.yml | 10 +- 7 files changed, 107 insertions(+), 170 deletions(-) delete mode 100644 specs/resources/transfers/createOnDemandTransferAuthorization.yml diff --git a/openapi.yml b/openapi.yml index d149853..49804c6 100644 --- a/openapi.yml +++ b/openapi.yml @@ -3818,6 +3818,72 @@ paths: message: type: string example: Funding source not found. + /on-demand-authorizations: + post: + tags: + - funding sources + summary: Create an on-demand transfer authorization + description: Create an on-demand transfer authorization that allows Customers to pre-authorize variable amount ACH transfers from their bank account for future payments. This authorization is used when creating Customer funding sources to enable flexible payment processing. Returns UI text elements including authorization body text and button text for display in your application's bank account addition flow. + operationId: createOnDemandTransferAuthorization + x-speakeasy-group: fundingSources.onDemandTransferAuthorizations + x-speakeasy-name-override: create + x-codeSamples: + - lang: bash + source: | + POST https://api-sandbox.dwolla.com/on-demand-authorizations + Accept: application/vnd.dwolla.v1.hal+json + Content-Type: application/vnd.dwolla.v1.hal+json + Authorization: Bearer pBA9fVDBEyYZCEsLf/wKehyh1RTpzjUj5KzIRfDi0wKTii7DqY + + { + "_links": { + "self": { + "href": "https://api-sandbox.dwolla.com/on-demand-authorizations/30e7c028-0bdf-e511-80de-0aa34a9b2388" + } + }, + "bodyText": "I agree that future payments to Company ABC inc. will be processed by the Dwolla payment system from the selected account above. In order to cancel this authorization, I will change my payment settings within my Company ABC inc. account.", + "buttonText": "Agree & Continue" + } + - lang: javascript + source: | + // Using dwolla-v2 - https://github.com/Dwolla/dwolla-v2-node + dwolla.post("on-demand-authorizations").then((res) => res.body.buttonText); // => "Agree & Continue" + - lang: python + source: | + # Using dwollav2 - https://github.com/Dwolla/dwolla-v2-python + on_demand_authorization = app_token.post('on-demand-authorizations') + on_demand_authorization.body['buttonText'] # => 'Agree & Continue' + - lang: php + source: | + createAuthorization(); + $onDemandAuth->_links["self"]->href; # => "https://api-sandbox.dwolla.com/on-demand-authorizations/30e7c028-0bdf-e511-80de-0aa34a9b2388" + ?> + - lang: ruby + source: | + # Using dwolla_v2 - https://github.com/Dwolla/dwolla-v2-ruby + on_demand_authorization = app_token.post "on-demand-authorizations" + on_demand_authorization.buttonText # => "Agree & Continue" + parameters: + - $ref: '#/components/parameters/Accept' + responses: + '200': + description: Ok + headers: {} + content: + application/vnd.dwolla.v1.hal+json: + schema: + $ref: '#/components/schemas/OnDemandAuthorization' + '403': + description: 403 Error + headers: {} + content: + application/vnd.dwolla.v1.hal+json: + schema: + $ref: '#/components/schemas/ForbiddenError' /transfers: post: tags: @@ -4846,71 +4912,6 @@ paths: application/vnd.dwolla.v1.hal+json: schema: $ref: '#/components/schemas/NotFoundError' - /on-demand-authorizations: - post: - tags: - - transfers - summary: Create an on-demand transfer authorization - description: Create an on-demand transfer authorization that allows Customers to pre-authorize variable amount ACH transfers from their bank account for future payments. This authorization is used when creating Customer funding sources to enable flexible payment processing. Returns UI text elements including authorization body text and button text for display in your application's bank account addition flow. - operationId: createOnDemandTransferAuthorization - x-speakeasy-name-override: createOnDemandAuthorization - x-codeSamples: - - lang: bash - source: | - POST https://api-sandbox.dwolla.com/on-demand-authorizations - Accept: application/vnd.dwolla.v1.hal+json - Content-Type: application/vnd.dwolla.v1.hal+json - Authorization: Bearer pBA9fVDBEyYZCEsLf/wKehyh1RTpzjUj5KzIRfDi0wKTii7DqY - - { - "_links": { - "self": { - "href": "https://api-sandbox.dwolla.com/on-demand-authorizations/30e7c028-0bdf-e511-80de-0aa34a9b2388" - } - }, - "bodyText": "I agree that future payments to Company ABC inc. will be processed by the Dwolla payment system from the selected account above. In order to cancel this authorization, I will change my payment settings within my Company ABC inc. account.", - "buttonText": "Agree & Continue" - } - - lang: javascript - source: | - // Using dwolla-v2 - https://github.com/Dwolla/dwolla-v2-node - dwolla.post("on-demand-authorizations").then((res) => res.body.buttonText); // => "Agree & Continue" - - lang: python - source: | - # Using dwollav2 - https://github.com/Dwolla/dwolla-v2-python - on_demand_authorization = app_token.post('on-demand-authorizations') - on_demand_authorization.body['buttonText'] # => 'Agree & Continue' - - lang: php - source: | - createAuthorization(); - $onDemandAuth->_links["self"]->href; # => "https://api-sandbox.dwolla.com/on-demand-authorizations/30e7c028-0bdf-e511-80de-0aa34a9b2388" - ?> - - lang: ruby - source: | - # Using dwolla_v2 - https://github.com/Dwolla/dwolla-v2-ruby - on_demand_authorization = app_token.post "on-demand-authorizations" - on_demand_authorization.buttonText # => "Agree & Continue" - parameters: - - $ref: '#/components/parameters/Accept' - responses: - '200': - description: Ok - headers: {} - content: - application/vnd.dwolla.v1.hal+json: - schema: - $ref: '#/components/schemas/OnDemandAuthorization' - '403': - description: 403 Error - headers: {} - content: - application/vnd.dwolla.v1.hal+json: - schema: - $ref: '#/components/schemas/ForbiddenError' /mass-payments: post: tags: @@ -5818,14 +5819,14 @@ paths: message: type: string example: Mass payment not found. - /mass-payment-items/{id}: + /mass-payment-items/{itemId}: get: tags: - mass payments summary: Retrieve mass payment item description: Retrieve detailed information for a specific mass payment item by its unique identifier. Returns item status, amount, metadata, and links to the parent mass payment, associated transfer, and destination funding source. Use this endpoint to check the processing status and details of an individual item within a mass payment batch. operationId: getMassPaymentItem - x-speakeasy-group: massPaymentsItems + x-speakeasy-group: massPayments.items x-speakeasy-name-override: get x-codeSamples: - lang: bash @@ -5866,7 +5867,7 @@ paths: mass_payment_item = app_token.get mass_payment_item_url mass_payment_item.status # => "success" parameters: - - name: id + - name: itemId in: path description: ID of item to be retrieved in mass payment required: true @@ -6654,14 +6655,14 @@ paths: application/vnd.dwolla.v1.hal+json: schema: $ref: '#/components/schemas/NotFoundError' - /ledger-entries/{id}: + /ledger-entries/{ledgerEntryId}: get: tags: - labels summary: Retrieve a label ledger entry description: Returns detailed information for a specific ledger entry on a Label, including its amount, currency, and creation timestamp. operationId: getLabelLedgerEntry - x-speakeasy-group: labelLedgerEntries + x-speakeasy-group: labels.ledgerEntries x-speakeasy-name-override: get x-codeSamples: - lang: bash @@ -6702,7 +6703,7 @@ paths: ledger_entry = app_token.get ledger_entry_url ledger_entry.id # => "32d68709-62dd-43d6-a6df-562f4baec526" parameters: - - name: id + - name: ledgerEntryId in: path description: A label ledger entry unique identifier required: true @@ -6738,7 +6739,7 @@ paths: summary: Create a label reallocation description: Reallocates funds between two labels belonging to the same Verified Customer. Moves the specified amount from the source label to the destination label, creating ledger entries for both. The reallocation only succeeds if the source label has sufficient funds. operationId: createLabelReallocation - x-speakeasy-group: labelReallocations + x-speakeasy-group: labels.reallocations x-speakeasy-name-override: create x-codeSamples: - lang: bash @@ -6923,14 +6924,14 @@ paths: message: type: string example: Label not found - /label-reallocations/{id}: + /label-reallocations/{reallocationId}: get: tags: - labels summary: Retrieve a label reallocation description: Retrieve details for a specific label reallocation that transfers funds between Labels. Returns reallocation information including source and destination Labels, amount transferred, status, and creation timestamp. Use this to track and audit fund movements between different Labels. operationId: retrieveLabelReallocation - x-speakeasy-group: labelsReallocations + x-speakeasy-group: labels.reallocations x-speakeasy-name-override: get x-codeSamples: - lang: bash @@ -6971,7 +6972,7 @@ paths: label_reallocation = app_token.get label_reallocation_url label_reallocation.created # => "2019-05-16T13:41:31.036Z" parameters: - - name: id + - name: reallocationId in: path description: Label reallocation unique identifier required: true @@ -11783,6 +11784,25 @@ components: currency: type: string example: USD + OnDemandAuthorization: + title: OnDemandAuthorization + type: object + properties: + _links: + type: object + properties: + self: + type: object + properties: + href: + type: string + example: https://api.dwolla.com/on-demand-authorizations/30e7c028-0bdf-e511-80de-0aa34a9b2388 + bodyText: + type: string + example: I agree that future payments to Company ABC inc. will be processed by the Dwolla payment system from the selected account above. In order to cancel this authorization, I will change my payment settings within my Company ABC inc. account. + buttonText: + type: string + example: Agree & Continue SourceNotFoundError: title: SourceNotFoundError type: object @@ -14059,25 +14079,6 @@ components: _links: type: object example: {} - OnDemandAuthorization: - title: OnDemandAuthorization - type: object - properties: - _links: - type: object - properties: - self: - type: object - properties: - href: - type: string - example: https://api.dwolla.com/on-demand-authorizations/30e7c028-0bdf-e511-80de-0aa34a9b2388 - bodyText: - type: string - example: I agree that future payments to Company ABC inc. will be processed by the Dwolla payment system from the selected account above. In order to cancel this authorization, I will change my payment settings within my Company ABC inc. account. - buttonText: - type: string - example: Agree & Continue MassPaymentItem: title: MassPaymentItem type: object diff --git a/specs/resources/labels/createLabelReallocation.yml b/specs/resources/labels/createLabelReallocation.yml index 63af7d7..893b2c7 100644 --- a/specs/resources/labels/createLabelReallocation.yml +++ b/specs/resources/labels/createLabelReallocation.yml @@ -4,7 +4,7 @@ post: summary: Create a label reallocation description: Reallocates funds between two labels belonging to the same Verified Customer. Moves the specified amount from the source label to the destination label, creating ledger entries for both. The reallocation only succeeds if the source label has sufficient funds. operationId: createLabelReallocation - x-speakeasy-group: labelReallocations + x-speakeasy-group: labels.reallocations x-speakeasy-name-override: create x-codeSamples: - lang: bash diff --git a/specs/resources/labels/retrieveLabelLedgerEntry.yml b/specs/resources/labels/retrieveLabelLedgerEntry.yml index 075e2a6..14746d5 100644 --- a/specs/resources/labels/retrieveLabelLedgerEntry.yml +++ b/specs/resources/labels/retrieveLabelLedgerEntry.yml @@ -4,7 +4,7 @@ get: summary: Retrieve a label ledger entry description: Returns detailed information for a specific ledger entry on a Label, including its amount, currency, and creation timestamp. operationId: getLabelLedgerEntry - x-speakeasy-group: labelLedgerEntries + x-speakeasy-group: labels.ledgerEntries x-speakeasy-name-override: get x-codeSamples: - lang: bash @@ -45,7 +45,7 @@ get: ledger_entry = app_token.get ledger_entry_url ledger_entry.id # => "32d68709-62dd-43d6-a6df-562f4baec526" parameters: - - name: id + - name: ledgerEntryId in: path description: A label ledger entry unique identifier required: true diff --git a/specs/resources/labels/retrieveLabelReallocation.yml b/specs/resources/labels/retrieveLabelReallocation.yml index 59ff0b7..76888fb 100644 --- a/specs/resources/labels/retrieveLabelReallocation.yml +++ b/specs/resources/labels/retrieveLabelReallocation.yml @@ -4,7 +4,7 @@ get: summary: Retrieve a label reallocation description: Retrieve details for a specific label reallocation that transfers funds between Labels. Returns reallocation information including source and destination Labels, amount transferred, status, and creation timestamp. Use this to track and audit fund movements between different Labels. operationId: retrieveLabelReallocation - x-speakeasy-group: labelsReallocations + x-speakeasy-group: labels.reallocations x-speakeasy-name-override: get x-codeSamples: - lang: bash @@ -45,7 +45,7 @@ get: label_reallocation = app_token.get label_reallocation_url label_reallocation.created # => "2019-05-16T13:41:31.036Z" parameters: - - name: id + - name: reallocationId in: path description: Label reallocation unique identifier required: true diff --git a/specs/resources/mass-payments/retrieveMassPaymentItem.yml b/specs/resources/mass-payments/retrieveMassPaymentItem.yml index eb30279..09a8197 100644 --- a/specs/resources/mass-payments/retrieveMassPaymentItem.yml +++ b/specs/resources/mass-payments/retrieveMassPaymentItem.yml @@ -4,7 +4,7 @@ get: summary: Retrieve mass payment item description: Retrieve detailed information for a specific mass payment item by its unique identifier. Returns item status, amount, metadata, and links to the parent mass payment, associated transfer, and destination funding source. Use this endpoint to check the processing status and details of an individual item within a mass payment batch. operationId: getMassPaymentItem - x-speakeasy-group: massPaymentsItems + x-speakeasy-group: massPayments.items x-speakeasy-name-override: get x-codeSamples: - lang: bash @@ -45,7 +45,7 @@ get: mass_payment_item = app_token.get mass_payment_item_url mass_payment_item.status # => "success" parameters: - - name: id + - name: itemId in: path description: ID of item to be retrieved in mass payment required: true diff --git a/specs/resources/transfers/createOnDemandTransferAuthorization.yml b/specs/resources/transfers/createOnDemandTransferAuthorization.yml deleted file mode 100644 index fee38ad..0000000 --- a/specs/resources/transfers/createOnDemandTransferAuthorization.yml +++ /dev/null @@ -1,64 +0,0 @@ -post: - tags: - - transfers - summary: Create an on-demand transfer authorization - description: Create an on-demand transfer authorization that allows Customers to pre-authorize variable amount ACH transfers from their bank account for future payments. This authorization is used when creating Customer funding sources to enable flexible payment processing. Returns UI text elements including authorization body text and button text for display in your application's bank account addition flow. - operationId: createOnDemandTransferAuthorization - x-speakeasy-name-override: createOnDemandAuthorization - x-codeSamples: - - lang: bash - source: | - POST https://api-sandbox.dwolla.com/on-demand-authorizations - Accept: application/vnd.dwolla.v1.hal+json - Content-Type: application/vnd.dwolla.v1.hal+json - Authorization: Bearer pBA9fVDBEyYZCEsLf/wKehyh1RTpzjUj5KzIRfDi0wKTii7DqY - - { - "_links": { - "self": { - "href": "https://api-sandbox.dwolla.com/on-demand-authorizations/30e7c028-0bdf-e511-80de-0aa34a9b2388" - } - }, - "bodyText": "I agree that future payments to Company ABC inc. will be processed by the Dwolla payment system from the selected account above. In order to cancel this authorization, I will change my payment settings within my Company ABC inc. account.", - "buttonText": "Agree & Continue" - } - - lang: javascript - source: | - // Using dwolla-v2 - https://github.com/Dwolla/dwolla-v2-node - dwolla.post("on-demand-authorizations").then((res) => res.body.buttonText); // => "Agree & Continue" - - lang: python - source: | - # Using dwollav2 - https://github.com/Dwolla/dwolla-v2-python - on_demand_authorization = app_token.post('on-demand-authorizations') - on_demand_authorization.body['buttonText'] # => 'Agree & Continue' - - lang: php - source: | - createAuthorization(); - $onDemandAuth->_links["self"]->href; # => "https://api-sandbox.dwolla.com/on-demand-authorizations/30e7c028-0bdf-e511-80de-0aa34a9b2388" - ?> - - lang: ruby - source: | - # Using dwolla_v2 - https://github.com/Dwolla/dwolla-v2-ruby - on_demand_authorization = app_token.post "on-demand-authorizations" - on_demand_authorization.buttonText # => "Agree & Continue" - parameters: - - $ref: '../../schemas/common.yml#/components/parameters/Accept' - responses: - '200': - description: Ok - headers: {} - content: - application/vnd.dwolla.v1.hal+json: - schema: - $ref: '../../schemas/transfers/OnDemandAuthorization.yml#/OnDemandAuthorization' - '403': - description: 403 Error - headers: {} - content: - application/vnd.dwolla.v1.hal+json: - schema: - $ref: '../../schemas/common.yml#/components/schemas/ForbiddenError' diff --git a/specs/spec.yml b/specs/spec.yml index 927d5be..be87022 100644 --- a/specs/spec.yml +++ b/specs/spec.yml @@ -66,6 +66,8 @@ paths: $ref: './resources/funding-sources/retrieveFundingSourceBalance.yml' /funding-sources/{id}/ach-routing: $ref: './resources/funding-sources/retrieveVansAccountRoutingNumber.yml' + /on-demand-authorizations: + $ref: './resources/funding-sources/createOnDemandTransferAuthorization.yml' /transfers: $ref: './resources/transfers/initiateTransfer.yml' /transfers/{id}: @@ -76,15 +78,13 @@ paths: $ref: './resources/transfers/listFeesForTransfer.yml' /transfers/{id}/failure: $ref: './resources/transfers/retrieveTransferFailureReason.yml' - /on-demand-authorizations: - $ref: './resources/transfers/createOnDemandTransferAuthorization.yml' /mass-payments: $ref: './resources/mass-payments/initiateMassPayment.yml' /mass-payments/{id}: $ref: './resources/mass-payments/retrieveUpdateMassPayment.yml' /mass-payments/{id}/items: $ref: './resources/mass-payments/listMassPaymentItems.yml' - /mass-payment-items/{id}: + /mass-payment-items/{itemId}: $ref: './resources/mass-payments/retrieveMassPaymentItem.yml' /customers/{id}/mass-payments: $ref: './resources/mass-payments/listMassPaymentsForCustomer.yml' @@ -94,11 +94,11 @@ paths: $ref: './resources/labels/createListCustomerLabels.yml' /labels/{id}/ledger-entries: $ref: './resources/labels/createListLabelLedgerEntries.yml' - /ledger-entries/{id}: + /ledger-entries/{ledgerEntryId}: $ref: './resources/labels/retrieveLabelLedgerEntry.yml' /label-reallocations: $ref: './resources/labels/createLabelReallocation.yml' - /label-reallocations/{id}: + /label-reallocations/{reallocationId}: $ref: './resources/labels/retrieveLabelReallocation.yml' /events: $ref: './resources/events/listEvents.yml'