---
updatedAt: 2026-05-06T01:44:13.000Z
agentTools:
  projectIndex: https://docs.vopay.com/llms.txt
---

# API Reference

## Supported Operations

* Generate embed URL for card capture
* Push funds to a debit card (OCT)
* Pull funds from a debit card (AFT)
* Manage cards on file (retrieve, set default, delete)

<br />

## Endpoints

### Generate Embed URL

`POST /api/v2/debit-card/generate-embed-url`

Generates a URL for the hosted debit card capture iFrame.

No additional parameters required beyond authentication.

***

### OCT — Push Funds

`POST /api/v2/debit-card/oct/push-funds`

Pushes funds from your VoPay account to a debit card via Original Credit Transaction (OCT).

#### Request Parameters

| Parameter             | Type    | Required    | Description                                          |
| --------------------- | ------- | ----------- | ---------------------------------------------------- |
| Amount                | decimal | Yes         | Amount to push to the card                           |
| Token                 | string  | Conditional | Debit card token. Required if no default card is set |
| ClientAccountID       | string  | Optional    | Link transaction to a sub-account                    |
| ClientReferenceNumber | string  | Optional    | Your internal reference number                       |
| IdempotencyKey        | string  | Optional    | Unique key to prevent duplicate transactions         |
| Notes                 | string  | Optional    | Internal notes                                       |

***

### Get OCT Transaction

`GET /api/v2/debit-card/oct/transaction`

Returns details of a single OCT push-funds transaction.

#### Request Parameters

| Parameter     | Type   | Required | Description                                                   |
| ------------- | ------ | -------- | ------------------------------------------------------------- |
| TransactionID | string | Yes      | The transaction ID returned from `/debit-card/oct/push-funds` |

***

### AFT — Pull Funds

`POST /api/v2/debit-card/aft/pull-funds`

Pulls funds from a debit card into your VoPay account via Account Funding Transaction (AFT).

#### Request Parameters

| Parameter             | Type    | Required    | Description                                          |
| --------------------- | ------- | ----------- | ---------------------------------------------------- |
| Amount                | decimal | Yes         | Amount to pull from the card                         |
| Token                 | string  | Conditional | Debit card token. Required if no default card is set |
| ClientAccountID       | string  | Optional    | Link transaction to a sub-account                    |
| ClientReferenceNumber | string  | Optional    | Your internal reference number                       |
| IdempotencyKey        | string  | Optional    | Unique key to prevent duplicate transactions         |
| Notes                 | string  | Optional    | Internal notes                                       |

***

### Get AFT Transaction

`GET /api/v2/debit-card/aft/transaction`

Returns details of a single AFT pull-funds transaction.

#### Request Parameters

| Parameter     | Type   | Required | Description                                                   |
| ------------- | ------ | -------- | ------------------------------------------------------------- |
| TransactionID | string | Yes      | The transaction ID returned from `/debit-card/aft/pull-funds` |

***

### Get Cards on File

`GET /api/v2/debit-card`

Returns all debit cards linked to the account.

No additional parameters required.

***

### Set Default Debit Card

`POST /api/v2/debit-card/set-debit-card`

Sets a linked debit card as the default for the account.

#### Request Parameters

| Parameter | Type   | Required | Description                            |
| --------- | ------ | -------- | -------------------------------------- |
| Token     | string | Yes      | The debit card token to set as default |

***

### Get Default Debit Card

`GET /api/v2/debit-card/default-debit-card`

Returns the default debit card configured for the account.

No additional parameters required.

***

### Delete Debit Card

`POST /api/v2/debit-card/delete`

Removes a linked debit card from the account.

#### Request Parameters

| Parameter | Type   | Required | Description                    |
| --------- | ------ | -------- | ------------------------------ |
| Token     | string | Yes      | The debit card token to delete |