/tickets/transfer/complete

Description

This call will initiate, accept and print a transfer request.

Supported Methods

1. POST

Request

/tickets/transfer/complete

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	The integrator's external request ID for support traceablility and issue debugging. This string should be a UUID V4 value.

Request Object

RCO	Property	Type	Description
R	transferRequests	Array of Objects	We currently only support one recipient transfer at a time so only one object is allowed in this array.
O	→ externalTransferId	String	External Transfer ID
R	→ Recipient	Object	Recipient details
O	→→ phone	String	Recipient phone
R	→→ email	String	Recipient email
R	→→ recipientFirstName	String	Recipient first name.
R	→→ recipientLastName	String	Recipient last name.
C	→ Items	Array of Objects	Token details for transfers. Required if calling the request with tokens.
R	→→ externalOrderId	String	External order ID used in the complete order call
R	→→ tokens	Array of Strings	List of tokens to transfer

Response

Response Object

Property	Type	Description
processId	String	A unique ID for the request that is/has executed.
status	Enum ["PENDING", "COMPLETE", "ERROR"]	The status of the transfer. A status of "PENDING" will require a followup polling call to /tickets/transfer/complete/{processId}.
confirmationCd	String	transferId returned by Backoffice
transferId	String	Database primary key
tickets	Array	Ticket items
→ token	String	Returns the same token ID from the request.
→ applePassUrl	String	Apple Pass
→ googlePassUrl	String	Text file containing the JWT needed to append to https://pay.google.com/gp/v/save/{JWT} to receive the pass for Google Wallet.

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 input. Please provide a valid data.	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 'https://link-sandbox.paciolan.info/v1/tickets/transfer/complete' \
--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 'Content-Type: application/json' \
--data-raw '{
    "transferRequests": [
        {
            "externalTransferId": "DJY2347651234",
            "Recipient": {
                "email": "ta236@paciolan.com",
                "recipientFirstName": "Juan",
                "recipientLastName": "Ramirez"
            },
            "Items": [
                {
                    "externalOrderId": "1234567890",
                    "tokens": [
                        "56789983390560",
                        "56689833903898"
                    ]
                },
                {
                    "externalOrderId": "2345678901",
                    "tokens": [
                        "67889833903898",
                    ]
                }
            ]
        }
    ]
}'

Responses

Success Response

< HTTP/1.1 200
{
    "processId": "d4e5f6",
    "status": "COMPLETE",
    "confirmationCd": "3785222-AMTX:10237",
    "transferId": "w53hKM1ZPmDBgYsq68VW6xR6KLLeoWCR",
    "tickets": [
        {
            "token": "56789983390560",
            "applePassUrl": "https://ticketdelivery.eveneue.net/tickets/F19/F02/3u328u39hfisudfgdnfgjd.pkpass",
            "googlePassUrl": "https://ticketdelivery.eveneue.net/tickets/F19/F02/3u328u39hfisudfgdnfgjd.txt"
        },
        {
            "token": "56689833903898",
            "applePassUrl": "https://ticketdelivery.eveneue.net/tickets/F19/F02/7etwy4oayi7isudfisfbgf.pkpass",
            "googlePassUrl": "https://ticketdelivery.eveneue.net/tickets/F19/F02/7etwy4oayi7isudfisfbgf.txt"
        },
        {
            "token": "67889833903898",
            "applePassUrl": "https://ticketdelivery.eveneue.net/tickets/F19/F02/3u328u39hfisudfisfhx.pkpass",
            "googlePassUrl": "https://ticketdelivery.eveneue.net/tickets/F19/F02/3u328u39hfisudfisfhx.txt"
        }
    ]
}

Status COMPLETE Response with Missing Passes

If tokens are missing the Apple or Google passes, a call the /print endpoint is needed to retrieve the passes.

< HTTP/1.1 200
{
    "processId": "d4e5f6",
    "status": "COMPLETE",
    "confirmationCd": "3785222-AMTX:10237",
    "transferId": "w53hKM1ZPmDBgYsq68VW6xR6KLLeoWCR",
    "tickets": [
        {
            "token": "56789983390560",
            "applePassUrl": null,
            "googlePassUrl": null
        },
        {
            "token": "56689833903898",
            "applePassUrl": null,
            "googlePassUrl": null
        },
        {
            "token": "67889833903898",
            "applePassUrl": null,
            "googlePassUrl": null
        }
    ]
}

Status PENDING Response

{
  "processId": "d4e5f6",
  "status": "PENDING"
}

Status ERROR Response

{
  "processId": "d4e5f6",
  "status": "ERROR",
  "error": {
      "type": "UNHANDLED_EXCEPTION",
      "developerMessage": "You can't transfer tickets to yourself",
      "appErrorCode": "MS-400"
  }
}

Failure Response

< HTTP/1.1 400
{
    "error": {
        "type": "INVALID_PARAMETER_VALUE",
        "developerMessage": "Invalid input. Please provide valid data.",
        "appErrorCode": "MS-400"
    }
}