Create charge
Notify Corrily that one of your customers has initiated a one-time transaction.
Custom payment gateway integrations only
You do not need to use this endpoint if you have granted Corrily automated access to your payment gateway’s subscription and charge events.
Body Params
The amount (price) of the charge.
The amount refunded by the charge. Only required if amount is undefined.
A 10-digit (seconds) UNIX timestamp
indicating when the charge was created. This timestamp should represent when
the charge was initialized, regardless of the status of the charge during the
initialization. It’s rare to need to update created
after initially setting
it.
The three-letter (ISO 4217) currency code.
User’s two-letter ISO3166 country code.
The payment gateway that handled the charge. Accepted values: stripe
,
paypal
, chargebee
.
A unique identifier for the charge. This can be the ID that the payment gateway assigned to the charge.
A product ID string or a payment gateway integration object. Product IDs are created by Corrily when you set up your Corrily account. Email support@corrily.com if you don’t know them. See the response of the calculate price endpoint for an example of the structure of integration objects.
The status of the charge. Accepted values: pending
, succeeded
, failed
.
Free form key-value data. Metadata is useful for storing additional, structured information for a charge.