Skip to navigation

Get payin by ID

View as Markdown

Retrieves detailed information about a specific payin by its unique identifier. This endpoint returns the complete payin object including current status and payin metadata.

Path Parameters

ParameterTypeRequiredDescription
payin_idUUIDYesUnique identifier of the payin to retrieve

Success Responses

Status CodeDescription
200OK - The payin was successfully retrieved

Error Responses

Status CodeError CodeDescription
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

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 retrieved successfully
dataobject
Response model for payin operations.
warningstring or nullOptional

Errors

404
Not Found Error