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

# Reverse a Payment to Platform

`POST /v1/payments/reversePaymentToPlatform`

## Request

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

This API will allow you to reverse a payment to platform. The original external requestId (extRequestId) from the original payment to platform request is needed to match the original transaction.

The amount field is optional, some considerations:

 - If no amount is provided, it will attempt to reverse the entire value from the original extRequestId

 - If an amount is provided, it can be up to the entire amount of the original extRequestId (paymentToPlatform)

 - However, there is also tracking of the partial amounts that have previously been reversed. The partner cannot go over the original paymentToPlatform amount that was sent in increments of reversals.

## Request body

- ReversePaymentToPlatformRequest
  - `amount` number: Amount to be transferred
  - `extRequestId` string, required: ExtRequestId to identify the original request. One of extRequestId or requestId is required.
  - `requestId` string, required: RequestId to identify the original request. One of extRequestId or requestId is required.
  - `tag` string: Tag to label different types of payments
  - `scheduleTs` number: Schedule timestamp for processing payment

## Response `200`

Successful response

- ReversePaymentToPlatformSuccessResponse
  - `status` ResponseStatus, required
    - `code` number
    - `desc` string
    - `messages` Message[]
      - `desc` string, required
      - `type` 'ERROR' | 'WARN' | 'INFO'
  - `data` ReversePaymentToPlatformResponse, required
    - `origRequestId` string, required: RequestId of original request
    - `origExtRequestId` string, required: ExtRequestId of original request
    - `requestId` string, required: RequestId of reverse request
    - `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.
    - `settlementAccountId` string: ID of the settlement account to direct funds from.
    - `tag` string, required: Custom label assigned to the reverse payment request.
    - `scheduleTs` number, required: Schedule timestamp for processing payment
    - `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)