get payment

This block is part of the stripe group and was last modified in core v15.0.0.

get payment v15.0.0

Answers did this payment succeed, and what did they pay with. The payment method pins come off the charge, so they report the method actually used rather than the ones that were offered.

In pins 2 + flow
  • flow
    flow
  • connection required
    stripeconnection
  • payment intent id required
    value

    pi_… : from create payment, from checkout get, or from a webhook event.

Out pins 20 + flow
  • flow
    flow
  • connection
    stripeconnection
  • succeeded
    condition

    True only when the money has actually been taken. This is the pin to gate fulfilment on.

  • status
    value

    requires_payment_method, requires_action, processing, succeeded, canceled.

  • payment intent id
    value
  • client secret
    value

    Hand this to Stripe.js in the browser to confirm the payment. It is scoped to this one payment : but do not log it.

  • amount
    number

    What was asked for, in the smallest currency unit.

  • amount received
    number

    What was actually taken. Differs from amount on a partial capture.

  • currency
    value
  • payment method type
    value

    What the customer actually paid with: card, ideal, sepa_debit, bancontact… Read off the charge, so it is the method used, not the ones offered.

  • payment method
    value

    A line to show a person: "Visa ···· 4242", "ideal (INGBNL2A)", "SEPA ···· 3000".

  • payment method details
    object

    The full method details : brand, last4, bank, mandate, wallet.

  • charge id
    value

    Needed for a refund when no payment intent id is to hand.

  • receipt url
    value

    Stripe's own hosted receipt for this payment.

  • customer id
    value
  • meta data
    object
  • payment intent
    object
  • success
    condition
  • error
    value

    Stripe's own message, or a sentinel like MISSING_SESSION_ID for a problem in the wiring.

  • error code
    value

    Stripe's machine-readable code, e.g. card_declined, resource_missing.

  • decline code
    value

    Why the bank refused, e.g. insufficient_funds. Only set on a declined card.

payment succeeded
check payment
payment method used
what did they pay with

Version history

Introduced in v15.0.0.

Service documentation

External API reference This block wraps a third-party service. Click here for the service's own documentation of the underlying endpoint.
Back to stripe Return to the main group to view all sub-groups Back to payments Return to the group to view all blocks within this group