Create a new Paysquad

post

https://api.sandbox.paysquad.co/api/merchant/paysquad

Creates a new Paysquad, specifying what items are being purchased and the total amount that needs to be charged.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

This endpoint allows a merchant to create a PaySquad. A model with information about the PaySquad will be returned, including the PaySquad ID. At this point, PaysSquad handles the rest of the payment flow through a hosted checkout experience.

Additionally, a resource Location header will be returned.

Body Params

The command specifying the basic properties of the Paysquad that is being created.

A model which creates the Paysquad by specifying what items are to be included and setting the total that needs to be paid.

items

array of objects

required

All of the items that are being purchased.

items*

currency

string

required

length ≥ 1

The ISO 4217 currency code the transaction is conducted in.
Supported: NZD, AUD, USD, CAD, EUR, GBP, SGD, CHF, JPY, DKK, NOK, SEK, MXN, HKD.
The total must be at least the minimum contribution threshold for the given currency.

total

int32

required

0 to 2147483647

Total cost of all items, in minimum fractional currency units. For a full explanation see https://stripe.com/docs/currencies as this is what our currencies are based on.
Eg 22050 = $220.50

meta

string | null

Optional free-form metadata stored with the Paysquad. Use it to attach your own order, cart, or transaction IDs; the same value is returned on Get responses so you can match the Paysquad back to your own records. String, recommended under 2KB.

successRedirectUrl

string | null

URL the shopper is offered as a "back to shop" link after the Squad Leader makes their first contribution. Optional.

cancelRedirectUrl

string | null

The URL the shopper is redirected to if the Squad Leader cancels the Paysquad before completion. Typically your cart page.

failedRedirectUrl

string | null

deprecated

Deprecated. Use cancelRedirectUrl instead. If both are supplied, cancelRedirectUrl takes precedence. This field will be removed in a future version.

paymentCompleteWebhook

string | null

Optional per-Paysquad webhook URL. If set, all lifecycle events (paysquad.succeeded, paysquad.cancelled, paysquad.failed) are posted here instead of your merchant-level webhook endpoint.

enforcedExpiry

date-time | null

Optional fixed expiry timestamp (UTC) for the Paysquad. When set, the Squad Leader cannot choose a duration; the Paysquad expires at this exact time.
If your merchant account has a maximum-checkout-duration configured, the earliest of the two wins.
If unset, the default 3-day expiry (or your merchant maximum, if configured) applies.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Responses

401

Your API key is either missing or invalid.

201The Paysquad was successfully created.