Interface MandatesClient

Hierarchy

MandatesClient

Index

Methods

Methods

block

block(merchantId: string, uniqueMandateReference: string, paymentContext?: null | PaymentContext): Promise<SdkResponse<GetMandateResponse, ErrorResponse>>

Resource /{merchantId}/mandates/{uniqueMandateReference}/block - Block mandate

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

create

create(merchantId: string, postData: CreateMandateRequest, paymentContext?: null | PaymentContext): Promise<SdkResponse<CreateMandateResponse, ErrorResponse>>

Resource /{merchantId}/mandates - Create mandate

Parameters
- merchantId: string
- postData: CreateMandateRequest
- Optional paymentContext: null | PaymentContext
Returns Promise<SdkResponse<CreateMandateResponse, ErrorResponse>>

createWithMandateReference

createWithMandateReference(merchantId: string, uniqueMandateReference: string, postData: CreateMandateRequest, paymentContext?: null | PaymentContext): Promise<SdkResponse<CreateMandateResponse, ErrorResponse>>

Resource /{merchantId}/mandates/{uniqueMandateReference} - Create mandate with mandatereference

Parameters
- merchantId: string
- uniqueMandateReference: string
- postData: CreateMandateRequest
- Optional paymentContext: null | PaymentContext
Returns Promise<SdkResponse<CreateMandateResponse, ErrorResponse>>

get

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

Resource /{merchantId}/mandates/{uniqueMandateReference} - Get mandate

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

revoke

revoke(merchantId: string, uniqueMandateReference: string, paymentContext?: null | PaymentContext): Promise<SdkResponse<GetMandateResponse, ErrorResponse>>

Resource /{merchantId}/mandates/{uniqueMandateReference}/revoke - Revoke mandate

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

unblock

unblock(merchantId: string, uniqueMandateReference: string, paymentContext?: null | PaymentContext): Promise<SdkResponse<GetMandateResponse, ErrorResponse>>

Resource /{merchantId}/mandates/{uniqueMandateReference}/unblock - Unblock mandate

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