Sign in
Links

Retrieve a Group of Links by Reference IDs

Get details for multiple links by providing an array of reference IDs (1-100 items). Only returns links that belong to the authenticated merchant.

post/api/v1/links/batch

Request body

referenceIdsstring[] required

Array of your reference IDs to retrieve. Minimum 1, maximum 100 items per request.

Example request

{
  "referenceIds": [
    "ref-001",
    "ref-002",
    "ref-003"
  ]
}

Response

Batch retrieval successful

messagestring
totalRequestedinteger

Total number of reference IDs requested

totalFoundinteger

Total number of links found

Example response

{
  "data": [
    {
      "linkExpiresIn": "1h"
    }
  ],
  "message": "Found 2 links out of 3 requested reference IDs"
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.