💻
Payouts Integration
  • Introduction
  • Functional overview
  • Onboarding
  • Postman Collection
  • Authentication
  • Authentication Token
    • API to Generate Token using username/password
    • API to Generate Token using private client id
  • Refresh Tokens
    • Refresh Token API
  • IP Check
  • API Integration
  • Testing Credentials
  • API Flow Diagram
  • Beneficiary Management
    • View Beneficiary Detail
    • Beneficiary Creation / Registration
  • Core Payouts API
    • Get Account Details API
    • Cancel Transfer API
    • Check Transfer Status API
    • Initiate/Schedule Transfer API
  • Verification
    • Verify Account / Penny Test
    • Validate Vpa
    • IFSC Details
  • smart send
    • Feature
    • Smart Send API
      • Cancel Smart Send
      • Smart Send Status
    • Smart Send V2 API
      • Create Smart Send Link
      • Smart Send Status
      • Cancel Smart Send
      • Extend Expiry Date
    • Bulk Smart Send
      • Bulk File Upload
      • Bulk Process File
    • Smart Send Error Codes
    • Fetch masked Vpas
  • Webhooks
    • What are Webhooks?
    • Default Webhooks
    • Creating Webhooks
    • Set Webhook API
    • Types of webhooks
  • Settings
    • Disable queued Payout
  • FAQ
Powered by GitBook
On this page
  • Request Header Params
  • Request Params
  • Example
  • Response Params

Was this helpful?

  1. smart send

Smart Send API

Api details for smart send

PreviousFeatureNextCancel Smart Send

Last updated 3 years ago

Was this helpful?

Note: These API's are now deprecated. Please use Smart Send v2 API's for new integrations.

Request Header Params

Key

Description

Data type

Mandatory

possible Values

Authorization

Access token generated earlier.

String

Yes

Bearer {access_token}

payoutMerchantId

This is the merchant id provided while onboarding

String

Yes

payoutMerchantId is different from payumoney merchant id, please check payouts dashboard or call customer support if you don’t know your payoutsMerchantID

Request Params

Key

Description

Data type

Mandatory

possible Values

merchantRefId

Unique reference id generated at merchant side to distinguish between multiple transfers. Same value will be used by merchant in status check of transfer and cancel it.

String

Yes

amount

The Amount that the merchant wants to send the customer

Double(20,2)

Yes

custEmail

Email of the customer to do otp verification. One of the email or mobile is mandatory

String

Optional

custMobile

Mobile of the customer to do otp verification. One of the email or mobile is mandatory

String

Optional

custName

Name of the customer who you are sending fund.

String

No

description

Description of the transfer

String

Yes

Example

Content-Type : application/json

Method : POST

Do not forget to use the ‘application/json’ as the content type when you call our api

Sample Request Body:

{
 "amount":1.00,
 "merchantRefId":"test1111",
 "custEmail" : "test@gmail.com",
 "custName": "test",
 "custMobile":"9999999999",
 "description" : "smart pay test1"
}

Response Body :

{
  "status": 0,
  "msg": "Success",
  "code": null,
  "data": {
          "link": "https://test.payumoney.com/smartPay?id=Dl7jbRuKacFXq74Smt8DhktBTbkj5eWI%2BuB5gUBMRH9mz8cBKYBITJ9hANGG1mEQ",
          "linkId": "Dl7jbRuKacFXq74Smt8DhktBTbkj5eWI+uB5gUBMRH9mz8cBKYBITJ9hANGG1mEQ",
          }
}
{
  "status": 1,
   "msg": "Fail",
   "code": null,
   "data": [
             {
               "code": 1108,
               "message": "custMobile or custEmail is required"
             }
           ]
 }

Response Params

Key

Description

data.link

link generated for the customer where he or she can fill the details

data.linkId

Id generated for link. Same will be used to check if details are filled in link or not.

https://payout.payumoney.com/payout/smartPay
https://test.payumoney.com/payout/smartPay