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 Payouts

Payouts client.

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

Resource /{merchantId}/payouts - Create payout

Resource /{merchantId}/payouts - Create payout

Parameters

$body
$callContext

Returns

Ingenico\Connect\Sdk\Domain\Payout\PayoutResponse

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\DeclinedPayoutException

Link

Create payout
public Ingenico\Connect\Sdk\Domain\Payout\FindPayoutsResponse
# find( Ingenico\Connect\Sdk\Merchant\Payouts\FindPayoutsParams $query, Ingenico\Connect\Sdk\CallContext $callContext = null )

Resource /{merchantId}/payouts - Find payouts

Resource /{merchantId}/payouts - Find payouts

Parameters

$query
$callContext

Returns

Ingenico\Connect\Sdk\Domain\Payout\FindPayoutsResponse

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 payouts
public Ingenico\Connect\Sdk\Domain\Payout\PayoutResponse
# get( string $payoutId, Ingenico\Connect\Sdk\CallContext $callContext = null )

Resource /{merchantId}/payouts/{payoutId} - Get payout

Resource /{merchantId}/payouts/{payoutId} - Get payout

Parameters

$payoutId
$callContext

Returns

Ingenico\Connect\Sdk\Domain\Payout\PayoutResponse

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 payout
public Ingenico\Connect\Sdk\Domain\Payout\PayoutResponse
# approve( string $payoutId, Ingenico\Connect\Sdk\Domain\Payout\ApprovePayoutRequest $body, Ingenico\Connect\Sdk\CallContext $callContext = null )

Resource /{merchantId}/payouts/{payoutId}/approve - Approve payout

Resource /{merchantId}/payouts/{payoutId}/approve - Approve payout

Parameters

$payoutId
$body
$callContext

Returns

Ingenico\Connect\Sdk\Domain\Payout\PayoutResponse

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 payout
public null
# cancel( string $payoutId, Ingenico\Connect\Sdk\CallContext $callContext = null )

Resource /{merchantId}/payouts/{payoutId}/cancel - Cancel payout

Resource /{merchantId}/payouts/{payoutId}/cancel - Cancel payout

Parameters

$payoutId
$callContext

Returns

null

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 payout
public null
# cancelapproval( string $payoutId, Ingenico\Connect\Sdk\CallContext $callContext = null )

Resource /{merchantId}/payouts/{payoutId}/cancelapproval - Undo approve payout

Resource /{merchantId}/payouts/{payoutId}/cancelapproval - Undo approve payout

Parameters

$payoutId
$callContext

Returns

null

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 approve payout
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