POST
/
payment-methods
/
{payment_method_id}
/
network-tokens

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

Authorization
string
headerrequired

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

Path Parameters

payment_method_id
string
required

The ID of the payment method.

Body

application/json

Request body for provision a network token.

merchant_initiated
boolean
required

Defines if the request is merchant initiated or not.

is_subsequent_payment
boolean
required

Defines if the request is a subsequent of another request or not.

security_code
string | null

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.

Required string length: 3 - 4

Response

201 - 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?

Get network tokensIssue cryptogram