Skip to main content
POST
/
api
/
network
/
tokens
/
{id}
/
forward
Forward cryptogram
curl --request POST \
  --url https://{cluster_id}.on-hellgate.cloud/api/network/tokens/{id}/forward \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --header 'x-cryptogram-reference: <x-cryptogram-reference>' \
  --header 'x-destination-url: <x-destination-url>' \
  --data '
{
  "paymentMethod": {
    "type": "networkToken",
    "number": "{{ number }}",
    "expiryMonth": "{{ expiry_month | unwrap }}",
    "expiryYear": "{{ expiry_year | unwrap }}"
  },
  "mpiData": {
    "authenticationResponse": "Y",
    "cavv": "{{ cryptogram }}",
    "eci": "{{ eci }}"
  }
}
'
{}

Authorizations

​
x-api-key
string
header
required

Headers

​
x-cryptogram-reference
string<uuid>
required

The cryptogram_reference UUID returned by Request cryptogram in reference mode. Single-use and short-lived.

​
x-destination-url
string<uri>
required

The target URL to which the request shall be forwarded. Guardian forwards calls only to whitelisted destination URLs (major payment providers are included by default). Contact support to whitelist a custom URL.

Path Parameters

​
id
string<uuid>
required

The ID of the network token.

Body

application/json

The payload to forward to the third-party provider.

Use placeholders to inject sensitive, cryptogram-derived data on the fly. Available placeholders include {{ cryptogram }}, {{ dynamic_cvv }}, {{ eci }}, {{ expiry_month }}, {{ expiry_year }}, {{ number }} (the network token number / TPAN), {{ type }}, {{ scheme_reference }}, {{ network_token_id }}, and {{ network_token_type }}. Append | unwrap to emit a value as its native type instead of a string, e.g. {{ expiry_month | unwrap }}. See Network Tokens for the full placeholder list.

Response

Success response

The response from the third-party provider.