Skip to main content
POST
/
api
/
pci
/
tokens
/
{id}
/
forward
curl --request POST \ --url https://{cluster_id}.on-hellgate.cloud/api/pci/tokens/{id}/forward \ --header 'Content-Type: application/json' \ --header 'x-api-key: <api-key>' \ --data ' { "transactionReference": "My reference", "instruction": { "method": "card", "paymentInstrument": { "type": "plain", "cardNumber": "{{ account_number }}", "expiryDate": { "month": "{{ expiry_month | unwrap }}", "year": "{{ expiry_year | unwrap }}" } } }, "value": { "currency": "EUR", "amount": 1000 } } '
{}

Authorizations

x-api-key
string
header
required

Headers

x-destination-url
string<uri>

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 token to forward.

Body

The payload the caller wants to forward to the third party provider.

To securely handle and inject sensitive cardholder data, predefined templates can be used. These templates help structure and standardize the data injection process while ensuring compliance with security and regulatory requirements.

Response

Success response

The response from the third party provider.