Mastercard

Mastercard Health Checks API

The Health Checks API from Mastercard — 1 operation(s) for health checks.

Documentation GitHub OpenAPI

Documentation

https://developer.mastercard.com/mastercard-id-for-tp/documentation/api-reference/

https://developer.mastercard.com/mastercard-id-for-idp/documentation/api-reference/

https://developer.mastercard.com/doconomy-aland-index/documentation/getting-started/

https://developer.mastercard.com/doconomy-aland-index/documentation/api-basics/#authentication

https://developer.mastercard.com/doconomy-aland-index/documentation/api-reference/

https://developer.mastercard.com/ethoca-alerts-for-merchants/documentation/api-reference/

https://developer.mastercard.com/ethoca-consumer-clarity-for-merchants/documentation/getting-started/

https://developer.mastercard.com/ethoca-consumer-clarity-for-merchants/documentation/api-basics/authentication-and-encryption/#authentication

https://developer.mastercard.com/ethoca-consumer-clarity-for-merchants/documentation/api-reference/

https://developer.mastercard.com/merchant-self-services/documentation/api-reference/

https://developer.mastercard.com/fld-suspected-fraud/documentation/api-basics/#authentication

https://developer.mastercard.com/fld-suspected-fraud/documentation/api-reference/

https://developer.mastercard.com/fld-fraud-submission/documentation/api-basics/#authentication

https://developer.mastercard.com/fld-fraud-submission/documentation/api-reference/

https://developer.mastercard.com/identity-insights-for-accounts/documentation/api-reference/

https://developer.mastercard.com/identity-insights-for-transactions/documentation/api-reference/

https://developer.mastercard.com/in-control-for-mobile-payments/documentation/api-reference/

https://developer.mastercard.com/unified-installments/documentation/api-basics/#authentication

https://developer.mastercard.com/unified-installments/documentation/api-reference/

https://developer.mastercard.com/locations-merchants/documentation/quick-start-guide/

https://developer.mastercard.com/locations-merchants/documentation/api-reference/

https://developer.mastercard.com/locations/documentation/quick-start-guide/

https://developer.mastercard.com/locations/documentation/api-reference/

https://developer.mastercard.com/donations/documentation/getting-started/

https://developer.mastercard.com/donations/documentation/api-reference/

https://developer.mastercard.com/mastercard-insurance-programs/documentation/api-basics/#authentication

https://developer.mastercard.com/mastercard-insurance-programs/documentation/api-reference/

https://developer.mastercard.com/card-issuance/documentation/getting-started/

https://developer.mastercard.com/card-issuance/documentation/api-basics/#authentication

https://developer.mastercard.com/traditional-fulfillment-service/documentation/api-reference/

https://developer.mastercard.com/user-account-management-service/documentation/api-reference/

Specifications

https://raw.githubusercontent.com/api-evangelist/mastercard/refs/heads/main/openapi/mastercard-health-checks-api-openapi.yml

Code Examples

https://developer.mastercard.com/mastercard-id-for-tp/documentation/postman-collection/

https://developer.mastercard.com/mastercard-id-for-tp/documentation/reference-app/

https://developer.mastercard.com/mastercard-id-for-idp/documentation/reference-app/

https://developer.mastercard.com/doconomy-aland-index/documentation/reference-app/

https://developer.mastercard.com/doconomy-aland-index/documentation/postman-collection/

https://developer.mastercard.com/ethoca-alerts-for-merchants/documentation/reference-app/

https://developer.mastercard.com/ethoca-consumer-clarity-for-merchants/documentation/reference-app/

https://developer.mastercard.com/merchant-self-services/documentation/reference-app/

https://developer.mastercard.com/merchant-self-services/documentation/postman-collection/

https://developer.mastercard.com/fld-suspected-fraud/documentation/reference-app/

https://developer.mastercard.com/fld-fraud-submission/documentation/reference-app/

https://developer.mastercard.com/identity-insights-for-accounts/documentation/reference-app/

https://developer.mastercard.com/identity-insights-for-accounts/documentation/postman-collections/

https://developer.mastercard.com/identity-insights-for-transactions/documentation/reference-app/

https://developer.mastercard.com/identity-insights-for-transactions/documentation/postman-collection/

