# Endpoint Guide API
source: https://developer.mastercard.com/cross-border-services/documentation/api-ref/value-added-services/endpoint-guide-adapter_api/index.md

Alert: If you are a Customer contracted with MTS EU or MTS UK, refer to the corresponding EU and UK specification inside the swagger file to ensure compliance with the relevant jurisdiction based Regulatory Technical Standards (either EU or UK) derived from the Revised Payment Services Directive (PSD2).

The Endpoint Guide API serves as a comprehensive reference for retrieving configuration and operational details across all payment corridors. It provides structured information on both mandatory and optional request parameters, tailored to specific endpoint attributes such as destination currency, destination country, payment instrument, and payment type.

The API categorizes data into:

1. Core data: Core request fields to be provided in the payment/quote request.
2. Additional data: Optional or conditional fields required by the system for successful transaction processing or compliance and regulatory purposes.

This design ensures that integrators and partners can dynamically adapt their requests based on corridor-specific requirements, improving accuracy and reducing integration effort.
Tip: The API call should not be integrated in the Payment API. It is recommended to cache the endpoint guide specifications and refresh them once a week for better system performance. For any upcoming updates, please refer to the **Customer Notice** for **Payout Service Updates** to determine any additional refresh needed.

## Environment Domains {#environment-domains}

* Sandbox/MTF
* Sandbox-EU
* Sandbox-UK
* MTF-EU
* MTF-UK
* Production
* Production-EU
* Production-UK

```Sandbox/MTF
https://sandbox.api.mastercard.com/crossborder/endpoint-guide/specifications?payment_type={payment_type}&destination_country={destination_country}&destination_currency={destination_currency}&destination_payment_instrument={destination_payment_instrument}
```

```Sandbox-EU
https://sandbox.api.mastercard.eu/crossborder/endpoint-guide/specifications?payment_type={payment_type}&destination_country={destination_country}&destination_currency={destination_currency}&destination_payment_instrument={destination_payment_instrument}
```

```Sandbox-UK
https://sandbox.api.mastercard.uk/crossborder/endpoint-guide/specifications?payment_type={payment_type}&destination_country={destination_country}&destination_currency={destination_currency}&destination_payment_instrument={destination_payment_instrument}
```

```MTF-EU
https://mtf.api.xbs.mastercard.eu/crossborder/endpoint-guide/specifications?payment_type=B2P&destination_country=USA&destination_currency=USD&destination_payment_instrument=BANK
```

```MTF-UK
https://mtf.api.xbs.mastercard.uk/crossborder/endpoint-guide/specifications?payment_type=B2P&destination_country=USA&destination_currency=USD&destination_payment_instrument=BANK
```

```Production
https://api.mastercard.com/crossborder/endpoint-guide/specifications?payment_type={payment_type}&destination_country={destination_country}&destination_currency={destination_currency}&destination_payment_instrument={destination_payment_instrument}
```

```Production-EU
https://api.mastercard.eu/crossborder/endpoint-guide/specifications?payment_type={payment_type}&destination_country={destination_country}&destination_currency={destination_currency}&destination_payment_instrument={destination_payment_instrument}
```

```Production-UK
https://api.mastercard.uk/crossborder/endpoint-guide/specifications?payment_type={payment_type}&destination_country={destination_country}&destination_currency={destination_currency}&destination_payment_instrument={destination_payment_instrument}
```

Note:   

* **Sandbox** and **MTF** environments share the same URL but are differentiated by partner ID.
* In the Sandbox environment, the technical rules are governed by generic endpoints setup.
* This API provides the specific rules for the given corridor after the customer has been onboarded.
* Hence, there is a possibility of differences in the rules across Sandbox and MTF environments.

## API {#api}

[Open Specification](https://static.developer.mastercard.com/content/cross-border-services/swagger/cross_border-swagger.yaml)

API Reference: `GET /crossborder/endpoint-guide/specifications`

* **Formats supported**: JSON
* **HTTP Version**: 1.0/ 1.1
* **Required HTTP header parameters** :   
  content-type : Format of the inbound content being submitted. example: application/json   
  accept: Format of the inbound content being submitted. example: application/json   
  X-Mc-Correlation-Id : A unique correlation ID for tracking the request.   
  Partner-Ref-Id : A unique reference ID of the business partner.

## API Convention {#api-convention}

Take a look at the [API Conventions](https://developer.mastercard.com/cross-border-services/documentation/api-basics/index.md#api-conventions) for general guidelines.

## Payload Encryption {#payload-encryption}

All the request payload sent by you to Mastercard must be encrypted. And you will need to decrypt the payload sent by Mastercard.   

For more detailed information on payload **Encryption/ Decryption** , please see [here](https://developer.mastercard.com/cross-border-services/documentation/api-basics/index.md#transport-encryption)

## Next step {#next-step}

Proceed to [Sandbox Testing](https://developer.mastercard.com/cross-border-services/documentation/testing/endpoint-guide-adapter_api/index.md) to test the Endpoint Guide API in the Sandbox environment.