/v2/tickets/transfer/pending/{processId}

Description

The Initiate Transfer Status API endpoint returns the status of the initiate transfer transaction trigger by the /v2/tickets/transfer post call. This endpoint is needed when the response to the /v2/tickets/transfer has a status of PENDING, and no asyncCallbackUrl was provided for the system to inform the caller of a status of the initiate transfer request. Calling this endpoint will provide an update.

Supported Methods

1. GET

Request

/v2/tickets/transfer/pending/{processId}

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

Response

Response Object

Property	Type	Description
patronId	String	Unique customer ID
confirmationCd	String	tranferId returned by Backoffice
sentDt	String	Sent date MM/dd/yyyy HH:mm:ss (using the 24-hour clock)
expireDt	String	Expiration date MM/dd/yyyy HH:mm:ss (using the 24-hour clock)
transferId	String	Database primary key
transferStatus	String	Transfer status (pending, accepted or cancelled)
url	String	Transfer accept URL
processId	String	A unique ID for the request that is/has executed.
transactionStatus	String	The status of the request (PENDING, COMPLETE, or ERROR). A status of "PENDING" will require a polling call to /v2/tickets/transfer/pending/{processId} if no asyncCallbackUrl was provided in the request.

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
processId	Object	A unique ID for the request that is/has executed.

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
UNHANDLED_EXCEPTION	Internal server error occurred due to backend error	MS-500	500	Internal Server Error	Yes	3	Caller to inform Provider	FATAL

Pending Response Object

At a minimum, the following two properties will be returned in the response if the status is PENDING.

Property	Type	Description
transactionStatus	Enum ["PENDING", "COMPLETE", "ERROR"]	The status of the request. A status of "PENDING" will require a followup polling call to this /v2/tickets/transfer/pending/{processId} if no asyncCallbackUrl was provided in the request of the /v2/tickets/transfer.
processId	string	A unique ID for the request that is/has executed.

Examples

Request

curl --location 'https://link-sandbox.paciolan.info/v2/tickets/transfer/pending/12345' \
--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'

Responses

Success Response

{
  "patronId": "3785222",
  "confirmationCd": "3785222-AMTX:10237",
  "sentDt": "06/07/2023 23:46:03",
  "expireDt": "06/14/2023 23:46:03",
  "transferId": "w53hKM1ZPmDBgYsq68VW6xR6KLLeoWCR",
  "url": "https://qfnq-bqfn80-amtx.paciolan.info/myaccount/receive/xnc3t7KpSQQxLr9SmdtnUXs74qHPfrz2?linkID=BQFN80-AMTX&siteId=ev_BQFN80-AMTX",
  "processId": "5f6d4e",
  "transferStatus": "pending",
  "transactionStatus": "COMPLETE"
}

Failure Response

{
  "error": {
    "type": "INVALID_PARAMETER_VALUE",
    "developerMessage": "Invalid input. Please provide valid data.",
    "appErrorCode": "MS-400"
  },
  "transactionStatus": "ERROR",
  "processId": "5f6d4e"
}

Status PENDING Response

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