Payment

View normalized Markdown

A payment attempt for an invoice.

graphql
type Payment {
  id: ID!
  paymentIntentClientSecret: String
  paymentIntentId: String!
  providerInitializationFailed: Boolean!
  redirectUrl: String
  state: PaymentStateEnum!
  type: PaymentTypeEnum!
  value: Money!
}

Fields

Payment.id · ID! non-null scalar

ID of the payment attempt.

Payment.paymentIntentClientSecret · String scalar

Secret for completing the attempt with the payment provider's browser SDK. Only set for providers that need it.

Payment.paymentIntentId · String! non-null scalar

The payment provider's ID for this attempt.

Payment.providerInitializationFailed · Boolean! non-null scalar

Whether the payment provider could not start this attempt. Start a new payment.

Payment.redirectUrl · String scalar

If the redirect_url is present then the frontend has to redirect the browser to that url for the payment process to happen.

Payment.state · PaymentStateEnum! non-null enum

State of the payment attempt.

Payment.type · PaymentTypeEnum! non-null enum

Payment provider that processes the attempt.

Payment.value · Money! non-null scalar

Amount of the payment attempt.

Member Of

Invoice object · PaymentIntentCreatePayload object

Ready to Get Started?

Book a free demo or reach out — we’d love to hear from you.