> ## Documentation Index
> Fetch the complete documentation index at: https://developer.uphold.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Card withdrawal via the REST API
> Send card withdrawals with the Uphold REST API: link or list a card external account, create a quote, and submit the withdrawal transaction to the user.
export const feature_0 = "withdraw"
This guide walks you through supporting card withdrawals using the REST API.
## Prerequisites
* The user has [completed onboarding](/developer-guides/user-onboarding/overview) and has the required capabilities enabled.
* A **funded account** to debit the funds from.
## Walkthrough
```mermaid theme={null}
sequenceDiagram
autonumber
participant Usr as User
participant U as Your App
participant B as Your Backend
participant A as Uphold
Usr->>U: Start card withdrawal
U->>B: List accounts
B->>A: GET /core/accounts
A-->>B: { accounts }
B-->>U: { accounts }
Usr->>U: Choose source account
U->>B: List card accounts
B->>A: GET /core/external-accounts
A-->>B: { externalAccounts }
B-->>U: { externalAccounts }
opt No existing card account
Usr->>U: Add card details
U->>B: Link card account
B->>A: Create card external account
A-->>B: { externalAccount }
end
Usr->>U: Choose card and amount
alt First time (EMD disclaimer)
U->>Usr: Display EMD disclaimer
Usr->>U: Acknowledge
end
U->>B: Request quote
B->>A: Create quote (account → card)
A-->>B: { quote }
B-->>U: { quote }
Usr->>U: Confirm
U->>B: Create transaction
B->>A: Create transaction
A-->>B: { transaction }
A-->>B: webhook: transaction.created (processing)
A-->>B: webhook: transaction.status-changed (completed/failed)
B-->>Usr: Notify the user
```
***
## Check available rails
Call [List Rails](/rest-apis/core-api/assets/list-rails) to verify card withdrawal is available.
```http theme={null}
GET /core/rails?type=card
```
```json theme={null}
{
"rails": [
{
"type": "card",
"network": "visa",
"method": "debit-card",
"asset": "GBP",
"decimals": 2,
"features": [
"deposit",
"withdraw"
]
}
]
}
```
## Select source account
Card withdrawals can be sourced from any account. If the selected account is not in the card's currency, the balance will be converted at the time of the transaction using Uphold's prevailing rate. Make sure the origin asset has the necessary [features enabled](/rest-apis/core-api/assets/introduction#features-and-deposits-/-withdrawals).
Call [List accounts](/rest-apis/core-api/accounts/list-accounts) to retrieve the user's accounts and let them pick the one to withdraw from.
```http theme={null}
GET /core/accounts
```
```json theme={null}
{
"accounts": [
{
"id": "a00507fe-628c-4f27-ae81-e1c40b2a8fb8",
"ownerId": "e4ce04dc-67b7-4e9f-af91-482cb6f9fc4a",
"label": "My GBP account",
"asset": "GBP",
"balance": {
"total": "500.00",
"available": "500.00"
}
}
]
}
```
## Link or select a card account
Let the user link a new card or select an existing one.
### Find an existing card account
Call [List external accounts](/rest-apis/core-api/external-accounts/list-external-accounts) to fetch the user's saved cards.
```http theme={null}
GET /core/external-accounts
```
Make sure the selected card has `status: "ok"` and **{feature_0}** in `features`.
```json theme={null}
{
"externalAccounts": [
{
"id": "7d5928c5-8ac4-4b0d-8b45-f332ba6a9de7",
"ownerId": "e4ce04dc-67b7-4e9f-af91-482cb6f9fc4a",
"type": "card",
"status": "ok",
"label": "My Visa Card",
"asset": "GBP",
"network": "visa",
"features": [
"deposit",
"withdraw"
],
"details": {
"type": "debit",
"last4Digits": "5119",
"expiryDate": {
"month": 12,
"year": 2028
},
"octSupport": "supported"
}
}
]
}
```
### Link a new card account
If the user wants to use a card not yet on file, call [Create external account](/rest-apis/core-api/external-accounts/create-external-account) with the card details.
```http theme={null}
POST /core/external-accounts
{
"type": "card",
"label": "My Visa Card",
"number": "4921817844445119",
"securityCode": "123",
"expiryDate": {
"month": 12,
"year": 2028
}
}
```
The response initially returns `status: "processing"` while the card is validated.
```json theme={null}
{
"externalAccount": {
"id": "7d5928c5-8ac4-4b0d-8b45-f332ba6a9de7",
"type": "card",
"status": "processing",
"label": "My Visa Card"
}
}
```
Once validated, the status transitions to `ok` and the full details are available.
```json theme={null}
{
"externalAccount": {
"id": "7d5928c5-8ac4-4b0d-8b45-f332ba6a9de7",
"ownerId": "e4ce04dc-67b7-4e9f-af91-482cb6f9fc4a",
"type": "card",
"status": "ok",
"label": "My Visa Card",
"asset": "GBP",
"network": "visa",
"features": [
"deposit",
"withdraw"
],
"details": {
"type": "debit",
"last4Digits": "5119",
"expiryDate": {
"month": 12,
"year": 2028
},
"octSupport": "supported"
}
}
}
```
Monitor the external account status via [Get external account](/rest-apis/core-api/external-accounts/get-external-account) or the `external-account.status-changed` webhook until `status` is `ok` before proceeding.
### EMD disclaimer
This disclaimer is required to comply with FCA regulations. Display it to users based in GB, the first time they link a credit/debit card or generate bank deposit details — it only needs to be shown once:
> Uphold Europe Limited is an EMD Agent of Optimus Cards UK Limited (FRN: 902034). All received funds are held in a designated safekeeping account with a regulated bank and kept separate from Uphold's own assets. These funds are not protected by the UK Financial Services Compensation Scheme.
## Create a quote
Call [Create quote](/rest-apis/core-api/transactions/create-quote) with the origin account and the card external account as destination.
```http theme={null}
POST /core/transactions/quote
{
"origin": {
"type": "account",
"id": "a00507fe-628c-4f27-ae81-e1c40b2a8fb8"
},
"destination": {
"type": "external-account",
"id": "7d5928c5-8ac4-4b0d-8b45-f332ba6a9de7"
},
"denomination": {
"asset": "GBP",
"amount": "250.00",
"target": "origin"
}
}
```
```json [expandable] theme={null}
{
"quote": {
"id": "a91f3c72-1e4b-4c8a-b3e9-9f2d8e4b7c1a",
"origin": {
"amount": "250.00",
"asset": "GBP",
"node": {
"type": "account",
"id": "a00507fe-628c-4f27-ae81-e1c40b2a8fb8",
"ownerId": "e4ce04dc-67b7-4e9f-af91-482cb6f9fc4a"
},
"rate": "1"
},
"destination": {
"amount": "250.00",
"asset": "GBP",
"node": {
"type": "external-account",
"id": "7d5928c5-8ac4-4b0d-8b45-f332ba6a9de7",
"ownerId": "e4ce04dc-67b7-4e9f-af91-482cb6f9fc4a"
},
"rate": "1"
},
"denomination": {
"asset": "GBP",
"amount": "250.00",
"target": "origin",
"rate": "1"
},
"fees": [],
"expiresAt": "2024-07-24T15:22:39Z"
}
}
```
Quotes typically **expire** quickly. Prompt for user confirmation within the expiry window and requote if needed.
## Confirm and create transaction
Once the user confirms, call [Create transaction](/rest-apis/core-api/transactions/create-transaction) with the quote ID.
```http theme={null}
POST /core/transactions
{
"quoteId": "a91f3c72-1e4b-4c8a-b3e9-9f2d8e4b7c1a"
}
```
In a successful card withdrawal, the origin is the user's `account` and the destination is the `external-account` representing the card. The transaction status is initially `processing` and updates to `completed` once the transfer settles.
```json [expandable] theme={null}
{
"transaction": {
"id": "a1b2c3d4-5e6f-4a8b-9c0d-1e2f3a4b5c6d",
"origin": {
"asset": "GBP",
"amount": "250.00",
"node": {
"type": "account",
"id": "a00507fe-628c-4f27-ae81-e1c40b2a8fb8",
"ownerId": "e4ce04dc-67b7-4e9f-af91-482cb6f9fc4a"
}
},
"destination": {
"asset": "GBP",
"amount": "250.00",
"node": {
"type": "external-account",
"id": "7d5928c5-8ac4-4b0d-8b45-f332ba6a9de7",
"ownerId": "e4ce04dc-67b7-4e9f-af91-482cb6f9fc4a"
}
},
"status": "completed",
"quotedAt": "2025-01-10T14:22:15Z",
"createdAt": "2025-01-10T14:22:45Z",
"updatedAt": "2025-01-10T14:22:45Z",
"denomination": {
"asset": "GBP",
"amount": "250.00",
"target": "origin"
}
}
}
```
## Notify the user
Display an in-app confirmation when the transaction is `completed`, and send an email if applicable.
You now support card withdrawals via the REST API.