payment_gateway_token_update_parameters

 payment_gateway_token_parameters object data

Name

Type

Description

action

(mandatory)

String

Defines if a new or existing payment gateway tokenized payment method (i.e. card) will be added, updated or removed. The supported values are the following:

ADD, REMOVE

payment_gateway_card_identifier

(mandatory and applicable only on remove)

Payment Gateway Card Identifier

The identifier of the payment gateway card that will be updated. The allowed payment gateway card identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The id of the payment gateway card

payment_gateway_reference_number

(semi-optional)

String

The card's reference number as provided by the payment gateway

last_digits

(semi-optional)

String The last digits of the card as provided by the payment gateway provider

The retrieved cards are always filtered based on their related accounts receivable payment preference and not across all cards

token

(mandatory and applicable only on add)

String

The token of the payment gateway payment method that will be registered

default

(optional, applicable only on add and update)

BooleanIt defines if the registered card should be the default card or not