gcm/recipient-contacts/generate-embed-url

post

https://earthnode-dev.vopay.com/api/v2/gcm/recipient-contacts/generate-embed-url

Generate a link to the cross-border iframe for onboarding recipient contacts.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Form Data

AccountID

string

required

Your account ID

Key

string

required

API key for the account

Signature

string

required

Hashed signature for the request

ContactClientType

string

required

Type of contact client. Options are individual or business.

ClientAccountID

string

Client account ID. If not provided, the primary client account will be used.

ContactID

string

Contact ID. If not provided, the primary client account will be used.

FirstName

string

Client's first name. Required if BusinessName is not provided.

LastName

string

Client's last name. Required if BusinessName is not provided.

BusinessName

string

Client's business name. Required if FirstName and LastName are not provided.

SendEmail

boolean

Set to true to send an onboarding link via email. Default is false.

ReceiverEmailAddress

string

Recipient's email address. Required if SendEmail = true.

SendSMS

boolean

Set to true to send an onboarding link via SMS. Default is false.

ReceiverPhoneNumber

string

Recipient's phone number. Required if SendSMS = true.

RequiredPaymentMethods

string

Comma-separated list of payment methods.

Label

string

Label to be added to the client account. If the label doesn't exist, it will be created and applied.

Response

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200