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

Jump to bottom

feat(user-action-details): add AccountNumberUserAction #102

Merged
merged 6 commits into from
Nov 14, 2023
Merged

feat(user-action-details): add AccountNumberUserAction #102

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
f989337
feat(user-action-details): add BankAccountTransferUserAction
cajubelt Nov 5, 2023
7213839
updates based on Rasheed's feedback
cajubelt Nov 7, 2023
7cd3cb5
add deadline field to AccountNumberUserAction
cajubelt Nov 14, 2023
c332d54
add deadline to swagger.yaml
cajubelt Nov 14, 2023
e248c63
make transactionReference optional, update description
cajubelt Nov 14, 2023
0f2eb69
update package.json
cajubelt Nov 14, 2023
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
26 changes: 25 additions & 1 deletion fiatconnect-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -246,7 +246,8 @@
- [9.3.3.1. `PIXUserAction`](#9331-pixuseraction)
- [9.3.3.2. `IBANUserAction`](#9332-ibanuseraction)
- [9.3.3.3. `PSEUserAction`](#9333-pseuseraction)
- [9.3.3.4. `URLUserAction`](#9333-urluseraction)
- [9.3.3.4. `URLUserAction`](#9334-urluseraction)
- [9.3.3.5. `AccountNumberUserAction`](#9335-AccountNumberUserAction)
- [10. References](#10-references)
- [10.1. Normative References](#101-normative-references)
- [10.1.1. [RFC2119]](#1011-rfc2119)
Expand Down Expand Up @@ -2569,6 +2570,29 @@ schema.

The `url` field contains a URL which the user can follow in order to complete thier transfer of fiat funds to the provider.

#### 9.3.3.5. `AccountNumberUserAction`

`AccountNumberUserAction` is a User Action Details Schema for transfers in which require the user to send funds to
an account identified by some number to complete the transfer of fiat funds.

```
{
userActionType: `TransferInUserActionDetailsEnum.AccountNumberUserAction`,
institutionName: `string`,
accountName: `string`,
accountNumber: `string`,
transactionReference: `string`,
Copy link
Contributor

Choose a reason for hiding this comment

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

Can this be made optional for providers that don't require this? I imagine many providers will be able to cross reference the account the payment is from with the one on file. You can add the provision that if it's present, it MUST be included in the actual transfer itself.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

sounds reasonable. updated

deadline?: `string`
}
```

The `institutionName`, `accountName`, and `accountNumber` fields describe a provider-controlled
account that the user should send funds to. The `transactionReference` field is a string that the user MUST include
in the transaction details when sending funds to the provider's account, for identification purposes. The `deadline`
field, if included, MUST be an ISO 8601 datetime string, and represents the time by which the user needs to send funds
to the provider's fiat account. If the user sends fiat funds after this time, the provider may choose whether to complete the
transfer or return the funds and mark the transfer as failed.

# 10. References

## 10.1. Normative References
Expand Down
11 changes: 11 additions & 0 deletions swagger.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,7 @@ definitions:
- IBANUserAction
- PSEUserAction
- URLUserAction
- AccountNumberUserAction
UserActionDetails:
type: "object"
required:
Expand All @@ -123,6 +124,16 @@ definitions:
type: "string"
pixString:
type: "string"
accountName:
type: "string"
accountNumber:
type: "string"
institutionName:
type: "string"
transactionReference:
type: "string"
deadline:
type: "string"
QuoteRequest:
type: "object"
properties:
Expand Down