Sign in

v1

latestOpenAPI 3.0.32026-08-0623677345.2 KB
Payments

Capture payment (publishable, GET)

Used by gateway redirect flows: the payer is bounced back here and Piriod renders an HTML page reflecting success or failure. Does not require authentication.

get/payments/{id}/capture/

Response

HTML page or JSON payload.

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).

status'cancelled' | 'failed' | 'incomplete' | 'processing' | 'requires_payment_method' | 'succeeded'
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