Overview

Namespaces

  • Ingenico
    • Connect
      • Sdk
        • Domain
          • Capture
            • Definitions
          • Definitions
          • Dispute
            • Definitions
          • Errors
            • Definitions
          • File
            • Definitions
          • Hostedcheckout
            • Definitions
          • Hostedmandatemanagement
            • Definitions
          • Installments
            • Definitions
          • Mandates
            • Definitions
          • MetaData
          • Payment
            • Definitions
          • Payout
            • Definitions
          • Product
            • Definitions
          • Refund
            • Definitions
          • Riskassessments
            • Definitions
          • Services
            • Definitions
          • Sessions
            • Definitions
          • Token
            • Definitions
          • Webhooks
        • Merchant
          • Disputes
          • Payments
          • Payouts
          • Productgroups
          • Products
          • Refunds
          • Services
          • Tokens
        • Webhooks

Classes

  • Captures
  • Disputes
  • Files
  • Hostedcheckouts
  • Hostedmandatemanagements
  • Installments
  • Mandates
  • Payments
  • Payouts
  • Productgroups
  • Products
  • Refunds
  • Riskassessments
  • Services
  • Sessions
  • Tokens
  • Overview
  • Namespace
  • Class
  • Deprecated

Class Mandates

Mandates client.

Ingenico\Connect\Sdk\Resource
Extended by Ingenico\Connect\Sdk\Merchant\Mandates
Namespace: Ingenico\Connect\Sdk\Merchant
Located at Ingenico/Connect/Sdk/Merchant/Mandates.php
Methods summary
public Ingenico\Connect\Sdk\Domain\Mandates\CreateMandateResponse
# create( Ingenico\Connect\Sdk\Domain\Mandates\CreateMandateRequest $body, Ingenico\Connect\Sdk\CallContext $callContext = null )

Resource /{merchantId}/mandates - Create mandate

Resource /{merchantId}/mandates - Create mandate

Parameters

$body
$callContext

Returns

Ingenico\Connect\Sdk\Domain\Mandates\CreateMandateResponse

Throws

Ingenico\Connect\Sdk\ValidationException
Ingenico\Connect\Sdk\AuthorizationException
Ingenico\Connect\Sdk\IdempotenceException
Ingenico\Connect\Sdk\ReferenceException
Ingenico\Connect\Sdk\GlobalCollectException
Ingenico\Connect\Sdk\ApiException
Ingenico\Connect\Sdk\InvalidResponseException

Link

Create mandate
public Ingenico\Connect\Sdk\Domain\Mandates\CreateMandateResponse
# createWithMandateReference( string $uniqueMandateReference, Ingenico\Connect\Sdk\Domain\Mandates\CreateMandateRequest $body, Ingenico\Connect\Sdk\CallContext $callContext = null )

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

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

Parameters

$uniqueMandateReference
$body
$callContext

Returns

Ingenico\Connect\Sdk\Domain\Mandates\CreateMandateResponse

Throws

Ingenico\Connect\Sdk\ValidationException
Ingenico\Connect\Sdk\AuthorizationException
Ingenico\Connect\Sdk\IdempotenceException
Ingenico\Connect\Sdk\ReferenceException
Ingenico\Connect\Sdk\GlobalCollectException
Ingenico\Connect\Sdk\ApiException
Ingenico\Connect\Sdk\InvalidResponseException

Link

Create mandate with mandatereference
public Ingenico\Connect\Sdk\Domain\Mandates\GetMandateResponse
# get( string $uniqueMandateReference, Ingenico\Connect\Sdk\CallContext $callContext = null )

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

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

Parameters

$uniqueMandateReference
$callContext

Returns

Ingenico\Connect\Sdk\Domain\Mandates\GetMandateResponse

Throws

Ingenico\Connect\Sdk\ValidationException
Ingenico\Connect\Sdk\AuthorizationException
Ingenico\Connect\Sdk\IdempotenceException
Ingenico\Connect\Sdk\ReferenceException
Ingenico\Connect\Sdk\GlobalCollectException
Ingenico\Connect\Sdk\ApiException
Ingenico\Connect\Sdk\InvalidResponseException

Link

Get mandate
public Ingenico\Connect\Sdk\Domain\Mandates\GetMandateResponse
# block( string $uniqueMandateReference, Ingenico\Connect\Sdk\CallContext $callContext = null )

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

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

Parameters

$uniqueMandateReference
$callContext

Returns

Ingenico\Connect\Sdk\Domain\Mandates\GetMandateResponse

Throws

Ingenico\Connect\Sdk\ValidationException
Ingenico\Connect\Sdk\AuthorizationException
Ingenico\Connect\Sdk\IdempotenceException
Ingenico\Connect\Sdk\ReferenceException
Ingenico\Connect\Sdk\GlobalCollectException
Ingenico\Connect\Sdk\ApiException
Ingenico\Connect\Sdk\InvalidResponseException

Link

Block mandate
public Ingenico\Connect\Sdk\Domain\Mandates\GetMandateResponse
# unblock( string $uniqueMandateReference, Ingenico\Connect\Sdk\CallContext $callContext = null )

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

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

Parameters

$uniqueMandateReference
$callContext

Returns

Ingenico\Connect\Sdk\Domain\Mandates\GetMandateResponse

Throws

Ingenico\Connect\Sdk\ValidationException
Ingenico\Connect\Sdk\AuthorizationException
Ingenico\Connect\Sdk\IdempotenceException
Ingenico\Connect\Sdk\ReferenceException
Ingenico\Connect\Sdk\GlobalCollectException
Ingenico\Connect\Sdk\ApiException
Ingenico\Connect\Sdk\InvalidResponseException

Link

Unblock mandate
public Ingenico\Connect\Sdk\Domain\Mandates\GetMandateResponse
# revoke( string $uniqueMandateReference, Ingenico\Connect\Sdk\CallContext $callContext = null )

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

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

Parameters

$uniqueMandateReference
$callContext

Returns

Ingenico\Connect\Sdk\Domain\Mandates\GetMandateResponse

Throws

Ingenico\Connect\Sdk\ValidationException
Ingenico\Connect\Sdk\AuthorizationException
Ingenico\Connect\Sdk\IdempotenceException
Ingenico\Connect\Sdk\ReferenceException
Ingenico\Connect\Sdk\GlobalCollectException
Ingenico\Connect\Sdk\ApiException
Ingenico\Connect\Sdk\InvalidResponseException

Link

Revoke mandate
Methods inherited from Ingenico\Connect\Sdk\Resource
__construct(), getClientMetaInfo(), getCommunicator(), instantiateUri()
Properties inherited from Ingenico\Connect\Sdk\Resource
$context
Ingenico Connect PHP SDK API documentation generated by ApiGen