openapi: 3.0.1 info: title: Verifications description: TBD. version: '2' servers: - url: https://try.access.worldpay.com description: testing (try) - url: https://access.worldpay.com description: live paths: /verifications: get: tags: - Root summary: Retrieve the Verified tokens top-level collection resource. description: |+ Retrieve the Verified tokens top-level collection resource. operationId: Verifications responses: '200': description: Links to next available actions. content: application/vnd.worldpay.verifications.accounts-v2.hal+json: schema: $ref: '#/components/schemas/verifications_Verifications_200_response' examples: Retrieve the Verifications top-level collection resource.: description: Retrieve the Verifications top-level collection resource. value: _links: resourceTree: href: >- https://try.access.worldpay.com/rels/verifications/accounts/resourceTree verifications:oneTime: href: >- https://try.access.worldpay.com/verifications/accounts/oneTime templated: true verifications:cardOnFile: href: >- https://try.access.worldpay.com/verifications/accounts/cardOnFile templated: true verifications:verification: href: >- https://try.access.worldpay.com/verifications/accounts/{verification} templated: true curies: - name: verifications href: >- https://try.access.worldpay.com/rels/verifications/accounts/{rel} templated: true /verifications/accounts/verification: get: tags: - Verifications summary: Verification resource retrieval. description: |+ Retrieval of a successful verification. operationId: Verification responses: '200': description: Retrieval request successful content: application/vnd.worldpay.verifications.accounts-v2.hal+json: schema: $ref: '#/components/schemas/verifications_verification_200_response' examples: Retrieval of a successful verification: description: Retrieval of a successful verification value: outcome: verified checkedAt: '2018-09-01T10:37:36.923Z' _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 /verifications/accounts/intelligent/oneTime: post: tags: - Verification summary: Verifications oneTime resource. description: |+ Successful account verification outcome. operationId: OneTime requestBody: content: application/vnd.worldpay.verifications.accounts-v2.hal+json: schema: $ref: '#/components/schemas/verifications_oneTime' examples: Successful account verification outcome.: description: Successful account verification outcome. value: >- {"currency": "EUR","paymentInstrument": {"type": "card/plain","cardHolderName": "Joe Bloggs","cardExpiryDate": {"month": 1,"year": 2019},"cardNumber": "4444333322221111","verificationAddress": { "address1": "address1","address2": "address2","address3": "address3","postalCode": "postalCode","city": "city","state": "state","countryCode": "GB"},"cvc": "101"},"merchant": {"entity": "default"}} Refused account verification outcome.: description: Refused account verification outcome. value: >- {"currency": "EUR","paymentInstrument": {"type": "card/plain","cardHolderName": "Joe Bloggs","cardExpiryDate": {"month": 1,"year": 2019},"cardNumber": "4444333322221111","billingAddress": { "address1": "address1","address2": "address2","address3": "address3","postalCode": "postalCode","city": "city","state": "state","countryCode": "GB"},"cvc": "101"},"merchant": {"reference": "default"}} Successful dynamic MCC account verification outcome.: description: Successful dynamic MCC account verification outcome. value: >- {"currency": "EUR", "paymentInstrument": { "type": "card/plain", "cardHolderName": "Joe Bloggs", "cardExpiryDate": { "month": 1, "year": 2019 }, "cardNumber": "4444333322221111", "verificationAddress": { "address1": "address1", "address2": "address2", "address3": "address3", "postalCode": "postalCode", "city": "city", "state": "state", "countryCode": "GB" }, "cvc": "101" }, "merchant": { "entity": "default", "mcc":"6012" }} Successful payment facilitator account verification outcome.: description: Successful payment facilitator account verification outcome. value: >- {"currency": "EUR","paymentInstrument": {"type": "card/plain","cardHolderName": "Joe Bloggs","cardExpiryDate": {"month": 1,"year": 2019},"cardNumber": "4444333322221111","verificationAddress": {"address1": "address1","address2": "address2","address3": "address3","postalCode": "postalCode","city": "city","state": "state","countryCode": "GB"},"cvc": "101"},"merchant": {"entity": "default","paymentFacilitator": {"pfId": "12345678901","subMerchant": {"merchantId": "123456789012345","name": "Example Shop","street": "123 Street","state": "CA","city": "San Francisco","countryCode": "840","postalCode": "94101","taxId": "987-65-4321"}}}} responses: '201': description: The account verification has been successful. content: application/vnd.worldpay.verifications.accounts-v2.hal+json: schema: $ref: '#/components/schemas/verifications_oneTime_201_response' examples: Successful account verification outcome.: description: Successful account verification outcome. value: outcome: verified checkedAt: '2018-09-01T10:37:36.923Z' _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 Refused account verification outcome.: description: Refused account verification outcome. value: outcome: not verified code: '76' rawCode: N7 description: CARD BLOCKED checkedAt: '2019-11-28T12:02:49.572137Z' _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 Successful dynamic MCC account verification outcome.: description: Successful dynamic MCC account verification outcome. value: outcome: verified checkedAt: '2018-09-01T10:37:36.923Z' _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 Successful payment facilitator account verification outcome.: description: Successful payment facilitator account verification outcome. value: outcome: verified checkedAt: '2018-09-01T10:37:36.923Z' _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 /verifications/accounts/intelligent/cardOnFile: post: tags: - Verification summary: Verifications cardOnFile resource. description: |+ Successful account verification outcome. operationId: OneTime1 requestBody: content: application/vnd.worldpay.verifications.accounts-v2.hal+json: schema: $ref: '#/components/schemas/verifications_cardOnFile' examples: Successful account verification outcome.: description: Successful account verification outcome. value: >- {"currency": "EUR","paymentInstrument": { "type": "card/plain", "cardHolderName": "Joe Bloggs", "cardExpiryDate": { "month": 1, "year": 2019 }, "cardNumber": "4444333322221111", "verificationAddress": { "address1": "address1", "address2": "address2", "address3": "address3", "postalCode": "postalCode", "city": "city", "state": "state", "countryCode": "GB" }, "cvc": "101"},"merchant": { "entity": "default"}} Refused account verification outcome.: description: Refused account verification outcome. value: >- {"currency": "EUR","paymentInstrument": { "type": "card/plain", "cardHolderName": "Joe Bloggs", "cardExpiryDate": { "month": 1, "year": 2019 }, "cardNumber": "4444333322221111", "verificationAddress": { "address1": "address1", "address2": "address2", "address3": "address3", "postalCode": "postalCode", "city": "city", "state": "state", "countryCode": "GB" }, "cvc": "101"},"merchant": { "entity": "default"}} Successful Dynamic MCC account verification outcome.: description: Successful Dynamic MCC account verification outcome. value: >- {"currency": "EUR","paymentInstrument": { "type": "card/plain", "cardHolderName": "Joe Bloggs", "cardExpiryDate": { "month": 1, "year": 2019 }, "cardNumber": "4444333322221111", "verificationAddress": { "address1": "address1", "address2": "address2", "address3": "address3", "postalCode": "postalCode", "city": "city", "state": "state", "countryCode": "GB" }, "cvc": "101"},"merchant": { "entity": "default", "mcc":"6012"}} Successful account verification outcome without Payments links.: description: >- Successful account verification outcome without Payments links. value: >- {"currency": "EUR","paymentInstrument": { "type": "card/plain", "cardHolderName": "Joe Bloggs", "cardExpiryDate": { "month": 1, "year": 2019 }, "cardNumber": "4444333322221111", "verificationAddress": { "address1": "address1", "address2": "address2", "address3": "address3", "postalCode": "postalCode", "city": "city", "state": "state", "countryCode": "GB" }, "cvc": "101"},"merchant": { "entity": "default"}} Successful payment facilitator account verification outcome.: description: Successful payment facilitator account verification outcome. value: >- {"currency": "EUR","paymentInstrument":{"type": "card/plain","cardHolderName": "Joe Bloggs","cardExpiryDate":{"month": 1,"year": 2019},"cardNumber":"4444333322221111","verificationAddress":{"address1":"address1","address2": "address2","address3": "address3","postalCode":"postalCode","city": "city","state": "state","countryCode": "GB"},"cvc": "101"},"merchant": {"entity": "default","paymentFacilitator":{"pfId":"12345678901","subMerchant":{"merchantId": "123456789012345","name": "Example Shop","street": "123 Street","state": "CA","city": "San Francisco","countryCode": "840","postalCode": "94101","taxId": "987-65-4321"}}}} responses: '201': description: The account verification has been successful. content: application/vnd.worldpay.verifications.accounts-v2.hal+json: schema: $ref: '#/components/schemas/verifications_cardOnFile_201_response' examples: Successful account verification outcome.: description: Successful account verification outcome. value: outcome: verified schemeTransactionReference: '00000000000000000' checkedAt: '2018-09-01T10:37:36.923Z' _links: verifications:verification: href: >- https://try.access.worldpay.com/verifications/accounts/{resource} payments:cardOnFileAuthorize: href: >- http://try.access.worldpay.com/payments/authorizations/cardOnFile/{resource} payments:recurringAuthorize: href: >- http://try.access.worldpay.com/payments/authorizations/recurring/{resource} curies: - name: verifications href: >- https://try.access.worldpay.com/rels/verifications/accounts/{rel} templated: true Refused account verification outcome.: description: Refused account verification outcome. value: outcome: not verified code: '76' rawCode: N7 description: CARD BLOCKED checkedAt: '2019-11-28T11:46:22.107966Z' _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 Successful Dynamic MCC account verification outcome.: description: Successful Dynamic MCC account verification outcome. value: outcome: verified schemeTransactionReference: '00000000000000000' checkedAt: '2018-09-01T10:37:36.923Z' _links: verifications:verification: href: >- https://try.access.worldpay.com/verifications/accounts/{resource} payments:cardOnFileAuthorize: href: >- http://try.access.worldpay.com/payments/authorizations/cardOnFile/{resource} payments:recurringAuthorize: href: >- http://try.access.worldpay.com/payments/authorizations/recurring/{resource} curies: - name: verifications href: >- https://try.access.worldpay.com/rels/verifications/accounts/{rel} templated: true Successful payment facilitator account verification outcome.: description: Successful payment facilitator account verification outcome. value: outcome: verified schemeTransactionReference: '00000000000000000' checkedAt: '2018-09-01T10:37:36.923Z' _links: verifications:verification: href: >- https://try.access.worldpay.com/verifications/accounts/{resource} payments:cardOnFileAuthorize: href: >- http://try.access.worldpay.com/payments/authorizations/cardOnFile/{resource} payments:recurringAuthorize: href: >- http://try.access.worldpay.com/payments/authorizations/recurring/{resource} curies: - name: verifications href: >- https://try.access.worldpay.com/rels/verifications/accounts/{rel} templated: true '202': description: The account verification has been successful. content: application/vnd.worldpay.verifications.accounts-v2.hal+json: schema: $ref: '#/components/schemas/verifications_cardOnFile_202_response' examples: Successful account verification outcome without Payments links.: description: >- Successful account verification outcome without Payments links. value: outcome: verified schemeTransactionReference: '00000000000000000' checkedAt: '2018-09-01T10:37:36.923Z' _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 components: schemas: verifications_Verifications_200_response: required: - _links type: object verifications_verification_200_response: required: - outcome - checkedAt - _links type: object properties: outcome: type: string checkedAt: type: string verifications_oneTime: required: - merchant - currency - paymentInstrument type: object properties: merchant: required: - entity type: object properties: entity: type: string mcc: type: string paymentFacilitator: required: - pfId - subMerchant type: object properties: pfId: type: string isoId: type: string subMerchant: required: - merchantId - name - street - city - countryCode - postalCode type: object properties: merchantId: type: string name: type: string street: type: string city: type: string state: type: string countryCode: type: string postalCode: type: string taxId: type: string telephone: type: string email: type: string currency: type: string paymentInstrument: required: - type - cardHolderName - cardExpiryDate - cardNumber type: object properties: type: type: string cardHolderName: type: string cardExpiryDate: required: - month - year type: object properties: month: type: integer year: type: integer cardNumber: type: string verificationAddress: required: - postalCode - city - countryCode type: object properties: address1: type: string postalCode: type: string city: type: string countryCode: type: string cvc: type: string verifications_oneTime_201_response: required: - outcome - checkedAt - _links type: object properties: outcome: type: string checkedAt: type: string verifications_cardOnFile: required: - merchant - currency - paymentInstrument type: object properties: merchant: required: - entity type: object properties: entity: type: string mcc: type: string paymentFacilitator: required: - pfId - subMerchant type: object properties: pfId: type: string isoId: type: string subMerchant: required: - merchantId - name - street - city - countryCode - postalCode type: object properties: merchantId: type: string name: type: string street: type: string city: type: string state: type: string countryCode: type: string postalCode: type: string taxId: type: string telephone: type: string email: type: string currency: type: string paymentInstrument: required: - type - cardHolderName - cardExpiryDate - cardNumber type: object properties: type: type: string cardHolderName: type: string cardExpiryDate: required: - month - year type: object properties: month: type: integer year: type: integer cardNumber: type: string verificationAddress: required: - postalCode - city - countryCode type: object properties: address1: type: string postalCode: type: string city: type: string countryCode: type: string cvc: type: string verifications_cardOnFile_201_response: required: - outcome - checkedAt - _links type: object properties: outcome: type: string schemeTransactionReference: type: string checkedAt: type: string verifications_cardOnFile_202_response: required: - outcome - checkedAt - _links type: object properties: outcome: type: string schemeTransactionReference: type: string checkedAt: type: string securitySchemes: BasicAuth: type: http scheme: basic security: - BasicAuth: [] tags: - name: Root description: >- Verifications root resource, returns links to available Account Verifications actions. - name: Verifications description: >- Verify tokens root resource, returns links to available verifiedTokens actions. - name: Verification description: >- Verify tokens root resource, returns links to available verifiedTokens actions.