Payments
/
Get Payment Intent Status

Get Payment Intent Status

GET
https://api.vivamo.co/v1/payment-intents/{paymentIntentId}/status

Retrieve the current status of a payment intent by paymentIntentId. Returns the overall intent status and an array of individual payment attempts.

The overall status is derived from the attempts — success if any succeeded, else pending if any is in flight, else failed. A failed attempt is reported as pending while the intent's 2-hour window is still open, because the customer can still retry within it. The window never overrides the status of an attempt once made: a payment that settles after it still reports success.

no-payment means no attempt has been made and the window is still open. expired means the window closed with no attempt ever made.

Path parameters

    paymentIntentId
    string
    Required
    The Vivamo payment intent ID returned when the intent was created.

Response

Payment intent status.
    status
    string
    Overall intent status.
      no-payment
      string
      expired
      string
      pending
      string
      success
      string
      failed
      string
    payments
    array of object
    An individual payment attempt within a payment intent.
      id
      string
      Unique payment ID.
      status
      string
      Payment status.
        pending
        string
        success
        string
        failed
        string
      subStatus
      string
      Additional detail when the payment has failed (e.g. `declined`, `error`).
      createdAt
      string
      Timestamp when the payment was created.
      type
      string
      Payment method type used.
        card
        string
        bank
        string
        pay_by_bank
        string
        crypto
        string
Built with