💻
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
  2. Smart Send API

Smart Send Status

Check the current usage status of link. It will return the different response like link is expired, details already submitted or link not found.

PreviousCancel Smart SendNextSmart Send V2 API

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

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

linkId

Link id return by payu while creating link

String

Conditional, In case searching with merchantRefId

merchantRefId

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

String

Conditional in case not passed link id

payoutMerchantId

payout merchantId

String

Conditional, Required in case search by merchantRefId

Example

Method : Get

Sample Request Body:

curl -X GET \
  'https://test.payumoney.com//payout/smartPay/status?linkId=5NoIQ1R8KuFeIaUYo8CEzllcxvRL4cWd5Kx48PkutmLHwgAkTVGwWrzaClVey6Rb' \
  -H 'authorization: bearer 5c1e9bf2a4d9761de6ac53122be4250907ae418c7dc34fec3dc71a9cf661b5c1' \
  -H 'payoutmerchantid: 1111110' \
 

Response Body :

{
    "status": 0,
    "msg": "Account Detail Pending",
    "code": null,
    "data": {
        "link": null,
        "linkId": "5NoIQ1R8KuFeIaUYo8CEzllcxvRL4cWd5Kx48PkutmLHwgAkTVGwWrzaClVey6Rb",
        "merchantRefId": "smart_pay_30_jul_test",
        "custEmail": null,
        "custName": null,
        "custMoblie": null,
        "merchantName": null,
        "amount": "1.0",
        "isOtpVerified": null,
        "linkExpiryDate": null,
        "detailFilled": false,
        "isLinkValid": true,
        "allowedMethod": "both"
    }
}
// In case invalid link
{
    "status": 1,
    "msg": "SmartPay Link not found",
    "code": 1112,
    "data": null
}

// Link Expired.
{
    "status": 1,
    "msg": "SmartPay Link expired",
    "code": 1111,
    "data": null
}

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://www.payumoney.com/payout/smartPay/status
https://test.payumoney.com/payout/smartPay/status