SendPaymentMessageInput

Input for sendPaymentLink and sendPaymentReceipt.

input SendPaymentMessageInput {
  channel: MessageChannel
  customerEmail: AWSEmail
  customerPhone: AWSPhone
  language: String
  paymentId: ID!
}

Fields

SendPaymentMessageInput.channel ● MessageChannel enum

Channel to send the message by. When omitted, the mutation picks one from the contact details it has; see sendPaymentLink and sendPaymentReceipt. SMS and WhatsApp fail in test mode.

SendPaymentMessageInput.customerEmail ● AWSEmail scalar

The customer will receive the payment message on this email address. Defaults to the customer email on the payment. In test mode, only the email of the account admin or the customer email on the payment is accepted.

SendPaymentMessageInput.customerPhone ● AWSPhone scalar

Phone number in E.164 format. The customer will receive the payment message on this phone number. Defaults to the customer phone on the payment, then the Bizum phone number of the payment.

SendPaymentMessageInput.language ● String scalar

Two-letter language code of the message, for example es: en, es, ca, pt, de, it or fr. Any other value gives English. A region suffix (es-ES) is ignored. Defaults to the customer's browser language, then the account language.

SendPaymentMessageInput.paymentId ● ID! non-null scalar

ID of the payment (Charge.id).

Member Of

sendPaymentLink mutation ● sendPaymentReceipt mutation