Visa

Visa Alerts Preference Management API API

Manage cardholder alert delivery preferences including mobile numbers, email addresses, and device identifiers for notification delivery.

Documentation GitHub OpenAPI

Documentation

https://developer.visa.com/capabilities/pav/docs

https://developer.visa.com/capabilities/pav/docs-authentication

https://developer.visa.com/capabilities/suppliermatchingservice/docs-getting-started

https://developer.visa.com/capabilities/suppliermatchingservice/docs-authentication

https://developer.visa.com/capabilities/vcms/docs-getting-started

https://developer.visa.com/capabilities/vcms/docs-authentication

https://developer.visa.com/capabilities/card-on-file-data-inquiry/docs-getting-started

https://developer.visa.com/capabilities/card-on-file-data-inquiry/docs-authentication

https://developer.visa.com/capabilities/foreign_exchange/docs-getting-started

https://developer.visa.com/capabilities/foreign_exchange/docs-authentication

https://developer.visa.com/capabilities/foreign_exchange/reference#tag/Foreign-Exchange-Rates-API/operation/ForeignExchangeRates_v2%20-%20Latest

https://developer.visa.com/capabilities/paai/docs-getting-started

https://developer.visa.com/capabilities/paai/docs-authentication

https://developer.visa.com/capabilities/paai/reference#tag/Funds-Transfer-Attributes-Inquiry-API/operation/Funds%20Transfer%20Inquiry_v5%20-%20Latest

https://developer.visa.com/capabilities/vau/docs-getting-started

https://developer.visa.com/capabilities/vau/docs-authentication

https://developer.visa.com/capabilities/vau/reference#tag/Issuer-Stop-Advice-API/operation/stopAdviceUsingPOST_v1%20-%20Latest

https://developer.visa.com/capabilities/visa-bin-attribute-sharing-service/docs-getting-started

https://developer.visa.com/capabilities/visa-bin-attribute-sharing-service/docs-authentication

https://developer.visa.com/capabilities/vbds/docs-getting-started

https://developer.visa.com/capabilities/vbds/docs-authentication

https://developer.visa.com/capabilities/vbds/reference#tag/Authorization-Data-API/operation/getAuthDataUsingPOST_v1%20-%20Latest

https://developer.visa.com/capabilities/vcpm/docs-getting-started

https://developer.visa.com/capabilities/vcpm/docs-authentication

https://developer.visa.com/capabilities/vcpm/reference#tag/Visa-Card-Program-Enrollment/operation/enrollmentV2UsingPOST_v2%20-%20Latest

https://developer.visa.com/capabilities/visa-secure-remote-commerce/docs-getting-started

https://developer.visa.com/capabilities/visa-secure-remote-commerce/reference#tag/CTP-Checkout-API/operation/CTP%20Checkout%20API_v1%20-%20Latest

https://developer.visa.com/capabilities/visa-digital-enablement-lite/reference#tag/URL-Generation-API_/paths/1inapp1provision1appclip1url/post_v1%20-%20Latest

https://developer.visa.com/capabilities/visa-merchant-screening-service/docs-getting-started

https://developer.visa.com/capabilities/visa-merchant-screening-service/docs-authentication

https://developer.visa.com/capabilities/visa-merchant-screening-service/reference#tag/Termination-Inquiry-APIs/operation/RetroActive%20Alert%20of%20Terminated%20Merchants%20or%20Agent_v2%20-%20Latest

https://developer.visa.com/capabilities/vpa

https://developer.visa.com/capabilities/visa-in-app-provisioning

https://developer.visa.com/capabilities/merchant_search/docs

https://developer.visa.com/capabilities/vba/docs

https://developer.visa.com/capabilities/vmorc/docs

https://developer.visa.com/capabilities/visa_direct/docs

https://developer.visa.com/capabilities/atmlocator/docs

https://developer.visa.com/capabilities/vctc/docs

Specifications

https://raw.githubusercontent.com/api-evangelist/visa/refs/heads/main/openapi/visa-alerts-preference-management-api-api-openapi.yml

Other Resources

https://developer.visa.com/pages/visa-developer-error-codes

https://developer.visa.com/capabilities/suppliermatchingservice/product-terms

https://developer.visa.com/capabilities/vcms/error-codes

https://developer.visa.com/capabilities/vcms/product-terms

https://developer.visa.com/capabilities/paai/product-terms

https://developer.visa.com/capabilities/vau/vau-faq

https://developer.visa.com/capabilities/vau/product-terms

https://developer.visa.com/capabilities/visa-bin-attribute-sharing-service/faq

https://developer.visa.com/capabilities/visa-bin-attribute-sharing-service/product-terms

https://developer.visa.com/capabilities/vbds/product-terms

https://developer.visa.com/capabilities/vcpm/docs-error-codes

https://developer.visa.com/capabilities/vcpm/product-terms

https://developer.visa.com/capabilities/visa-secure-remote-commerce/docs-glossary

https://developer.visa.com/capabilities/visa-digital-enablement-lite/product-terms

OpenAPI Specification

openapi: 3.0.1
info:
  title: Foreign Exchange Rates Alerts Preference Management API API
  description: Manage cardholder alert delivery preferences including mobile numbers, email addresses, and device identifiers for notification delivery.
  version: '1'
servers:
- url: https://sandbox.api.visa.com
  description: Sandbox server
security: []
tags:
- name: Alerts Preference Management API
  description: Manage cardholder alert delivery preferences including mobile numbers, email addresses, and device identifiers for notification delivery.
paths:
  /vctc/alertspreference/v1/managealertspreference:
    post:
      operationId: manageAlertsPreference
      summary: Manage Alerts Preference
      description: Configures the cardholder's alert delivery preferences including mobile number, email address, and device identifiers that Visa will use to send all alert notifications.
      tags:
      - Alerts Preference Management API
      requestBody:
        description: Alert preference configuration
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AlertsPreferenceRequest'
      responses:
        '200':
          description: Alert preferences configured successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlertsPreferenceResponse'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized
components:
  schemas:
    AlertsPreferenceRequest:
      type: object
      required:
      - primaryAccountNumber
      properties:
        primaryAccountNumber:
          type: string
          description: Primary account number
        mobileNumber:
          type: string
          description: Mobile number for SMS alerts in E.164 format
        emailAddress:
          type: string
          format: email
          description: Email address for alert delivery
        deviceId:
          type: string
          description: Device identifier for push notifications
        alertDeliveryChannel:
          type: string
          description: Preferred alert delivery channel
          enum:
          - SMS
          - EMAIL
          - PUSH
    ErrorResponse:
      type: object
      properties:
        errorCode:
          type: string
          description: Machine-readable error code
        message:
          type: string
          description: Human-readable error description
    AlertsPreferenceResponse:
      type: object
      properties:
        status:
          type: string
          description: Preference configuration status
        alertDeliveryChannel:
          type: string
          description: Configured delivery channel
x-tagGroups:
- name: API Reference
  tags:
  - Foreign Exchange Rates API