v1

latestOpenAPI 3.0.02026-07-2459256884.4 KB

Payment to Platform

Reverse a Payment to Platform

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.

post/v1/payments/reversePaymentToPlatform

Request body

amountnumber

Amount to be transferred

extRequestIdstring required

ExtRequestId to identify the original request. One of extRequestId or requestId is required.

requestIdstring required

RequestId to identify the original request. One of extRequestId or requestId is required.

tagstring

Tag to label different types of payments

scheduleTsnumber

Schedule timestamp for processing payment

Example request

{
  "amount": 3000,
  "extRequestId": "12c9d6e8-c87b-415e-94e2-15367975218d",
  "requestId": "998ac06b-4fad-4043-aef9-96cf011bae8f",
  "tag": "Reverse Payment to platform",
  "scheduleTs": 1614602485926
}

Response

Example response

{
  "status": {
    "code": 200,
    "desc": "success",
    "messages": [
      {
        "desc": "Example description"
      }
    ]
  },
  "data": {
    "origRequestId": "998ac06b-4fad-4043-aef9-96cf011bae8f",
    "origExtRequestId": "12c9d6e8-c87b-415e-94e2-15367975218d",
    "requestId": "fd97c6e8-c87b-415e-94e2-15367975218d",
    "amount": 3000,
    "payerId": "92becc07-ee08-44b3-bc7b-1ff2f98ed92a",
    "requestType": "ONE_TIME",
    "tag": "Reverse Payment to platform",
    "scheduleTs": 1614602485926,
    "createdOn": 1614602485926,
    "updatedOn": 1614602485926
  }
}