Interface PaymentsClient

Hierarchy

PaymentsClient

Index

Methods

Methods

approve

approve(merchantId: string, paymentId: string, postData: ApprovePaymentRequest, paymentContext?: null | PaymentContext): Promise<SdkResponse<PaymentApprovalResponse, ErrorResponse>>

Resource /{merchantId}/payments/{paymentId}/approve - Approve payment

Parameters
- merchantId: string
- paymentId: string
- postData: ApprovePaymentRequest
- Optional paymentContext: null | PaymentContext
Returns Promise<SdkResponse<PaymentApprovalResponse, ErrorResponse>>

cancel

cancel(merchantId: string, paymentId: string, paymentContext?: null | PaymentContext): Promise<SdkResponse<CancelPaymentResponse, ErrorResponse>>

Resource /{merchantId}/payments/{paymentId}/cancel - Cancel payment

Parameters
- merchantId: string
- paymentId: string
- Optional paymentContext: null | PaymentContext
Returns Promise<SdkResponse<CancelPaymentResponse, ErrorResponse>>

cancelapproval

cancelapproval(merchantId: string, paymentId: string, paymentContext?: null | PaymentContext): Promise<SdkResponse<CancelApprovalPaymentResponse, ErrorResponse>>

Resource /{merchantId}/payments/{paymentId}/cancelapproval - Undo capture payment

Parameters
- merchantId: string
- paymentId: string
- Optional paymentContext: null | PaymentContext
Returns Promise<SdkResponse<CancelApprovalPaymentResponse, ErrorResponse>>

capture

capture(merchantId: string, paymentId: string, postData: CapturePaymentRequest, paymentContext?: null | PaymentContext): Promise<SdkResponse<CaptureResponse, ErrorResponse>>

Resource /{merchantId}/payments/{paymentId}/capture - Capture payment

Parameters
- merchantId: string
- paymentId: string
- postData: CapturePaymentRequest
- Optional paymentContext: null | PaymentContext
Returns Promise<SdkResponse<CaptureResponse, ErrorResponse>>

captures

captures(merchantId: string, paymentId: string, paymentContext?: null | PaymentContext): Promise<SdkResponse<CapturesResponse, ErrorResponse>>

Resource /{merchantId}/payments/{paymentId}/captures - Get captures of payment

Parameters
- merchantId: string
- paymentId: string
- Optional paymentContext: null | PaymentContext
Returns Promise<SdkResponse<CapturesResponse, ErrorResponse>>

complete

complete(merchantId: string, paymentId: string, postData: CompletePaymentRequest, paymentContext?: null | PaymentContext): Promise<SdkResponse<CompletePaymentResponse, ErrorResponse>>

Resource /{merchantId}/payments/{paymentId}/complete - Complete payment

Parameters
- merchantId: string
- paymentId: string
- postData: CompletePaymentRequest
- Optional paymentContext: null | PaymentContext
Returns Promise<SdkResponse<CompletePaymentResponse, ErrorResponse>>

create

create(merchantId: string, postData: CreatePaymentRequest, paymentContext?: null | PaymentContext): Promise<SdkResponse<CreatePaymentResponse, PaymentErrorResponse>>

Resource /{merchantId}/payments - Create payment

Parameters
- merchantId: string
- postData: CreatePaymentRequest
- Optional paymentContext: null | PaymentContext
Returns Promise<SdkResponse<CreatePaymentResponse, PaymentErrorResponse>>

devicefingerprint

devicefingerprint(merchantId: string, paymentId: string, paymentContext?: null | PaymentContext): Promise<SdkResponse<DeviceFingerprintDetails, ErrorResponse>>

Resource /{merchantId}/payments/{paymentId}/devicefingerprint - Get Device Fingerprint details

Parameters
- merchantId: string
- paymentId: string
- Optional paymentContext: null | PaymentContext
Returns Promise<SdkResponse<DeviceFingerprintDetails, ErrorResponse>>

dispute

