Verified Payment

Verified Payment

Initiate Verified Payment (coming soon)

Methods

POST

Request

Copied!
{
 "type": "object",
 "required": [
  "challenge",
  "deviceData",
  "instruction",
  "merchant",
  "transactionReference"
 ],
 "properties": {
  "transactionReference": {
   "type": "string"
  },
  "instruction": {
   "type": "object",
   "required": [
    "narrative",
    "paymentInstrument",
    "value"
   ],
   "properties": {
    "debtRepayment": {
     "type": "boolean"
    },
    "narrative": {
     "type": "object",
     "required": [
      "line1"
     ],
     "properties": {
      "line2": {
       "type": "string"
      },
      "line1": {
       "type": "string"
      }
     }
    },
    "paymentInstrument": {},
    "value": {
     "type": "object",
     "required": [
      "amount",
      "currency"
     ],
     "properties": {
      "amount": {
       "type": "integer"
      },
      "currency": {
       "type": "string"
      }
     }
    }
   }
  },
  "deviceData": {
   "type": "object",
   "required": [
    "acceptHeader",
    "userAgentHeader"
   ],
   "properties": {
    "acceptHeader": {
     "type": "string"
    },
    "browserLanguage": {
     "type": "string"
    },
    "userAgentHeader": {
     "type": "string"
    },
    "ipAddress": {
     "type": "string"
    },
    "tmxSessionId": {
     "type": "string"
    }
   }
  },
  "merchant": {
   "type": "object",
   "required": [
    "entity"
   ],
   "properties": {
    "paymentFacilitator": {
     "type": "object",
     "required": [
      "pfId",
      "subMerchant"
     ],
     "properties": {
      "subMerchant": {
       "type": "object",
       "required": [
        "city",
        "countryCode",
        "merchantId",
        "name",
        "postalCode",
        "street"
       ],
       "properties": {
        "merchantId": {
         "type": "string"
        },
        "city": {
         "type": "string"
        },
        "street": {
         "type": "string"
        },
        "countryCode": {
         "type": "string"
        },
        "taxId": {
         "type": "string"
        },
        "postalCode": {
         "type": "string"
        },
        "name": {
         "type": "string"
        },
        "state": {
         "type": "string"
        }
       }
      },
      "pfId": {
       "type": "string"
      },
      "isoId": {
       "type": "string"
      }
     }
    },
    "fraud": {
     "type": "string"
    },
    "mcc": {
     "type": "string"
    },
    "entity": {
     "type": "string"
    }
   }
  },
  "challenge": {
   "type": "object",
   "required": [
    "returnUrl"
   ],
   "properties": {
    "windowSize": {
     "type": "string"
    },
    "preference": {
     "type": "string"
    },
    "returnUrl": {
     "type": "string"
    }
   }
  },
  "riskData": {
   "type": "object",
   "properties": {
    "shipping": {
     "type": "object",
     "properties": {
      "firstName": {
       "type": "string"
      },
      "lastName": {
       "type": "string"
      },
      "address": {
       "type": "object",
       "required": [
        "countryCode"
       ],
       "properties": {
        "phoneNumber": {
         "type": "string"
        },
        "address3": {
         "type": "string"
        },
        "address2": {
         "type": "string"
        },
        "city": {
         "type": "string"
        },
        "address1": {
         "type": "string"
        },
        "countryCode": {
         "type": "string"
        },
        "postalCode": {
         "type": "string"
        },
        "state": {
         "type": "string"
        }
       }
      },
      "method": {
       "type": "string"
      },
      "nameMatchesAccountName": {
       "type": "boolean"
      },
      "timeFrame": {
       "type": "string"
      },
      "email": {
       "type": "string"
      }
     }
    },
    "custom": {
     "type": "object",
     "properties": {
      "number3": {
       "type": "integer"
      },
      "number4": {
       "type": "integer"
      },
      "number1": {
       "type": "integer"
      },
      "number2": {
       "type": "integer"
      },
      "number7": {
       "type": "integer"
      },
      "number8": {
       "type": "integer"
      },
      "number5": {
       "type": "integer"
      },
      "number6": {
       "type": "integer"
      },
      "string7": {
       "type": "string"
      },
      "string8": {
       "type": "string"
      },
      "number9": {
       "type": "integer"
      },
      "string5": {
       "type": "string"
      },
      "string6": {
       "type": "string"
      },
      "string3": {
       "type": "string"
      },
      "string4": {
       "type": "string"
      },
      "string1": {
       "type": "string"
      },
      "string2": {
       "type": "string"
      },
      "string9": {
       "type": "string"
      }
     }
    },
    "account": {
     "type": "object",
     "properties": {
      "shopperId": {
       "type": "string"
      },
      "dateOfBirth": {
       "type": "string"
      },
      "history": {
       "type": "object",
       "properties": {
        "createdAt": {
         "type": "string"
        },
        "modifiedAt": {
         "type": "string"
        },
        "paymentAccountEnrolledAt": {
         "type": "string"
        },
        "passwordModifiedAt": {
         "type": "string"
        }
       }
      },
      "previousSuspiciousActivity": {
       "type": "boolean"
      },
      "type": {
       "type": "string"
      },
      "email": {
       "type": "string"
      }
     }
    },
    "transaction": {
     "type": "object",
     "properties": {
      "firstName": {
       "type": "string"
      },
      "lastName": {
       "type": "string"
      },
      "phoneNumber": {
       "type": "string"
      },
      "preOrderDate": {
       "type": "string"
      },
      "reorder": {
       "type": "boolean"
      },
      "history": {
       "type": "object",
       "properties": {
        "attemptsLastYear": {
         "type": "integer"
        },
        "completedLastSixMonths": {
         "type": "integer"
        },
        "attemptsLastDay": {
         "type": "integer"
        },
        "shippingAddressFirstUsedAt": {
         "type": "string"
        },
        "addCardsLastDay": {
         "type": "integer"
        }
       }
      },
      "giftCardsPurchase": {
       "type": "object",
       "properties": {
        "totalValue": {
         "type": "object",
         "required": [
          "amount",
          "currency"
         ],
         "properties": {
          "amount": {
           "type": "integer"
          },
          "currency": {
           "type": "string"
          }
         }
        },
        "quantity": {
         "type": "integer"
        }
       }
      }
     }
    }
   }
  }
 }
}

