/tickets/transfer/{confirmationCd}
Description
This call will return transfer history.
Supported Methods
- GET
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 |
Response
Response Object
Property | Type | Description |
---|---|---|
transferId | String | Transfer ID (or also known as confirmationCd in the initiate transfer response) |
recipientFirstName | String | Recipient first name |
recipientLastName | String | Recipient last name |
history | Array of Objects | Transfer history |
→ op | String | Operation name |
→ ts | String | Issue date and time MM/dd/yyyy HH:mm:ss (using the 24-hour clock) |
→ initiator | String | |
createTs | String | Date and time the transfer was created MM/dd/yyyy HH:mm:ss (using the 24-hour clock) |
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 |
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/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"
}
}