Payment Authorization

The Payments endpoints manage how Credit Key invoices are repaid and how payment activity is tracked over time. A payment represents money applied toward a Credit Key balance (for a specific order, invoice, or company).

These endpoints let you:

• Record payments (ACH, card, or other supported methods)
• Retrieve payment details and history
• View payment schedules for installment plans
• Issue refunds or reversals where supported

All endpoints require authentication and are intended for backend use.

---

Create a Payment

POST /payment

Record a new payment against a Credit Key balance.

Common uses:

• Applying a one-time payment toward an outstanding invoice
• Capturing a scheduled installment outside of autopay
• Recording a manual payment initiated by your AR or support team

This is typically used in operational or back-office flows where your system needs to explicitly tell Credit Key that funds have been collected.

---

Retrieve a Payment

GET /payment/{id}

Fetch details for a specific payment.

Common uses:

• Showing full payment details in your admin or support tools
• Verifying how a particular payment was applied (amount, method, timestamps)
• Troubleshooting customer questions about a specific transaction

The response usually includes amount, currency, status, method, timestamps, and references to related order/invoice/company.

---

List Payments

GET /payments

Return a list of payments, optionally filtered by company, order, date range, or status (depending on the query parameters supported by the API).

Common uses:

• Showing recent payment history for a customer
• Reconciling payments over a date range
• Building internal reports or dashboards for AR teams

This endpoint is useful any time you need a high-level view of payment activity.

---

Get a Payment Schedule

GET /payments/schedule/{orderId}

Retrieve the schedule of installments for a given order (or financing arrangement).

Common uses:

• Displaying the customer’s upcoming installment dates and amounts
• Showing payment schedule details to support or AR staff
• Confirming the remaining balance and future due dates

This ties directly into the repayment terms for the financing plan associated with the order.

---

Refund a Payment

POST /payment/{id}/refund

Initiate a refund (full or partial, depending on the API schema) for a previously captured payment.

Common uses:

• Refunding a payment when an order is cancelled or returned
• Correcting overpayments
• Resolving customer disputes

Refunds adjust the customer’s balance and may also interact with your own settlement flows, depending on how your integration is structured.

---

Where Payments Fit in the Overall Model

• Applications → Underwrite and approve the buyer.
• Companies → Represent the approved business account.
• Orders → Represent purchases financed through Credit Key.
• Payments → Represent money flowing back to pay off those financed purchases.

Typical lifecycle:

1. Buyer is approved via an Application → becomes a Company.
2. The buyer places an Order financed through Credit Key.
3. A payment schedule is generated and viewable through Payments endpoints.
4. Payments are created over time (autopay, manual, or refunded), gradually reducing the balance.