Unenrol

This endpoint allows you to unenrol merchants from Mastercard’s ISSM tool. This means merchants can no longer participate in Mastercard’s 3DS2 authentications.

Field Status Definitions
Required Required fields must be sent. If the data is not sent Ravelin will return an error.
Important Important fields are crucial for performance.
Optional Optional fields are additional data points that can be shared with the card schemes, issuers, and Ravelin. These fields may impact performance or dashboard usability.
Conditional Fields that may be required under certain conditions.

POST 3ds.live.pci.ravelin.com/merchant/unenrol

Jump to Response

Show all
scheme string
required

The card scheme for which the merchant is being unenrolled.

Conditions:

Must be Mastercard

product string
required

The product for which unenrolment is taking place.

Conditions:

Must be Identity Check

merchants array
required

The merchants which will be unenrolled.

Hide definition
Maximum length: 1000
acquirerBIN string
required

Acquiring institution identification code as assigned by Mastercard. This should match the acquirerBIN.

This value should start with 2, 5, or 6.

Maximum length: 6
acquirerCID string
required

Acquirer Company ID. This is the customer ID assigned to an acquirer by Mastercard.

This value should not contain empty spaces.

Maximum length: 10
acquirerICA string
required

Acquirer ICA (Interbank Card Association) number.

Maximum length: 11
acquirerName string
required

The name of the acquirer with whom the merchant has a bank account.

acquirerMerchantID string
required

Acquirer-assigned merchant identifier. This should match the acquirerMerchantID.

Maximum length: 24
merchantName string
required

Name of the merchant being unenrolled. This should match merchantName.

Maximum length: 25
identityCheckExpress string
optional

Indicates whether the merchant supports Mastercard’s Identity Check Express.

Options:
Y
N
deleteReason string
required

The reason for unenroling a merchant.

Options:
Data Entry Error
Merchant No Longer Participating
Acquirer Reference ID Change
Acquirer Primary ICA Change
Other
POST https://3ds.live.pci.ravelin.com/merchant/enrol HTTP/1.1
Authorization: token ...
Content-Type: application/json

{
  "scheme": "Mastercard",
  "product": "Identity Check",
  "merchants": [
    {
      "acquirerBIN": "223456",
      "acquirerCID": "10",
      "acquirerICA": "123",
      "acquirerName": "adyen",
      "acquirerMerchantID": "235",
      "merchantName": "Test Merchant",
      "identityCheckExpress": "Y",
      "deleteReason": "Other"
    }
  ]
}

Response

Show all
status string

The status of the merchant unenrolment request.

Options:
PROCESSING
COMPLETED
enrolmentRequestID string

The ID of the unenrolment request, returned by Mastercard.

totalRecords integer

The number of merchants processed in this request.

{
  "status": "PROCESSING",
  "enrolmentRequestID": "00000000-0000-0000-0000-000000000000",
  "totalRecords": 1
}

Feedback