https://developer.mastercard.com/in-control-for-mobile-payments/documentation/reference-app/

https://developer.mastercard.com/unified-installments/documentation/reference-app/

https://developer.mastercard.com/unified-installments/documentation/postman-collection/

https://developer.mastercard.com/locations-merchants/documentation/integration-and-testing/#insomnia

https://developer.mastercard.com/locations-merchants/documentation/integration-and-testing/#postman

https://developer.mastercard.com/locations-merchants/documentation/reference-app/

https://developer.mastercard.com/locations/documentation/integration-and-testing/#insomnia

https://developer.mastercard.com/locations/documentation/integration-and-testing/#postman

https://developer.mastercard.com/locations/documentation/reference-app/

https://developer.mastercard.com/donations/documentation/reference_app/

https://developer.mastercard.com/donations/documentation/postman-collection/

https://developer.mastercard.com/card-issuance/documentation/reference-app/

https://developer.mastercard.com/traditional-fulfillment-service/documentation/reference-app/

https://developer.mastercard.com/traditional-fulfillment-service/documentation/postman-collection/

https://developer.mastercard.com/user-account-management-service/documentation/reference-app/

Other Resources

https://developer.mastercard.com/mastercard-id-for-tp/documentation/api-basics/#api-security

https://developer.mastercard.com/mastercard-id-for-tp/documentation/api-basics/#encryption

https://developer.mastercard.com/mastercard-id-for-tp/documentation/api-basics/#environments

https://developer.mastercard.com/mastercard-id-for-tp/documentation/use-cases/

https://developer.mastercard.com/mastercard-id-for-tp/documentation/tutorials-and-guides/

https://developer.mastercard.com/mastercard-id-for-tp/documentation/code-and-formats/

https://developer.mastercard.com/mastercard-id-for-tp/documentation/release-history/

https://developer.mastercard.com/mastercard-id-for-tp/documentation/support/#faqs

https://developer.mastercard.com/mastercard-id-for-tp/documentation/support/#get-help

https://developer.mastercard.com/mastercard-id-for-idp/documentation/api-basics/#api-security

https://developer.mastercard.com/mastercard-id-for-idp/documentation/

https://developer.mastercard.com/mastercard-id-for-idp/documentation/api-basics/#environments

https://developer.mastercard.com/mastercard-id-for-idp/documentation/use-cases/

https://developer.mastercard.com/mastercard-id-for-idp/documentation/tutorials-and-guides/

https://developer.mastercard.com/mastercard-id-for-idp/documentation/code-and-formats/

https://developer.mastercard.com/mastercard-id-for-idp/documentation/release-history/

https://developer.mastercard.com/mastercard-id-for-idp/documentation/support/#faqs

https://developer.mastercard.com/mastercard-id-for-idp/documentation/support/#help

https://developer.mastercard.com/doconomy-aland-index/documentation/api-basics/#environments

https://developer.mastercard.com/doconomy-aland-index/documentation/use-cases/

https://developer.mastercard.com/doconomy-aland-index/documentation/tutorials-and-guides/

https://developer.mastercard.com/doconomy-aland-index/documentation/code-and-formats/

https://developer.mastercard.com/doconomy-aland-index/documentation/support/#faqs

https://developer.mastercard.com/doconomy-aland-index/documentation/support/#get-help

https://developer.mastercard.com/ethoca-alerts-for-merchants/documentation/announcements/

https://developer.mastercard.com/ethoca-alerts-for-merchants/documentation/api-basics/#api-security

https://developer.mastercard.com/ethoca-alerts-for-merchants/documentation/api-basics/#environments

https://developer.mastercard.com/ethoca-alerts-for-merchants/documentation/tutorials-and-guides/

https://developer.mastercard.com/ethoca-alerts-for-merchants/documentation/use-cases/

https://developer.mastercard.com/ethoca-alerts-for-merchants/documentation/code-and-formats/

https://developer.mastercard.com/ethoca-alerts-for-merchants/documentation/testing/

https://developer.mastercard.com/ethoca-alerts-for-merchants/documentation/testing/#test-data

https://developer.mastercard.com/ethoca-alerts-for-merchants/documentation/release-history/

https://developer.mastercard.com/ethoca-alerts-for-merchants/documentation/support/#faq

