API Documentation

Update Request

put https://{host}/v2/requests/

Update transaction or customer merge requests.

This API allows you to update the request to one of the following statuses:

  • APPROVED – Approves the request.
  • REJECTED – Rejects the request.
  • CUSTOM – Sets a custom intermediate status.
    Note: The CUSTOM status is not supported for Customer Merge requests.

❗️

You cannot approve a request that is REJECTED. To approve a rejected request, first change its status to PENDING, and then change it to APPROVED.

Transaction Request

This API is to update the transaction request only. To update regular transactions, see the Update regular transaction API.

Customer Merge Request

Customer Merge requests can be modified in standard organizations, organizations with dual eligibility enabled, and connected organizations.
In a connected organization setup, only the parent organization can modify the status of a request. Any request initiated from a child organization is blocked.

API Endpoint

https://{host}/v2/requests

Prerequisites

  • Authentication - Basic or OAuth authentication
  • Access group resource - Write permission on Requests resource group

Resource information

URIv2/requests
HTTP methodPUT
Pagination supported?NA
Rate limitNA
Batch supportNA

Request body parameters

ParameterData TypeDescription
type*EnumThe type of request.
Values: TRANSACTION - For transaction request
CHANGE_IDENTIFIER For customer merge request
baseType*EnumThe base type of the request.
Values: REGULAR_TXN_ADD - For transaction request
MERGE - For customer merge request
id*LongThe unique identifier of the request, generated during the POST call to add the request.
status*EnumThe status to which the request should be changed. Values: APPROVED, REJECTED, CUSTOM
commentsStringAdditional comments or notes related to the request. Example: Working
 '[
  {
    "type": "TRANSACTION",
    "baseType": "REGULAR_TXN_ADD",
    "id": 1031558,
    "status": "APPROVED",
    "comments": "Test"
  }
]'

	curl --location --request PUT 'https://eu.api.capillarytech.com/v2/requests' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic ZGlTdlYTI0YTYyZTZm' \
--header 'Cookie: _cfuvid=EWw7Wfz8Ouj54ZVF2cPldbObmSaOCCsfBD._qxSWZoM-1744468652196-0.0.1.1-604800000' \
--data '[{
    "type": "CHANGE_IDENTIFIER",
    "baseType": "MERGE",
    "status": "APPROVED", 
    "id": 13030101
}]'

	curl --location --request PUT 'https://eu.api.capillarytech.com/v2/requests' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic ZGlTdlYTI0YTYyZTZm' \
--header 'Cookie: _cfuvid=EWw7Wfz8Ouj54ZVF2cPldbObmSaOCCsfBD._qxSWZoM-1744468652196-0.0.1.1-604800000' \
--data '[{
    "type": "CHANGE_IDENTIFIER",
    "baseType": "MERGE",
    "status": "APPROVED", 
    "id": 13029191
}]'

	curl --location --request PUT 'https://eu.api.capillarytech.com/v2/requests' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic ZGlTdlYTI0YTYyZTZm' \
--header 'Cookie: _cfuvid=EWw7Wfz8Ouj54ZVF2cPldbObmSaOCCsfBD._qxSWZoM-1744468652196-0.0.1.1-604800000' \
--data '[{
    "type": "CHANGE_IDENTIFIER",
    "baseType": "MERGE",
    "status": "APPROVED", 
    "id": 13029723
}]'

Response parameters

ParameterData TypeDescription
responseArrayList of responses for each request processed.
- entityIdLongUnique identifier of the request.
- warningsArrayList of warnings encountered for the request, if any.
- errorsArrayList of errors encountered for the request, if any.
-- statusBooleanIndicates whether the API call was successful or not. Success- TrueFailure - False
-- codeIntegerError code explaining the reason for failure.
-- messageStringError message describing the issue.
totalCountIntegerTotal number of requests that were processed.
failureCountIntegerNumber of requests that failed during processing.
{
    "response": [
        {
            "entityId": 1031558,
            "result": true,
            "warnings": []
        }
    ],
    "totalCount": 1,
    "failureCount": 0
}

{
    "response": [
        {
            "entityId": 13030101,
            "result": true,
            "warnings": []
        }
    ],
    "totalCount": 1,
    "failureCount": 0
}

{
    "response": [
        {
            "entityId": 13029191,
            "result": true,
            "warnings": []
        }
    ],
    "totalCount": 1,
    "failureCount": 0
}

{
    "response": [
        {
            "entityId": 13029723,
            "errors": [
                {
                    "status": false,
                    "code": 9021,
                    "message": "Request Add/Update is blocked for the org"
                }
            ]
        }
    ],
    "totalCount": 1,
    "failureCount": 1
}

Error Codes

Error CodesDescriptionReason
9050Request not foundIncorrect request ID
9021Request Add/Update is blocked for the orgRequest originates from the child organization.
Language
URL
Click Try It! to start a request and see the response here!