Payment Requests

The paymentRequestManager provides methods to create and manage payment requests.

Creating Payment Requests

const { resp, requestObjChange } = await client.paymentRequestManager.createPaymentRequest(
	coinType, // e.g., "0x2::sui::SUI"
	amount, // Amount in smallest unit
	payTo, // Address to receive the payment
	requestTo, // Address to pay the request
	description, // Request description
	{
		billId, // Optional: Link to a bill
		dryRun, // Optional: Simulate transaction
		sender, // Optional: Override default sender
	},
);

Response

interface PaymentRequestResponse {
	resp: SuiTransactionBlockResponse;
	requestObjChange: {
		id: string;
		type: string;
		status: number;
		// ... other request properties
	};
}

Managing Requests

Pay Request

const resp = await client.paymentRequestManager.payRequest(
	coinType, // Token type to pay with
	requestId, // ID of the request to pay
	amount, // Amount to pay
	{
		dryRun, // Optional: Simulate transaction
		sender, // Optional: Override default sender
	},
);

Reject Request

const resp = await client.paymentRequestManager.rejectRequest(
	requestId, // ID of the request to reject
	{
		dryRun, // Optional: Simulate transaction
		sender, // Optional: Override default sender
	},
);

Fetching Requests

Fetch Single Request

const request = await client.paymentRequestManager.fetchPaymentRequest(requestId);

Fetch Multiple Requests

const requests = await client.paymentRequestManager.fetchPaymentRequests([requestId1, requestId2]);

Payment Request Object

The SDK returns payment requests in this format:

interface PaymentRequest {
	id: string;
	amount: bigint;
	creator: string;
	receiver: string;
	payer: string;
	coin_type: string;
	bill_id?: string;
	description: string;
	status: number;
	creation_time: number;
}

Status Values

• 0: PENDING - Request is awaiting payment

• 1: PAID - Request has been paid

• 2: REJECTED - Request has been rejected

Error Handling

Handle specific payment request errors:

try {
	await client.paymentRequestManager.payRequest(/* ... */);
} catch (error) {
	switch (error.code) {
		case 'UNSUPPORTED_COIN':
			// Handle unsupported coin type
			break;
		case 'INSUFFICIENT_BALANCE':
			// Handle insufficient balance
			break;
		case 'INVALID_STATE':
			// Handle invalid request state
			break;
		case 'PERMISSION_DENIED':
			// Handle permission issues
			break;
		default:
		// Handle other errors
	}
}

Common Use Cases

1. Create and Track Payment Request:

// Create request
const { requestObjChange } = await client.paymentRequestManager.createPaymentRequest(/* ... */);
const requestId = requestObjChange.id;

// Monitor status
const request = await client.paymentRequestManager.fetchPaymentRequest(requestId);
console.log('Request Status:', request.status);

1. Link Request to Bill:

const { requestObjChange } = await client.paymentRequestManager.createPaymentRequest(
	coinType,
	amount,
	payTo,
	requestTo,
	description,
	{
		billId: existingBillId, // Link to existing bill
	},
);