Card Forwarding
Card forwarding enables one-click purchase by reusing the customer's vaulted payment method from their primary transaction. The integration leverages the partner's PSP Forward API to securely transmit card details to Rokt's PCI-compliant endpoint, where the charge is processed with the Rokt Catalog brand as MoR.
Card forwarding is supported on web, with additional platform support planned.
Sequence overviewSequence overview への直接リンク
- Customer clicks "Buy Now" on the Rokt placement within the confirmation page.
- Rokt calls partner API. Rokt sends an API request to the partner's backend, signaling that the customer has initiated a purchase and their stored payment details are needed.
- Partner looks up payment method using the
partnerpaymentreferenceattribute passed during SDK initialization. - Partner forwards card details. The partner calls the PSP's Forward API to forward the customer's raw PAN, billing address, and (if available) CVV to Rokt's destination endpoint.
- Rokt processes payment. Rokt's PCI-compliant endpoint receives the card details, creates a secure non-persistent token, and processes the charge with the brand as MoR.
- Confirmation displayed. Rokt returns the result. The placement displays the confirmation state.
Required attributesRequired attributes への直接リンク
Card forwarding requires the following attributes to be passed during SDK initialization. For the full list, see the recommended attributes in the SDK Integration Guide.
| Attribute | Type | Required | Description |
|---|---|---|---|
| partnerpaymentreference | string | Yes | Non-guessable identifier used to look up the customer's vaulted payment method. |
| last4digits | string | Yes | Last 4 digits of the card used for the primary transaction. Displayed to the customer for confirmation. |
| paymenttype | string | Yes | Payment method used for the primary transaction (e.g., visa, mastercard, amex). Used to determine which payment options to display. |
NOTE: If your platform does not have shipping address details available (e.g., ticket or digital goods purchases), pass billing address details instead. Rokt will provide a UI for the customer to confirm or edit their shipping address before completing the purchase.
Payment sharing APIPayment sharing API への直接リンク
Partners must build and expose a server-side API endpoint that Rokt can call to initiate the payment forwarding process.
Example requestExample request への直接リンク
POST /v1/initiate-payment-sharing
Authorization: Bearer <OAUTH_TOKEN>
{
"customerIdentifiers": {
"email": "john.smith@example.com"
},
"partnerPaymentReference": "ORDER_67890",
"destination": "COM.ROKT.CATALOG"
}
Required fieldsRequired fields への直接リンク
| Field | Type | Description |
|---|---|---|
| partnerPaymentReference | String | The payment reference passed as an SDK attribute, used to look up the vaulted payment method. |
| destination | String | Type of request. Use "COM.ROKT.CATALOG" for Shoppable Ads. |
| customerIdentifiers | Object | Optional additional identifiers (e.g., customerId) for extra security validation. |
IMPORTANT: Restrict this API endpoint to Rokt's static IP addresses. Rokt will provide a list of IPs to be whitelisted. Use OAuth 2.0 with short-lived tokens for authentication.
Forward API setupForward API setup への直接リンク
Configure your PSP's Forward API to forward card data to Rokt:
- Destination configuration: Create a new Forward API destination (config) pointing to Rokt's PCI-compliant endpoint. In production, submit a JSON config file to your PSP for review and approval. Rokt will provide the destination URL and required headers.
- API permissions: Ensure your PSP account has Forward API access enabled. Production usage is subject to eligibility - contact your PSP Account Manager.
Response formatResponse format への直接リンク
The response from the partner API must include the full body returned by the PSP's Forward API:
{
"status": 200,
"headers": { "Content-Type": "application/json" },
"body": {
"body-from-psp": "..."
},
"request-time": 150
}