https://developer.mastercard.com/ethoca-alerts-for-merchants/documentation/support/#get-help

https://developer.mastercard.com/ethoca-consumer-clarity-for-merchants/documentation/announcements/

https://developer.mastercard.com/ethoca-consumer-clarity-for-merchants/documentation/api-basics/authentication-and-encryption/#encryption

https://developer.mastercard.com/ethoca-consumer-clarity-for-merchants/documentation/use-cases/

https://developer.mastercard.com/ethoca-consumer-clarity-for-merchants/documentation/tutorials-and-guides/

https://developer.mastercard.com/ethoca-consumer-clarity-for-merchants/documentation/code-and-formats/

https://developer.mastercard.com/ethoca-consumer-clarity-for-merchants/documentation/testing/

https://developer.mastercard.com/ethoca-consumer-clarity-for-merchants/documentation/release-history/

https://developer.mastercard.com/ethoca-consumer-clarity-for-merchants/documentation/support/#faq

https://developer.mastercard.com/ethoca-consumer-clarity-for-merchants/documentation/support/#get-help

https://developer.mastercard.com/merchant-self-services/documentation/announcements/

https://developer.mastercard.com/merchant-self-services/documentation/api-basics/#api-security

https://developer.mastercard.com/merchant-self-services/documentation/api-basics/#environments

https://developer.mastercard.com/merchant-self-services/documentation/use-cases/

https://developer.mastercard.com/merchant-self-services/documentation/tutorials-and-guides/

https://developer.mastercard.com/merchant-self-services/documentation/code-and-formats/

https://developer.mastercard.com/merchant-self-services/documentation/testing/

https://developer.mastercard.com/merchant-self-services/documentation/release-history/

https://developer.mastercard.com/merchant-self-services/documentation/support/#faq

https://developer.mastercard.com/merchant-self-services/documentation/support/#get-help

https://developer.mastercard.com/fld-suspected-fraud/documentation/api-basics/#encryption

https://developer.mastercard.com/fld-suspected-fraud/documentation/api-basics/#environment-descriptions

https://developer.mastercard.com/fld-suspected-fraud/documentation/use-cases/

https://developer.mastercard.com/fld-suspected-fraud/documentation/tutorials/

https://developer.mastercard.com/fld-suspected-fraud/documentation/code-and-formats/

https://developer.mastercard.com/fld-suspected-fraud/documentation/support/#faq

https://developer.mastercard.com/fld-suspected-fraud/documentation/support/#get-help

https://developer.mastercard.com/fld-fraud-submission/documentation/announcements/

https://developer.mastercard.com/fld-fraud-submission/documentation/api-basics/#encryption

https://developer.mastercard.com/fld-fraud-submission/documentation/api-basics/#environment-descriptions

https://developer.mastercard.com/fld-fraud-submission/documentation/use-cases/

https://developer.mastercard.com/fld-fraud-submission/documentation/use-cases/testing/

https://developer.mastercard.com/fld-fraud-submission/documentation/tutorials/

https://developer.mastercard.com/fld-fraud-submission/documentation/code-and-formats/

https://developer.mastercard.com/fld-fraud-submission/documentation/support/#faq

https://developer.mastercard.com/fld-fraud-submission/documentation/support/#get-help

https://developer.mastercard.com/identity-insights-for-accounts/documentation/announcements/

https://developer.mastercard.com/identity-insights-for-accounts/documentation/api-basics/#api-security

https://developer.mastercard.com/identity-insights-for-accounts/documentation/api-basics/#environments

https://developer.mastercard.com/identity-insights-for-accounts/documentation/use-cases/

https://developer.mastercard.com/identity-insights-for-accounts/documentation/tutorials-and-guides/

https://developer.mastercard.com/identity-insights-for-accounts/documentation/code-and-formats/

https://developer.mastercard.com/identity-insights-for-accounts/documentation/testing/

https://developer.mastercard.com/identity-insights-for-accounts/documentation/support/#faq

https://developer.mastercard.com/identity-insights-for-accounts/documentation/support/#get-help

https://developer.mastercard.com/identity-insights-for-transactions/documentation/announcements/

https://developer.mastercard.com/identity-insights-for-transactions/documentation/api-basics/#api-security

