/tickets/transfer/accept
Description
This call will accept a pending transfer request to the recipent user.
Supported Methods
- POST
Request
/tickets/transfer/accept
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. |
Query Parameters
RCOM | Key | Type | Description |
---|---|---|---|
C | distributorCode | String | Distributor code. Required if initiated transfer with seat details. |
Request Object
RCO | Property | Type | Description |
---|---|---|---|
R | transferId | String | Transfer ID |
C | Recipient | Object | Recipient details |
O | → phone | String | Recipient phone |
R | String | Recipient email | |
R | → recipientFirstName | String | Recipient first name. Required when calling after initiating transfer with tokens. |
R | → recipientLastName | String | Recipient last name. Required when calling after initiating transfer with tokens. |
Response
Response Object
Property | Type | Description |
---|---|---|
confirmationCd | String | tranferId returned by Backoffice |
transferId | String | Database primary key |
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
Accpet Transfer that initiated with Seat Details
curl --location 'https://link-sandbox.paciolan.info/v1/tickets/transfer/accept?distributorCode=AMTX' \
--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 '{
"transferId": "w53hKM1ZPmDBgYsq68VW6xR6KLLeoWCR"
}'
Accept Transfer that initiated with Tokens
curl --location 'https://link-sandbox.paciolan.info/v1/tickets/transfer/accept' \
--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 '{
"transferId": "w53hKM1ZPmDBgYsq68VW6xR6KLLeoWCR",
"Recipient": {
"email": "ta236@paciolan.com",
"recipientFirstName": "Juan",
"recipientLastName": "Ramirez"
}
}'
Responses
Success Response
< HTTP/1.1 200
{
"confirmationCd": "3785222-AMTX:10237",
"transferId": "w53hKM1ZPmDBgYsq68VW6xR6KLLeoWCR"
}
Failure Response
< HTTP/1.1 400
{
"error": {
"type": "INVALID_PARAMETER_VALUE",
"developerMessage": "Invalid input. Please provide valid data.",
"appErrorCode": "MS-400"
}
}