Mandate

createdAt
string <date-time>

The date and time the mandate was created and the customer consented to authorize the payment card to be used for merchant-initiated transactions in ISO 8601 format.

customerId
string <uuid>

The unique identifier for the customer record that identifies the customer in the Toast platform.

externalReferenceId
string

The optional reference identifier for the consent agreement language.

id
string <uuid>

The identifier of the mandate.

originalTransactionId
string <uuid>

The identifier of the original transaction that established the customer consent to authorize the payment card to be used for merchant-initiated transactions.

paymentMethodId
string <uuid>

The identifier of the payment method.

standingInstructionType
string (StandingInstructionType)

The instruction type used by the merchant and sent to the payment processor.

Enum: "INSTALLMENT" "RECURRING" "UNSCHEDULED"
status
string (MandateStatus)

The status of the mandate. An ACTIVE mandate authorizes the payment card to be used for merchant-initiated transactions. An INACTIVE mandate indicates that the customer has revoked their consent to authorize the payment card to be used for merchant-initiated transactions.

Enum: "ACTIVE" "INACTIVE"
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
  • "paymentMethodId": "b6df8625-cd25-4123-b345-638aa7b5d011",
  • "originalTransactionId": "b11ac1d7-0e90-4b3e-a083-e5c767d08597",
  • "standingInstructionType": "INSTALLMENT",
  • "status": "ACTIVE",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "externalReferenceId": "string"
}