Skip to navigation

Cancel payin

View as Markdown

Cancels a pending payin by marking it as canceled. Only payins in CREATED status can be canceled. Once a payin is approved or initiated, it can no longer be canceled.

Path Parameters

ParameterTypeRequiredDescription
payin_idUUIDYesUnique identifier of the payin to cancel

Success Responses

Status CodeDescription
204No Content - The payin was successfully canceled

Error Responses

Status CodeError CodeDescription
400INVALID_STATUSPayin cannot be canceled due to invalid status (only CREATED payins can be canceled)
401AUTHENTICATION_ERRORAuthentication credentials are invalid or missing
403AUTHORIZATION_ERRORYou do not have permission to perform this action
404PAYIN_NOT_FOUNDThe specified payin was not found or doesn’t belong to your entity
500CANCELLATION_FAILEDFailed to cancel payin due to unexpected error

Authentication

x-api-keystring

RootPay API key sent in the x-api-key header. Keys are environment-scoped: live_* for production, test_* for sandbox.

Path parameters

payin_idstringRequiredformat: "uuid"

Response

Payin canceled successfully

Errors

404
Not Found Error