Create Network Token

POST 
/network-tokens

This endpoint initiates token provisioning. Please refer to Network Tokens Integration Process.

Request

Header Parameters

Content-Type stringrequired

Must be application/json

Accept-Language stringrequired

Must be be en-US

Origin stringrequired

The origin of the request

User-Agent stringrequired

The client making the request

application/json

Body

required

integrationFlow stringrequired

Possible values: <= 20 characters, [payment-form, direct]

Set payment-form to leave PAN and other card details collection on SmartPay, see Network Token Web SDK.
Or direct if PAN is collected by you own (PCI-DSS Level 1 is required). If direct is provided, then a token will be immediately generated.

accountReferenceId uuidrequired

Identifier of the customer account in merchant's system, if applicable. Otherwise, random unique value to be provided.

accountCategory stringrequired

Possible values: <= 30 characters, [EWalletUser]

Constant value EWalletUser.

currencyCode stringrequired

Possible values: >= 3 characters and <= 3 characters

Three-characters currency code of the currency that will be used to perform 3DS authentication (only). Does not restrict the currencies of further payments.

billingAddress

object

required

Consumer's billing address data. See Address in Data model.

addressLine1 stringrequired

Possible values: <= 60 characters

Street name.

addressLine2 string

Possible values: <= 60 characters

Apartment, suite, unit, building, floor or other secondary address information.

addressLine3 string

Possible values: <= 60 characters

Specific delivery instructions, department names, or additional floor information.

city stringrequired

Possible values: <= 50 characters

The city or localitly of the address.

countryCode stringrequired

Possible values: >= 3 characters and <= 3 characters

ISO-3 code of the address country (e.g., DEU for Germany).

number string

Possible values: <= 10 characters

The house or building number corresponding to the street address.

postCode stringrequired

Possible values: <= 10 characters

The postal or ZIP code of the address.

state string

Possible values: <= 3 characters

3-letter code of the address state. Mandatory when countryCode corresponds to Canada or USA.

shippingAddress

object

Consumer's shipping address data. See Address in Data model.

addressLine1 stringrequired

Possible values: <= 60 characters

Street name.

addressLine2 string

Possible values: <= 60 characters

Apartment, suite, unit, building, floor or other secondary address information.

addressLine3 string

Possible values: <= 60 characters

Specific delivery instructions, department names, or additional floor information.

city stringrequired

Possible values: <= 50 characters

The city or localitly of the address.

countryCode stringrequired

Possible values: >= 3 characters and <= 3 characters

ISO-3 code of the address country (e.g., DEU for Germany).

number string

Possible values: <= 10 characters

The house or building number corresponding to the street address.

postCode stringrequired

Possible values: <= 10 characters

The postal or ZIP code of the address.

state string

Possible values: <= 3 characters

3-letter code of the address state. Mandatory when countryCode corresponds to Canada or USA.

consumer

object

required

Consumer's personal data, in case the consumer is a physical person.
Mandatory, unless businessConsumer is provided.
consumer and businessConsumer objects may not be submitted together.

culture string

Possible values: <= 5 characters

Consists of ISO 639-1 language code and ISO 3166-1 alpha-2 country code separated by dash. If this value is not provided the browser culture is used. Default culture is English (e.g., en-de). This field is not case sensitive.

dateOfBirth date

Possible values: <= 10 characters, Value must match regular expression ^\d{4}-\d{2}-\d{2}$

Date of birth. Format - YYYY-MM-DD. Mandatory for payment option registration flow. Minimum date allowed is 1900-01-01

emailAddress emailrequired

Possible values: <= 255 characters

Customer email address for any notification

firstName stringrequired

Possible values: <= 60 characters

Person first name

gender string

Possible values: <= 6 characters

Person gender

homePhone string

Possible values: <= 30 characters

Person's home phone number (including the country code)

lastName stringrequired

Possible values: <= 60 characters

Person last name

merchantCustomerId string

Possible values: <= 255 characters

Consumer/Customer Account Id in the merchant system. When provided into the Create Checkout API, SmartPay will request e-wallet account creation which will have external account reference equals to the given merchantCustomerId value.

middleName string

Possible values: <= 60 characters

The customer's middle name

mobilePhone string

Possible values: <= 30 characters

Person's mobile phone number (including the country code)

taxId string

Possible values: <= 30 characters

Person's tax identification number

timezone string

Possible values: <= 50 characters

Preferred timezone name

title string

Possible values: <= 3 characters

Person title

workPhone string

Possible values: <= 30 characters

Person's work phone number (including the country code)

cardDetails

object

Card details required only if integrationFlow is set to direct.

cardBrand stringrequired

Possible values: <= 10 characters

Brand of the card used.

cardHolder stringrequired

Possible values: <= 64 characters

Name of the cardholder.

cardToken stringrequired

Possible values: <= 32 characters

