---
title: "credit-card/generate-embed-url"
method: POST
path: "/credit-card/generate-embed-url"
tags: ["Credit Card Endpoints"]
---

# credit-card/generate-embed-url

`POST /credit-card/generate-embed-url`

## Request

- Base URL: `https://earthnode-dev.vopay.com/api/v2`
- URL: `https://earthnode-dev.vopay.com/api/v2/credit-card/generate-embed-url`
- Auth: none declared

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 credit card information, which can be used in the /credit-card/charge endpoint.

## Request body `application/x-www-form-urlencoded`

- object
  - `AccountID` string, required: Your account ID
  - `Key` string, required: API key for the account
  - `Signature` string, required: Hashed signature for the request
  - `ClientAccountID` string: When provided, the credit card added will be attached to the Client Account ID
  - `RedirectURL` string, required: URL to redirect the user to after a credit card is added.
  - `RedirectMethod` string: This parameter accepts InnerRedirect, OuterRedirect, and JavascriptMessage as parameter values.
  - `ClientControlled` boolean: When set to true, the credit card added will be linked to your VoPay account. Default is false.
  - `CardTypeValidation` boolean: When set to true, the card type will be validated to ensure the entered information represents a credit card. Default is false.

## Response `200`

- object
  - `Success` boolean, required: True if the request was successful, false if it failed
  - `ErrorMessage` string, required: Contains a description of the error if the request failed
  - `EmbedURL` string, required: Custom generated iQ11 iframe url for users to use
  - `IframeKey` string, required: Unique key attached to the generated iFrame

---

[API](https://skmtc.dev/vopay/apis/payment-methods.md) - [All operations](https://skmtc.dev/vopay/apis/payment-methods/llms.txt) - [OpenAPI document](https://skmtc.dev/vopay/apis/payment-methods/revisions/b566c8002410?raw)