NEnewline53
Transfers

Cancel a Transfer

Changed on

Transfers must be canceled by the originating Customer (or Authorized Representative).

Transfers can only enter the canceled state if Newline receives a request while the Transfer is in queued or pending states.

A cancellation request during the pending state is not guaranteed, as this state may include payment execution. At that stage, a cancel request will result in an error.

put/transfers/{uid}/cancel

Request

Request body

authorized_representative_namestring

Name of the authorized representative who wants to cancel the transfer. Max 35 characters.

cancellation_reasonstring

Reason for cancellation. Max 135 characters.

Example request

{
  "authorized_representative_name": "Swee'Pea",
  "cancellation_reason": "Transfer submitted by accident"
}

Response

The updated Transfer resource is returned

Schema required(unresolved $ref)

Changes

  • 6f45d84cfa7bRevision changes
    • warning

      added the new TRAD enum value to the // response property for the response status

    • info

      the //// response's property pattern was changed from ^.{1,80}$ to ^[^\r\n]{1,80}$ for the status

  • 5f8163e29af4Revision changes
    • warning

      removed the optional property //// from the response with the status