Payments

Capture payment (publishable)

Confirms the gateway transaction. Used by hosted checkouts.

post/payments/{id}/capture/

Request

Base URL
https://api.piriod.com
Auth
API key in header Authorization
TypeScript
https://skmtc.dev/piriod/apis/piriod-api/docs/payments/:id/capture/post.ts
A function with typed inputs. Its response is checked against the schema.

gateway_dataobject

Raw gateway callback payload.

Captured payment.

idinteger

invoicestring nullable

Invoice ID this payment applies to.

subscriptionstring nullable

Subscription ID when generated by a subscription cycle.

customerstring nullable

amountnumber required

balancenumber

Remaining balance to charge against this payment.

currencystring required

ISO currency code.

datestring date required

payment_datestring date-time nullable

Effective date the payment was completed.

descriptionstring required

sourceinteger nullable

Primary source ID. (Legacy single source link.)

sourcesinteger[]

All source IDs linked to this payment (multi-source support).

failed_reasonstring nullable

Reason code when status=failed.

return_urlstring uri nullable

URL the payer is sent back to after a redirect-flow checkout.

enable_checkoutboolean

Whether the publishable checkout /pay/ is reachable for this payment.

metadataobject

test_modeboolean

createdstring date-time

updatedstring date-time

No recorded changes to this operation across all 1 revision of this API.