https://developer.mastercard.com/identity-insights-for-transactions/documentation/api-basics/#environments

https://developer.mastercard.com/identity-insights-for-transactions/documentation/use-cases/

https://developer.mastercard.com/identity-insights-for-transactions/documentation/tutorials-and-guides/

https://developer.mastercard.com/identity-insights-for-transactions/documentation/code-and-formats/

https://developer.mastercard.com/identity-insights-for-transactions/documentation/testing/

https://developer.mastercard.com/identity-insights-for-transactions/documentation/release-history/

https://developer.mastercard.com/identity-insights-for-transactions/documentation/support/#faq

https://developer.mastercard.com/identity-insights-for-transactions/documentation/support/#get-help

https://developer.mastercard.com/in-control-for-mobile-payments/documentation/api-basics/#api-security

https://developer.mastercard.com/in-control-for-mobile-payments/documentation/api-basics/#environments

https://developer.mastercard.com/in-control-for-mobile-payments/documentation/use-cases/

https://developer.mastercard.com/in-control-for-mobile-payments/documentation/tutorials-and-guides/

https://developer.mastercard.com/in-control-for-mobile-payments/documentation/testing/

https://developer.mastercard.com/in-control-for-mobile-payments/documentation/code-and-formats/

https://developer.mastercard.com/in-control-for-mobile-payments/documentation/support/#frequently-asked-questions

https://developer.mastercard.com/in-control-for-mobile-payments/documentation/support/#get-help

https://developer.mastercard.com/in-control-for-mobile-payments/documentation/glossary/

https://developer.mastercard.com/unified-installments/documentation/release-history/

https://developer.mastercard.com/unified-installments/documentation/api-basics/#api-security

https://developer.mastercard.com/unified-installments/documentation/api-basics/#encryption

https://developer.mastercard.com/unified-installments/documentation/api-basics/#environments

https://developer.mastercard.com/unified-installments/documentation/use-cases/mastercard-installments-program-with-merchant-participation/

https://developer.mastercard.com/unified-installments/documentation/tutorials-and-guides/

https://developer.mastercard.com/unified-installments/documentation/code-and-formats/

https://developer.mastercard.com/unified-installments/documentation/testing/

https://developer.mastercard.com/unified-installments/documentation/support/

https://developer.mastercard.com/locations-merchants/documentation/api-basics/#api-security

https://developer.mastercard.com/locations-merchants/documentation/api-basics/#environments

https://developer.mastercard.com/locations-merchants/documentation/integration-and-testing/

https://developer.mastercard.com/locations-merchants/documentation/integration-and-testing/#sandbox-test-data

https://developer.mastercard.com/locations-merchants/documentation/use-cases/

https://developer.mastercard.com/locations-merchants/documentation/code-and-formats/

https://developer.mastercard.com/locations-merchants/documentation/support/#faq

https://developer.mastercard.com/locations-merchants/documentation/support/#get-help

https://developer.mastercard.com/locations-merchants/documentation/announcements/

https://developer.mastercard.com/locations-merchants/documentation/release-history/

https://developer.mastercard.com/locations/documentation/api-basics/#api-security

https://developer.mastercard.com/locations/documentation/api-basics/#environments

https://developer.mastercard.com/locations/documentation/integration-and-testing/

https://developer.mastercard.com/locations/documentation/integration-and-testing/#sandbox-test-data

https://developer.mastercard.com/locations/documentation/use-cases/

https://developer.mastercard.com/locations/documentation/code-and-formats/

https://developer.mastercard.com/locations/documentation/support/#faq

https://developer.mastercard.com/locations/documentation/support/#get-help

https://developer.mastercard.com/locations/documentation/announcements/

https://developer.mastercard.com/locations/documentation/release-history/

https://developer.mastercard.com/donations/documentation/use-cases/

https://developer.mastercard.com/donations/documentation/api-basics/#environment-descriptions

https://developer.mastercard.com/donations/documentation/code-and-formats/

https://developer.mastercard.com/donations/documentation/support/#faqs

https://developer.mastercard.com/donations/documentation/support/#get-help

https://developer.mastercard.com/donations/documentation/support/#guides

https://developer.mastercard.com/donations/documentation/tutorials/