Permanent token for the PAN.

cvvToken stringrequired

Possible values: <= 18 characters

Permanent token for the CVV.

cardExpiryMonth stringrequired

Possible values: <= 2 characters

Expiry month of the card.

cardExpiryYear stringrequired

Possible values: <= 4 characters

Expiry year of the card.

Responses

200

Successful response with token details.

tip

The Create Token response includes the 36-character GUID tokenId.

application/json

Schema

Schema

tokenId uuid

Possible values: <= 36 characters

The generated token ID.

createdAt date-time

Possible values: <= 30 characters

Timestamp of token creation.

updatedAt date-time

Possible values: <= 30 characters

Timestamp of last update.

authorizationId uuid

Possible values: <= 36 characters

Authorization ID for the transaction.

externalMerchantId uuid

Possible values: <= 36 characters

External merchant ID.

status string

Possible values: <= 32 characters

Current status of the token.

Example (from schema)

{
  "tokenId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "createdAt": "2024-07-29T15:51:28.071Z",
  "updatedAt": "2024-07-29T15:51:28.071Z",
  "authorizationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "externalMerchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "status": "string"
}

Example

{
  "tokenId": "fb80458c-82ad-4abb-9e96-fc7d0a8b3d59",
  "createdAt": "2023-03-21T13:57:03.138Z",
  "updatedAt": "2023-03-21T13:57:03.138Z",
  "authorizationId": "b50938f6-3f6b-4716-a173-6fe726a1db31",
  "externalMerchantId": "9ff980b6-1fc6-4b61-9957-f8655b04cd9d",
  "status": "PENDING_PAYMENT_FORM"
}

400

Bad Request response with error messages.

info

If you receive an HTTP status other than 2xx, the request failed. Please try to interpret the response message to correct your request and contact Customer Support in case of further questions.

application/json

Schema

Schema

message string[]

List of error messages.

Example (from schema)

{
  "message": [
    "string"
  ]
}

Example

{
  "message": [
    "accountReferenceId must be a string",
    "accountReferenceId should not be empty",
    {
      "accountCategory must be one of the following values": "EWalletUser, Guest"
    },
    "accountCategory should not be empty"
  ]
}

401

Unauthenticated

info

For error handling, please refer to this section.

application/json

Schema

Schema

error string

errorDetails

object

context object

gatewayDescription string

paymentProviderDescription string

message

object

oneOf

MOD1

string

MOD2

Array [

string

]

Example (from schema)

{
  "error": "string",
  "errorDetails": {
    "context": {},
    "gatewayDescription": "string",
    "paymentProviderDescription": "string"
  },
  "message": "string"
}

Example

{
  "traceId": "00-1234567890abcdef0123456789abcdef-0123456789abcdef-00",
  "errors": [
    {
      "message": "You are not authenticated to perform this request.",
      "code": "unauthorized"
    }
  ]
}

403

Forbidden

info

For error handling, please refer to this section.

application/json

Schema

Schema

error string

errorDetails

object

context object

gatewayDescription string

paymentProviderDescription string

message

object

oneOf

MOD1

string

MOD2

Array [

string

]

Example (from schema)

{
  "error": "string",
  "errorDetails": {
    "context": {},
    "gatewayDescription": "string",
    "paymentProviderDescription": "string"
  },
  "message": "string"
}

Example

{
  "traceId": "00-1234567890abcdef0123456789abcdef-0123456789abcdef-00",
  "errors": [
    {
      "message": "You do not have permissions to perform this request.",
      "code": "forbidden"
    }
  ]
}

404

Not Found

info

For error handling, please refer to this section.

application/json

Schema

Schema

error string

errorDetails

object

context object

gatewayDescription string

paymentProviderDescription string

message

object

oneOf

MOD1

string

MOD2

Array [

string

]

Example (from schema)

{
  "error": "string",
  "errorDetails": {
    "context": {},
    "gatewayDescription": "string",
    "paymentProviderDescription": "string"
  },
  "message": "string"
}

Example

{
  "traceId": "00-1234567890abcdef0123456789abcdef-0123456789abcdef-00",
  "errors": [
    {
      "message": "Resource not found.",
      "code": "not_found"
    }
  ]
}

500

Internal Server Error

info

For error handling, please refer to this section.

application/json

Schema

Schema

error string

errorDetails

object

context object

gatewayDescription string

paymentProviderDescription string

message

object

oneOf

MOD1

string

MOD2

Array [

string

]

Example (from schema)

{
  "error": "string",
  "errorDetails": {
    "context": {},
    "gatewayDescription": "string",
    "paymentProviderDescription": "string"
  },
  "message": "string"
}

Example

{
  "traceId": "00-1234567890abcdef0123456789abcdef-0123456789abcdef-00",
  "errors": [
    {
      "message": "Internal server error."
    }
  ]
}

Loading...