dispute(merchantId: string, paymentId: string, postData: CreateDisputeRequest, paymentContext?: null | PaymentContext): Promise<SdkResponse<DisputeResponse, ErrorResponse>>

Resource /{merchantId}/payments/{paymentId}/dispute - Create dispute

Parameters
- merchantId: string
- paymentId: string
- postData: CreateDisputeRequest
- Optional paymentContext: null | PaymentContext
Returns Promise<SdkResponse<DisputeResponse, ErrorResponse>>

disputes

disputes(merchantId: string, paymentId: string, paymentContext?: null | PaymentContext): Promise<SdkResponse<DisputesResponse, ErrorResponse>>

Resource /{merchantId}/payments/{paymentId}/disputes - Get disputes

Parameters
- merchantId: string
- paymentId: string
- Optional paymentContext: null | PaymentContext
Returns Promise<SdkResponse<DisputesResponse, ErrorResponse>>

find

find(merchantId: string, paymentContext: FindPaymentsParams): Promise<SdkResponse<FindPaymentsResponse, ErrorResponse>>

Resource /{merchantId}/payments - Find payments

Parameters
- merchantId: string
- paymentContext: FindPaymentsParams
Returns Promise<SdkResponse<FindPaymentsResponse, ErrorResponse>>

get

get(merchantId: string, paymentId: string, paymentContext?: null | PaymentContext): Promise<SdkResponse<PaymentResponse, ErrorResponse>>

Resource /{merchantId}/payments/{paymentId} - Get payment

Parameters
- merchantId: string
- paymentId: string
- Optional paymentContext: null | PaymentContext
Returns Promise<SdkResponse<PaymentResponse, ErrorResponse>>

processchallenged

processchallenged(merchantId: string, paymentId: string, paymentContext?: null | PaymentContext): Promise<SdkResponse<PaymentResponse, ErrorResponse>>

Resource /{merchantId}/payments/{paymentId}/processchallenged - Approves challenged payment

Parameters
- merchantId: string
- paymentId: string
- Optional paymentContext: null | PaymentContext
Returns Promise<SdkResponse<PaymentResponse, ErrorResponse>>

refund

refund(merchantId: string, paymentId: string, postData: RefundRequest, paymentContext?: null | PaymentContext): Promise<SdkResponse<RefundResponse, RefundErrorResponse>>

Resource /{merchantId}/payments/{paymentId}/refund - Create refund

Parameters
- merchantId: string
- paymentId: string
- postData: RefundRequest
- Optional paymentContext: null | PaymentContext
Returns Promise<SdkResponse<RefundResponse, RefundErrorResponse>>

refunds

refunds(merchantId: string, paymentId: string, paymentContext?: null | PaymentContext): Promise<SdkResponse<RefundsResponse, ErrorResponse>>

Resource /{merchantId}/payments/{paymentId}/refunds - Get refunds of payment

Parameters
- merchantId: string
- paymentId: string
- Optional paymentContext: null | PaymentContext
Returns Promise<SdkResponse<RefundsResponse, ErrorResponse>>

thirdPartyStatus

thirdPartyStatus(merchantId: string, paymentId: string, paymentContext?: null | PaymentContext): Promise<SdkResponse<ThirdPartyStatusResponse, ErrorResponse>>

Resource /{merchantId}/payments/{paymentId}/thirdpartystatus - Third party status poll

Parameters
- merchantId: string
- paymentId: string
- Optional paymentContext: null | PaymentContext
Returns Promise<SdkResponse<ThirdPartyStatusResponse, ErrorResponse>>

tokenize

tokenize(merchantId: string, paymentId: string, postData: TokenizePaymentRequest, paymentContext?: null | PaymentContext): Promise<SdkResponse<CreateTokenResponse, ErrorResponse>>

Resource /{merchantId}/payments/{paymentId}/tokenize - Create a token from payment

Parameters
- merchantId: string
- paymentId: string
- postData: TokenizePaymentRequest
- Optional paymentContext: null | PaymentContext
Returns Promise<SdkResponse<CreateTokenResponse, ErrorResponse>>