API Reference

Create charge

post
https://client.corrily.com/v1/charges

Notify Corrily that one of your customers has initiated a one-time transaction.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

🚧

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
float
required

The amount (price) of the charge.

float
Defaults to 0

The amount refunded by the charge. Only required if amount is undefined.

int32
required

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.

string
required

The three-letter (ISO 4217) currency code.

string

User's two-letter ISO3166 country code

string
required

The payment gateway that handled the charge. Accepted values: stripe, paypal, chargebee

string
required

A unique identifier for the charge. This can be the ID that the payment gateway assigned to the charge.

string
required

A product ID string or a payment gateway integration object. Product IDs are created by Corrily when you set up your Corrily account. Email [email protected] if you don't know them. See the response of the calculate price endpoint for an example of the structure of integration objects.

string
required

The status of the charge. Accepted values: pending, succeeded, failed

string
required

A User ID.

Headers
string
required

Your organization's API key.

Response

Updated about 5 years ago

Did this page help you?
Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 5 years ago

Did this page help you?