Skip to content

Commit d7a0688

Browse files
jmpfrazaoricardobcl
authored andcommitted
Remove invite transaction cancel and resend
1 parent 2fb5dd1 commit d7a0688

File tree

4 files changed

+8
-64
lines changed

4 files changed

+8
-64
lines changed

_applications.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ The following _scopes_ are deprecated and will be removed in a future version of
4747

4848
Scope | Description
4949
------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
50-
transactions:write | Can create a [transaction](#transaction-object) from any origin to any destination (another card or an external address), cancel and resend transactions. This scope is now deprecated in favor of the more fine-grained write scopes above (deposit, transfer and withdraw).
50+
transactions:write | Can create a [transaction](#transaction-object) from any origin to any destination (another card or an external address). This scope is now deprecated in favor of the more fine-grained write scopes above (deposit, transfer and withdraw).
5151

5252
<aside class="notice">
5353
<strong>Important Notice</strong>: Only specify scopes that your application absolutely needs.

_entities.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -262,7 +262,7 @@ origin | The sender of the funds. See [Origin](#origin).
262262
params | Other parameters of this transaction. See [Parameters](#parameters).
263263
priority | The priority of the transaction. Possible values are `normal` and `fast`.
264264
reference | A reference code assigned to the transaction. Can be any string, up to 100 characters. This is not exposed to the user; a possible use case is to reference an external ID in another system.
265-
status | The current status of the transaction. Possible values are `pending`, `processing`, `waiting`, `cancelled`, `failed` and `completed`.
265+
status | The current status of the transaction. Possible values are `pending`, `processing`, `cancelled`, `failed` and `completed`.
266266
type | The nature of the transaction. Possible values are `deposit`, `transfer` and `withdrawal`.
267267

268268
<aside class="notice">

_transactions.md

Lines changed: 5 additions & 61 deletions
Original file line numberDiff line numberDiff line change
@@ -362,14 +362,14 @@ As such, under the regulatory action of The Financial Action Task Force [FATF](h
362362
"amount": "3000",
363363
"currency": "USD"
364364
},
365-
"destination": "invite-user@mail.com",
365+
"destination": "1c857998-6ddf-4236-986b-71db03711bc9",
366366
"purpose": "donations"
367367
}
368368
```
369369

370370
Parameter | Required | Description
371371
----------- | -------- | -----------
372-
beneficiary | yes/no | The transaction beneficiary information. See [Beneficiary](#beneficiary). <br><br> <b>Required</b> for transfers to other users (invites included) and withdrawals above _$3000 USD_ (or _$1000 USD_, if the origin user is from Arizona, United States). <br><br> <b>Note:</b> ACH withdrawals do <b>not require</b> the beneficiary information to be sent. We only support personal bank accounts therefore the beneficiary (ACH account holder) is assumed to be the Uphold user who added that account.
372+
beneficiary | yes/no | The transaction beneficiary information. See [Beneficiary](#beneficiary). <br><br> <b>Required</b> for transfers to other users and withdrawals above _$3000 USD_ (or _$1000 USD_, if the origin user is from Arizona, United States). <br><br> <b>Note:</b> ACH withdrawals do <b>not require</b> the beneficiary information to be sent. We only support personal bank accounts therefore the beneficiary (ACH account holder) is assumed to be the Uphold user who added that account.
373373
purpose | yes/no | The reason for the transaction. <br><br> <b>Required</b> for transactions in which the relationship is not set to `myself`.<br><br>For business relationships, the possible values are: `business_expenses`, `business_travel`, `consultancy_expenses`, `education_expenses`, `family_expenses`, `funding_investments`, `gift_or_donations`, `invoice_payment`, `loan_payment`, `personal_expenses`, `salary_payments`, and `technology_expenses`.<br><br>For personal relationships, the possible values are: `bill_payments`, `donations`, `expenses`, `gift`, `living_expenses`, `payment_for_goods_or_services`, and `supporting_family_internationally`.
374374

375375
### Beneficiary
@@ -378,8 +378,8 @@ This beneficiary field has the following properties:
378378

379379
Parameter | Required | Description
380380
------------ | ----------- | -----------
381-
address | yes/no | The transaction beneficiary address information. See [Address](#address). <br><br> <b>Required</b> for invites and external beneficiaries.
382-
name | yes/no | The beneficiary's full name. <br><br> <b>Required</b> for invites and external beneficiaries. <br><br> For all transactions, except those with `relationship` type `business`, the name must be composed of at least, 2 words with a minimum of 2 characters each, for the first and last word.
381+
address | yes/no | The transaction beneficiary address information. See [Address](#address). <br><br> <b>Required</b> for external beneficiaries.
382+
name | yes/no | The beneficiary's full name. <br><br> <b>Required</b> for external beneficiaries. <br><br> For all transactions, except those with `relationship` type `business`, the name must be composed of at least, 2 words with a minimum of 2 characters each, for the first and last word.
383383
relationship | yes | Reflects the beneficiary's relationship to the transaction originator. <br><br> Possible values are `business`, `child`, `co_worker`, `friend`, `myself`, `parent`, `sibling`.
384384

385385
### Address
@@ -423,7 +423,7 @@ curl 'https://api-sandbox.uphold.com/v0/me/cards/<card-id>/transactions' \
423423
"amount": "3000",
424424
"currency": "USD"
425425
},
426-
"destination": "invite-user@mail.com",
426+
"destination": "1c857998-6ddf-4236-986b-71db03711bc9",
427427
"purpose": "donations"
428428
}'
429429
```
@@ -497,62 +497,6 @@ curl 'https://api-sandbox.uphold.com/v0/me/cards/<card-id>/transactions/<transac
497497
For regulatory compliance reasons, the beneficiary name is checked by a sanctions screening process, and is expected to consist entirely of characters in the Latin, Cyrillic, Greek or Georgian alphabets, along with a limited set of special characters. These validations may result in an <code>invalid_beneficiary</code> error.
498498
</aside>
499499

500-
## Cancel a Transaction
501-
502-
```bash
503-
curl https://api.uphold.com/v0/me/cards/a6d35fcd-xxxx-9c9d1dda6d57/transactions/d51b4e4e-9827-40fb-8763-e0ea2880085b/cancel \
504-
-X POST \
505-
-H "Authorization: Bearer <token>"
506-
```
507-
508-
> Returns a [Transaction Object](#transaction-object).
509-
510-
Cancels a transaction that has not yet been redeemed.
511-
512-
### Request
513-
514-
`POST https://api.uphold.com/v0/me/cards/:card/transactions/:id/cancel`
515-
516-
<aside class="notice">
517-
Requires the <code>transactions:transfer:others</code> scope for Uphold Connect applications.
518-
</aside>
519-
520-
### Response
521-
522-
Returns a [Transaction Object](#transaction-object).
523-
524-
<aside class="notice">
525-
Only transactions with status <code>waiting</code> can be cancelled.
526-
</aside>
527-
528-
## Resend a Transaction
529-
530-
```bash
531-
curl https://api.uphold.com/v0/me/cards/a6d35fcd-xxxx-9c9d1dda6d57/transactions/d51b4e4e-9827-40fb-8763-e0ea2880085b/resend \
532-
-X POST \
533-
-H "Authorization: Bearer <token>"
534-
```
535-
536-
> Returns a [Transaction Object](#transaction-object).
537-
538-
Triggers a reminder for a transaction that hasn't been redeemed yet.
539-
540-
### Request
541-
542-
`POST https://api.uphold.com/v0/me/cards/:card/transactions/:id/resend`
543-
544-
<aside class="notice">
545-
Requires the <code>transactions:transfer:others</code> scope for Uphold Connect applications.
546-
</aside>
547-
548-
### Response
549-
550-
Returns a [Transaction Object](#transaction-object).
551-
552-
<aside class="notice">
553-
Only transactions with status <code>waiting</code> can be resent.
554-
</aside>
555-
556500
## List User Transactions
557501

558502
```bash

_webhooks.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -122,6 +122,6 @@ Parameter | Description
122122
----------|-------------------------------------------------------------------------
123123
id | The id of the transaction.
124124
status | A string with the transaction status that triggered the hook.
125-
| | Possible values are: `cancelled`, `completed`, `failed` and `waiting`.
125+
| | Possible values are: `cancelled`, `completed` and `failed`.
126126

127127
It returns the `id` of the created transaction, along with its current `status`.

0 commit comments

Comments
 (0)