Payment Requests

The Payment Requests API provides endpoints to query payment requests and their activities.

Get All Payment Requests

GET /payment-requests

Retrieves a paginated list of payment requests with filtering options.

Query Parameters

Parameter	Type	Description
page	number	Page number (min: 1, default: 1)
limit	number	Items per page (max: 100, default: 10)
creator	string	Filter by creator address
payer	string	Filter by payer address
status	string	Filter by status
coinType	string	Filter by coin type
search	string	Search requests (min: 3 chars)
sortBy	string	Sort field (CREATED_AT, TOTAL_AMOUNT, etc.)
sortOrder	string	Sort order (ASC/DESC)

Payment Request Status Types

• PENDING: Request is awaiting payment

• PAID: Request has been paid

• REJECTED: Request has been rejected

Response

{
	"data": [
		{
			"id": "123e4567-e89b-12d3-a456-426614174000",
			"creator": "0x1234567890abcdef",
			"receiver": "0x1234567890abcdef",
			"payer": "0x1234567890abcdef",
			"coinType": "0x2::sui::SUI",
			"amount": "1000000",
			"billId": "123e4567-e89b-12d3-a456-426614174001",
			"status": "PENDING",
			"createdAt": "2024-01-01T00:00:00Z",
			"updatedAt": "2024-01-01T00:00:00Z"
		}
	],
	"meta": {
		"page": 1,
		"limit": 10,
		"total": 100
	}
}

Get Payment Request by ID

GET /payment-requests/{id}

Retrieves details of a specific payment request.

Response

{
	"data": {
		// Payment Request object (same as above)
	}
}

Get Payment Request Activities

GET /payment-requests/{id}/activities

Retrieves activities for a specific payment request.

Query Parameters

Parameter	Type	Description
page	number	Page number (min: 1, default: 1)
limit	number	Items per page (max: 100, default: 10)
activityType	string	Filter by activity type
actor	string	Filter by actor address

Activity Types

• CREATED

• PAID

• REJECTED

Response

{
	"data": [
		{
			"id": "123e4567-e89b-12d3-a456-426614174000",
			"paymentRequestId": "123e4567-e89b-12d3-a456-426614174001",
			"activityType": "CREATED",
			"actor": "0x1234567890abcdef",
			"data": {
				"amount": "1000",
				"reason": "Payment completed"
			},
			"checkpointSequenceNumber": 12345,
			"transactionDigest": "HkPwB75KXX4bQH5Vr6oYpwgwwRSSFJJf6eNFEwAd67N8",
			"createdAt": "2024-01-01T00:00:00Z"
		}
	],
	"meta": {
		"page": 1,
		"limit": 10,
		"total": 100
	}
}

Get Account Payment Request Activities

GET /payment-requests/account/{address}/activities

Retrieves payment request activities for a specific account.

Query Parameters

Same as Get Payment Request Activities

Get Account Payment Request Stats

GET /payment-requests/account/{address}/stats

Retrieves payment request statistics for a specific account.

Response

{
	"data": {
		"asReceiver": {
			"pendingAmounts": [
				{
					"coinType": "0x2::sui::SUI",
					"amount": "1000000"
				}
			],
			"paidAmounts": [
				{
					"coinType": "0x2::sui::SUI",
					"amount": "500000"
				}
			],
			"rejectedAmounts": [
				{
					"coinType": "0x2::sui::SUI",
					"amount": "100000"
				}
			],
			"requestsByStatus": [
				{
					"status": "PENDING",
					"count": 5
				}
			]
		},
		"asCreator": {
			// Same structure as asReceiver
		}
	}
}