Read Payment
Intent
Reads the payment without changing it.
When to call it
Call this after your application has received or stored the identifier for the payment.
Access boundary
Authorize the request with a token that carries payments:read.
Successful result
A successful request returns 200. The response schema below defines the body your integration receives.
Operational notes
Get a payment by ID.
Scopes: payments:read
Authorizations
Path Parameters
The payment ID.
Response
Successful Response
- CardPayment
- GenericPayment
Schema of a payment with a card payment method.
The time Ruba created this record.
The time this record last changed.
The stable identifier for this record.
The payment processor.
stripe "stripe"
The payment status.
pending, succeeded, failed "succeeded"
The payment amount in cents.
1000
The three-letter currency code of the payment.
"usd"
The payment method used.
"card""card"
Error code, if the payment was declined.
"insufficient_funds"
Human-readable error message, if the payment was declined.
"Your card has insufficient funds."
The ID of the organization that owns the payment.
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"
The ID of the checkout session associated with this payment.
"e4b478fa-cd25-4253-9f1f-8a41e6370ede"
The ID of the order associated with this payment.
"e4b478fa-cd25-4253-9f1f-8a41e6370ede"
Additional metadata for the card payment method.
What initiated this payment attempt, e.g. initial purchase, subscription renewal, or an automated dunning retry.
purchase, subscription_cycle, retry_dunning, retry_customer, retry_payment_method_update, retry_admin "subscription_cycle"
Opaque metadata returned by the payment processor.