Dynamic card on file

Verifications dynamic cardOnFile resource.

Methods

POST

Verifies a card 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"
   ]
  },
  "instruction": {
   "type": "object",
   "properties": {
    "value": {
     "type": "object",
     "properties": {
      "amount": {
       "type": "string"
      },
      "currency": {
       "type": "string"
      }
     },
     "required": [
      "amount",
      "currency"
     ]
    },
    "paymentInstrument": {
     "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",
      "cardHolderName",
      "cardExpiryDate",
      "cardNumber"
     ]
    },
    "narrative": {
     "type": "object",
     "properties": {
      "line1": {
       "type": "string"
      },
      "line2": {
       "type": "string"
      }
     },
     "required": [
      "line1"
     ]
    }
   },
   "required": [
    "value",
    "paymentInstrument",
    "narrative"
   ]
  },
  "transactionReference": {
   "type": "string"
  },
  "customer": {
   "type": "object",
   "properties": {
    "authentication": {
     "type": "object",
     "properties": {
      "version": {
       "type": "string"
      },
      "type": {
       "type": "string"
      },
      "eci": {
       "type": "string"
      },
      "authenticationValue": {
       "type": "string"
      },
      "transactionId": {
       "type": "string"
      }
     },
     "required": [
      "version",
      "type",
      "eci"
     ]
    }
   },
   "required": [
    "authentication"
   ]
  }
 },
 "required": [
  "merchant",
  "transactionReference",
  "instruction"
 ]
}

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"
       ]
      },
      "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"
 ]
}

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"
       ]
      },
      "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"
 ]
}

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

Verifies a token 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"
   ]
  },
  "instruction": {
   "type": "object",
   "properties": {
    "value": {
     "type": "object",
     "properties": {
      "amount": {
       "type": "string"
      },
      "currency": {
       "type": "string"
      }
     },
     "required": [
      "amount",
      "currency"
     ]
    },
    "paymentInstrument": {
     "type": "object",
     "properties": {
      "type": {
       "type": "string"
      },
      "href": {
       "type": "string"
      }
     },
     "required": [
      "type",
      "href"
     ]
    },
    "narrative": {
     "type": "object",
     "properties": {
      "line1": {
       "type": "string"
      },
      "line2": {
       "type": "string"
      }
     },
     "required": [
      "line1"
     ]
    }
   },
   "required": [
    "value",
    "paymentInstrument",
    "narrative"
   ]
  },
  "transactionReference": {
   "type": "string"
  },
  "customer": {
   "type": "object",
   "properties": {
    "authentication": {
     "type": "object",
     "properties": {
      "version": {
       "type": "string"
      },
      "type": {
       "type": "string"
      },
      "eci": {
       "type": "string"
      },
      "authenticationValue": {
       "type": "string"
      },
      "transactionId": {
       "type": "string"
      }
     },
     "required": [
      "version",
      "type",
      "eci"
     ]
    }
   },
   "required": [
    "authentication"
   ]
  }
 },
 "required": [
  "merchant",
  "transactionReference",
  "instruction"
 ]
}

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"
       ]
      },
      "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"
 ]
}

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"
       ]
      },
      "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"
 ]
}

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

Link relationship

post
 Successful account verification outcome. 
POST https://try.access.worldpay.com/verifications/accounts/dynamic/cardOnFile
Copied!
{
  "Authorization": "Basic Auth",
  "Content-Type": "application/vnd.worldpay.verifications.accounts-v5+json",
  "Accept": "application/vnd.worldpay.verifications.accounts-v5+json"
}
Copied!
{
  "merchant": {
    "entity": "default"
  },
  "transactionReference": "transactionReference",
  "instruction": {
    "value": {
      "amount": 100,
      "currency": "GBP"
    },
    "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"
    }
  }
}

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
      }
    ]
  }
}