Replace credit card payment method.

put

https://payments.subscriptionplatform.com/api/paymentsv2

Replaces a customer's (identfied with customerId) existing payment method (identified with payment method id ). Will result in a new payment method and id

Very similar and has the same requirements as Create Credit Card Payment Method

There is no payment method "edit". Instead payment methods are "updated" by replacement and that replacement needs to be validated again.

Body Params

publicApiKey

string

required

Can be acquired from the Admin UI.

recaptcha

int32

required

The reCAPTCHA token response. Required as part of submission.

string

required

id of the payment method to be replaced. A new id will be returned in the response payload if successful. Default flag and any hierarchy sharing will be copied to the new payment method.

customerId

string

required

cardNumber

string

required

**This should be a string, escaped with ". Otherwise values might be interpreted incorrectly.

firstName

string

required

Payment method first name, may not exactly match customer first name. Used for validating credit card.

lastName

string

required

Payment method last name, may not exactly match customer last name. Used for validating credit card.

cvv

string

required

This must be sent as a string, otherwise any leading 0 will be trimmed and validation will fail.

makeDefault

boolean

Will automatically flag as default if replacing the existing default payment method.

address1

string

address2

string

city

string

stateId

string

countryId

string

postalZip

string

paymentCollectOptions

object

Headers

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Responses

Language

Loading…

Response

Choose an example:

application/json

200200

400400