PIpiriod
Payments

Authorize payment (publishable)

Public endpoint used during a checkout flow. Attaches a source to the payment and authorizes the gateway transaction. Does not require authentication; the payment is found by its ID alone, so its enable_checkout flag must be true.

post/payments/{id}/authorize/

Request

Request body

sourceinteger required

Source ID to authorize this payment against.

Response

Payment authorized.

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

Changes

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