Sign in

v1

latestOpenAPI 3.0.02026-07-244074117.0 KB
Orders

Open an order

Optional API call during checkout flow. Only used by developers that utilize the submitted status. Moves an order from the "submitted" state to the "open" state.

post/v4/orders/{id}/open

Path parameters

idstring required

The Slope order ID or the partner external order ID

Request body

selectedQuoteIdstring

The ID of the selected quote. If this quote is not the same as the selected quote ID, the call will fail

Example request

{
  "selectedQuoteId": "quote_123"
}

Response

The opened order.

idstring required

Slope Unique Order ID

externalIdstring

Unique merchant generated external ID

customerIdstring

Slope Customer ID, null until order is claimed by customer

numberstring required

Unique short & friendly order number

checkoutCodestring required

Unique code for Slope.JS widget

checkoutUrlstring required

Full URL for redirect flow

totalnumber required

Order total before customer fees

totalFinalizednumber

Total amount finalized for multi-finalization, null if not in finalizing/finalized state

merchantFeenumber required

Merchant fees

customerFeenumber required

Customer fees

customerFeePercentagenumber required

Customer fee percentage

totalWithFeesnumber required

Order total with customer fees

amountCanceledPrincipalnumber required

Amount canceled, in cents.

amountCanceledFeenumber required

Amount canceled, in cents.

status'pending' | 'approved' | 'submitted' | 'opening' | 'open' | 'finalizing' | 'finalized' | 'unpaid' | 'partiallyPaid' | 'complete' | 'defaulted' | 'rejected' | 'canceled' | 'refunded' | 'repayment' required
finalizedAtstring date-time required

Time when order was finalized, null if not finalized yet

openedAtstring date-time required

Time when order was opened, null if not open yet

currency'mxn' | 'usd' required
selectedTermNamestring

The selected payment term name. Null if not selected yet.

selectedPaymentType'ach' | 'card' | 'oxxo' | 'spei' | 'wire' | 'rtp' | 'customer_wallet' | 'virtual_card' | 'virtual_account'
selectedTermDaysnumber

The selected payment term days. Null if not selected yet.

metadataobject

Any additional metadata to attach to the order

amountOutstandingnumber required

Current amount outstanding on the order

aprnumber

Annual percentage rate from the selected quote. Null if no quote is selected yet.

Example response

{
  "paymentSchedule": [
    {
      "date": "2024-01-01"
    }
  ],
  "quotes": [
    {
      "payments": [
        {
          "number": 1,
          "date": "2024-02-15T00:00:00Z",
          "principal": 95000,
          "customerFee": 500,
          "amount": 105000,
          "financingFee": 2500
        }
      ]
    }
  ]
}