• A
• B
• C
• D
• E
• F
• G
• H
• I
• J
• K
• L
• M
• N
• O
• P
• Q
• R
• S
• T
• U
• V
• W
• X
• Y
• Z

A

AVSResult — Class in namespace MangoPay

Address Verification System result

Address — Class in namespace MangoPay

Class represents an address.

$ Address#AddressLine1 — Property in class Address

Address line 1.

$ Address#AddressLine2 — Property in class Address

Address line 2.

ApiBankAccounts — Class in namespace MangoPay

Class to manage MangoPay API for bank accounts

ApiBankingAliases — Class in namespace MangoPay

Class to management MangoPay API for Banking Aliases

ApiCardPreAuthorizations — Class in namespace MangoPay

Class to management MangoPay API for pre-authorization process

ApiCardRegistrations — Class in namespace MangoPay

Class to management MangoPay API for card registrations

ApiCards — Class in namespace MangoPay

Class to management MangoPay API for cards

ApiClients — Class in namespace MangoPay

Class to management MangoPay API for users

ApiConversions — Class in namespace MangoPay

Class to management MangoPay API for instant conversions

ApiDeposits — Class in namespace MangoPay

Class to management MangoPay API for users

ApiDisputeDocuments — Class in namespace MangoPay

Class ApiDisputeDocuments

ApiDisputes — Class in namespace MangoPay

Class ApiDisputes

ApiEvents — Class in namespace MangoPay

Class to management MangoPay API for cards

ApiHooks — Class in namespace MangoPay

Class to management MangoPay API for hooks and notifications

ApiIdentityVerification — Class in namespace MangoPay

Class to management MangoPay API for Identity Verification Sessions

ApiKycDocuments — Class in namespace MangoPay

Class to management MangoPay API for KYC document list

ApiMandates — Class in namespace MangoPay

Class to management MangoPay API for mandates

ApiPayIns — Class in namespace MangoPay

Class to management MangoPay API for pay-ins

ApiPayIns::AddPayPalTrackingInformation() — Method in class ApiPayIns

ApiPayOuts — Class in namespace MangoPay

Class to management MangoPay API for pay-outs

ApiRefunds — Class in namespace MangoPay

Class to management MangoPay API for refunds

ApiRegulatory — Class in namespace MangoPay

Class to management MangoPay API for regulatory endpoints

ApiReports — Class in namespace MangoPay

Class to management MangoPay API for reports

ApiRepudiations — Class in namespace MangoPay

Class to manage MangoPay API for Repudiations

ApiResponses — Class in namespace MangoPay

Class to management MangoPay API for responses See

ApiTransfers — Class in namespace MangoPay

Class to management MangoPay API for transfers

ApiUboDeclarations — Class in namespace MangoPay

Manages API calls for the UBO declaration entity.

ApiUsers — Class in namespace MangoPay

Class to manage MangoPay API calls for the user entity.

ApiVirtualAccounts — Class in namespace MangoPay

ApiWallets — Class in namespace MangoPay

Class to management MangoPay API for wallets

$ BankAccount#Active — Property in class BankAccount

$ BankAccountDetailsCA#AccountNumber — Property in class BankAccountDetailsCA

Account number

$ BankAccountDetailsGB#AccountNumber — Property in class BankAccountDetailsGB

Account number

$ BankAccountDetailsOTHER#AccountNumber — Property in class BankAccountDetailsOTHER

Account number

$ BankAccountDetailsUS#AccountNumber — Property in class BankAccountDetailsUS

Account number

$ BankAccountDetailsUS#ABA — Property in class BankAccountDetailsUS

ABA

$ BankingAlias#Active — Property in class BankingAlias

Wether the banking alias is active or not

$ BankingAliasOTHER#AccountNumber — Property in class BankingAliasOTHER

Account Number

$ Billing#Address — Property in class Billing

The billing address

$ BrowserInfo#AcceptHeader — Property in class BrowserInfo

$ Card#Alias — Property in class Card

Alias

$ Card#Active — Property in class Card

Active

$ CardPreAuthorization#AuthorId — Property in class CardPreAuthorization

The user Id of the author of the pre-authorization

$ CardPreAuthorization#AuthorizationDate — Property in class CardPreAuthorization

The date when the payment was authorized

$ CardPreAuthorization#Applied3DSVersion — Property in class CardPreAuthorization

Applied3DSVersion

$ CardRegistration#AccessKey — Property in class CardRegistration

Access key

$ CardValidation#AuthorId — Property in class CardValidation

Author Id

$ CardValidation#Applied3DSVersion — Property in class CardValidation

Applied3DSVersion

$ CardValidation#AuthorizationDate — Property in class CardValidation

The date and time at which successful authorization occurred. If authorization failed, the value is null.

$ Client#AdminEmails — Property in class Client

A list of email addresses to use when contacting you for admin/commercial issues/communications

$ Conversion#AuthorId — Property in class Conversion

The unique identifier of the user at the source of the transaction.

$ CountryAuthorization#Authorization — Property in class CountryAuthorization

Information about the country’s restrictions.

$ CreateCardPreAuthorizedDepositPayIn#AuthorId — Property in class CreateCardPreAuthorizedDepositPayIn

$ CreateDeposit#AuthorId — Property in class CreateDeposit

$ CreateInstantConversion#AuthorId — Property in class CreateInstantConversion

The unique identifier of the user at the source of the transaction.

$ CreateQuotedConversion#AuthorId — Property in class CreateQuotedConversion

The unique identifier of the user at the source of the transaction.

$ DebitedBankAccount#AccountNumber — Property in class DebitedBankAccount

The Account Number

$ Deposit#AuthorId — Property in class Deposit

$ Deposit#Applied3DSVersion — Property in class Deposit

$ FilterBankAccounts#Active — Property in class FilterBankAccounts

Active {true, false}

$ FilterBase#AfterDate — Property in class FilterBase

End date in unix format: return only records that have CreationDate AFTER this date

$ FilterCards#Active — Property in class FilterCards

Active {true, false}

$ FilterReports#AuthorId — Property in class FilterReports

User ID

$ InternationalAccountDetails#Address — Property in class InternationalAccountDetails

Information about the address associated with the international IBAN account.

$ InternationalAccountDetails#Account — Property in class InternationalAccountDetails

The IBAN and BIC of the account.

ApiBase — Class in namespace MangoPay\Libraries

Base class for MangoPay API managers

ApiOAuth — Class in namespace MangoPay\Libraries

Authentication manager

AuthenticationHelper — Class in namespace MangoPay\Libraries

AuthorizationTokenManager — Class in namespace MangoPay\Libraries

Authorization token manager

$ OAuthToken#access_token — Property in class OAuthToken

Value of token

$ OAuthToken#autentication_key — Property in class OAuthToken

Autentication key

RestTool::AddRequestHttpHeader() — Method in class RestTool

$ LocalAccount#AccountNumber — Property in class LocalAccount

The account number of the account

$ LocalAccountDetails#Address — Property in class LocalAccountDetails

Information about the address associated with the local IBAN account.

$ LocalAccountDetails#Account — Property in class LocalAccountDetails

Information about the address associated with the local IBAN account.

$ LocalAccountDetailsBankingAlias#AccountNumber — Property in class LocalAccountDetailsBankingAlias

BankingAlias GB AccountNumber

$ MangoPayApi#AuthenticationManager — Property in class MangoPayApi

OAuth methods

$ Money#Amount — Property in class Money

The currency amount of money

$ PayInExecutionDetailsDirect#Applied3DSVersion — Property in class PayInExecutionDetailsDirect

Applied3DSVersion

$ PayInPaymentDetailsKlarna#AdditionalData — Property in class PayInPaymentDetailsKlarna

Klarna custom data that you can add to this item

$ PayInRecurringRegistration#AuthorId — Property in class PayInRecurringRegistration

$ PayInWebExtendedView#Alias — Property in class PayInWebExtendedView

A partially obfuscated version of the credit card number

$ PayOutEligibilityRequest#AuthorId — Property in class PayOutEligibilityRequest

A user's ID

$ Repudiation#AuthorId — Property in class Repudiation

The Id of the origin payin author

$ SecurityInfo#AVSResult — Property in class SecurityInfo

Result of the AVS verification

$ SettlementTransfer#AuthorId — Property in class SettlementTransfer

The Id of the author of the original PayIn that was repudiated

$ Shipping#Address — Property in class Shipping

The address.

$ ShippingAddress#Address — Property in class ShippingAddress

The address.

Sorting::AddField() — Method in class Sorting

Add filed to sort

Sorting::AddFiled() — Method in class Sorting

$ Transaction#AuthorId — Property in class Transaction

Author Id

$ Ubo#Address — Property in class Ubo

$ UserBlockStatus#ActionCode — Property in class UserBlockStatus

$ UserNatural#Address — Property in class UserNatural

Address for user

$ VirtualAccount#Active — Property in class VirtualAccount

Whether the banking alias is active or not

$ VirtualAccount#AccountOwner — Property in class VirtualAccount

The current Status of the Virtual Account Allowed values: COLLECTION, USER_OWNED

$ VirtualAccountAvailability#Available — Property in class VirtualAccountAvailability

Whether international bank wires can be made to this account

B

BankAccount — Class in namespace MangoPay

Bank Account entity

BankAccountDetails — Class in namespace MangoPay

Marker interface for classes with details option in BankAccount entity

BankAccountDetailsCA — Class in namespace MangoPay

Class represents CA bank account type for in BankAccount entity

$ BankAccountDetailsCA#BankName — Property in class BankAccountDetailsCA

Bank name

$ BankAccountDetailsCA#BranchCode — Property in class BankAccountDetailsCA

Branch code

BankAccountDetailsGB — Class in namespace MangoPay

Class represents GB bank account type for in BankAccount entity

BankAccountDetailsIBAN — Class in namespace MangoPay

Class represents IBAN bank account type for in BankAccount entity

$ BankAccountDetailsIBAN#BIC — Property in class BankAccountDetailsIBAN

BIC

BankAccountDetailsOTHER — Class in namespace MangoPay

Class represents OTHER bank account type for in BankAccount entity

$ BankAccountDetailsOTHER#BIC — Property in class BankAccountDetailsOTHER

Valid BIC format

BankAccountDetailsUS — Class in namespace MangoPay

Class represents US bank account type for in BankAccount entity

BankingAlias — Class in namespace MangoPay

Bank Account entity

BankingAliasIBAN — Class in namespace MangoPay

Bank Account entity

$ BankingAliasIBAN#BIC — Property in class BankingAliasIBAN

The BIC of the banking alias

BankingAliasOTHER — Class in namespace MangoPay

$ BankingAliasOTHER#BIC — Property in class BankingAliasOTHER

BIC

BankingAliasType — Class in namespace MangoPay

Event types

Billing — Class in namespace MangoPay

Billing information

Birthplace — Class in namespace MangoPay

BrowserInfo — Class in namespace MangoPay

BusinessType — Class in namespace MangoPay

Business types

$ Card#BankCode — Property in class Card

Bank code

$ CardInfo#BIN — Property in class CardInfo

The 6-digit bank identification number (BIN) of the card issuer.

$ CardInfo#Brand — Property in class CardInfo

The card brand. Examples include: AMERICAN EXPRESS, DISCOVER, JCB, MASTERCARD, VISA, etc.

$ CardPreAuthorization#Billing — Property in class CardPreAuthorization

Billing information

$ CardPreAuthorization#BrowserInfo — Property in class CardPreAuthorization

BrowserInfo

$ CardValidation#BrowserInfo — Property in class CardValidation

BrowserInfo

$ Client#BillingEmails — Property in class Client

A list of email addresses to use when contacting you for billing issues/communications

$ CountryAuthorizationData#BlockUserCreation — Property in class CountryAuthorizationData

Whether or not user creation is possible based on the user’s country of residence.

$ CountryAuthorizationData#BlockBankAccountCreation — Property in class CountryAuthorizationData

Whether or not bank account creation is possible based on the bank’s country of domiciliation.

$ CountryAuthorizationData#BlockPayout — Property in class CountryAuthorizationData

Whether or not payout creation is possible based on the bank’s country of domiciliation.

$ CreateDeposit#BrowserInfo — Property in class CreateDeposit

BrowserInfo

$ CreateDeposit#Billing — Property in class CreateDeposit

$ DebitedBankAccount#BIC — Property in class DebitedBankAccount

BIC

$ Deposit#BrowserInfo — Property in class Deposit

BrowserInfo

$ Deposit#Billing — Property in class Deposit

$ FilterBase#BeforeDate — Property in class FilterBase

Start date in unix format: return only records that have CreationDate BEFORE this date

$ InternationalAccount#Bic — Property in class InternationalAccount

ApiBase::BuildRequestData() — Method in class ApiBase

Get array with request data

$ Configuration#BaseUrl — Property in class Configuration

Base URL to MangoPay API

$ HttpResponse#Body — Property in class HttpResponse

$ Mandate#BankAccountId — Property in class Mandate

The bank account ID to associate this mandate against

$ Mandate#BankReference — Property in class Mandate

The bank reference

$ MangoPayApi#BankingAliases — Property in class MangoPayApi

Provides banking aliases methods

$ MangoPayApi#BankAccounts — Property in class MangoPayApi

Provides Bank Account methods

$ PayInExecutionDetailsDirect#Billing — Property in class PayInExecutionDetailsDirect

Billing information

$ PayInExecutionDetailsExternalInstruction#BankingAliasId — Property in class PayInExecutionDetailsExternalInstruction

The ID of a banking alias.

$ PayInExecutionDetailsWeb#Billing — Property in class PayInExecutionDetailsWeb

Billing information

$ PayInPaymentDetailsBankWire#BankAccount — Property in class PayInPaymentDetailsBankWire

Bank account details

$ PayInPaymentDetailsCard#BrowserInfo — Property in class PayInPaymentDetailsCard

BrowserInfo

$ PayInPaymentDetailsCard#Bic — Property in class PayInPaymentDetailsCard

$ PayInPaymentDetailsCard#BankName — Property in class PayInPaymentDetailsCard

$ PayInPaymentDetailsGooglePay#BrowserInfo — Property in class PayInPaymentDetailsGooglePay

The IP address of the end user initiating the transaction, in IPV4 or IPV6 format.

$ PayInPaymentDetailsIdeal#Bic — Property in class PayInPaymentDetailsIdeal

The BIC identifier of the end-user’s bank

$ PayInPaymentDetailsIdeal#BankName — Property in class PayInPaymentDetailsIdeal

Name of the end-user’s bank

$ PayInPaymentDetailsPaypal#BuyerCountry — Property in class PayInPaymentDetailsPaypal

$ PayInPaymentDetailsPaypal#BuyerFirstname — Property in class PayInPaymentDetailsPaypal

$ PayInPaymentDetailsPaypal#BuyerLastname — Property in class PayInPaymentDetailsPaypal

$ PayInPaymentDetailsPaypal#BuyerPhone — Property in class PayInPaymentDetailsPaypal

$ PayInRecurringRegistration#Billing — Property in class PayInRecurringRegistration

$ PayInRecurringRegistrationUpdate#Billing — Property in class PayInRecurringRegistrationUpdate

$ PayOutEligibilityRequest#BankAccountId — Property in class PayOutEligibilityRequest

An ID of a Bank Account

$ PayOutEligibilityRequest#BankWireRef — Property in class PayOutEligibilityRequest

A custom reference you wish to appear on the user’s bank statement (your Client Name is already shown). We advise you not to add more than 12 characters.

$ PayOutPaymentDetailsBankWire#BankAccountId — Property in class PayOutPaymentDetailsBankWire

