SchemaTokenizationSecure Tokens

Partially update secure token

View as MarkdownOpen in Claude
Use this method to partially update a secure token. Structure your request to follow the [RFC 6902](https://datatracker.ietf.org/doc/html/rfc6902) standard. To update a secure token, you need its secureTokenId, which you sent in the request of the [Create Secure Token](https://docs.payroc.com/api/schema/tokenization/secure-tokens/create) method. **Note:** If you don't have the secureTokenId, use our [List Secure Tokens](https://docs.payroc.com/api/schema/tokenization/secure-tokens/list) method to search for the payment. You can update all of the properties of the secure token, except the following: - processingTerminalId - type - token - status - source/Card - type - cardNumber - cardType - currency - debit - surcharging - source/ACH account - accountNumber - routingNumber - source/PAD account - type - accountNumber - transitNumber

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

processingTerminalIdstringRequired4-50 characters
Unique identifier that we assigned to the terminal.
secureTokenIdstringRequired1-200 characters
Unique identifier that the merchant assigned to the secure token.

Headers

Idempotency-KeystringRequiredformat: "uuid"
Unique identifier that you generate for each request. You must use the [UUID v4 format](https://www.rfc-editor.org/rfc/rfc4122) for the identifier. For more information about the idempotency key, go to [Idempotency](https://docs.payroc.com/api/idempotency).

Request

This endpoint expects a list of objects.
addobjectRequired
A Patch Add Operation.
OR
removeobjectRequired
A Patch Remove Operation.
OR
replaceobjectRequired
A Patch Replace Operation.
OR
moveobjectRequired
A Patch Move Operation.
OR
copyobjectRequired
A Patch Copy Operation.
OR
testobjectRequired
A Patch Test Operation.

Response

Successful request. We updated the customer's payment details.
secureTokenIdstring0-200 characters
Unique identifier that the merchant created for the secure token that represents the customer's payment details.
processingTerminalIdstring4-50 characters
Unique identifier that we assigned to the terminal.
sourceobject

Polymorphic object that contains the payment method that we tokenized.

The value of the type parameter determines which variant you should use:

  • ach - Automated Clearing House (ACH) details
  • pad - Pre-authorized debit (PAD) details
  • card - Payment card details
tokenstring12-19 characters

Token that the merchant can use in future transactions to represent the customer’s payment details. The token:

  • Begins with the six-digit identification number 296753.
  • Contains up to 12 digits.
  • Contains a single check digit that we calculate using the Luhn algorithm.
statusenum

Outcome of a security check on the status of the customer’s payment card or bank account.

Note: Depending on the merchant’s account settings, this feature may be unavailable.

mitAgreementenum

Indicates how the merchant can use the customer’s card details, as agreed by the customer:

  • unscheduled - Transactions for a fixed or variable amount that are run at a certain pre-defined event.
  • recurring - Transactions for a fixed amount that are run at regular intervals, for example, monthly. Recurring transactions don’t have a fixed duration and run until the customer cancels the agreement.
  • installment - Transactions for a fixed amount that are run at regular intervals, for example, monthly. Installment transactions have a fixed duration.
Allowed values:
customerobject
Object that contains the customer's contact details and address information.
customFieldslist of objects
Array of customField objects.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
406
Not Acceptable Error
409
Conflict Error
415
Unsupported Media Type Error
500
Internal Server Error