Skip to content

Latest commit

 

History

History
77 lines (59 loc) · 2.64 KB

_accounts.md

File metadata and controls

77 lines (59 loc) · 2.64 KB

Accounts

Uphold allows users to deposit value into a specific card from an external source (ACH account, debit/credit card or wire transfer) or withdraw to an external source (ACH account or wire transfer).

Whenever a deposit is made into an Uphold card, it will be automatically converted into the value determined by the card's denomination. Likewise, when a withdrawal is made, the currency will be converted to the currency of the destination account, thus minimizing fees and currency conversions.

We support the following account types:

Account type Deposits supported? Withdrawals supported?
ach Yes Yes
card Yes No
sepa Yes Yes

Please refer to our FAQ for estimated ACH transaction times, SEPA transaction times, fees and limits.

List Accounts

curl https://api.uphold.com/v0/me/accounts \
  -H "Authorization: Bearer <token>"

The above command returns the following JSON:

[{
  "currency": "USD",
  "id": "bfef7422-9f3c-47e0-4d4b-569d92d29a5c",
  "label": "My Chase card",
  "status": "ok",
  "type": "card"
}, {
  "currency": "EUR",
  "id": "0fa000c0-618a-4de1-ad0e-beb593f4d07d",
  "label": "My checking account",
  "status": "ok",
  "type": "sepa"
}]

Retrieves a list of accounts for the current user.

Request

GET https://api.uphold.com/v0/me/accounts

Requires the `accounts:read` scope for Uphold Connect applications.

Response

Returns an array of the current user's accounts.

Get Account Details

curl https://api.uphold.com/v0/me/accounts/0fa000c0-618a-4de1-ad0e-beb593f4d07d \
  -H "Authorization: Bearer <token>"

The above command returns the following JSON:

{
  "currency": "EUR",
  "id": "0fa000c0-618a-4de1-ad0e-beb593f4d07d",
  "label": "My checking account",
  "status": "ok",
  "type": "sepa"
}

Retrieves the details about a specific account.

Request

GET https://api.uphold.com/v0/me/accounts/:id

Requires the `accounts:read` scope for Uphold Connect applications. The account id must be owned by the user performing the API call.

Response

Returns a fully formed Account Object representing the requested account.