Retrieve
Verification resource retrieval.
GET
Retrieve One Time verification details
Responses
Response schema
Copied!
{
"type": "object",
"properties": {
"outcome": {
"type": "string"
},
"checkedAt": {
"type": "string"
},
"riskFactors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"risk": {
"type": "string"
},
"detail": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"risk",
"type"
]
}
},
"paymentInstrument": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"card": {
"type": "object",
"properties": {
"number": {
"type": "object",
"properties": {
"bin": {
"type": "string"
},
"last4Digits": {
"type": "string"
}
},
"required": [
"bin",
"last4Digits"
]
},
"countryCode": {
"type": "string"
},
"expiryDate": {
"type": "object",
"properties": {
"month": {
"type": "integer"
},
"year": {
"type": "integer"
}
},
"required": [
"month",
"year"
]
},
"brand": {
"type": "string"
},
"fundingType": {
"type": "string"
},
"issuer": {
"type": "object",
"properties": {
"name": {
"type": "string"
}
},
"required": [
"name"
]
},
"category": {
"type": "string"
},
"paymentAccountReference": {
"type": "string"
}
},
"required": []
}
},
"required": [
"type"
]
},
"_links": {
"type": "object",
"properties": {
"verifications:verification": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
},
"required": [
"href"
]
},
"curies": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"href": {
"type": "string"
},
"templated": {
"type": "boolean"
}
},
"required": [
"name",
"href",
"templated"
]
}
}
},
"required": [
"verifications:verification",
"curies"
]
}
},
"required": [
"outcome",
"checkedAt",
"_links"
]
}{ "type": "object", "properties": { "outcome": { "type": "string" }, "checkedAt": { "type": "string" }, "riskFactors": { "type": "array", "items": { "type": "object", "properties": { "risk": { "type": "string" }, "detail": { "type": "string" }, "type": { "type": "string" } }, "required": [ "risk", "type" ] } }, "paymentInstrument": { "type": "object", "properties": { "type": { "type": "string" }, "card": { "type": "object", "properties": { "number": { "type": "object", "properties": { "bin": { "type": "string" }, "last4Digits": { "type": "string" } }, "required": [ "bin", "last4Digits" ] }, "countryCode": { "type": "string" }, "expiryDate": { "type": "object", "properties": { "month": { "type": "integer" }, "year": { "type": "integer" } }, "required": [ "month", "year" ] }, "brand": { "type": "string" }, "fundingType": { "type": "string" }, "issuer": { "type": "object", "properties": { "name": { "type": "string" } }, "required": [ "name" ] }, "category": { "type": "string" }, "paymentAccountReference": { "type": "string" } }, "required": [] } }, "required": [ "type" ] }, "_links": { "type": "object", "properties": { "verifications:verification": { "type": "object", "properties": { "href": { "type": "string" } }, "required": [ "href" ] }, "curies": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "href": { "type": "string" }, "templated": { "type": "boolean" } }, "required": [ "name", "href", "templated" ] } } }, "required": [ "verifications:verification", "curies" ] } }, "required": [ "outcome", "checkedAt", "_links" ] }
GET
Retrieve Card On File verification details
Responses
Response schema
Copied!
{
"type": "object",
"properties": {
"outcome": {
"type": "string"
},
"schemeTransactionReference": {
"type": "string"
},
"checkedAt": {
"type": "string"
},
"riskFactors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"risk": {
"type": "string"
},
"detail": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"risk",
"type"
]
}
},
"paymentInstrument": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"card": {
"type": "object",
"properties": {
"number": {
"type": "object",
"properties": {
"bin": {
"type": "string"
},
"last4Digits": {
"type": "string"
}
},
"required": [
"bin",
"last4Digits"
]
},
"countryCode": {
"type": "string"
},
"expiryDate": {
"type": "object",
"properties": {
"month": {
"type": "integer"
},
"year": {
"type": "integer"
}
},
"required": [
"month",
"year"
]
},
"brand": {
"type": "string"
},
"fundingType": {
"type": "string"
},
"issuer": {
"type": "object",
"properties": {
"name": {
"type": "string"
}
},
"required": [
"name"
]
},
"category": {
"type": "string"
},
"paymentAccountReference": {
"type": "string"
}
},
"required": []
}
},
"required": [
"type"
]
},
"_links": {
"type": "object",
"properties": {
"verifications:verification": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
},
"required": [
"href"
]
},
"payments:cardOnFileAuthorize": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
},
"required": [
"href"
]
},
"payments:recurringAuthorize": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
},
"required": [
"href"
]
},
"payments:recurringSale": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
},
"required": [
"href"
]
},
"curies": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"href": {
"type": "string"
},
"templated": {
"type": "boolean"
}
},
"required": [
"name",
"href",
"templated"
]
}
}
},
"required": [
"verifications:verification",
"curies"
]
}
},
"required": [
"outcome",
"checkedAt",
"_links"
]
}{ "type": "object", "properties": { "outcome": { "type": "string" }, "schemeTransactionReference": { "type": "string" }, "checkedAt": { "type": "string" }, "riskFactors": { "type": "array", "items": { "type": "object", "properties": { "risk": { "type": "string" }, "detail": { "type": "string" }, "type": { "type": "string" } }, "required": [ "risk", "type" ] } }, "paymentInstrument": { "type": "object", "properties": { "type": { "type": "string" }, "card": { "type": "object", "properties": { "number": { "type": "object", "properties": { "bin": { "type": "string" }, "last4Digits": { "type": "string" } }, "required": [ "bin", "last4Digits" ] }, "countryCode": { "type": "string" }, "expiryDate": { "type": "object", "properties": { "month": { "type": "integer" }, "year": { "type": "integer" } }, "required": [ "month", "year" ] }, "brand": { "type": "string" }, "fundingType": { "type": "string" }, "issuer": { "type": "object", "properties": { "name": { "type": "string" } }, "required": [ "name" ] }, "category": { "type": "string" }, "paymentAccountReference": { "type": "string" } }, "required": [] } }, "required": [ "type" ] }, "_links": { "type": "object", "properties": { "verifications:verification": { "type": "object", "properties": { "href": { "type": "string" } }, "required": [ "href" ] }, "payments:cardOnFileAuthorize": { "type": "object", "properties": { "href": { "type": "string" } }, "required": [ "href" ] }, "payments:recurringAuthorize": { "type": "object", "properties": { "href": { "type": "string" } }, "required": [ "href" ] }, "payments:recurringSale": { "type": "object", "properties": { "href": { "type": "string" } }, "required": [ "href" ] }, "curies": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "href": { "type": "string" }, "templated": { "type": "boolean" } }, "required": [ "name", "href", "templated" ] } } }, "required": [ "verifications:verification", "curies" ] } }, "required": [ "outcome", "checkedAt", "_links" ] }
Link relationship
verifications:verificationQuery a verification.
Retrieval of a successful verification
GEThttps://try.access.worldpay.com/rels/verifications/accounts/verification
Copied!
{
"Authorization": "Basic Auth",
"Accept": "application/vnd.worldpay.verifications.accounts-v5+json"
}{ "Authorization": "Basic Auth", "Accept": "application/vnd.worldpay.verifications.accounts-v5+json" }
200
Copied!
{
"outcome": "verified",
"checkedAt": "2018-09-01T10:37:36.923Z",
"riskFactors": [
{
"risk": "matched",
"type": "cvc"
},
{
"risk": "matched",
"detail": "postcode",
"type": "avs"
},
{
"risk": "matched",
"detail": "address",
"type": "avs"
}
],
"paymentInstrument": {
"type": "card/plain",
"card": {
"number": {
"bin": "444433",
"last4Digits": "1111"
},
"countryCode": "GB",
"expiryDate": {
"month": 12,
"year": 2029
},
"brand": "visa",
"fundingType": "debit",
"issuer": {
"name": "cardIssuer"
},
"category": "consumer",
"paymentAccountReference": "reference"
}
},
"_links": {
"verifications:verification": {
"href": "https://try.access.worldpay.com/verifications/accounts/{resource}"
},
"curies": [
{
"name": "verifications",
"href": "https://try.access.worldpay.com/rels/verifications/accounts/{rel}",
"templated": true
}
]
}
}{ "outcome": "verified", "checkedAt": "2018-09-01T10:37:36.923Z", "riskFactors": [ { "risk": "matched", "type": "cvc" }, { "risk": "matched", "detail": "postcode", "type": "avs" }, { "risk": "matched", "detail": "address", "type": "avs" } ], "paymentInstrument": { "type": "card/plain", "card": { "number": { "bin": "444433", "last4Digits": "1111" }, "countryCode": "GB", "expiryDate": { "month": 12, "year": 2029 }, "brand": "visa", "fundingType": "debit", "issuer": { "name": "cardIssuer" }, "category": "consumer", "paymentAccountReference": "reference" } }, "_links": { "verifications:verification": { "href": "https://try.access.worldpay.com/verifications/accounts/{resource}" }, "curies": [ { "name": "verifications", "href": "https://try.access.worldpay.com/rels/verifications/accounts/{rel}", "templated": true } ] } }
