Adjust increases the reserved amount of a pre-authorisation. Use it when the final order amount grows after the initial pre-auth — for example, when a customer adds items or extends a rental period.
You can only adjust an uncaptured pre-authorisation.
API request
curl --request POST \
--url https://gateway.paybyrd.com/api/v2/adjust/{transactionId} \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'x-api-key: {your_api_key}' \
--data '{"amount": "5.00"}'
| Parameter | Location | Description |
|---|
transactionId | URL path | ID of the pre-authorised transaction to adjust |
amount | Request body | The additional amount to add to the reserved total |
Response
{
"code": "BYRD200",
"description": "Operation successfully completed",
"transactionId": "c16ce479-319d-4e7b-a966-7735c34b2cc5",
"amount": "15.00",
"previousAmount": "10.00"
}
| Field | Description |
|---|
code | BYRD200 = success |
transactionId | ID of the adjusted transaction |
amount | Updated total reserved amount after the adjustment |
previousAmount | Reserved amount before the adjustment |
