Skip to navigation

Approve single payin

View as Markdown

Approves a single payin for processing. The payin must be in CREATED status.

Response body

FieldTypeDescription
dataObjectThe payin object (status reflects the state at response time)

Success responses

Status CodeDescription
201The payin was approved and processing continued; data.status reflects the outcome of this request.
202The request was accepted and data includes the payin, but data.status may still change. Poll GET /api/payins/{id} until the payin reaches a terminal status.

Error and retry responses

Status CodeError codeDescription
400INVALID_STATUSThe payin is not in CREATED status and cannot be approved.
401AUTHENTICATION_ERRORAuthentication credentials are invalid or missing.
403AUTHORIZATION_ERRORYou do not have permission to perform this action.
404PAYIN_NOT_FOUNDPayin not found or does not belong to your entity.
503(see response body)Transient error—bank initiation could not be started for this request. Retry the same approve call after a short wait. The JSON body includes error_code and message for logging and automation.

Notes

  • Treat 202 like any accepted operation: use the returned id and poll until status stabilizes.
  • 503 is for retries, not a final business outcome for the transfer.
  • After approval, bank processing may continue after this response returns. There is no sync “initiation failed” 207 on this endpoint.

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

Errors

404
Not Found Error
503
Service Unavailable Error