Update Payment Method

client.Accounts.PaymentMethods.Update(ctx, paymentMethodID, params) (*PaymentMethodUpdateResponse, error)

PUT/accounts/{account_id}/payment-methods/{payment_method_id}

Updates a payment method for an account.

Security

API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

Example:X-Auth-Email: user@example.com

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

Example:X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194

Accepted Permissions (at least one required)

Billing Write

ParametersExpand Collapse

paymentMethodID string

Identifier

maxLength32

params PaymentMethodUpdateParams

AccountID param.Field[string]

Path param: Identifier

maxLength32

Address param.Field[string]Optional

Body param: Billing address line 1.

Address2 param.Field[string]Optional

Body param: Billing address line 2.

BankAccountType param.Field[string]Optional

Body param: Bank account type.

BankCode param.Field[string]Optional

Body param: Bank code.

BankCountry param.Field[string]Optional

Body param: Bank country.

BankName param.Field[string]Optional

Body param: Bank name for bank-based payment methods.

BankRoutingNumber param.Field[string]Optional

Body param: Bank routing number.

CashappCashTag param.Field[string]Optional

Body param: Cash App cash tag.

City param.Field[string]Optional

Body param: Billing city.

Country param.Field[string]Optional

Body param: Billing country.

Default param.Field[bool]Optional

Body param: Whether this is the default payment method.

DeviceData param.Field[string]Optional

Body param: Device data for fraud prevention.

FirstName param.Field[string]Optional

Body param: Billing first name.

LastName param.Field[string]Optional

Body param: Billing last name.

NickName param.Field[string]Optional

Body param: A nickname for the payment method.

PaymentAccountEmail param.Field[string]Optional

Body param: Email associated with the payment account.

PaymentEmail param.Field[string]Optional

Body param: Payment email address.

PaymentGateway param.Field[string]Optional

Body param: The payment gateway used.

PaymentNonce param.Field[string]Optional

Body param: Payment nonce for tokenized payments.

State param.Field[string]Optional

Body param: Billing state.

Type param.Field[PaymentMethodUpdateParamsType]Optional

Body param: The payment method type.

const PaymentMethodUpdateParamsTypeCreditCard PaymentMethodUpdateParamsType = "CREDIT_CARD"

const PaymentMethodUpdateParamsTypePaypal PaymentMethodUpdateParamsType = "PAYPAL"

const PaymentMethodUpdateParamsTypeCashapp PaymentMethodUpdateParamsType = "CASHAPP"

const PaymentMethodUpdateParamsTypeSepaDebit PaymentMethodUpdateParamsType = "SEPA_DEBIT"

const PaymentMethodUpdateParamsTypeLink PaymentMethodUpdateParamsType = "LINK"

const PaymentMethodUpdateParamsTypeACHDirectDebit PaymentMethodUpdateParamsType = "ACH_DIRECT_DEBIT"

Zipcode param.Field[string]Optional

Body param: Billing zip code.

ReturnsExpand Collapse

type PaymentMethodUpdateResponse struct{…}

ID stringOptional

Payment method identifier.

Address stringOptional

Billing address line 1.

Address2 stringOptional

Billing address line 2.

BankAccountType stringOptional

Bank account type.

BankCode stringOptional

Bank code.

BankCountry stringOptional

Bank country.

BankName stringOptional

Bank name for bank-based payment methods.

BankRoutingNumber stringOptional

Bank routing number.

CashappCashTag stringOptional

Cash App cash tag.

City stringOptional

Billing city.

Country stringOptional

Billing country.

Default boolOptional

Whether this is the default payment method.

DeviceData stringOptional

Device data for fraud prevention.

ExpirationDate stringOptional

Card expiration date.

FirstName stringOptional

Billing first name.

LastFour stringOptional

Last four digits of the card number.

LastName stringOptional

Billing last name.

NickName stringOptional

A nickname for the payment method.

PaymentAccountEmail stringOptional

Email associated with the payment account.

PaymentEmail stringOptional

Payment email address.

PaymentGateway stringOptional

The payment gateway used.

PaymentNonce stringOptional

Payment nonce for tokenized payments.

State stringOptional

Billing state.

Type PaymentMethodUpdateResponseTypeOptional

The payment method type.

One of the following:

const PaymentMethodUpdateResponseTypeCreditCard PaymentMethodUpdateResponseType = "CREDIT_CARD"

const PaymentMethodUpdateResponseTypePaypal PaymentMethodUpdateResponseType = "PAYPAL"

const PaymentMethodUpdateResponseTypeCashapp PaymentMethodUpdateResponseType = "CASHAPP"

const PaymentMethodUpdateResponseTypeSepaDebit PaymentMethodUpdateResponseType = "SEPA_DEBIT"

const PaymentMethodUpdateResponseTypeLink PaymentMethodUpdateResponseType = "LINK"

const PaymentMethodUpdateResponseTypeACHDirectDebit PaymentMethodUpdateResponseType = "ACH_DIRECT_DEBIT"

Zipcode stringOptional

Billing zip code.

Update Payment Method

package main

import (
  "context"
  "fmt"

  "github.com/cloudflare/cloudflare-go"
  "github.com/cloudflare/cloudflare-go/accounts"
  "github.com/cloudflare/cloudflare-go/option"
)

func main() {
  client := cloudflare.NewClient(
    option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
  )
  paymentMethod, err := client.Accounts.PaymentMethods.Update(
    context.TODO(),
    "023e105f4ecef8ad9ca31a8372d0c353",
    accounts.PaymentMethodUpdateParams{
      AccountID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"),
    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", paymentMethod.ID)
}

{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": {
    "id": "id",
    "address": "address",
    "address2": "address2",
    "bank_account_type": "bank_account_type",
    "bank_code": "bank_code",
    "bank_country": "bank_country",
    "bank_name": "bank_name",
    "bank_routing_number": "bank_routing_number",
    "cashapp_cash_tag": "cashapp_cash_tag",
    "city": "city",
    "country": "country",
    "default": true,
    "expiration_date": "expiration_date",
    "first_name": "first_name",
    "last_four": "4242",
    "last_name": "last_name",
    "nick_name": "nick_name",
    "payment_account_email": "payment_account_email",
    "payment_email": "payment_email",
    "state": "state",
    "type": "CREDIT_CARD",
    "zipcode": "zipcode"
  },
  "success": true
}

Returns Examples

{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": {
    "id": "id",
    "address": "address",
    "address2": "address2",
    "bank_account_type": "bank_account_type",
    "bank_code": "bank_code",
    "bank_country": "bank_country",
    "bank_name": "bank_name",
    "bank_routing_number": "bank_routing_number",
    "cashapp_cash_tag": "cashapp_cash_tag",
    "city": "city",
    "country": "country",
    "default": true,
    "expiration_date": "expiration_date",
    "first_name": "first_name",
    "last_four": "4242",
    "last_name": "last_name",
    "nick_name": "nick_name",
    "payment_account_email": "payment_account_email",
    "payment_email": "payment_email",
    "state": "state",
    "type": "CREDIT_CARD",
    "zipcode": "zipcode"
  },
  "success": true
}