Forward payment-data
This endpoint enables platform merchants to leverage payment-data bundles in their acquirer integration.
The request is forwarded to the configured destination URL of your merchant settings.
Commerce requires certain HTTP headers for this feature. These headers are reserved and cannot be used by the caller:
| Header | Required? | Description |
|---|---|---|
x-api-key | Yes | Authentication of the request. |
x-hellgate-version | No | Define the API version to use for the request. |
Refer to the general documentation about forwarding senstive data for more information.
Authorizations
Path Parameters
The ID of the payment-data bundle
Body
The payload the caller wants to forward to the third party provider.
To securely handle and inject sensitive token data, predefined templates can be used. These templates help structure and standardize the data injection process while ensuring compliance with security and regulatory requirements.
| Placeholder | Type | Description |
|---|---|---|
{{ network_token }} | string | The Token-Pan (TPAN) of the network token. |
{{ cardholder_name }} | string | The name of the cardholder. |
{{ expiration_year }} | number | Four digit year of the expiration date. |
{{ expiration_month }} | number | Two digit month of the expiration date. |
{{ cryptogram }} | string | The token authentication verification value TAVV. |
{{ eci }} | string | The ECI associated with the payment-data bundle. |
{{ amount }} | number | The authenticated amount given in minor units. |
{{ currency_code }} | string | The currency code of the authenticated amount. |
Placeholder of type number can be unwrapped from the standard string representation.
Response
Success response
The response from the third party provider.