Get the link to update the marketplace payment method

PUT/customers/{customerId}/payment-method/

API version

v2

Request method

PUT

Operation ID

marketplace-customer-update-payment-method

---

Request

• customerIdstring (uuid)

  required
  Example:"907a24e9-0723-4566-b584-86578419e983"

Responses

Format

application/json

Description

The generated link to the Stripe payment method setup

Schema documentation

• urlstring

Example

Content-Type: application/json

{
  "url": "string"
}

JSON Schema

{
  "properties": {
    "url": {
      "type": "string"
    }
  },
  "type": "object"
}

Usage examples

cURL

$ curl \
    --fail \
    --location \
    -X PUT \
    -d '{"customReturnUrl":"https://mittwald.studio/app/marketplace"}' \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    -H 'Content-Type: application/json' \
    https://api.mittwald.de/v2/customers/f0f86186-0a5a-45b2-aa33-502777496347/payment-method

JavaScript SDK

import { MittwaldAPIV2Client } from "@mittwald/api-client";
import { assertStatus } from "@mittwald/api-client-commons";
  
const client = MittwaldAPIClient.newWithToken(process.env.MITTWALD_API_TOKEN);
const response = await client.marketplace.customerUpdatePaymentMethod({
  "customerId": "f0f86186-0a5a-45b2-aa33-502777496347",
  "data": {
    "customReturnUrl": "https://mittwald.studio/app/marketplace"
  }
});

assertStatus(response, 200);
  

PHP SDK

use \Mittwald\ApiClient\Generated\V2\Clients\Marketplace\CustomerUpdatePaymentMethod\CustomerUpdatePaymentMethodRequest;
use \Mittwald\ApiClient\Generated\V2\Clients\Marketplace\CustomerUpdatePaymentMethod\CustomerUpdatePaymentMethodRequestBody;
  
$client = MittwaldAPIClient::newWithToken(getenv('MITTWALD_API_TOKEN'));

// TODO: Please consult the properties and constructor signature of
// CustomerUpdatePaymentMethodRequestBody to learn how to construct a valid instance
$body = new CustomerUpdatePaymentMethodRequestBody(/* TODO: ... */);

$request = (new CustomerUpdatePaymentMethodRequest(
  customerId: "f0f86186-0a5a-45b2-aa33-502777496347",
  body: $body
));
$response = $client->marketplace()->customerUpdatePaymentMethod($request);

var_dump($response->getBody();