---
updatedAt: 2026-07-07T16:41:47.000Z
agentTools:
  projectIndex: https://docs.vopay.com/llms.txt
---

# debit-card/generate-embed-url

This endpoint is used to generate a unique URL to embed into your application using an iFrame. End users will use this to provide their card information, which can be used in the /debit-card/oct/push-funds and /debit-card/aft/pull-funds endpoint.

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "version": "2.0",
    "title": "Payment Methods",
    "description": "The Payment Methods API allows you to manage your payment methods.  You can add, delete, and set default payment methods.",
    "contact": {
      "name": "API Support",
      "email": "help@vopay.com"
    }
  },
  "paths": {
    "/debit-card/generate-embed-url": {
      "post": {
        "description": "This endpoint is used to generate a unique URL to embed into your application using an iFrame. End users will use this to provide their card information, which can be used in the /debit-card/oct/push-funds and /debit-card/aft/pull-funds endpoint.",
        "summary": "debit-card/generate-embed-url",
        "tags": [
          "Debit Card Endpoints"
        ],
        "operationId": "DebtiCardGenerateEmbedURLPOST",
        "deprecated": false,
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "AccountID": {
                    "description": "Your account ID",
                    "type": "string"
                  },
                  "Key": {
                    "description": "API key for the account",
                    "type": "string"
                  },
                  "Signature": {
                    "description": "Hashed signature for the request",
                    "type": "string"
                  },
                  "ClientAccountID": {
                    "description": "When provided, the credit card added will be attached to the Client Account ID",
                    "type": "string"
                  },
                  "RedirectURL": {
                    "description": "URL to redirect the user to after a card is added.",
                    "type": "string"
                  },
                  "RedirectMethod": {
                    "description": "This parameter accepts InnerRedirect, OuterRedirect, and JavascriptMessage as parameter values.",
                    "type": "string"
                  },
                  "ClientControlled": {
                    "description": "When set to true, the card added will be linked to your VoPay account. Default is false.",
                    "type": "boolean"
                  },
                  "CardTypeValidation": {
                    "description": "When set to true, the card type will be validated to ensure the entered information represents a debit card. Default is false.",
                    "type": "boolean"
                  }
                },
                "required": [
                  "AccountID",
                  "Key",
                  "Signature",
                  "RedirectURL"
                ]
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "",
            "headers": {},
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "Success": {
                      "type": "boolean",
                      "description": "True if the request was successful, false if it failed",
                      "example": true
                    },
                    "ErrorMessage": {
                      "type": "string",
                      "description": "Contains a description of the error if the request failed",
                      "example": ""
                    },
                    "EmbedURL": {
                      "type": "string",
                      "description": "Custom generated iQ11 iframe url for users to use",
                      "example": "https://earthnode-dev.vopay.com/iq11/embed/{Key Returned by Vopay}"
                    },
                    "IframeKey": {
                      "type": "string",
                      "description": "Unique key attached to the generated iFrame",
                      "example": "a1b2c3"
                    }
                  },
                  "required": [
                    "Success",
                    "ErrorMessage",
                    "EmbedURL",
                    "IframeKey"
                  ]
                }
              }
            }
          }
        }
      }
    }
  },
  "servers": [
    {
      "url": "https://earthnode-dev.vopay.com/api/v2"
    }
  ]
}
```