Sign in

v12

latestOpenAPI 3.0.3raw.githubusercontent.com2026-08-011518127.5 KB
payments

post/business/{business}/payments/

Path parameters

businessstring required

A business unique identifier.

Request body

amountnumber required

The total monetary value associated with the order.

datestring date-time required

The timestamp representing the date and time of the order.

orderinteger required

The unique identifier number for the order.

Example request

{
  "amount": 1200,
  "date": "2023-12-15T22:45:06.506Z",
  "order": 5728
}

Response

Successful response

pkinteger

The primary key or identifier associated with the payment.

orderinteger

The unique identifier number associated with the order.

amountstring

The total monetary value of the order.

statusstring

The current status of the order.

datestring date-time

The timestamp indicating the date and time the payment was created.

paid_datestring date-time

The timestamp indicating the date and time the order was paid, or null if not paid.

shipping_address_idinteger

The identifier associated with the shipping address in the order.

billing_address_idstring

The identifier associated with the billing address in the order.

clientstring

The identifier or reference associated with the client or customer.

customer_order_referencestring

The customer's reference or identifier associated with the order.

Example response

{
  "pk": 5943,
  "amount": "1200.0000",
  "status": "PENDING",
  "date": "2024-01-18T10:18:39.800536-06:00",
  "shipping_address": {
    "street": "N/a",
    "number": "N/a",
    "suburb": "N/a",
    "city": {
      "name": "N/a"
    },
    "state": {
      "name": "N/a",
      "country": {
        "name": "N/a"
      }
    },
    "zip_code": "N/a"
  },
  "billing_address": {
    "street": "N/a",
    "number": "N/a",
    "suburb": "N/a",
    "city": {
      "name": "N/a"
    },
    "state": {
      "name": "N/a",
      "country": {
        "name": "N/a"
      }
    },
    "zip_code": "N/a"
  }
}