API Changelog - 2026-06-25: Summary
The paymentMethod.token.status field is now returned in payment and
transaction responses when a tokenized Visa, Mastercard, Maestro, or
Troy card payment is retrieved. The field indicates whether the token is
currently active or suspended.
GET /v1/payments — Get All Payments
For Visa, Mastercard, Maestro, and Troy payment methods, the
paymentMethod.token object (present when the payment was made using a
stored card token) now includes a required status field. Integrations
that read token details from payment list responses should expect this
field to always be present.
| Property | Details |
|---|---|
| Name | paymentMethod.token.status |
| Location | Response body (data[]) |
| Type | string |
| Required | Yes — when paymentMethod.token is present |
| Format | Enum: active, suspended |
| Example | "active" |
GET /v1/payments/{paymentId} — Get Payment by ID
For Visa, Mastercard, Maestro, and Troy payment methods, the
paymentMethod.token object (present when the payment was made using a
stored card token) now includes a required status field. Integrations
that read token details from payment responses should expect this field
to always be present.
| Property | Details |
|---|---|
| Name | paymentMethod.token.status |
| Location | Response body |
| Type | string |
| Required | Yes — when paymentMethod.token is present |
| Format | Enum: active, suspended |
| Example | "active" |
GET /v1/transactions — Get All Transactions
For payment-type transactions using Visa, Mastercard, Maestro, or Troy,
the paymentMethod.token object (present when the transaction used a
stored card token) now includes a required status field.
| Property | Details |
|---|---|
| Name | paymentMethod.token.status |
| Location | Response body (data[]) |
| Type | string |
| Required | Yes — when paymentMethod.token is present |
| Format | Enum: active, suspended |
| Example | "active" |
GET /v1/transactions/{transactionId} — Get Transaction by ID
For payment-type transactions using Visa, Mastercard, Maestro, or Troy,
the paymentMethod.token object (present when the transaction used a
stored card token) now includes a required status field.
| Property | Details |
|---|---|
| Name | paymentMethod.token.status |
| Location | Response body |
| Type | string |
| Required | Yes — when paymentMethod.token is present |
| Format | Enum: active, suspended |
| Example | "active" |