---
title: "Make a Payment to Platform"
method: POST
path: "/v1/payments/paymentToPlatform"
tags: ["Payment to Platform"]
---

# Make a Payment to Platform

`POST /v1/payments/paymentToPlatform`

## Request

- Base URL: `https://sandbox-api.spinwheel.io`
- URL: `https://sandbox-api.spinwheel.io/v1/payments/paymentToPlatform`
- Auth: API key in header `Authorization`

This API will allow you to make a payment to platform.

## Request body

- PaymentToPlatform
  - `payerId` string, required: PayerId of payer from whom the payment would go through
  - `settlementAccountId` string: The ID of the settlement account to direct funds to.
  - `amount` number, required: Amount to be transferred
  - `extRequestId` string, required: ID to identify the request
  - `tag` string: Tag to label different types of payments
  - `scheduleTs` number: Schedule timestamp for processing payment
  - `requestType` 'ONE_TIME', required: Type of the payment request. Only ONE_TIME is supported.
  - `settlementSpeed` 'STANDARD' | 'NEXT_DAY' | 'SAME_DAY': Settlement speed. If this field is not set, the default configuration will be used.
  - `paymentMethod` 'ACH' | 'WIRE': Payment method. If this field is not set, ACH will be used.

## Response `200`

Successful response

- PaymentToPlatformOkResponse
  - `status` ResponseStatus, required
    - `code` number
    - `desc` string
    - `messages` Message[]
      - `desc` string, required
      - `type` 'ERROR' | 'WARN' | 'INFO'
  - `data` PaymentToPlatformResponse, required
    - `requestId` string, required
    - `extRequestId` string, required
    - `amount` number, required: Transaction amount
    - `payerId` string, required: PayerId of payer from whom the payment would go through.
    - `requestType` 'ONE_TIME', required: Type of the payment request.
    - `settlementSpeed` 'STANDARD' | 'NEXT_DAY' | 'SAME_DAY', required: Settlement speed. If this field is not set, the default configuration will be used.
    - `paymentMethod` 'ACH' | 'WIRE', required: Payment method. If this field is not set, ACH will be used.
    - `scheduleTs` number, required: Schedule timestamp for processing payment
    - `tag` string, required
    - `settlementAccountId` string: The ID of the settlement account to direct funds to.
    - `createdOn` number, required
    - `updatedOn` number, required

## Other responses

- `400`: Bad request response
- `401`: Unauthorized response
- `404`: Not found response
- `500`: Internal server error response

---

[API](https://skmtc.dev/spinwheel/apis/pay.md) - [All operations](https://skmtc.dev/spinwheel/apis/pay/llms.txt) - [OpenAPI document](https://skmtc.dev/spinwheel/apis/pay/revisions/58ba91f8ae13?raw)