Get mandates for a payment method

Returns mandates associated with a payment method. Optionally filter by active status.

SecurityOAuth2
Request
path Parameters
paymentMethodId
required
string <uuid>

The identifier of the payment method.

query Parameters
active
boolean

Filter mandates by active status. When true, returns only ACTIVE mandates. When false, returns only INACTIVE mandates. When omitted, returns all mandates regardless of status.

Responses
200

Successful operation. Returns information about mandates for the specific payment method.

400

Invalid payment method ID format.

403

Unauthorized access.

404

Payment method not found.

get/v1/payment-methods/{paymentMethodId}/mandates
Request samples
curl -i -X GET \
  'https://payments.toasttab.com/v1/payment-methods/{paymentMethodId}/mandates?active=true' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
Response samples
application/json
[
  • {
    }
]