Skip to content
APIs/Delegate Tokens API/Delegate payment/
Create a delegated paymen...

Delegate Tokens API (2025-09-29)

Delegate a payment using a provided payment method and allowance.

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
Test (Try)
https://try.access.worldpay.com/
Live
https://access.worldpay.com/

Delegate payment

Create delegated payment tokens

Operations

Create a delegated payment tokenPreview

Request

Tokenizes a credential for controlled usage by the merchant's PSP per the Allowance constraints. Exactly one credential type is currently supported: card.

Security
bearerAuth
Headers
Authorizationstringrequired
Example: Bearer api_key_123
Content-Typestringrequired
Example: application/json
Accept-Languagestring
Example: en-us
User-Agentstring
Example: ChatGPT/2.0
Idempotency-Keystring
Example: idem_abc123
Request-Idstring
Example: req_123
Signaturestring
Example: ZXltZX...
Timestampstring(date-time)
Example: 2025-09-29T10:30:00Z
API-Versionstringrequired
Example: 2025-09-29
Bodyapplication/jsonrequired
payment_methodobjectrequired
typestringrequired
Value"card"
card_number_typestringrequired
Enum"fpan""network_token"
numberstringrequired

network token or fallback fpan value

exp_monthstring<= 2 characters
exp_yearstring<= 4 characters
namestring
cvcstring<= 4 characters
cryptogramstring
eci_valuestring<= 2 characters
checks_performedArray of strings
Items Enum"avs""cvv""ani""auth0"
iinstring<= 6 characters
display_card_funding_typestringrequired
Enum"credit""debit""prepaid"
display_wallet_typestring
display_brandstring
display_last4string<= 4 characters
metadataobjectrequired
allowanceobjectrequired
reasonstringrequired
Value"one_time"
max_amountintegerrequired

Minor units (e.g., $20 → 2000)

currencystring^[a-z]{3}$required

ISO-4217 lowercase (e.g., usd)

checkout_session_idstringrequired
merchant_idstring<= 256 charactersrequired
expires_atstring(date-time)required
billing_addressobject
namestring<= 256 charactersrequired
line_onestring<= 60 charactersrequired
line_twostring<= 60 characters
citystring<= 60 charactersrequired
statestringrequired
countrystring= 2 charactersrequired

ISO-3166-1 alpha-2

postal_codestring<= 20 charactersrequired
risk_signalsArray of objectsnon-emptyrequired
typestringrequired
Value"card_testing"
scoreintegerrequired
actionstringrequired
Enum"blocked""manual_review""authorized"
metadataobjectrequired
property name*stringadditional property
application/json
{
  "payment_method": {
    "type": "card",
    "card_number_type": "fpan",
    "number": "4242424242424242",
    "exp_month": "11",
    "exp_year": "2026",
    "name": "Jane Doe",
    "cvc": "223",
    "checks_performed": [
      "avs",
      "cvv"
    ],
    "iin": "424242",
    "display_card_funding_type": "credit",
    "display_brand": "visa",
    "display_last4": "4242",
    "metadata": {
      "issuing_bank": "temp"
    }
  },
  "allowance": {
    "reason": "one_time",
    "max_amount": 2000,
    "currency": "usd",
    "checkout_session_id": "csn_01HV3P3...",
    "merchant_id": "acme",
    "expires_at": "2025-10-09T07:20:50.52Z"
  },
  "billing_address": {
    "name": "John Doe",
    "line_one": "123 Fake St.",
    "line_two": "Unit 1",
    "city": "San Francisco",
    "state": "CA",
    "country": "US",
    "postal_code": "12345"
  },
  "risk_signals": [
    {
      "type": "card_testing",
      "score": 10,
      "action": "manual_review"
    }
  ],
  "metadata": {
    "campaign": "q4"
  }
}

Responses

Created

Headers
Request-Idstring

Echo of the request correlation ID

Bodyapplication/json
idstringrequired

Unique vault token identifier (vt_...)

createdstring(date-time)required
metadataobjectrequired
property name*stringadditional property
Response
application/json
{
  "id": "vt_01J8Z3W4YZ9ABC",
  "created": "2025-09-29T11:00:00Z",
  "metadata": {
    "source": "agent_checkout",
    "merchant_id": "acme",
    "idempotency_key": "idem_abc123"
  }
}