Skip to content
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

Update payments api for implementation #66

Open
wants to merge 11 commits into
base: payments-api-beta
Choose a base branch
from
Open

Update payments api for implementation #66

Changes from 2 commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
9f73a9a
remove payments information from transaction apis
Neilshweky Nov 11, 2024
0fb337a
remove payment_id as a requirement
Neilshweky Nov 11, 2024
e38d7d7
remove references to an address_id
Neilshweky Nov 12, 2024
43f5e33
remove get address
Neilshweky Nov 12, 2024
3b7971a
remove created at and updated at
Neilshweky Nov 12, 2024
22bf180
remove transactions and update create payment
Neilshweky Nov 20, 2024
17adf82
fix fern comp
Neilshweky Nov 20, 2024
fa9dbd4
add transactions to payments api
Neilshweky Nov 20, 2024
762b6fe
fix fern
Neilshweky Nov 20, 2024
8b18420
add back portions
Neilshweky Nov 20, 2024
aeb3fc2
add transactions to payments get
Neilshweky Nov 21, 2024
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
24 changes: 4 additions & 20 deletions specs/2024-10-30.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1101,7 +1101,7 @@ paths:
purpose:
type: string
description: |
What the File will be used for. We may add additional possible values for this enum over time;
What the File will be used for. We may add additional possible values for this enum over time;
your application should be able to handle such additions gracefully.
grant_letter: A grant letter
tax_document: A tax document
Expand Down Expand Up @@ -1657,7 +1657,7 @@ components:
type: string
description: |-
The name of the organization.
For organizations that operate under a different name than the one tied to the legal entity,
For organizations that operate under a different name than the one tied to the legal entity,
this name will differ from the name of the linked entity.
This is also known as the "DBA" or "Doing Business As" name of the organization.
example: American Red Cross
Expand Down Expand Up @@ -2355,7 +2355,7 @@ components:
purpose:
type: string
description: |
What the File will be used for. We may add additional possible values for this enum over time;
What the File will be used for. We may add additional possible values for this enum over time;
your application should be able to handle such additions gracefully.
grant_letter: A grant letter
tax_document: A tax document
Expand Down Expand Up @@ -2418,7 +2418,6 @@ components:
required:
- organization_id
- amount
- payment_id
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

remove payment_id as a requirement. This payment id is only relevant if the org creates the payment through the CreatePayments API, but if they choose to process the payments themselves, there is no payment ID to provide

properties:
id:
type: string
Expand Down Expand Up @@ -2457,27 +2456,12 @@ components:
description: |-
The unique identifier for the payment that the transaction is associated with.
example: "pay_1LaXpKGUcADgqoEMl0Cx0Ygg"
payment:
$ref: "#/components/schemas/Payment"
payment_details:
$ref: "#/components/schemas/PaymentDetails"
Comment on lines -2460 to -2463
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

removed payment details from the create transactions request. Transactions are many-to-one with payments, so it wouldnt make sense to specify payment details in the create transactions route

attachment_file_id:
type: string
description: |-
The unique identifier for the file that is attached to the transaction.
This is useful if you want to attach a letter or another document to the transaction.
example: "file_1LaXpKGUcADgqoEMl0Cx0Ygg"
status:
type: string
description: The status of the transaction
example: "pending"
readOnly: true
enum:
- pending
- submitted
- completed
- canceled
- rejected
Comment on lines -2470 to -2480
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

since we dont allow for updating a transaction, I didnt think it made sense to provide a status (which inherently implies it should be updatable)

created_at:
type: string
format: date-time
Expand Down Expand Up @@ -2589,7 +2573,7 @@ components:
properties:
irs_group_exemption_number:
type: string
description: This is a four-digit internal IRS number assigned to central/parent entity holding group exemption letters.
description: This is a four-digit internal IRS number assigned to central/parent entity holding group exemption letters.
irs_subsection_code:
type: string
description: The IRS subsection code for the entity
Expand Down
Loading