Interface MandatesClient

interface MandatesClient {
    block(
        merchantId: string,
        uniqueMandateReference: string,
        paymentContext?: PaymentContext | null,
    ): Promise<SdkResponse<GetMandateResponse, ErrorResponse>>;
    create(
        merchantId: string,
        postData: CreateMandateRequest,
        paymentContext?: PaymentContext | null,
    ): Promise<SdkResponse<CreateMandateResponse, ErrorResponse>>;
    createWithMandateReference(
        merchantId: string,
        uniqueMandateReference: string,
        postData: CreateMandateRequest,
        paymentContext?: PaymentContext | null,
    ): Promise<SdkResponse<CreateMandateResponse, ErrorResponse>>;
    get(
        merchantId: string,
        uniqueMandateReference: string,
        paymentContext?: PaymentContext | null,
    ): Promise<SdkResponse<GetMandateResponse, ErrorResponse>>;
    revoke(
        merchantId: string,
        uniqueMandateReference: string,
        paymentContext?: PaymentContext | null,
    ): Promise<SdkResponse<GetMandateResponse, ErrorResponse>>;
    unblock(
        merchantId: string,
        uniqueMandateReference: string,
        paymentContext?: PaymentContext | null,
    ): Promise<SdkResponse<GetMandateResponse, ErrorResponse>>;
}

Index

Methods

block create createWithMandateReference get revoke unblock

Methods

block

block(
    merchantId: string,
    uniqueMandateReference: string,
    paymentContext?: PaymentContext | null,
): Promise<SdkResponse<GetMandateResponse, ErrorResponse>>
Resource /{merchantId}/mandates/{uniqueMandateReference}/block - Block mandate
Parameters
- merchantId: string
- uniqueMandateReference: string
- OptionalpaymentContext: PaymentContext | null
Returns Promise<SdkResponse<GetMandateResponse, ErrorResponse>>

create

create(
    merchantId: string,
    postData: CreateMandateRequest,
    paymentContext?: PaymentContext | null,
): Promise<SdkResponse<CreateMandateResponse, ErrorResponse>>
Resource /{merchantId}/mandates - Create mandate
Parameters
- merchantId: string
- postData: CreateMandateRequest
- OptionalpaymentContext: PaymentContext | null
Returns Promise<SdkResponse<CreateMandateResponse, ErrorResponse>>

createWithMandateReference

createWithMandateReference(
    merchantId: string,
    uniqueMandateReference: string,
    postData: CreateMandateRequest,
    paymentContext?: PaymentContext | null,
): Promise<SdkResponse<CreateMandateResponse, ErrorResponse>>
Resource /{merchantId}/mandates/{uniqueMandateReference} - Create mandate with mandatereference
Parameters
- merchantId: string
- uniqueMandateReference: string
- postData: CreateMandateRequest
- OptionalpaymentContext: PaymentContext | null
Returns Promise<SdkResponse<CreateMandateResponse, ErrorResponse>>

get

get(
    merchantId: string,
    uniqueMandateReference: string,
    paymentContext?: PaymentContext | null,
): Promise<SdkResponse<GetMandateResponse, ErrorResponse>>
Resource /{merchantId}/mandates/{uniqueMandateReference} - Get mandate
Parameters
- merchantId: string
- uniqueMandateReference: string
- OptionalpaymentContext: PaymentContext | null
Returns Promise<SdkResponse<GetMandateResponse, ErrorResponse>>

revoke

revoke(
    merchantId: string,
    uniqueMandateReference: string,
    paymentContext?: PaymentContext | null,
): Promise<SdkResponse<GetMandateResponse, ErrorResponse>>
Resource /{merchantId}/mandates/{uniqueMandateReference}/revoke - Revoke mandate
Parameters
- merchantId: string
- uniqueMandateReference: string
- OptionalpaymentContext: PaymentContext | null
Returns Promise<SdkResponse<GetMandateResponse, ErrorResponse>>

unblock

unblock(
    merchantId: string,
    uniqueMandateReference: string,
    paymentContext?: PaymentContext | null,
): Promise<SdkResponse<GetMandateResponse, ErrorResponse>>
Resource /{merchantId}/mandates/{uniqueMandateReference}/unblock - Unblock mandate
Parameters
- merchantId: string
- uniqueMandateReference: string
- OptionalpaymentContext: PaymentContext | null
Returns Promise<SdkResponse<GetMandateResponse, ErrorResponse>>