API Reference

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
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

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.

items
array of objects
required

All of the items that are being purchased.

items*
string
required
length ≥ 1

The currency that the transaction is being conducted in. Currently only NZD is supported.

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

string | null

Any additional metadata that needs to be attached to the Paysquad (e.g. arbitary JSON to store properties used in the merchant's CMS).

string | null

When a Contribution is successfull the user will be directed to this url.

string | null

When a Contribution fails the user will be directed to this url.

string | null

When Paysquad has been completed a Webhook notification will be posted to this url

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

401

Your API key is either missing or invalid.

Updated almost 2 years ago

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json

Updated almost 2 years ago