Transfer Approvals

A transfer approval is a collection of tickets that are allowed to be transferred.

The channel connected to the application defines how and to whom tickets can be transferred. For example, when creating a Transfer Approval for a Waiting List, the tickets will be matched with Order Requests for the same channel.

When a ticket is transferred, a new ticket will be created with a new barcode and the original ticket will be invalidated.

Create a transfer approval

Authenticate this request using Basic access authorization. Only valid tickets can be transferred.

Request data

Field name	Type	Description
tickets	Tickets (list)	One or more ticket references to be transferred.
sale	Sale	Optional. A sale reference to which to offer these tickets. You can get this reference from transfer_sale of a ticket.
asking_price	Amount	Optional. Asking price for the transfer.

Example

[POST] https://shopping-api.paylogic.com/ticket-transfer-approvals

{
    "channel": "https://shopping-api.paylogic.com/channels/b0f98cd6aef34487b941fae77a2ac760",
    "tickets": [
        "https://shopping-api.paylogic.com/tickets/a2e37ee17474417a87259b02b674da9a",
        "https://shopping-api.paylogic.com/tickets/5959f610ba0f4b61b30750d5382f228c"
    ]
}

Response data

Field name	Type	Description
uid	String	A unique identifier for this approval.
created_date	Datetime	Date and time the approval was created.
modified_date	Datetime	Date and time the approval was modified.
transfer_actor_email	String	The email address of the actor who was requested to complete a ticket transfer. (optional)
status	String	The status of the approval. See the table below.
tickets	Tickets (list)	Embedded list of tickets in the transfer approval. Note that only a small subset of the ticket is exposed.
asking_price	Amount	Asking price for the transfer.
type	String	The type of the transfer. (waiting_list/resale/name_change)

Approval statuses

Status	Description
approved	This ticket is approved for transfer and a new order can be created using it.
rejected	The consumer has retracted his or her approval for the transfer of this ticket.

Example

{
    "uid": "23c4aa75abfe41c2bf2049f189ec9db7",
    "status": "approved",
    "transfer_actor_email": "",
    "created_date": "2020-07-27T11:33:11Z"
    "modified_date": "2020-07-27T11:33:11Z",
    "asking_price": "",
    "_links": {
        "profile": {
            "href": "https://shopping-api-docs.paylogic.com/documentation/transfer_approvals.html",
            "type": "text/html"
        },
        "curies": [
            {
                "href": "https://shopping-api-docs.paylogic.com/documentation/{rel}.html",
                "type": "text/html",
                "name": "shop",
                "templated": true
            }
        ],
        "self": {
            "href": "https://shopping-api.paylogic.com/ticket-transfer-approvals/23c4aa75abfe41c2bf2049f189ec9db7"
        }
    }
    "_embedded": {
        "shop:ticket": [
            {
                "_links": {
                    "self": {
                        "href": "https://shopping-api.paylogic.com/tickets/a2e37ee17474417a87259b02b674da9a"
                    },
                    "shop:withdraw_url": {
                        "href": "https://shopping-api.paylogic.com/ticket-transfer-approvals/23c4aa75abfe41c2bf2049f189ec9db7"
                    }
                },
                "complete_ticket_transfer_url": "",
                "target_order_status": null
            },
            {
                // omitted: second ticket data
            }
        ]
    }
}

Get details of a transfer approval

A ticket transfer approval can be created so a consumer can cancel the sale of his ticket. If a consumer cancels his or her approval then the ticket can no longer be transferred to a new consumer.

[GET] https://shopping-api.paylogic.com/ticket-transfer-approvals/b3689a893a164abaaf93407bca5ef278

The server will respond with the same fields as when creating a transfer approval.

Cancelling a transfer approval

Cancelling a ticket transfer is currently not possible using the Shopping Service API. When a ticket transfer is created, our system will send the owners of the original tickets an email with a link where they can cancel the transfer. It’s not possible to cancel a transfer approval for tickets that have completed the transfer.

Withdrawing tickets from a transfer approval

A ticket can be withdrawn from a transfer approval when the embedded ticket inside the transfer approval response contains a shop:withdraw_url. In that case a DELETE request can be made with the ticket part of the request data. For example:

[DELETE] https://shopping-api.paylogic.com/ticket-transfer-approvals/b3689a893a164abaaf93407bca5ef278

{
    "tickets": [
        "https://shopping-api.paylogic.com/tickets/a2e37ee17474417a87259b02b674da9a"
    ]
}

The server will respond with the same fields as when creating a transfer approval.