NEnewline53
Virtual Reference Numbers

Lock a single Virtual Reference Number

Changed on

Locks a Virtual Reference Number to prevent new transactions or usage. This is typically used for fraud prevention or temporary deactivation.

put/virtual_reference_numbers/{uid}/lock

Request

Request body

lock_reason'admin' | 'customer_request' required

Lock reason

Example request

{
  "lock_reason": "disabled by client request"
}

Response

The locked Virtual Reference Number resource is returned

Schema required(unresolved $ref)

Changes

  • 5f8163e29af4Revision changes
    • info

      added the optional property / to the response with the status

  • 54f4fe726d8fRevision changes
    • breaking

      the / response's property type changed from no type to string for status

    • info

      added to the / response property allOf list for the response status