Activate or swap a mandate using an existing saved card token
X-Api-Key<token>
Business API key, e.g. vuz_ab12cdef... Created via Settings → Integrations → API Keys. Unlike partner keys, a public API key's STRING does not encode its environment — isolation instead comes from a completely separate sandbox database: a key minted on the Sandbox server (above) only ever reads/writes sandbox data and can never see or affect production, regardless of what the key looks like.
In: header
Path Parameters
mandateId*string
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X POST "https://example.com/mandates/string/use-saved-card" \ -H "Content-Type: application/json" \ -d '{ "tokenId": "string" }'{ "id": "550e8400-e29b-41d4-a716-446655440000", "status": "draft", "clientId": "string", "clientName": "string", "clientEmail": "string", "amount": 0, "currency": "string", "description": "string", "frequency": "weekly", "frequencyDisplay": "Every month on the 15th", "startDate": "2019-08-24T14:15:22Z", "endDate": "2019-08-24T14:15:22Z", "nextChargeDate": "2019-08-24T14:15:22Z", "lastChargeDate": "2019-08-24T14:15:22Z", "setupAmount": 0, "setupDescription": "string", "setupCharged": true, "lineItems": [ { "description": "Monthly subscription", "quantity": 1, "unitPrice": 99, "vatMode": "inclusive" } ], "setupLineItems": [ { "description": "Monthly subscription", "quantity": 1, "unitPrice": 99, "vatMode": "inclusive" } ], "totalChargesCount": 0, "totalChargedAmount": 0, "consecutiveFailures": 0, "expectedTotalAmount": 0, "expectedChargesCount": 0, "cardLastFour": "string", "cardBrand": "string", "cardExpiry": "12/25", "setupPaymentLinkUrl": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z"}