v1

latestOpenAPI 3.1.02026-07-241120379.1 KB

Send update payment method mail

This endpoint allows you to send an email to the customer with a secure link to update their payment method. Useful for prompting customers to resolve failed payments or update expired card details.

post/2023-10/paymentMethod/{paymentMethodId}/update

Path parameters

versionstring required

YYYY-MM

paymentMethodIdinteger required

The unique identifier of the payment method in Loop.

Response

200

successboolean

messagestring

codestring

{"stackTrail":"paths:/2023-10/paymentMethod/{paymentMethodId}/update:post:responses:200:content:application/json:schema:properties:pageInfo","oasType":"schema","type":"unknown"}

Example response

{
  "success": true,
  "message": "Payment method email sent successfully",
  "data": {
    "id": 1643344,
    "type": "CustomerCreditCard",
    "card": {
      "brand": "mastercard",
      "expiryYear": 29,
      "expiryMonth": 1,
      "lastDigits": "4444"
    },
    "status": "safe"
  },
  "code": "SUCCESS"
}