/tickets/transfer/{confirmationCd}

Description

This call will cancel the transfer.

Supported Methods

1. DELETE

Request

/tickets/transfer/{confirmationCd}

HEADERS

RCO	Property	Type	Description
R	User-Agent	String	An identifying string in Product/Version format, where Version is a SemVer-compliant string, that uniquely identifies your application.
R	Authorization	String	It's required to use the "Bearer" authentication scheme to transmit the access token.
R	Accept	String	The only supported response type for this endpoint is application/json.
O	Accept-Encoding	String	gzip compression is supported.
R	Content-Type	String	The only supported request type for this endpoint is application/json.
R	PAC-Channel-Code	String	The channel partner identifier issued to your organization by the Paciolan Partner Services team partner on-boarding.
R	PAC-Application-ID	String	The application identifier for which API access has been authorized; this value is typically expressed in reverse domain notation and is bound to an API key provided by Paciolan during provisioning.
R	PAC-API-Key	String	The API key provided by Paciolan for this application.
R	Request-ID	String	A unique ID provided for debugging purposes
R	PAC-Organization-ID	String	PAC-Organization-ID String The client's data account ID to pull events from.

Response

Response Object

Property	Type	Description
patronId	String	Unique customer id
confirmationCd	String	tranferId returned by Backoffice
cancelDt	String	Cancel date and time MM/dd/yyyy HH:mm:ss (using the 24-hour clock)
transferStatus	String	Current transfer status

Error Response Object

Property	Type	Description
error	Object	Error details
→ type	String	Error type that has occurred
→ developerMessage	String	Generic description of error that occurred
→ appErrorCode	String	Internal error code used for support. Depending on type returned, this code may be needed to handle error response differently

Error Types

Error Type	Error Desc	App Error Code	HTTP Status Code	HTTP Status Desc	Retry Possible	Retry Count	Ultimate action	MS Error Level
INVALID_PARAMETER_VALUE	Invalid Code Provided	MS-400	400	Bad Request	No	0	Caller to inform Provider	ERROR
INVALID_PARAMETER_VALUE	This Seats cannot be canceled at this time	MS-422	422	Unprocessable Entity	No	0	Caller to inform Provider	ERROR
UNHANDLED_EXCEPTION	Internal server error occurred due to backend error	MS-500	500	Internal Server Error	Yes	3	Caller to inform Provider	FATAL

Examples

Request

curl --location --request DELETE 'https://link-sandbox.paciolan.info/v1/tickets/transfer/3785222-AMTX:10555' \
--header 'User-Agent: MyApplication/1.0' \
--header 'Authorization: Bearer <BearerToken>' \
--header 'PAC-Channel-Code: my-application' \
--header 'PAC-Application-ID: com.mycompany.myapp' \
--header 'PAC-API-Key: <ApiKey>' \
--header 'Request-ID: <RequestID>' \
--header 'PAC-Organization-ID: 999' \
--header 'Content-Type: application/json'

Responses

Success Response

< HTTP/1.1 200
{
    "patronId": "3785222",
    "confirmationCd": "3785222-AMTX:10270",
    "cancelDt": "06/15/2023 09:43:12",
    "transferStatus": "Cancelled"
}

Failure Response

< HTTP/1.1 400
{
    "error": {
        "type": "INVALID_PARAMETER_VALUE",
        "developerMessage": "This Seats cannot be canceled at this time",
        "appErrorCode": "MS-400"
    }
}