Merchants > API Reference > Endpoints > Reclaim

Reclaim

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 where that data is relevant for your business.

Optional Optional fields are additional data points that can be shared with Ravelin.
These fields are unlikely to impact performance but may be visible in the Ravelin dashboard.

Jump to Response

POST api.ravelin.com/v2/reclaim

Show all

timestamp integer required

Unix timestamp with milliseconds (nanoseconds also accepted).

customers array required

An array of up to 1000 customers whose accounts have been reclaimed.

Show definition

method string required

Indicates the method by which the customer account was reclaimed.

One of: PasswordReset, AccountDeleted, or Other.

customerId string required

The ID of the customer whose account was reclaimed.

reportedBy string optional

Indicates who reported that account takeover took place.

One of: CUSTOMER, MERCHANT, or RAVELIN.

atoEvents array optional

An array of objects containing IDs for the first account takeover events seen on a customer account. Each object in the array may only contain one ID.

One of the following:

Show definition

loginId string optional

The unique ID of a login which indicated account takeover had taken place.

deviceId string optional

The unique ID of a device which indicated account takeover had taken place.

orderId string optional

The unique ID of an order which indicated account takeover had taken place.

source string optional

deprecated

Indicates the source of the request. This field is deprecated. Please, use customer.reportedBy instead.

Only: ATO.

POST https://api.ravelin.com/v2/reclaim HTTP/1.1
Authorization: token ...
Content-Type: application/json

{
  "timestamp": 1512828988826,
  "customers": [
    {
      "customerId": "abc-123-ZYZ",
      "method": "Other",
      "reportedBy": "CUSTOMER",
      "atoEvents": [
        {
          "loginId": "42bd8af9-1ac2-7b2c-cd6a-a6a33c723510"
        }
      ]
    }
  ]
}

Response

Show all

status integer

The HTTP response status code.

message string

A message reporting how many customer accounts were successfully reclaimed.

{
  "status": 200,
  "message": "1 customer accounts reclaimed successfully"
}

Feedback

Was this page helpful?