Retrieve a Mandate

Changed on

Retrieves a Mandate object.

get/v1/mandates/{mandate}

Request

  • Base URL: https://api.stripe.com
  • URL: https://api.stripe.com/v1/mandates/{mandate}
  • Auth: one of:
    • HTTP basic
    • HTTP bearer

Path parameters

mandatestring required

Query parameters

expandstring[]

Specifies which fields in the response should be expanded.

Response

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.

Changes

  • e24a26de4188Revision changes
    • breaking

      removed the required property //////////// from the response with the status

    • breaking

      removed the required property ////////// from the response with the status

    • breaking

      removed the required property ////////// from the response with the status

    This list may be incomplete.

Some revisions have not been checked yet.