https://developer.mastercard.com/mastercard-insurance-programs/documentation/api-basics/#encryption

https://developer.mastercard.com/mastercard-insurance-programs/documentation/api-basics/#environments

https://developer.mastercard.com/mastercard-insurance-programs/documentation/use-cases/

https://developer.mastercard.com/mastercard-insurance-programs/documentation/tutorials-and-guides/

https://developer.mastercard.com/mastercard-insurance-programs/documentation/code-and-formats/

https://developer.mastercard.com/mastercard-insurance-programs/documentation/testing/

https://developer.mastercard.com/mastercard-insurance-programs/documentation/support/#faq

https://developer.mastercard.com/mastercard-insurance-programs/documentation/support/#get-help

https://developer.mastercard.com/card-issuance/documentation/getting-started/#glossary

https://developer.mastercard.com/card-issuance/documentation/api-basics/#encryption

https://developer.mastercard.com/card-issuance/documentation/api-basics/#environments

https://developer.mastercard.com/card-issuance/documentation/use-cases/

https://developer.mastercard.com/card-issuance/documentation/tutorials-and-guides/

https://developer.mastercard.com/card-issuance/documentation/code-and-formats/

https://developer.mastercard.com/card-issuance/documentation/support/#faqs

https://developer.mastercard.com/card-issuance/documentation/support/#get-help

https://developer.mastercard.com/traditional-fulfillment-service/documentation/api-basics/#api-security

https://developer.mastercard.com/traditional-fulfillment-service/documentation/api-basics/#environments

https://developer.mastercard.com/traditional-fulfillment-service/documentation/use-cases/

https://developer.mastercard.com/traditional-fulfillment-service/documentation/tutorials-and-guides/

https://developer.mastercard.com/traditional-fulfillment-service/documentation/code-and-formats/

https://developer.mastercard.com/traditional-fulfillment-service/documentation/release-history/

https://developer.mastercard.com/traditional-fulfillment-service/documentation/support/#faq

https://developer.mastercard.com/traditional-fulfillment-service/documentation/support/#get-help

https://developer.mastercard.com/user-account-management-service/documentation/api-basics/#api-security

https://developer.mastercard.com/user-account-management-service/documentation/api-basics/#environments

https://developer.mastercard.com/user-account-management-service/documentation/use-cases/

https://developer.mastercard.com/user-account-management-service/documentation/tutorials-and-guides/

https://developer.mastercard.com/user-account-management-service/documentation/glossary/

https://developer.mastercard.com/user-account-management-service/documentation/code-and-formats/

https://developer.mastercard.com/user-account-management-service/documentation/release-history/

https://developer.mastercard.com/user-account-management-service/documentation/support/#faq

https://developer.mastercard.com/user-account-management-service/documentation/support/#get-help

OpenAPI Specification

swagger: '2.0'
info:
  title: Mastercard Bill Payment Validator Account Opening Health Checks API
  description: This service is provided on behalf of the Mastercard Remote Payment and Presentment (RPPS) Bill Payment Processing Network, which supports consumer to business "push" bill payments (i.e. those which are not funded by debit/credit card transactions) in the U.S.
  version: '1.0'
  x-artifactId: billpay-api
  contact:
    name: Bill Pay Development Support
    email: Bill_Pay_Development_Support@mastercard.com
host: sandbox.api.mastercard.com
basePath: /billpayAPI/v1
schemes:
- https
consumes:
- application/json
produces:
- application/json
tags:
- name: Health Checks
paths:
  /api/orders/healthchecks:
    get:
      tags:
      - Health Checks
      operationId: getHealthDetails
      description: Health or Echo or Heartbeat endpoint ensuring that the API is running
      summary: Health endpoint to ensure confirm connectivity to transaction API
      responses:
        '200':
          $ref: '#/components/responses/HealthCheckResponse'
components:
  responses:
    HealthCheckResponse:
      description: "The code indicates the response.\n  - OK = The API is up and running\n  - failure = The API is not running"
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/HealthCheckResponse'
  schemas:
    HealthCheckResponse:
      type: string
      maxLength: 7
      minLength: 2
      description: "The code indicates if the API is up or not\n  - OK = The API is up and running\n  - failure = The API is down"
      example: OK