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.

Form Data
string
required

Your account ID

string
required

API key for the account

string
required

Hashed signature for the request

string

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

string
required

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

string

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

boolean

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

boolean

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

boolean

When set to true, 3DS authentication will be triggered during the card addition process. Default is false.

Response

Language
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json