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 actions): Add URLUserAction schema #99

Merged
merged 6 commits into from
Aug 26, 2023
Merged

feat(user actions): Add URLUserAction schema #99

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
00e02ac
fix(swagger): Update user action detail enum in swagger
jophish Jun 25, 2023
45c94c3
Bump patch version
jophish Jun 26, 2023
5f177ca
Add URLUserAction
jophish Aug 25, 2023
2bfbc68
Merge branch 'main' into jophish/url-user-action
jophish Aug 25, 2023
d51a14f
Merge branch 'jophish/fixes' into jophish/url-user-action
jophish Aug 25, 2023
70dde02
Bump version
jophish Aug 25, 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
22 changes: 21 additions & 1 deletion fiatconnect-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -246,6 +246,7 @@
- [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)
- [10. References](#10-references)
- [10.1. Normative References](#101-normative-references)
- [10.1.1. [RFC2119]](#1011-rfc2119)
Expand Down Expand Up @@ -2272,7 +2273,8 @@ An enum listing the types of User Action Detail Schemas for transfers in.
[
`PIXUserAction`,
`IBANUserAction`,
`PSEUserAction`
`PSEUserAction`,
`URLUserAction`
]
```

Expand Down Expand Up @@ -2538,6 +2540,9 @@ The `iban` field represents the IBAN number for the provider-controlled bank acc

#### 9.3.3.3. `PSEUserAction`

**Deprecated:** Note that `PSEUserAction` is deprecated and its use is discouraged, in favor of the more general `URLUserAction` schema. Consider migrating
existing implementations over to using this schema instead of `PSEUserAction`.

`PSEUserAction` is a User Action Details Schema for transfers in requiring use of the Colombian [PSE payment system](https://www.pse.com.co/persona).

```
Expand All @@ -2549,6 +2554,21 @@ The `iban` field represents the IBAN number for the provider-controlled bank acc

The `url` field contains a uniquely generated URL which the user can follow in order to complete their transfer of fiat funds to the provider using the PSE payment system.

#### 9.3.3.4. `URLUserAction`

`URLUserAction` is a User Action Details Schema for transfers in which require the user to follow a URL to complete the transfer of fiat funds. The URL itself, and
action required by the user after navigating to the URL are unspecified by this schema; no particular semantics are required or imparted by use of the `URLUserAction`
schema.

```
{
userActionType: `TransferInUserActionDetailsEnum.URLUserAction`,
url: `string`,
}
```

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

# 10. References

## 10.1. Normative References
Expand Down
2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "specification",
"version": "1.1.4",
"version": "1.1.5",
"description": "FiatConnect API Specification",
"repository": "https://github.com/fiatconnect/specification.git",
"scripts": {
Expand Down
1 change: 1 addition & 0 deletions swagger.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,7 @@ definitions:
- PIXUserAction
- IBANUserAction
- PSEUserAction
- URLUserAction
UserActionDetails:
type: "object"
required:
Expand Down