Query

This endpoint allows you to query the status of enrolment or unenrolment requests.

To query the status of a request, please provide the enrolmentRequestID returned from a successful enrolment or unenrolment request as a query parameter to the endpoint api.ravelin.com/3ds/merchant/query?enrolmentRequestID=[enrolmentRequestID]

GET 3ds.live.pci.ravelin.com/merchant/query?enrolmentRequestID=[enrolmentRequestID]

Jump to Response

Response

Show all
enrolmentRequestID string

The enrolment request ID returned from a successful enrolment or unenrolment request.
action string

Whether the merchants are being enrolled or unenrolled.

Options:
ENROL
UNENROL
status string

The status of the merchant enrolment or unenrolment request.

Options:
PROCESSING
COMPLETED
totalRecords integer

The number of merchants processed in this request.
successRecords integer

The number of merchants processed successfully.
failedRecords integer

The number of merchants for which processing failed.
merchants array

The merchants that have been enrolled or unenrolled as part of this request.

Hide definition
acquirerBIN string

Acquiring institution identification code as assigned by Mastercard.
acquirerCID string

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

Acquirer ICA (Interbank Card Association) number.
acquirerName string

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

Acquirer-assigned merchant identifier.
merchantName string

Name of the merchant.
identityCheckExpress string

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

The reason for unenroling a merchant. This will only be populated for unenrolment requests.
status string

Status of the merchant with regards to it’s enrolment or unenrolment.

Options:
Successful
Rejected
reason string

This will contain New Record Data for successfully enrolled merchants. Otherwise it will contain the reason why a merchant failed to enrol or unenrol.

 
{
  "enrolmentRequestID": "00000000-0000-0000-0000-000000000000",
  "action": "ENROL",
  "status": "COMPLETED",
  "totalRecords": 1,
  "successRecords": 1,
  "failedRecords": 0,
  "merchants": [
    {
      "acquirerBIN": "223456",
      "acquirerCID": "10",
      "acquirerICA": "123",
      "acquirerName": "adyen",
      "acquirerMerchantID": "235",
      "merchantName": "Test Merchant",
      "identityCheckExpress": "Y",
      "status": "Successful",
      "reason": "New Record Data"
    }
  ]
}

Feedback

© Ravelin Technology Ltd. All rights reserved