Create an order

post

https://api.slopepay.com/v4/orders

Creates a new order for checkout. Returns both a code for Slope.JS widget and full URL for redirect flow

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

total

number

required

Total amount of the order, in cents. Must be greater than 0

currency

string

enum

required

The currency of the order

Allowed:

externalId

string

required

The external ID of the order, used for merchant reference. Must be unique.

items

array of objects

required

The line items in the order.

items*

customerId

string

Optional: The Slope customer ID for this order. If set, only this Slope customer will be able to access the order.

contactBusinessName

string

The customer business name

contactEmail

string

The customer email address

contactFirstName

string

The customer first name

contactLastName

string

The customer last name

contactDesiredLimit

string

The desired funding limit for the customer, in cents.

contactPhone

string

The customer phone number in E.164 format.

billingAddress

object

The billing address of the order.

taxId

string

The Federal EIN / Tax ID of this business. Must be 9 digits.

payoutAccountId

string

If provided, overrides the default payout account for this order

payeeExternalId

string

The external ID of the payee receiving the payout for this order

payeeName

string

The name of the payee receiving the payout for this order

resumeUrl

string

(Optional) The URL to redirect the user if an order is approved offline. Relevant only if an order transitions from "pending" to "approved" status.

cancelUrl

string

(Optional) The URL to redirect to if the user cancels the checkout. Relevant for redirect flow only

successUrl

string

(Optional) The URL to redirect to if the user completes the checkout. Relevant for redirect flow only

metadata

object

Any additional metadata to attach to the order. This takes in a object

uiType

string

enum

The type of integration that is being used.

Allowed:

Headers

Slope-Access-Token

string

required

The access token returned from exchanging the short lived authorizationCode /v4/auth/token endpoint.

Responses

Language

Credentials

Basic

base64

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201The created order. Returns either a standard order or a composable order depending on the uiType.

400Bad Request - Invalid request format or validation errors

409Conflict - Request conflicts with current state of the resource

422Unprocessable Entity - Request validation failed

500Internal Server Error - An unexpected error occurred