Check payment status

Check mandate payment status

PREREQUISITES

A recurring mandate can have multiple payments associated to it.

The merchant can use check status API to check payment status of the last payment associated to the mandate and check status history API to payment status of the last 5 payments associated to the mandate

Staging host	`https://umap.setu.co/api`
Method	`GET`
Path	`/v1/merchants/payments/product-instances/{mandateId}/last`
Header	`merchantId` `Authorization`: Bearer < insert_token_here>. Generate this token using OAuth. `Content-Type`—will be `application/json`

Sample response

{
    "amount": 10000,
    "createdAt": "2023-09-04T12:08:20+0530",
    "currency": "INR",
    "customerAccountType": "savings",
    "customerVpa": "test-auto-tyvmm59i9b@pineaxis",
    "id": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
    "merchantId": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
    "merchantReferenceId": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
    "merchantVpa": "test-auto-beibfev2oq@pineaxis",
    "productInstanceId": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
    "refId": "1240689979139556558",
    "rrn": "124068997913",
    "status": "success",
    "txnId": "SETmBZkQOV0M7wyyP1V4PIFhRSzW5eSjmYI",
    "txnNote": "testpay"
}

In the above response:

id is a unique ID that is associated with this mandate payment and can be used to track it later.

To know more about all the API params, please refer to the API documentation here.

Staging host	`https://umap.setu.co/api`
Method	`GET`
Path	`/v1/merchants/payments/product-instances/{mandateId}/history`
Header	`merchantId` `Authorization`: Bearer < insert_token_here>. Generate this token using OAuth. `Content-Type`—will be `application/json`

Sample response

{
  "payments": [
    {
      "amount": 10000,
      "createdAt": "2023-09-04T12:08:20+0530",
      "currency": "INR",
      "customerAccountType": "savings",
      "customerVpa": "test-auto-tyvmm59i9b@pineaxis",
      "id": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
      "merchantId": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
      "merchantReferenceId": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
      "merchantVpa": "test-auto-beibfev2oq@pineaxis",
      "productInstanceId": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
      "refId": "1240689979139556558",
      "requestId": "cjqml1f2e5ocq2mesej0",
      "rrn": "124068997913",
      "status": "success",
      "txnId": "SETmBZkQOV0M7wyyP1V4PIFhRSzW5eSjmYI",
      "txnNote": "testpay"
    },
    {
      "amount": 10000,
      "createdAt": "2023-09-04T12:08:20+0530",
      "currency": "INR",
      "customerAccountType": "savings",
      "customerVpa": "test-auto-tyvmm59i9b@pineaxis",
      "id": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
      "merchantId": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
      "merchantReferenceId": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
      "merchantVpa": "test-auto-beibfev2oq@pineaxis",
      "productInstanceId": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
      "refId": "1240689979139556558",
      "requestId": "cjqml1f2e5ocq2mesej0",
      "rrn": "124068997913",
      "status": "success",
      "txnId": "SETmBZkQOV0M7wyyP1V4PIFhRSzW5eSjmYI",
      "txnNote": "testpay"
    }
  ]
}

To know more about all the API params, please refer to the API documentation here.

Check payment status

Check mandate payment status

Sample response

Sample response

On this page