Skip to content

Dev 1815 #46

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.

Sign up for GitHub

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
ShreyaThapa merged 8 commits into from
Jan 6, 2026
Merged

Dev 1815 #46

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
5823244
DEV-1815: Add P2D endpoints
ShreyaThapa Dec 5, 2025
3057903
Updates to card details response, settlement funding-source balance s…
ShreyaThapa Dec 15, 2025
6844688
DEV-1815: Add all known P2D changes to the spec
ShreyaThapa Jan 6, 2026
5bf0d57
Specify debit card type
ShreyaThapa Jan 6, 2026
edc8c9e
chore: update bundled openapi.yml
actions-user Jan 6, 2026
f44c1a7
Add error for using card as source
ShreyaThapa Jan 6, 2026
82c83fa
Bundle openapi.yml
ShreyaThapa Jan 6, 2026
a5d8cae
Merge branch 'DEV-1815' of https://github.com/Dwolla/dwolla-openapi i…
ShreyaThapa Jan 6, 2026
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
902 changes: 877 additions & 25 deletions openapi.yml
View file
Open in desktop

Large diffs are not rendered by default.

279 changes: 277 additions & 2 deletions specs/resources/funding-sources/createListCustomerFundingSources.yml
View file
Open in desktop

Large diffs are not rendered by default.

