Skip to main content

Update Payment Token Details

PATCH 
/payment-tokens/{payment-token-id}

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

Request​

Path Parameters

    payment-token-id Payment Token IDrequired

    Represents a customer bank account in the Nuvei system.

Body

required

    processingEntityId uuidrequired

    Processing entityId provided by Nuvei.

    Example: 80aef199-b89a-4d59-ba0c-f2cd3c25d5cd

    paymentOption

    object

    card

    object

    cardHolderName CardHolderName (string)

    The cardholder name.

    Possible values: <= 70 characters

    Example: Jada Pinkett
    expirationMonth Card Expiration - Month (string)

    The card expiration month.

    Possible values: Value must match regular expression ^(0[1-9]|1[0-2])$

    Example: 06
    expirationYear Card Expiration - Year (string)

    The card expiration year.

    Possible values: Value must match regular expression ^(\d{4}|\d{2})$

    Example: 2022

    alternativePaymentMethod

    object

    data

    object

    property name* password
    buyerId BuyerId (string)

    Possible values: <= 255 characters

    merchantReference Merchant Reference for Payment Token (string)

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

    Possible values: <= 50 characters

    Example: MREF_6f06168d-ff6e-448b-8401-30051eb6b1af
    usageIntent declared MIT usage for the payment token (string)

    Possible values: [recurring, unscheduled]

Responses​

OK

Schema

    result

    object

    required

    status stringrequired

    Possible values: [success, error]

    errors

    object

    code string

    If an error occurred on the request side, an error code is returned in this parameter.

    Possible values: <= 11 characters

    Example: 7000.1000
    reason string

    If an error occurred on the request side, then an error reason is returned in this parameter.

    Possible values: <= 400 characters

    Example: Unexpected error
Loading...