---
title: "Test cards API reference"
url: "https://docs.adyen.com/development-resources/test-cards-and-credentials/create-test-cards/test-cards-api"
source_url: "https://docs.adyen.com/development-resources/test-cards-and-credentials/create-test-cards/test-cards-api.md"
canonical: "https://docs.adyen.com/development-resources/test-cards-and-credentials/create-test-cards/test-cards-api"
last_modified: "2020-09-06T22:30:00+02:00"
language: "en"
---

# Test cards API reference

[View source](/development-resources/test-cards-and-credentials/create-test-cards/test-cards-api.md)

To communicate with our API, you submit HTTP requests to applicable endpoints.

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 Adyen payments platform.

This document lists all endpoints that are available for you to integrate with the test platform and run QA checks.

## Requirements

| Requirement         | Description                                                                                                  |
| ------------------- | ------------------------------------------------------------------------------------------------------------ |
| **API credentials** | You must have valid [API credentials](/development-resources/api-credentials) to make requests to endpoints. |

## SOAP endpoints

For the SOAP messaging protocol, all test payment requests must be posted to the following endpoint:

* <https://pal-test.adyen.com/pal/services/TestCard/v1>

The data schema for corresponding SOAP objects is available at:

* <https://pal-test.adyen.com/pal/services/TestCard/v1?wsdl>

## JSON and FORM endpoints

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).

* <https://pal-test.adyen.com/pal/services/TestCard/v1/createTestCardRanges>

### AvsAddress

| Field           | Type    | Required                                                                                    | Description                                                                      |
| --------------- | ------- | ------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- |
| `streetAddress` |  String | ![-white\_check\_mark-](/user/data/smileys/emoji/white_check_mark.png "-white_check_mark-") | Billing address of the cardholder.Example: 1 Infinite Loop, Cupertino            |
| `zip`           |  String |                                                                                             | Zip code associated with the billing address of the cardholder.Example: CA 95014 |

### CreateTestCardRangesRequest

 

| Field             | Type                                                                                                                          | Required                                                                                    | Description                                                                                                           |
| ----------------- | ----------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- |
| `accountCode`     | String                                                                                                                        | ![-white\_check\_mark-](/user/data/smileys/emoji/white_check_mark.png "-white_check_mark-") | The merchant account details used to log in and access the account.                                                   |
| `accountTypeCode` | String                                                                                                                        | ![-white\_check\_mark-](/user/data/smileys/emoji/white_check_mark.png "-white_check_mark-") | The type of account used to make the call.Possible values:- Company
- MerchantAccountThese values are case-sensitive. |
| `testCardRanges`  | Array of [TestCardRange](/development-resources/test-cards-and-credentials/create-test-cards/test-cards-api/#test-card-range) | ![-white\_check\_mark-](/user/data/smileys/emoji/white_check_mark.png "-white_check_mark-") | Contains one or more test card range objects.                                                                         |

### CreateTestCardRangesResult

| Field                  | Type                                                                                                                                                        | Required                                                                                    | Description                                          |
| ---------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ---------------------------------------------------- |
| `rangeCreationResults` | Array of [TestCardRangeCreationResult](/development-resources/test-cards-and-credentials/create-test-cards/test-cards-api/#test-card-range-creation-result) | ![-white\_check\_mark-](/user/data/smileys/emoji/white_check_mark.png "-white_check_mark-") | Contains one or more test card range result outputs. |

### TestCardRange

Defines the properties of a test card range.

| Field                           | Type                                                                                                          | Required                                                                                    | Description                                                                                                                                                                                                                                |
| ------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `address`                       | [AvsAddress](/development-resources/test-cards-and-credentials/create-test-cards/test-cards-api/#avs-address) | ![-white\_check\_mark-](/user/data/smileys/emoji/white_check_mark.png "-white_check_mark-") | 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.                                                               |
| `cardHolderName`                | String                                                                                                        | ![-white\_check\_mark-](/user/data/smileys/emoji/white_check_mark.png "-white_check_mark-") | The name of the cardholder, as it appears on the card, for the test card range.Example: S Hopper                                                                                                                                           |
| `cvc`                           | String                                                                                                        |                                                                                             | The test card range security code.Example: 123                                                                                                                                                                                             |
| `expiryMonth`                   | String                                                                                                        | ![-white\_check\_mark-](/user/data/smileys/emoji/white_check_mark.png "-white_check_mark-") | Expiry month for the test card range.Allowed values:- JANUARY

- FEBRUARY

- MARCH

- APRIL

- MAY

- JUNE

- JULY

- AUGUST

- SEPTEMBER

- OCTOBER

- NOVEMBER

- DECEMBER                                                               |
| `expiryYear`                    | String                                                                                                        | ![-white\_check\_mark-](/user/data/smileys/emoji/white_check_mark.png "-white_check_mark-") | Expiry year for the test card range.Example: 2020                                                                                                                                                                                          |
| `rangeEnd`                      | String                                                                                                        | ![-white\_check\_mark-](/user/data/smileys/emoji/white_check_mark.png "-white_check_mark-") | The last test card number in the test card range:- Min 6, max 19 digits

- BIN compliantExample: 5432123412344321                                                                                                                          |
| `rangeStart`                    | String                                                                                                        | ![-white\_check\_mark-](/user/data/smileys/emoji/white_check_mark.png "-white_check_mark-") | The first test card number in the test card range:- Min 6, max 19 digits

- BIN compliantExample: 5432123412341234                                                                                                                         |
| `threeDUserName`                | String                                                                                                        |                                                                                             | 3D Secure user name details of the cardholder.Example: simonhopper                                                                                                                                                                         |
| `threeDPassword`                | String                                                                                                        |                                                                                             | 3D Secure password details of the cardholder.Example: myPa$$w0rd                                                                                                                                                                           |
| `threeDDirectoryServerResponse` | String                                                                                                        |                                                                                             | 3D Secure server response. It notifies whether the specified cardholder is enrolled in a 3D Secure service. Possible values:- Y (Authentication available)

- N (Card holder not enrolled/not participating)

- U (Unable to authenticate) |

### TestCardRangeCreationResult

Contains a test card range result output.

| Field                   | Type    | Required                                                                                    | Description                                                                                                              |
| ----------------------- | ------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ |
|  `cardNumberRangeStart` |  String | ![-white\_check\_mark-](/user/data/smileys/emoji/white_check_mark.png "-white_check_mark-") | The first test card number in the generated test card range.Example: 5432123412341234                                    |
|  `cardNumberRangeEnd`   |  String | ![-white\_check\_mark-](/user/data/smileys/emoji/white_check_mark.png "-white_check_mark-") | The last test card number in the generated test card range.Example: 5432123412344321                                     |
|  `creationResultCode`   |  String | ![-white\_check\_mark-](/user/data/smileys/emoji/white_check_mark.png "-white_check_mark-") | Notification message. It informs about the outcome of the operation. Possible values:- CREATED
- ALREADY\_EXISTS
- ERROR |
