v52

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-015891,4406.1 MB

Retrieve a Mandate

Retrieves a Mandate object.

get/v1/mandates/{mandate}

mandatestring required

expandstring[]

Specifies which fields in the response should be expanded.

Successful response.

idstring required

Unique identifier for the object.

livemodeboolean required

If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.

object'mandate' required

String representing the object's type. Objects of the same type share the same value.

on_behalf_ofstring

The account (if any) that the mandate is intended for.

status'active' | 'inactive' | 'pending' required

The mandate status indicates whether or not you can use it to initiate a payment.

type'multi_use' | 'single_use' required

The type of the mandate.