Retrieve a payment
Authentication
AuthorizationBearer
A secret key (rl_sk_test_..., rl_sk_live_...) or a restricted key with limited scopes (rl_rk_test_..., rl_rk_live_...). A restricted key can carry agent: true and an expires_at, and is what a coding agent should hold. Keys end in a checksum so secret scanners can recognize them. People create, roll and revoke keys in the dashboard; GET /v1/api_keys lists them, masked.
Path parameters
payment_id
The payment ID (pay_...).
Response
The payment.
id
object
provider
provider_reference
The provider’s own ID, such as Adyen’s pspReference or a Stripe payment intent.
kind
Allowed values:
customer
amount
An amount of money in the currency's minor unit.
status
disputed means the provider reported a chargeback. Runledger changes no credits because of it.
Allowed values:
livemode
created_at
merchant_reference
The reference you or Runledger sent the provider, such as Adyen’s merchantReference.
checkout_session
invoice
credit_grant
The grant a top_up created. Credits at risk are counted from it.
payout_reference
The provider's payout or batch ID, once the payment is paid out.
settled_at
When the provider paid it out.
disputed_at
When the provider reported a chargeback.
Errors
400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error