Skip to main content

Function: paymentService()

paymentService(client): object

Defined in: service/PaymentService.ts:16

Service for managing payments

Parameters​

client​

GraphQLClient

Returns​

createPayment()​

createPayment(input): Promise<Payment>

Creates a new payment *

Parameters​

input​

any

Payment creation input *

Returns​

Promise<Payment>

Promise<Payment> The created payment

deletePayment()​

deletePayment(variables): Promise&lt;Payment>

Deletes a payment *

Parameters​

variables​

PaymentDeleteVariables

Payment ID to delete *

Returns​

Promise&lt;Payment>

Promise<boolean> Success status

getPayment()​

getPayment(variables): Promise&lt;Payment>

Retrieves a specific payment *

Parameters​

variables​

PaymentVariables

Payment ID *

Returns​

Promise&lt;Payment>

Promise<Payment> Payment data

getPayments()​

getPayments(input?): Promise&lt;PaymentsResponse>

Retrieves payments with search *

Parameters​

input?​

PaymentsSearchInput

Search input parameters *

Returns​

Promise&lt;PaymentsResponse>

Promise<PaymentsResponse> Payments response

updatePayment()​

updatePayment(variables): Promise&lt;Payment>

Updates an existing payment *

Parameters​

variables​

PaymentUpdateVariables

Payment update input *

Returns​

Promise&lt;Payment>

Promise<Payment> The updated payment