# API Reference
source: https://developer.mastercard.com/mdes-token-connect/documentation/api-reference/index.md

## APIs {#apis}


API Specification: `https://static.developer.mastercard.com/content/mdes-token-connect/swagger/mdes-token-connect.yaml`

## Push Multiple Funding Account {#push-multiple-funding-account}

Push Multiple Funding Account object contains following parameters

|     Parameter      |                                                                                                                                                                                                                          Description                                                                                                                                                                                                                          |                                                            Type                                                             | Presence  |                Example                |
|--------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------|-----------|---------------------------------------|
| pushAccountId      | The identifier for the account that is being pushed. Should be unique within a PushMultipleAccounts request. Issuer will need to generate a unique pushAccountId for each funding account/financial account for each request and must pass it in the request. Issuers should include the applicable pre-defined value(s) in the pushAccountId: * For Credit Card, Debit Card, Maestro Card - CA * Financial Account - BA <br /> **Max Length:** 36 characters | string                                                                                                                      | Mandatory | 'CA-132d72d4fcb2f4136a0532d3093ff1ab' |
| fundingAccountData | Containing the account information to be provisioned by the token requestor.                                                                                                                                                                                                                                                                                                                                                                                  | [Funding Account](https://developer.mastercard.com/mdes-token-connect/documentation/api-reference/index.md#funding-account) | Mandatory | N/A                                   |

## Funding Account {#funding-account}

Funding Account object contains following parameters

|        Parameter        |                                                                                                                                                                                                                                                                     Description                                                                                                                                                                                                                                                                      |                                                              Type                                                               |                                         Presence                                          |             Example              |
|-------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------|----------------------------------|
| cardAccountData         | Card Account information. This contains data for either credit card or debit card or Maestro card or Private Label Card or Prepaid Card. Please contact Mastercard product team before start pushing Private label card and Prepaid Card.                                                                                                                                                                                                                                                                                                            | [Card Account](https://developer.mastercard.com/mdes-token-connect/documentation/api-reference/index.md#card-account)           | **Conditional** either cardAccountData or financialAccountData must be present            | N/A                              |
| financialAccountData    | Financial Account Information. This contains data for bank account.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | [Financial Account](https://developer.mastercard.com/mdes-token-connect/documentation/api-reference/index.md#financial-account) | **Conditional parameter**, either cardAccountData or financialAccountData must be present | Financial Account Data           |
| accountHolderData       | Cardholder information. This contains information about cardholder like name, address etc                                                                                                                                                                                                                                                                                                                                                                                                                                                            | [Account Holder](https://developer.mastercard.com/mdes-token-connect/documentation/api-reference/index.md#account-holder)       | Optional                                                                                  | N/A                              |
| dataValidUntilTimestamp | The date/time after which this encrypted payload object is considered invalid. If present, all systems must reject this encrypted object after this time and treat it as invalid data. Must be a value no more than 30 days in the future. Mastercard recommends using a value of (CurrentTime + 30 minutes). **Max length:** 29. Must be expressed in ISO 8601 extended format as one of the following: \*\* YYYY-MM-DDThh:mm:ss\[.sss\]Z \*\* and \*\* YYYY-MM-DDThh:mm:ss\[.sss\]±hh:mm \*\* where \[.sss\] is optional and can be 1 to 3 digits. | String                                                                                                                          | Optional                                                                                  | '2019-07-04T12:09:56.123-07:00Z' |

## Card Account {#card-account}

Card Account object contains following parameters

|   Parameter   |                                                                                                    Description                                                                                                     |  Type  | Presence  |      Example       |
|---------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------|-----------|--------------------|
| accountNumber | The Account Primary Account Number of the card to be digitized. **Max length:** 19 - **Min length:** 9. **Data Type:** String (Numeric)                                                                            | string | Mandatory | '5123456789012345' |
| expiryMonth   | The month of the expiration date of the card to be digitized. Note: the expiry date may not be in the past. May be omitted if the card does not have an expiry date. **Length:** 2 **Data Type:** String (Numeric) | string | Optional  | '12'               |
| expiryYear    | The year of the expiration date of the card to be digitized. Note: the expiry date may not be in the past. May be omitted if the card does not have an expiry date. **Length:** 2 **Data Type:** String (Numeric)  | string | Optional  | '21'               |

## Financial Account {#financial-account}

Financial Account object contains following parameters

|         Parameter          |                                                                                                      Description                                                                                                       |  Type  | Presence  |      Example       |
|----------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------|-----------|--------------------|
| financialAccountId         | The identifier of the financial account being tokenized. This could be a bank account number or other types of financial accounts. **Max length:** 64 - **Min length:** 9. **Data Type:** String (spaces not allowed). | string | Mandatory | '5123456789012345' |
| interbankCardAssociationId | The identifier (ICA) assigned by Mastercard to the financial institution. **Max length:** 11 - **Min length:** 3. **Data Type:** String (Numeric).                                                                     | string | Mandatory | '1234'             |
| countryCode                | The country of the financial account. Expressed as a 3-letter (alpha-3) country code as defined in ISO 3166-1. **Length:** 3                                                                                           | string | Mandatory | GBR                |

## Account Holder {#account-holder}

Account Holder object contains following parameters

|           Parameter            |                                                Description                                                 |                                                         Type                                                          | Presence |                        Example                        |
|--------------------------------|------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------|----------|-------------------------------------------------------|
| accountHolderName              | The name of the account holder in the format LASTNAME/FIRSTNAME or FIRSTNAME LASTNAME. **Max length:** 27. | string                                                                                                                | Optional | John Doe                                              |
| accountHolderAddress           | Billing Address of account holder                                                                          | Billing Address                                                                                                       | Optional | N/A                                                   |
| accountHolderEmailAddress      | The e-mail address of the account holder. **Max length:** 320.                                             | string                                                                                                                | Optional | '[john.doe@anymail.com](mailto:john.doe@anymail.com)' |
| accountHolderMobilePhoneNumber | Phone Number of account holder                                                                             | [Phone Number](https://developer.mastercard.com/mdes-token-connect/documentation/api-reference/index.md#phone-number) | Optional | N/A                                                   |

## Billing Address {#billing-address}

Billing Address object contains following parameters

|     Parameter      |                                                        Description                                                         |  Type  | Presence  |     Example      |
|--------------------|----------------------------------------------------------------------------------------------------------------------------|--------|-----------|------------------|
| line1              | First line of the billing address. **Max length:** 64.                                                                     | string | optional  | '100 1st Street' |
| line1              | Second line of the billing address. **Max length:** 64.                                                                    | string | optional  | 'Apt. 4B'        |
| city               | The city of the billing address. **Max length:** 32.                                                                       | string | optional  | 'St. Louis'      |
| countrySubdivision | The country subdivision (for example, the state in the U.S.) of the billing address. **Max length:** 12.                   | string | optional  | 'MO'             |
| postalCode         | The postal code (for example, zipcode in the U.S.) of the billing address. **Max length:** 16.                             | string | optional  | '61000'          |
| country            | The country of the Billing Address. Expressed as a 3-letter (alpha-3) country code as defined in ISO 3166-1. **Length:** 3 | string | Mandatory | USA              |

## Phone Number {#phone-number}

Phone Number object contains following parameters

|     Parameter     |                                                                             Description                                                                             |  Type  | Presence  |   Example    |
|-------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------|-----------|--------------|
| countryDialInCode | The international dial-in prefix code associated with the country. For instance: "1" for USA, "44" for UK, etc. **Max length:** 4. **Data Type:** String (Numeric). | string | Mandatory | '1'          |
| phoneNumber       | The Phone number to be dialed after the international prefix -- hence, excluding any domestic prefix if any. **Max length:** 20. **Data Type:** String (Numeric).   | String | Mandatory | '7181234567' |

