Skip to main content

/tickets/transfer/{confirmationCd}

Description

This call will return transfer history.

Supported Methods

  1. GET

Request

/tickets/transfer/{confirmationCd}

HEADERS

RCOPropertyTypeDescription
RUser-AgentStringAn identifying string in Product/Version format, where Version is a SemVer-compliant string, that uniquely identifies your application.
RAuthorizationStringIt's required to use the "Bearer" authentication scheme to transmit the access token.
RAcceptStringThe only supported response type for this endpoint is application/json.
OAccept-EncodingStringgzip compression is supported.
RContent-TypeStringThe only supported request type for this endpoint is application/json.
RPAC-Channel-CodeStringThe channel partner identifier issued to your organization by the Paciolan Partner Services team partner on-boarding.
RPAC-Application-IDStringThe 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.
RPAC-API-KeyStringThe API key provided by Paciolan for this application.
RRequest-IDStringA unique ID provided for debugging purposes

Response

Response Object

PropertyTypeDescription
transferIdStringTransfer ID (or also known as confirmationCd in the initiate transfer response)
recipientFirstNameStringRecipient first name
recipientLastNameStringRecipient last name
historyArray of ObjectsTransfer history
opStringOperation name
tsStringIssue date and time MM/dd/yyyy HH:mm:ss (using the 24-hour clock)
initiatorString
createTsStringDate and time the transfer was created MM/dd/yyyy HH:mm:ss (using the 24-hour clock)

Error Response Object

PropertyTypeDescription
errorObjectError details
typeStringError type that has occurred
developerMessageStringGeneric description of error that occurred
appErrorCodeStringInternal error code used for support. Depending on type returned, this code may be needed to handle error response differently

Error Types

Error TypeError DescApp Error CodeHTTP Status CodeHTTP Status DescRetry PossibleRetry CountUltimate actionMS Error Level
INVALID_PARAMETER_VALUEInvalid Code ProvidedMS-400400Bad RequestNo0Caller to inform ProviderERROR
UNHANDLED_EXCEPTIONInternal server error occurred due to backend errorMS-500500Internal Server ErrorYes3Caller to inform ProviderFATAL

Examples

Request

curl --location '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 'Content-Type: application/json'

Responses

Success Response
< HTTP/1.1 200
{
"transferId": "3785222-AMTX:10237",
"recipientFirstName": "Juan",
"recipientLastName": "Ramirez",
"history": [
{
"op": "initiate",
"ts": "2023-06-14T07:23:05.281+0000"
},
{
"op": "cancel",
"ts": "2023-06-14T19:48:58.792+0000",
"initiator": "transferrer"
}
],
"createTs": "2023-06-14T07:23:05.281+0000"
}
Failure Response
< HTTP/1.1 400
{
"error": {
"type": "INVALID_PARAMETER_VALUE",
"developerMessage": "Invalid Code Provided",
"appErrorCode": "MS-400"
}
}