- Home
- All APIs
- Access Worldpay
- SCA Exemptions API
- SCA Exemptions
SCA Exemptions
Make yourself familiar with our
Set your headers
Setting your headers is an important part of an API request. The headers represent the meta-data associated with your API request.
Authorization: {your_credentials}
Content-Type: application/vnd.worldpay.exemptions-v1.hal+json
Accept: application/vnd.worldpay.exemptions-v1.hal+json
Authorization: {your_credentials} Content-Type: application/vnd.worldpay.exemptions-v1.hal+json Accept: application/vnd.worldpay.exemptions-v1.hal+json
Header | Description |
---|---|
Authorization | We use the Authorization header to identify and authenticate you within Access Worldpay.. You must use the Authorization header for any request you send to our Exemptions API, unless you are using client certificate authentication over TLS. If you must use this, read our reference guide on |
Content-Type | We require the Content-Type header if the request you're sending includes a request body, and if the HTTP method is a POST or a PUT . |
Accept | We use the Accept header to identify which version of our Exemptions API you are using. You must use the Accept header for any request you send to our Exemptions API. |
If you're using both the Content-Type
and Accept
headers, they must match.
Note: Replace {your_credentials}
with your base64-encoded Basic Auth username and password. To get your Access Worldpay credentials contact your Implementation Manager.
Query the root resource
Our APIs guide you by providing you with links to the next available actions.
To discover and start using our APIs you must first query the root resource. This returns the available resources within Access Worldpay.
Request
GET https://try.access.worldpay.com/
Note: No request body is needed for this request.
Response
You receive all our available API resources in the response.
{
"_links": {
"payments:authorize": {
"href": "https://try.access.worldpay.com/payments/authorizations"
},
"service:payments": {
"href": "https://try.access.worldpay.com/payments"
},
"service:sessions": {
"href": "https://try.access.worldpay.com/sessions"
},
"service:tokens": {
"href": "https://try.access.worldpay.com/tokens"
},
"service:verifications/accounts": {
"href": "https://try.access.worldpay.com/verifications/accounts"
},
"service:verifications/customers/3ds": {
"href": "https://try.access.worldpay.com/verifications/customers/3ds"
},
"service:verifiedTokens": {
"href": "https://try.access.worldpay.com/verifiedTokens"
},
"service:fraudsight": {
"href": "https://try.access.worldpay.com/fraudsight"
},
"service:exemptions": {
"href": "https://try.access.worldpay.com/exemptions"
},
"service:payouts": {
"href": "https://try.access.worldpay.com/payouts"
},
"service:payments/alternative/direct": {
"href": "https://try.access.worldpay.com/payments/alternative/direct"
},
"service:payments/alternative/action/paypal": {
"href": "https://try.access.worldpay.com/payments/alternative/action/paypal"
},
"service:payments/alternative/action/ideal": {
"href": "https://try.access.worldpay.com/payments/alternative/action/ideal"
},
"service:payouts/accounts": {
"href": "https://try.access.worldpay.com/payouts/accounts"
},
"service:payouts/events": {
"href": "https://try.access.worldpay.com/payouts/events"
},
"service:moneyTransfers": {
"href": "https://try.access.worldpay.com/moneyTransfers"
},
"service:foreignExchange": {
"href": "https://try.access.worldpay.com/foreignExchange"
},
"service:accounts/statements": {
"href": "https://try.access.worldpay.com/accounts/statements"
},
"service:accounts/balance": {
"href": "https://try.access.worldpay.com/accounts/balance"
},
"service:accounts/transfer": {
"href": "https://try.access.worldpay.com/accounts/transfer"
},
"curies": [
{
"href": "https://try.access.worldpay.com/rels/payments/{rel}",
"name": "payments",
"templated": true
}
]
}
}
When integrating into Access Worldpay, we strongly recommend that you get the URI resource links from the action links. Do not hard code the URI resource links, they could change and break your integration.
What is an action link?
An action link is a parameter where the URI link to the resource is stored.
What is a URI resource link?
A URI resource link is the link to the resource you send your requests to.
Query the Exemptions root resource
Query the service:exemptions
action link for the Exemptions root resource.
Request
GET https://try.access.worldpay.com/exemptions
Note: No request body is needed for this request.
The response
{
"_links": {
"resourceTree": {
"href": "https://try.access.worldpay.com/exemptions/resourceTree"
},
"exemptions:assess": {
"href": "https://try.access.worldpay.com/exemptions/assessment"
},
"curies": [
{
"href": "https://try.access.worldpay.com/rels/exemptions/{rel}",
"templated": true,
"name": "exemptions"
}
]
}
}
Resources
The response contains a link for the Exemptions assessment request:
Action Link (resources) | Description |
---|---|
exemptions:assess | Exemptions assessment request |
DNS Whitelisting
Whitelist the following URLs:
https://try.access.worldpay.com/
https://access.worldpay.com/
Please ensure you use DNS whitelisting not explicit IP whitelisting.
We recommend that you use DNS whitelisting over explicit IP whitelisting.
Link Caching
When you make a request within Access Worldpay, you should always cache the response returned.
Next steps