Generate Share Links

The generateVCShareLinks mutation allows you to generate shareable links for recipients to claim virtual cards on your account.

Pre-requisites: https://docs.fluz.app/v0.0.48-hosted-links/update/docs/share-virtual-cards.

GetVCShareLinksInput

FieldTypeDescriptionRequired
cardLimitIntThe limit on the card you want to share.Yes
offerIdStringThe offer ID for the virtual card.Yes
quantityIntThe number of share links to generate.Yes
shareMethodShareMethodTypeThe method you want to share cards.Yes
userCashBalanceIdUUIDThe spend account you want to use to fund the virtual card.Yes
daysUntilExpirationIntThe number of days the card should be valid for.No
recipientListPhone[String]The list of phone numbers to send the share link to via SMS. Required when shareMethod is PHONE_NUMBER. Array length must match quantity.No
recipientListEmail[String]The list of email addresses to send the share link to. Required when shareMethod is EMAIL. Array length must match quantity.No

📘

Please note

  • If your funding source does not have enough funds at the time of the recipient claiming the card, it will fail. Please ensure you have sufficient balances.
  • daysUntilExpiration will determine the date until the link expires. It will also determine the lock date of the virtual card. E.g. if daysUntilExpiration is 30, then the recipient has 30 days to claim and fully use the virtual card.
  • The phone numbers in recipientListPhone must be a string with no spaces, and it must include the country code at the beginning e.g. +18883606660 where +1 is the country code.