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 (no-payment, pending, success, failed) and an array of individual payment attempts.

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
      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
      messages
      array of object
      Processing messages associated with this payment.
Built with