Update External Transfer Status

patch

https://partner-api.getpliant.com/api/external-transfers/{externalTransferId}/status

Update the status of an existing external transfer. This endpoint allows you to change the transfer status, for example to approve, reject, or mark as paid.

The available status transitions depend on the current status of the transfer and your organization's configuration.

Path Params

externalTransferId

uuid

required

The unique identifier of the external transfer.

Body Params

status

string

enum

required

The new status for the external transfer. It can be one of the following values:

DRAFT: Transfer is in draft state and can be modified
NEEDS_APPROVAL: Transfer requires approval before processing
APPROVED: Transfer has been approved and is ready for processing
REJECTED: Transfer has been rejected
COMPLIANCE_CHECK: Transfer is undergoing compliance checks
COMPLIANCE_PASSED: Transfer has passed compliance checks
COMPLIANCE_REVIEW: Transfer is under compliance review
COMPLIANCE_BLOCKED: Transfer has been blocked by compliance
PAYMENT_IN_PROGRESS: Transfer is currently being processed
PAID: Transfer has been successfully completed
FAILED: Transfer has failed

Responses

200Ok

400Bad Request. The API consumer sent a malformed request which could not be processed.

401Unauthorized. The API consumer is not authorized to access the requested resource.

403Forbidden. The API consumer is not allowed to access the requested resource.

404Not Found. The requested resource could not be found.

409Conflict. The request could not be completed due to a conflict with the current state of the resource. You may retry the call.

429Too Many Requests. The API consumer has sent too many requests in a given amount of time. Please check our API guidelines.

500Internal Server Error. The request was not completed due to an internal error.