Bank account Id

$ PayOutPaymentDetailsBankWire#BankWireRef — Property in class PayOutPaymentDetailsBankWire

A custom reference you wish to appear on the user’s bank statement

$ PaymentMethodMetadata#Bin — Property in class PaymentMethodMetadata

The bank identification number (BIN). (Format: 6 or 8 digits)

$ PaymentMethodMetadata#BinData — Property in class PaymentMethodMetadata

Additional data about the card based on the BIN. In the case of co-branded card products, two objects are returned.

$ PlatformCategorization#BusinessType — Property in class PlatformCategorization

Type of business conducted by the platform

$ RecurringPayInCIT#BrowserInfo — Property in class RecurringPayInCIT

$ Ubo#Birthday — Property in class Ubo

$ Ubo#Birthplace — Property in class Ubo

$ UserNatural#Birthday — Property in class UserNatural

Date of birth

$ Wallet#Balance — Property in class Wallet

Money in wallet

C

$ Address#City — Property in class Address

City.

$ Address#Country — Property in class Address

Country.

Address::CanBeNull() — Method in class Address

ApiBankingAliases::Create() — Method in class ApiBankingAliases

Create a banking alias

ApiCardPreAuthorizations::Create() — Method in class ApiCardPreAuthorizations

Create new pre-authorization object

ApiCardRegistrations::Create() — Method in class ApiCardRegistrations

Create new card registration

ApiClients::CreateBankAccount() — Method in class ApiClients

ApiClients::CreatePayOut() — Method in class ApiClients

ApiConversions::CreateInstantConversion() — Method in class ApiConversions

This endpoint allows the platform to move funds between two wallets of different currencies instantaneously.

ApiConversions::CreateClientWalletsInstantConversion() — Method in class ApiConversions

This call triggers an immediate conversion at the market rate, of the debited funds to the credited wallet at the market rate.

ApiConversions::CreateQuotedConversion() — Method in class ApiConversions

This call triggers a conversion, at the rate guaranteed by its quote, of the debited funds to the credited wallet.

ApiConversions::CreateClientWalletsQuotedConversion() — Method in class ApiConversions

This call triggers a conversion at the rate defined in its quote.

ApiConversions::CreateConversionQuote() — Method in class ApiConversions

This call guarantees a conversion rate to let you Create a Quoted Conversion.

ApiDeposits::Create() — Method in class ApiDeposits

Create Deposit

ApiDeposits::Cancel() — Method in class ApiDeposits

Cancel Deposit

ApiDisputeDocuments::CreateDisputeDocumentConsult() — Method in class ApiDisputeDocuments

Creates temporary URLs where each page of a dispute document can be viewed.

ApiDisputes::ContestDispute() — Method in class ApiDisputes

Contests dispute

ApiDisputes::CloseDispute() — Method in class ApiDisputes

Close dispute

ApiDisputes::CreateSettlementTransfer() — Method in class ApiDisputes

Creates settlement transfer

ApiDisputes::CreateDisputeDocument() — Method in class ApiDisputes

Creates document for dispute

ApiDisputes::CreateDisputeDocumentPage() — Method in class ApiDisputes

Creates document's page for dispute

ApiDisputes::CreateDisputeDocumentPageFromFile() — Method in class ApiDisputes

Creates document's page for dispute from file

ApiHooks::Create() — Method in class ApiHooks

Create new hook

ApiIdentityVerification::Create() — Method in class ApiIdentityVerification

Create new IdentityVerification

ApiKycDocuments::CreateKycDocumentConsult() — Method in class ApiKycDocuments

Creates temporary URLs where each page of a KYC document can be viewed.

ApiMandates::Create() — Method in class ApiMandates

Create new mandate

ApiMandates::Cancel() — Method in class ApiMandates

Cancel mandate

ApiPayIns::Create() — Method in class ApiPayIns

Create new pay-in object

ApiPayIns::CreateRefund() — Method in class ApiPayIns

Create refund for pay-in object

ApiPayIns::CreateRecurringRegistration() — Method in class ApiPayIns

Create a recurring payment

ApiPayIns::CreateRecurringPayInRegistrationCIT() — Method in class ApiPayIns

Create a Recurring PayIn CIT

ApiPayIns::CreateRecurringPayInRegistrationMIT() — Method in class ApiPayIns

Create a Recurring PayIn MIT

ApiPayIns::CreateCardPreAuthorizedDepositPayIn() — Method in class ApiPayIns

Create Card PreAuthorized Deposit PayIn

ApiPayIns::CreatePayPal() — Method in class ApiPayIns

Create new PayPal Web pay-in object

ApiPayIns::CreateGooglePay() — Method in class ApiPayIns

Create new GooglePay Direct pay-in object

ApiPayOuts::Create() — Method in class ApiPayOuts

Create new pay-out

ApiPayOuts::CheckInstantPayoutEligibility() — Method in class ApiPayOuts

This method is used to check whether or not the destination bank is eligible for instant payout.

ApiReports::Create() — Method in class ApiReports

Creates new report request

ApiTransfers::Create() — Method in class ApiTransfers

Create new transfer

ApiTransfers::CreateRefund() — Method in class ApiTransfers

Create refund for transfer object

ApiUboDeclarations::Create() — Method in class ApiUboDeclarations

Creates a new UBO Declaration for an user.

ApiUboDeclarations::CreateUbo() — Method in class ApiUboDeclarations

Creates a new UBO for the specified arguments

ApiUsers::Create() — Method in class ApiUsers

Create a new user

ApiUsers::CreateBankAccount() — Method in class ApiUsers

Create bank account for user

ApiUsers::CreateKycDocument() — Method in class ApiUsers

Create new KYC document

ApiUsers::CreateKycPage() — Method in class ApiUsers

Create page for Kyc document

ApiUsers::CreateKycPageFromFile() — Method in class ApiUsers

Create page for Kyc document from file

ApiVirtualAccounts::Create() — Method in class ApiVirtualAccounts

Create new Virtual Account

ApiWallets::Create() — Method in class ApiWallets

Create new wallet

$ BankAccountDetailsOTHER#Country — Property in class BankAccountDetailsOTHER

The Country associate to the BankAccount, ISO 3166-1 alpha-2 format is expected

$ BankingAlias#CreditedUserId — Property in class BankingAlias

The User ID who was credited

$ BankingAliasIBAN#Country — Property in class BankingAliasIBAN

The country

$ BankingAliasOTHER#Country — Property in class BankingAliasOTHER

Country

$ Birthplace#City — Property in class Birthplace

$ Birthplace#Country — Property in class Birthplace

$ BrowserInfo#ColorDepth — Property in class BrowserInfo

CancelDeposit — Class in namespace MangoPay

Card — Class in namespace MangoPay

Card entity

$ Card#CardProvider — Property in class Card

CardProvider

$ Card#CardType — Property in class Card

Card type

$ Card#Country — Property in class Card

Country

$ Card#Currency — Property in class Card

Currency

$ Card#CardHolderName — Property in class Card

The cardholder’s name shown on the payment card.

CardInfo — Class in namespace MangoPay

CardPreAuthorization — Class in namespace MangoPay

Pre-authorization entity

$ CardPreAuthorization#CardId — Property in class CardPreAuthorization

The ID of the registered card (Got through CardRegistration object)

$ CardPreAuthorization#CardInfo — Property in class CardPreAuthorization

Information of the card

CardPreAuthorizationPaymentStatus — Class in namespace MangoPay

Pre-authorization payment statuses

CardPreAuthorizationStatus — Class in namespace MangoPay

Pre-authorization statuses

CardRegistration — Class in namespace MangoPay

CardRegistration entity

$ CardRegistration#CardType — Property in class CardRegistration

CardType

$ CardRegistration#CardRegistrationURL — Property in class CardRegistration

Card registration URL

$ CardRegistration#CardId — Property in class CardRegistration

Card Id

$ CardRegistration#Currency — Property in class CardRegistration

Currency

$ CardRegistration#CardHolderName — Property in class CardRegistration

The cardholder’s name shown on the payment card.

CardRegistrationStatus — Class in namespace MangoPay

Card registration statuses

CardValidation — Class in namespace MangoPay

$ CardValidation#CardInfo — Property in class CardValidation

Information of the card

CardValidationStatus — Class in namespace MangoPay

CardValidity — Class in namespace MangoPay

Check — Class in namespace MangoPay

$ Check#CheckId — Property in class Check

The unique identifier of the verification check.

$ Check#CheckStatus — Property in class Check

Returned values: VALIDATED, REFUSED, REVIEW

$ Check#CreationDate — Property in class Check

The date and time at which the check was created.

CheckData — Class in namespace MangoPay

Client — Class in namespace MangoPay

Client entity

$ Client#ClientId — Property in class Client

Client identifier

ClientLogoUpload — Class in namespace MangoPay

Client logo upload entity

CompanyNumber — Class in namespace MangoPay

$ CompanyNumber#CompanyNumber — Property in class CompanyNumber

Information about the registration number of a legal entity.

$ CompanyNumber#CountryCode — Property in class CompanyNumber

The country of the registration of the legal entity, against which the company number format is validated.

CompanyNumberDetails — Class in namespace MangoPay

$ CompanyNumberDetails#CompanyNumber — Property in class CompanyNumberDetails

Company number details

Conversion — Class in namespace MangoPay

$ Conversion#CreditedWalletId — Property in class Conversion

The unique identifier of the credited wallet

$ Conversion#CreditedFunds — Property in class Conversion

The buy funds

$ Conversion#ConversionRateResponse — Property in class Conversion

Real time indicative market rate of a specific currency pair

ConversionQuote — Class in namespace MangoPay

$ ConversionQuote#CreditedFunds — Property in class ConversionQuote

Credited funds

$ ConversionQuote#ConversionRateResponse — Property in class ConversionQuote

ConversionRate — Class in namespace MangoPay

Real time indicative market rate of a specific currency pair

$ ConversionRate#CreditedCurrency — Property in class ConversionRate

The buy currency – the currency of the wallet to be credited.

$ ConversionRate#ClientRate — Property in class ConversionRate

The market rate plus Mangopay's commission, charged during the platform's billing cycle. This is an indicative rate.

CountryAuthorization — Class in namespace MangoPay

Repudiation entity

$ CountryAuthorization#CountryCode — Property in class CountryAuthorization

The code of the country in the ISO 3166-1 alpha-2 format.

$ CountryAuthorization#CountryName — Property in class CountryAuthorization

Name of the country

CountryAuthorizationData — Class in namespace MangoPay

Repudiation entity

CreateCardPreAuthorizedDepositPayIn — Class in namespace MangoPay

$ CreateCardPreAuthorizedDepositPayIn#CreditedWalletId — Property in class CreateCardPreAuthorizedDepositPayIn

CreateClientWalletsInstantConversion — Class in namespace MangoPay

$ CreateClientWalletsInstantConversion#CreditedWalletType — Property in class CreateClientWalletsInstantConversion

Allowed values: FEES, CREDIT

$ CreateClientWalletsInstantConversion#CreditedFunds — Property in class CreateClientWalletsInstantConversion

The buy funds

CreateClientWalletsQuotedConversion — Class in namespace MangoPay

A conversion, at the rate guaranteed by its quote, of the debited funds to the credited wallet.

$ CreateClientWalletsQuotedConversion#CreditedWalletType — Property in class CreateClientWalletsQuotedConversion

Allowed values: FEES, CREDIT

CreateDeposit — Class in namespace MangoPay

$ CreateDeposit#CardId — Property in class CreateDeposit

$ CreateDeposit#Culture — Property in class CreateDeposit

CreateInstantConversion — Class in namespace MangoPay

$ CreateInstantConversion#CreditedWalletId — Property in class CreateInstantConversion

The unique identifier of the credited wallet

$ CreateInstantConversion#CreditedFunds — Property in class CreateInstantConversion

The buy funds

CreateQuotedConversion — Class in namespace MangoPay

A conversion, at the rate guaranteed by its quote, of the debited funds to the credited wallet.

$ CreateQuotedConversion#CreditedWalletId — Property in class CreateQuotedConversion

The unique identifier of the credited wallet

CurrencyIso — Class in namespace MangoPay

Currencies

$ DebitedBankAccount#Country — Property in class DebitedBankAccount

Country

$ Deposit#CardId — Property in class Deposit

$ Deposit#Culture — Property in class Deposit

$ Deposit#CardInfo — Property in class Deposit

Information of the card

$ Dispute#ContestDeadlineDate — Property in class Dispute

The date by which you must submit docs if they wish to contest the dispute

$ Dispute#ContestedFunds — Property in class Dispute

Contested funds

$ Dispute#ClosedDate — Property in class Dispute

The date and time the dispute was closed

$ EMoney#CreditedEMoney — Property in class EMoney

The amount of money that has been credited to this user

$ FallbackReason#Code — Property in class FallbackReason

$ IdentityVerificationCheck#CreationDate — Property in class IdentityVerificationCheck

The date and time at which the session was created.

$ IdentityVerificationCheck#Checks — Property in class IdentityVerificationCheck

The details of the individual verification checks performed during the session.

ApiBase::CreateObject() — Method in class ApiBase

Create object in API

ApiBase::CastResponseToError() — Method in class ApiBase

Cast response object to an error object

ApiBase::CastResponseToEntity() — Method in class ApiBase

Cast response object to entity object

ApiOAuth::CreateToken() — Method in class ApiOAuth

Get token information to OAuth Authentication

Configuration — Class in namespace MangoPay\Libraries

Configuration settings

$ Configuration#ClientId — Property in class Configuration

Client Id

$ Configuration#ClientPassword — Property in class Configuration

Client password

$ Configuration#CertificatesFilePath — Property in class Configuration

Absolute path to file holding one or more certificates to verify the peer with.

$ Configuration#CurlConnectionTimeout — Property in class Configuration

Set the cURL connection timeout limit (in seconds)

$ Configuration#CurlResponseTimeout — Property in class Configuration

Set the cURL response timeout limit (in seconds)

$ EntityBase#CreationDate — Property in class EntityBase

$ OAuthToken#create_time — Property in class OAuthToken

Created time

$ LineItem#Category — Property in class LineItem

$ Mandate#Culture — Property in class Mandate

The language to use for the confirmation web page presented to your user

$ MangoPayApi#Config — Property in class MangoPayApi

Configuration instance

$ MangoPayApi#Clients — Property in class MangoPayApi

Clients methods

$ MangoPayApi#CardRegistrations — Property in class MangoPayApi

Card registration methods

$ MangoPayApi#CardPreAuthorizations — Property in class MangoPayApi

Pre-authorization methods

$ MangoPayApi#Cards — Property in class MangoPayApi

Card methods

$ MangoPayApi#Conversions — Property in class MangoPayApi

Provides Instant conversion API methods

$ Money#Currency — Property in class Money

Text with currency code with ISO 4217 standard

$ PayIn#CreditedWalletId — Property in class PayIn

Credited wallet Id

$ PayInExecutionDetailsDirect#Culture — Property in class PayInExecutionDetailsDirect

The language to use for the payment page - needs to be the ISO code of the language

$ PayInExecutionDetailsDirect#CardId — Property in class PayInExecutionDetailsDirect

Card Id

$ PayInExecutionDetailsWeb#Culture — Property in class PayInExecutionDetailsWeb

$ PayInPaymentDetailsCard#CardType — Property in class PayInPaymentDetailsCard

CardType { CB_VISA_MASTERCARD, AMEX }

$ PayInPaymentDetailsCard#CardId — Property in class PayInPaymentDetailsCard

CardId

$ PayInPaymentDetailsCard#CardInfo — Property in class PayInPaymentDetailsCard

Information of the card

$ PayInPaymentDetailsDirectDebit#ChargeDate — Property in class PayInPaymentDetailsDirectDebit

ChargeDate

$ PayInPaymentDetailsKlarna#Country — Property in class PayInPaymentDetailsKlarna

The end-user residency country

$ PayInPaymentDetailsKlarna#Culture — Property in class PayInPaymentDetailsKlarna

The language in which the Klarna payment page is to be displayed - Alpha-2 format (default US)

$ PayInPaymentDetailsPayconiq#Country — Property in class PayInPaymentDetailsPayconiq

The country of your user (should be BE, NL or LU)

$ PayInPaymentDetailsPaypal#CancelURL — Property in class PayInPaymentDetailsPaypal

$ PayInPaymentDetailsSatispay#Country — Property in class PayInPaymentDetailsSatispay

The end-user country of residence

$ PayInRecurringRegistration#CardId — Property in class PayInRecurringRegistration

$ PayInRecurringRegistration#CreditedUserId — Property in class PayInRecurringRegistration

$ PayInRecurringRegistration#CreditedWalletId — Property in class PayInRecurringRegistration

$ PayInRecurringRegistrationGet#CurrentState — Property in class PayInRecurringRegistrationGet

$ PayInRecurringRegistrationRequestResponse#CycleNumber — Property in class PayInRecurringRegistrationRequestResponse

$ PayInRecurringRegistrationUpdate#CardId — Property in class PayInRecurringRegistrationUpdate

$ PayInWebExtendedView#CardType — Property in class PayInWebExtendedView

The card type

$ PayInWebExtendedView#Country — Property in class PayInWebExtendedView

Country of the address

$ PayPalWebTracking#Carrier — Property in class PayPalWebTracking

Quantity of item bought

$ RateLimit#CallsMade — Property in class RateLimit

$ RateLimit#CallsRemaining — Property in class RateLimit

$ RecurringPayInCurrentState#CumulatedDebitedAmount — Property in class RecurringPayInCurrentState

$ RecurringPayInCurrentState#CumulatedFeesAmount — Property in class RecurringPayInCurrentState

$ Refund#CreditedWalletId — Property in class Refund

Credited wallet Id

$ ReportRequest#CallbackURL — Property in class ReportRequest

Callback URL.

$ ReportRequest#Columns — Property in class ReportRequest

Allowed values: "Alias", "BankAccountId", "BankWireRef", "CardId", "CardType", "Country", "Culture", "Currency", "DeclaredDebitedFundsAmount", "DeclaredDebitedFundsCurrency", "DeclaredFeesAmount", "DeclaredFeesCurrency", "ExecutionType", "ExpirationDate", "PaymentType", "PreauthorizationId", "WireReference".

$ Repudiation#CreditedFunds — Property in class Repudiation

The amount of credited funds – since there are currently no fees, this will be equal to the DebitedFunds

$ Response#ContentLength — Property in class Response

Content length

$ Response#ContentType — Property in class Response

Content type

$ Transaction#CreditedUserId — Property in class Transaction

Credited user Id

$ Transaction#CreditedFunds — Property in class Transaction

Credited funds

$ Transaction#CreditedWalletId — Property in class Transaction

Credited wallet Id

$ Transfer#CreditedWalletId — Property in class Transfer

Credited wallet Id

$ UserLegal#CompanyNumber — Property in class UserLegal

$ UserNatural#CountryOfResidence — Property in class UserNatural

Country of residence

$ UserNatural#Capacity — Property in class UserNatural

Capacity of the user within MangoPay Takes values from \MangoPay\NaturalUserCapacity

$ VirtualAccount#CreditedUserId — Property in class VirtualAccount

The credited user ID

$ VirtualAccount#Country — Property in class VirtualAccount

The country of the IBAN. The country must correspond to the currency of the wallet ISO 3166-1 alpha-2 format is expected

$ VirtualAccount#Capabilities — Property in class VirtualAccount

The current Status of the Virtual Account

$ VirtualAccountAddress#CountrySubDivision — Property in class VirtualAccountAddress

$ VirtualAccountAddress#Country — Property in class VirtualAccountAddress

$ VirtualAccountAvailabilities#Collection — Property in class VirtualAccountAvailabilities

• @var VirtualAccountAvailability[]

$ VirtualAccountAvailability#Country — Property in class VirtualAccountAvailability

ISO 3166-1 alpha-2 format is expected

• @var string

$ VirtualAccountAvailability#Currencies — Property in class VirtualAccountAvailability

List of currencies supported by the account

$ VirtualAccountCapabilities#Currencies — Property in class VirtualAccountCapabilities

List of currencies supported by the account

$ Wallet#Currency — Property in class Wallet

Currency code in ISO

D

ApiVirtualAccounts::Deactivate() — Method in class ApiVirtualAccounts

$ BankAccount#Details — Property in class BankAccount

One of BankAccountDetails implementations, depending on $Type

$ BankAccountDetailsUS#DepositAccountType — Property in class BankAccountDetailsUS

DepositAccountType { CHECKING, SAVINGS }

$ CardPreAuthorization#DebitedFunds — Property in class CardPreAuthorization

It represents the amount debited on the bank account of the Author.DebitedFunds = Fees + CreditedFunds (amount received on wallet)

$ Check#Data — Property in class Check

The data points collected and verified during the check.

$ Conversion#DebitedWalletId — Property in class Conversion

The unique identifier of the debited wallet.

$ Conversion#DebitedFunds — Property in class Conversion

The sell funds

$ ConversionQuote#Duration — Property in class ConversionQuote

The time in seconds during which the quote is active and can be used for conversions.

$ ConversionQuote#DebitedFunds — Property in class ConversionQuote

Debited funds

$ ConversionRate#DebitedCurrency — Property in class ConversionRate

The sell currency – the currency of the wallet to be debited.

$ CreateCardPreAuthorizedDepositPayIn#DebitedFunds — Property in class CreateCardPreAuthorizedDepositPayIn

$ CreateCardPreAuthorizedDepositPayIn#DepositId — Property in class CreateCardPreAuthorizedDepositPayIn

$ CreateClientWalletsInstantConversion#DebitedWalletType — Property in class CreateClientWalletsInstantConversion

Allowed values: FEES, CREDIT

$ CreateClientWalletsInstantConversion#DebitedFunds — Property in class CreateClientWalletsInstantConversion

The sell funds

$ CreateClientWalletsQuotedConversion#DebitedWalletType — Property in class CreateClientWalletsQuotedConversion

Allowed values: FEES, CREDIT

$ CreateDeposit#DebitedFunds — Property in class CreateDeposit

$ CreateInstantConversion#DebitedWalletId — Property in class CreateInstantConversion

The unique identifier of the debited wallet

$ CreateInstantConversion#DebitedFunds — Property in class CreateInstantConversion

The sell funds

$ CreateQuotedConversion#DebitedWalletId — Property in class CreateQuotedConversion

The unique identifier of the debited wallet.

DebitedBankAccount — Class in namespace MangoPay

Debited bank account object.

DeclaredUbo — Class in namespace MangoPay

Represents validation status of a user declared as UBO.

DeclaredUboStatus — Class in namespace MangoPay

Holds enumeration of possible statuses of a declared UBO.

Deposit — Class in namespace MangoPay

$ Deposit#DebitedFunds — Property in class Deposit

DepositStatus — Class in namespace MangoPay

Dispute — Class in namespace MangoPay

Dispute entity

$ Dispute#DisputeType — Property in class Dispute

The type of dispute

$ Dispute#DisputeReason — Property in class Dispute

Dispute's reason

$ Dispute#DisputedFunds — Property in class Dispute

Disputed funds

DisputeDocument — Class in namespace MangoPay

Dispute document entity

$ DisputeDocument#DisputeId — Property in class DisputeDocument

The Dispute that this document belongs to

DisputeDocumentPage — Class in namespace MangoPay

Dispute document page entity for dispute document

DisputeDocumentStatus — Class in namespace MangoPay

Dispute document statuses

DisputeDocumentType — Class in namespace MangoPay

Dispute document types

DisputeReason — Class in namespace MangoPay

Class represents dispute's reason

$ DisputeReason#DisputeReasonType — Property in class DisputeReason

Dispute's reason type

$ DisputeReason#DisputeReasonMessage — Property in class DisputeReason

Dispute's reason message

DisputeReasonType — Class in namespace MangoPay

Dispute reason types

DisputeStatus — Class in namespace MangoPay

Dispute statuses

DisputeType — Class in namespace MangoPay

Dispute types

DocumentPageConsult — Class in namespace MangoPay

Holds document page viewing data.

$ EMoney#DebitedEMoney — Property in class EMoney

The amount of money that has been debited from the user

$ Event#Date — Property in class Event

Date of event

$ FilterDisputes#DisputeType — Property in class FilterDisputes

$ Configuration#DebugMode — Property in class Configuration

[INTERNAL USAGE ONLY] Switch debug mode: log all request and response data

DefaultStorageStrategy — Class in namespace MangoPay\Libraries

Default storage strategy implementation.

Document — Class in namespace MangoPay\Libraries

Abstract class for all documents

Dto — Class in namespace MangoPay\Libraries

Abstract class for all DTOs (entities and their composites)

$ Error#Date — Property in class Error

The timestamp of this API response

Logs::Debug() — Method in class Logs

$ LineItem#Description — Property in class LineItem

A consistent and unique reference for the seller. It can be:

• The user ID created on MANGOPAY for the seller
• Or the firstname and lastname of the seller

$ Mandate#DocumentURL — Property in class Mandate

The URL to view/download the mandate document

$ MangoPayApi#Disputes — Property in class MangoPayApi

Provides disputes methods

$ MangoPayApi#DisputeDocuments — Property in class MangoPayApi

Provides dispute documents methods

$ MangoPayApi#Deposits — Property in class MangoPayApi

Provides Deposit methods

$ PayInExecutionDetailsExternalInstruction#DebitedBankAccount — Property in class PayInExecutionDetailsExternalInstruction

Information about the account that was debited.

$ PayInPaymentDetailsBancontact#DeepLinkURL — Property in class PayInPaymentDetailsBancontact

The URL where you should redirect your client in a mobile app experience

$ PayInPaymentDetailsBankWire#DeclaredDebitedFunds — Property in class PayInPaymentDetailsBankWire

Declared debited funds

$ PayInPaymentDetailsBankWire#DeclaredFees — Property in class PayInPaymentDetailsBankWire

Declared fees

$ PayInPaymentDetailsDirectDebit#DirectDebitType — Property in class PayInPaymentDetailsDirectDebit

Direct debit type {SOFORT, ELV, GIROPAY}

$ PayInPaymentDetailsPayconiq#DebitedWalletId — Property in class PayInPaymentDetailsPayconiq

$ PayInPaymentDetailsPayconiq#DeepLinkURL — Property in class PayInPaymentDetailsPayconiq

$ PayInPaymentDetailsSwish#DeepLinkURL — Property in class PayInPaymentDetailsSwish

The mobile URL to which to redirect the user to complete the payment in an app-to-app flow.

$ PayOut#DebitedWalletId — Property in class PayOut

Debited wallet Id

$ PayOutEligibilityRequest#DebitedFunds — Property in class PayOutEligibilityRequest

Information about the funds that are being debited

$ PayOutEligibilityRequest#DebitedWalletId — Property in class PayOutEligibilityRequest

The ID of the wallet that was debited

$ RecurringPayInCIT#DebitedFunds — Property in class RecurringPayInCIT

$ RecurringPayInMIT#DebitedFunds — Property in class RecurringPayInMIT

$ Refund#DebitedWalletId — Property in class Refund

Debited wallet Id

$ ReportRequest#DownloadFormat — Property in class ReportRequest

Download file format.

$ ReportRequest#DownloadURL — Property in class ReportRequest

Download URL.

$ Repudiation#DebitedFunds — Property in class Repudiation

The funds repudiated from the wallet

$ Repudiation#DebitedWalletId — Property in class Repudiation

The wallet from where the repudiation was taken

$ Repudiation#DisputeId — Property in class Repudiation

The Id of the dispute to which this repudation corresponds.

$ Response#Date — Property in class Response

Date

$ SettlementTransfer#DebitedFunds — Property in class SettlementTransfer

The funds debited from the debited wallet

$ Transaction#DebitedFunds — Property in class Transaction

Debited funds

$ Transaction#DebitedWalletId — Property in class Transaction

Debited wallet Id

$ Transfer#DebitedWalletId — Property in class Transfer

Debited wallet Id

$ Wallet#Description — Property in class Wallet

Wallet description

E

$ Card#ExpirationDate — Property in class Card

Expiration date

$ CardPreAuthorization#ExecutionType — Property in class CardPreAuthorization

How the PreAuthorization has been executed.

$ CardPreAuthorization#ExpirationDate — Property in class CardPreAuthorization

The date when the payment is processed

$ Conversion#ExecutionDate — Property in class Conversion

The date and time at which the status changed to SUCCEEDED, indicating that the transaction occurred.

$ ConversionQuote#ExpirationDate — Property in class ConversionQuote

Expiration date

$ Deposit#ExpirationDate — Property in class Deposit

$ Deposit#ExecutionType — Property in class Deposit

$ DocumentPageConsult#ExpirationDate — Property in class DocumentPageConsult

Time in millis when the page consult will expire.

EMoney — Class in namespace MangoPay

User entity

Event — Class in namespace MangoPay

Event entity

$ Event#EventType — Property in class Event

Event type

EventType — Class in namespace MangoPay

Event types

$ FilterEvents#EventType — Property in class FilterEvents

Event type

$ Hook#EventType — Property in class Hook

ApiBase::ExecutePostRequest() — Method in class ApiBase

Executes a POST request

EntityBase — Class in namespace MangoPay\Libraries

Abstract class with common properties

Error — Class in namespace MangoPay\Libraries

Class represents error object

$ Error#Errors — Property in class Error

Array with errors information

Exception — Class in namespace MangoPay\Libraries

$ OAuthToken#expires_in — Property in class OAuthToken

Expires time for the token

$ Mandate#ExecutionType — Property in class Mandate

How the mandate has been created: WEB

$ MangoPayApi#Events — Property in class MangoPayApi

Events methods

$ PayIn#ExecutionType — Property in class PayIn

ExecutionType { WEB, TOKEN, DIRECT, PREAUTHORIZED, RECURRING_ORDER_EXECUTION }

$ PayIn#ExecutionDetails — Property in class PayIn

One of PayInExecutionDetails implementations, depending on $ExecutionType

$ PayInPaymentDetailsKlarna#Email — Property in class PayInPaymentDetailsKlarna

The end-user email address

$ PayInPaymentDetailsPayconiq#ExpirationDate — Property in class PayInPaymentDetailsPayconiq

$ PayInRecurringRegistration#EndDate — Property in class PayInRecurringRegistration

$ PayInWebExtendedView#ExecutionType — Property in class PayInWebExtendedView

ExecutionType { WEB, TOKEN, DIRECT, PREAUTHORIZED, RECURRING_ORDER_EXECUTION }

$ PayInWebExtendedView#ExpirationDate — Property in class PayInWebExtendedView

The expiry date of the credit card (MMYY)

$ Repudiation#ExecutionDate — Property in class Repudiation

The execution date of the repudiation

$ Transaction#ExecutionDate — Property in class Transaction

Execution date

$ User#Email — Property in class User

Email address

F

$ Billing#FirstName — Property in class Billing

The First Name for Billing Address

$ Card#Fingerprint — Property in class Card

Card's fingerprint hash, unique per 16-digit card number

$ Client#FraudEmails — Property in class Client

A list of email addresses to use when contacting you for fraud/compliance issues/communications

$ Conversion#Fees — Property in class Conversion

Information about the fees taken by the platform for this transaction (and hence transferred to the Fees Wallet).

$ CreateCardPreAuthorizedDepositPayIn#Fees — Property in class CreateCardPreAuthorizedDepositPayIn

$ CreateInstantConversion#Fees — Property in class CreateInstantConversion

Information about the fees taken by the platform for this transaction (and hence transferred to the Fees Wallet).

FallbackReason — Class in namespace MangoPay

FilterBankAccounts — Class in namespace MangoPay

Filtering object for Bank Accounts

FilterBase — Class in namespace MangoPay

Base filter object

FilterCards — Class in namespace MangoPay

Filtering object for Cards

FilterDisputeDocuments — Class in namespace MangoPay

Filter for event list

FilterDisputes — Class in namespace MangoPay

Filter for dispute list

FilterEvents — Class in namespace MangoPay

Filter for event list

FilterKycDocuments — Class in namespace MangoPay

Filter for dispute document list

FilterPreAuthorizations — Class in namespace MangoPay

Filtering object for PreAuthorization lists

FilterRefunds — Class in namespace MangoPay

Filtering object for Refunds

FilterReports — Class in namespace MangoPay

Filter for transaction list

FilterTransactions — Class in namespace MangoPay

Filter for transaction list

FundsType — Class in namespace MangoPay

Funds types

$ KycDocument#Flags — Property in class KycDocument

More information regarding why the document has been rejected.

$ Upload#File — Property in class Upload

Image base64

$ PayInRecurringRegistration#FirstTransactionDebitedFunds — Property in class PayInRecurringRegistration

$ PayInRecurringRegistration#FirstTransactionFees — Property in class PayInRecurringRegistration

$ PayInRecurringRegistration#Frequency — Property in class PayInRecurringRegistration

$ PayInRecurringRegistration#FixedNextAmount — Property in class PayInRecurringRegistration

$ PayInRecurringRegistration#FractionedPayment — Property in class PayInRecurringRegistration

$ PayInRecurringRegistration#FreeCycles — Property in class PayInRecurringRegistration

$ PayInRecurringRegistrationRequestResponse#FreeCycles — Property in class PayInRecurringRegistrationRequestResponse

$ PayInWebExtendedView#Fingerprint — Property in class PayInWebExtendedView

Card's fingerprint hash, unique per 16-digit card number

$ PayOutEligibilityRequest#Fees — Property in class PayOutEligibilityRequest

Information about the fees that were taken by the client for this transaction (and were hence transferred to the Client's platform wallet)

$ PayOutPaymentDetailsBankWire#FallbackReason — Property in class PayOutPaymentDetailsBankWire

The fallback reason.

$ RecurringPayInCIT#Fees — Property in class RecurringPayInCIT

$ RecurringPayInMIT#Fees — Property in class RecurringPayInMIT

$ ReportRequest#Filters — Property in class ReportRequest

Filters for the report list.

$ Repudiation#Fees — Property in class Repudiation

The fees taken on the repudiation – will always be 0 at this stage

$ SettlementTransfer#Fees — Property in class SettlementTransfer

The amount you wish to charge for this settlement.

$ Shipping#FirstName — Property in class Shipping

The First Name for Billing Address

$ Transaction#Fees — Property in class Transaction

Fees

$ Ubo#FirstName — Property in class Ubo

$ UserNatural#FirstName — Property in class UserNatural

First name for user

G

ApiBankAccounts::GetTransactions() — Method in class ApiBankAccounts

Retrieves a list of Transactions pertaining to a certain Bank Account

ApiBankingAliases::Get() — Method in class ApiBankingAliases

Get a banking alias

ApiBankingAliases::GetAll() — Method in class ApiBankingAliases

Get all banking aliases

ApiCardPreAuthorizations::Get() — Method in class ApiCardPreAuthorizations

Get pre-authorization object

ApiCardPreAuthorizations::GetTransactions() — Method in class ApiCardPreAuthorizations

ApiCardRegistrations::Get() — Method in class ApiCardRegistrations

Get card registration

ApiCards::Get() — Method in class ApiCards

Get card

ApiCards::GetByFingerprint() — Method in class ApiCards

Gets a list of cards having the same fingerprint.

ApiCards::GetPreAuthorizations() — Method in class ApiCards

Gets a Card's PreAuthorizations

ApiCards::GetTransactions() — Method in class ApiCards

Retrieves a list of Transactions pertaining to a certain Card

ApiCards::GetCardValidation() — Method in class ApiCards

Get card validation

ApiClients::Get() — Method in class ApiClients

Get client information

ApiClients::GetWallets() — Method in class ApiClients

View your client wallets. To see your fees or credit wallets for each currency set second $fundsType parameter.

ApiClients::GetWallet() — Method in class ApiClients

View one of your client wallets (fees or credit) with a particular currency.

ApiClients::GetWalletTransactions() — Method in class ApiClients

View the transactions linked to your client wallets (fees and credit)

ApiConversions::GetConversionRate() — Method in class ApiConversions

This endpoint allows the platform to get a real time indicative market rate of a specific currency pair.

ApiConversions::GetConversion() — Method in class ApiConversions

This endpoint allows the platform to get the details of a conversion which has been carried out.

ApiConversions::GetConversionQuote() — Method in class ApiConversions

This endpoint allows the platform to get the details of a quote

ApiDeposits::Get() — Method in class ApiDeposits

Get Deposit

ApiDisputeDocuments::Get() — Method in class ApiDisputeDocuments

Gets dispute's document

ApiDisputeDocuments::GetAll() — Method in class ApiDisputeDocuments

Gets dispute's documents for client

ApiDisputes::Get() — Method in class ApiDisputes

Gets dispute

ApiDisputes::GetAll() — Method in class ApiDisputes

Get all disputes

ApiDisputes::GetPendingSettlements() — Method in class ApiDisputes

List Disputes that need settling

ApiDisputes::GetTransactions() — Method in class ApiDisputes

Gets dispute's transactions

ApiDisputes::GetDisputesForWallet() — Method in class ApiDisputes

Gets dispute's documents for wallet

ApiDisputes::GetDisputesForUser() — Method in class ApiDisputes

Gets user's disputes

ApiDisputes::GetRepudiation() — Method in class ApiDisputes

Gets repudiation

ApiDisputes::GetSettlementTransfer() — Method in class ApiDisputes

Gets settlement transfer

ApiDisputes::GetDocumentsForDispute() — Method in class ApiDisputes

Gets documents for dispute

ApiEvents::GetAll() — Method in class ApiEvents

Get events

ApiHooks::Get() — Method in class ApiHooks

Get hook

ApiHooks::GetAll() — Method in class ApiHooks

Get all hooks

ApiIdentityVerification::Get() — Method in class ApiIdentityVerification

Get IdentityVerification

ApiIdentityVerification::GetChecks() — Method in class ApiIdentityVerification

Get IdentityVerificationCheck

ApiKycDocuments::GetAll() — Method in class ApiKycDocuments

Get all KYC documents

ApiKycDocuments::Get() — Method in class ApiKycDocuments

Get KYC document

ApiMandates::Get() — Method in class ApiMandates

Get mandate

ApiMandates::GetAll() — Method in class ApiMandates

Get all mandates

ApiMandates::GetTransactions() — Method in class ApiMandates

Retrieves list of Transactions pertaining to a certain Mandate

ApiPayIns::Get() — Method in class ApiPayIns

Get pay-in object

ApiPayIns::GetRecurringRegistration() — Method in class ApiPayIns

Get recurring payment

ApiPayIns::GetRefunds() — Method in class ApiPayIns

Retrieves a list of Refunds pertaining to a certain PayIn

ApiPayIns::GetExtendedCardView() — Method in class ApiPayIns

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

ApiPayIns::GetPaymentMethodMetadata() — Method in class ApiPayIns

Look up metadata from BIN or Google Pay token

ApiPayOuts::Get() — Method in class ApiPayOuts

Get pay-out object

ApiPayOuts::GetBankwire() — Method in class ApiPayOuts

Get bankwire pay-out object

ApiPayOuts::GetRefunds() — Method in class ApiPayOuts

Returns a list of Refunds pertaining to a certain PayOut.

ApiRefunds::Get() — Method in class ApiRefunds

Get refund object

ApiRegulatory::GetCountryAuthorizations() — Method in class ApiRegulatory

Get country authorizations by country code

ApiRegulatory::GetAllCountryAuthorizations() — Method in class ApiRegulatory

Get all countries authorizations

ApiReports::Get() — Method in class ApiReports

Gets report request.

ApiReports::GetAll() — Method in class ApiReports

Gets all report requests.

ApiRepudiations::Get() — Method in class ApiRepudiations

ApiRepudiations::GetRefunds() — Method in class ApiRepudiations

Retrieves a list of Refunds pertaining to a certain Repudiation

ApiResponses::Get() — Method in class ApiResponses

Get response from previous call by idempotency key

ApiTransfers::Get() — Method in class ApiTransfers

Get transfer

ApiTransfers::GetRefunds() — Method in class ApiTransfers

Retrieve list of Refunds pertaining to a certain Transfer

ApiUboDeclarations::GetAll() — Method in class ApiUboDeclarations

ApiUboDeclarations::Get() — Method in class ApiUboDeclarations

Gets an UBO Declaration.

ApiUboDeclarations::GetById() — Method in class ApiUboDeclarations

Gets an UBO Declaration directly by Id.

ApiUboDeclarations::GetUbo() — Method in class ApiUboDeclarations

Gets an UBO

ApiUboDeclarations::GetUboDeclarationById() — Method in class ApiUboDeclarations

Gets an UBO Declaration.

ApiUsers::GetAll() — Method in class ApiUsers

Get all users

ApiUsers::Get() — Method in class ApiUsers

Get natural or legal user by ID

ApiUsers::GetNatural() — Method in class ApiUsers

Get natural user by ID

ApiUsers::GetLegal() — Method in class ApiUsers

Get legal user by ID

ApiUsers::GetBankAccounts() — Method in class ApiUsers

Get all bank accounts for user

ApiUsers::GetBankAccount() — Method in class ApiUsers

Get bank account for user

ApiUsers::GetWallets() — Method in class ApiUsers

Get all wallets for user

ApiUsers::GetTransactions() — Method in class ApiUsers

Get all transactions for user

ApiUsers::GetCards() — Method in class ApiUsers

Get all cards for user

ApiUsers::GetKycDocuments() — Method in class ApiUsers

Get all KYC documents for user

ApiUsers::GetKycDocument() — Method in class ApiUsers

Get KYC document

ApiUsers::GetMandates() — Method in class ApiUsers

Get all mandates for user

ApiUsers::GetMandatesForBankAccount() — Method in class ApiUsers

Get mandates for user and bank account

ApiUsers::GetEMoney() — Method in class ApiUsers

Get user EMoney

ApiUsers::GetPreAuthorizations() — Method in class ApiUsers

Gets a list with PreAuthorizations belonging to a specific user

ApiUsers::GetBlockStatus() — Method in class ApiUsers

Get the Block Status of a User

ApiUsers::GetRegulatory() — Method in class ApiUsers

Get the Block Status Regulatory of a User

ApiVirtualAccounts::Get() — Method in class ApiVirtualAccounts

ApiVirtualAccounts::GetAll() — Method in class ApiVirtualAccounts

ApiVirtualAccounts::GetAvailabilities() — Method in class ApiVirtualAccounts

ApiWallets::Get() — Method in class ApiWallets

Get wallet

ApiWallets::GetTransactions() — Method in class ApiWallets

Get transactions for the wallet

BankAccount::GetSubObjects() — Method in class BankAccount

Get array with mapping which property is object and what type of object

BankAccount::GetDependsObjects() — Method in class BankAccount

Get array with mapping which property depends on other property

BankAccount::GetReadOnlyProperties() — Method in class BankAccount

Get array with read-only properties

Billing::GetSubObjects() — Method in class Billing

Get array with mapping which property is object and what type of object

CancelDeposit::GetSubObjects() — Method in class CancelDeposit

Get array with mapping which property is object and what type of object

CardPreAuthorization::GetSubObjects() — Method in class CardPreAuthorization

Get array with mapping which property is object and what type of object

CardPreAuthorization::GetReadOnlyProperties() — Method in class CardPreAuthorization

Get array with read-only properties

CardRegistration::GetReadOnlyProperties() — Method in class CardRegistration

Get array with read-only properties

CardValidation::GetSubObjects() — Method in class CardValidation

Get array with mapping which property is object and what type of object.

Client::GetSubObjects() — Method in class Client

Get array with mapping which property is object and what type of object

Client::GetReadOnlyProperties() — Method in class Client

Get array with read-only properties

CountryAuthorization::GetSubObjects() — Method in class CountryAuthorization

Get array with mapping which property is object and what type of object

CreateCardPreAuthorizedDepositPayIn::GetSubObjects() — Method in class CreateCardPreAuthorizedDepositPayIn

Get array with mapping which property is object and what type of object

CreateDeposit::GetSubObjects() — Method in class CreateDeposit

Get array with mapping which property is object and what type of object

Deposit::GetSubObjects() — Method in class Deposit

Get array with mapping which property is object and what type of object

Dispute::GetSubObjects() — Method in class Dispute

Get array with mapping which property is object and what type of object

Dispute::GetReadOnlyProperties() — Method in class Dispute

Get array with read-only properties

EMoney::GetSubObjects() — Method in class EMoney

Get array with mapping which property is object and what type of object

ApiBase::getLogger() — Method in class ApiBase

ApiBase::GetRequestUrl() — Method in class ApiBase

Get URL for REST Mango Pay API

ApiBase::GetRequestType() — Method in class ApiBase

Get request type for REST Mango Pay API

ApiBase::GetObject() — Method in class ApiBase

Get entity object from API

ApiBase::GetList() — Method in class ApiBase

Get lst with entities object from API

ApiBase::GetObjectForIdempotencyUrl() — Method in class ApiBase

AuthenticationHelper::GetHttpHeaderKey() — Method in class AuthenticationHelper

Get HTTP header value with authorization string

AuthenticationHelper::GetHttpHeaderBasicKey() — Method in class AuthenticationHelper

Get basic key for HTTP header

AuthenticationHelper::GetAutenticationKey() — Method in class AuthenticationHelper

AuthorizationTokenManager::GetToken() — Method in class AuthorizationTokenManager

Gets the current authorization token.

DefaultStorageStrategy::Get() — Method in class DefaultStorageStrategy

Gets the current authorization token.

Document::GetReadOnlyProperties() — Method in class Document

Get array with read-only properties

Dto::GetSubObjects() — Method in class Dto

Get array with mapping which property is object and what type of object.

Dto::GetDependsObjects() — Method in class Dto

Get array with mapping which property depends on other property To be overridden in child class if has any dependent objects.

Dto::GetReadOnlyProperties() — Method in class Dto

Get array with read only properties - not used in response To be overridden in child class if has any read-only properties.

EntityBase::GetReadOnlyProperties() — Method in class EntityBase

Get array with read-only properties

IStorageStrategy::Get() — Method in class IStorageStrategy

Gets the current authorization token.

OAuthToken::GetAutenticationKey() — Method in class OAuthToken

ResponseException::GetErrorDetails() — Method in class ResponseException

Get Error object returned by REST API

ResponseException::GetErrorCode() — Method in class ResponseException

Get Error code returned by REST API

RestTool::GetRequestHeaders() — Method in class RestTool

Return HTTP header to send with request

RestTool::GetRequestType() — Method in class RestTool

Return HTTP request method

RestTool::GetRequestData() — Method in class RestTool

Return HTTP request data

RestTool::GetRequestUrl() — Method in class RestTool

Return HTTP request url

UrlTool::GetRestUrl() — Method in class UrlTool

UrlTool::GetFullUrl() — Method in class UrlTool

MangoPayApi::getLogger() — Method in class MangoPayApi

MangoPayApi::getConfig() — Method in class MangoPayApi

MangoPayApi::getHttpClient() — Method in class MangoPayApi

PayIn::GetDependsObjects() — Method in class PayIn

Get array with mapping which property depends on other property

PayIn::GetReadOnlyProperties() — Method in class PayIn

Get array with read-only properties

PayInExecutionDetailsDirect::GetSubObjects() — Method in class PayInExecutionDetailsDirect

Get array with mapping which property is object and what type of object.

PayInExecutionDetailsWeb::GetReadOnlyProperties() — Method in class PayInExecutionDetailsWeb

Get array with read-only properties

PayInExecutionDetailsWeb::GetSubObjects() — Method in class PayInExecutionDetailsWeb

Get array with mapping which property is object and what type of object

PayInPaymentDetailsApplePay::GetSubObjects() — Method in class PayInPaymentDetailsApplePay

Get array with mapping which property is object and what type of object.

PayInPaymentDetailsBankWire::GetSubObjects() — Method in class PayInPaymentDetailsBankWire

Get array with mapping which property is object and what type of object

PayInPaymentDetailsGooglePay::GetSubObjects() — Method in class PayInPaymentDetailsGooglePay

Get array with mapping which property is object and what type of object.

PayInPaymentDetailsKlarna::GetSubObjects() — Method in class PayInPaymentDetailsKlarna

Get array with mapping which property is object and what type of object.

PayInPaymentDetailsPaypal::GetSubObjects() — Method in class PayInPaymentDetailsPaypal

Get array with mapping which property is object and what type of object.

PayInRecurringRegistration::GetReadOnlyProperties() — Method in class PayInRecurringRegistration

Get array with read-only properties

PayOut::GetDependsObjects() — Method in class PayOut

Get array with mapping which property depends on other property

PayOut::GetReadOnlyProperties() — Method in class PayOut

Get array with read-only properties

Refund::GetSubObjects() — Method in class Refund

Get array with mapping which property is object and what type of object

ReportRequest::GetReadOnlyProperties() — Method in class ReportRequest

Get array with read-only properties

Repudiation::GetSubObjects() — Method in class Repudiation

Get array with mapping which property is object and what type of object

SettlementTransfer::GetSubObjects() — Method in class SettlementTransfer

Get array with mapping which property is object and what type of object

Shipping::GetSubObjects() — Method in class Shipping

Get array with mapping which property is object and what type of object

ShippingAddress::GetSubObjects() — Method in class ShippingAddress

Get array with mapping which property is object and what type of object.

Sorting::GetSortParameter() — Method in class Sorting

Get sort parametrs to URL

Transaction::GetSubObjects() — Method in class Transaction

Get array with mapping which property is object and what type of object

Transaction::GetReadOnlyProperties() — Method in class Transaction

Get array with read-only properties

Ubo::GetSubObjects() — Method in class Ubo

Get array with mapping which property is object and what type of object

UboDeclaration::GetReadOnlyProperties() — Method in class UboDeclaration

Get array with read-only properties

UboDeclaration::GetSubObjects() — Method in class UboDeclaration

Get array with mapping which property is object and what type of object.

User::GetReadOnlyProperties() — Method in class User

Get array with read-only properties

UserBlockStatus::GetSubObjects() — Method in class UserBlockStatus

Get array with mapping which property is object and what type of object

UserLegal::GetSubObjects() — Method in class UserLegal

Get array with mapping which property is object and what type of object

UserLegal::GetReadOnlyProperties() — Method in class UserLegal

Get array with read-only properties

UserNatural::GetSubObjects() — Method in class UserNatural

Get array with mapping which property is object and what type of object

UserNatural::GetReadOnlyProperties() — Method in class UserNatural

Get array with read-only properties

Wallet::GetSubObjects() — Method in class Wallet

Get array with mapping which property is object and what type of object

Wallet::GetReadOnlyProperties() — Method in class Wallet

Get array with read-only properties

H

$ Client#HeadquartersAddress — Property in class Client

The address of the company’s headquarters

$ Client#HeadquartersPhoneNumber — Property in class Client

The user's headquarter's phone number

Hook — Class in namespace MangoPay

Hooks and Notifications entity

HookStatus — Class in namespace MangoPay

HookValidity — Class in namespace MangoPay

$ IdentityVerification#HostedUrl — Property in class IdentityVerification

The URL to redirect the user to for the hosted identity verification session.

$ Configuration#HostProxy — Property in class Configuration

Set the proxy host

HttpBase — Class in namespace MangoPay\Libraries

Base class for Http Client

HttpCurl — Class in namespace MangoPay\Libraries

Curl Http Client

HttpResponse — Class in namespace MangoPay\Libraries

Base class for Http Client

$ HttpResponse#Headers — Property in class HttpResponse

$ MangoPayApi#Hooks — Property in class MangoPayApi

Hooks methods

$ MangoPayApi#httpClient — Property in class MangoPayApi

$ UserLegal#HeadquartersAddress — Property in class UserLegal

I

$ BankAccountDetailsCA#InstitutionNumber — Property in class BankAccountDetailsCA

Institution number

$ BankAccountDetailsIBAN#IBAN — Property in class BankAccountDetailsIBAN

IBAN number

$ BankingAliasIBAN#IBAN — Property in class BankingAliasIBAN

The IBAN of the banking alias

$ CardInfo#IssuingBank — Property in class CardInfo

The name of the card issuer.

$ CardInfo#IssuerCountryCode — Property in class CardInfo

The country where the card was issued.

$ CardPreAuthorization#IpAddress — Property in class CardPreAuthorization

IpAddress

$ CardValidation#IpAddress — Property in class CardValidation

Ip Address

$ CompanyNumber#IsValid — Property in class CompanyNumber

$ CreateDeposit#IpAddress — Property in class CreateDeposit

$ DebitedBankAccount#IBAN — Property in class DebitedBankAccount

IBAN

$ Deposit#IpAddress — Property in class Deposit

$ Dispute#InitialTransactionId — Property in class Dispute

Identifier of the transaction that was disputed

$ Dispute#InitialTransactionType — Property in class Dispute

The type of transaction that is disputed

IdentityVerification — Class in namespace MangoPay

IdentityVerificationCheck — Class in namespace MangoPay

InstantPayout — Class in namespace MangoPay

$ InstantPayout#IsReachable — Property in class InstantPayout

InternationalAccount — Class in namespace MangoPay

$ InternationalAccount#Iban — Property in class InternationalAccount

InternationalAccountDetails — Class in namespace MangoPay

$ EntityBase#Id — Property in class EntityBase

$ Error#Id — Property in class Error

An identifer for this API response

IStorageStrategy — Class in namespace MangoPay\Libraries

Storage strategy interface.

OAuthToken::IsExpired() — Method in class OAuthToken

Check that current tokens are expire and return true if yes

$ MangoPayApi#IdentityVerifications — Property in class MangoPayApi

Provides IdentityVerifications methods.

$ Pagination#ItemsPerPage — Property in class Pagination

Number of items per page

$ PayInPaymentDetailsCard#IpAddress — Property in class PayInPaymentDetailsCard

IpAddress

$ PayInPaymentDetailsGooglePay#IpAddress — Property in class PayInPaymentDetailsGooglePay

Information about the browser used by the end user (author) to perform the payment.

$ PayInRecurringRegistration#Id — Property in class PayInRecurringRegistration

$ PayInRecurringRegistrationUpdate#Id — Property in class PayInRecurringRegistrationUpdate

Recurring PayIn's id to update

$ PayInWebExtendedView#Id — Property in class PayInWebExtendedView

The PayIn's ID

$ PayOutEligibilityResponse#InstantPayout — Property in class PayOutEligibilityResponse

$ PaymentMethodMetadata#IssuerCountryCode — Property in class PaymentMethodMetadata

The country where the card was issued. Format: ISO-3166 alpha-2 two-letter country code

$ PaymentMethodMetadata#IssuingBank — Property in class PaymentMethodMetadata

The name of the card issuer.

$ RateLimit#IntervalMinutes — Property in class RateLimit

$ RecurringPayInCIT#IpAddress — Property in class RecurringPayInCIT

$ Refund#InitialTransactionId — Property in class Refund

Initial transaction Id

$ Refund#InitialTransactionType — Property in class Refund

Initial transaction Type {PAYIN, PAYOUT, TRANSFER}

$ Repudiation#InitialTransactionId — Property in class Repudiation

The Id of the transaction that was repudiated

$ Repudiation#InitialTransactionType — Property in class Repudiation

The initial transaction type

$ ScopeBlocked#Inflows — Property in class ScopeBlocked

$ Ubo#isActive — Property in class Ubo

$ UserNatural#IncomeRange — Property in class UserNatural

$ VirtualAccount#InternationalAccountDetails — Property in class VirtualAccount

The current Status of the Virtual Account

$ VirtualAccountCapabilities#InternationalPayInAvailable — Property in class VirtualAccountCapabilities

Whether international bank wires can be made to this account

J

$ BrowserInfo#JavaEnabled — Property in class BrowserInfo

$ BrowserInfo#JavascriptEnabled — Property in class BrowserInfo

K

KeyValueArray — Class in namespace MangoPay

Class represents tabular values

$ KeyValueArray#Key — Property in class KeyValueArray

Key for tabular variable

KycDocument — Class in namespace MangoPay

KYC document entity

KycDocumentRefusedReasonType — Class in namespace MangoPay

Kyc Refused Reason Type

KycDocumentStatus — Class in namespace MangoPay

KYC document statuses

KycDocumentType — Class in namespace MangoPay

KYC document types

KycLevel — Class in namespace MangoPay

KYC Level

KycPage — Class in namespace MangoPay

KYC page entity for Kyc document

$ MangoPayApi#KycDocuments — Property in class MangoPayApi

Kyc documents list

$ User#KYCLevel — Property in class User

KYC Level (LIGHT or REGULAR)

L

$ BankingAliasIBAN#LocalAccountDetails — Property in class BankingAliasIBAN

LocalAccount details used for GB

$ Billing#LastName — Property in class Billing

The Last Name for Billing Address

$ BrowserInfo#Language — Property in class BrowserInfo

$ Check#LastUpdate — Property in class Check

The date and time at which the check was last updated.

$ Client#Logo — Property in class Client

The URL of the logo of your client

$ CountryAuthorization#LastUpdate — Property in class CountryAuthorization

Date and time when at least one of the authorizations has been last updated.

$ IdentityVerificationCheck#LastUpdate — Property in class IdentityVerificationCheck

The date and time at which the session was last updated.

LegalPersonType — Class in namespace MangoPay

Legal Person types

$ Configuration#LogClass — Property in class Configuration

Set the logging class if DebugMode is enabled

$ HttpBase#logger — Property in class HttpBase

Root/parent instance logger

Logs — Class in namespace MangoPay\Libraries

Class to manage debug logs in MangoPay SDK

LineItem — Class in namespace MangoPay

Information about the items bought by the customer

LocalAccount — Class in namespace MangoPay

LocalAccountDetails — Class in namespace MangoPay

LocalAccountDetailsBankingAlias — Class in namespace MangoPay

$ MangoPayApi#logger — Property in class MangoPayApi

$ Pagination#Links — Property in class Pagination

Array with links to navigation.

$ PayInPaymentDetailsKlarna#LineItems — Property in class PayInPaymentDetailsKlarna

Information about the order items (basket) Note : The LineItems total amount must match the declared DebitedFunds

$ PayInPaymentDetailsPaypal#LineItems — Property in class PayInPaymentDetailsPaypal

Information about the items bought by the customer

$ RecurringPayInCurrentState#LastPayinId — Property in class RecurringPayInCurrentState

$ Shipping#LastName — Property in class Shipping

The Last Name for Billing Address

$ Ubo#LastName — Property in class Ubo

$ UserLegal#LegalPersonType — Property in class UserLegal

Type for legal user. Possible: ‘BUSINESS’, ’ORGANIZATION’

$ UserLegal#LegalRepresentativeFirstName — Property in class UserLegal

$ UserLegal#LegalRepresentativeLastName — Property in class UserLegal

$ UserLegal#LegalRepresentativeAddress — Property in class UserLegal

$ UserLegal#LegalRepresentativeEmail — Property in class UserLegal

$ UserLegal#LegalRepresentativeBirthday — Property in class UserLegal

$ UserLegal#LegalRepresentativeNationality — Property in class UserLegal

$ UserLegal#LegalRepresentativeCountryOfResidence — Property in class UserLegal

$ UserLegal#LegalRepresentativeProofOfIdentity — Property in class UserLegal

$ UserNatural#LastName — Property in class UserNatural

Last name for user

$ VirtualAccount#LocalAccountsDetails — Property in class VirtualAccount

The current Status of the Virtual Account

$ VirtualAccountCapabilities#LocalPayInAvailable — Property in class VirtualAccountCapabilities

Whether local bank wires can be made to this account.

M

$ CardPreAuthorization#MultiCapture — Property in class CardPreAuthorization

Boolean. The value is 'true' if the MultiCapture was used

$ ConversionRate#MarketRate — Property in class ConversionRate

The rate used for the conversion, excluding Mangopay's commission.

$ FallbackReason#Message — Property in class FallbackReason

$ FilterReports#MinDebitedFundsAmount — Property in class FilterReports

Minimum debited funds amount

$ FilterReports#MinDebitedFundsCurrency — Property in class FilterReports

Currency for minimal debited funds amount

$ FilterReports#MaxDebitedFundsAmount — Property in class FilterReports

Maximum debited funds amount

$ FilterReports#MaxDebitedFundsCurrency — Property in class FilterReports

Currency for maximum debited funds amount

$ FilterReports#MinFeesAmount — Property in class FilterReports

Minimum Fees amount

$ FilterReports#MinFeesCurrency — Property in class FilterReports

Currency for minimal Fees amount

$ FilterReports#MaxFeesAmount — Property in class FilterReports

Maximum Fees amount

$ FilterReports#MaxFeesCurrency — Property in class FilterReports

Currency for maximum Fees amount

$ Error#Message — Property in class Error

Error message

Mandate — Class in namespace MangoPay

Direct debit mandate entity.

$ Mandate#MandateType — Property in class Mandate

The type of mandate: DIRECT_DEBIT

MandateStatus — Class in namespace MangoPay

MangoPayApi — Class in namespace MangoPay

MangoPay API main entry point.

$ MangoPayApi#Mandates — Property in class MangoPayApi

Provides dispute documents methods

Money — Class in namespace MangoPay

Class represents money value with currency

$ PayInPaymentDetailsDirectDebit#MandateId — Property in class PayInPaymentDetailsDirectDebit

Mandate Id

$ PayInPaymentDetailsDirectDebitDirect#MandateId — Property in class PayInPaymentDetailsDirectDebitDirect

Mandate identifier.

$ PayInRecurringRegistration#Migration — Property in class PayInRecurringRegistration

$ PayOut#MeanOfPaymentDetails — Property in class PayOut

One of PayOutPaymentDetails implementations, depending on $PaymentType

$ PayOutPaymentDetailsBankWire#ModeRequested — Property in class PayOutPaymentDetailsBankWire

Returned ModeRequested.

$ PayOutPaymentDetailsBankWire#ModeApplied — Property in class PayOutPaymentDetailsBankWire

The new parameter is the current status of the mode above.

$ UboDeclaration#Message — Property in class UboDeclaration

Explanation of why the declaration was refused.

N

$ Client#Name — Property in class Client

Name of client

$ Conversion#Nature — Property in class Conversion

The nature of the transaction, providing more information about the context in which the transaction occurred:

$ FilterTransactions#Nature — Property in class FilterTransactions

$ LineItem#Name — Property in class LineItem

Item name

NaturalUserCapacity — Class in namespace MangoPay

Holds enumeration of natural users' capacities within MangoPay.

$ PayInRecurringRegistration#NextTransactionDebitedFunds — Property in class PayInRecurringRegistration

$ PayInRecurringRegistration#NextTransactionFees — Property in class PayInRecurringRegistration

$ PayPalWebTracking#NotifyBuyer — Property in class PayPalWebTracking

The item cost

$ PaymentData#Network — Property in class PaymentData

Network card used for transaction

$ Transaction#Nature — Property in class Transaction

$ Ubo#Nationality — Property in class Ubo

$ UserLegal#Name — Property in class UserLegal

Name of user

$ UserNatural#Nationality — Property in class UserNatural

User's country

O

$ BankAccount#OwnerName — Property in class BankAccount

Owner name

$ BankAccount#OwnerAddress — Property in class BankAccount

Owner address

$ BankingAlias#OwnerName — Property in class BankingAlias

The name of the owner of the bank account

$ DebitedBankAccount#OwnerName — Property in class DebitedBankAccount

Name of the bank account's owner.

OAuthToken — Class in namespace MangoPay\Libraries

OAuthToken

$ MangoPayApi#OAuthTokenManager — Property in class MangoPayApi

Authorization token methods

$ ScopeBlocked#Outflows — Property in class ScopeBlocked

$ UserNatural#Occupation — Property in class UserNatural

User's occupation

$ Wallet#Owners — Property in class Wallet

Array with owners identities

P

$ Address#PostalCode — Property in class Address

Postal code.

$ CancelDeposit#PaymentStatus — Property in class CancelDeposit

$ Card#Product — Property in class Card

Product

$ CardPreAuthorization#PaymentStatus — Property in class CardPreAuthorization

The status of the payment after the PreAuthorization

$ CardPreAuthorization#PaymentType — Property in class CardPreAuthorization

The type of pre-authorization ("CARD" is the only acceptable value at present

$ CardPreAuthorization#PayInId — Property in class CardPreAuthorization

The Id of the associated PayIn

$ CardPreAuthorization#PaymentCategory — Property in class CardPreAuthorization

Allowed values: ECommerce (default), TelephoneOrder

$ CardRegistration#PreregistrationData — Property in class CardRegistration

Preregistration data

$ CardValidation#PreferredCardNetwork — Property in class CardValidation

Allowed values: VISA, MASTERCARD, CB, MAESTRO

$ CardValidation#PaymentCategory — Property in class CardValidation

Allowed values: ECommerce (default), TelephoneOrder

$ Client#PrimaryThemeColour — Property in class Client

The primary branding colour to use for your merchant

$ Client#PrimaryButtonColour — Property in class Client

The primary branding colour to use for buttons for your merchant

$ Client#PlatformDescription — Property in class Client

A description of what your platform does

$ Client#PlatformCategorization — Property in class Client

Categorization details of the client

$ Client#PlatformURL — Property in class Client

The URL for your website

$ Deposit#PaymentStatus — Property in class Deposit

$ Deposit#PayinsLinked — Property in class Deposit

$ Deposit#PaymentType — Property in class Deposit

$ FilterPreAuthorizations#PaymentStatus — Property in class FilterPreAuthorizations

Status of the payment after the PreAuthorization

$ Document#ProcessedDate — Property in class Document

Date when this document was processed

$ MangoPayApi#PayIns — Property in class MangoPayApi

Pay-in methods

$ MangoPayApi#PayOuts — Property in class MangoPayApi

Pay-out methods

Pagination — Class in namespace MangoPay

Class represents pagination information

$ Pagination#Page — Property in class Pagination

Page number

PayIn — Class in namespace MangoPay

Pay-in entity

$ PayIn#PaymentType — Property in class PayIn

PaymentType {CARD, BANK_WIRE, DIRECT_DEBIT, PAYPAL, PAYCONIQ }

$ PayIn#PaymentDetails — Property in class PayIn

One of PayInPaymentDetails implementations, depending on $PaymentType

$ PayIn#PaymentCategory — Property in class PayIn

Allowed values: ECommerce (default), TelephoneOrder

PayInCardTemplateURLOptions — Class in namespace MangoPay

Class represents template URL options

$ PayInCardTemplateURLOptions#PAYLINE — Property in class PayInCardTemplateURLOptions

PAYLINE options - Will be deprecated on March 31th (Sandbox) and April 30th (production)

$ PayInCardTemplateURLOptions#PAYLINEV2 — Property in class PayInCardTemplateURLOptions

PAYLINEV2 options

PayInExecutionDetails — Class in namespace MangoPay

Marker interface for classes with details of execution option in PayIn entity

PayInExecutionDetailsDirect — Class in namespace MangoPay

Class represents Web type for 'DIRECT' execution option in PayIn entity

PayInExecutionDetailsExternalInstruction — Class in namespace MangoPay

Class represents Web type for 'EXTERNAL_INSTRUCTION' execution option in PayIn entity

PayInExecutionDetailsWeb — Class in namespace MangoPay

Class represents Web type for 'WEB' execution option in PayIn entity

PayInExecutionType — Class in namespace MangoPay

PayIn execution types

PayInPaymentDetails — Class in namespace MangoPay

Marker interface for classes with details of means of payment in PayIn entity

PayInPaymentDetailsApplePay — Class in namespace MangoPay

$ PayInPaymentDetailsApplePay#PaymentData — Property in class PayInPaymentDetailsApplePay

Payment information returned by Apple Pay payment

PayInPaymentDetailsBancontact — Class in namespace MangoPay

Class represents Bancontact type for mean of payment in Bancontact entity

PayInPaymentDetailsBankWire — Class in namespace MangoPay

Class represents BankWire type for mean of payment in PayIn entity

PayInPaymentDetailsBlik — Class in namespace MangoPay

PayInPaymentDetailsCard — Class in namespace MangoPay

Class represents Card type for mean of payment in PayIn entity

PayInPaymentDetailsDirectDebit — Class in namespace MangoPay

Class represents direct debit type for mean of payment in PayIn entity

PayInPaymentDetailsDirectDebitDirect — Class in namespace MangoPay

Class represents direct debit type for mean of payment in PayIn entity

PayInPaymentDetailsGiropay — Class in namespace MangoPay

Class represents Giropay type for mean of payment in Giropay entity

PayInPaymentDetailsGooglePay — Class in namespace MangoPay

$ PayInPaymentDetailsGooglePay#PaymentData — Property in class PayInPaymentDetailsGooglePay

Payment information returned by Google Pay payment

PayInPaymentDetailsIdeal — Class in namespace MangoPay

Class represents IDEAL type for mean of payment in IDEAL entity

PayInPaymentDetailsKlarna — Class in namespace MangoPay

Class represents Klarna type for mean of payment in Klarna entity

$ PayInPaymentDetailsKlarna#Phone — Property in class PayInPaymentDetailsKlarna

The end-user mobile phone number

$ PayInPaymentDetailsKlarna#PaymentMethod — Property in class PayInPaymentDetailsKlarna

The Klarna option that the end-user has chosen at checkout

PayInPaymentDetailsMbway — Class in namespace MangoPay

$ PayInPaymentDetailsMbway#Phone — Property in class PayInPaymentDetailsMbway

The mobile phone number of the user initiating the pay-in Country code followed by hash symbol (#) followed by the rest of the number. Only digits and hash allowed

PayInPaymentDetailsMultibanco — Class in namespace MangoPay

PayInPaymentDetailsPayconiq — Class in namespace MangoPay

Class represents Payconiq type for mean of payment in PayIn entity

PayInPaymentDetailsPaypal — Class in namespace MangoPay

Class represents PayPal type for mean of payment in PayIn entity

$ PayInPaymentDetailsPaypal#PaypalBuyerAccountEmail — Property in class PayInPaymentDetailsPaypal

PayPal buyer's email account

$ PayInPaymentDetailsPaypal#PaypalPayerID — Property in class PayInPaymentDetailsPaypal

$ PayInPaymentDetailsPaypal#PaypalOrderID — Property in class PayInPaymentDetailsPaypal

PayInPaymentDetailsPreAuthorized — Class in namespace MangoPay

Class represents Web type for execution option in PayIn entity

$ PayInPaymentDetailsPreAuthorized#PreauthorizationId — Property in class PayInPaymentDetailsPreAuthorized

The ID of the Preauthorization object

PayInPaymentDetailsSatispay — Class in namespace MangoPay

PayInPaymentDetailsSwish — Class in namespace MangoPay

Class represents Giropay type for mean of payment in Giropay entity

$ PayInPaymentDetailsSwish#PaymentFlow — Property in class PayInPaymentDetailsSwish

Allowed values: WEB, APP

Default value: WEB

The platform environment of the post-payment flow. The PaymentFlow value combines with the ReturnURL to manage the redirection behavior after payment:

Set the value to APP to send the user to your platform’s mobile app

Set the value to WEB to send the user to a web browser

In both cases you need to provide the relevant ReturnURL, whether to your app or website.

PayInPaymentType — Class in namespace MangoPay

PayIn payment types

PayInRecurring — Class in namespace MangoPay

PayInRecurringRegistration — Class in namespace MangoPay

PayInRecurringRegistrationGet — Class in namespace MangoPay

PayInRecurringRegistrationRequestResponse — Class in namespace MangoPay

PayInRecurringRegistrationUpdate — Class in namespace MangoPay

PayInStatus — Class in namespace MangoPay

PayIn statuses

PayInTemplateURLOptions — Class in namespace MangoPay

Class represents template URL options

$ PayInTemplateURLOptions#PAYLINE — Property in class PayInTemplateURLOptions

PAYLINE options - Will be deprecated on March 31th (Sandbox) and April 30th (production)

PayInWebExtendedView — Class in namespace MangoPay

Pay-in entity

$ PayInWebExtendedView#PaymentType — Property in class PayInWebExtendedView

Payment Type

PayOut — Class in namespace MangoPay

PayOut entity

$ PayOut#PaymentType — Property in class PayOut

PaymentType (BANK_WIRE, MERCHANT_EXPENSE, AMAZON_GIFTCARD)

PayOutEligibilityRequest — Class in namespace MangoPay

$ PayOutEligibilityRequest#PayoutModeRequested — Property in class PayOutEligibilityRequest

Payout mode requested. May take one of the following values: STANDARD (value by default if no parameter is sent): a standard bank wire is requested and the processing time of the funds is about 48 hours; INSTANT_PAYMENT: an instant payment bank wire is requested and the processing time is within 25 seconds (subject to prerequisites); INSTANT_PAYMENT_ONLY: an instant payment bank wire is requested and the processing time is within 25 seconds, but if any prerequisite is not met or another problem occurs, there is no fallback: the wallet is automatically refunded and the payout is not completed.

PayOutEligibilityResponse — Class in namespace MangoPay

PayOutPaymentDetails — Class in namespace MangoPay

Marker interface for classes with details of means of payment in PayOut entity

PayOutPaymentDetailsBankWire — Class in namespace MangoPay

Class represents BankWire type for mean of payment in PayOut entity

$ PayOutPaymentDetailsBankWire#PaymentRef — Property in class PayOutPaymentDetailsBankWire

The PaymentRef must be sent on payouts that are reimbursing bank wire pay-ins and pay-ins to virtual IBANs,

$ PayOutPaymentDetailsBankWire#PayoutModeRequested — Property in class PayOutPaymentDetailsBankWire

The parameter "PayoutModeRequested" can take 3 different values : "STANDARD", "INSTANT_PAYMENT", "INSTANT_PAYMENT_ONLY"

PayOutPaymentRef — Class in namespace MangoPay

PayOutPaymentType — Class in namespace MangoPay

PayOut payment types

PayOutStatus — Class in namespace MangoPay

PayOut statuses

PayPalWebTracking — Class in namespace MangoPay

PayinsLinked — Class in namespace MangoPay

Event entity

$ PayinsLinked#PayInCaptureId — Property in class PayinsLinked

$ PayinsLinked#PayinComplementId — Property in class PayinsLinked

PaymentData — Class in namespace MangoPay

Information regarding the Apple Pay payment

PaymentMethodMetadata — Class in namespace MangoPay

PersonType — Class in namespace MangoPay

Person type for users

PlatformCategorization — Class in namespace MangoPay

Class holds details about the client platform categorization

$ RecurringPayInCurrentState#PayinsLinked — Property in class RecurringPayInCurrentState

$ ReportRequest#Preview — Property in class ReportRequest

If true, the report will be limited to the first 10 lines.

$ UboDeclaration#ProcessedDate — Property in class UboDeclaration

$ User#PersonType — Property in class User

Type of user

$ UserLegal#ProofOfRegistration — Property in class UserLegal

$ UserNatural#ProofOfIdentity — Property in class UserNatural

$ UserNatural#ProofOfAddress — Property in class UserNatural

$ VirtualAccountAddress#PostCode — Property in class VirtualAccountAddress

Q

$ Conversion#QuoteId — Property in class Conversion

The unique identifier of the active quote which guaranteed the rate for the conversion.

$ CreateClientWalletsQuotedConversion#QuoteId — Property in class CreateClientWalletsQuotedConversion

The unique identifier of the active quote which guaranteed the rate for the conversion.

$ CreateQuotedConversion#QuoteId — Property in class CreateQuotedConversion

The unique identifier of the active quote which guaranteed the rate for the conversion.

$ LineItem#Quantity — Property in class LineItem

Quantity of item bought

$ PayInPaymentDetailsSwish#QRCodeURL — Property in class PayInPaymentDetailsSwish

The PNG file of the Swish QR code as a Base64-encoded string.

R

$ Address#Region — Property in class Address

Region.

ApiDisputes::ResubmitDispute() — Method in class ApiDisputes

This method is used to resubmit a Dispute if it is reopened requiring more docs

$ CardPreAuthorization#ResultCode — Property in class CardPreAuthorization

The PreAuthorization result code

$ CardPreAuthorization#ResultMessage — Property in class CardPreAuthorization

The PreAuthorization result Message explaining the result code

$ CardPreAuthorization#RemainingFunds — Property in class CardPreAuthorization

RemainingFunds

$ CardPreAuthorization#Requested3DSVersion — Property in class CardPreAuthorization

Requested3DSVersion

$ CardRegistration#RegistrationData — Property in class CardRegistration

Card registration data

$ CardRegistration#ResultCode — Property in class CardRegistration

The result code of the object

$ CardRegistration#ResultMessage — Property in class CardRegistration

The message explaining the result code

$ CardValidation#ResultCode — Property in class CardValidation

The mandate result code

$ CardValidation#ResultMessage — Property in class CardValidation

The mandate result Message

$ Conversion#ResultCode — Property in class Conversion

The code indicates the result of the operation.

$ Conversion#ResultMessage — Property in class Conversion

The explanation of the result code.

$ DeclaredUbo#RefusedReasonType — Property in class DeclaredUbo

Reason why the declared UBO is not valid.

$ DeclaredUbo#RefusedReasonMessage — Property in class DeclaredUbo

Message explaining why the UBO is not valid.

$ Deposit#ResultCode — Property in class Deposit

$ Deposit#ResultMessage — Property in class Deposit

$ Deposit#Requested3DSVersion — Property in class Deposit

$ Dispute#ResultCode — Property in class Dispute

The outcome of the dispute – will be null until closed, and then one of WON, LOST or VOID

$ Dispute#ResultMessage — Property in class Dispute

The field that may be used to give more info about the end result

$ Dispute#RepudiationId — Property in class Dispute

The Id of the associated repudiation transaction

$ Event#ResourceId — Property in class Event

Resource ID

$ FilterPreAuthorizations#ResultCode — Property in class FilterPreAuthorizations

$ FilterRefunds#ResultCode — Property in class FilterRefunds

Multiple values separated by commas are allowed

$ FilterReports#ResultCode — Property in class FilterReports

Code to filter.

$ FilterTransactions#ResultCode — Property in class FilterTransactions

$ IdentityVerification#ReturnUrl — Property in class IdentityVerification

The URL to which the user is returned after the hosted identity verification session, regardless of the outcome.

AuthorizationTokenManager::RegisterCustomStorageStrategy() — Method in class AuthorizationTokenManager

Registers custom storage strategy implementation.

$ Document#RefusedReasonType — Property in class Document

Refused reason type

$ Document#RefusedReasonMessage — Property in class Document

Refused reason message

HttpBase::Request() — Method in class HttpBase

HttpCurl::Request() — Method in class HttpCurl

$ HttpResponse#ResponseCode — Property in class HttpResponse

RequestType — Class in namespace MangoPay\Libraries

Request type enum

ResponseException — Class in namespace MangoPay\Libraries

Response exception class

$ ResponseException#RequestUrl — Property in class ResponseException

Request URL

RestTool — Class in namespace MangoPay\Libraries

Class to prepare HTTP request, call the request and decode the response

RestTool::Request() — Method in class RestTool

Call request to MangoPay API

$ Mandate#RedirectURL — Property in class Mandate

Redirect URL

$ Mandate#ReturnURL — Property in class Mandate

Return URL

$ Mandate#ResultCode — Property in class Mandate

The mandate result code

$ Mandate#ResultMessage — Property in class Mandate

The mandate result Message

$ MangoPayApi#Responses — Property in class MangoPayApi

Provides responses methods

$ MangoPayApi#Refunds — Property in class MangoPayApi

Refund methods

$ MangoPayApi#Reports — Property in class MangoPayApi

Provides reports request methods

$ MangoPayApi#Repudiations — Property in class MangoPayApi

Provides Repudiation methods

$ MangoPayApi#RateLimits — Property in class MangoPayApi

$ MangoPayApi#Regulatory — Property in class MangoPayApi

Provides Regulatory methods

$ PayIn#RecurringPayinRegistrationId — Property in class PayIn

Recurring PayIn Registration Id

$ PayInExecutionDetailsDirect#Requested3DSVersion — Property in class PayInExecutionDetailsDirect

Requested3DSVersion

$ PayInExecutionDetailsWeb#RedirectURL — Property in class PayInExecutionDetailsWeb

URL format expected

$ PayInExecutionDetailsWeb#ReturnURL — Property in class PayInExecutionDetailsWeb

URL format expected

$ PayInPaymentDetailsBancontact#Recurring — Property in class PayInPaymentDetailsBancontact

Whether the Bancontact pay-ins are being made to be re-used in a recurring payment flow

$ PayInPaymentDetailsCard#Reference — Property in class PayInPaymentDetailsCard

$ PayInPaymentDetailsGooglePay#ReturnURL — Property in class PayInPaymentDetailsGooglePay

Return URL

$ PayInPaymentDetailsKlarna#Reference — Property in class PayInPaymentDetailsKlarna

The merchant order reference

$ PayInPaymentDetailsPaypal#Reference — Property in class PayInPaymentDetailsPaypal

$ PayInRecurringRegistrationRequestResponse#RecurringType — Property in class PayInRecurringRegistrationRequestResponse

$ PayOutPaymentRef#ReasonType — Property in class PayOutPaymentRef

ReasonType (PAYIN_REFUND)

$ PayOutPaymentRef#ReferenceId — Property in class PayOutPaymentRef

RateLimit — Class in namespace MangoPay

$ RateLimit#ResetTimeTimestamp — Property in class RateLimit

RecurringPayInCIT — Class in namespace MangoPay

$ RecurringPayInCIT#RecurringPayinRegistrationId — Property in class RecurringPayInCIT

RecurringPayInCurrentState — Class in namespace MangoPay

RecurringPayInMIT — Class in namespace MangoPay

$ RecurringPayInMIT#RecurringPayinRegistrationId — Property in class RecurringPayInMIT

Refund — Class in namespace MangoPay

Refund entity

$ Refund#RefundReason — Property in class Refund

Contains info about the reason for refund

$ Refund#Reference — Property in class Refund

RefundReasonDetails — Class in namespace MangoPay

Class represents RefundReason details in Refund entity

$ RefundReasonDetails#RefundReasonMessage — Property in class RefundReasonDetails

Message about the reason for refund

$ RefundReasonDetails#RefundReasonType — Property in class RefundReasonDetails

Type of refund reason

RefundStatus — Class in namespace MangoPay

ReportRequest — Class in namespace MangoPay

Report request entity

$ ReportRequest#ReportDate — Property in class ReportRequest

Date of when the report was requested.

$ ReportRequest#ReportType — Property in class ReportRequest

Type of the report.

$ ReportRequest#ResultCode — Property in class ReportRequest

Result code.

$ ReportRequest#ResultMessage — Property in class ReportRequest

Result message.

ReportStatus — Class in namespace MangoPay

ReportType — Class in namespace MangoPay

Repudiation — Class in namespace MangoPay

Repudiation entity

$ Repudiation#ResultCode — Property in class Repudiation

The transaction result code

$ Repudiation#ResultMessage — Property in class Repudiation

The transaction result message

Response — Class in namespace MangoPay

Response entity

$ Response#RequestURL — Property in class Response

Request URL where the idempotency key was used

$ Response#Resource — Property in class Response

Entity or response data (JSON-serialized)

$ SettlementTransfer#RepudiationId — Property in class SettlementTransfer

The Id of the associated repudiation transaction

$ ShippingAddress#RecipientName — Property in class ShippingAddress

The recipient's name.

$ Transaction#ResultCode — Property in class Transaction

Result code

$ Transaction#ResultMessage — Property in class Transaction

The PreAuthorization result Message explaining the result code

$ UboDeclaration#Reason — Property in class UboDeclaration

List of reasons why the declaration was refused.

S

ApiUboDeclarations::SubmitForValidation() — Method in class ApiUboDeclarations

Updates an UBO Declaration with the status VALIDATION_ASKED.

$ BankAccountDetailsGB#SortCode — Property in class BankAccountDetailsGB

Sort code

$ BrowserInfo#ScreenHeight — Property in class BrowserInfo

$ BrowserInfo#ScreenWidth — Property in class BrowserInfo

$ CardInfo#SubType — Property in class CardInfo

The subtype of the card product. Examples include: CLASSIC, GOLD, PLATINUM, PREPAID, etc.

$ CardPreAuthorization#Status — Property in class CardPreAuthorization

Status of the PreAuthorization

$ CardPreAuthorization#StatementDescriptor — Property in class CardPreAuthorization

An optional value to be specified on the user's bank statement

$ CardPreAuthorization#SecureMode — Property in class CardPreAuthorization

The SecureMode correspond to '3D secure' for CB Visa and MasterCard or 'Amex Safe Key' for American Express.

$ CardPreAuthorization#SecureModeNeeded — Property in class CardPreAuthorization

Boolean. The value is 'true' if the SecureMode was used

$ CardPreAuthorization#SecureModeRedirectURL — Property in class CardPreAuthorization

This is the URL where to redirect users to proceed to 3D secure validation

$ CardPreAuthorization#SecureModeReturnURL — Property in class CardPreAuthorization

This is the URL where users are automatically redirected after 3D secure validation (if activated)

$ CardPreAuthorization#SecurityInfo — Property in class CardPreAuthorization

Security validation information

$ CardPreAuthorization#Shipping — Property in class CardPreAuthorization

Shipping

$ CardRegistration#Status — Property in class CardRegistration

Status

$ CardValidation#SecureModeReturnUrl — Property in class CardValidation

This is the URL where users are automatically redirected after 3D secure validation (if activated)

$ CardValidation#SecureModeRedirectURL — Property in class CardValidation

SecureModeRedirectURL

$ CardValidation#SecureModeNeeded — Property in class CardValidation

Boolean. The value is 'true' if the SecureMode was used

$ CardValidation#SecureMode — Property in class CardValidation

The mode applied for the 3DS2 protocol for CB, Visa, and Mastercard

$ CardValidation#Status — Property in class CardValidation

The current status of the card validation

$ Conversion#Status — Property in class Conversion

The status of the transaction.

$ ConversionQuote#Status — Property in class ConversionQuote

$ CreateDeposit#SecureModeReturnURL — Property in class CreateDeposit

$ CreateDeposit#StatementDescriptor — Property in class CreateDeposit

$ CreateDeposit#Shipping — Property in class CreateDeposit

$ DeclaredUbo#Status — Property in class DeclaredUbo

Validation status of this declared UBO.

$ Deposit#Status — Property in class Deposit

$ Deposit#SecureModeReturnURL — Property in class Deposit

$ Deposit#SecureModeRedirectURL — Property in class Deposit

$ Deposit#SecureModeNeeded — Property in class Deposit

$ Deposit#StatementDescriptor — Property in class Deposit

$ Deposit#Shipping — Property in class Deposit

$ Dispute#Status — Property in class Dispute

The current status of the dispute

$ Dispute#StatusMessage — Property in class Dispute

Free text used when reopening the dispute

$ DisputeDocument#Status — Property in class DisputeDocument

Status of dispute document

$ FilterDisputeDocuments#Status — Property in class FilterDisputeDocuments

$ FilterDisputes#Status — Property in class FilterDisputes

$ FilterKycDocuments#Status — Property in class FilterKycDocuments

$ FilterPreAuthorizations#Status — Property in class FilterPreAuthorizations

Status of the PreAuthorizations

$ FilterRefunds#Status — Property in class FilterRefunds

Multiple values separated by commas are allowed

$ FilterTransactions#Status — Property in class FilterTransactions

$ Hook#Status — Property in class Hook

$ IdentityVerification#Status — Property in class IdentityVerification

The status of the identity verification session:

PENDING – The session is available on the HostedUrl, to which the user must be redirected to complete it.

VALIDATED – The session was successful.

REFUSED – The session was refused.

REVIEW – The session is under manual review by Mangopay.

OUTDATED – The session is no longer valid (likely due to expired documents used during the session).

TIMEOUT – The session timed out due to inactivity.

ERROR – The session was not completed because an error occurred.

$ IdentityVerificationCheck#SessionId — Property in class IdentityVerificationCheck

Unique identifier for the entire verification session.

$ IdentityVerificationCheck#Status — Property in class IdentityVerificationCheck

The status of the identity verification session:

PENDING – The session is available on the HostedUrl, to which the user must be redirected to complete it.

VALIDATED – The session was successful.

REFUSED – The session was refused.

REVIEW – The session is under manual review by Mangopay.

OUTDATED – The session is no longer valid (likely due to expired documents used during the session).

TIMEOUT – The session timed out due to inactivity.

ERROR – The session was not completed because an error occurred.

$ KycDocument#Status — Property in class KycDocument

ApiBase::SaveObject() — Method in class ApiBase

Save object in API

AuthorizationTokenManager::StoreToken() — Method in class AuthorizationTokenManager

Stores authorization token passed as an argument in the underlying storage strategy implementation.

DefaultStorageStrategy::Store() — Method in class DefaultStorageStrategy

Stores authorization token passed as an argument.

IStorageStrategy::Store() — Method in class IStorageStrategy

Stores authorization token passed as an argument.

$ LocalAccount#SortCode — Property in class LocalAccount

The sort code of the account.

$ LocalAccountDetailsBankingAlias#SortCode — Property in class LocalAccountDetailsBankingAlias

BankingAlias GB SortCode

$ Mandate#Scheme — Property in class Mandate

The type of mandate – it will be « SEPA » or « BACS » but will only be completed once the mandate has been submitted

$ Mandate#Status — Property in class Mandate

Status of the mandate

MangoPayApi::setLogger() — Method in class MangoPayApi

MangoPayApi::setConfig() — Method in class MangoPayApi

MangoPayApi::setHttpClient() — Method in class MangoPayApi

$ PayInExecutionDetailsDirect#SecureMode — Property in class PayInExecutionDetailsDirect

SecureMode { DEFAULT, FORCE, NO_CHOICE }

$ PayInExecutionDetailsDirect#SecureModeReturnURL — Property in class PayInExecutionDetailsDirect

SecureModeReturnURL

$ PayInExecutionDetailsDirect#SecureModeRedirectURL — Property in class PayInExecutionDetailsDirect

SecureModeRedirectURL

$ PayInExecutionDetailsDirect#SecureModeNeeded — Property in class PayInExecutionDetailsDirect

SecureModeNeeded

$ PayInExecutionDetailsDirect#SecurityInfo — Property in class PayInExecutionDetailsDirect

Security & validation information

$ PayInExecutionDetailsWeb#SecureMode — Property in class PayInExecutionDetailsWeb

Mode3DSType { DEFAULT, FORCE, NO_CHOICE }

$ PayInPaymentDetailsApplePay#StatementDescriptor — Property in class PayInPaymentDetailsApplePay

Custom description to show on the user's bank statement.

$ PayInPaymentDetailsBancontact#StatementDescriptor — Property in class PayInPaymentDetailsBancontact

Custom description to show on the user's bank statement.

$ PayInPaymentDetailsBlik#StatementDescriptor — Property in class PayInPaymentDetailsBlik

Custom description to show on the user's bank statement.

$ PayInPaymentDetailsCard#StatementDescriptor — Property in class PayInPaymentDetailsCard

StatementDescriptor

$ PayInPaymentDetailsCard#Shipping — Property in class PayInPaymentDetailsCard

Shipping

$ PayInPaymentDetailsDirectDebit#StatementDescriptor — Property in class PayInPaymentDetailsDirectDebit

StatementDescriptor

$ PayInPaymentDetailsDirectDebitDirect#StatementDescriptor — Property in class PayInPaymentDetailsDirectDebitDirect

StatementDescriptor

$ PayInPaymentDetailsGiropay#StatementDescriptor — Property in class PayInPaymentDetailsGiropay

Custom description to show on the user's bank statement.

$ PayInPaymentDetailsGooglePay#StatementDescriptor — Property in class PayInPaymentDetailsGooglePay

Custom description to show on the user's bank statement.

$ PayInPaymentDetailsGooglePay#Shipping — Property in class PayInPaymentDetailsGooglePay

Information about the end user shipping address.

$ PayInPaymentDetailsIdeal#StatementDescriptor — Property in class PayInPaymentDetailsIdeal

Custom description to show on the user's bank statement.

$ PayInPaymentDetailsKlarna#Shipping — Property in class PayInPaymentDetailsKlarna

Information about the shipping address

$ PayInPaymentDetailsMbway#StatementDescriptor — Property in class PayInPaymentDetailsMbway

Custom description to show on the user's bank statement.

$ PayInPaymentDetailsMultibanco#StatementDescriptor — Property in class PayInPaymentDetailsMultibanco

Custom description to show on the user's bank statement.

$ PayInPaymentDetailsPaypal#ShippingAddress — Property in class PayInPaymentDetailsPaypal

Address used instead of the user's PayPal account address.

$ PayInPaymentDetailsPaypal#StatementDescriptor — Property in class PayInPaymentDetailsPaypal

Custom description of the payment shown to the consumer when making payments and on the bank statement

$ PayInPaymentDetailsPaypal#Shipping — Property in class PayInPaymentDetailsPaypal

User’s shipping address When not provided, the default address is the one register one the buyer PayPal account

$ PayInPaymentDetailsPaypal#ShippingPreference — Property in class PayInPaymentDetailsPaypal

User’s shipping preference

$ PayInPaymentDetailsSatispay#StatementDescriptor — Property in class PayInPaymentDetailsSatispay

Custom description to show on the user's bank statement.

$ PayInPaymentDetailsSwish#StatementDescriptor — Property in class PayInPaymentDetailsSwish

Custom description to show on the user's bank statement.

$ PayInRecurringRegistration#Shipping — Property in class PayInRecurringRegistration

$ PayInRecurringRegistration#Status — Property in class PayInRecurringRegistration

$ PayInRecurringRegistrationUpdate#Shipping — Property in class PayInRecurringRegistrationUpdate

$ PayInRecurringRegistrationUpdate#Status — Property in class PayInRecurringRegistrationUpdate

$ PayOutPaymentDetailsBankWire#Status — Property in class PayOutPaymentDetailsBankWire

The status.

$ PlatformCategorization#Sector — Property in class PlatformCategorization

Sector of business in which the platform operates

$ RecurringPayInCIT#SecureModeReturnURL — Property in class RecurringPayInCIT

$ RecurringPayInCIT#StatementDescriptor — Property in class RecurringPayInCIT

$ RecurringPayInMIT#StatementDescriptor — Property in class RecurringPayInMIT

$ Refund#StatementDescriptor — Property in class Refund

$ ReportRequest#Status — Property in class ReportRequest

Status of the report.

$ ReportRequest#Sort — Property in class ReportRequest

Sorting.

$ Repudiation#Status — Property in class Repudiation

The status of the transfer

$ Response#StatusCode — Property in class Response

Status code

ScopeBlocked — Class in namespace MangoPay

Sector — Class in namespace MangoPay

Business sector

SecurityInfo — Class in namespace MangoPay

Security & validation information

SettlementTransfer — Class in namespace MangoPay

Settlement transfer entity.

Shipping — Class in namespace MangoPay

ShippingAddress — Class in namespace MangoPay

Class represents the shipping address of a PayPal PayIn.

ShippingPreference — Class in namespace MangoPay

SortDirection — Class in namespace MangoPay

Sorting — Class in namespace MangoPay

Base sorting object

$ Transaction#Status — Property in class Transaction

$ UboDeclaration#Status — Property in class UboDeclaration

Declaration status.

User::SetPersonType() — Method in class User

Construct

$ UserBlockStatus#ScopeBlocked — Property in class UserBlockStatus

$ UserLegal#Statute — Property in class UserLegal

$ UserLegal#ShareholderDeclaration — Property in class UserLegal

$ VirtualAccount#Status — Property in class VirtualAccount

The status of the virtual account creation Allowed values: COLLECTION, USER_OWNED

$ VirtualAccountAddress#StreetName — Property in class VirtualAccountAddress

T

$ BankAccount#Type — Property in class BankAccount

Type of bank account

$ BankAccountDetailsOTHER#Type — Property in class BankAccountDetailsOTHER

Type

$ BankingAlias#Tag — Property in class BankingAlias

Custom data that you can add to this item

$ BankingAlias#Type — Property in class BankingAlias

The type of banking alias (note that only IBAN is available at present)

$ BankingAliasIBAN#Type — Property in class BankingAliasIBAN

The type of banking alias (note that only IBAN and GB is available at present)

$ BankingAliasOTHER#Type — Property in class BankingAliasOTHER

Type

$ BrowserInfo#TimeZoneOffset — Property in class BrowserInfo

$ CardInfo#Type — Property in class CardInfo

The type of card product: DEBIT, CREDIT, CHARGE CARD.

$ CardValidation#Type — Property in class CardValidation

$ Check#Type — Property in class Check

Type of verification check performed:

BUSINESS_VERIFICATION - Verification of the business entity of a Legal User.

IDENTITY_DOCUMENT_VERIFICATION - Verification of the identity document of a Natural User or the legal representative of a Legal User.

PERSONS_SIGNIFICANT_CONTROL - Verification of a person of significant control of a Legal User.

$ CheckData#Type — Property in class CheckData

The type of the data point.

$ Client#TechEmails — Property in class Client

A list of email addresses to use when contacting you for technical issues/communications

$ Client#TaxNumber — Property in class Client

The tax (or VAT) number for your company

$ Conversion#Type — Property in class Conversion

The type of transaction

$ CreateCardPreAuthorizedDepositPayIn#Tag — Property in class CreateCardPreAuthorizedDepositPayIn

$ CreateClientWalletsInstantConversion#Tag — Property in class CreateClientWalletsInstantConversion

Custom data.

$ CreateClientWalletsQuotedConversion#Tag — Property in class CreateClientWalletsQuotedConversion

Custom data.

$ CreateInstantConversion#Tag — Property in class CreateInstantConversion

Custom data.

$ CreateQuotedConversion#Tag — Property in class CreateQuotedConversion

Custom data.

$ DebitedBankAccount#Type — Property in class DebitedBankAccount

Type

$ DisputeDocument#Type — Property in class DisputeDocument

Type of dispute document

$ FilterDisputeDocuments#Type — Property in class FilterDisputeDocuments

$ FilterKycDocuments#Type — Property in class FilterKycDocuments

$ FilterTransactions#Type — Property in class FilterTransactions

$ KycDocument#Type — Property in class KycDocument

$ Configuration#TemporaryFolder — Property in class Configuration

Path to folder with temporary files (with permissions to write)

$ EntityBase#Tag — Property in class EntityBase

$ Error#Type — Property in class Error

The type of error

$ OAuthToken#token_type — Property in class OAuthToken

Token type

$ LineItem#TaxAmount — Property in class LineItem

The item tax

$ MangoPayApi#Transfers — Property in class MangoPayApi

Transfers methods

$ Pagination#TotalPages — Property in class Pagination

Number of total pages

$ Pagination#TotalItems — Property in class Pagination

Number of total items

$ PayInExecutionDetailsWeb#TemplateURL — Property in class PayInExecutionDetailsWeb

URL format expected.

$ PayInExecutionDetailsWeb#TemplateURLOptions — Property in class PayInExecutionDetailsWeb

The URL where you host the iFramed template.

$ PayInPaymentDetailsPaypal#Trackings — Property in class PayInPaymentDetailsPaypal

$ PayInRecurringRegistrationRequestResponse#TotalAmount — Property in class PayInRecurringRegistrationRequestResponse

$ PayPalWebTracking#TrackingNumber — Property in class PayPalWebTracking

Item name

$ PaymentData#TransactionId — Property in class PaymentData

ID of the Apple payment transaction

$ PaymentData#TokenData — Property in class PaymentData

Data block containing payment information

$ PaymentMethodMetadata#Type — Property in class PaymentMethodMetadata

The type of metadata. Allowed values: BIN, GOOGLE_PAY

$ PaymentMethodMetadata#Token — Property in class PaymentMethodMetadata

The tokenized payment data provided by the third-party payment method.

$ PaymentMethodMetadata#TokenFormat — Property in class PaymentMethodMetadata

In the case of Google Pay, the format of the Token.

$ RecurringPayInCIT#Tag — Property in class RecurringPayInCIT

$ RecurringPayInMIT#Tag — Property in class RecurringPayInMIT

Transaction — Class in namespace MangoPay

Transaction entity.

$ Transaction#Type — Property in class Transaction

TransactionNature — Class in namespace MangoPay

TransactionStatus — Class in namespace MangoPay

TransactionType — Class in namespace MangoPay

Transfer — Class in namespace MangoPay

Transfer entity

$ User#TermsAndConditionsAccepted — Property in class User

Whether the user has accepted the MANGOPAY Terms and Conditions.

$ User#TermsAndConditionsAcceptedDate — Property in class User

The date on which the user has accepted the MANGOPAY Terms and Conditions.

$ VirtualAccountAddress#TownName — Property in class VirtualAccountAddress

U

ApiBankingAliases::Update() — Method in class ApiBankingAliases

Update banking alias

ApiCardPreAuthorizations::Update() — Method in class ApiCardPreAuthorizations

Update pre-authorization object

ApiCardRegistrations::Update() — Method in class ApiCardRegistrations

Update card registration

ApiCards::Update() — Method in class ApiCards

Update card

ApiClients::Update() — Method in class ApiClients

Save client

ApiClients::UploadLogo() — Method in class ApiClients

Upload a logo for client.

ApiClients::UploadLogoFromFile() — Method in class ApiClients

Upload a logo for client from file.

ApiDisputes::Update() — Method in class ApiDisputes

Updates dispute's tag

ApiDisputes::UpdateDisputeDocument() — Method in class ApiDisputes

Update dispute document

ApiHooks::Update() — Method in class ApiHooks

Save hook

ApiPayIns::UpdateRecurringRegistration() — Method in class ApiPayIns

Update recurring payment

ApiUboDeclarations::UpdateUbo() — Method in class ApiUboDeclarations

Updates an UBO

ApiUsers::Update() — Method in class ApiUsers

Save user

ApiUsers::UpdateBankAccount() — Method in class ApiUsers

Save a bank account

ApiUsers::UpdateKycDocument() — Method in class ApiUsers

Save KYC document

ApiWallets::Update() — Method in class ApiWallets

Save wallet

$ BankAccount#UserId — Property in class BankAccount

User identifier

$ BrowserInfo#UserAgent — Property in class BrowserInfo

$ Card#UserId — Property in class Card

UserId

$ CardRegistration#UserId — Property in class CardRegistration

User Id

$ DeclaredUbo#UserId — Property in class DeclaredUbo

ID of the declared user.

$ DocumentPageConsult#Url — Property in class DocumentPageConsult

URL where this document page can be viewed.

$ EMoney#UserId — Property in class EMoney

Owner object owner's UserId

$ Hook#Url — Property in class Hook

This is the URL where your receive notification for each EventType

$ InstantPayout#UnreachableReason — Property in class InstantPayout

$ KycDocument#UserId — Property in class KycDocument

$ Configuration#UserPasswordProxy — Property in class Configuration

Set the user:password proxy

$ Configuration#UKHeaderFlag — Property in class Configuration

Set to true for uk traffic

Upload — Class in namespace MangoPay\Libraries

Abstract class for all documents

UrlTool — Class in namespace MangoPay\Libraries

$ LineItem#UnitAmount — Property in class LineItem

The item cost

$ Mandate#UserId — Property in class Mandate

ID of the user to which this mandate belongs

$ MangoPayApi#Users — Property in class MangoPayApi

Users methods

$ MangoPayApi#UboDeclarations — Property in class MangoPayApi

Provides UBO declaration methods.

Ubo — Class in namespace MangoPay

UboDeclaration — Class in namespace MangoPay

UBO Declaration entity.

$ UboDeclaration#UserId — Property in class UboDeclaration

The id of the user

$ UboDeclaration#Ubos — Property in class UboDeclaration

Listed representations of natural users declared as UBOs.

UboDeclarationRefusedOrIncompleteReasonType — Class in namespace MangoPay

Holds enumeration of possible reasons why a UBO declaration is refused or incomplete.

UboDeclarationRefusedReasonType — Class in namespace MangoPay

UboDeclarationStatus — Class in namespace MangoPay

Holds enumeration of possible UBO declaration status values.

UboRefusedReasonType — Class in namespace MangoPay

Holds enumeration of reasons why declaration of a user as UBO was refused

User — Class in namespace MangoPay

User entity

$ User#UserCategory — Property in class User

Category of user

UserBlockStatus — Class in namespace MangoPay

UserCategory — Class in namespace MangoPay

User category for clients

UserLegal — Class in namespace MangoPay

UserLegal entity

UserNatural — Class in namespace MangoPay

UserNatural entity

$ VirtualAccountAvailabilities#UserOwned — Property in class VirtualAccountAvailabilities

• @var VirtualAccountAvailability[]

V

ApiCards::ValidateCard() — Method in class ApiCards

Validate a card

ApiUsers::ValidateTheFormatOfUserData() — Method in class ApiUsers

This call allows you to check the validity of the format of a piece of user data, and to retrieve the validation rules applied to it.

$ Card#Validity — Property in class Card

Validity. For allowed values, see constants in MangoPay\CardValidity

$ CardValidation#Validity — Property in class CardValidation

Validity. For allowed values, see constants in MangoPay\CardValidity

$ CheckData#Value — Property in class CheckData

The value of the data point.

$ CompanyNumber#ValidationRules — Property in class CompanyNumber

Validation rules applied for a given country

$ Hook#Validity — Property in class Hook

$ KeyValueArray#Value — Property in class KeyValueArray

Value for tabular variable

$ MangoPayApi#VirtualAccounts — Property in class MangoPayApi

Provides VirtualAccount methods

VirtualAccount — Class in namespace MangoPay

Virtual Account entity

$ VirtualAccount#VirtualAccountPurpose — Property in class VirtualAccount

The type of the virtual account Allowed values: COLLECTION, USER_OWNED

VirtualAccountAddress — Class in namespace MangoPay

VirtualAccountAvailabilities — Class in namespace MangoPay

VirtualAccountAvailability — Class in namespace MangoPay

VirtualAccountCapabilities — Class in namespace MangoPay

VirtualAccountOwner — Class in namespace MangoPay

VirtualAccountPurpose — Class in namespace MangoPay

VirtualAccountStatus — Class in namespace MangoPay

Virtual Account statuses

W

$ BankingAlias#WalletId — Property in class BankingAlias

The ID of a wallet

$ FilterReports#WalletId — Property in class FilterReports

Wallet ID

$ MangoPayApi#Wallets — Property in class MangoPayApi

Wallets methods

$ PayInExecutionDetailsExternalInstruction#WireReference — Property in class PayInExecutionDetailsExternalInstruction

Wire reference.

$ PayInPaymentDetailsBankWire#WireReference — Property in class PayInPaymentDetailsBankWire

Wire reference

$ VirtualAccount#WalletId — Property in class VirtualAccount

The ID of the wallet

Wallet — Class in namespace MangoPay

Wallet entity

_

$ ApiBase#_root — Property in class ApiBase

Root/parent instance that holds the OAuthToken and Configuration instance

ApiBase::__construct() — Method in class ApiBase

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

AuthenticationHelper::__construct() — Method in class AuthenticationHelper

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

AuthorizationTokenManager::__construct() — Method in class AuthorizationTokenManager

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

DefaultStorageStrategy::__construct() — Method in class DefaultStorageStrategy

EntityBase::__construct() — Method in class EntityBase

Construct

Error::__toString() — Method in class Error

Return the stdClass error serialized as string

$ HttpBase#_root — Property in class HttpBase

Root/parent instance that holds the OAuthToken and Configuration instance

HttpBase::__construct() — Method in class HttpBase

Constructor

OAuthToken::__construct() — Method in class OAuthToken

Constructor

ResponseException::__construct() — Method in class ResponseException

Construct

RestTool::__construct() — Method in class RestTool

Constructor

UrlTool::__construct() — Method in class UrlTool

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

MangoPayApi::__construct() — Method in class MangoPayApi

Constructor

Pagination::__construct() — Method in class Pagination

Construct

RateLimit::__construct() — Method in class RateLimit

RateLimit constructor.

UserLegal::__construct() — Method in class UserLegal

Construct

UserNatural::__construct() — Method in class UserNatural

Construct