# Mastercard Send Account Information Service
source: https://developer.mastercard.com/mastercard-send-account-info/documentation/index.md

## Overview {#overview}

The [Mastercard Send](https://developer.mastercard.com/product/mastercard-send/) Account Information Service enables Originating Institutions and Transaction Initiators to validate the eligibility of sending/receiving card accounts, and get card details, **before** initiating funding transactions or payment transactions (person-to-person payments or disbursements) with those card accounts.

![Mastercard Send Account Info overview](https://static.developer.mastercard.com/content/mastercard-send-account-info/documentation/img/mastercard-send-account-info-overview.png)

The service helps create a positive consumer experience:

* It ensures the consumer account is eligible for funds transfers (eliminates false hope).
* Validations are performed against configured controls for compliance with program requirements.
* The returned card information can be used to enrich the funds transfer app interface and inform the user (consumer), such as showing them the estimated funds availability when receiving transfers.

See [the product page](https://developer.mastercard.com/product/mastercard-send/) for marketing and case study details.
Note: This optional service can be used to enhance a Mastercard Send transfer solution. Additional fees might apply for using this service, as set forth in the *Mastercard Consolidated Billing System* manual generated by the Pricing Guide tool in the Pricing and Billing Resource Center on [Mastercard Connect](https://www.mastercardconnect.com/) or otherwise communicated by Mastercard to the Program Participant.

## How It Works {#how-it-works}

You (as an Originating Institution or Transaction Initiator) make an **Account Info** API call (PUT request) for each card account. For example, you could make API calls when a card account is first captured (e.g. during consumer registration or when added to your app) and again before submitting a funding/payment request, as shown below (step 2). You could check:

* A sending account's sending eligibility (funding eligibility) before requesting a Funding Transaction
* A receiving account's receiving eligibility before requesting a Payment Transaction

<br />

Person-to-person (P2P) payment example:

![Mastercard Send Account Info how it works](https://static.developer.mastercard.com/content/mastercard-send-account-info/documentation/img/mastercard-send-account-info-how-it-works.png)

The API response (step 3) will provide both sending and receiving eligibility for the card account, see [Eligibility](https://developer.mastercard.com/mastercard-send-account-info/documentation/code-and-formats/index.md). You can use the API response information to determine app functionality, such as whether to proceed with the transfer flow, and provide details to the sender (step 4).

### API Requests {#api-requests}

#### Aliases and tokenized PANs {#aliases-and-tokenized-pans}

Depending on your implementation, you can use different types of aliases in your API requests to identify card accounts (Account URIs), such as:

* PANs and tokenized PANs
* Accounts registered in the Mastercard Send Consumer Mapping service
* Temporary tokens for card accounts captured using the Mastercard Send Lightbox service

You supply the alias using the appropriate schema, see [Account URIs](https://developer.mastercard.com/mastercard-send-account-info/documentation/code-and-formats/index.md#account-uris).

#### Checking the intended transfer amount {#checking-the-intended-transfer-amount}

Your API request can include the intended amount of the funding and/or payment transfer in the optional `amount` and `currency` fields. If you provide the amount, Mastercard Send will validate it against the configured network limit amounts.

#### Identifying whether a transfer is domestic or cross-border {#identifying-whether-a-transfer-is-domestic-or-cross-border}

The service will determine the checked card account's receiving eligibility based on the card issuer's acceptance of domestic or cross border MoneySend payment and/or Visa OCT. To assist this determination, your API request can include an optional `origination_country` field identifying the country where the funding and/or payment is originating:

* When the field is present, if its value matches the account's institution country, receiving eligibility will be based on the issuer's **domestic** enablement indicator for MoneySend or Visa OCT. Otherwise, receiving eligibility will be based on the issuer's **cross border** enablement indicator for MoneySend or Visa OCT.
* When the field is not present, Mastercard Send will use the country configured for you or your Sponsor OI (depending on your implementation) and base the receiving eligibility on the domestic or cross border enablement indicator as per the logic above.

#### Requesting an enhanced response {#requesting-an-enhanced-response}

Your API request can include an optional `enhanced_response` field with a value of 'true' or 'false':

* When the field is present and its value is 'true', the response will always include card attributes.\*

* When the field is not present or its value is 'false':

  * If sending and/or receiving eligibility are 'true', the response will include card attributes.
  * If both sending and receiving eligibility are 'false', the response will **not** include card attributes.

*\* The account must be a valid card account. If the BIN or account range does not exist on a network, card attributes will not be available in the response.*

### API Responses {#api-responses}

The Account Information Service retrieves the following information about the card account and returns it in the API response:

* Sending eligibility (funding eligibility) --- is the account allowed to send/fund a transfer?
* Receiving eligibility --- is the account allowed to receive a transfer?
* Account type, e.g. credit, debit, prepaid
* Account brand, e.g. Mastercard
* Estimated funds availability time frame after receiving a payment transaction, e.g. immediate, next business day (timing driven by Receive Network and issuer)
* Product type: consumer or commercial
* Name and country of the Financial Institution associated with the account
* Currency of cardholder's account statement --- This will be the default cardholder billing currency configured by the issuer (there may be additional currencies configured for an account), see [Default cardholder billing currency](https://developer.mastercard.com/mastercard-send-account-info/documentation/index.md#default-cardholder-billing-currency) below.

#### Understanding eligibility {#understanding-eligibility}

See [Eligibility](https://developer.mastercard.com/mastercard-send-account-info/documentation/code-and-formats/index.md).

#### Default cardholder billing currency {#default-cardholder-billing-currency}

The cardholder billing currency provided in the API response is what the issuer has configured in Mastercard systems as its Default Currency. Issuers have the option to provide other Currency Pairs, but the Account Information service does not currently expose this data. To get these additional currency details, participants can refer to the Mastercard Parameter Extract (MPE) and Financial Institution Table (FIT). However, participants should be aware that the accuracy of these details depends on the information the issuer provided to Mastercard.
Note: A successful response from the Account Information API service does not guarantee that the funding issuer or receiving issuer (Receiving Institution) will approve the funding/payment transaction. Other factors, such as transaction limits and the issuer's compliance and fraud checks, may cause it to decline a transaction.

### Additional Resources {#additional-resources}

* **Customer Portal** ---The Mastercard Move: Send Customer Portal is a near real‑time, self‑service tool to search transactions and download reconciliation reports for your Mastercard Send activity. You can look up financial and non‑financial transactions using multiple search filters, export results, and view transaction details and API payloads. The portal enables you to research and validate transactions quickly, helping you assist your consumers without needing Mastercard Support. See [Customer Portal](https://developer.mastercard.com/mastercard-send/documentation/customer-site/).

* **API changes and announcements** ---We provide advance notice of changes to the APIs. There may also be Mastercard announcements that impact Mastercard Send API customers. See [Release History](https://developer.mastercard.com/mastercard-send-account-info/documentation/release-history/index.md).

## Getting Started {#getting-started}

### Before You Start {#before-you-start}

* **Sandbox**---This service has a Sandbox environment with mock APIs, enabling you to try the APIs quickly before registering as a Program Participant.

* **Registration** ---To use the full service, you must become a Mastercard Send Program Participant, which involves registering for the required programs and services (including the Account Information service) and meeting program eligibility requirements; see [Mastercard Send Registration and Eligibility](https://developer.mastercard.com/mastercard-send/documentation/send-eligibility/). You will not be able to use the Account Information APIs in the Mastercard Test Facility (MTF) or Production environments until your organization is approved as a Mastercard Send Program Participant and has onboarded to, and been set up for, this service.

<!-- -->

* **Region availability** ---This API service is available in most markets. [Contact us](mailto:digital.support@mastercard.com) for pricing and region information.

### Good to Know {#good-to-know}

* The Account Information service is an additional service that is meant to be used with the main Mastercard Send [Person-to-Person](https://developer.mastercard.com/mastercard-send-person-to-person/documentation/), [Disbursements](https://developer.mastercard.com/mastercard-send-disbursements/documentation/), and/or [Funding](https://developer.mastercard.com/mastercard-send-funding/documentation/) services to enhance the funds transfer flow. You are likely to integrate and test with this service at the same time as the main funding/payment service, and you access these services using the same **Mastercard Send** API service (shown below), which you select when creating your API project. This means you can use the **same** project and authentication keys for the Account Information service and the main funding/payment service.

  ![Service dropdown select Send](https://static.developer.mastercard.com/content/mastercard-send-account-info/documentation/img/select-api-send.png)

  If you choose to implement the Account Information service after launching your solution with the main services, you will need to ask your Mastercard representative or Account Manager to subscribe you to this service and initiate a new CIS implementation project; see [Implementing additional services](https://developer.mastercard.com/mastercard-send/documentation/implementation/#implementing-additional-services).

  If you intend to use multiple Mastercard API services, such as Mastercard Send and Mastercard Cross-Border Services, you can add them to the same Mastercard Developers project and use the same keys and credentials to access the APIs. [Follow this guidance](https://developer.mastercard.com/mastercard-send/documentation/implementation/getting-started/#adding-a-new-service-to-an-existing-project).
* When you have registered for this service and are ready to use the MTF environment, you must copy the Sandbox Consumer Key shown on your project page's Sandbox credentials panel (masked example shown below) and provide it to your Mastercard Delivery Manager (assigned to you during onboarding), identifying your project and that the key is for the MTF environment. It can take 5-7 business days for Mastercard to configure the MTF environment for your keys. Mastercard will notify you when you can start making API calls to that environment.

  ![Example consumer key](https://static.developer.mastercard.com/content/mastercard-send-account-info/documentation/img/new-consumer-key.png)

  You must also do this for your Production Consumer Key when you have requested Production access for your project (by clicking **Request Production Access** in your project page).
* When you register as a Mastercard Send Program Participant, you will be given a unique Partner Reference ID. Use this for the `partnerId` portion of the endpoint URL for the MTF and Production APIs.

* If your solution will also use the Mastercard Send [Account Verification Service](https://developer.mastercard.com/mastercard-send-avs/documentation/) (AVS), to perform real-time card account checks with issuers, we recommend making the Account Information API call before the AVS API call.

## Next Steps {#next-steps}

Start with [API Basics](https://developer.mastercard.com/mastercard-send-account-info/documentation/api-basics/index.md) for information about API security and keys, how to use the APIs, and the different API environments that are available. Then set up a project and try the Sandbox APIs. For additional guidance, see [Tutorials and Guides](https://developer.mastercard.com/mastercard-send-account-info/documentation/tutorials-and-guides/index.md).

For examples of how the API service could be used in a funds transfer flow, see [Use Cases](https://developer.mastercard.com/mastercard-send-account-info/documentation/use-cases/index.md).

Your Mastercard representative can provide more information about this service. [Don't have a Mastercard representative?](https://developer.mastercard.com/mastercard-send-account-info/documentation/support/index.md)