Global Payments API
GP Developer PortalGP API reference
HomeAPI ReferenceSDKsContext Plugin
Payment Methods

Edit a Payment Method

PATCH
/payment-methods/{id}

Change information about a stored payment method such as update the card expiry date or the funding type of card or the bank identifier of the account number.

Authorization

bearerAuth
AuthorizationBearer <token>

Access token from POST /accesstoken, sent as Authorization: Bearer <token>.

In: header

Path Parameters

id*string

Unique Global Payments generated id used to reference a stored payment method on the Global Payments system. Often referred to as the payment method token. This value can be used instead of payment method details such as a card number and expiry date.

Header Parameters

X-GP-Version*string

The version of the API to execute the request.

Length1 <= length <= 50
Default"2021-03-22"
X-GP-Idempotency?string

Integrator generated value submitted in the request header that is checked to ensure the same value has not been seen in the last 24 hours. It is used to ensure idempotency is maintained with this action.

Length1 <= length <= 50

Request Body

application/json

usage_mode?string

Indicates the behaviour of the payment method token.

  • SINGLE - This value must be used if using the Hosted Fields or the Drop-in UI integration types. When creating the payment method token, this option ensures the payment method token is temporary and will be removed once a transaction is executed or after a short period of time.
  • MULTIPLE - When creating the payment method token, this indicates it is permanent and can be used to create many transactions.
  • USE_CARD_NUMBER - When using the payment method token to transaction process, this indicates to use the card number also known as the PAN or FPAN when bothe the card number and the network token are available.
  • USE_NETWORK_TOKEN - When using the payment method token to transaction process, this indicates to use the network token instead of the card number if both are available.
Length1 <= length <= 50
Default"MULTIPLE"

Value in

  • "SINGLE"
  • "MULTIPLE"
  • "USE_CARD_NUMBER"
  • "USE_NETWORK_TOKEN"
fingerprint_mode?string

Indicates whether to execute the fingerprint signature functionality.

  • ALWAYS - Always check and create the fingerprint value regardless of the result of the card authorization.
  • ON_SUCCESS - Always check and create the fingerprint value when the card authorization is successful.
Length1 <= length <= 50

Value in

  • "ALWAYS"
  • "ON_SUCCESS"
name?string

The name of the owner of the payment method. For example the cardholder's name.

Lengthlength <= 100
auto_updater?string

Indicates whether this payment token should be enabled for account updater services. Availability of this is dependent on your live configuration

Value in

  • "ENABLE"
  • "DISABLE"
card?

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/payment-methods/PMT_3367f648-558a-4979-8b1f-7002961d5d37" \  -H "X-GP-Version: 2021-03-22" \  -H "Content-Type: application/json" \  -d '{    "name": "John\'s payment method",    "card": {      "number": "4263970000005262",      "expiry_month": "05",      "expiry_year": "25"    }  }'
{  "id": "PMT_f5bbdfde-3010-4802-8f5d-1cdb2a2381c2",  "status": "ACTIVE",  "fingerprint_presence_indicator": "NEW",  "fingerprint": "string",  "usage_mode": "SINGLE",  "name": "John's payment method",  "auto_updater": "ENABLE",  "card": {    "masked_number_last4": "xxxxxxxxxxxx5262",    "expiry_month": "05",    "expiry_year": "25",    "brand": "VISA",    "brand_reference": "000000321000010"  },  "action": {    "id": "ACT_uzFr7t4VOqxdLDI44hHmXIjHtOOE8d",    "type": "PAYMENT_METHOD_CREATE",    "time_created": "2021-05-03T21:23:39.718Z",    "result_code": "SUCCESS",    "app_id": "uzFr7t4VOqxdLDI44hHmXIjHtOOE8d",    "app_name": "my_lovely_app"  }}

Get a Payment Method GET

Return a single view of a stored payment method.

Delete a Payment Method DELETE

Delete a stored payment method.