Create mid request

Path Params
string
required

The ID of the program where the MID Request is being created

Body Params
string
enum
required

The MID action to be performed

Allowed:
string

The ID of the location, required for Onboarding and Reassignment requests. For Reassignments this is the new locationId for the MID

string

The Acquiring Merchant ID, required for Mastercard Onboarding requests

string

The Mastercard Location ID, only for Mastercard Onboarding reques

string

The ID of the MID, required for Offboarding and Reassignment requests

string
enum

How the MID was sourced, required for Onboarding requests

Allowed:
string
enum

The reason for the action, required for Offboarding and Reassignment requests

Allowed:
string

The Amex Service Establishment number (Merchant ID), required for Amex Onboarding requests. Must be 10 digits

string
enum

The scheme name, required for Onboarding requests

Allowed:
string

The Visa Merchant ID, required for Visa (Merchant) Onboarding requests. Must be 6-8 digits

string

The Visa Store ID, only for Visa (Merchant) Onboarding requests. By omitting this field, all the stores for the given VMID are onboarded. Must be Must be 8-10 digits

string

The Acquirer Bank Identification Number as assigned by Visa, only for Visa (Acquirer) Onboarding requests. By providing this value, the onboarding will take place near real-time

string

The Acquiring Merchant ID, also known as Card Acceptor ID, required for Visa (Acquirer) Onboarding requests. For the United States, this will trigger a VMID/VSID search

Headers
string
required

application/json

string
required

test/live API secret or public key

Responses

Language
Credentials
Header
Response
Choose an example:
application/json