No matter how you integrate KOMOJU, you will interact with payments either directly or indirectly. Even integrations using our e-commerce plugins like Shopify and WooCommerce create payments under the hood, and those payments can be queried and interacted with via our API.
A payment represents money collected from one of your customers. At a minimum, every payment has an amount and currency. The full list of attributes is documented in the Payment: Show API reference.
Payment Statuses
Payments have a read-only status field that tells you whether or not money has been collected.
| Status | Meaning |
|---|---|
pending | A payment has been initiated but not confirmed. Pending payments await customer action. |
authorized | See The two meanings of authorized below. |
captured | Payment was successful. The money will be transferred to your bank account next settlement. |
refunded | The payment was completed, but has been fully refunded. Note that partially refunded payments remain captured. |
cancelled | The payment was actively cancelled by either the merchant or the customer. |
expired | Payment was pending or authorized with no action for too long. |
The two meanings of authorized
The authorized status has two possible meanings, depending on the payment method:
- Long-form async payment methods (
konbini,bank_transfer,payeasy) — the payment is reserved but awaiting customer action (e.g. waiting for the customer to go to the store and pay cash). - All other payment methods —
authorizedrefers to a credit card authorization. The funds are in your control but haven't left the customer's account yet. These authorized payments are awaiting merchant action (e.g. the merchant performs a manual capture when goods are shipped). See Two-Step Capture for details.
Payment details (advanced integrations only)
In KOMOJU we use the term "payment details" (payment_details in the API) to refer to any information specific to one payment method. For example, a credit card payment has the card number and expiration date, while a konbini payment needs to know which store the customer will pay at. This information is all "payment details".
In the API, payment_details is used when:
If you are using Hosted Page or Hosted Fields, you do not need to interact with payment details. For a full reference of payment method-specific fields, see Payments API | Payment Details.