Sign in
api
customer-payment-methods

Set customer payment method to primary

post/api/customers/{customerId}/payment-methods/{paymentMethodId}/primary

Path parameters

customerIdstring required

ID of the customer

paymentMethodIdstring required

ID of the customer

Response

OK

_idstring required

The ID of the payment method

status'ACTIVE' | 'DELETED' | 'EXPIRED' required

The status of the payment method

sellerIdstring required

The ID of the seller this payment method

dataobject

Whether the payment method is primary

paymentDetailsobject

Whether the payment method is primary

primaryboolean required

Whether the payment method is primary

activeboolean required

Whether the payment method is primary

gatewayType'stripe' | 'paypal' | 'adyen' | 'custom' | 'cardconnect' | 'worldline' | 'shift4' | 'authorizenet' | 'wallee' | 'square' | 'payfast' | 'touchnet' | 'transact' | 'unzer' | 'monext' | 'vivenuPayments' | 'ebanx' | 'rapyd' | 'momentusPayments' | 'paymob' | 'additional-payment-method'

The type of the payment gateway associated to this method

gatewayIdstring required

The ID of the attached payment gateway or additional payment method

createdAtstring date-time

The created ISO timestamp

updatedAtstring date-time

The last updated ISO timestamp

Changes

Changed in 2 of the 14 revisions of this API.2

  • a18eefe17b941See the full diff
    • ●

      added the new paymob enum value to the gatewayType response property for the response status 200

      response-property-enum-value-added

  • 9155568e45b21See the full diff
    • ●

      added the new momentusPayments enum value to the gatewayType response property for the response status 200

      response-property-enum-value-added