Document beneficiary information for transactions #209
Conversation
waldyrious
force-pushed
the
support/add-docs-for-beneficiary-info
branch
from
2ff4269
to
8081d70
Compare
waldyrious
force-pushed
the
support/add-docs-for-beneficiary-info
branch
from
8081d70
to
3a02d12
Compare
_transactions.md
Outdated
| "amount": "3000", | ||
| "currency": "USD" | ||
| }, | ||
| "destination": "[email protected]" |
There was a problem hiding this comment.
should we be using here an @uphold.com email?
also - what if someone signs up with that email?
There was a problem hiding this comment.
I think @uphold.com would be misleading. The goal here is to make it evident that this is an invite transaction, hence the generic and self-descriptive email address. That said, we could make it even more generic to drive that point home. I'll change to [email protected].
| "beneficiary": { | ||
| "relationship": "child", | ||
| "name": "Harper Wilson", | ||
| "address": { |
There was a problem hiding this comment.
Should we have a US address? I'm cool with Braga 😎 But is it common to have API docs with Braga?
There was a problem hiding this comment.
It's a good practice to make the examples varied, to showcase the diversity of supported content and formats. If we repeat the same structures and content, we risk making our API seem more rigid than it really is, or creating uncertainty regarding how to represent content that deviates from the examples.
_transactions.md
Outdated
| This is required if **both** the following conditions are met: | ||
|
|
||
| - The transaction is either a withdrawal to an external account (crypto networks, SEPA bank accounts, etc.) or a transfer to another user; and | ||
| - The transaction amount is over _$3000 USD_ (or over $1000 USD, if the origin user is from Arizona). |
There was a problem hiding this comment.
Better to reference Arizona, United States?
There was a problem hiding this comment.
Sure, will change.
_transactions.md
Outdated
| - The transaction amount is over _$3000 USD_ (or over $1000 USD, if the origin user is from Arizona). | ||
|
|
||
| <aside class="notice"> | ||
| The threshold value is calculated from the <a href="#normalized">normalized</a> amount of the transaction, |
There was a problem hiding this comment.
Should we mention that it's the amount normalized to USD?
There was a problem hiding this comment.
Good point, will change.
_transactions.md
Outdated
| The special value `myself` can also be used when applicable. | ||
|
|
||
| Depending on the conditions of the transaction, additional fields may be required | ||
| — namely, the beneficiary `name` and `address` (with subfields `city`, `country`, `line1`, `line2`, `state`, `zipCode`), |
There was a problem hiding this comment.
Should we state which fields are mandatory here?
There was a problem hiding this comment.
We don't want to duplicate the logic of the code into the docs, both to minimize the possibility of them becoming out of sync, and to avoid making the docs too complex (since the actual requirements depend on the interaction of various conditions). The goal here was to explain the behavior of the API, and let the API responses provide the specific conditions.
_transactions.md
Outdated
| and personal transactions (indicated by the values `child`, `co_worker`, `friend`, `parent`, or `sibling`). | ||
| The special value `myself` can also be used when applicable. | ||
|
|
||
| Depending on the conditions of the transaction, additional fields may be required |
There was a problem hiding this comment.
Is this newline with a dash intentional?
There was a problem hiding this comment.
It is intentional. I've been making use of semantic line breaks in the docs to facilitate reading of the the source files and make diffs more concise and readable, though I haven't applied that consistently throughout the repo yet. I can remove this particular instance if it's jarring to you.
There was a problem hiding this comment.
Oh, that's genius. Great concept ❤️
Anyway, I think what threw me off was the dash (-) itself. Maybe we can just remove it?
There was a problem hiding this comment.
Yeah, there is some discussion about whether/how to break on dashes — it's certainly not a clear-cut case. I'll go ahead and remove this break.
waldyrious
force-pushed
the
support/add-docs-for-beneficiary-info
branch
from
3a02d12
to
34ed607
Compare
waldyrious
force-pushed
the
support/add-docs-for-beneficiary-info
branch
from
34ed607
to
98edf50
Compare
|
@afsampaio we also need a list of the possible |
franciscocardoso
force-pushed
the
support/add-docs-for-beneficiary-info
branch
from
e2da129
to
98edf50
Compare
franciscocardoso
force-pushed
the
support/add-docs-for-beneficiary-info
branch
from
db9409a
to
e6b11ae
Compare
|
Deprecated by #219. |
Add a new section under the "Transactions" heading, describing the beneficiary information requirements.