GEgetpliant
External Transfers

Update External Transfer Status

Changed on

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.

patch/external-transfers/{externalTransferId}/status

Request

Path parameters

externalTransferIdstring uuid required

The unique identifier of the external transfer.

Request body

status'DRAFT' | 'NEEDS_APPROVAL' | 'APPROVED' | 'COMPLIANCE_CHECK' | 'COMPLIANCE_PASSED' | 'COMPLIANCE_REVIEW' | 'PAYMENT_IN_PROGRESS' | 'PAID' | 'FAILED' 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
  • COMPLIANCE_CHECK: Transfer is undergoing compliance checks
  • COMPLIANCE_PASSED: Transfer has passed compliance checks
  • COMPLIANCE_REVIEW: Transfer is under compliance review
  • PAYMENT_IN_PROGRESS: Transfer is currently being processed
  • PAID: Transfer has been successfully completed
  • FAILED: Transfer has failed

Response

Ok

Schema required(unresolved $ref)

Changes