đź’»
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

Was this helpful?

  1. smart send
  2. Smart Send API

Cancel Smart Send

Mark any link as invalid. You can only mark this invalid in case user not filled the details

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

​https://payout.payumoney.com/payout/smartPay/cancel​

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

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

payountMerchantId 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 links. Same value will be used by merchant to check status of link or transfer or to cancel it.

String

Yes

Example

Sample Request :

curl -X POST \
 ​https://test.payumoney.com/payout/smartPay/cancel​ \
 -H 'authorization: bearer 45f87fed35bdafe9f47698ed03e202e282f873b79a57eb53a9d30247b376f01d' \
 -H 'content-type: application/x-www-form-urlencoded' \
 -H 'payoutmerchantid: 1111122' \
 -d merchantRefId=1584856958885

Response :

// Link not found
{
 "status": 1,
 "msg": "SmartPay Link not found",
 "code": 1112,
 "data": null
 }
 
 // invalid link
 {
 "status": 1,
 "msg": "Payout cannot be cancelled as it is already processed or cancelled",
 "code": 1110,
 "data": null
 }
 
 // 
 
 {
 "status": 1,
 "msg": "Payout cannot be cancelled as it is already processed",
 "code": null,
 "data": null
 }
 
  {
 "status": 1,
 "msg": "Payout transaction already cancelled",
 "code": null,
 "data": null
 }

 {
 "status": 1,
 "msg": "Payout transaction in progress. Try after sometime!",
 "code": null,
 "data": null
 }



PreviousSmart Send APINextSmart Send Status

Last updated 3 years ago

Was this helpful?