VOvopay
Embedded Experience Endpoints

gcm/recipient-contacts/generate-embed-url

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

post/gcm/recipient-contacts/generate-embed-url

Request

  • Base URL
    https://earthnode-dev.vopay.com/api/v2
  • URL
    https://earthnode-dev.vopay.com/api/v2/gcm/recipient-contacts/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

ContactClientTypestring required

Type of contact client. Options are individual or business.

Countrystring required

Destination country of the recipient contact (ISO 3166-1 alpha-2 or alpha-3 code).

UseCasestring required

Valid values are B2B, B2P, P2B, P2P

ClientAccountIDstring

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

ContactIDstring

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

FirstNamestring

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

LastNamestring

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

BusinessNamestring

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

SendEmailboolean

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

ReceiverEmailAddressstring email

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

SendSMSboolean

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

ReceiverPhoneNumberstring

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

RequiredPaymentMethodsstring

Comma-separated list of payment methods.

Labelstring

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

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

OnboardingLinkstring required

The URL of the onboarding link.

Example response

{
  "Success": true,
  "OnboardingLink": "https://request.vopay.com?Token=3s77vg2nwta8c3qc2rwpmmk8w03elfa7rmrsug3l"
}

Changes

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