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 Payments

Payments client.

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

Resource /{merchantId}/payments - Create payment

Resource /{merchantId}/payments - Create payment

Parameters

$body
$callContext

Returns

Ingenico\Connect\Sdk\Domain\Payment\CreatePaymentResponse

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
Ingenico\Connect\Sdk\DeclinedPaymentException

Link

Create payment
public Ingenico\Connect\Sdk\Domain\Payment\FindPaymentsResponse
# find( Ingenico\Connect\Sdk\Merchant\Payments\FindPaymentsParams $query, Ingenico\Connect\Sdk\CallContext $callContext = null )

Resource /{merchantId}/payments - Find payments

Resource /{merchantId}/payments - Find payments

Parameters

$query
$callContext

Returns

Ingenico\Connect\Sdk\Domain\Payment\FindPaymentsResponse

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

Find payments
public Ingenico\Connect\Sdk\Domain\Payment\PaymentResponse
# get( string $paymentId, Ingenico\Connect\Sdk\CallContext $callContext = null )

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

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

Parameters

$paymentId
$callContext

Returns

Ingenico\Connect\Sdk\Domain\Payment\PaymentResponse

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 payment
public Ingenico\Connect\Sdk\Domain\Payment\CompletePaymentResponse
# complete( string $paymentId, Ingenico\Connect\Sdk\Domain\Payment\CompletePaymentRequest $body, Ingenico\Connect\Sdk\CallContext $callContext = null )

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

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

Parameters

$paymentId
$body
$callContext

Returns

Ingenico\Connect\Sdk\Domain\Payment\CompletePaymentResponse

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

Complete payment
public Ingenico\Connect\Sdk\Domain\Payment\ThirdPartyStatusResponse
# thirdPartyStatus( string $paymentId, Ingenico\Connect\Sdk\CallContext $callContext = null )

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

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

Parameters

$paymentId
$callContext

Returns

Ingenico\Connect\Sdk\Domain\Payment\ThirdPartyStatusResponse

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

Third party status poll
public Ingenico\Connect\Sdk\Domain\Token\CreateTokenResponse
# tokenize( string $paymentId, Ingenico\Connect\Sdk\Domain\Payment\TokenizePaymentRequest $body, Ingenico\Connect\Sdk\CallContext $callContext = null )

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

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

Parameters

$paymentId
$body
$callContext

Returns

Ingenico\Connect\Sdk\Domain\Token\CreateTokenResponse

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 a token from payment
public Ingenico\Connect\Sdk\Domain\Payment\PaymentResponse
# processchallenged( string $paymentId, Ingenico\Connect\Sdk\CallContext $callContext = null )

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

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

Parameters

$paymentId
$callContext

Returns

Ingenico\Connect\Sdk\Domain\Payment\PaymentResponse

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

Approves challenged payment
public Ingenico\Connect\Sdk\Domain\Payment\PaymentApprovalResponse
# approve( string $paymentId, Ingenico\Connect\Sdk\Domain\Payment\ApprovePaymentRequest $body, Ingenico\Connect\Sdk\CallContext $callContext = null )

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

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

Parameters

$paymentId
$body
$callContext

Returns

Ingenico\Connect\Sdk\Domain\Payment\PaymentApprovalResponse

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

Approve payment
public Ingenico\Connect\Sdk\Domain\Capture\CaptureResponse
# capture( string $paymentId, Ingenico\Connect\Sdk\Domain\Payment\CapturePaymentRequest $body, Ingenico\Connect\Sdk\CallContext $callContext = null )

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

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

Parameters

$paymentId
$body
$callContext

Returns

Ingenico\Connect\Sdk\Domain\Capture\CaptureResponse

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

Capture payment
public Ingenico\Connect\Sdk\Domain\Payment\CancelApprovalPaymentResponse
# cancelapproval( string $paymentId, Ingenico\Connect\Sdk\CallContext $callContext = null )

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

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

Parameters

$paymentId
$callContext

Returns

Ingenico\Connect\Sdk\Domain\Payment\CancelApprovalPaymentResponse

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

Undo capture payment
public Ingenico\Connect\Sdk\Domain\Capture\CapturesResponse
# captures( string $paymentId, Ingenico\Connect\Sdk\CallContext $callContext = null )

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

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

Parameters

$paymentId
$callContext

Returns

Ingenico\Connect\Sdk\Domain\Capture\CapturesResponse

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 captures of payment
public Ingenico\Connect\Sdk\Domain\Refund\RefundResponse
# refund( string $paymentId, Ingenico\Connect\Sdk\Domain\Refund\RefundRequest $body, Ingenico\Connect\Sdk\CallContext $callContext = null )

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

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

Parameters

$paymentId
$body
$callContext

Returns

Ingenico\Connect\Sdk\Domain\Refund\RefundResponse

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
Ingenico\Connect\Sdk\DeclinedRefundException

Link

Create refund
public Ingenico\Connect\Sdk\Domain\Refund\RefundsResponse
# refunds( string $paymentId, Ingenico\Connect\Sdk\CallContext $callContext = null )

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

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

Parameters

$paymentId
$callContext

Returns

Ingenico\Connect\Sdk\Domain\Refund\RefundsResponse

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 refunds of payment
public Ingenico\Connect\Sdk\Domain\Payment\CancelPaymentResponse
# cancel( string $paymentId, Ingenico\Connect\Sdk\CallContext $callContext = null )

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

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

Parameters

$paymentId
$callContext

Returns

Ingenico\Connect\Sdk\Domain\Payment\CancelPaymentResponse

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

Cancel payment
public Ingenico\Connect\Sdk\Domain\Dispute\DisputeResponse
# dispute( string $paymentId, Ingenico\Connect\Sdk\Domain\Dispute\CreateDisputeRequest $body, Ingenico\Connect\Sdk\CallContext $callContext = null )

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

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

Parameters

$paymentId
$body
$callContext

Returns

Ingenico\Connect\Sdk\Domain\Dispute\DisputeResponse

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 dispute
public Ingenico\Connect\Sdk\Domain\Dispute\DisputesResponse
# disputes( string $paymentId, Ingenico\Connect\Sdk\CallContext $callContext = null )

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

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

Parameters

$paymentId
$callContext

Returns

Ingenico\Connect\Sdk\Domain\Dispute\DisputesResponse

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 disputes
public Ingenico\Connect\Sdk\Domain\Payment\DeviceFingerprintDetails
# devicefingerprint( string $paymentId, Ingenico\Connect\Sdk\CallContext $callContext = null )

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

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

Parameters

$paymentId
$callContext

Returns

Ingenico\Connect\Sdk\Domain\Payment\DeviceFingerprintDetails

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 Device Fingerprint details
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