{"title":"Test cards API reference","category":"default","creationDate":1779533780,"content":"<p>To communicate with our API, you submit HTTP requests to applicable endpoints.<\/p>\n<p>These endpoints differ for test and live accounts, and also depend on the data format (SOAP, JSON, or FORM) you use to submit data to the\u00a0Adyen payments platform.<\/p>\n<p>This document lists all endpoints that are available for you to integrate with the test platform and run QA checks.<\/p>\n<h2>Requirements<\/h2>\n<table>\n<thead>\n<tr>\n<th style=\"text-align: left;\">Requirement<\/th>\n<th style=\"text-align: left;\">Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td style=\"text-align: left;\"><strong>API credentials<\/strong><\/td>\n<td style=\"text-align: left;\">You must have valid <a href=\"\/development-resources\/api-credentials\">API credentials<\/a> to make requests to endpoints.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<h2 id=\"soap\">SOAP endpoints<\/h2>\n<p>For the SOAP messaging protocol, all test payment requests must be posted to the following endpoint:<\/p>\n<ul>\n<li><a href=\"https:\/\/pal-test.adyen.com\/pal\/services\/TestCard\/v1\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">https:\/\/pal-test.adyen.com\/pal\/services\/TestCard\/v1<\/a><\/li>\n<\/ul>\n<p>The data schema for corresponding SOAP objects is available at:<\/p>\n<ul>\n<li><a href=\"https:\/\/pal-test.adyen.com\/pal\/services\/TestCard\/v1?wsdl\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">https:\/\/pal-test.adyen.com\/pal\/services\/TestCard\/v1?wsdl<\/a><\/li>\n<\/ul>\n<h2 id=\"json-and-form\">JSON and FORM endpoints<\/h2>\n<p>This is an overview of the test URL endpoints to communicate with our API using JSON or FORM (key-value parameters passed in an HTTP POST URL).<\/p>\n<ul>\n<li><a href=\"https:\/\/pal-test.adyen.com\/pal\/services\/TestCard\/v1\/createTestCardRanges\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">https:\/\/pal-test.adyen.com\/pal\/services\/TestCard\/v1\/createTestCardRanges<\/a><\/li>\n<\/ul>\n<h3 id=\"avs-address\">AvsAddress<\/h3>\n<table style=\"width:100%;\"><colgroup><col style=\"width: 22%\"><col style=\"width: 5%\"><col style=\"width: 7%\"><col style=\"width: 64%\"><\/colgroup><thead><tr class=\"header\"><th>Field<\/th><th>Type<\/th><th>Required<\/th><th>Description<\/th><\/tr><\/thead><tbody><tr><td>\n<p><code>streetAddress<\/code><\/p>\n<\/td><td>\n<p>\u00a0String<\/p>\n<\/td><td>\n<p><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/p>\n<\/td><td>\n<p>Billing address of the cardholder.Example:\u00a01 Infinite Loop, Cupertino<\/p>\n<\/td><\/tr><tr><td>\n<p><code>zip<\/code><\/p>\n<\/td><td>\n<p>\u00a0String<\/p>\n<\/td><td>\n\n<\/td><td>\n<p>Zip code associated with the billing address of the cardholder.Example:\u00a0CA 95014<\/p>\n<\/td><\/tr><\/tbody><\/table>\n<h3>CreateTestCardRangesRequest<\/h3>\n<p>\u00a0<\/p>\n<table style=\"width:100%;\"><colgroup><col style=\"width: 21%\"><col style=\"width: 8%\"><col style=\"width: 6%\"><col style=\"width: 62%\"><\/colgroup><thead><tr class=\"header\"><th>Field<\/th><th>Type<\/th><th>Required<\/th><th>Description<\/th><\/tr><\/thead><tbody><tr><td>\n<p><code>accountCode<\/code><\/p>\n<\/td><td>\n<p>String<\/p>\n<\/td><td>\n<p><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/p>\n<\/td><td>\n<p>The merchant account details used to log in and access the account.<\/p>\n<\/td><\/tr><tr><td>\n<p><code>accountTypeCode<\/code><\/p>\n<\/td><td>\n<p>String<\/p>\n<\/td><td>\n<p><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/p>\n<\/td><td>\n<p>The type of account used to make the call.Possible values:<ul><li markdown=\"1\">Company<\/li><li markdown=\"1\">MerchantAccount<\/li><\/ul><p>These values are case-sensitive.<\/p><\/p>\n<\/td><\/tr><tr><td>\n<p><code>testCardRanges<\/code><\/p>\n<\/td><td>\n<p>Array of <a href=\"\/development-resources\/test-cards-and-credentials\/create-test-cards\/test-cards-api\/#test-card-range\">TestCardRange<\/a><\/p>\n<\/td><td>\n<p><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/p>\n<\/td><td>\n<p>Contains one or more test card range objects.<\/p>\n<\/td><\/tr><\/tbody><\/table>\n<h3>CreateTestCardRangesResult<\/h3>\n<table>\n<thead>\n<tr>\n<th>Field<\/th>\n<th>Type<\/th>\n<th>Required<\/th>\n<th>Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td><code>rangeCreationResults<\/code><\/td>\n<td>Array of <a href=\"\/development-resources\/test-cards-and-credentials\/create-test-cards\/test-cards-api\/#test-card-range-creation-result\">TestCardRangeCreationResult<\/a><\/td>\n<td><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/td>\n<td>Contains one or more test card range result outputs.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<h3 id=\"test-card-range\">TestCardRange<\/h3>\n<p>Defines the properties of a test card range.<\/p>\n<table>\n   <thead>\n      <tr class=\"header\">\n         <th>Field<\/th>\n         <th>Type<\/th>\n         <th>Required<\/th>\n         <th>Description<\/th>\n      <\/tr>\n   <\/thead>\n   <tbody>\n      <tr>\n         <td>\n<p><code>address<\/code><\/p>\n<\/td>\n         <td>\n<p><a href=\"\/development-resources\/test-cards-and-credentials\/create-test-cards\/test-cards-api\/#avs-address\">AvsAddress<\/a><\/p>\n<\/td>\n         <td>\n<p><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/p>\n<\/td>\n         <td>\n<p>Contains the billing address of the cardholder. The address details need to be AVS (Address Verification Service) compliant, i.e. you need to define at least streetAddress.<\/p>\n<\/td>\n      <\/tr>\n      <tr>\n         <td>\n<p><code>cardHolderName<\/code><\/p>\n<\/td>\n         <td>\n<p>String<\/p>\n<\/td>\n         <td>\n<p><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/p>\n<\/td>\n         <td>\n            <p>The name of the cardholder, as it appears on the card, for the test card range.<\/p>\n            <p>Example: S Hopper<\/p>\n         <\/td>\n      <\/tr>\n      <tr>\n         <td>\n<p><code>cvc<\/code><\/p>\n<\/td>\n         <td>\n<p>String<\/p>\n<\/td>\n         <td>\n\n<\/td>\n         <td>\n            <p>The test card range security code.<\/p>\n            <p>Example: 123<\/p>\n         <\/td>\n      <\/tr>\n      <tr>\n         <td>\n<p><code>expiryMonth<\/code><\/p>\n<\/td>\n         <td>\n<p>String<\/p>\n<\/td>\n         <td>\n<p><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/p>\n<\/td>\n         <td>\n            <p>Expiry month for the test card range.<\/p>\n            <p>Allowed values: <\/p>\n            <ul>\n               <li>\n<p>JANUARY<\/p>\n<\/li>\n               <li>\n<p>FEBRUARY<\/p>\n<\/li>\n               <li>\n<p>MARCH<\/p>\n<\/li>\n               <li>\n<p>APRIL<\/p>\n<\/li>\n               <li>\n<p>MAY<\/p>\n<\/li>\n               <li>\n<p>JUNE<\/p>\n<\/li>\n               <li>\n<p>JULY<\/p>\n<\/li>\n               <li>\n<p>AUGUST<\/p>\n<\/li>\n               <li>\n<p>SEPTEMBER<\/p>\n<\/li>\n               <li>\n<p>OCTOBER<\/p>\n<\/li>\n               <li>\n<p>NOVEMBER<\/p>\n<\/li>\n               <li>\n<p>DECEMBER<\/p>\n<\/li>\n            <\/ul>\n         <\/td>\n      <\/tr>\n      <tr>\n         <td>\n<p><code>expiryYear<\/code><\/p>\n<\/td>\n         <td>\n<p>String<\/p>\n<\/td>\n         <td>\n<p><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/p>\n<\/td>\n         <td>\n            <p>Expiry year for the test card range.<\/p>\n            <p>Example: 2020<\/p>\n         <\/td>\n      <\/tr>\n      <tr>\n         <td>\n<p><code>rangeEnd<\/code><\/p>\n<\/td>\n         <td>\n<p>String<\/p>\n<\/td>\n         <td>\n<p><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/p>\n<\/td>\n         <td>\n            <p>The last test card number in the test card range: <\/p>\n            <ul>\n               <li>\n<p>Min 6, max 19 digits<\/p>\n<\/li>\n               <li>\n<p>BIN compliant<\/p>\n<\/li>\n            <\/ul>\n            <p>Example: 5432123412344321<\/p>\n         <\/td>\n      <\/tr>\n      <tr>\n         <td>\n<p><code>rangeStart<\/code><\/p>\n<\/td>\n         <td>\n<p>String<\/p>\n<\/td>\n         <td>\n<p><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/p>\n<\/td>\n         <td>\n            <p> The first test card number in the test card range:<\/p>\n            <ul>\n               <li>\n<p>Min 6, max 19 digits<\/p>\n<\/li>\n               <li>\n<p>BIN compliant<\/p>\n<\/li>\n            <\/ul>\n            <p>Example: 5432123412341234<\/p>\n         <\/td>\n      <\/tr>\n      <tr>\n         <td>\n<p><code>threeDUserName<\/code><\/p>\n<\/td>\n         <td>\n<p>String<\/p>\n<\/td>\n         <td>\n\n<\/td>\n         <td>\n            <p>3D Secure user name details of the cardholder.<\/p>\n            <p>Example: simonhopper<\/p>\n         <\/td>\n      <\/tr>\n      <tr>\n         <td>\n<p><code>threeDPassword<\/code><\/p>\n<\/td>\n         <td>\n<p>String<\/p>\n<\/td>\n         <td>\n\n<\/td>\n         <td>\n            <p>3D Secure password details of the cardholder.<\/p>\n            <p>Example: myPa$$w0rd<\/p>\n         <\/td>\n      <\/tr>\n      <tr>\n         <td>\n<p><code>threeDDirectoryServerResponse<\/code><\/p>\n<\/td>\n         <td>\n<p>String<\/p>\n<\/td>\n         <td>\n\n<\/td>\n         <td>\n            <p>3D Secure server response. It notifies whether the specified cardholder is enrolled in a 3D Secure service. Possible values:<\/p>\n            <ul>\n               <li>\n<p>Y (Authentication available)<\/p>\n<\/li>\n               <li>\n<p>N (Card holder not enrolled\/not participating)<\/p>\n<\/li>\n               <li>\n<p>U (Unable to authenticate)<\/p>\n<\/li>\n            <\/ul>\n         <\/td>\n      <\/tr>\n   <\/tbody>\n<\/table>\n<h3 id=\"test-card-range-creation-result\">TestCardRangeCreationResult<\/h3>\n<p>Contains a test card range result output.<\/p>\n<table><thead><tr class=\"header\"><th>Field<\/th><th>Type<\/th><th>Required<\/th><th>Description<\/th><\/tr><\/thead><tbody><tr><td>\n<p>\u00a0<code>cardNumberRangeStart<\/code><\/p>\n<\/td><td>\n<p>\u00a0String<\/p>\n<\/td><td>\n<p><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/p>\n<\/td><td>\n<p>The first test card number in the generated test card range.Example:\u00a05432123412341234<\/p>\n<\/td><\/tr><tr><td>\n<p>\u00a0<code>cardNumberRangeEnd<\/code><\/p>\n<\/td><td>\n<p>\u00a0String<\/p>\n<\/td><td>\n<p><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/p>\n<\/td><td>\n<p>The last test card number in the generated test card range.Example:\u00a05432123412344321<\/p>\n<\/td><\/tr><tr><td>\n<p>\u00a0<code>creationResultCode<\/code><\/p>\n<\/td><td>\n<p>\u00a0String<\/p>\n<\/td><td>\n<p><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/p>\n<\/td><td>\n<p>Notification message. It informs about the outcome of the operation. Possible values:<ul><li markdown=\"1\">CREATED<\/li><li markdown=\"1\">ALREADY_EXISTS<\/li><li markdown=\"1\">ERROR<\/li><\/ul><\/p>\n<\/td><\/tr><\/tbody><\/table>","url":"https:\/\/docs.adyen.com\/development-resources\/test-cards-and-credentials\/create-test-cards\/test-cards-api","articleFields":{"id":"25133818","type":"page","status":"current","last_edit_on":"06-09-2020 22:30"},"algolia":{"url":"https:\/\/docs.adyen.com\/development-resources\/test-cards-and-credentials\/create-test-cards\/test-cards-api","title":"Test cards API reference","content":"To communicate with our API, you submit HTTP requests to applicable endpoints.\nThese endpoints differ for test and live accounts, and also depend on the data format (SOAP, JSON, or FORM) you use to submit data to the\u00a0Adyen payments platform.\nThis document lists all endpoints that are available for you to integrate with the test platform and run QA checks.\nRequirements\n\n\n\nRequirement\nDescription\n\n\n\n\nAPI credentials\nYou must have valid API credentials to make requests to endpoints.\n\n\n\nSOAP endpoints\nFor the SOAP messaging protocol, all test payment requests must be posted to the following endpoint:\n\nhttps:\/\/pal-test.adyen.com\/pal\/services\/TestCard\/v1\n\nThe data schema for corresponding SOAP objects is available at:\n\nhttps:\/\/pal-test.adyen.com\/pal\/services\/TestCard\/v1?wsdl\n\nJSON and FORM endpoints\nThis is an overview of the test URL endpoints to communicate with our API using JSON or FORM (key-value parameters passed in an HTTP POST URL).\n\nhttps:\/\/pal-test.adyen.com\/pal\/services\/TestCard\/v1\/createTestCardRanges\n\nAvsAddress\nFieldTypeRequiredDescription\nstreetAddress\n\n\u00a0String\n\n\n\nBilling address of the cardholder.Example:\u00a01 Infinite Loop, Cupertino\n\nzip\n\n\u00a0String\n\n\n\nZip code associated with the billing address of the cardholder.Example:\u00a0CA 95014\n\nCreateTestCardRangesRequest\n\u00a0\nFieldTypeRequiredDescription\naccountCode\n\nString\n\n\n\nThe merchant account details used to log in and access the account.\n\naccountTypeCode\n\nString\n\n\n\nThe type of account used to make the call.Possible values:CompanyMerchantAccountThese values are case-sensitive.\n\ntestCardRanges\n\nArray of TestCardRange\n\n\n\nContains one or more test card range objects.\n\nCreateTestCardRangesResult\n\n\n\nField\nType\nRequired\nDescription\n\n\n\n\nrangeCreationResults\nArray of TestCardRangeCreationResult\n\nContains one or more test card range result outputs.\n\n\n\nTestCardRange\nDefines the properties of a test card range.\n\n   \n      \n         Field\n         Type\n         Required\n         Description\n      \n   \n   \n      \n         \naddress\n\n         \nAvsAddress\n\n         \n\n\n         \nContains the billing address of the cardholder. The address details need to be AVS (Address Verification Service) compliant, i.e. you need to define at least streetAddress.\n\n      \n      \n         \ncardHolderName\n\n         \nString\n\n         \n\n\n         \n            The name of the cardholder, as it appears on the card, for the test card range.\n            Example: S Hopper\n         \n      \n      \n         \ncvc\n\n         \nString\n\n         \n\n\n         \n            The test card range security code.\n            Example: 123\n         \n      \n      \n         \nexpiryMonth\n\n         \nString\n\n         \n\n\n         \n            Expiry month for the test card range.\n            Allowed values: \n            \n               \nJANUARY\n\n               \nFEBRUARY\n\n               \nMARCH\n\n               \nAPRIL\n\n               \nMAY\n\n               \nJUNE\n\n               \nJULY\n\n               \nAUGUST\n\n               \nSEPTEMBER\n\n               \nOCTOBER\n\n               \nNOVEMBER\n\n               \nDECEMBER\n\n            \n         \n      \n      \n         \nexpiryYear\n\n         \nString\n\n         \n\n\n         \n            Expiry year for the test card range.\n            Example: 2020\n         \n      \n      \n         \nrangeEnd\n\n         \nString\n\n         \n\n\n         \n            The last test card number in the test card range: \n            \n               \nMin 6, max 19 digits\n\n               \nBIN compliant\n\n            \n            Example: 5432123412344321\n         \n      \n      \n         \nrangeStart\n\n         \nString\n\n         \n\n\n         \n             The first test card number in the test card range:\n            \n               \nMin 6, max 19 digits\n\n               \nBIN compliant\n\n            \n            Example: 5432123412341234\n         \n      \n      \n         \nthreeDUserName\n\n         \nString\n\n         \n\n\n         \n            3D Secure user name details of the cardholder.\n            Example: simonhopper\n         \n      \n      \n         \nthreeDPassword\n\n         \nString\n\n         \n\n\n         \n            3D Secure password details of the cardholder.\n            Example: myPa$$w0rd\n         \n      \n      \n         \nthreeDDirectoryServerResponse\n\n         \nString\n\n         \n\n\n         \n            3D Secure server response. It notifies whether the specified cardholder is enrolled in a 3D Secure service. Possible values:\n            \n               \nY (Authentication available)\n\n               \nN (Card holder not enrolled\/not participating)\n\n               \nU (Unable to authenticate)\n\n            \n         \n      \n   \n\nTestCardRangeCreationResult\nContains a test card range result output.\nFieldTypeRequiredDescription\n\u00a0cardNumberRangeStart\n\n\u00a0String\n\n\n\nThe first test card number in the generated test card range.Example:\u00a05432123412341234\n\n\u00a0cardNumberRangeEnd\n\n\u00a0String\n\n\n\nThe last test card number in the generated test card range.Example:\u00a05432123412344321\n\n\u00a0creationResultCode\n\n\u00a0String\n\n\n\nNotification message. It informs about the outcome of the operation. Possible values:CREATEDALREADY_EXISTSERROR\n","type":"page","locale":"en","boost":16,"hierarchy":{"lvl0":"Home","lvl1":"Development resources","lvl2":"Test cards and credentials","lvl3":"Create test cards","lvl4":"Test cards API reference"},"hierarchy_url":{"lvl0":"https:\/\/docs.adyen.com\/","lvl1":"https:\/\/docs.adyen.com\/development-resources","lvl2":"https:\/\/docs.adyen.com\/development-resources\/test-cards-and-credentials","lvl3":"https:\/\/docs.adyen.com\/development-resources\/test-cards-and-credentials\/create-test-cards","lvl4":"\/development-resources\/test-cards-and-credentials\/create-test-cards\/test-cards-api"},"levels":5,"category":"Development Resources","category_color":"green","tags":["cards","reference"]}}