45 changes: 44 additions & 1 deletion specs/resources/funding-sources/retrieveFundingSourceBalance.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ get:
tags:
- funding sources
summary: Retrieve funding source balance
description: Returns the current balance for a specific funding source. For bank accounts, includes available and closing balances; for Dwolla balance, includes balance and total amounts. All responses include currency and last updated timestamp. Supports bank accounts (via Open Banking) and Dwolla balance (verified customers only).
description: Returns the current balance for a specific funding source. For bank accounts, includes available and closing balances; for Dwolla balance, includes balance and total amounts; for settlement accounts (bankUsageType = card-network), includes available balance only. Supports bank accounts (via Open Banking), Dwolla balance (verified customers only), and settlement accounts for card network processing.
operationId: getFundingSourceBalance
x-speakeasy-group: fundingSources.balance
x-speakeasy-name-override: get
Expand Down Expand Up @@ -148,6 +148,49 @@ get:
lastUpdated:
type: string
example: '2024-09-09T16:39:14.219Z'
- title: Settlement Account Balance Response
description: Response for retrieving balance of a settlement account with bankUsageType = card-network
type: object
required:
- _links
- available
properties:
_links:
type: object
properties:
self:
type: object
properties:
href:
type: string
example: 'https://api.dwolla.com/funding-sources/12345678-1234-1234-1234-123456789012/balance'
type:
type: string
example: 'application/vnd.dwolla.v1.hal+json'
resource-type:
type: string
example: 'balance'
funding-source:
type: object
properties:
href:
type: string
example: 'https://api.dwolla.com/funding-sources/12345678-1234-1234-1234-123456789012'
type:
type: string
example: 'application/vnd.dwolla.v1.hal+json'
resource-type:
type: string
example: 'funding-source'
available:
type: object
properties:
value:
type: string
example: '3209.55'
currency:
type: string
example: USD
'404':
description: not found
headers: {}
Expand Down
90 changes: 88 additions & 2 deletions specs/resources/funding-sources/retrieveUpdateRemoveFundingSource.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ get:
tags:
- funding sources
summary: Retrieve a funding source
description: Returns detailed information for a specific funding source, including its type, status, and verification details. Supports bank accounts (via Open Banking) and Dwolla balance (verified customers only).
description: Returns detailed information for a specific funding source, including its type, status, and verification details. Supports bank accounts (via Open Banking), debit card funding sources, and Dwolla balance (verified customers only). Debit card funding sources include masked card details such as brand, last four digits, expiration date, and cardholder name.
operationId: getFundingSource
x-speakeasy-group: fundingSources
x-speakeasy-name-override: get
Expand Down Expand Up @@ -60,6 +60,92 @@ get:
application/vnd.dwolla.v1.hal+json:
schema:
$ref: '../../schemas/funding-sources/FundingSource.yml#/FundingSource'
examples:
standard_bank_account:
summary: Standard bank account
value:
_links:
self:
href: "https://api-sandbox.dwolla.com/funding-sources/49dbaa24-1580-4b1c-8b58-24e26656fa31"
type: "application/vnd.dwolla.v1.hal+json"
resource-type: "funding-source"
id: "49dbaa24-1580-4b1c-8b58-24e26656fa31"
status: "verified"
type: "bank"
bankAccountType: "checking"
name: "Test checking account"
created: "2022-07-23T00:18:21.419Z"
removed: false
channels:
- "ach"
bankName: "SANDBOX TEST BANK"
fingerprint: "5012989b55af15400e8102f95d2ec5e7ce3aef45c01613280d80a236dd8d6c"
settlement_account:
summary: Card network settlement account
value:
_links:
self:
href: "https://api-sandbox.dwolla.com/funding-sources/12345678-1234-1234-1234-123456789012"
type: "application/vnd.dwolla.v1.hal+json"
resource-type: "funding-source"
id: "12345678-1234-1234-1234-123456789012"
status: "unverified"
type: "bank"
bankAccountType: "checking"
name: "Checkout.com Settlement Account"
created: "2024-01-15T10:30:00.000Z"
removed: false
channels:
- "ach"
- "real-time-payments"
bankName: "ABC Bank"
fingerprint: "4cf31392f678cb26c62b75096e1a09d4465a801798b3d5c3729de44a4f54c794"
bankUsageType: "card-network"
card_funding_source:
summary: Debit card funding source
value:
_links:
self:
href: "https://api-sandbox.dwolla.com/funding-sources/12345678-abcd-1234-abcd-123456789012"
type: "application/vnd.dwolla.v1.hal+json"
resource-type: "funding-source"
transfer-to-balance:
href: "https://api-sandbox.dwolla.com/transfers"
type: "application/vnd.dwolla.v1.hal+json"
resource-type: "transfer"
remove:
href: "https://api-sandbox.dwolla.com/funding-sources/12345678-abcd-1234-abcd-123456789012"
type: "application/vnd.dwolla.v1.hal+json"
resource-type: "funding-source"
customer:
href: "https://api-sandbox.dwolla.com/customers/91f059e7-fac6-4677-bee1-49057a6e528f"
type: "application/vnd.dwolla.v1.hal+json"
resource-type: "customer"
transfer-receive:
href: "https://api-sandbox.dwolla.com/transfers"
type: "application/vnd.dwolla.v1.hal+json"
resource-type: "transfer"
id: "12fb2f3c-39c7-40cf-99e2-b0311ba39261"
status: "verified"
type: "card"
name: "My Visa Debit Card"
created: "2025-12-10T18:02:47.985Z"
removed: false
channels: []
fingerprint: "a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9b0c1d2e3f4a5b6c7d8e9f0a1b2"
cardDetails:
brand: "VISA"
lastFour: "1519"
expirationMonth: 10
expirationYear: 2027
nameOnCard: "Jane Doe"
bin: "40247644"
billingAddress:
address1: "552 test"
city: "Des Moines"
stateProvinceRegion: "IA"
country: "US"
postalCode: "50310"
'404':
description: not found
headers: {}
Expand Down Expand Up @@ -167,7 +253,7 @@ post:
example: validationError
message:
type: string
example: Only funding sources of type="bank" can be updated.
example: "Only funding sources of type='bank' can be updated."
'403':
description: forbidden
headers: {}
Expand Down
6 changes: 5 additions & 1 deletion specs/resources/transfers/initiateTransfer.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ post:
tags:
- transfers
summary: Initiate a transfer
description: Initiate a transfer between funding sources from a Dwolla Account or API Customer resource. Supports ACH, Instant Payments (RTP/FedNow), and wire transfers with optional expedited clearing, facilitator fees, metadata, and correlation IDs for enhanced traceability. Includes idempotency key support to prevent duplicate transfers and extensive customization options for addenda records and processing channels. Returns the location of the created transfer resource for tracking and management.
description: Initiate a transfer between funding sources from a Dwolla Account or API Customer resource. Supports ACH, Instant Payments (RTP/FedNow), Push-to-Debit Card, and wire transfers with optional expedited clearing, facilitator fees, metadata, and correlation IDs for enhanced traceability. Includes idempotency key support to prevent duplicate transfers and extensive customization options for addenda records and processing channels. Returns the location of the created transfer resource for tracking and management.
operationId: initiateTransfer
x-speakeasy-name-override: create
x-codeSamples:
Expand Down Expand Up @@ -473,6 +473,7 @@ post:
- $ref: '../../schemas/transfers/CreateTransfer.yml#/InvalidFacilitatorFeeCollectFromError'
- $ref: '../../schemas/transfers/CreateTransfer.yml#/InvalidFacilitatorFeeCollectFromCombinationError'
- $ref: '../../schemas/transfers/CreateTransfer.yml#/InvalidDestinationFundingSourceError'
- $ref: '../../schemas/transfers/CreateTransfer.yml#/InvalidOrRemovedCardDestinationError'
- $ref: '../../schemas/transfers/CreateTransfer.yml#/InvalidFacilitatorFeeAmountError'
- $ref: '../../schemas/transfers/CreateTransfer.yml#/WeeklyReceiveLimitReachedError'
- $ref: '../../schemas/transfers/CreateTransfer.yml#/InvalidDestinationClearingTypeError'
Expand All @@ -494,6 +495,8 @@ post:
- $ref: '../../schemas/transfers/CreateTransfer.yml#/InvalidSourceBankAccountTypeError'
- $ref: '../../schemas/transfers/CreateTransfer.yml#/InvalidDestinationBankAccountTypeError'
- $ref: '../../schemas/transfers/CreateTransfer.yml#/IncompatibleSourceAndDestinationTypesError'
- $ref: '../../schemas/transfers/CreateTransfer.yml#/SourceNotCardNetworkSettlementError'
- $ref: '../../schemas/transfers/CreateTransfer.yml#/CardSourceNotAllowedError'
- $ref: '../../schemas/transfers/CreateTransfer.yml#/IncompatibleSourceForRtpDestinationError'
- $ref: '../../schemas/transfers/CreateTransfer.yml#/InvalidAmountForDestinationProcessingChannelError'
- $ref: '../../schemas/transfers/CreateTransfer.yml#/RtpFacilitatorFeeNotSupportedError'
Expand All @@ -517,6 +520,7 @@ post:
- $ref: '../../schemas/transfers/CreateTransfer.yml#/WireAccountRestrictedError'
- $ref: '../../schemas/transfers/CreateTransfer.yml#/WireNotEnabledError'
- $ref: '../../schemas/transfers/CreateTransfer.yml#/WireAccountNotFoundError'
- $ref: '../../schemas/transfers/CreateTransfer.yml#/PrefundingSourceNotAllowedError'
'403':
description: Forbidden
headers: {}
Expand Down
3 changes: 3 additions & 0 deletions specs/resources/transfers/retrieveTransferFailureReason.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,9 @@ get:
application/vnd.dwolla.v1.hal+json:
schema:
type: object
required:
- code
- description
properties:
_links:
type: object
Expand Down
Loading
Loading