Responses

Examples

POST
 Example of a card payment using only the mandatory values
View
POST
 Example of a card payment using all possible values
View
POST
 Example of a tokenized card using only the mandatory values
View
POST
 Example of a tokenized card with CVC
View

Link relationship

  • verifiedPayments:3dsDeviceData

    Fills in the device data details.

post
 Example of a card payment using only the mandatory values
POSTverifiedPayments:verifiedPayment link from VerifiedPayments root resource response
Copied!
{
  "Authorization": "Bearer token",
  "Accept": "application/vnd.worldpay.verifiedpayments-v1.hal+json",
  "Content-Type": "application/vnd.worldpay.verifiedpayments-v1.hal+json"
}
Copied!
{
  "transactionReference": "uniqueId",
  "merchant": {
    "entity": "an-entity"
  },
  "instruction": {
    "paymentInstrument": {
      "type": "card/plain",
      "cardHolderName": "John Appleseed",
      "cardNumber": "4444333322221111",
      "cardExpiryDate": {
        "month": 5,
        "year": 2035
      }
    },
    "narrative": {
      "line1": "trading name"
    },
    "value": {
      "currency": "GBP",
      "amount": 42
    }
  },
  "deviceData": {
    "acceptHeader": "text/html",
    "userAgentHeader": "Mozilla/5.0 (Windows NT 6.1; Win64; x64; rv:47.0)"
  },
  "challenge": {
    "returnUrl": "https://your-website.com/webhook"
  }
}

201

Copied!
{
  "outcome": "3dsDeviceDataRequired",
  "deviceDataCollection": {
    "jwt": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJPcmdVbml0SWQiOiJPcmdVbml0IiwiaXNzIjoiYXBpSWQiLCJleHAiOjE1NjI5MjMzNDYsImlhdCI6MTU2MjkyMzQwNiwianRpIjoiYTAzMWVhOGEtN2E0Zi00YTQwLWI1NjMtOTUzMzYzMzVhZGNmIn0.0IK74OIXBxFsxqeOURJz1TFnz14ZTbFJTdTWo9cHUJQ",
    "url": "https://ddcUrl.example.com",
    "bin": "555555"
  },
  "transactionReference": "11611",
  "_links": {
    "verifiedPayments:3dsDeviceData": {
      "href": "https://access.worldpay.com/verifiedPayments/3dsDeviceData/eyJrIjoxLCJkIjoiM1p4TFdwKzV3ZFRZYWUyT1FYd3lMdz09In0"
    },
    "curies": [
      {
        "href": "https://access.worldpay.com/rels/verifiedPayments/{rel}",
        "name": "verifiedPayments",
        "templated": true
      }
    ]
  }
}