Create a verified cardOnFile token by sending a request to cardOnFile resource. A cardOnFile verified token allows you to take payments that are made by the customer using a stored verified token, such as in one-click or in-app purchases.
Verified Tokens (v3)
Verified Tokens ensures that your customer's payment details are valid and CIT compliant when creating a token.
Authentication header
Authorization: {your_credentials}Replace {your_credentials} with your base64-encoded Basic Auth username and password given to you by your Implementation Manager.
You must use the Authorization header for any request you send to our Verified Tokens API.
Accept header
Accept: application/vnd.worldpay.verified-tokens-v3.hal+jsonWe use the Accept header to identify which version of our API you are using. You must use the Accept header for any request you send to our Verified Tokens API.
DNS whitelisting
Whitelist the following URLs:
https://try.access.worldpay-bsh.securedataplatform.com/https://access.worldpay-bsh.securedataplatform.com/
Please ensure you use DNS whitelisting, not explicit IP whitelisting. When you make a request within Access Worldpay, you should always cache the response returned.
Download OpenAPI description
Languages
Servers
Test (Try)
https://try.access.worldpay-bsh.securedataplatform.com
Live
https://access.worldpay-bsh.securedataplatform.com
Bodyapplication/vnd.worldpay.verified-tokens-v3.hal+json
An object that contains the card details or token location.
- Test (Try)https://try.access.worldpay-bsh.securedataplatform.com/verifiedTokens/cardOnFile
- Livehttps://access.worldpay-bsh.securedataplatform.com/verifiedTokens/cardOnFile
- Payload
- curl
- Python
- Java
- Node.js
- Go
- PHP
- Ruby
- C#
application/vnd.worldpay.verified-tokens-v3.hal+json
- Creating a new token for cardOnFile transactions when supplying all the payment instrument details.
- Matching an existing token for cardOnFile transactions when supplying all the payment instrument details.
- Conflicting with an existing token for cardOnFile transactions when supplying all the payment instrument details.
- Payload cannot be verified for cardOnFile transactions when supplying all the payment instrument details. An unverified token has been created.
- Payload cannot be verified for cardOnFile transactions when supplying all the payment instrument details. An unverified token has been matched.
- Payload cannot be verified for cardOnFile transactions when supplying all the payment instrument details. An unverified token with conflicts has been returned.
- Creating a new token for cardOnFile transactions using a verified token or card session created by the access checkout SDK.
- Matching a token for cardOnFile transactions using a verified token or card session created by the access checkout SDK.
- Conflicts with an existing token for cardOnFile transactions using a verified token or card session created by the access checkout SDK.
- Payload cannot be verified for cardOnFile transactions using a verified token or card session created by the access checkout SDK. An unverified token has been created.
- Payload cannot be verified for cardOnFile transactions using a verified token or card session created by the access checkout SDK. An unverified token has been matched.
- Payload cannot be verified for cardOnFile transactions using a verified token or card session created by the access checkout SDK. An unverified token with conflicts has been returned.
Creating a new token for cardOnFile transactions when supplying all the payment instrument details.
{ "description": "Token-Description", "paymentInstrument": { "type": "card/plain", "cardHolderName": "SherlockHolmes", "cardNumber": "4444333322221111", "cardExpiryDate": { "month": 5, "year": 2035 }, "cvc": "123", "billingAddress": { "address1": "221BBakerStreet", "address2": "Marylebone", "address3": "Westminster", "postalCode": "NW16XE", "city": "London", "state": "GreaterLondon", "countryCode": "GB" } }, "narrative": { "line1": "TheMindPalaceLtd", "line2": "Memory265-13-08-1876" }, "merchant": { "entity": "default" }, "verificationCurrency": "GBP", "namespace": "SHOPPER_ID_1234567890" }
Response
application/vnd.worldpay.verified-tokens-v3.hal+json
- Matching an existing token for cardOnFile transactions when supplying all the payment instrument details.
- Matching a token for cardOnFile transactions using a verified token or card session created by the access checkout SDK.
Matching an existing token for cardOnFile transactions when supplying all the payment instrument details.
{ "_embedded": { "verification": { "outcome": "verified", "schemeTransactionReference": "000000000000020005060720116005060", "checkedAt": "2020-08-18T14:29:10.641180Z", "riskFactors": [ { "risk": "matched", "type": "cvc" }, { "risk": "matched", "detail": "postcode", "type": "avs" }, { "risk": "matched", "detail": "address", "type": "avs" } ], "paymentInstrument": { "type": "card/plain", "card": { "number": { "bin": "4444", "last4Digits": "1236" }, "issuer": { "name": "UNKNOWN" }, "expiryDate": { "month": 5, "year": 2035 }, "brand": "visa", "fundingType": "debit", "paymentAccountReference": "reference" } }, "_links": { "verifications:verification": { "href": "https://try.access.worldpay-bsh.securedataplatform.com/verifications/accounts/{resource}" }, "payments:cardOnFileAuthorize": { "href": "https://try.access.worldpay-bsh.securedataplatform.com/payments/authorizations/cardOnFile/eyJrIjoia2FhYzM1ZiIsImxpbmtWZXJzaW9uIjoiMS4wLjAifQ==.rTSaWnvtqTfgLUF9d+yia:Xr:bMt7SfZl7sgZ0yFtqVrp79hk:hZjQ1rHNZUtukWvMHHnIhvkyp4QhRO0aAcDdOsiNkkSoq+It1ADfLty7k=" }, "payments:recurringAuthorize": { "href": "https://try.access.worldpay-bsh.securedataplatform.com/payments/authorizations/recurring/eyJrIjoia2FhYzM1ZiIsImxpbmtWZXJzaW9uIjoiMS4wLjAifQ==.rTSaWnvtqTfgLUF9d+yia:Xr:bMt7SfZl7sgZ0yFtqVrp79hk:hZjQ1rHNZUtukWvMHHnIhvkyp4QhRO0aAcDdOsiNkkSoq+It1ADfLty7k=" }, "payments:recurringSale": { "href": "https://try.access.worldpay-bsh.securedataplatform.com/payments/sales/recurring/eyJrIjoia2FhYzM1ZiIsImxpbmtWZXJzaW9uIjoiMS4wLjAifQ==.rTSaWnvtqTfgLUF9d+yia:Xr:bMt7SfZl7sgZ0yFtqVrp79hk:hZjQ1rHNZUtukWvMHHnIhvkyp4QhRO0aAcDdOsiNkkSoq+It1ADfLty7k=" }, "curies": [ { "href": "https://try.access.worldpay-bsh.securedataplatform.com/rels/verifications/accounts/{rel}", "name": "verifications", "templated": true } ] } }, "token": { "tokenId": "9902480679618049603", "description": "TestTokenDescription", "tokenExpiryDateTime": "2021-08-18T14:30:40Z", "schemeTransactionReference": "000000000000020005060720116005060", "tokenPaymentInstrument": { "type": "card/tokenized", "href": "https://try.access.worldpay-bsh.securedataplatform.com/tokens/eyJrIjoxLCJkIjoialRBL0FFelBzcnZpNCtzRGNRemh0NzI0NE1rdUtjMUFJdjYxVnlibWZuUT0ifQ" }, "paymentInstrument": { "type": "card/masked", "cardNumber": "4444********1111", "cardHolderName": "SherlockHolmes", "cardExpiryDate": { "month": 5, "year": 2035 }, "billingAddress": { "address1": "221BBakerStreet", "address2": "Marylebone", "address3": "Westminster", "postalCode": "NW16XE", "city": "London", "state": "GreaterLondon", "countryCode": "GB" }, "bin": "444433", "brand": "VISA" }, "_links": { "tokens:token": { "href": "https://try.access.worldpay-bsh.securedataplatform.com/tokens/eyJrIjoxLCJkIjoialRBL0FFelBzcnZpNCtzRGNRemh0NzI0NE1rdUtjMUFJdjYxVnlibWZuUT0ifQ" }, "tokens:description": { "href": "https://try.access.worldpay-bsh.securedataplatform.com/tokens/eyJrIjoxLCJkIjoialRBL0FFelBzcnZpNCtzRGNRemh0MWJVbkh1WTFGZExUNXJxc04va1ZoTFVzYW1OU1lxSFE2NHI1c2JkY1pWaSJ9" }, "tokens:cardHolderName": { "href": "https://try.access.worldpay-bsh.securedataplatform.com/tokens/eyJrIjoxLCJkIjoialRBL0FFelBzcnZpNCtzRGNRemh0d3ltd21ieGo3TlZLYzRYSkExOUhSdUpLN2N3VVc5WUk3czRUTW1RQ2JLdjFnVXlzakdPSXdWWkRhZkZyUmlMd3c9PSJ9" }, "tokens:cardExpiryDate": { "href": "https://try.access.worldpay-bsh.securedataplatform.com/tokens/eyJrIjoxLCJkIjoialRBL0FFelBzcnZpNCtzRGNRemh0d3ltd21ieGo3TlZLYzRYSkExOUhSdUpLN2N3VVc5WUk3czRUTW1RQ2JLdkVpVW5GNnBsZThNTXNQWTRGbzFzTXc9PSJ9" }, "tokens:billingAddress": { "href": "https://try.access.worldpay-bsh.securedataplatform.com/tokens/eyJrIjoxLCJkIjoialRBL0FFelBzcnZpNCtzRGNRemh0d3ltd21ieGo3TlZLYzRYSkExOUhSdFpSdXFxbWZlNVl1TkpHZEVvZXN3MTlCU0lmdCtxSTUyVDJSdXlmSTIwM3c9PSJ9" }, "tokens:schemeTransactionReference": { "href": "https://try.access.worldpay-bsh.securedataplatform.com/tokens/eyJrIjoxLCJkIjoiSENXWFZQZjNIZ1V3dnpDMElJZS9Zdmc4M0pYM3dDWEJTVnQrWVlacXdDUXFFKzhzaC8xNSs2d3NkTTdFWUFNVU9tdXBmUlZGeVNDY2dPMkhKV2NIcGc9PSJ9" }, "curies": [ { "href": "https://try.access.worldpay-bsh.securedataplatform.com/rels/tokens/{rel}.json", "name": "tokens", "templated": true } ] } } } }
Request
Create a verified oneTime token by sending a request to oneTime resource. A oneTime verified token allows you to take payments that are made by the customer using a stored verified token, such as in one-click or in-app purchases.
Security
BasicAuth
An object that contains the card details or token location.
- Test (Try)https://try.access.worldpay-bsh.securedataplatform.com/verifiedTokens/oneTime
- Livehttps://access.worldpay-bsh.securedataplatform.com/verifiedTokens/oneTime
- Payload
- curl
- Python
- Java
- Node.js
- Go
- PHP
- Ruby
- C#
application/vnd.worldpay.verified-tokens-v3.hal+json
- Creating a new token for oneTime transactions when supplying all the payment instrument details.
- Matching an existing token for oneTime transactions when supplying all the payment instrument details.
- Conflicting with an existing token for oneTime transactions when supplying all the payment instrument details.
- Payload cannot be verified for oneTime transactions when supplying all the payment instrument details. An unverified token has been created.
- Payload cannot be verified for oneTime transactions when supplying all the payment instrument details. An unverified token has been matched.
- Payload cannot be verified for oneTime transactions when supplying all the payment instrument details. An unverified token with conflicts has been returned.
- Creating a new token for oneTime transactions using a verified token or card session created by the access checkout SDK.
- Matching a token for oneTime transactions using a verified token or card session created by the access checkout SDK.
- Conflicts with an existing token for oneTime transactions using a verified token or card session created by the access checkout SDK.
- Payload cannot be verified for oneTime transactions using a verified token or card session created by the access checkout SDK. An unverified token has been created.
- Payload cannot be verified for oneTime transactions using a verified token or card session created by the access checkout SDK. An unverified token has been matched.
- Payload cannot be verified for oneTime transactions using a verified token or card session created by the access checkout SDK. An unverified token with conflicts has been returned.
Creating a new token for oneTime transactions when supplying all the payment instrument details.
{ "description": "Token-Description", "paymentInstrument": { "type": "card/plain", "cardHolderName": "SherlockHolmes", "cardNumber": "4444333322221111", "cardExpiryDate": { "month": 5, "year": 2035 }, "cvc": "123", "billingAddress": { "address1": "221BBakerStreet", "address2": "Marylebone", "address3": "Westminster", "postalCode": "NW16XE", "city": "London", "state": "GreaterLondon", "countryCode": "GB" } }, "narrative": { "line1": "TheMindPalaceLtd", "line2": "Memory265-13-08-1876" }, "merchant": { "entity": "default" }, "verificationCurrency": "GBP", "namespace": "SHOPPER_ID_1234567890" }
Response
application/vnd.worldpay.verified-tokens-v3.hal+json
- Matching an existing token for oneTime transactions when supplying all the payment instrument details.
- Matching a token for oneTime transactions using a verified token or card session created by the access checkout SDK.
Matching an existing token for oneTime transactions when supplying all the payment instrument details.
{ "_embedded": { "verification": { "outcome": "verified", "checkedAt": "2020-08-18T14:29:10.641180Z", "riskFactors": [ { "risk": "matched", "type": "cvc" }, { "risk": "matched", "detail": "postcode", "type": "avs" }, { "risk": "matched", "detail": "address", "type": "avs" } ], "paymentInstrument": { "type": "card/plain", "card": { "number": { "bin": "4444", "last4Digits": "1236" }, "issuer": { "name": "UNKNOWN" }, "expiryDate": { "month": 5, "year": 2035 }, "brand": "visa", "fundingType": "debit", "paymentAccountReference": "reference" } }, "_links": { "verifications:verification": { "href": "https://try.access.worldpay-bsh.securedataplatform.com/verifications/accounts/{resource}" }, "curies": [ { "href": "https://try.access.worldpay-bsh.securedataplatform.com/rels/verifications/accounts/{rel}", "name": "verifications", "templated": true } ] } }, "token": { "tokenId": "9902480679618049603", "description": "TestTokenDescription", "tokenExpiryDateTime": "2021-08-18T14:30:40Z", "tokenPaymentInstrument": { "type": "card/tokenized", "href": "https://try.access.worldpay-bsh.securedataplatform.com/tokens/eyJrIjoxLCJkIjoialRBL0FFelBzcnZpNCtzRGNRemh0NzI0NE1rdUtjMUFJdjYxVnlibWZuUT0ifQ" }, "paymentInstrument": { "type": "card/masked", "cardNumber": "4444********1111", "cardHolderName": "SherlockHolmes", "cardExpiryDate": { "month": 5, "year": 2035 }, "billingAddress": { "address1": "221BBakerStreet", "address2": "Marylebone", "address3": "Westminster", "postalCode": "NW16XE", "city": "London", "state": "GreaterLondon", "countryCode": "GB" }, "bin": "444433", "brand": "VISA" }, "_links": { "tokens:token": { "href": "https://try.access.worldpay-bsh.securedataplatform.com/tokens/eyJrIjoxLCJkIjoialRBL0FFelBzcnZpNCtzRGNRemh0NzI0NE1rdUtjMUFJdjYxVnlibWZuUT0ifQ" }, "tokens:description": { "href": "https://try.access.worldpay-bsh.securedataplatform.com/tokens/eyJrIjoxLCJkIjoialRBL0FFelBzcnZpNCtzRGNRemh0MWJVbkh1WTFGZExUNXJxc04va1ZoTFVzYW1OU1lxSFE2NHI1c2JkY1pWaSJ9" }, "tokens:cardHolderName": { "href": "https://try.access.worldpay-bsh.securedataplatform.com/tokens/eyJrIjoxLCJkIjoialRBL0FFelBzcnZpNCtzRGNRemh0d3ltd21ieGo3TlZLYzRYSkExOUhSdUpLN2N3VVc5WUk3czRUTW1RQ2JLdjFnVXlzakdPSXdWWkRhZkZyUmlMd3c9PSJ9" }, "tokens:cardExpiryDate": { "href": "https://try.access.worldpay-bsh.securedataplatform.com/tokens/eyJrIjoxLCJkIjoialRBL0FFelBzcnZpNCtzRGNRemh0d3ltd21ieGo3TlZLYzRYSkExOUhSdUpLN2N3VVc5WUk3czRUTW1RQ2JLdkVpVW5GNnBsZThNTXNQWTRGbzFzTXc9PSJ9" }, "tokens:billingAddress": { "href": "https://try.access.worldpay-bsh.securedataplatform.com/tokens/eyJrIjoxLCJkIjoialRBL0FFelBzcnZpNCtzRGNRemh0d3ltd21ieGo3TlZLYzRYSkExOUhSdFpSdXFxbWZlNVl1TkpHZEVvZXN3MTlCU0lmdCtxSTUyVDJSdXlmSTIwM3c9PSJ9" }, "tokens:schemeTransactionReference": { "href": "https://try.access.worldpay-bsh.securedataplatform.com/tokens/eyJrIjoxLCJkIjoiSENXWFZQZjNIZ1V3dnpDMElJZS9Zdmc4M0pYM3dDWEJTVnQrWVlacXdDUXFFKzhzaC8xNSs2d3NkTTdFWUFNVU9tdXBmUlZGeVNDY2dPMkhKV2NIcGc9PSJ9" }, "curies": [ { "href": "https://try.access.worldpay-bsh.securedataplatform.com/rels/tokens/{rel}.json", "name": "tokens", "templated": true } ] } } } }