Connect

Connect
Debt Profile
User Management
Real Time Balances
- Refresh Liabilitypost
- Poll Liability Refreshget

Pay

Payers
Transactions
- Get a list of transactionsget
- Retrieve the details of a single transactionget
Sandbox
- Simulate transaction flow in Sandbox environmentpatch
Payment to Platform
Requests
Use Of Funds

Finance

Refinance
Interest Rate Monitoring

Webhooks

Partner Webhooks

Insights

Loan Calculatorpost
Master data constants
- Get a list of constants based on the criteria provided in the query parametersget
Vehicles

Connect

Connect
Debt Profile
User Management
Real Time Balances
- Refresh Liabilitypost
- Poll Liability Refreshget

Pay

Payers
Transactions
- Get a list of transactionsget
- Retrieve the details of a single transactionget
Sandbox
- Simulate transaction flow in Sandbox environmentpatch
Payment to Platform
Requests
Use Of Funds

Finance

Refinance
Interest Rate Monitoring

Webhooks

Partner Webhooks

Insights

Loan Calculatorpost
Master data constants
- Get a list of constants based on the criteria provided in the query parametersget
Vehicles

Get a list of requests

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

This API will allow you to get list of the payment requests created for a user with a provided userId, extRequestId or requestId. One of userId, extRequestId or requestId is required.

Query Params

userId

string

Spinwheel userId

extRequestId

string

extRequestId passed by you in the payments request

requestId

string

Spinwheel generated requestId of the payment request.

requestType

string

Filter on requestType

Responses

Response body

object

status

object

required

code

number

desc

string

messages

array of objects

messages

object

desc

string

required

type

string

ERROR WARN INFO

data

array of objects

required

data*

object

requestId

string

required

Spinwheel generated PaymentRequest Id.

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

required

Whether the payment request is one-time or recurring.

ONE_TIME RECURRING ROUND_UP AUTO_DEBIT

settlementSpeed

string

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

STANDARD NEXT_DAY SAME_DAY

goalId

string

This is to mark that this payment is made based on the goal.

contributedBy

string

This is to mark that this payment is made by an employee or employer.

EMPLOYEE EMPLOYER

tag

string

This is to tag payments with specific keywords.

createdOn

number

required

updatedOn

number

required

Response body

object

status

object

required

code

number

required

desc

string

required

Response body

object

status

object

required

code

number

required

desc

string

required

Response body

object

status

object

required

code

number

required

desc

string

required

Response body

object

status

object

required

code

number

required

desc

string

required

Updated 6 months ago

Create a request

Get the details of a single request

Did this page help you?

Language

Credentials

Header

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://sandbox-api.spinwheel.io/v1/payments/requests \
3
     --header 'accept: application/json'

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

application/json

Updated 6 months ago

Create a request

Get the details of a single request

Did this page help you?

Connect
Connect
Create user from network tokenpost
Connect a user via KBApost
Submit answers for KBAput
Connect a preverified userpost
Connect a user via SMSpost
Verify an SMS Connectionpost
Debt Profile
Get a PDF credit reportget
Subscribe to Equifax credit reportpost
Delete Equifax credit report subscriptiondelete
Get Equifax credit report subscriptions for a userget
Order an Equifax credit reportpost
User Management
Update student loanpatch
Create a payable bank accountpost
Delete userdelete
Retrieve a userget
Real Time Balances
Poll Liability Refreshget
Refresh Liabilitypost

Pay
Payers
Delete a payerdelete
Get payer account details using payerIdget
Get a list of payersget
Create a Partner Payerpost
Create a User Payerpost
Execute Payer verificationpost
Transactions
Retrieve the details of a single transactionget
Get a list of transactionsget
Sandbox
Simulate transaction flow in Sandbox environmentpatch
Payment to Platform
Reverse a payment to platformpost
Get account balanceget
Make a payment to platformpost
Requests
Delete a requestdelete
Get the details of a single requestget
Get a list of requestsget
Create a requestpost
Use Of Funds
Delete a useOfFunds objectdelete
Get the details of a single useOfFunds objectget
Get a list of a user's useOfFunds objectsget
Create a useOfFunds objectpost

Finance
Refinance
Retrieve the Results of a Refinancing Applicationget
Prequalify Refi Partnerspost
Submit a Refinancing Applicationpost
Update a Refinancing Applicationput
Clone a Refinancing Applicationpost
Retrieve a Refinancing Applicationget
Create a Refinancing Applicationpost
Interest Rate Monitoring
Updating an interest rate monitoring plan from active to inactiveput
Returns the interest rate monitoring history and detailget
The creation function for a user to be enrolled in interest rate monitoringpost

Webhooks
Partner Webhooks
Delete a webhookdelete
Update a webhook headerpatch
Retrieve a webhook by webhookIdget
Update a webhookpatch
Retrieve a list of webhooksget
Create a webhookpost

Insights
Loan Calculatorpost
Master data constants
Get a list of constants based on the criteria provided in the query parametersget
Vehicles
Get a list of trims for vehiclesget
Get a list of models for vehiclesget
Get a list of makes for vehiclesget
Get vehicle detailsget
Get vehicle details from a license plate and stateget

Connect
Connect
Create user from network tokenpost
Connect a user via KBApost
Submit answers for KBAput
Connect a preverified userpost
Connect a user via SMSpost
Verify an SMS Connectionpost
Debt Profile
Get a PDF credit reportget
Subscribe to Equifax credit reportpost
Delete Equifax credit report subscriptiondelete
Get Equifax credit report subscriptions for a userget
Order an Equifax credit reportpost
User Management
Update student loanpatch
Create a payable bank accountpost
Delete userdelete
Retrieve a userget
Real Time Balances
Poll Liability Refreshget
Refresh Liabilitypost

Pay
Payers
Delete a payerdelete
Get payer account details using payerIdget
Get a list of payersget
Create a Partner Payerpost
Create a User Payerpost
Execute Payer verificationpost
Transactions
Retrieve the details of a single transactionget
Get a list of transactionsget
Sandbox
Simulate transaction flow in Sandbox environmentpatch
Payment to Platform
Reverse a payment to platformpost
Get account balanceget
Make a payment to platformpost
Requests
Delete a requestdelete
Get the details of a single requestget
Get a list of requestsget
Create a requestpost
Use Of Funds
Delete a useOfFunds objectdelete
Get the details of a single useOfFunds objectget
Get a list of a user's useOfFunds objectsget
Create a useOfFunds objectpost

Finance
Refinance
Retrieve the Results of a Refinancing Applicationget
Prequalify Refi Partnerspost
Submit a Refinancing Applicationpost
Update a Refinancing Applicationput
Clone a Refinancing Applicationpost
Retrieve a Refinancing Applicationget
Create a Refinancing Applicationpost
Interest Rate Monitoring
Updating an interest rate monitoring plan from active to inactiveput
Returns the interest rate monitoring history and detailget
The creation function for a user to be enrolled in interest rate monitoringpost

Webhooks
Partner Webhooks
Delete a webhookdelete
Update a webhook headerpatch
Retrieve a webhook by webhookIdget
Update a webhookpatch
Retrieve a list of webhooksget
Create a webhookpost

Insights
Loan Calculatorpost
Master data constants
Get a list of constants based on the criteria provided in the query parametersget
Vehicles
Get a list of trims for vehiclesget
Get a list of models for vehiclesget
Get a list of makes for vehiclesget
Get vehicle detailsget
Get vehicle details from a license plate and stateget

200Successful response

400Bad request response

401Unauthorized response

404Not found response

500Internal server error response