Card on file

Verifications cardOnFile resource.

Methods

POST

Verifies a payment instrument for stored credentials purposes.

Request

Copied!
{
 "type": "object",
 "properties": {
  "merchant": {
   "type": "object",
   "properties": {
    "entity": {
     "type": "string"
    },
    "mcc": {
     "type": "string"
    },
    "paymentFacilitator": {
     "type": "object",
     "properties": {
      "pfId": {
       "type": "string"
      },
      "isoId": {
       "type": "string"
      },
      "subMerchant": {
       "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"
        }
       },
       "required": [
        "merchantId",
        "name",
        "street",
        "city",
        "countryCode",
        "postalCode"
       ]
      }
     },
     "required": [
      "pfId",
      "subMerchant"
     ]
    }
   },
   "required": [
    "entity"
   ]
  },
  "currency": {
   "type": "string"
  },
  "paymentInstrument": {
   "oneOf": [
    {
     "type": "object",
     "properties": {
      "type": {
       "type": "string"
      },
      "cardHolderName": {
       "type": "string"
      },
      "cardExpiryDate": {
       "type": "object",
       "properties": {
        "month": {
         "type": "integer"
        },
        "year": {
         "type": "integer"
        }
       },
       "required": [
        "month",
        "year"
       ]
      },
      "cardNumber": {
       "type": "string"
      },
      "verificationAddress": {
       "type": "object",
       "properties": {
        "address1": {
         "type": "string"
        },
        "postalCode": {
         "type": "string"
        },
        "city": {
         "type": "string"
        },
        "countryCode": {
         "type": "string"
        }
       },
       "required": [
        "postalCode",
        "city",
        "countryCode"
       ]
      },
      "cvc": {
       "type": "string"
      }
     },
     "required": [
      "type",
      "cardExpiryDate",
      "cardNumber"
     ]
    },
    {
     "type": "object",
     "properties": {
      "type": {
       "type": "string"
      },
      "href": {
       "type": "string"
      }
     },
     "required": [
      "type",
      "href"
     ]
    },
    {
     "type": "object",
     "properties": {
      "type": {
       "type": "string"
      },
      "cardHolderName": {
       "type": "string"
      },
      "cardExpiryDate": {
       "type": "object",
       "properties": {
        "month": {
         "type": "integer"
        },
        "year": {
         "type": "integer"
        }
       },
       "required": [
        "month",
        "year"
       ]
      },
      "dpan": {
       "type": "string"
      }
     },
     "required": [
      "type",
      "cardExpirtyDate",
      "dpan"
     ]
    }
   ]
  },
  "narrative": {
   "type": "object",
   "properties": {
    "line1": {
     "type": "string"
    },
    "line2": {
     "type": "string"
    }
   },
   "required": [
    "line1"
   ]
  },
  "transactionReference": {
   "type": "string"
  },
  "customer": {
   "type": "object",
   "properties": {
    "authentication": {
     "oneOf": [
      {
       "type": "object",
       "properties": {
        "version": {
         "type": "string"
        },
        "type": {
         "type": "string"
        },
        "eci": {
         "type": "string"
        },
        "authenticationValue": {
         "type": "string"
        },
        "transactionId": {
         "type": "string"
        }
       },
       "required": [
        "version",
        "type",
        "eci"
       ]
      },
      {
       "type": "object",
       "properties": {
        "type": {
         "type": "string"
        },
        "eci": {
         "type": "string"
        },
        "authenticationValue": {
         "type": "string"
        }
       },
       "required": [
        "type",
        "authenticationValue"
       ]
      }
     ]
    }
   },
   "required": [
    "authentication"
   ]
  }
 },
 "required": [
  "merchant",
  "currency",
  "paymentInstrument",
  "transactionReference"
 ]
}

Responses

Examples

POST
 Successful account verification outcome.
View
POST
 Refused account verification outcome.
View
POST
 Successful Dynamic MCC account verification outcome.
View
POST
 Successful account verification outcome without Payments links.
View
POST
 Successful payment facilitator account verification outcome.
View
POST
 Successful account verification outcome with 3DS1 values.
View
POST
 Successful account verification outcome with 3DS2 values.
View
POST
 Successful account verification with a token.
View
POST
 Successful account verification with a decrypted applepay.
View

Link relationship

post
 Successful account verification outcome. 
POSThttps://try.access.worldpay.com/verifications/accounts/intelligent/cardOnFile
Copied!
{
  "Authorization": "Basic Auth",
  "Content-Type": "application/vnd.worldpay.verifications.accounts-v5+json",
  "Accept": "application/vnd.worldpay.verifications.accounts-v5+json"
}
Copied!
{
  "currency": "EUR",
  "paymentInstrument": {
    "type": "card/plain",
    "cardHolderName": "Joe Bloggs",
    "cardExpiryDate": {
      "month": 1,
      "year": 2019
    },
    "cardNumber": "4444333322221111",
    "verificationAddress": {
      "address1": "address1",
      "postalCode": "postalCode",
      "city": "city",
      "countryCode": "GB"
    },
    "cvc": "101"
  },
  "narrative": {
    "line1": "STATEMENT",
    "line2": "OPTIONAL"
  },
  "merchant": {
    "entity": "default"
  },
  "transactionReference": "transactionReference"
}

201

Copied!
{
  "outcome": "verified",
  "schemeTransactionReference": "00000000000000000",
  "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"
      },
      "paymentAccountReference": "reference"
    }
  },
  "_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}"
    },
    "payments:recurringSale": {
      "href": "http://try.access.worldpay.com/payments/sales/recurring/{resource}"
    },
    "curies": [
      {
        "name": "verifications",
        "href": "https://try.access.worldpay.com/rels/verifications/accounts/{rel}",
        "templated": true
      }
    ]
  }
}