v1

latestOpenAPI 3.0.32026-08-0623677345.2 KB

Payments

Create payment

post/payments/

Headers

x-simple-workspacestring required

Workspace (account) identifier. Required for every request.

x-piriod-test-modeboolean

Whether to operate against test-mode data. Defaults to false.

Request body

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

Response

Payment created.