Sign in
Transfers

Cancel a Transfer

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 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

Changed in 1 of the 2 revisions of this API.2

  • 54f4fe726d8f2See the full diff
    • ○

      added subschema #1 subschema #2 to the response body allOf list for the response status 200

      response-body-all-of-added

    • ○

      removed subschema #1 subschema #2 from the response body allOf list for the response status 200

      response-body-all-of-removed