Wallet Tokens

Forward wallet token

Forward a request to a certified third-party provider with the wallet token’s card data injected server-side, so it never touches your systems. This mirrors Forward card data and Forward cryptogram.

The available placeholders depend on the token’s auth_method:

CRYPTOGRAM_3DS: {{ dpan }}, {{ cryptogram }}, {{ eci }}, {{ expiry_month }}, {{ expiry_year }}. The cryptogram is single-use — the token is consumed by the first successful forward.
PAN_ONLY: {{ fpan }}, {{ expiry_month }}, {{ expiry_year }}. Forwardable repeatedly.

Using a placeholder the token’s auth_method does not carry returns 422 with the classifier DESTINATION_POLICY_VIOLATION; a declared placeholder without a value on this specific token returns 422 with PLACEHOLDER_VALUE_MISSING. Forwarding an already-consumed CRYPTOGRAM_3DS token returns 400 with CRYPTOGRAM_CONSUMED.

See Wallet Tokens for details.

POST

api

wallet

{id}

forward

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

{}

{
  "code": 400,
  "message": "The request could not be handle due to invalid data",
  "classifier": "BAD_REQUEST"
}

{
  "code": 401,
  "message": "No valid means of authentication was provided",
  "classifier": "UNAUTHORIZED"
}

{
  "code": 403,
  "message": "Not allowed to access this resource or feature",
  "classifier": "FORBIDDEN"
}

{
  "code": 404,
  "message": "The requested resource was not found.",
  "classifier": "NOT_FOUND"
}

{
  "code": 422,
  "classifier": "VALIDATION_ERROR",
  "message": "Validation error",
  "validation_errors": [
    {
      "path": "json-path",
      "message": "human readable error message"
    }
  ]
}

{
  "code": 502,
  "message": "Bad gateway",
  "classifier": "BAD_GATEWAY"
}

{
  "code": 503,
  "message": "Service unavailable",
  "classifier": "SERVICE_UNAVAILABLE"
}

{
  "code": 504,
  "message": "Gateway timeout",
  "classifier": "GATEWAY_TIMEOUT"
}

Authorizations

x-api-key

string

header

required

Headers

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

string<uuid>

required

The ID of the wallet token to forward.

Body

application/json

The payload to forward to the third-party provider.

Use placeholders to inject the wallet token's card data on the fly. Append | unwrap to emit a value as its native type instead of a string, e.g. {{ expiry_month | unwrap }}.

Response

Success response

The response from the third-party provider.

Create tokenCreate a new token in the generic scope. This type of token can be used for various use cases that do not involve sensitive card payment credentials.

⌘I

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

{}

{
  "code": 400,
  "message": "The request could not be handle due to invalid data",
  "classifier": "BAD_REQUEST"
}

{
  "code": 401,
  "message": "No valid means of authentication was provided",
  "classifier": "UNAUTHORIZED"
}

{
  "code": 403,
  "message": "Not allowed to access this resource or feature",
  "classifier": "FORBIDDEN"
}

{
  "code": 404,
  "message": "The requested resource was not found.",
  "classifier": "NOT_FOUND"
}

{
  "code": 422,
  "classifier": "VALIDATION_ERROR",
  "message": "Validation error",
  "validation_errors": [
    {
      "path": "json-path",
      "message": "human readable error message"
    }
  ]
}

{
  "code": 502,
  "message": "Bad gateway",
  "classifier": "BAD_GATEWAY"
}

{
  "code": 503,
  "message": "Service unavailable",
  "classifier": "SERVICE_UNAVAILABLE"
}

{
  "code": 504,
  "message": "Gateway timeout",
  "classifier": "GATEWAY_TIMEOUT"
}