Edit Token API

The Edit Token API enables you to view an existing token's details and to change the payment instrument for the token.

Request Parameters

Parameter	Description	Required
`callerReference`	A value you provide that uniquely identifies the request. For more information, see Important Values to Store in Your Database. Type: String Default: None Constraint: Max size = 128 bytes	Yes
`paymentMethod`	A comma-separated list that enables you to pass payment methods supported by the merchant. Type: String Default: `ABT` Valid Values: `CC` \| `ACH` \| `ABT`	No
`tokenID`	Specifies the token you want to edit. You can only edit multi-use or recurring tokens. Type: String Constraint: Max size = 65 characters	Yes

Parameter

Description

Required

callerReference

A value you provide that uniquely identifies the request. For more information, see Important Values to Store in Your Database.

Type: String

Default: None

Constraint: Max size = 128 bytes

Yes

paymentMethod

A comma-separated list that enables you to pass payment methods supported by the merchant.

Type: String

Default: ABT

Valid Values: CC | ACH | ABT

tokenID

Specifies the token you want to edit. You can only edit multi-use or recurring tokens.

Type: String

Constraint: Max size = 65 characters

Yes

The request also uses the parameters common to all Co-Branded service API requests. For more information, see Common Parameters.

Parameter	Description
`errorMessage`	This is text in a human readable form that specifies the reason for a request failure. Type: String
`expiry`	This specifies the expiry (if any) of the payment method associated with the token. Type: String
`status`	The status of the Co-Branded service request. Type: String Valid Values: See Status Codes.
`tokenID`	This specifies the token ID associated with the new token. Type: String

Responses also include parameters common to all responses. For more information, see Response Parameters.

Status Code	Description
SU	The token has not changed.
SA	The status of the token that uses ABT as the payment method has changed.
SB	The token that uses ACH as the payment method has changed.
SC	The token that uses CC as the payment method has changed.
SE	System error.
A	Buyer abandoned the pipeline.
CE	Specifies a caller exception.
IT	Specifies an invalid token. The token passed is invalid, expired, or cannot be modified.
NA	Specifies that the user account does not exist.
UT	Specifies an unauthorized access to the token. The token does not belong to the user.
PE	Specifies a payment method mismatch error. The user does not have payment method that you requested.