Provision network token
Provision a network token for a stored card.
This endpoint requires the payment-methods.write
scope.
Network token provisioning via the API is not enabled by default in production.
Please contact support for further guidance.
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
The ID of the payment method.
Body
The 3 or 4 digit security code often found on the card. This often referred to as the CVV or CVD.
The security code can only be set if the stored payment method represents a card.
Defines if the request is merchant initiated or not.
Defines if the request is a subsequent of another request or not.
Response
The type of this resource.
network-token
The unique ID of the token.
The unique ID of the payment method.
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.
active
, inactive
, suspended
, deleted
The value of the network token.
The expiration date for the network token.
The date and time when this network token was first created in our system.
The date and time when this network token was last updated in our system.
Was this page helpful?