payment_methods

Retain payment method

Changed on Nov 3, 2026

Retain (keep in the Spreedly vault for future use) a payment method.

put/payment_methods/{payment_method_token}/retain

Request

Base URL
https://core.spreedly.com/v1
Auth
HTTP basic
TypeScript
https://skmtc.dev/spreedly/apis/spreedly-api-v1/docs/payment_methods/:payment_method_token/retain/put.ts
A function with typed inputs. Its response is checked against the schema.

Request body

boolean required

true if this transaction should attempt to provision a network token. false or omit this element to not provision a network token for this transaction. Please see our network tokenization guide for more details.

Response

successful

Changes

Nov 3, 2026a33f10acbf55 Revision changes
- info
  added the optional property // to the response with the status (media type: application/json)
- info
  added the optional property // to the response with the status (media type: application/xml)
- info
  added the optional property // to the response with the status (media type: application/json)
- info
  added the optional property // to the response with the status (media type: application/xml)
- info
  added the optional property // to the response with the status (media type: application/json)
- info
  added the optional property // to the response with the status (media type: application/xml)
- info
  added the optional property // to the response with the status (media type: application/json)
- info
  added the optional property // to the response with the status (media type: application/xml)
- info
  added the optional property // to the response with the status (media type: application/json)
- info
  added the optional property // to the response with the status (media type: application/xml)
- info
  added the optional property // to the response with the status (media type: application/json)
- info
  added the optional property // to the response with the status (media type: application/xml)
- info
  added the optional property // to the response with the status (media type: application/json)
- info
  added the optional property // to the response with the status (media type: application/xml)
- info
  added the optional property // to the response with the status (media type: application/json)
- info
  added the optional property // to the response with the status (media type: application/xml)
- info
  added the optional property // to the response with the status (media type: application/json)
- info
  added the optional property // to the response with the status (media type: application/xml)
- info
  added the optional property // to the response with the status (media type: application/json)
- info
  added the optional property // to the response with the status (media type: application/xml)

Operation history

Retain payment method

Request

Request body

Response 200OK

Changes

Response