Create a new session

Create a new session for accepting payments from customers.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

In order to accept payments from a customer the first step would be to create a session in which you can capture a payment. Creating a session is the first step of capturing a payment.

Every session is valid for 1 hour and your customer should complete the payment within this duration.

Body Params
float
required

Payment amount

string
enum
required
Defaults to AUD

The currency for payin

Allowed:
string
required

The ID of the counterparty from whom this payin is intended for

string
required

A reference id from your system to Cake Capital

string
enum
required

Purpose for this transaction

string
required

The url from which the user is coming from

string
required

The url to which the user would be redirected to

string
enum
Allowed:
kyc
object

Optional KYC information for the payin session which would be prefilled in the form, if this information is being sent then all of the underlying fields are required

Responses

Language
LoadingLoading…
Response
Choose an example:
application/json