v52

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

Retrieve a Source MandateNotification

Retrieves a new Source MandateNotification.

get/v1/sources/{source}/mandate_notifications/{mandate_notification}

Path parameters

mandate_notificationstring required

sourcestring required

Query parameters

expandstring[]

Specifies which fields in the response should be expanded.

Response

Successful response.

amountinteger nullable

A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the amount associated with the mandate notification. The amount is expressed in the currency of the underlying source. Required if the notification type is debit_initiated.

createdinteger required

Time at which the object was created. Measured in seconds since the Unix epoch.

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'source_mandate_notification' required

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

reasonstring required

The reason of the mandate notification. Valid reasons are mandate_confirmed or debit_initiated.

statusstring required

The status of the mandate notification. Valid statuses are pending or submitted.

typestring required

The type of source this mandate notification is attached to. Should be the source type identifier code for the payment method, such as three_d_secure.