Schema2020-08-27object

source_mandate_notification

Source mandate notifications should be created when a notification related to a source mandate must be sent to the payer. They will trigger a webhook or deliver an email to the customer.

Source: openapi/spec3.json
Commit: d70de345383d
Active snapshot: da69df7e6e11

SourceReceiverFlow

object

address string

optionalnullable

The address of the receiver source. This is the value that should be communicated to the customer to send their funds to.

maxLength:5000

amount_charged integer

required

The total amount that was moved to your balance. This is almost always equal to the amount charged. In rare cases when customers deposit excess funds and we are unable to refund those, those funds get moved to your balance and show up in amount_charged as well. The amount charged is expressed in the source's currency.

amount_received integer

required

The total amount received by the receiver source. `amount_received = amount_returned + amount_charged` should be true for consumed sources unless customers deposit excess funds. The amount received is expressed in the source's currency.

amount_returned integer

required

The total amount that was returned to the customer. The amount returned is expressed in the source's currency.

refund_attributes_method string

required

Type of refund attribute method, one of `email`, `manual`, or `none`.

maxLength:5000

refund_attributes_status string

required

Type of refund attribute status, one of `missing`, `requested`, or `available`.

maxLength:5000

Root JSON Schema

{"description":"Source mandate notifications should be created when a notification related to\na source mandate must be sent to the payer. They will trigger a webhook or\ndeliver an email to the customer.","properties":{"acss_debit":{"$ref":"#/components/schemas/source_mandate_notification_acss_debit_data"},"amount":{"description":"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`.","nullable":true,"type":"integer"},"bacs_debit":{"$ref":"#/components/schemas/source_mandate_notification_bacs_debit_data"},"created":{"description":"Time at which the object was created. Measured in seconds since the Unix epoch.","format":"unix-time","type":"integer"},"id":{"description":"Unique identifier for the object.","maxLength":5000,"type":"string"},"livemode":{"description":"Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.","type":"boolean"},"object":{"description":"String representing the object's type. Objects of the same type share the same value.","enum":["source_mandate_notification"],"type":"string"},"reason":{"description":"The reason of the mandate notification. Valid reasons are `mandate_confirmed` or `debit_initiated`.","maxLength":5000,"type":"string"},"sepa_debit":{"$ref":"#/components/schemas/source_mandate_notification_sepa_debit_data"},"source":{"$ref":"#/components/schemas/source"},"status":{"description":"The status of the mandate notification. Valid statuses are `pending` or `submitted`.","maxLength":5000,"type":"string"},"type":{"description":"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`.","maxLength":5000,"type":"string"}},"required":["created","id","livemode","object","reason","source","status","type"],"title":"SourceMandateNotification","type":"object","x-expandableFields":["acss_debit","bacs_debit","sepa_debit","source"],"x-resourceId":"source_mandate_notification"}