Retrieve a Payment Record

GET / v1 / payment_records /:id

Retrieves a Payment Record with the given ID

Parameters

id string Required The ID of the Payment Record.

Returns

Returns a Payment Record object if a valid ID was provided. Otherwise, this call raises an error.

Response

{ "id": "pr_5RV730PrHyAEi", "object": "payment_record", "amount_canceled": { "currency": "usd", "value": 0 }, "amount_failed": { "currency": "usd", "value": 0 }, "amount_guaranteed": { "currency": "usd", "value": 0 }, "amount_refunded": { "currency": "usd", "value": 0 }, "amount_requested": { "currency": "usd", "value": 1000 }, "created": 1730211363, "customer_details": null, "customer_presence": "on_session", "description": "computer software", "latest_payment_attempt_record": "par_1ArV730PrHyQuG", "livemode": true, "metadata": {}, "payment_method_details": { "billing_details": null, "custom": { "display_name": "newpay", "type": "custom" }, "payment_method": null, "type": "custom" }, "processor_details": { "type": "custom", "custom": { "payment_reference": "npp2358872734k" } }, "shipping_details": null}

Report a payment

POST / v1 / payment_records / report_payment

Report a new Payment Record. You may report a Payment Record as it is initialized and later report updates through the other report_* methods, or report Payment Records in a terminal state directly, through this method.

Parameters

amount _ requested object Required The amount you initially requested for this payment.
initiated _ at timestamp Required When the reported payment was initiated. Measured in seconds since the Unix epoch.
payment _ method _ details object Required Information about the Payment Method debited for this payment.
customer _ details object Customer information for this payment.
customer _ presence enum Indicates whether the customer was present in your checkout flow during this payment. Possible enum values off_session The customer was not present during the transaction. on_session The customer was present during the transaction.
description string An arbitrary string attached to the object. Often useful for displaying to users.
failed object Information about the payment attempt failure.
guaranteed object Information about the payment attempt guarantee.
metadata map Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.
outcome enum The outcome of the reported payment. Possible enum values failed The payment failed. guaranteed The payment was guaranteed.
processor _ details object Required Processor information for this payment.
shipping _ details object Shipping information for this payment.

Returns

The newly created Payment Record.

Response

{ "id": "pr_5RV730PrHyAEi", "object": "payment_record", "amount_canceled": { "currency": "usd", "value": 0 }, "amount_failed": { "currency": "usd", "value": 0 }, "amount_guaranteed": { "currency": "usd", "value": 0 }, "amount_refunded": { "currency": "usd", "value": 0 }, "amount_requested": { "currency": "usd", "value": 1000 }, "created": 1730211363, "customer_details": null, "customer_presence": "on_session", "description": "computer software", "latest_payment_attempt_record": "par_1ArV730PrHyQuG", "livemode": true, "metadata": {}, "payment_method_details": { "billing_details": null, "custom": { "display_name": "newpay", "type": "custom" }, "payment_method": null, "type": "custom" }, "processor_details": { "type": "custom", "custom": { "payment_reference": "npp2358872734k" } }, "shipping_details": null}

Report a payment attempt

POST / v1 / payment_records /:id / report_payment_attempt

Report a new payment attempt on the specified Payment Record. A new payment attempt can only be specified if all other payment attempts are canceled or failed.

Parameters

id string Required The ID of the Payment Record.
initiated _ at timestamp Required When the reported payment was initiated. Measured in seconds since the Unix epoch.
description string An arbitrary string attached to the object. Often useful for displaying to users.
failed object Information about the payment attempt failure.
guaranteed object Information about the payment attempt guarantee.
metadata map Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.
outcome enum The outcome of the reported payment. Possible enum values failed The payment failed. guaranteed The payment was guaranteed.
payment _ method _ details object Information about the Payment Method debited for this payment.
shipping _ details object Shipping information for this payment.

Returns

The updated Payment Record object with a new latest_payment_attempt_record, or an error (for example, if the Payment Record already has funds guaranteed).

Response

{ "id": "pr_5RV730PrHyAEi", "object": "payment_record", "amount_canceled": { "currency": "usd", "value": 0 }, "amount_failed": { "currency": "usd", "value": 0 }, "amount_guaranteed": { "currency": "usd", "value": 0 }, "amount_refunded": { "currency": "usd", "value": 0 }, "amount_requested": { "currency": "usd", "value": 1000 }, "created": 1730211363, "customer_details": null, "customer_presence": "on_session", "description": "computer software", "latest_payment_attempt_record": "par_345kjsi8WE", "livemode": true, "metadata": {}, "payment_method_details": { "billing_details": null, "custom": { "display_name": "newpay", "type": "custom" }, "payment_method": null, "type": "custom" }, "processor_details": { "type": "custom", "custom": { "payment_reference": "npp2358872734k" } }, "shipping_details": null}