Sign in

v1

latestOpenAPI 3.0.02026-07-2459256884.4 KB
Payment to Platform

Make a Payment to Platform

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

post/v1/payments/paymentToPlatform

Request body

payerIdstring required

PayerId of payer from whom the payment would go through

amountnumber required

Amount to be transferred

extRequestIdstring required

ID to identify the request

tagstring

Tag to label different types of payments

scheduleTsnumber

Schedule timestamp for processing payment

requestType'ONE_TIME' | 'RECURRING' required

Whether the payment request is one-time or recurring.

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.

Example request

{
  "payerId": "12b9d6e8-c87b-415e-94e2-15367975218d",
  "amount": 3000,
  "extRequestId": "12c9d6e8-c87b-415e-94e2-15367975218d",
  "tag": "Payment to platform",
  "scheduleTs": 1614602485926,
  "settlementSpeed": "SAME_DAY",
  "paymentMethod": "ACH"
}

Response

Successful response

Example response

{
  "status": {
    "code": 200,
    "desc": "success",
    "messages": [
      {
        "desc": "Example description"
      }
    ]
  },
  "data": {
    "requestId": "fd97c6e8-c87b-415e-94e2-15367975218d",
    "extRequestId": "12c9d6e8-c87b-415e-94e2-15367975218d",
    "amount": 3000,
    "payerId": "92becc07-ee08-44b3-bc7b-1ff2f98ed92a",
    "requestType": "ONE_TIME",
    "settlementSpeed": "SAME_DAY",
    "paymentMethod": "ACH",
    "scheduleTs": 1614602485926,
    "tag": "Payment to platform",
    "createdOn": 1614602485926,
    "updatedOn": 1614602485926
  }
}