***
title: "PaymentService"
generated: true
---------------
Contains methods relating to [Payment](/current/core/reference/typescript-api/entities/payment#payment) entities.
```ts title="Signature"
class PaymentService {
constructor(connection: TransactionalConnection, paymentStateMachine: PaymentStateMachine, refundStateMachine: RefundStateMachine, paymentMethodService: PaymentMethodService, eventBus: EventBus)
create(ctx: RequestContext, input: DeepPartial) => Promise;
findOneOrThrow(ctx: RequestContext, id: ID, relations: string[] = ['order']) => Promise;
transitionToState(ctx: RequestContext, paymentId: ID, state: PaymentState) => Promise;
getNextStates(payment: Payment) => readonly PaymentState[];
createPayment(ctx: RequestContext, order: Order, amount: number, method: string, metadata: any) => Promise;
settlePayment(ctx: RequestContext, paymentId: ID) => Promise;
cancelPayment(ctx: RequestContext, paymentId: ID) => Promise;
createManualPayment(ctx: RequestContext, order: Order, amount: number, input: ManualPaymentInput) => ;
createRefund(ctx: RequestContext, input: RefundOrderInput, order: Order, selectedPayment: Payment) => Promise;
}
```
### create
\
RequestContext, input: DeepPartial<Payment>) => Promise<Payment>`} />
### findOneOrThrow
\RequestContext, id: ID, relations: string[] = ['order']) => Promise<Payment>`} />
### transitionToState
\RequestContext, paymentId: ID, state: PaymentState) => Promise<Payment | PaymentStateTransitionError>`} />
Transitions a Payment to the given state.
When updating a Payment in the context of an Order, it is
preferable to use the [OrderService](/current/core/reference/typescript-api/services/order-service#orderservice) `transitionPaymentToState()` method, which will also handle
updating the Order state too.
### getNextStates
\Payment) => readonly PaymentState[]`} />
### createPayment
\RequestContext, order: Order, amount: number, method: string, metadata: any) => Promise<Payment | IneligiblePaymentMethodError>`} />
Creates a new Payment.
When creating a Payment in the context of an Order, it is
preferable to use the [OrderService](/current/core/reference/typescript-api/services/order-service#orderservice) `addPaymentToOrder()` method, which will also handle
updating the Order state too.
### settlePayment
\RequestContext, paymentId: ID) => PromisePayment>`} />
Settles a Payment.
When settling a Payment in the context of an Order, it is
preferable to use the [OrderService](/current/core/reference/typescript-api/services/order-service#orderservice) `settlePayment()` method, which will also handle
updating the Order state too.
### cancelPayment
\RequestContext, paymentId: ID) => PromisePayment>`} />
### createManualPayment
\RequestContext, order: Order, amount: number, input: ManualPaymentInput) => `} />
Creates a Payment from the manual payment mutation in the Admin API
When creating a manual Payment in the context of an Order, it is
preferable to use the [OrderService](/current/core/reference/typescript-api/services/order-service#orderservice) `addManualPaymentToOrder()` method, which will also handle
updating the Order state too.
### createRefund
\RequestContext, input: RefundOrderInput, order: Order, selectedPayment: Payment) => Promise<Refund | RefundStateTransitionError | RefundAmountError>`} />
Creates a Refund against the specified Payment. If the amount to be refunded exceeds the value of the
specified Payment (in the case of multiple payments on a single Order), then the remaining outstanding
refund amount will be refunded against the next available Payment from the Order.
When creating a Refund in the context of an Order, it is
preferable to use the [OrderService](/current/core/reference/typescript-api/services/order-service#orderservice) `refundOrder()` method, which performs additional
validation.