Network tokens
Suspend network token
Suspends a specific network token.
POST
/
payment-methods
/
{payment_method_id}
/
network-tokens
/
{network_token_id}
/
suspend
This endpoint requires the payment-methods.write
scope.
Authorizations
Authorization
string
headerrequiredBearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
payment_method_id
string
requiredThe ID of the payment method.
network_token_id
string
requiredThe ID of the network token.
Response
200 - application/json
A network token generated by an open-loop PSP.
type
enum<string>
The type of this resource.
Available options:
network-token
id
string
The unique ID of the token.
payment_method_id
string
The unique ID of the payment method.
status
enum<string>
The state of the network token.
active
- The network token is active and ready to be used.inactive
- The network token is being deactivated.suspended
- The network token is suspended.deleted
- The network token is deleted.
Available options:
active
, inactive
, suspended
, deleted
token
string
The value of the network token.
expiration_date
string | null
The expiration date for the network token.
Required string length:
5
created_at
string
The date and time when this network token was first created in our system.
updated_at
string
The date and time when this network token was last updated in our system.
Was this page helpful?