Get All Payments

Introduction:

Sample Curl:

curl --location 'https://api.signzy.app/api/v3/fd-booking/get-all-payments' \
--header 'Authorization: <auth-token>' \
--header 'Content-Type: application/json' \
--data '{
	"limit": "10",
	"offset": "0",
	"applicationId": "afd961bb-fa07-49e6-bc16-eb9feb4b64ca"
}'

Input Parameters:

Parameters	Type	Description	Mandatory/Optional
limit	String	Maximum number of records to return. Range: [1, 100] Default is 10	Optional
offset	String	Number of records to skip. Default is 0.	Optional
applicationId	String (UUID)	Application ID	Optional

Sample Output:

{
	"total": 37,
	"offset": 0,
	"limit": 10,
	"payments": [
		{
			"id": "cb708830-f060-4d8f-b2a8-eb940d98d132",
			"date": "2024-07-18",
			"paymentMethod": "upi",
			"utrNumber": null,
			"applicationId": "8c5618b0-775a-4b5d-aede-74d3d45cf284",
			"status": "new",
			"callbackUrl": "https://www.google.com/",
			"redirectUrl": "https://devapi.tarrakki.com/fd/v1/payments/cb708830-f060-4d8f-b2a8-eb940d98d132/redirect"
		},
		{
			"id": "e9ef00d7-78f5-4f60-9950-05a4b349d1ec",
			"date": "2024-08-12",
			"paymentMethod": "upi",
			"utrNumber": null,
			"applicationId": "e3160ccb-73f7-4ab5-9dab-9dca04f8ec8d",
			"status": "new",
			"callbackUrl": "https://www.google.com/",
			"redirectUrl": "https://devapi.tarrakki.com/fd/v1/payments/e9ef00d7-78f5-4f60-9950-05a4b349d1ec/redirect"
		},
		{
			"id": "a60480a8-0581-47f3-9690-adfde278532b",
			"date": "2024-07-18",
			"paymentMethod": "upi",
			"utrNumber": null,
			"applicationId": "de911e40-d8e6-4a7d-b119-df94afaeee94",
			"status": "new",
			"callbackUrl": "https://www.google.com/",
			"redirectUrl": "https://devapi.tarrakki.com/fd/v1/payments/a60480a8-0581-47f3-9690-adfde278532b/redirect"
		},
		{
			"id": "0f7a942a-ac99-4304-a2c2-eac7fb9e50e9",
			"date": "2024-07-18",
			"paymentMethod": "upi",
			"utrNumber": null,
			"applicationId": "c131e536-3155-4c36-a005-62815e7a5140",
			"status": "success",
			"callbackUrl": "https://webhook.site/a6315d33-4b79-49cf-88a8-436014405347",
			"redirectUrl": "https://devapi.tarrakki.com/fd/v1/payments/0f7a942a-ac99-4304-a2c2-eac7fb9e50e9/redirect"
		},
		{
			"id": "81f2a123-01da-4913-8876-43696447b241",
			"date": "2024-07-18",
			"paymentMethod": "netbanking",
			"utrNumber": null,
			"applicationId": "a3ab50f5-c349-4427-84fd-121924488e19",
			"status": "success",
			"callbackUrl": "https://www.google.com/",
			"redirectUrl": "https://devapi.tarrakki.com/fd/v1/payments/81f2a123-01da-4913-8876-43696447b241/redirect"
		},
		{
			"id": "afd961bb-fa07-49e6-bc16-eb9feb4b64ce",
			"date": "2024-07-18",
			"paymentMethod": "upi",
			"utrNumber": null,
			"applicationId": "0d8ebb34-a9b0-4efc-9280-427130f7008a",
			"status": "success",
			"callbackUrl": "https://www.google.com/",
			"redirectUrl": "https://devapi.tarrakki.com/fd/v1/payments/afd961bb-fa07-49e6-bc16-eb9feb4b64ce/redirect"
		},
		{
			"id": "d7051dc6-bc3b-4000-b3c4-78ce9f132da7",
			"date": "2024-07-18",
			"paymentMethod": "upi",
			"utrNumber": null,
			"applicationId": "94e9bf70-cab9-41e8-bc6e-0727d27312bd",
			"status": "success",
			"callbackUrl": "https://www.google.com/",
			"redirectUrl": "https://devapi.tarrakki.com/fd/v1/payments/d7051dc6-bc3b-4000-b3c4-78ce9f132da7/redirect"
		},
		{
			"id": "427b7452-7227-4de5-91e7-0ec84b83fbcb",
			"date": "2024-07-18",
			"paymentMethod": "upi",
			"utrNumber": null,
			"applicationId": "25a38b99-d04d-4c04-a9b7-31103de675b8",
			"status": "success",
			"callbackUrl": "https://www.google.com/",
			"redirectUrl": "https://devapi.tarrakki.com/fd/v1/payments/427b7452-7227-4de5-91e7-0ec84b83fbcb/redirect"
		},
		{
			"id": "6d1a9e1a-65e6-4b17-b593-605a4a47c36b",
			"date": "2024-07-18",
			"paymentMethod": "upi",
			"utrNumber": null,
			"applicationId": "5c74ed63-7dd2-48d6-80ca-127bbc451099",
			"status": "success",
			"callbackUrl": null,
			"redirectUrl": "https://devapi.tarrakki.com/fd/v1/payments/6d1a9e1a-65e6-4b17-b593-605a4a47c36b/redirect"
		},
		{
			"id": "2af04354-a96c-427b-b922-c0df83dfc26b",
			"date": "2024-07-18",
			"paymentMethod": "neft_rtgs",
			"utrNumber": "XXXXR520190109599036XX",
			"applicationId": "5a1ff173-0b6c-4aff-956c-c3a8f4a0a74a",
			"status": "success",
			"callbackUrl": "https://www.google.com/",
			"redirectUrl": null
		}
	]
}

Output Parameters:

Parameter	Type	Description
total	Number	Total Number of Payments
offset	Number	Number of records skipped
limit	Number	Maximum number of records in resp
payments	Array	List of Payments
payments[i].id	String (UUID)	Payment ID
payments[i].date	String	Date of the Payment in YYYY-MM-DD
payments[i].paymentMethod	String	Method of Payment like UPI, NEFT/RTGS and Net Banking
payments[i].utrNumber	String	UTR Number of the Payment
payments[i].applicationId	String (UUID)	Application ID
payments[i].status	String	Status of the Payment
payments[i].callbackUrl	String (URL)	CallbackURL of the payment
payments[i].redirectUrl	String (URL)	Payment RedirectUrl

Status Codes:

{
    "message": "Invalid authentication credentials"
}