Update Payment Token Details

PATCH 
/paymentTokens/{paymentTokenId}

For cards, allows updating card holder name and expiration of the token. Can link to a buyer as well.

Request

Path Parameters

paymentTokenId uuidrequired

Represents a customer bank account in the Nuvei system.

application/json

Body

required

processingEntityId uuid

Processing entityId provided by Nuvei.

paymentOption

object

card

object

cardHolderName CardHolderName (string)

Possible values: <= 70 characters

The card holder name.

expirationMonth Card Expiration - Month (string)

Possible values: >= 2 characters and <= 2 characters, Value must match regular expression ^(0[1-9]|1[0-2])$

The card expiration month.

expirationYear Card Expiration - Year (string)

Possible values: >= 2 characters and <= 4 characters, Value must match regular expression ^(\d{4}|\d{2})$

The card expiration year.

alternativePaymentMethod

object

data

object

property name* string
buyerId BuyerId (string)

Possible values: <= 255 characters

merchantReference Merchant Reference for Payment Token (string)

Possible values: <= 50 characters

Merchant Reference for a business entity (token, subscription, etc.)

usageIntent declared MIT usage for the payment token (string)

Possible values: [recurring, unscheduled]

Responses

200

OK

application/json

Schema

Schema

result

object

required

status stringrequired

Possible values: [success, error]

errors

object

code string

Possible values: <= 11 characters

reason string

Possible values: <= 400 characters

Example (from schema)

{
  "result": {
    "status": "success",
    "errors": {
      "code": "7000.1000",
      "reason": "Unexpected error"
    }
  }
}

Loading...