VOvopay
Debit Card Endpoints

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.

post/debit-card/generate-embed-url

Request

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

Request body application/x-www-form-urlencoded

AccountIDstring required

Your account ID

Keystring required

API key for the account

Signaturestring required

Hashed signature for the request

ClientAccountIDstring

When provided, the credit card added will be attached to the Client Account ID

RedirectURLstring required

URL to redirect the user to after a card is added.

RedirectMethodstring

This parameter accepts InnerRedirect, OuterRedirect, and JavascriptMessage as parameter values.

ClientControlledboolean

When set to true, the card added will be linked to your VoPay account. Default is false.

CardTypeValidationboolean

When set to true, the card type will be validated to ensure the entered information represents a debit card. Default is false.

Response

Successboolean required

True if the request was successful, false if it failed

ErrorMessagestring required

Contains a description of the error if the request failed

EmbedURLstring required

Custom generated iQ11 iframe url for users to use

IframeKeystring required

Unique key attached to the generated iFrame

Example response

{
  "Success": true,
  "EmbedURL": "https://earthnode-dev.vopay.com/iq11/embed/{Key Returned by Vopay}",
  "IframeKey": "a1b2c3"
}

Changes

No recorded changes to this operation across all 1 revision of this API.