Sign in
General

Disable stored payment details

Disables stored payment details to stop charging a shopper with this particular recurring detail ID.

For more information, refer to Disable stored details.

post/disable

Request body

contractstring

Specify the contract if you only want to disable a specific use.

This field can be set to one of the following values, or to their combination (comma-separated):

  • ONECLICK
  • RECURRING
  • PAYOUT
merchantAccountstring required

The merchant account identifier with which you want to process the transaction.

recurringDetailReferencestring

The ID that uniquely identifies the recurring detail reference.

If it is not provided, the whole recurring contract of the shopperReference will be disabled, which includes all recurring details.

shopperReferencestring required

The ID that uniquely identifies the shopper.

This shopperReference must be the same as the shopperReference used in the initial payment.

Response

OK - the request has succeeded.

responsestring

Depending on whether a specific recurring detail was in the request, result is either [detail-successfully-disabled] or [all-details-successfully-disabled].

Changes

Changed in 6 of the 38 revisions of this API.1418

  • v253143012dc3447See the full diff
    • ▲

      the request's body type changed from no type to object

      request-body-type-changed

    • ▲

      the response's body type changed from no type to object for status

      response-body-type-changed

    • ▲

      the response's body type changed from no type to object for status

      response-body-type-changed

    • ▲

      the response's body type changed from no type to object for status

      response-body-type-changed

    • ▲

      the response's body type changed from no type to object for status

      response-body-type-changed

    • ▲

      the response's body type changed from no type to object for status

      response-body-type-changed

    • ▲

      the response's body type changed from no type to object for status

      response-body-type-changed

  • v2508dafb1e4a013See the full diff
    • ○

      the endpoint scheme security ApiKeyAuth was added to the API

      api-security-added

    • ○

      the endpoint scheme security BasicAuth was added to the API

      api-security-added

    • ○

      api tag General added

      api-tag-added

  • v25a71fe366dba05See the full diff
    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

  • v259aa7722f81425See the full diff
    • ○

      added the media type application/json for the response with the status

      response-media-type-added

    • ○

      added the media type application/json for the response with the status

      response-media-type-added

    • ○

      added the media type application/json for the response with the status

      response-media-type-added

    • ○

      added the media type application/json for the response with the status

      response-media-type-added

    • ○

      added the media type application/json for the response with the status

      response-media-type-added

  • v25aaba80d479bb1See the full diff
    • ○

      api operation id post-disable was added

      api-operation-id-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • v25016d859e847f74See the full diff
    • ▲

      the request's body type changed from object to no type

      request-body-type-changed

    • ▲

      the response's body type changed from object to no type for status

      response-body-type-changed

    • ▲

      removed the media type application/json for the response with the status

      response-media-type-removed

    • ▲

      removed the media type application/json for the response with the status

      response-media-type-removed

    • ▲

      removed the media type application/json for the response with the status

      response-media-type-removed

    • ▲

      removed the media type application/json for the response with the status

      response-media-type-removed

    • ▲

      removed the media type application/json for the response with the status

      response-media-type-removed

    • ○

      api operation id post-disable removed and replaced with

      api-operation-id-removed

    • ○

      the endpoint scheme security ApiKeyAuth was removed from the API

      api-security-removed

    • ○

      the endpoint scheme security BasicAuth was removed from the API

      api-security-removed

    • ○

      api tag General removed

      api-tag-removed

    This revision also has 8 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog