1. class
  2. MangoPay
  3. \
  4. ApiPayIns

ApiPayIns

class ApiPayIns extends ApiBase (View source)

Class to management MangoPay API for pay-ins

Properties

protected MangoPayApi $_root

Root/parent instance that holds the OAuthToken and Configuration instance

 from  ApiBase

Methods

mixed
getLogger()

No description

from  ApiBase
__construct(MangoPayApi $root)

Constructor Root/parent instance that holds the OAuthToken and Configuration instance

from  ApiBase
string
GetRequestUrl(string $key)

Get URL for REST Mango Pay API

from  ApiBase
RequestType
GetRequestType(string $key)

Get request type for REST Mango Pay API

from  ApiBase
GetApiVersion($key)

No description

from  ApiBase
object
CreateObject(string $methodKey, object $entity, object $responseClassName = null, string $entityId = null, $subEntityId = null, $idempotencyKey = null)

Create object in API

from  ApiBase
object
CreateOrUpdateMultipartObject(string $methodKey, string $file, string $fileName, string $responseClassName = null, string $entityId = null, string $idempotencyKey = null)

No description

from  ApiBase
object
GetObject(string $methodKey, object $responseClassName, $firstEntityId = null, $secondEntityId = null, $thirdEntityId = null, $clientIdRequired = true)

Get entity object from API

from  ApiBase
object
GetObjectManyQueryParams(string $methodKey, object $responseClassName, ...$queryParams)

Get entity object from API endpoint that has a lot of query params

from  ApiBase
object
GetObjectWithPagination(string $methodKey, object $responseClassName, $pagination = null, $filter = null, $entityId = null, $clientIdRequired = true)

Get entity object from API on a request path that contains pagination and other query params

from  ApiBase
object[]
GetList(string $methodKey, Pagination $pagination, object $responseClassName = null, string $entityId = null, object $filter = null, Sorting $sorting = null, $secondEntityId = null, $clientIdRequired = true)

Get lst with entities object from API

from  ApiBase
object
SaveObject(string $methodKey, object $entity, object $responseClassName = null, $secondEntityId = null, $thirdEntityId = null)

Save object in API

from  ApiBase
UpdateObject($methodKey, $entity, $responseClassName = null, $firstEntityId = null, $secondEntityId = null, $thirdEntityId = null)

Does the same thing as SaveObject above, but keeps natural order of provided entity ids when building the URL

from  ApiBase
DeleteObject($methodKey, $entity, $responseClassName = null)

No description

from  ApiBase
object
ExecutePostRequest(mixed $methodKey, mixed $entity, mixed $responseClassName, mixed $entityId = null, $idempotency_key = null)

Executes a POST request

from  ApiBase
Error
CastResponseToError(object $response)

Cast response object to an error object

from  ApiBase
CastResponseToEntity($response, $entityClassName, $asDependentObject = false)

Cast response object to entity object

from  ApiBase
array
BuildRequestData(object $entity)

Get array with request data

from  ApiBase
GetObjectForIdempotencyUrl($url)

No description

from  ApiBase
PayIn
Create(PayIn $payIn, $idempotencyKey = null)

Create new pay-in object

PayIn
Get(string $payInId)

Get pay-in object

Refund
CreateRefund(string $payInId, Refund $refund, $idempotencyKey = null)

Create refund for pay-in object

PayInRecurringRegistrationRequestResponse
CreateRecurringRegistration(PayInRecurringRegistration $recurringRegistration, $idempotencyKey = null)

Create a recurring payment

PayInRecurringRegistrationGet
GetRecurringRegistration(string $recurringRegistrationId, $idempotencyKey = null)

Get recurring payment

PayInRecurringRegistrationGet
UpdateRecurringRegistration(PayInRecurringRegistrationUpdate $recurringUpdate, $idempotencyKey = null)

Update recurring payment

PayInRecurring
CreateRecurringPayInRegistrationCIT(RecurringPayInCIT $recurringPayInRegistrationCIT, $idempotencyKey = null)

Create a Recurring PayIn CIT

PayInRecurring
CreateRecurringPayInRegistrationMIT(RecurringPayInMIT $recurringPayInRegistrationMIT, $idempotencyKey = null)

Create a Recurring PayIn MIT

PayInRecurring
CreateRecurringPayPalPayInCIT(RecurringPayPalPayInCIT $recurringPayPalPayInCIT, $idempotencyKey = null)

Create a Recurring PayPal PayIn CIT

PayInRecurring
CreateRecurringPayPalPayInMIT(RecurringPayPalPayInMIT $recurringPayPalPayInMIT, $idempotencyKey = null)

Create a Recurring PayPal PayIn MIT

Refund[]
GetRefunds(string $payInId, Pagination $pagination = null, FilterRefunds $filter = null, Sorting $sorting = null)

Retrieves a list of Refunds pertaining to a certain PayIn

PayInWebExtendedView
GetExtendedCardView(string $payInId)

Retrieves a more detailed view of details concerning the card used to process a Web payment.

PayIn
CreateCardPreAuthorizedDepositPayIn(CreateCardPreAuthorizedDepositPayIn $payIn)

Create Card PreAuthorized Deposit PayIn

PayIn
CreateDepositPreauthorizedPayInWithoutComplement(CreateCardPreAuthorizedDepositPayIn $payIn)

Create a Deposit Preauthorized PayIn without complement

PayIn
CreateDepositPreauthorizedPayInPriorToComplement(CreateCardPreAuthorizedDepositPayIn $payIn)

Create a Deposit Preauthorized PayIn prior to complement

PayIn
CreateDepositPreauthorizedPayInComplement(CreateCardPreAuthorizedDepositPayIn $payIn)

Create a Deposit Preauthorized PayIn complement

PayIn
CreatePayPal(PayIn $payIn, $idempotencyKey = null)

Create new PayPal Web pay-in object

PayIn
CreateGooglePay(PayIn $payIn, $idempotencyKey = null)

Create new GooglePay Direct pay-in object

PaymentMethodMetadata
GetPaymentMethodMetadata(PaymentMethodMetadata $paymentMethodMetadata, $idempotencyKey = null)

Look up metadata from BIN or Google Pay token

AddPayPalTrackingInformation($payId, PayPalWebTracking $palWebTracking)

No description

PayIn
CreatePayconiq(PayIn $payIn, $idempotencyKey = null)

Create a Payconiq Web PayIn using the latest API url (payins/payment-methods/payconiq)

PayInIntent
CreatePayInIntentAuthorization(PayInIntent $payInIntentAuthorization, $idempotencyKey = null)

Create a pay in intent authorization

PayInIntent
CreatePayInIntentCapture(string $intentId, PayInIntent $payInIntentCapture, $idempotencyKey = null)

Create a pay in intent authorization

PayInIntent
GetPayInIntent(string $intentId)

Get a pay in intent

PayInIntent
CancelPayInIntent(string $intentId, PayInIntent $details, string|null $idempotencyKey = null)

Cancel a pay in intent

IntentSplits
CreatePayInIntentSplits(string $intentId, IntentSplits $splits, $idempotencyKey = null)

Create Intent splits

PayInIntentSplit
ExecutePayInIntentSplit(string $intentId, string $splitId, $idempotencyKey = null)

Execute split

PayInIntentSplit
ReversePayInIntentSplit(string $intentId, string $splitId, $idempotencyKey = null)

Reverse split

PayInIntentSplit
GetPayInIntentSplit(string $intentId, string $splitId)

Get split

PayInIntentSplit
UpdatePayInIntentSplit(string $intentId, PayInIntentSplit $split)

Execute split

PayInIntent
CreatePayInIntentRefund(string $intentId, PayInIntent $payInIntentRefund, $idempotencyKey = null)

Create a pay in intent refund (full or partial)

PayInIntent
ReversePayInIntentRefund(string $intentId, string $refundId, PayInIntent $payInIntentRefund, $idempotencyKey = null)

Reverse a pay in intent refund (fully or partial)

PayByBankSupportedBank
GetPayByBankSupportedBanks(Pagination $pagination = null, FilterSupportedBanks $filter = null)

Retrieve a paginated list of banks that you can present to the user for selection during their Pay by Bank checkout experience

stdClass
CreatePayPalDataCollection(stdClass $dataCollection, string $idempotencyKey = null)

Send key pre-transaction data such as order details, buyer information, and merchant context before initiating a PayPal payment

stdClass
GetPayPalDataCollection(string $dataCollectionId, $idempotencyKey = null)

Send key pre-transaction data such as order details, buyer information, and merchant context before initiating a PayPal payment

PayInIntent
CreatePayInIntentDispute(string $intentId, string $captureId, PayInIntent $payInIntentDispute, $idempotencyKey = null)

Create a PayInIntentDispute (full or partial)

PayInIntent
UpdatePayInIntentDisputeOutcome(string $intentId, string $captureId, string $disputeId, PayInIntent $disputeOutcome)

Update PayInIntentDispute outcome

Details

in ApiBase at line 19
protected mixed getLogger()

No description

Return Value

mixed

in ApiBase at line 319
__construct(MangoPayApi $root)

Constructor Root/parent instance that holds the OAuthToken and Configuration instance

Parameters

MangoPayApi $root

in ApiBase at line 329
protected string GetRequestUrl(string $key)

Get URL for REST Mango Pay API

Parameters

string $key

Key with data

Return Value

string

in ApiBase at line 339
protected RequestType GetRequestType(string $key)

Get request type for REST Mango Pay API

Parameters

string $key

Key with data

Return Value

RequestType

in ApiBase at line 344
protected GetApiVersion($key)

No description

Parameters

$key

in ApiBase at line 360
protected object CreateObject(string $methodKey, object $entity, object $responseClassName = null, string $entityId = null, $subEntityId = null, $idempotencyKey = null)

Create object in API

Parameters

string $methodKey

Key with request data
object $entity

Entity object
object $responseClassName

Name of entity class from response
string $entityId

Entity identifier
$subEntityId
$idempotencyKey

Return Value

object

Response data

in ApiBase at line 399
protected object CreateOrUpdateMultipartObject(string $methodKey, string $file, string $fileName, string $responseClassName = null, string $entityId = null, string $idempotencyKey = null)

No description

Parameters

string $methodKey

Key with request data
string $file

The file content (raw binary string)
string $fileName

The file name
string $responseClassName

Name of entity class from response
string $entityId

Optional entity identifier
string $idempotencyKey

Optional idempotency key

Return Value

object

Response data

Exceptions

Exception

in ApiBase at line 428
protected object GetObject(string $methodKey, object $responseClassName, $firstEntityId = null, $secondEntityId = null, $thirdEntityId = null, $clientIdRequired = true)

Get entity object from API

Parameters

string $methodKey

Key with request data
object $responseClassName

Name of entity class from response
$firstEntityId
$secondEntityId
$thirdEntityId
$clientIdRequired

Return Value

object

Response data

Exceptions

Exception

in ApiBase at line 457
protected object GetObjectManyQueryParams(string $methodKey, object $responseClassName, ...$queryParams)

Get entity object from API endpoint that has a lot of query params

Parameters

string $methodKey

Key with request data
object $responseClassName

Name of entity class from response
...$queryParams

Return Value

object

Response data

Exceptions

Exception

in ApiBase at line 477
protected object GetObjectWithPagination(string $methodKey, object $responseClassName, $pagination = null, $filter = null, $entityId = null, $clientIdRequired = true)

Get entity object from API on a request path that contains pagination and other query params

Parameters

string $methodKey

Key with request data
object $responseClassName

Name of entity class from response
$pagination
$filter
$entityId
$clientIdRequired

Return Value

object

Response data

Exceptions

Exception

in ApiBase at line 520
protected object[] GetList(string $methodKey, Pagination $pagination, object $responseClassName = null, string $entityId = null, object $filter = null, Sorting $sorting = null, $secondEntityId = null, $clientIdRequired = true)

Get lst with entities object from API

Parameters

string $methodKey

Key with request data
Pagination $pagination

Pagination object
object $responseClassName

Name of entity class from response
string $entityId

Entity identifier
object $filter

Object to filter data
Sorting $sorting

Object to sorting data
$secondEntityId
$clientIdRequired

Return Value

object[]

Response data

in ApiBase at line 558
protected object SaveObject(string $methodKey, object $entity, object $responseClassName = null, $secondEntityId = null, $thirdEntityId = null)

Save object in API

Parameters

string $methodKey

Key with request data
object $entity

Entity object to save
object $responseClassName

Name of entity class from response
$secondEntityId
$thirdEntityId

Return Value

object

Response data

in ApiBase at line 589
protected UpdateObject($methodKey, $entity, $responseClassName = null, $firstEntityId = null, $secondEntityId = null, $thirdEntityId = null)

Does the same thing as SaveObject above, but keeps natural order of provided entity ids when building the URL

Parameters

$methodKey
$entity
$responseClassName
$firstEntityId
$secondEntityId
$thirdEntityId

in ApiBase at line 613
protected DeleteObject($methodKey, $entity, $responseClassName = null)

No description

Parameters

$methodKey
$entity
$responseClassName

in ApiBase at line 639
protected object ExecutePostRequest(mixed $methodKey, mixed $entity, mixed $responseClassName, mixed $entityId = null, $idempotency_key = null)

Executes a POST request

Parameters

mixed $methodKey

Key with request data
mixed $entity

Entity object
mixed $responseClassName

Name of entity class from response
mixed $entityId

Entity identifier
$idempotency_key

Return Value

object

Response data

in ApiBase at line 664
protected Error CastResponseToError(object $response)

Cast response object to an error object

Parameters

object $response

Object from API response

Return Value

Error

The error

in ApiBase at line 700
protected CastResponseToEntity($response, $entityClassName, $asDependentObject = false)

Cast response object to entity object

Parameters

$response
$entityClassName
$asDependentObject

in ApiBase at line 815
protected array BuildRequestData(object $entity)

Get array with request data

Parameters

object $entity

Entity object to send as request data

Return Value

array

in ApiBase at line 876
protected GetObjectForIdempotencyUrl($url)

No description

Parameters

$url

at line 17
PayIn Create(PayIn $payIn, $idempotencyKey = null)

Create new pay-in object

Parameters

PayIn $payIn

\MangoPay\PayIn object
$idempotencyKey

Return Value

PayIn

Object returned from API

at line 29
PayIn Get(string $payInId)

Get pay-in object

Parameters

string $payInId

Pay-in identifier

Return Value

PayIn

Object returned from API

at line 40
Refund CreateRefund(string $payInId, Refund $refund, $idempotencyKey = null)

Create refund for pay-in object

Parameters

string $payInId

Pay-in identifier
Refund $refund

Refund object to create
$idempotencyKey

Return Value

Refund

Object returned by REST API

at line 50
PayInRecurringRegistrationRequestResponse CreateRecurringRegistration(PayInRecurringRegistration $recurringRegistration, $idempotencyKey = null)

Create a recurring payment

Parameters

PayInRecurringRegistration $recurringRegistration
$idempotencyKey

Return Value

PayInRecurringRegistrationRequestResponse

at line 60
PayInRecurringRegistrationGet GetRecurringRegistration(string $recurringRegistrationId, $idempotencyKey = null)

Get recurring payment

Parameters

string $recurringRegistrationId
$idempotencyKey

Return Value

PayInRecurringRegistrationGet

at line 70
PayInRecurringRegistrationGet UpdateRecurringRegistration(PayInRecurringRegistrationUpdate $recurringUpdate, $idempotencyKey = null)

Update recurring payment

Parameters

PayInRecurringRegistrationUpdate $recurringUpdate
$idempotencyKey

Return Value

PayInRecurringRegistrationGet

at line 80
PayInRecurring CreateRecurringPayInRegistrationCIT(RecurringPayInCIT $recurringPayInRegistrationCIT, $idempotencyKey = null)

Create a Recurring PayIn CIT

Parameters

RecurringPayInCIT $recurringPayInRegistrationCIT
$idempotencyKey

Return Value

PayInRecurring

at line 90
PayInRecurring CreateRecurringPayInRegistrationMIT(RecurringPayInMIT $recurringPayInRegistrationMIT, $idempotencyKey = null)

Create a Recurring PayIn MIT

Parameters

RecurringPayInMIT $recurringPayInRegistrationMIT
$idempotencyKey

Return Value

PayInRecurring

at line 100
PayInRecurring CreateRecurringPayPalPayInCIT(RecurringPayPalPayInCIT $recurringPayPalPayInCIT, $idempotencyKey = null)

Create a Recurring PayPal PayIn CIT

Parameters

RecurringPayPalPayInCIT $recurringPayPalPayInCIT
$idempotencyKey

Return Value

PayInRecurring

at line 110
PayInRecurring CreateRecurringPayPalPayInMIT(RecurringPayPalPayInMIT $recurringPayPalPayInMIT, $idempotencyKey = null)

Create a Recurring PayPal PayIn MIT

Parameters

RecurringPayPalPayInMIT $recurringPayPalPayInMIT
$idempotencyKey

Return Value

PayInRecurring

at line 123
Refund[] GetRefunds(string $payInId, Pagination $pagination = null, FilterRefunds $filter = null, Sorting $sorting = null)

Retrieves a list of Refunds pertaining to a certain PayIn

Parameters

string $payInId

ID of PayIn for which to retrieve Refunds
Pagination $pagination

Pagination object
FilterRefunds $filter

Filtering object
Sorting $sorting

Sorting object

Return Value

Refund[]

List of the PayIn's Refunds

at line 154
PayInWebExtendedView GetExtendedCardView(string $payInId)

Retrieves a more detailed view of details concerning the card used to process a Web payment.

Parameters

string $payInId

ID of the PayIn to retrieve card details for

Return Value

PayInWebExtendedView

Object returned from API

at line 164
PayIn CreateCardPreAuthorizedDepositPayIn(CreateCardPreAuthorizedDepositPayIn $payIn)

Create Card PreAuthorized Deposit PayIn

Parameters

CreateCardPreAuthorizedDepositPayIn $payIn

PayIn object to create

Return Value

PayIn

Deposit object returned from API

at line 174
PayIn CreateDepositPreauthorizedPayInWithoutComplement(CreateCardPreAuthorizedDepositPayIn $payIn)

Create a Deposit Preauthorized PayIn without complement

Parameters

CreateCardPreAuthorizedDepositPayIn $payIn

PayIn object to create

Return Value

PayIn

Deposit object returned from API

at line 184
PayIn CreateDepositPreauthorizedPayInPriorToComplement(CreateCardPreAuthorizedDepositPayIn $payIn)

Create a Deposit Preauthorized PayIn prior to complement

Parameters

CreateCardPreAuthorizedDepositPayIn $payIn

PayIn object to create

Return Value

PayIn

Deposit object returned from API

at line 194
PayIn CreateDepositPreauthorizedPayInComplement(CreateCardPreAuthorizedDepositPayIn $payIn)

Create a Deposit Preauthorized PayIn complement

Parameters

CreateCardPreAuthorizedDepositPayIn $payIn

PayIn object to create

Return Value

PayIn

Deposit object returned from API

at line 204
PayIn CreatePayPal(PayIn $payIn, $idempotencyKey = null)

Create new PayPal Web pay-in object

Parameters

PayIn $payIn

\MangoPay\PayIn object
$idempotencyKey

Return Value

PayIn

Object returned from API

at line 214
PayIn CreateGooglePay(PayIn $payIn, $idempotencyKey = null)

Create new GooglePay Direct pay-in object

Parameters

PayIn $payIn

\MangoPay\PayIn object
$idempotencyKey

Return Value

PayIn

Object returned from API

at line 224
PaymentMethodMetadata GetPaymentMethodMetadata(PaymentMethodMetadata $paymentMethodMetadata, $idempotencyKey = null)

Look up metadata from BIN or Google Pay token

Parameters

PaymentMethodMetadata $paymentMethodMetadata

\MangoPay\PaymentMethodMetadata object
$idempotencyKey

Return Value

PaymentMethodMetadata

Object returned from API

at line 229
AddPayPalTrackingInformation($payId, PayPalWebTracking $palWebTracking)

No description

Parameters

$payId
PayPalWebTracking $palWebTracking

at line 239
PayIn CreatePayconiq(PayIn $payIn, $idempotencyKey = null)

Create a Payconiq Web PayIn using the latest API url (payins/payment-methods/payconiq)

Parameters

PayIn $payIn

\MangoPay\PayIn object
$idempotencyKey

Return Value

PayIn

Object returned from API

at line 249
PayInIntent CreatePayInIntentAuthorization(PayInIntent $payInIntentAuthorization, $idempotencyKey = null)

Create a pay in intent authorization

Parameters

PayInIntent $payInIntentAuthorization

\MangoPay\PayInIntent object
$idempotencyKey

Return Value

PayInIntent

Object returned from API

at line 267
PayInIntent CreatePayInIntentCapture(string $intentId, PayInIntent $payInIntentCapture, $idempotencyKey = null)

Create a pay in intent authorization

Parameters

string $intentId

The identifier of the PayInIntent
PayInIntent $payInIntentCapture

\MangoPay\PayInIntent object
$idempotencyKey

Return Value

PayInIntent

Object returned from API

at line 284
PayInIntent GetPayInIntent(string $intentId)

Get a pay in intent

Parameters

string $intentId

The identifier of the PayInIntent

Return Value

PayInIntent

Object returned from API

at line 296
PayInIntent CancelPayInIntent(string $intentId, PayInIntent $details, string|null $idempotencyKey = null)

Cancel a pay in intent

Parameters

string $intentId

The identifier of the PayInIntent
PayInIntent $details

Intent details
string|null $idempotencyKey

Idempotency key for this request (optional)

Return Value

PayInIntent

Object returned from API

at line 314
IntentSplits CreatePayInIntentSplits(string $intentId, IntentSplits $splits, $idempotencyKey = null)

Create Intent splits

Parameters

string $intentId

The identifier of the PayInIntent
IntentSplits $splits Splits
$idempotencyKey

Return Value

IntentSplits

Object returned from API

at line 332
PayInIntentSplit ExecutePayInIntentSplit(string $intentId, string $splitId, $idempotencyKey = null)

Execute split

Parameters

string $intentId

The identifier of the PayInIntent
string $splitId

The identifier of the Split
$idempotencyKey

Return Value

PayInIntentSplit

Object returned from API

at line 350
PayInIntentSplit ReversePayInIntentSplit(string $intentId, string $splitId, $idempotencyKey = null)

Reverse split

Parameters

string $intentId

The identifier of the PayInIntent
string $splitId

The identifier of the Split
$idempotencyKey

Return Value

PayInIntentSplit

Object returned from API

at line 368
PayInIntentSplit GetPayInIntentSplit(string $intentId, string $splitId)

Get split

Parameters

string $intentId

The identifier of the PayInIntent
string $splitId

The identifier of the Split

Return Value

PayInIntentSplit

Object returned from API

at line 385
PayInIntentSplit UpdatePayInIntentSplit(string $intentId, PayInIntentSplit $split)

Execute split

Parameters

string $intentId

The identifier of the PayInIntent
PayInIntentSplit $split

Object containing the properties to be updated. At least the 'Id' and 'LineItemId' need to be present.

Return Value

PayInIntentSplit

Object returned from API

at line 401
PayInIntent CreatePayInIntentRefund(string $intentId, PayInIntent $payInIntentRefund, $idempotencyKey = null)

Create a pay in intent refund (full or partial)

Parameters

string $intentId

The identifier of the PayInIntent
PayInIntent $payInIntentRefund

The Refund to be created
$idempotencyKey

Return Value

PayInIntent

Object returned from API

at line 420
PayInIntent ReversePayInIntentRefund(string $intentId, string $refundId, PayInIntent $payInIntentRefund, $idempotencyKey = null)

Reverse a pay in intent refund (fully or partial)

Parameters

string $intentId

The identifier of the PayInIntent
string $refundId

The identifier of the PayInIntentRefund
PayInIntent $payInIntentRefund

The Refund to be reversed
$idempotencyKey

Return Value

PayInIntent

Object returned from API

at line 438
PayByBankSupportedBank GetPayByBankSupportedBanks(Pagination $pagination = null, FilterSupportedBanks $filter = null)

Retrieve a paginated list of banks that you can present to the user for selection during their Pay by Bank checkout experience

Parameters

Pagination $pagination

Pagination object
FilterSupportedBanks $filter

Filtering object

Return Value

PayByBankSupportedBank

Object returned by the API

at line 458
stdClass CreatePayPalDataCollection(stdClass $dataCollection, string $idempotencyKey = null)

Send key pre-transaction data such as order details, buyer information, and merchant context before initiating a PayPal payment

Since the fields needed by PayPal are dynamic and can change, the method expects a stdClass as payload

Parameters

stdClass $dataCollection
string $idempotencyKey

Return Value

stdClass

at line 471
stdClass GetPayPalDataCollection(string $dataCollectionId, $idempotencyKey = null)

Send key pre-transaction data such as order details, buyer information, and merchant context before initiating a PayPal payment

Parameters

string $dataCollectionId
$idempotencyKey

Return Value

stdClass

Exceptions

Exception

at line 483
PayInIntent CreatePayInIntentDispute(string $intentId, string $captureId, PayInIntent $payInIntentDispute, $idempotencyKey = null)

Create a PayInIntentDispute (full or partial)

Parameters

string $intentId

The identifier of the PayInIntent
string $captureId

The identifier of the PayInIntentCapture
PayInIntent $payInIntentDispute

The Dispute to be created
$idempotencyKey

Return Value

PayInIntent

Object returned from API

at line 503
PayInIntent UpdatePayInIntentDisputeOutcome(string $intentId, string $captureId, string $disputeId, PayInIntent $disputeOutcome)

Update PayInIntentDispute outcome

Parameters

string $intentId

The identifier of the PayInIntent
string $captureId

The identifier of the PayInIntentCapture
string $disputeId

The identifier of the PayInIntentDispute
PayInIntent $disputeOutcome

Object containing the 'decision' and intent id

Return Value

PayInIntent

Object returned from API