CoworkerPaymentMethods
Update CoworkerPaymentMethod
Update an existing CoworkerPaymentMethod record.
PUT
Update CoworkerPaymentMethod
Updates an existing CoworkerPaymentMethod record. You must include the
Id of the record to update along with all required fields.
Authentication
This endpoint requires OAuth2 authentication. Include a valid bearer token in the
Authorization header.
The authenticated user must be a full unrestricted administrator or have the CoworkerPaymentMethod-Edit role.Enums
eRegularPaymentProvider
eRegularPaymentProvider
Request Body
Required Fields
ID of the customer whose payment method is stored; the customer must belong to a location the operator can access.
Optional Fields
Regular-payment provider for this method; only one method may exist for the same customer, location, and provider, and the Admin UI supports Stripe, StripeACH, StripeBACS, and GoCardless. See
eRegularPaymentProvider? enum above.Payment-provider method ID supplied by the provider, such as a Stripe payment method token; set it only for the matching provider flow.
Payment-provider customer ID supplied by the provider, such as a Stripe customer ID; set it only for the matching provider flow.
Payment-provider mandate or bank-account identifier supplied by a direct-debit provider; GoCardless and StripeBACS use this field.
Code Examples
Response
200
Example Response
400
Example Response