Skip to content

Claim a transfer

Request

Claim a pending transfer. Once claimed, any tickets attached to the transfer are moved from the sender's account to the recipient's and returned to a usable state. Only a transfer's recipient can claim a transfer, and a transfer can no longer be claimed once it has been cancelled or claimed previously.

Security
SessionKey(Required scopes: customeradministrator)
Path
transferstring^\d{14}$

Unique identifier of the transfer

curl -i -X POST \
  'https://docs.ticketingevents.com/_mock/openapi/transfers/{transfer}/claims' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

The transferred tickets were successfully delivered to the recipient's account.

Bodyapplication/json
datestring, (date-time)

The date/time at which the transfer was claimed

claimantstring

Full name and username of the TickeTing user that claimed the transfer

successboolean

True if the transfer was successfully claimed, false otherwise

Response
{
  "date": "2024-03-05 21:56:09",
  "claimant": "Billy Butcher (the_butcher)",
  "success": true
}