Create a Payment

post

https://sandbox-api.spinwheel.io/v1/payments/requests

This API will allow you to create a Payment request for a user.

📘
Settlement Speeds
Liability payments: Support STANDARD settlement.
Bank account payments: Support SAME_DAY or NEXT_DAY settlement.

Body Params

userId

string

required

Spinwheel userId of the user you're posting the recurringTransaction towards.

extRequestId

string

required

An id generated by you, a partner, to refer back the payment request. (Needs to be unique for a given request)

amount

number

required

≥ 1

Recurring transaction amount.

payerId

string

required

payerId of payer from whom the payment would go through.

useOfFundsId

string

useOfFundsId of funds allocation you've configured. Either of useOfFundsId or useOfFunds object is required.

useOfFunds

object

scheduleTs

number

Epoch timestamp value of schedule date

schedule

object

If not provided, Current date will be taken as the date for posting recurring transactions.

requestType

string

enum

required

Whether the payment request is one-time or recurring.

Allowed:

settlementSpeed

string

enum

Settlement speed. If this field is not set, the default configuration will be used.

Allowed:

tag

string

This is to tag payments with specific keywords.

Responses

Language

Credentials

Header

URL

Loading…

Response

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

application/json

Settlement Speeds

200Successful response

400Bad request response

401Unauthorized response

404Not found response

500Internal server error response