├── .github ├── dependabot.yml └── workflows │ └── generate-release-tag.yml ├── .gitignore ├── .openapi-generator-ignore ├── .openapi-generator ├── FILES └── VERSION ├── .php-cs-fixer.dist.php ├── LICENSE ├── README.md ├── composer.json ├── docs ├── BalanceAndTransaction │ ├── Balance.md │ ├── ChannelsCategories.md │ ├── Currency.md │ ├── DateRangeFilter.md │ ├── FeeResponse.md │ ├── LinkItem.md │ ├── ServerError.md │ ├── TransactionResponse.md │ ├── TransactionResponseType.md │ ├── TransactionStatuses.md │ ├── TransactionTypes.md │ ├── TransactionsResponse.md │ └── ValidationError.md ├── BalanceApi.md ├── Customer │ ├── AccountBank.md │ ├── AccountCard.md │ ├── AccountEwallet.md │ ├── AccountOTC.md │ ├── AccountPayLater.md │ ├── AccountQRCode.md │ ├── Address.md │ ├── AddressRequest.md │ ├── AddressStatus.md │ ├── BusinessDetail.md │ ├── CreateCustomer400Response.md │ ├── CreateCustomer400ResponseAllOf.md │ ├── Customer.md │ ├── CustomerRequest.md │ ├── EmploymentDetail.md │ ├── EndCustomerStatus.md │ ├── Error.md │ ├── GetCustomerByReferenceID200Response.md │ ├── GetCustomerByReferenceID400Response.md │ ├── GetCustomerByReferenceID400ResponseAllOf.md │ ├── IdentityAccountRequest.md │ ├── IdentityAccountRequestProperties.md │ ├── IdentityAccountResponse.md │ ├── IdentityAccountResponseProperties.md │ ├── IdentityAccountType.md │ ├── IndividualDetail.md │ ├── KYCDocumentRequest.md │ ├── KYCDocumentResponse.md │ ├── KYCDocumentSubType.md │ ├── KYCDocumentType.md │ ├── PatchCustomer.md │ ├── ResponseDataNotFound.md │ ├── UpdateCustomer400Response.md │ └── UpdateCustomer400ResponseAllOf.md ├── CustomerApi.md ├── Invoice │ ├── AddressObject.md │ ├── AlternativeDisplayItem.md │ ├── BadRequestError.md │ ├── Bank.md │ ├── BankCode.md │ ├── ChannelProperties.md │ ├── ChannelPropertiesCards.md │ ├── ChannelPropertiesCardsInstallmentConfiguration.md │ ├── ChannelPropertiesCardsInstallmentConfigurationAllowedTermsInner.md │ ├── CreateInvoiceRequest.md │ ├── CustomerObject.md │ ├── DirectDebit.md │ ├── DirectDebitType.md │ ├── Ewallet.md │ ├── EwalletType.md │ ├── ForbiddenError.md │ ├── Invoice.md │ ├── InvoiceCallback.md │ ├── InvoiceCallbackItem.md │ ├── InvoiceClientType.md │ ├── InvoiceCurrency.md │ ├── InvoiceError404ResponseDefinition.md │ ├── InvoiceFee.md │ ├── InvoiceItem.md │ ├── InvoiceNotFoundError.md │ ├── InvoicePaymentMethod.md │ ├── InvoiceStatus.md │ ├── NotificationChannel.md │ ├── NotificationPreference.md │ ├── Paylater.md │ ├── PaylaterType.md │ ├── PaymentDetails.md │ ├── QrCode.md │ ├── QrCodeType.md │ ├── RetailOutlet.md │ ├── RetailOutletName.md │ ├── ServerError.md │ └── UnauthorizedError.md ├── InvoiceApi.md ├── PaymentMethod │ ├── BillingInformation.md │ ├── Card.md │ ├── CardChannelCode.md │ ├── CardChannelProperties.md │ ├── CardInstallmentConfiguration.md │ ├── CardParameters.md │ ├── CardParametersCardInformation.md │ ├── CardVerificationResults.md │ ├── CardVerificationResultsThreeDSecure.md │ ├── CreatePaymentMethod409Response.md │ ├── CreatePaymentMethod503Response.md │ ├── DirectDebit.md │ ├── DirectDebitAllOf.md │ ├── DirectDebitBankAccount.md │ ├── DirectDebitChannelCode.md │ ├── DirectDebitChannelProperties.md │ ├── DirectDebitDebitCard.md │ ├── DirectDebitParameters.md │ ├── DirectDebitType.md │ ├── EWallet.md │ ├── EWalletAccount.md │ ├── EWalletChannelCode.md │ ├── EWalletChannelProperties.md │ ├── EWalletParameters.md │ ├── GetAllPaymentMethods400Response.md │ ├── GetAllPaymentMethods403Response.md │ ├── GetAllPaymentMethods404Response.md │ ├── GetAllPaymentMethodsDefaultResponse.md │ ├── OverTheCounter.md │ ├── OverTheCounterChannelCode.md │ ├── OverTheCounterChannelProperties.md │ ├── OverTheCounterChannelPropertiesUpdate.md │ ├── OverTheCounterParameters.md │ ├── OverTheCounterUpdateParameters.md │ ├── PaymentMethod.md │ ├── PaymentMethodAction.md │ ├── PaymentMethodAuthParameters.md │ ├── PaymentMethodCallback.md │ ├── PaymentMethodCountry.md │ ├── PaymentMethodExpireParameters.md │ ├── PaymentMethodList.md │ ├── PaymentMethodParameters.md │ ├── PaymentMethodReusability.md │ ├── PaymentMethodStatus.md │ ├── PaymentMethodType.md │ ├── PaymentMethodUpdateParameters.md │ ├── QRCode.md │ ├── QRCodeChannelCode.md │ ├── QRCodeChannelProperties.md │ ├── QRCodeParameters.md │ ├── SimulatePaymentRequest.md │ ├── TokenizedCardInformation.md │ ├── VirtualAccount.md │ ├── VirtualAccountAllOf.md │ ├── VirtualAccountAlternativeDisplay.md │ ├── VirtualAccountChannelCode.md │ ├── VirtualAccountChannelProperties.md │ ├── VirtualAccountChannelPropertiesPatch.md │ ├── VirtualAccountParameters.md │ └── VirtualAccountUpdateParameters.md ├── PaymentMethodApi.md ├── PaymentRequest │ ├── Capture.md │ ├── CaptureListResponse.md │ ├── CaptureParameters.md │ ├── Card.md │ ├── CardChannelCode.md │ ├── CardChannelProperties.md │ ├── CardInformation.md │ ├── CardInstallmentConfiguration.md │ ├── CardParameters.md │ ├── CardVerificationResults.md │ ├── CardVerificationResultsThreeDSecure.md │ ├── DirectDebit.md │ ├── DirectDebitAllOf.md │ ├── DirectDebitBankAccount.md │ ├── DirectDebitChannelCode.md │ ├── DirectDebitChannelProperties.md │ ├── DirectDebitChannelPropertiesBankAccount.md │ ├── DirectDebitChannelPropertiesBankRedirect.md │ ├── DirectDebitChannelPropertiesDebitCard.md │ ├── DirectDebitDebitCard.md │ ├── DirectDebitParameters.md │ ├── DirectDebitType.md │ ├── EWallet.md │ ├── EWalletAccount.md │ ├── EWalletAllOf.md │ ├── EWalletChannelCode.md │ ├── EWalletChannelProperties.md │ ├── EWalletParameters.md │ ├── Error.md │ ├── InvoicePartnerMetadata.md │ ├── OverTheCounter.md │ ├── OverTheCounterChannelCode.md │ ├── OverTheCounterChannelProperties.md │ ├── OverTheCounterParameters.md │ ├── PaymentCallback.md │ ├── PaymentCallbackData.md │ ├── PaymentMethod.md │ ├── PaymentMethodParameters.md │ ├── PaymentMethodReusability.md │ ├── PaymentMethodStatus.md │ ├── PaymentMethodType.md │ ├── PaymentRequest.md │ ├── PaymentRequestAction.md │ ├── PaymentRequestAuthParameters.md │ ├── PaymentRequestBasketItem.md │ ├── PaymentRequestCaptureMethod.md │ ├── PaymentRequestCardVerificationResults.md │ ├── PaymentRequestCardVerificationResultsThreeDeeSecure.md │ ├── PaymentRequestChannelProperties.md │ ├── PaymentRequestCountry.md │ ├── PaymentRequestCurrency.md │ ├── PaymentRequestInitiator.md │ ├── PaymentRequestListResponse.md │ ├── PaymentRequestParameters.md │ ├── PaymentRequestParametersChannelProperties.md │ ├── PaymentRequestParametersChannelPropertiesAllOf.md │ ├── PaymentRequestShippingInformation.md │ ├── PaymentRequestStatus.md │ ├── PaymentSimulation.md │ ├── QRCode.md │ ├── QRCodeChannelCode.md │ ├── QRCodeChannelProperties.md │ ├── QRCodeParameters.md │ ├── VirtualAccount.md │ ├── VirtualAccountAllOf.md │ ├── VirtualAccountAlternativeDisplay.md │ ├── VirtualAccountChannelCode.md │ ├── VirtualAccountChannelProperties.md │ └── VirtualAccountParameters.md ├── PaymentRequestApi.md ├── Payout │ ├── Channel.md │ ├── ChannelAccountType.md │ ├── ChannelAmountLimits.md │ ├── ChannelCategory.md │ ├── CreatePayoutRequest.md │ ├── DigitalPayoutChannelProperties.md │ ├── Error.md │ ├── ErrorErrorsInner.md │ ├── GetPayouts200Response.md │ ├── GetPayouts200ResponseDataInner.md │ ├── GetPayouts200ResponseLinks.md │ ├── Payout.md │ ├── PayoutAllOf.md │ └── ReceiptNotification.md ├── PayoutApi.md ├── Refund │ ├── CreateRefund.md │ ├── CreateRefund400Response.md │ ├── CreateRefund403Response.md │ ├── CreateRefund404Response.md │ ├── CreateRefund409Response.md │ ├── CreateRefund503Response.md │ ├── GetAllRefundsDefaultResponse.md │ ├── Refund.md │ ├── RefundCallback.md │ ├── RefundCallbackData.md │ └── RefundList.md ├── RefundApi.md └── TransactionApi.md ├── images └── header.jpg ├── lib ├── BalanceAndTransaction │ ├── Balance.php │ ├── BalanceApi.php │ ├── ChannelsCategories.php │ ├── Currency.php │ ├── DateRangeFilter.php │ ├── FeeResponse.php │ ├── LinkItem.php │ ├── ServerError.php │ ├── TransactionApi.php │ ├── TransactionResponse.php │ ├── TransactionResponseType.php │ ├── TransactionStatuses.php │ ├── TransactionTypes.php │ ├── TransactionsResponse.php │ └── ValidationError.php ├── Configuration.php ├── Customer │ ├── AccountBank.php │ ├── AccountCard.php │ ├── AccountEwallet.php │ ├── AccountOTC.php │ ├── AccountPayLater.php │ ├── AccountQRCode.php │ ├── Address.php │ ├── AddressRequest.php │ ├── AddressStatus.php │ ├── BusinessDetail.php │ ├── CreateCustomer400Response.php │ ├── CreateCustomer400ResponseAllOf.php │ ├── Customer.php │ ├── CustomerApi.php │ ├── CustomerRequest.php │ ├── EmploymentDetail.php │ ├── EndCustomerStatus.php │ ├── Error.php │ ├── GetCustomerByReferenceID200Response.php │ ├── GetCustomerByReferenceID400Response.php │ ├── GetCustomerByReferenceID400ResponseAllOf.php │ ├── IdentityAccountRequest.php │ ├── IdentityAccountRequestProperties.php │ ├── IdentityAccountResponse.php │ ├── IdentityAccountResponseProperties.php │ ├── IdentityAccountType.php │ ├── IndividualDetail.php │ ├── KYCDocumentRequest.php │ ├── KYCDocumentResponse.php │ ├── KYCDocumentSubType.php │ ├── KYCDocumentType.php │ ├── PatchCustomer.php │ ├── ResponseDataNotFound.php │ ├── UpdateCustomer400Response.php │ └── UpdateCustomer400ResponseAllOf.php ├── HeaderSelector.php ├── Invoice │ ├── AddressObject.php │ ├── AlternativeDisplayItem.php │ ├── BadRequestError.php │ ├── Bank.php │ ├── BankCode.php │ ├── ChannelProperties.php │ ├── ChannelPropertiesCards.php │ ├── ChannelPropertiesCardsInstallmentConfiguration.php │ ├── ChannelPropertiesCardsInstallmentConfigurationAllowedTermsInner.php │ ├── CreateInvoiceRequest.php │ ├── CustomerObject.php │ ├── DirectDebit.php │ ├── DirectDebitType.php │ ├── Ewallet.php │ ├── EwalletType.php │ ├── ForbiddenError.php │ ├── Invoice.php │ ├── InvoiceApi.php │ ├── InvoiceCallback.php │ ├── InvoiceCallbackItem.php │ ├── InvoiceClientType.php │ ├── InvoiceCurrency.php │ ├── InvoiceError404ResponseDefinition.php │ ├── InvoiceFee.php │ ├── InvoiceItem.php │ ├── InvoiceNotFoundError.php │ ├── InvoicePaymentMethod.php │ ├── InvoiceStatus.php │ ├── NotificationChannel.php │ ├── NotificationPreference.php │ ├── Paylater.php │ ├── PaylaterType.php │ ├── PaymentDetails.php │ ├── QrCode.php │ ├── QrCodeType.php │ ├── RetailOutlet.php │ ├── RetailOutletName.php │ ├── ServerError.php │ └── UnauthorizedError.php ├── Model │ └── ModelInterface.php ├── ObjectSerializer.php ├── PaymentMethod │ ├── BillingInformation.php │ ├── Card.php │ ├── CardChannelCode.php │ ├── CardChannelProperties.php │ ├── CardInstallmentConfiguration.php │ ├── CardParameters.php │ ├── CardParametersCardInformation.php │ ├── CardVerificationResults.php │ ├── CardVerificationResultsThreeDSecure.php │ ├── CreatePaymentMethod409Response.php │ ├── CreatePaymentMethod503Response.php │ ├── DirectDebit.php │ ├── DirectDebitAllOf.php │ ├── DirectDebitBankAccount.php │ ├── DirectDebitChannelCode.php │ ├── DirectDebitChannelProperties.php │ ├── DirectDebitDebitCard.php │ ├── DirectDebitParameters.php │ ├── DirectDebitType.php │ ├── EWallet.php │ ├── EWalletAccount.php │ ├── EWalletChannelCode.php │ ├── EWalletChannelProperties.php │ ├── EWalletParameters.php │ ├── GetAllPaymentMethods400Response.php │ ├── GetAllPaymentMethods403Response.php │ ├── GetAllPaymentMethods404Response.php │ ├── GetAllPaymentMethodsDefaultResponse.php │ ├── OverTheCounter.php │ ├── OverTheCounterChannelCode.php │ ├── OverTheCounterChannelProperties.php │ ├── OverTheCounterChannelPropertiesUpdate.php │ ├── OverTheCounterParameters.php │ ├── OverTheCounterUpdateParameters.php │ ├── PaymentMethod.php │ ├── PaymentMethodAction.php │ ├── PaymentMethodApi.php │ ├── PaymentMethodAuthParameters.php │ ├── PaymentMethodCallback.php │ ├── PaymentMethodCountry.php │ ├── PaymentMethodExpireParameters.php │ ├── PaymentMethodList.php │ ├── PaymentMethodParameters.php │ ├── PaymentMethodReusability.php │ ├── PaymentMethodStatus.php │ ├── PaymentMethodType.php │ ├── PaymentMethodUpdateParameters.php │ ├── QRCode.php │ ├── QRCodeChannelCode.php │ ├── QRCodeChannelProperties.php │ ├── QRCodeParameters.php │ ├── SimulatePaymentRequest.php │ ├── TokenizedCardInformation.php │ ├── VirtualAccount.php │ ├── VirtualAccountAllOf.php │ ├── VirtualAccountAlternativeDisplay.php │ ├── VirtualAccountChannelCode.php │ ├── VirtualAccountChannelProperties.php │ ├── VirtualAccountChannelPropertiesPatch.php │ ├── VirtualAccountParameters.php │ └── VirtualAccountUpdateParameters.php ├── PaymentRequest │ ├── Capture.php │ ├── CaptureListResponse.php │ ├── CaptureParameters.php │ ├── Card.php │ ├── CardChannelCode.php │ ├── CardChannelProperties.php │ ├── CardInformation.php │ ├── CardInstallmentConfiguration.php │ ├── CardParameters.php │ ├── CardVerificationResults.php │ ├── CardVerificationResultsThreeDSecure.php │ ├── DirectDebit.php │ ├── DirectDebitAllOf.php │ ├── DirectDebitBankAccount.php │ ├── DirectDebitChannelCode.php │ ├── DirectDebitChannelProperties.php │ ├── DirectDebitChannelPropertiesBankAccount.php │ ├── DirectDebitChannelPropertiesBankRedirect.php │ ├── DirectDebitChannelPropertiesDebitCard.php │ ├── DirectDebitDebitCard.php │ ├── DirectDebitParameters.php │ ├── DirectDebitType.php │ ├── EWallet.php │ ├── EWalletAccount.php │ ├── EWalletAllOf.php │ ├── EWalletChannelCode.php │ ├── EWalletChannelProperties.php │ ├── EWalletParameters.php │ ├── Error.php │ ├── InvoicePartnerMetadata.php │ ├── OverTheCounter.php │ ├── OverTheCounterChannelCode.php │ ├── OverTheCounterChannelProperties.php │ ├── OverTheCounterParameters.php │ ├── PaymentCallback.php │ ├── PaymentCallbackData.php │ ├── PaymentMethod.php │ ├── PaymentMethodParameters.php │ ├── PaymentMethodReusability.php │ ├── PaymentMethodStatus.php │ ├── PaymentMethodType.php │ ├── PaymentRequest.php │ ├── PaymentRequestAction.php │ ├── PaymentRequestApi.php │ ├── PaymentRequestAuthParameters.php │ ├── PaymentRequestBasketItem.php │ ├── PaymentRequestCaptureMethod.php │ ├── PaymentRequestCardVerificationResults.php │ ├── PaymentRequestCardVerificationResultsThreeDeeSecure.php │ ├── PaymentRequestChannelProperties.php │ ├── PaymentRequestCountry.php │ ├── PaymentRequestCurrency.php │ ├── PaymentRequestInitiator.php │ ├── PaymentRequestListResponse.php │ ├── PaymentRequestParameters.php │ ├── PaymentRequestParametersChannelProperties.php │ ├── PaymentRequestParametersChannelPropertiesAllOf.php │ ├── PaymentRequestShippingInformation.php │ ├── PaymentRequestStatus.php │ ├── PaymentSimulation.php │ ├── QRCode.php │ ├── QRCodeChannelCode.php │ ├── QRCodeChannelProperties.php │ ├── QRCodeParameters.php │ ├── VirtualAccount.php │ ├── VirtualAccountAllOf.php │ ├── VirtualAccountAlternativeDisplay.php │ ├── VirtualAccountChannelCode.php │ ├── VirtualAccountChannelProperties.php │ └── VirtualAccountParameters.php ├── Payout │ ├── Channel.php │ ├── ChannelAccountType.php │ ├── ChannelAmountLimits.php │ ├── ChannelCategory.php │ ├── CreatePayoutRequest.php │ ├── DigitalPayoutChannelProperties.php │ ├── Error.php │ ├── ErrorErrorsInner.php │ ├── GetPayouts200Response.php │ ├── GetPayouts200ResponseDataInner.php │ ├── GetPayouts200ResponseLinks.php │ ├── Payout.php │ ├── PayoutAllOf.php │ ├── PayoutApi.php │ └── ReceiptNotification.php ├── Refund │ ├── CreateRefund.php │ ├── CreateRefund400Response.php │ ├── CreateRefund403Response.php │ ├── CreateRefund404Response.php │ ├── CreateRefund409Response.php │ ├── CreateRefund503Response.php │ ├── GetAllRefundsDefaultResponse.php │ ├── Refund.php │ ├── RefundApi.php │ ├── RefundCallback.php │ ├── RefundCallbackData.php │ └── RefundList.php └── XenditSdkException.php ├── phpunit.xml.dist └── test ├── .env.test ├── InvoiceAPITest.php └── PaymentAPITest.php /.github/dependabot.yml: -------------------------------------------------------------------------------- 1 | version: 2 2 | updates: 3 | - package-ecosystem: "composer" # See documentation for possible values 4 | directory: "/" # Location of package manifests 5 | schedule: 6 | interval: "weekly" 7 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # ref: https://github.com/github/gitignore/blob/master/Composer.gitignore 2 | 3 | composer.phar 4 | /vendor/ 5 | 6 | # Commit your application's lock file https://getcomposer.org/doc/01-basic-usage.md#commit-your-composer-lock-file-to-version-control 7 | # You may choose to ignore a library lock file http://getcomposer.org/doc/02-libraries.md#lock-file 8 | # composer.lock 9 | 10 | # php-cs-fixer cache 11 | .php_cs.cache 12 | .php-cs-fixer.cache 13 | 14 | # PHPUnit cache 15 | .phpunit.result.cache 16 | -------------------------------------------------------------------------------- /.openapi-generator-ignore: -------------------------------------------------------------------------------- 1 | # OpenAPI Generator Ignore 2 | # Generated by openapi-generator https://github.com/openapitools/openapi-generator 3 | 4 | # Use this file to prevent files from being overwritten by the generator. 5 | # The patterns follow closely to .gitignore or .dockerignore. 6 | 7 | # As an example, the C# client generator defines ApiClient.cs. 8 | # You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: 9 | #ApiClient.cs 10 | 11 | # You can match any string of characters against a directory, file or extension with a single asterisk (*): 12 | #foo/*/qux 13 | # The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux 14 | 15 | # You can recursively match patterns against a directory, file or extension with a double asterisk (**): 16 | #foo/**/qux 17 | # This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux 18 | 19 | # You can also negate patterns with an exclamation (!). 20 | # For example, you can ignore all files in a docs folder with the file extension .md: 21 | #docs/*.md 22 | # Then explicitly reverse the ignore rule for a single file: 23 | #!docs/README.md 24 | -------------------------------------------------------------------------------- /.openapi-generator/VERSION: -------------------------------------------------------------------------------- 1 | 6.6.0 -------------------------------------------------------------------------------- /.php-cs-fixer.dist.php: -------------------------------------------------------------------------------- 1 | in(__DIR__) 9 | ->exclude('vendor') 10 | ->exclude('test') 11 | ->exclude('tests') 12 | ; 13 | 14 | $config = new PhpCsFixer\Config(); 15 | return $config->setRules([ 16 | '@PSR12' => true, 17 | 'phpdoc_order' => true, 18 | 'array_syntax' => [ 'syntax' => 'short' ], 19 | 'strict_comparison' => true, 20 | 'strict_param' => true, 21 | 'no_trailing_whitespace' => false, 22 | 'no_trailing_whitespace_in_comment' => false, 23 | 'braces' => false, 24 | 'single_blank_line_at_eof' => false, 25 | 'blank_line_after_namespace' => false, 26 | 'no_leading_import_slash' => false, 27 | ]) 28 | ->setFinder($finder) 29 | ; 30 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2017-2025 Xendit 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. -------------------------------------------------------------------------------- /composer.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "xendit/xendit-php", 3 | "version": "7.0.0", 4 | "description": "Xendit PHP SDK", 5 | "keywords": [ 6 | "openapitools", 7 | "openapi-generator", 8 | "openapi", 9 | "php", 10 | "sdk", 11 | "rest", 12 | "api" 13 | ], 14 | "homepage": "https://openapi-generator.tech", 15 | "license": "unlicense", 16 | "authors": [ 17 | { 18 | "name": "OpenAPI-Generator contributors", 19 | "homepage": "https://openapi-generator.tech" 20 | } 21 | ], 22 | "require": { 23 | "php": "^7.4 || ^8.0", 24 | "ext-curl": "*", 25 | "ext-json": "*", 26 | "ext-mbstring": "*", 27 | "guzzlehttp/guzzle": "^7.3", 28 | "guzzlehttp/psr7": "^1.7 || ^2.0", 29 | "vlucas/phpdotenv": "^5.5" 30 | }, 31 | "require-dev": { 32 | "phpunit/phpunit": "^8.0 || ^9.0", 33 | "friendsofphp/php-cs-fixer": "^3.5" 34 | }, 35 | "autoload": { 36 | "psr-4": { "Xendit\\" : "lib/" } 37 | }, 38 | "autoload-dev": { 39 | "psr-4": { "Xendit\\Test\\" : "test/" } 40 | }, 41 | "scripts": { 42 | "test": "DEVELOPMENT_API_KEY=$DEVELOPMENT_API_KEY BUSINESS_ID=$BUSINESS_ID phpunit", 43 | "filtered-test": "DEVELOPMENT_API_KEY=$DEVELOPMENT_API_KEY BUSINESS_ID=$BUSINESS_ID phpunit --filter PaymentAPITest" 44 | } 45 | } 46 | -------------------------------------------------------------------------------- /docs/BalanceAndTransaction/Balance.md: -------------------------------------------------------------------------------- 1 | # # Balance 2 | The balance remaining in your account 3 | 4 | ```php 5 | use Xendit\BalanceAndTransaction\Balance; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **balance** | **float** | ☑️ | | 123000.12 | 13 | 14 | 15 | [[Back to README]](../../README.md) 16 | -------------------------------------------------------------------------------- /docs/BalanceAndTransaction/ChannelsCategories.md: -------------------------------------------------------------------------------- 1 | # # ChannelsCategories 2 | 3 | 4 | ```php 5 | use Xendit\BalanceAndTransaction\ChannelsCategories; 6 | ``` 7 | 8 | 9 | ## Enum 10 | 11 | 12 | * `BANK` (value: `'BANK'`) 13 | 14 | * `CARDLESS_CREDIT` (value: `'CARDLESS_CREDIT'`) 15 | 16 | * `PAYLATER` (value: `'PAYLATER'`) 17 | 18 | * `CARDS` (value: `'CARDS'`) 19 | 20 | * `CASH` (value: `'CASH'`) 21 | 22 | * `DIRECT_DEBIT` (value: `'DIRECT_DEBIT'`) 23 | 24 | * `EWALLET` (value: `'EWALLET'`) 25 | 26 | * `INVOICE` (value: `'INVOICE'`) 27 | 28 | * `QR_CODE` (value: `'QR_CODE'`) 29 | 30 | * `RETAIL_OUTLET` (value: `'RETAIL_OUTLET'`) 31 | 32 | * `VIRTUAL_ACCOUNT` (value: `'VIRTUAL_ACCOUNT'`) 33 | 34 | * `XENPLATFORM` (value: `'XENPLATFORM'`) 35 | 36 | * `DIRECT_BANK_TRANSFER` (value: `'DIRECT_BANK_TRANSFER'`) 37 | 38 | * `OTHER` (value: `'OTHER'`) 39 | 40 | * `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) 41 | 42 | If you encounter `UNKNOWN_ENUM_VALUE`, it means that this ENUM is unavailable in your current SDK version. Please upgrade to get the newest ENUM. 43 | 44 | [[Back to README]](../../README.md) 45 | -------------------------------------------------------------------------------- /docs/BalanceAndTransaction/DateRangeFilter.md: -------------------------------------------------------------------------------- 1 | # # DateRangeFilter 2 | 3 | 4 | ```php 5 | use Xendit\BalanceAndTransaction\DateRangeFilter; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **gte** | **\DateTime** | | Start time of transaction. If not specified will list all dates. | 2020-08-29T17:00Z | 13 | | **lte** | **\DateTime** | | End time of transaction. If not specified will list all dates. | 2020-08-29T17:00Z | 14 | 15 | 16 | [[Back to README]](../../README.md) 17 | -------------------------------------------------------------------------------- /docs/BalanceAndTransaction/FeeResponse.md: -------------------------------------------------------------------------------- 1 | # # FeeResponse 2 | 3 | 4 | ```php 5 | use Xendit\BalanceAndTransaction\FeeResponse; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **xendit_fee** | **float** | ☑️ | Amount of the Xendit fee for this transaction. | 10 | 13 | | **value_added_tax** | **float** | ☑️ | Amount of the VAT for this transaction. | 1 | 14 | | **xendit_withholding_tax** | **float** | | Amount of the Xendit Withholding Tax for this transaction if applicable. See [Tax Documentation](https://docs.xendit.co/fees-and-vat#vat) for more information. | 10 | 15 | | **third_party_withholding_tax** | **float** | | Amount of the 3rd Party Withholding Tax for this transaction if applicable. 3rd party example: Bank | 10 | 16 | | **status** | **string** | | | null | 17 | 18 | 19 | [[Back to README]](../../README.md) 20 | -------------------------------------------------------------------------------- /docs/BalanceAndTransaction/LinkItem.md: -------------------------------------------------------------------------------- 1 | # # LinkItem 2 | 3 | 4 | ```php 5 | use Xendit\BalanceAndTransaction\LinkItem; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **href** | **string** | ☑️ | URI of target, this will be to the next link. | /transactions?types=PAYMENT&statuses=SUCCESS&channel_categories=EWALLET&channel_categories=RETAIL_OUTLET&limit=2&after_id=txn_a765a3f0-34c0-41ee-8686-bca11835ebdc | 13 | | **rel** | **string** | ☑️ | The relationship between source and target. The value will be `next`. | next | 14 | | **method** | **string** | ☑️ | The HTTP method, the value will be `GET`. | GET | 15 | 16 | 17 | [[Back to README]](../../README.md) 18 | -------------------------------------------------------------------------------- /docs/BalanceAndTransaction/ServerError.md: -------------------------------------------------------------------------------- 1 | # # ServerError 2 | 3 | 4 | ```php 5 | use Xendit\BalanceAndTransaction\ServerError; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **status_code** | **float** | ☑️ | | 500 | 13 | | **error** | **string** | ☑️ | | Internal Server Error | 14 | | **message** | **string** | ☑️ | | An internal server error occurred | 15 | 16 | 17 | [[Back to README]](../../README.md) 18 | -------------------------------------------------------------------------------- /docs/BalanceAndTransaction/TransactionResponseType.md: -------------------------------------------------------------------------------- 1 | # # TransactionResponseType 2 | The type of the transactions. 3 | 4 | ```php 5 | use Xendit\BalanceAndTransaction\TransactionResponseType; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | 13 | 14 | [[Back to README]](../../README.md) 15 | -------------------------------------------------------------------------------- /docs/BalanceAndTransaction/TransactionStatuses.md: -------------------------------------------------------------------------------- 1 | # # TransactionStatuses 2 | 3 | 4 | ```php 5 | use Xendit\BalanceAndTransaction\TransactionStatuses; 6 | ``` 7 | 8 | 9 | ## Enum 10 | 11 | 12 | * `SUCCESS` (value: `'SUCCESS'`) 13 | 14 | * `PENDING` (value: `'PENDING'`) 15 | 16 | * `FAILED` (value: `'FAILED'`) 17 | 18 | * `REVERSED` (value: `'REVERSED'`) 19 | 20 | * `VOIDED` (value: `'VOIDED'`) 21 | 22 | * `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) 23 | 24 | If you encounter `UNKNOWN_ENUM_VALUE`, it means that this ENUM is unavailable in your current SDK version. Please upgrade to get the newest ENUM. 25 | 26 | [[Back to README]](../../README.md) 27 | -------------------------------------------------------------------------------- /docs/BalanceAndTransaction/TransactionTypes.md: -------------------------------------------------------------------------------- 1 | # # TransactionTypes 2 | 3 | 4 | ```php 5 | use Xendit\BalanceAndTransaction\TransactionTypes; 6 | ``` 7 | 8 | 9 | ## Enum 10 | 11 | 12 | * `BATCH_DISBURSEMENT` (value: `'BATCH_DISBURSEMENT'`) 13 | 14 | * `DISBURSEMENT` (value: `'DISBURSEMENT'`) 15 | 16 | * `PAYMENT` (value: `'PAYMENT'`) 17 | 18 | * `REMITTANCE` (value: `'REMITTANCE'`) 19 | 20 | * `REMITTANCE_PAYOUT` (value: `'REMITTANCE_PAYOUT'`) 21 | 22 | * `REMITTANCE_COLLECTION` (value: `'REMITTANCE_COLLECTION'`) 23 | 24 | * `TRANSFER` (value: `'TRANSFER'`) 25 | 26 | * `PLATFORM_FEE` (value: `'PLATFORM_FEE'`) 27 | 28 | * `REFUND` (value: `'REFUND'`) 29 | 30 | * `CASHBACK` (value: `'CASHBACK'`) 31 | 32 | * `TOPUP` (value: `'TOPUP'`) 33 | 34 | * `WITHDRAWAL` (value: `'WITHDRAWAL'`) 35 | 36 | * `OTHER` (value: `'OTHER'`) 37 | 38 | * `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) 39 | 40 | If you encounter `UNKNOWN_ENUM_VALUE`, it means that this ENUM is unavailable in your current SDK version. Please upgrade to get the newest ENUM. 41 | 42 | [[Back to README]](../../README.md) 43 | -------------------------------------------------------------------------------- /docs/BalanceAndTransaction/TransactionsResponse.md: -------------------------------------------------------------------------------- 1 | # # TransactionsResponse 2 | Returns an array of Transaction Objects. Returns empty array when there is no result. 3 | 4 | ```php 5 | use Xendit\BalanceAndTransaction\TransactionsResponse; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **has_more** | **bool** | ☑️ | Indicates whether there are more items to be queried with `after_id` of the last item from the current result. Use the `links` to follow to the next result. | null | 13 | | **links** | [**array**](LinkItem.md) | | The links to the next page based on LinkItem if there is next result. | null | 14 | | **data** | [**array**](TransactionResponse.md) | ☑️ | | null | 15 | 16 | 17 | [[Back to README]](../../README.md) 18 | -------------------------------------------------------------------------------- /docs/BalanceAndTransaction/ValidationError.md: -------------------------------------------------------------------------------- 1 | # # ValidationError 2 | 3 | 4 | ```php 5 | use Xendit\BalanceAndTransaction\ValidationError; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **status_code** | **float** | ☑️ | | 400 | 13 | | **error** | **string** | ☑️ | | API_VALIDATION_ERROR | 14 | | **message** | **string** | ☑️ | | \"from\" is required. \"status\" is required. \"currency\" is required | 15 | | **validation** | **object** | | | {"source":"query","keys":["from","status","currency"]} | 16 | 17 | 18 | [[Back to README]](../../README.md) 19 | -------------------------------------------------------------------------------- /docs/Customer/AccountBank.md: -------------------------------------------------------------------------------- 1 | # # AccountBank 2 | 3 | 4 | ```php 5 | use Xendit\Customer\AccountBank; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **account_number** | **string** | | Unique account identifier as per the bank records. | null | 13 | | **account_holder_name** | **string** | | Name of account holder as per the bank records. Needs to match the registered account name exactly. . | null | 14 | | **swift_code** | **string** | | The SWIFT code for international payments | null | 15 | | **account_type** | **string** | | Free text account type, e.g., Savings, Transaction, Virtual Account. | null | 16 | | **account_details** | **string** | | Potentially masked account detail, for display purposes only. | null | 17 | | **currency** | **string** | | | null | 18 | 19 | 20 | [[Back to README]](../../README.md) 21 | -------------------------------------------------------------------------------- /docs/Customer/AccountCard.md: -------------------------------------------------------------------------------- 1 | # # AccountCard 2 | 3 | 4 | ```php 5 | use Xendit\Customer\AccountCard; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **token_id** | **string** | | The token id returned in tokenisation | null | 13 | 14 | 15 | [[Back to README]](../../README.md) 16 | -------------------------------------------------------------------------------- /docs/Customer/AccountEwallet.md: -------------------------------------------------------------------------------- 1 | # # AccountEwallet 2 | 3 | 4 | ```php 5 | use Xendit\Customer\AccountEwallet; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **account_number** | **string** | | Unique account identifier as per the bank records. | null | 13 | | **account_holder_name** | **string** | | Name of account holder as per the bank records. Needs to match the registered account name exactly. | null | 14 | | **currency** | **string** | | | null | 15 | 16 | 17 | [[Back to README]](../../README.md) 18 | -------------------------------------------------------------------------------- /docs/Customer/AccountOTC.md: -------------------------------------------------------------------------------- 1 | # # AccountOTC 2 | 3 | 4 | ```php 5 | use Xendit\Customer\AccountOTC; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **payment_code** | **string** | | Complete fixed payment code (including prefix) | null | 13 | | **expires_at** | **string** | | YYYY-MM-DD string with expiry date for the payment code | null | 14 | 15 | 16 | [[Back to README]](../../README.md) 17 | -------------------------------------------------------------------------------- /docs/Customer/AccountPayLater.md: -------------------------------------------------------------------------------- 1 | # # AccountPayLater 2 | 3 | 4 | ```php 5 | use Xendit\Customer\AccountPayLater; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **account_id** | **string** | | Alphanumeric string identifying this account. Usually an email address or phone number. | null | 13 | | **account_holder_name** | **string** | | Name of account holder as per the cardless credit account. | null | 14 | | **currency** | **string** | | | null | 15 | 16 | 17 | [[Back to README]](../../README.md) 18 | -------------------------------------------------------------------------------- /docs/Customer/AccountQRCode.md: -------------------------------------------------------------------------------- 1 | # # AccountQRCode 2 | 3 | 4 | ```php 5 | use Xendit\Customer\AccountQRCode; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **qr_string** | **string** | | String representation of the QR Code image | null | 13 | 14 | 15 | [[Back to README]](../../README.md) 16 | -------------------------------------------------------------------------------- /docs/Customer/Address.md: -------------------------------------------------------------------------------- 1 | # # Address 2 | 3 | 4 | ```php 5 | use Xendit\Customer\Address; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **id** | **string** | | | d290f1ee-6c54-4b01-90e6-d701748f0851 | 13 | | **category** | **string** | ☑️ | | null | 14 | | **country** | **string** | ☑️ | | null | 15 | | **province_state** | **string** | ☑️ | | null | 16 | | **city** | **string** | ☑️ | | null | 17 | | **postal_code** | **string** | ☑️ | | null | 18 | | **street_line1** | **string** | ☑️ | | null | 19 | | **street_line2** | **string** | ☑️ | | null | 20 | | **status** | [**AddressStatus**](AddressStatus.md) | | | null | 21 | | **is_primary** | **bool** | ☑️ | | null | 22 | | **meta** | **object** | | | null | 23 | | **created** | **\DateTime** | | | 2016-08-29T09:12:33.001Z | 24 | | **updated** | **\DateTime** | | | 2016-08-29T09:12:33.001Z | 25 | 26 | 27 | [[Back to README]](../../README.md) 28 | -------------------------------------------------------------------------------- /docs/Customer/AddressRequest.md: -------------------------------------------------------------------------------- 1 | # # AddressRequest 2 | 3 | 4 | ```php 5 | use Xendit\Customer\AddressRequest; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **category** | **string** | | Home, work or provincial | null | 13 | | **country_code** | **string** | | ISO3166-2 country code | ID | 14 | | **province_state** | **string** | | | null | 15 | | **city** | **string** | | | null | 16 | | **suburb** | **string** | | | null | 17 | | **postal_code** | **string** | | | null | 18 | | **line_1** | **string** | | | null | 19 | | **line_2** | **string** | | | null | 20 | | **status** | [**AddressStatus**](AddressStatus.md) | | | null | 21 | | **is_primary** | **bool** | | | null | 22 | 23 | 24 | [[Back to README]](../../README.md) 25 | -------------------------------------------------------------------------------- /docs/Customer/AddressStatus.md: -------------------------------------------------------------------------------- 1 | # # AddressStatus 2 | 3 | 4 | ```php 5 | use Xendit\Customer\AddressStatus; 6 | ``` 7 | 8 | 9 | ## Enum 10 | 11 | 12 | * `ACTIVE` (value: `'ACTIVE'`) 13 | 14 | * `DELETED` (value: `'DELETED'`) 15 | 16 | * `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) 17 | 18 | If you encounter `UNKNOWN_ENUM_VALUE`, it means that this ENUM is unavailable in your current SDK version. Please upgrade to get the newest ENUM. 19 | 20 | [[Back to README]](../../README.md) 21 | -------------------------------------------------------------------------------- /docs/Customer/BusinessDetail.md: -------------------------------------------------------------------------------- 1 | # # BusinessDetail 2 | 3 | 4 | ```php 5 | use Xendit\Customer\BusinessDetail; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **business_name** | **string** | | | null | 13 | | **business_type** | **string** | | | null | 14 | | **date_of_registration** | **string** | | | 2017-07-21 | 15 | | **nature_of_business** | **string** | | | null | 16 | | **business_domicile** | **string** | | ISO3166-2 country code | ID | 17 | 18 | 19 | [[Back to README]](../../README.md) 20 | -------------------------------------------------------------------------------- /docs/Customer/CreateCustomer400Response.md: -------------------------------------------------------------------------------- 1 | # # CreateCustomer400Response 2 | 3 | 4 | ```php 5 | use Xendit\Customer\CreateCustomer400Response; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **error_code** | **string** | ☑️ | | DUPLICATE_END_CUSTOMER_ERROR | 13 | | **message** | **mixed** | ☑️ | | Client reference already exist | 14 | | **errors** | **object[]** | | | null | 15 | 16 | 17 | [[Back to README]](../../README.md) 18 | -------------------------------------------------------------------------------- /docs/Customer/CreateCustomer400ResponseAllOf.md: -------------------------------------------------------------------------------- 1 | # # CreateCustomer400ResponseAllOf 2 | 3 | 4 | ```php 5 | use Xendit\Customer\CreateCustomer400ResponseAllOf; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **error_code** | **string** | | | DUPLICATE_END_CUSTOMER_ERROR | 13 | | **message** | **mixed** | | | Client reference already exist | 14 | 15 | 16 | [[Back to README]](../../README.md) 17 | -------------------------------------------------------------------------------- /docs/Customer/Customer.md: -------------------------------------------------------------------------------- 1 | # # Customer 2 | 3 | 4 | ```php 5 | use Xendit\Customer\Customer; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **type** | **string** | ☑️ | | null | 13 | | **reference_id** | **string** | ☑️ | Merchant's reference of this end customer, eg Merchant's user's id. Must be unique. | null | 14 | | **individual_detail** | [**IndividualDetail**](IndividualDetail.md) | ☑️ | | null | 15 | | **business_detail** | [**BusinessDetail**](BusinessDetail.md) | ☑️ | | null | 16 | | **description** | **string** | ☑️ | | null | 17 | | **email** | **string** | ☑️ | | info@xendit.co | 18 | | **mobile_number** | **string** | ☑️ | | +6281295412345 | 19 | | **phone_number** | **string** | ☑️ | | +6281295412345 | 20 | | **addresses** | [**array**](Address.md) | ☑️ | | null | 21 | | **identity_accounts** | [**array**](IdentityAccountResponse.md) | ☑️ | | null | 22 | | **kyc_documents** | [**array**](KYCDocumentResponse.md) | ☑️ | | null | 23 | | **metadata** | **object** | ☑️ | | null | 24 | | **status** | [**EndCustomerStatus**](EndCustomerStatus.md) | | | null | 25 | | **id** | **string** | ☑️ | | null | 26 | | **created** | **\DateTime** | ☑️ | | 2016-08-29T09:12:33.001Z | 27 | | **updated** | **\DateTime** | ☑️ | | 2016-08-29T09:12:33.001Z | 28 | 29 | 30 | [[Back to README]](../../README.md) 31 | -------------------------------------------------------------------------------- /docs/Customer/CustomerRequest.md: -------------------------------------------------------------------------------- 1 | # # CustomerRequest 2 | 3 | 4 | ```php 5 | use Xendit\Customer\CustomerRequest; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **client_name** | **string** | | Entity's name for this client | AirAsia Indonesia | 13 | | **reference_id** | **string** | ☑️ | Merchant's reference of this end customer, eg Merchant's user's id. Must be unique. | null | 14 | | **type** | **string** | | | null | 15 | | **individual_detail** | [**IndividualDetail**](IndividualDetail.md) | | | null | 16 | | **business_detail** | [**BusinessDetail**](BusinessDetail.md) | | | null | 17 | | **description** | **string** | | | null | 18 | | **email** | **string** | | | info@xendit.co | 19 | | **mobile_number** | **string** | | | +6281295412345 | 20 | | **phone_number** | **string** | | | +6281295412345 | 21 | | **addresses** | [**array**](AddressRequest.md) | | | null | 22 | | **identity_accounts** | [**array**](IdentityAccountRequest.md) | | | null | 23 | | **kyc_documents** | [**array**](KYCDocumentRequest.md) | | | null | 24 | | **metadata** | **object** | | | null | 25 | 26 | 27 | [[Back to README]](../../README.md) 28 | -------------------------------------------------------------------------------- /docs/Customer/EmploymentDetail.md: -------------------------------------------------------------------------------- 1 | # # EmploymentDetail 2 | 3 | 4 | ```php 5 | use Xendit\Customer\EmploymentDetail; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **employer_name** | **string** | | Name of employer | null | 13 | | **nature_of_business** | **string** | | Industry or nature of business | null | 14 | | **role_description** | **string** | | Occupation or title | null | 15 | 16 | 17 | [[Back to README]](../../README.md) 18 | -------------------------------------------------------------------------------- /docs/Customer/EndCustomerStatus.md: -------------------------------------------------------------------------------- 1 | # # EndCustomerStatus 2 | 3 | 4 | ```php 5 | use Xendit\Customer\EndCustomerStatus; 6 | ``` 7 | 8 | 9 | ## Enum 10 | 11 | 12 | * `ACTIVE` (value: `'ACTIVE'`) 13 | 14 | * `INACTIVE` (value: `'INACTIVE'`) 15 | 16 | * `PENDING` (value: `'PENDING'`) 17 | 18 | * `BLOCKED` (value: `'BLOCKED'`) 19 | 20 | * `DELETED` (value: `'DELETED'`) 21 | 22 | * `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) 23 | 24 | If you encounter `UNKNOWN_ENUM_VALUE`, it means that this ENUM is unavailable in your current SDK version. Please upgrade to get the newest ENUM. 25 | 26 | [[Back to README]](../../README.md) 27 | -------------------------------------------------------------------------------- /docs/Customer/Error.md: -------------------------------------------------------------------------------- 1 | # # Error 2 | 3 | 4 | ```php 5 | use Xendit\Customer\Error; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **error_code** | **string** | ☑️ | | SERVER_ERROR | 13 | | **message** | **string** | ☑️ | | Something unexpected happened, we are investigating this issue right now | 14 | | **errors** | **object[]** | | | null | 15 | 16 | 17 | [[Back to README]](../../README.md) 18 | -------------------------------------------------------------------------------- /docs/Customer/GetCustomerByReferenceID200Response.md: -------------------------------------------------------------------------------- 1 | # # GetCustomerByReferenceID200Response 2 | 3 | 4 | ```php 5 | use Xendit\Customer\GetCustomerByReferenceID200Response; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **has_more** | **bool** | | | null | 13 | | **data** | [**array**](Customer.md) | | | null | 14 | 15 | 16 | [[Back to README]](../../README.md) 17 | -------------------------------------------------------------------------------- /docs/Customer/GetCustomerByReferenceID400Response.md: -------------------------------------------------------------------------------- 1 | # # GetCustomerByReferenceID400Response 2 | 3 | 4 | ```php 5 | use Xendit\Customer\GetCustomerByReferenceID400Response; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **error_code** | **string** | ☑️ | | ENTITY_NOT_FOUND_ERROR | 13 | | **message** | **mixed** | ☑️ | | Entity does not exist | 14 | | **errors** | **object[]** | | | null | 15 | 16 | 17 | [[Back to README]](../../README.md) 18 | -------------------------------------------------------------------------------- /docs/Customer/GetCustomerByReferenceID400ResponseAllOf.md: -------------------------------------------------------------------------------- 1 | # # GetCustomerByReferenceID400ResponseAllOf 2 | 3 | 4 | ```php 5 | use Xendit\Customer\GetCustomerByReferenceID400ResponseAllOf; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **error_code** | **string** | | | ENTITY_NOT_FOUND_ERROR | 13 | | **message** | **mixed** | | | Entity does not exist | 14 | 15 | 16 | [[Back to README]](../../README.md) 17 | -------------------------------------------------------------------------------- /docs/Customer/IdentityAccountRequest.md: -------------------------------------------------------------------------------- 1 | # # IdentityAccountRequest 2 | 3 | 4 | ```php 5 | use Xendit\Customer\IdentityAccountRequest; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **type** | [**IdentityAccountType**](IdentityAccountType.md) | | | null | 13 | | **company** | **string** | | The issuing institution associated with the account (e.g., OCBC, GOPAY, 7-11). If adding financial accounts that Xendit supports, we recommend you use the channel_name found at https://xendit.github.io/apireference/#payment-channels for this field | null | 14 | | **description** | **string** | | Free text description of this account | null | 15 | | **country** | **string** | | ISO3166-2 country code | ID | 16 | | **properties** | [**IdentityAccountRequestProperties**](IdentityAccountRequestProperties.md) | | | null | 17 | 18 | 19 | [[Back to README]](../../README.md) 20 | -------------------------------------------------------------------------------- /docs/Customer/IdentityAccountRequestProperties.md: -------------------------------------------------------------------------------- 1 | # # IdentityAccountRequestProperties 2 | 3 | 4 | ```php 5 | use Xendit\Customer\IdentityAccountRequestProperties; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **account_number** | **string** | | Unique account identifier as per the bank records. | null | 13 | | **account_holder_name** | **string** | | Name of account holder as per the cardless credit account. | null | 14 | | **swift_code** | **string** | | The SWIFT code for international payments | null | 15 | | **account_type** | **string** | | Free text account type, e.g., Savings, Transaction, Virtual Account. | null | 16 | | **account_details** | **string** | | Potentially masked account detail, for display purposes only. | null | 17 | | **currency** | **string** | | | null | 18 | | **token_id** | **string** | | The token id returned in tokenisation | null | 19 | | **account_id** | **string** | | Alphanumeric string identifying this account. Usually an email address or phone number. | null | 20 | | **payment_code** | **string** | | Complete fixed payment code (including prefix) | null | 21 | | **expires_at** | **string** | | YYYY-MM-DD string with expiry date for the payment code | null | 22 | | **qr_string** | **string** | | String representation of the QR Code image | null | 23 | 24 | 25 | [[Back to README]](../../README.md) 26 | -------------------------------------------------------------------------------- /docs/Customer/IdentityAccountResponse.md: -------------------------------------------------------------------------------- 1 | # # IdentityAccountResponse 2 | 3 | 4 | ```php 5 | use Xendit\Customer\IdentityAccountResponse; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **id** | **string** | | | d290f1ee-6c54-4b01-90e6-d701748f0851 | 13 | | **code** | **string** | | | null | 14 | | **company** | **string** | ☑️ | | null | 15 | | **description** | **string** | ☑️ | | null | 16 | | **country** | **string** | ☑️ | ISO3166-2 country code | ID | 17 | | **holder_name** | **string** | | | null | 18 | | **type** | **string** | ☑️ | | null | 19 | | **properties** | [**IdentityAccountResponseProperties**](IdentityAccountResponseProperties.md) | ☑️ | | null | 20 | | **created** | **\DateTime** | | | 2016-08-29T09:12:33.001Z | 21 | 22 | 23 | [[Back to README]](../../README.md) 24 | -------------------------------------------------------------------------------- /docs/Customer/IdentityAccountResponseProperties.md: -------------------------------------------------------------------------------- 1 | # # IdentityAccountResponseProperties 2 | 3 | 4 | ```php 5 | use Xendit\Customer\IdentityAccountResponseProperties; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **account_number** | **string** | | Unique account identifier as per the bank records. | null | 13 | | **account_holder_name** | **string** | | Name of account holder as per the cardless credit account. | null | 14 | | **swift_code** | **string** | | The SWIFT code for international payments | null | 15 | | **account_type** | **string** | | Free text account type, e.g., Savings, Transaction, Virtual Account. | null | 16 | | **account_details** | **string** | | Potentially masked account detail, for display purposes only. | null | 17 | | **currency** | **string** | | | null | 18 | | **token_id** | **string** | | The token id returned in tokenisation | null | 19 | | **payment_code** | **string** | | Complete fixed payment code (including prefix) | null | 20 | | **expires_at** | **string** | | YYYY-MM-DD string with expiry date for the payment code | null | 21 | | **qr_string** | **string** | | String representation of the QR Code image | null | 22 | | **account_id** | **string** | | Alphanumeric string identifying this account. Usually an email address or phone number. | null | 23 | 24 | 25 | [[Back to README]](../../README.md) 26 | -------------------------------------------------------------------------------- /docs/Customer/IdentityAccountType.md: -------------------------------------------------------------------------------- 1 | # # IdentityAccountType 2 | 3 | 4 | ```php 5 | use Xendit\Customer\IdentityAccountType; 6 | ``` 7 | 8 | 9 | ## Enum 10 | 11 | 12 | * `BANK_ACCOUNT` (value: `'BANK_ACCOUNT'`) 13 | 14 | * `EWALLET` (value: `'EWALLET'`) 15 | 16 | * `CREDIT_CARD` (value: `'CREDIT_CARD'`) 17 | 18 | * `PAY_LATER` (value: `'PAY_LATER'`) 19 | 20 | * `OTC` (value: `'OTC'`) 21 | 22 | * `QR_CODE` (value: `'QR_CODE'`) 23 | 24 | * `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) 25 | 26 | If you encounter `UNKNOWN_ENUM_VALUE`, it means that this ENUM is unavailable in your current SDK version. Please upgrade to get the newest ENUM. 27 | 28 | [[Back to README]](../../README.md) 29 | -------------------------------------------------------------------------------- /docs/Customer/IndividualDetail.md: -------------------------------------------------------------------------------- 1 | # # IndividualDetail 2 | 3 | 4 | ```php 5 | use Xendit\Customer\IndividualDetail; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **given_names** | **string** | | | null | 13 | | **given_names_non_roman** | **string** | | | null | 14 | | **middle_name** | **string** | | | null | 15 | | **surname** | **string** | | | null | 16 | | **surname_non_roman** | **string** | | | null | 17 | | **mother_maiden_name** | **string** | | | null | 18 | | **gender** | **string** | | | null | 19 | | **date_of_birth** | **string** | | | 2017-07-21 | 20 | | **nationality** | **string** | | ISO3166-2 country code | ID | 21 | | **place_of_birth** | **string** | | | null | 22 | | **employment** | [**EmploymentDetail**](EmploymentDetail.md) | | | null | 23 | 24 | 25 | [[Back to README]](../../README.md) 26 | -------------------------------------------------------------------------------- /docs/Customer/KYCDocumentRequest.md: -------------------------------------------------------------------------------- 1 | # # KYCDocumentRequest 2 | 3 | 4 | ```php 5 | use Xendit\Customer\KYCDocumentRequest; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **country** | **string** | | ISO3166-2 country code | ID | 13 | | **type** | [**KYCDocumentType**](KYCDocumentType.md) | | | null | 14 | | **sub_type** | [**KYCDocumentSubType**](KYCDocumentSubType.md) | | | null | 15 | | **document_name** | **string** | | | KTP | 16 | | **document_number** | **string** | | | AA123467890 | 17 | | **expires_at** | **string** | | | 2017-07-21 | 18 | | **holder_name** | **string** | | | John Doe | 19 | | **document_images** | **string[]** | | | null | 20 | 21 | 22 | [[Back to README]](../../README.md) 23 | -------------------------------------------------------------------------------- /docs/Customer/KYCDocumentResponse.md: -------------------------------------------------------------------------------- 1 | # # KYCDocumentResponse 2 | 3 | 4 | ```php 5 | use Xendit\Customer\KYCDocumentResponse; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **country** | **string** | ☑️ | | null | 13 | | **type** | [**KYCDocumentType**](KYCDocumentType.md) | ☑️ | | null | 14 | | **sub_type** | [**KYCDocumentSubType**](KYCDocumentSubType.md) | ☑️ | | null | 15 | | **document_name** | **string** | ☑️ | | null | 16 | | **document_number** | **string** | ☑️ | | null | 17 | | **expires_at** | **string** | ☑️ | | null | 18 | | **holder_name** | **string** | ☑️ | | null | 19 | | **document_images** | **string[]** | ☑️ | | null | 20 | 21 | 22 | [[Back to README]](../../README.md) 23 | -------------------------------------------------------------------------------- /docs/Customer/KYCDocumentSubType.md: -------------------------------------------------------------------------------- 1 | # # KYCDocumentSubType 2 | 3 | 4 | ```php 5 | use Xendit\Customer\KYCDocumentSubType; 6 | ``` 7 | 8 | 9 | ## Enum 10 | 11 | 12 | * `NATIONAL_ID` (value: `'NATIONAL_ID'`) 13 | 14 | * `CONSULAR_ID` (value: `'CONSULAR_ID'`) 15 | 16 | * `VOTER_ID` (value: `'VOTER_ID'`) 17 | 18 | * `POSTAL_ID` (value: `'POSTAL_ID'`) 19 | 20 | * `RESIDENCE_PERMIT` (value: `'RESIDENCE_PERMIT'`) 21 | 22 | * `TAX_ID` (value: `'TAX_ID'`) 23 | 24 | * `STUDENT_ID` (value: `'STUDENT_ID'`) 25 | 26 | * `MILITARY_ID` (value: `'MILITARY_ID'`) 27 | 28 | * `MEDICAL_ID` (value: `'MEDICAL_ID'`) 29 | 30 | * `OTHERS` (value: `'OTHERS'`) 31 | 32 | * `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) 33 | 34 | If you encounter `UNKNOWN_ENUM_VALUE`, it means that this ENUM is unavailable in your current SDK version. Please upgrade to get the newest ENUM. 35 | 36 | [[Back to README]](../../README.md) 37 | -------------------------------------------------------------------------------- /docs/Customer/KYCDocumentType.md: -------------------------------------------------------------------------------- 1 | # # KYCDocumentType 2 | 3 | 4 | ```php 5 | use Xendit\Customer\KYCDocumentType; 6 | ``` 7 | 8 | 9 | ## Enum 10 | 11 | 12 | * `BIRTH_CERTIFICATE` (value: `'BIRTH_CERTIFICATE'`) 13 | 14 | * `BANK_STATEMENT` (value: `'BANK_STATEMENT'`) 15 | 16 | * `DRIVING_LICENSE` (value: `'DRIVING_LICENSE'`) 17 | 18 | * `IDENTITY_CARD` (value: `'IDENTITY_CARD'`) 19 | 20 | * `PASSPORT` (value: `'PASSPORT'`) 21 | 22 | * `VISA` (value: `'VISA'`) 23 | 24 | * `BUSINESS_REGISTRATION` (value: `'BUSINESS_REGISTRATION'`) 25 | 26 | * `BUSINESS_LICENSE` (value: `'BUSINESS_LICENSE'`) 27 | 28 | * `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) 29 | 30 | If you encounter `UNKNOWN_ENUM_VALUE`, it means that this ENUM is unavailable in your current SDK version. Please upgrade to get the newest ENUM. 31 | 32 | [[Back to README]](../../README.md) 33 | -------------------------------------------------------------------------------- /docs/Customer/PatchCustomer.md: -------------------------------------------------------------------------------- 1 | # # PatchCustomer 2 | 3 | 4 | ```php 5 | use Xendit\Customer\PatchCustomer; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **client_name** | **string** | | Entity's name for this client | AirAsia Indonesia | 13 | | **reference_id** | **string** | | Merchant's reference of this end customer, eg Merchant's user's id. Must be unique. | null | 14 | | **individual_detail** | [**IndividualDetail**](IndividualDetail.md) | | | null | 15 | | **business_detail** | [**BusinessDetail**](BusinessDetail.md) | | | null | 16 | | **description** | **string** | | | null | 17 | | **email** | **string** | | | info@xendit.co | 18 | | **mobile_number** | **string** | | | +6281295412345 | 19 | | **phone_number** | **string** | | | +6281295412345 | 20 | | **metadata** | **object** | | | null | 21 | | **addresses** | [**array**](AddressRequest.md) | | | null | 22 | | **identity_accounts** | [**array**](IdentityAccountRequest.md) | | | null | 23 | | **kyc_documents** | [**array**](KYCDocumentRequest.md) | | | null | 24 | | **status** | [**EndCustomerStatus**](EndCustomerStatus.md) | | | null | 25 | 26 | 27 | [[Back to README]](../../README.md) 28 | -------------------------------------------------------------------------------- /docs/Customer/ResponseDataNotFound.md: -------------------------------------------------------------------------------- 1 | # # ResponseDataNotFound 2 | 3 | 4 | ```php 5 | use Xendit\Customer\ResponseDataNotFound; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **error_code** | **string** | | | DATA_NOT_FOUND | 13 | | **message** | **mixed** | | | Provided customer_id does not exist | 14 | 15 | 16 | [[Back to README]](../../README.md) 17 | -------------------------------------------------------------------------------- /docs/Customer/UpdateCustomer400Response.md: -------------------------------------------------------------------------------- 1 | # # UpdateCustomer400Response 2 | 3 | 4 | ```php 5 | use Xendit\Customer\UpdateCustomer400Response; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **error_code** | **string** | ☑️ | | ENTITY_NOT_FOUND_ERROR | 13 | | **message** | **mixed** | ☑️ | | Entity does not exist | 14 | | **errors** | **object[]** | | | null | 15 | 16 | 17 | [[Back to README]](../../README.md) 18 | -------------------------------------------------------------------------------- /docs/Customer/UpdateCustomer400ResponseAllOf.md: -------------------------------------------------------------------------------- 1 | # # UpdateCustomer400ResponseAllOf 2 | 3 | 4 | ```php 5 | use Xendit\Customer\UpdateCustomer400ResponseAllOf; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **error_code** | **string** | | | ENTITY_NOT_FOUND_ERROR | 13 | | **message** | **mixed** | | | Entity does not exist | 14 | 15 | 16 | [[Back to README]](../../README.md) 17 | -------------------------------------------------------------------------------- /docs/Invoice/AddressObject.md: -------------------------------------------------------------------------------- 1 | # # AddressObject 2 | An object representing an address with various properties. 3 | 4 | ```php 5 | use Xendit\Invoice\AddressObject; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **country** | **string** | | The country where the address is located. | null | 13 | | **street_line1** | **string** | | The first line of the street address. | null | 14 | | **street_line2** | **string** | | The second line of the street address. | null | 15 | | **city** | **string** | | The city or locality within the address. | null | 16 | | **province** | **string** | | The province or region within the country. | null | 17 | | **state** | **string** | | The state or administrative division within the country. | null | 18 | | **postal_code** | **string** | | The postal code or ZIP code for the address. | null | 19 | 20 | 21 | [[Back to README]](../../README.md) 22 | -------------------------------------------------------------------------------- /docs/Invoice/AlternativeDisplayItem.md: -------------------------------------------------------------------------------- 1 | # # AlternativeDisplayItem 2 | An object representing alternative display of a VA. 3 | 4 | ```php 5 | use Xendit\Invoice\AlternativeDisplayItem; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **type** | **string** | | Represent type of alternative display. | null | 13 | | **value** | **string** | | Represent value of alternative display value. | null | 14 | 15 | 16 | [[Back to README]](../../README.md) 17 | -------------------------------------------------------------------------------- /docs/Invoice/BadRequestError.md: -------------------------------------------------------------------------------- 1 | # # BadRequestError 2 | Response definition for a 400 Bad Request error when creating an invoice. 3 | 4 | ```php 5 | use Xendit\Invoice\BadRequestError; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **error_code** | **string** | ☑️ | The error code indicating the type of error that occurred. | null | 13 | | **message** | **string** | ☑️ | A human-readable error message that provides additional information about the error. | null | 14 | 15 | 16 | [[Back to README]](../../README.md) 17 | -------------------------------------------------------------------------------- /docs/Invoice/Bank.md: -------------------------------------------------------------------------------- 1 | # # Bank 2 | An object representing bank details for invoices. 3 | 4 | ```php 5 | use Xendit\Invoice\Bank; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **bank_code** | [**BankCode**](BankCode.md) | ☑️ | | null | 13 | | **collection_type** | **string** | ☑️ | The collection type for the bank details. | null | 14 | | **bank_branch** | **string** | | The branch of the bank. | null | 15 | | **bank_account_number** | **string** | | The bank account number. | null | 16 | | **account_holder_name** | **string** | ☑️ | The name of the account holder. | null | 17 | | **transfer_amount** | **float** | | The transfer amount. | null | 18 | | **alternative_displays** | [**array**](AlternativeDisplayItem.md) | | | null | 19 | 20 | 21 | [[Back to README]](../../README.md) 22 | -------------------------------------------------------------------------------- /docs/Invoice/BankCode.md: -------------------------------------------------------------------------------- 1 | # # BankCode 2 | Representing the available bank channels used for invoice-related transactions. 3 | 4 | ```php 5 | use Xendit\Invoice\BankCode; 6 | ``` 7 | 8 | 9 | ## Enum 10 | 11 | 12 | * `BCA` (value: `'BCA'`) 13 | 14 | * `BNI` (value: `'BNI'`) 15 | 16 | * `BRI` (value: `'BRI'`) 17 | 18 | * `MANDIRI` (value: `'MANDIRI'`) 19 | 20 | * `PERMATA` (value: `'PERMATA'`) 21 | 22 | * `BSI` (value: `'BSI'`) 23 | 24 | * `BJB` (value: `'BJB'`) 25 | 26 | * `SAHABAT_SAMPOERNA` (value: `'SAHABAT_SAMPOERNA'`) 27 | 28 | * `CIMB` (value: `'CIMB'`) 29 | 30 | * `VIETCAPITAL` (value: `'VIETCAPITAL'`) 31 | 32 | * `WOORI` (value: `'WOORI'`) 33 | 34 | * `PV` (value: `'PV'`) 35 | 36 | * `MSB` (value: `'MSB'`) 37 | 38 | * `VPB` (value: `'VPB'`) 39 | 40 | * `BIDV` (value: `'BIDV'`) 41 | 42 | * `CAKE` (value: `'CAKE'`) 43 | 44 | * `BNC` (value: `'BNC'`) 45 | 46 | * `HANA` (value: `'HANA'`) 47 | 48 | * `MUAMALAT` (value: `'MUAMALAT'`) 49 | 50 | * `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) 51 | 52 | If you encounter `UNKNOWN_ENUM_VALUE`, it means that this ENUM is unavailable in your current SDK version. Please upgrade to get the newest ENUM. 53 | 54 | [[Back to README]](../../README.md) 55 | -------------------------------------------------------------------------------- /docs/Invoice/ChannelProperties.md: -------------------------------------------------------------------------------- 1 | # # ChannelProperties 2 | An object representing channel-specific properties. 3 | 4 | ```php 5 | use Xendit\Invoice\ChannelProperties; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **cards** | [**ChannelPropertiesCards**](ChannelPropertiesCards.md) | | | null | 13 | 14 | 15 | [[Back to README]](../../README.md) 16 | -------------------------------------------------------------------------------- /docs/Invoice/ChannelPropertiesCards.md: -------------------------------------------------------------------------------- 1 | # # ChannelPropertiesCards 2 | An object representing properties specific for credit card payment method. 3 | 4 | ```php 5 | use Xendit\Invoice\ChannelPropertiesCards; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **allowed_bins** | **string[]** | | An array of allowed BINs (6 or 8 digits) for credit card payments. | null | 13 | | **installment_configuration** | [**ChannelPropertiesCardsInstallmentConfiguration**](ChannelPropertiesCardsInstallmentConfiguration.md) | | | null | 14 | 15 | 16 | [[Back to README]](../../README.md) 17 | -------------------------------------------------------------------------------- /docs/Invoice/ChannelPropertiesCardsInstallmentConfiguration.md: -------------------------------------------------------------------------------- 1 | # # ChannelPropertiesCardsInstallmentConfiguration 2 | An object to pre-set cards installment for a specific invoice 3 | 4 | ```php 5 | use Xendit\Invoice\ChannelPropertiesCardsInstallmentConfiguration; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **allow_full_payment** | **bool** | | Indicate whether full payment (without installment) is allowed | null | 13 | | **allowed_terms** | [**array**](ChannelPropertiesCardsInstallmentConfigurationAllowedTermsInner.md) | | An object to set what kind (from specific bank / specific tenor) of cards installments will be available on a specific invoice | null | 14 | 15 | 16 | [[Back to README]](../../README.md) 17 | -------------------------------------------------------------------------------- /docs/Invoice/ChannelPropertiesCardsInstallmentConfigurationAllowedTermsInner.md: -------------------------------------------------------------------------------- 1 | # # ChannelPropertiesCardsInstallmentConfigurationAllowedTermsInner 2 | 3 | 4 | ```php 5 | use Xendit\Invoice\ChannelPropertiesCardsInstallmentConfigurationAllowedTermsInner; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **issuer** | **string** | | The bank code of the installment provider / issuer | null | 13 | | **terms** | **float[]** | | An array containing list of installment tenor available to choose | null | 14 | 15 | 16 | [[Back to README]](../../README.md) 17 | -------------------------------------------------------------------------------- /docs/Invoice/CustomerObject.md: -------------------------------------------------------------------------------- 1 | # # CustomerObject 2 | An object representing a customer with various properties, including addresses. 3 | 4 | ```php 5 | use Xendit\Invoice\CustomerObject; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **id** | **string** | | The unique identifier for the customer. | null | 13 | | **phone_number** | **string** | | The customer's phone number. | null | 14 | | **given_names** | **string** | | The customer's given names or first names. | null | 15 | | **surname** | **string** | | The customer's surname or last name. | null | 16 | | **email** | **string** | | The customer's email address. | null | 17 | | **mobile_number** | **string** | | The customer's mobile phone number. | null | 18 | | **customer_id** | **string** | | An additional identifier for the customer. | null | 19 | | **addresses** | [**array**](AddressObject.md) | | An array of addresses associated with the customer. | null | 20 | 21 | 22 | [[Back to README]](../../README.md) 23 | -------------------------------------------------------------------------------- /docs/Invoice/DirectDebit.md: -------------------------------------------------------------------------------- 1 | # # DirectDebit 2 | An object representing direct debit details for invoices. 3 | 4 | ```php 5 | use Xendit\Invoice\DirectDebit; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **direct_debit_type** | [**DirectDebitType**](DirectDebitType.md) | ☑️ | | null | 13 | 14 | 15 | [[Back to README]](../../README.md) 16 | -------------------------------------------------------------------------------- /docs/Invoice/Ewallet.md: -------------------------------------------------------------------------------- 1 | # # Ewallet 2 | An object representing e-wallet details for invoices. 3 | 4 | ```php 5 | use Xendit\Invoice\Ewallet; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **ewallet_type** | [**EwalletType**](EwalletType.md) | ☑️ | | null | 13 | 14 | 15 | [[Back to README]](../../README.md) 16 | -------------------------------------------------------------------------------- /docs/Invoice/EwalletType.md: -------------------------------------------------------------------------------- 1 | # # EwalletType 2 | Representing the available eWallet channels used for invoice-related transactions. 3 | 4 | ```php 5 | use Xendit\Invoice\EwalletType; 6 | ``` 7 | 8 | 9 | ## Enum 10 | 11 | 12 | * `OVO` (value: `'OVO'`) 13 | 14 | * `GOPAY` (value: `'GOPAY'`) 15 | 16 | * `DANA` (value: `'DANA'`) 17 | 18 | * `LINKAJA` (value: `'LINKAJA'`) 19 | 20 | * `PAYMAYA` (value: `'PAYMAYA'`) 21 | 22 | * `SHOPEEPAY` (value: `'SHOPEEPAY'`) 23 | 24 | * `GCASH` (value: `'GCASH'`) 25 | 26 | * `GRABPAY` (value: `'GRABPAY'`) 27 | 28 | * `ASTRAPAY` (value: `'ASTRAPAY'`) 29 | 30 | * `NEXCASH` (value: `'NEXCASH'`) 31 | 32 | * `JENIUSPAY` (value: `'JENIUSPAY'`) 33 | 34 | * `MOMO` (value: `'MOMO'`) 35 | 36 | * `ZALOPAY` (value: `'ZALOPAY'`) 37 | 38 | * `VIETTELPAY` (value: `'VIETTELPAY'`) 39 | 40 | * `VNPTWALLET` (value: `'VNPTWALLET'`) 41 | 42 | * `APPOTA` (value: `'APPOTA'`) 43 | 44 | * `LINEPAY` (value: `'LINEPAY'`) 45 | 46 | * `TRUEMONEY` (value: `'TRUEMONEY'`) 47 | 48 | * `WECHATPAY` (value: `'WECHATPAY'`) 49 | 50 | * `TOUCHNGO` (value: `'TOUCHNGO'`) 51 | 52 | * `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) 53 | 54 | If you encounter `UNKNOWN_ENUM_VALUE`, it means that this ENUM is unavailable in your current SDK version. Please upgrade to get the newest ENUM. 55 | 56 | [[Back to README]](../../README.md) 57 | -------------------------------------------------------------------------------- /docs/Invoice/ForbiddenError.md: -------------------------------------------------------------------------------- 1 | # # ForbiddenError 2 | An error object used to indicate a 403 Forbidden response related to invoice operations. 3 | 4 | ```php 5 | use Xendit\Invoice\ForbiddenError; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **error_code** | **string** | ☑️ | The specific error code indicating that access to the invoice operation is suspended. | null | 13 | | **message** | **string** | ☑️ | A human-readable error message providing additional context about the 403 Forbidden response. | null | 14 | 15 | 16 | [[Back to README]](../../README.md) 17 | -------------------------------------------------------------------------------- /docs/Invoice/InvoiceCallbackItem.md: -------------------------------------------------------------------------------- 1 | # # InvoiceCallbackItem 2 | An object representing an item within an invoice. 3 | 4 | ```php 5 | use Xendit\Invoice\InvoiceCallbackItem; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **name** | **string** | ☑️ | The name of the item. | null | 13 | | **price** | **float** | ☑️ | The price of the item. | null | 14 | | **quantity** | **float** | ☑️ | The quantity of the item. Must be greater than or equal to 0. | null | 15 | | **url** | **string** | | The URL associated with the item. | null | 16 | | **category** | **string** | | The category of the item. | null | 17 | 18 | 19 | [[Back to README]](../../README.md) 20 | -------------------------------------------------------------------------------- /docs/Invoice/InvoiceClientType.md: -------------------------------------------------------------------------------- 1 | # # InvoiceClientType 2 | Representing the client type or source of an invoice. 3 | 4 | ```php 5 | use Xendit\Invoice\InvoiceClientType; 6 | ``` 7 | 8 | 9 | ## Enum 10 | 11 | 12 | * `DASHBOARD` (value: `'DASHBOARD'`) 13 | 14 | * `API_GATEWAY` (value: `'API_GATEWAY'`) 15 | 16 | * `INTEGRATION` (value: `'INTEGRATION'`) 17 | 18 | * `ON_DEMAND` (value: `'ON_DEMAND'`) 19 | 20 | * `RECURRING` (value: `'RECURRING'`) 21 | 22 | * `MOBILE` (value: `'MOBILE'`) 23 | 24 | * `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) 25 | 26 | If you encounter `UNKNOWN_ENUM_VALUE`, it means that this ENUM is unavailable in your current SDK version. Please upgrade to get the newest ENUM. 27 | 28 | [[Back to README]](../../README.md) 29 | -------------------------------------------------------------------------------- /docs/Invoice/InvoiceCurrency.md: -------------------------------------------------------------------------------- 1 | # # InvoiceCurrency 2 | Representing the currency used for an invoice. 3 | 4 | ```php 5 | use Xendit\Invoice\InvoiceCurrency; 6 | ``` 7 | 8 | 9 | ## Enum 10 | 11 | 12 | * `IDR` (value: `'IDR'`) 13 | 14 | * `USD` (value: `'USD'`) 15 | 16 | * `THB` (value: `'THB'`) 17 | 18 | * `VND` (value: `'VND'`) 19 | 20 | * `PHP` (value: `'PHP'`) 21 | 22 | * `MYR` (value: `'MYR'`) 23 | 24 | * `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) 25 | 26 | If you encounter `UNKNOWN_ENUM_VALUE`, it means that this ENUM is unavailable in your current SDK version. Please upgrade to get the newest ENUM. 27 | 28 | [[Back to README]](../../README.md) 29 | -------------------------------------------------------------------------------- /docs/Invoice/InvoiceError404ResponseDefinition.md: -------------------------------------------------------------------------------- 1 | # # InvoiceError404ResponseDefinition 2 | An error object used to indicate that the requested resource, in this case, an invoice, was not found. 3 | 4 | ```php 5 | use Xendit\Invoice\InvoiceError404ResponseDefinition; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **error_code** | **string** | ☑️ | The specific error code indicating that the requested invoice was not found. | null | 13 | | **message** | **string** | ☑️ | A human-readable error message providing additional context about the resource not being found. | null | 14 | 15 | 16 | [[Back to README]](../../README.md) 17 | -------------------------------------------------------------------------------- /docs/Invoice/InvoiceFee.md: -------------------------------------------------------------------------------- 1 | # # InvoiceFee 2 | An object representing internal details for a fee associated with an invoice. 3 | 4 | ```php 5 | use Xendit\Invoice\InvoiceFee; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **type** | **string** | ☑️ | The type of fee. | null | 13 | | **value** | **float** | ☑️ | The value or amount of the fee. | null | 14 | 15 | 16 | [[Back to README]](../../README.md) 17 | -------------------------------------------------------------------------------- /docs/Invoice/InvoiceItem.md: -------------------------------------------------------------------------------- 1 | # # InvoiceItem 2 | An object representing an item within an invoice. 3 | 4 | ```php 5 | use Xendit\Invoice\InvoiceItem; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **name** | **string** | ☑️ | The name of the item. | null | 13 | | **price** | **float** | ☑️ | The price of the item. | null | 14 | | **quantity** | **float** | ☑️ | The quantity of the item. Must be greater than or equal to 0. | null | 15 | | **reference_id** | **string** | | The reference ID of the item. | null | 16 | | **url** | **string** | | The URL associated with the item. | null | 17 | | **category** | **string** | | The category of the item. | null | 18 | 19 | 20 | [[Back to README]](../../README.md) 21 | -------------------------------------------------------------------------------- /docs/Invoice/InvoiceNotFoundError.md: -------------------------------------------------------------------------------- 1 | # # InvoiceNotFoundError 2 | Response definition for a 404 Not Found error when creating an invoice. 3 | 4 | ```php 5 | use Xendit\Invoice\InvoiceNotFoundError; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **error_code** | **string** | ☑️ | The error code indicating the type of error that occurred. | null | 13 | | **message** | **string** | ☑️ | A human-readable error message that provides additional information about the error. | null | 14 | 15 | 16 | [[Back to README]](../../README.md) 17 | -------------------------------------------------------------------------------- /docs/Invoice/InvoicePaymentMethod.md: -------------------------------------------------------------------------------- 1 | # # InvoicePaymentMethod 2 | Representing the payment method used for an invoice. 3 | 4 | ```php 5 | use Xendit\Invoice\InvoicePaymentMethod; 6 | ``` 7 | 8 | 9 | ## Enum 10 | 11 | 12 | * `POOL` (value: `'POOL'`) 13 | 14 | * `CALLBACK_VIRTUAL_ACCOUNT` (value: `'CALLBACK_VIRTUAL_ACCOUNT'`) 15 | 16 | * `CREDIT_CARD` (value: `'CREDIT_CARD'`) 17 | 18 | * `RETAIL_OUTLET` (value: `'RETAIL_OUTLET'`) 19 | 20 | * `QR_CODE` (value: `'QR_CODE'`) 21 | 22 | * `QRIS` (value: `'QRIS'`) 23 | 24 | * `EWALLET` (value: `'EWALLET'`) 25 | 26 | * `DIRECT_DEBIT` (value: `'DIRECT_DEBIT'`) 27 | 28 | * `BANK_TRANSFER` (value: `'BANK_TRANSFER'`) 29 | 30 | * `PAYLATER` (value: `'PAYLATER'`) 31 | 32 | * `CRYPTOCURRENCY` (value: `'CRYPTOCURRENCY'`) 33 | 34 | * `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) 35 | 36 | If you encounter `UNKNOWN_ENUM_VALUE`, it means that this ENUM is unavailable in your current SDK version. Please upgrade to get the newest ENUM. 37 | 38 | [[Back to README]](../../README.md) 39 | -------------------------------------------------------------------------------- /docs/Invoice/InvoiceStatus.md: -------------------------------------------------------------------------------- 1 | # # InvoiceStatus 2 | Representing the status of an invoice. 3 | 4 | ```php 5 | use Xendit\Invoice\InvoiceStatus; 6 | ``` 7 | 8 | 9 | ## Enum 10 | 11 | 12 | * `PENDING` (value: `'PENDING'`) 13 | 14 | * `PAID` (value: `'PAID'`) 15 | 16 | * `SETTLED` (value: `'SETTLED'`) 17 | 18 | * `EXPIRED` (value: `'EXPIRED'`) 19 | 20 | * `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) 21 | 22 | If you encounter `UNKNOWN_ENUM_VALUE`, it means that this ENUM is unavailable in your current SDK version. Please upgrade to get the newest ENUM. 23 | 24 | [[Back to README]](../../README.md) 25 | -------------------------------------------------------------------------------- /docs/Invoice/NotificationChannel.md: -------------------------------------------------------------------------------- 1 | # # NotificationChannel 2 | Representing a notification channel for sending messages. 3 | 4 | ```php 5 | use Xendit\Invoice\NotificationChannel; 6 | ``` 7 | 8 | 9 | ## Enum 10 | 11 | 12 | * `EMAIL` (value: `'email'`) 13 | 14 | * `SMS` (value: `'sms'`) 15 | 16 | * `WHATSAPP` (value: `'whatsapp'`) 17 | 18 | * `VIBER` (value: `'viber'`) 19 | 20 | * `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) 21 | 22 | If you encounter `UNKNOWN_ENUM_VALUE`, it means that this ENUM is unavailable in your current SDK version. Please upgrade to get the newest ENUM. 23 | 24 | [[Back to README]](../../README.md) 25 | -------------------------------------------------------------------------------- /docs/Invoice/NotificationPreference.md: -------------------------------------------------------------------------------- 1 | # # NotificationPreference 2 | An object representing notification preferences for different invoice events. 3 | 4 | ```php 5 | use Xendit\Invoice\NotificationPreference; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **invoice_created** | [**array**](NotificationChannel.md) | | Notification channels for when an invoice is created. | null | 13 | | **invoice_reminder** | [**array**](NotificationChannel.md) | | Notification channels for invoice reminders. | null | 14 | | **invoice_paid** | [**array**](NotificationChannel.md) | | Notification channels for when an invoice is paid. | null | 15 | 16 | 17 | [[Back to README]](../../README.md) 18 | -------------------------------------------------------------------------------- /docs/Invoice/Paylater.md: -------------------------------------------------------------------------------- 1 | # # Paylater 2 | An object representing paylater details for invoices. 3 | 4 | ```php 5 | use Xendit\Invoice\Paylater; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **paylater_type** | [**PaylaterType**](PaylaterType.md) | ☑️ | | null | 13 | | **should_exclude** | **bool** | | Indicates whether this paylater option should be excluded. | null | 14 | 15 | 16 | [[Back to README]](../../README.md) 17 | -------------------------------------------------------------------------------- /docs/Invoice/PaylaterType.md: -------------------------------------------------------------------------------- 1 | # # PaylaterType 2 | Representing the available paylater channels used for invoice-related transactions. 3 | 4 | ```php 5 | use Xendit\Invoice\PaylaterType; 6 | ``` 7 | 8 | 9 | ## Enum 10 | 11 | 12 | * `KREDIVO` (value: `'KREDIVO'`) 13 | 14 | * `AKULAKU` (value: `'AKULAKU'`) 15 | 16 | * `UANGME` (value: `'UANGME'`) 17 | 18 | * `BILLEASE` (value: `'BILLEASE'`) 19 | 20 | * `CASHALO` (value: `'CASHALO'`) 21 | 22 | * `ATOME` (value: `'ATOME'`) 23 | 24 | * `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) 25 | 26 | If you encounter `UNKNOWN_ENUM_VALUE`, it means that this ENUM is unavailable in your current SDK version. Please upgrade to get the newest ENUM. 27 | 28 | [[Back to README]](../../README.md) 29 | -------------------------------------------------------------------------------- /docs/Invoice/PaymentDetails.md: -------------------------------------------------------------------------------- 1 | # # PaymentDetails 2 | An object representing payment details. 3 | 4 | ```php 5 | use Xendit\Invoice\PaymentDetails; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **receipt_id** | **string** | | The unique identifier or reference ID associated with the payment receipt. | null | 13 | | **source** | **string** | | The source or method of payment. | null | 14 | 15 | 16 | [[Back to README]](../../README.md) 17 | -------------------------------------------------------------------------------- /docs/Invoice/QrCode.md: -------------------------------------------------------------------------------- 1 | # # QrCode 2 | An object representing QR code details for invoices. 3 | 4 | ```php 5 | use Xendit\Invoice\QrCode; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **qr_code_type** | [**QrCodeType**](QrCodeType.md) | ☑️ | | null | 13 | 14 | 15 | [[Back to README]](../../README.md) 16 | -------------------------------------------------------------------------------- /docs/Invoice/QrCodeType.md: -------------------------------------------------------------------------------- 1 | # # QrCodeType 2 | Representing the available QR Code channels used for invoice-related transactions. 3 | 4 | ```php 5 | use Xendit\Invoice\QrCodeType; 6 | ``` 7 | 8 | 9 | ## Enum 10 | 11 | 12 | * `QRIS` (value: `'QRIS'`) 13 | 14 | * `PROMPTPAY` (value: `'PROMPTPAY'`) 15 | 16 | * `QRPH` (value: `'QRPH'`) 17 | 18 | * `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) 19 | 20 | If you encounter `UNKNOWN_ENUM_VALUE`, it means that this ENUM is unavailable in your current SDK version. Please upgrade to get the newest ENUM. 21 | 22 | [[Back to README]](../../README.md) 23 | -------------------------------------------------------------------------------- /docs/Invoice/RetailOutlet.md: -------------------------------------------------------------------------------- 1 | # # RetailOutlet 2 | An object representing retail outlet details for invoices. 3 | 4 | ```php 5 | use Xendit\Invoice\RetailOutlet; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **retail_outlet_name** | [**RetailOutletName**](RetailOutletName.md) | ☑️ | | null | 13 | | **payment_code** | **string** | | The payment code. | null | 14 | | **transfer_amount** | **float** | | The transfer amount. | null | 15 | | **merchant_name** | **string** | | The name of the merchant. | null | 16 | 17 | 18 | [[Back to README]](../../README.md) 19 | -------------------------------------------------------------------------------- /docs/Invoice/RetailOutletName.md: -------------------------------------------------------------------------------- 1 | # # RetailOutletName 2 | Representing the available retail outlet channels used for invoice-related transactions. 3 | 4 | ```php 5 | use Xendit\Invoice\RetailOutletName; 6 | ``` 7 | 8 | 9 | ## Enum 10 | 11 | 12 | * `ALFAMART` (value: `'ALFAMART'`) 13 | 14 | * `INDOMARET` (value: `'INDOMARET'`) 15 | 16 | * `_7_ELEVEN` (value: `'7ELEVEN'`) 17 | 18 | * `CEBUANA` (value: `'CEBUANA'`) 19 | 20 | * `DP_ECPAY_LOAN` (value: `'DP_ECPAY_LOAN'`) 21 | 22 | * `DP_MLHUILLIER` (value: `'DP_MLHUILLIER'`) 23 | 24 | * `DP_PALAWAN` (value: `'DP_PALAWAN'`) 25 | 26 | * `DP_ECPAY_SCHOOL` (value: `'DP_ECPAY_SCHOOL'`) 27 | 28 | * `LBC` (value: `'LBC'`) 29 | 30 | * `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) 31 | 32 | If you encounter `UNKNOWN_ENUM_VALUE`, it means that this ENUM is unavailable in your current SDK version. Please upgrade to get the newest ENUM. 33 | 34 | [[Back to README]](../../README.md) 35 | -------------------------------------------------------------------------------- /docs/Invoice/ServerError.md: -------------------------------------------------------------------------------- 1 | # # ServerError 2 | 3 | 4 | ```php 5 | use Xendit\Invoice\ServerError; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **error_code** | **string** | ☑️ | | null | 13 | | **message** | **string** | ☑️ | | null | 14 | 15 | 16 | [[Back to README]](../../README.md) 17 | -------------------------------------------------------------------------------- /docs/Invoice/UnauthorizedError.md: -------------------------------------------------------------------------------- 1 | # # UnauthorizedError 2 | An error object used to indicate unauthorized access to an invoice-related resource. 3 | 4 | ```php 5 | use Xendit\Invoice\UnauthorizedError; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **error_code** | **string** | ☑️ | The specific error code associated with the unauthorized access. | null | 13 | | **message** | **string** | ☑️ | A human-readable error message providing additional context about the unauthorized access. | null | 14 | 15 | 16 | [[Back to README]](../../README.md) 17 | -------------------------------------------------------------------------------- /docs/PaymentMethod/BillingInformation.md: -------------------------------------------------------------------------------- 1 | # # BillingInformation 2 | Billing Information 3 | 4 | ```php 5 | use Xendit\PaymentMethod\BillingInformation; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **country** | **string** | ☑️ | | null | 13 | | **street_line1** | **string** | | | null | 14 | | **street_line2** | **string** | | | null | 15 | | **city** | **string** | | | null | 16 | | **province_state** | **string** | | | null | 17 | | **postal_code** | **string** | | | null | 18 | 19 | 20 | [[Back to README]](../../README.md) 21 | -------------------------------------------------------------------------------- /docs/PaymentMethod/Card.md: -------------------------------------------------------------------------------- 1 | # # Card 2 | Card Payment Method Details 3 | 4 | ```php 5 | use Xendit\PaymentMethod\Card; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **channel_code** | [**CardChannelCode**](CardChannelCode.md) | | | null | 13 | | **currency** | **string** | | | null | 14 | | **channel_properties** | [**CardChannelProperties**](CardChannelProperties.md) | ☑️ | | null | 15 | | **card_information** | [**TokenizedCardInformation**](TokenizedCardInformation.md) | | | null | 16 | | **card_verification_results** | [**CardVerificationResults**](CardVerificationResults.md) | | | null | 17 | 18 | 19 | [[Back to README]](../../README.md) 20 | -------------------------------------------------------------------------------- /docs/PaymentMethod/CardChannelCode.md: -------------------------------------------------------------------------------- 1 | # # CardChannelCode 2 | Card Channel Code 3 | 4 | ```php 5 | use Xendit\PaymentMethod\CardChannelCode; 6 | ``` 7 | 8 | 9 | ## Enum 10 | 11 | 12 | * `BAY_CARD_INSTALLMENT` (value: `'BAY_CARD_INSTALLMENT'`) 13 | 14 | * `BBL_CARD_INSTALLMENT` (value: `'BBL_CARD_INSTALLMENT'`) 15 | 16 | * `GPN` (value: `'GPN'`) 17 | 18 | * `KBANK_CARD_INSTALLMENT` (value: `'KBANK_CARD_INSTALLMENT'`) 19 | 20 | * `KTB_CARD_INSTALLMENT` (value: `'KTB_CARD_INSTALLMENT'`) 21 | 22 | * `SCB_CARD_INSTALLMENT` (value: `'SCB_CARD_INSTALLMENT'`) 23 | 24 | * `TTB_CARD_INSTALLMENT` (value: `'TTB_CARD_INSTALLMENT'`) 25 | 26 | * `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) 27 | 28 | If you encounter `UNKNOWN_ENUM_VALUE`, it means that this ENUM is unavailable in your current SDK version. Please upgrade to get the newest ENUM. 29 | 30 | [[Back to README]](../../README.md) 31 | -------------------------------------------------------------------------------- /docs/PaymentMethod/CardChannelProperties.md: -------------------------------------------------------------------------------- 1 | # # CardChannelProperties 2 | Card Channel Properties 3 | 4 | ```php 5 | use Xendit\PaymentMethod\CardChannelProperties; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **skip_three_d_secure** | **bool** | | This field value is only being used for reusability = MULTIPLE_USE. To indicate whether to perform 3DS during the linking phase. Defaults to false. | false | 13 | | **success_return_url** | **string** | | URL where the end-customer is redirected if the authorization is successful | https://webhook.site/f4b755f5-4770-4a11-8c72-cc0b3cc6b882 | 14 | | **failure_return_url** | **string** | | URL where the end-customer is redirected if the authorization failed | https://webhook.site/f4b755f5-4770-4a11-8c72-cc0b3cc6b882 | 15 | | **cardonfile_type** | **string** | | Type of “credential-on-file” / “card-on-file” payment being made. Indicate that this payment uses a previously linked Payment Method for charging. | RECURRING | 16 | | **expires_at** | **\DateTime** | | | null | 17 | | **installment_configuration** | [**CardInstallmentConfiguration**](CardInstallmentConfiguration.md) | | | null | 18 | | **merchant_id_tag** | **string** | | Tag for a Merchant ID that you want to associate this payment with. For merchants using their own MIDs to specify which MID they want to use | label123 | 19 | 20 | 21 | [[Back to README]](../../README.md) 22 | -------------------------------------------------------------------------------- /docs/PaymentMethod/CardInstallmentConfiguration.md: -------------------------------------------------------------------------------- 1 | # # CardInstallmentConfiguration 2 | Card Installment Configuration 3 | 4 | ```php 5 | use Xendit\PaymentMethod\CardInstallmentConfiguration; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **terms** | **int** | | | null | 13 | | **interval** | **string** | | | MONTH | 14 | | **code** | **string** | | | 123 | 15 | 16 | 17 | [[Back to README]](../../README.md) 18 | -------------------------------------------------------------------------------- /docs/PaymentMethod/CardParameters.md: -------------------------------------------------------------------------------- 1 | # # CardParameters 2 | 3 | 4 | ```php 5 | use Xendit\PaymentMethod\CardParameters; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **currency** | **string** | ☑️ | | null | 13 | | **channel_properties** | [**CardChannelProperties**](CardChannelProperties.md) | | | null | 14 | | **card_information** | [**CardParametersCardInformation**](CardParametersCardInformation.md) | | | null | 15 | 16 | 17 | [[Back to README]](../../README.md) 18 | -------------------------------------------------------------------------------- /docs/PaymentMethod/CardParametersCardInformation.md: -------------------------------------------------------------------------------- 1 | # # CardParametersCardInformation 2 | Card Information 3 | 4 | ```php 5 | use Xendit\PaymentMethod\CardParametersCardInformation; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **card_number** | **string** | ☑️ | | null | 13 | | **expiry_month** | **string** | ☑️ | Card expiry month in MM format | null | 14 | | **expiry_year** | **string** | ☑️ | Card expiry month in YY format | null | 15 | | **cardholder_name** | **string** | | Cardholder name | null | 16 | | **cvv** | **string** | | | null | 17 | 18 | 19 | [[Back to README]](../../README.md) 20 | -------------------------------------------------------------------------------- /docs/PaymentMethod/CardVerificationResults.md: -------------------------------------------------------------------------------- 1 | # # CardVerificationResults 2 | 3 | 4 | ```php 5 | use Xendit\PaymentMethod\CardVerificationResults; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **three_d_secure** | [**CardVerificationResultsThreeDSecure**](CardVerificationResultsThreeDSecure.md) | ☑️ | | null | 13 | | **cvv_result** | **string** | | | null | 14 | | **address_verification_result** | **string** | | | null | 15 | 16 | 17 | [[Back to README]](../../README.md) 18 | -------------------------------------------------------------------------------- /docs/PaymentMethod/CardVerificationResultsThreeDSecure.md: -------------------------------------------------------------------------------- 1 | # # CardVerificationResultsThreeDSecure 2 | 3 | 4 | ```php 5 | use Xendit\PaymentMethod\CardVerificationResultsThreeDSecure; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **three_d_secure_flow** | **string** | | | null | 13 | | **eci_code** | **string** | | | null | 14 | | **three_d_secure_result** | **string** | | | null | 15 | | **three_d_secure_result_reason** | **string** | | | null | 16 | | **three_d_secure_version** | **string** | | | null | 17 | 18 | 19 | [[Back to README]](../../README.md) 20 | -------------------------------------------------------------------------------- /docs/PaymentMethod/CreatePaymentMethod409Response.md: -------------------------------------------------------------------------------- 1 | # # CreatePaymentMethod409Response 2 | 3 | 4 | ```php 5 | use Xendit\PaymentMethod\CreatePaymentMethod409Response; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **error_code** | **string** | | | null | 13 | | **message** | **string** | | | An internal server error occurred | 14 | 15 | 16 | [[Back to README]](../../README.md) 17 | -------------------------------------------------------------------------------- /docs/PaymentMethod/CreatePaymentMethod503Response.md: -------------------------------------------------------------------------------- 1 | # # CreatePaymentMethod503Response 2 | 3 | 4 | ```php 5 | use Xendit\PaymentMethod\CreatePaymentMethod503Response; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **error_code** | **string** | | | null | 13 | | **message** | **string** | | | An internal server error occurred | 14 | 15 | 16 | [[Back to README]](../../README.md) 17 | -------------------------------------------------------------------------------- /docs/PaymentMethod/DirectDebit.md: -------------------------------------------------------------------------------- 1 | # # DirectDebit 2 | Direct Debit Payment Method Details 3 | 4 | ```php 5 | use Xendit\PaymentMethod\DirectDebit; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **channel_code** | [**DirectDebitChannelCode**](DirectDebitChannelCode.md) | ☑️ | | null | 13 | | **channel_properties** | [**DirectDebitChannelProperties**](DirectDebitChannelProperties.md) | ☑️ | | null | 14 | | **type** | [**DirectDebitType**](DirectDebitType.md) | ☑️ | | null | 15 | | **bank_account** | [**DirectDebitBankAccount**](DirectDebitBankAccount.md) | | | null | 16 | | **debit_card** | [**DirectDebitDebitCard**](DirectDebitDebitCard.md) | | | null | 17 | 18 | 19 | [[Back to README]](../../README.md) 20 | -------------------------------------------------------------------------------- /docs/PaymentMethod/DirectDebitAllOf.md: -------------------------------------------------------------------------------- 1 | # # DirectDebitAllOf 2 | 3 | 4 | ```php 5 | use Xendit\PaymentMethod\DirectDebitAllOf; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **type** | [**DirectDebitType**](DirectDebitType.md) | ☑️ | | null | 13 | | **bank_account** | [**DirectDebitBankAccount**](DirectDebitBankAccount.md) | | | null | 14 | | **debit_card** | [**DirectDebitDebitCard**](DirectDebitDebitCard.md) | | | null | 15 | 16 | 17 | [[Back to README]](../../README.md) 18 | -------------------------------------------------------------------------------- /docs/PaymentMethod/DirectDebitBankAccount.md: -------------------------------------------------------------------------------- 1 | # # DirectDebitBankAccount 2 | 3 | 4 | ```php 5 | use Xendit\PaymentMethod\DirectDebitBankAccount; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **masked_bank_account_number** | **string** | | | 233eca40ff303ba15bf39052ca3102c6 | 13 | | **bank_account_hash** | **string** | | | 233eca40ff303ba15bf39052ca3102c6 | 14 | | **mobile_number** | **string** | | Mobile number of the customer registered to the partner channel | +62818555988 | 15 | | **identity_document_number** | **string** | | Identity number of the customer registered to the partner channel | 1234567891113 | 16 | 17 | 18 | [[Back to README]](../../README.md) 19 | -------------------------------------------------------------------------------- /docs/PaymentMethod/DirectDebitChannelProperties.md: -------------------------------------------------------------------------------- 1 | # # DirectDebitChannelProperties 2 | Direct Debit Channel Properties 3 | 4 | ```php 5 | use Xendit\PaymentMethod\DirectDebitChannelProperties; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **success_return_url** | **string** | | | null | 13 | | **failure_return_url** | **string** | | | null | 14 | | **mobile_number** | **string** | | Mobile number of the customer registered to the partner channel | +62818555988 | 15 | | **card_last_four** | **string** | | Last four digits of the debit card | 8888 | 16 | | **card_expiry** | **string** | | Expiry month and year of the debit card (in MM/YY format) | 06/24 | 17 | | **email** | **string** | | Email address of the customer that is registered to the partner channel | test.email@xendit.co | 18 | | **identity_document_number** | **string** | | Identity number of the customer registered to the partner channel | 1234567891113 | 19 | | **require_auth** | **bool** | | | null | 20 | | **account_number** | **string** | | Account number of the customer | 1234567891113 | 21 | | **destination_account_id** | **string** | | Destination Account ID for BaaS topups | 12341234 | 22 | 23 | 24 | [[Back to README]](../../README.md) 25 | -------------------------------------------------------------------------------- /docs/PaymentMethod/DirectDebitDebitCard.md: -------------------------------------------------------------------------------- 1 | # # DirectDebitDebitCard 2 | 3 | 4 | ```php 5 | use Xendit\PaymentMethod\DirectDebitDebitCard; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **mobile_number** | **string** | | Mobile number of the customer registered to the partner channel | +62818555988 | 13 | | **card_last_four** | **string** | | Last four digits of the debit card | 8888 | 14 | | **card_expiry** | **string** | | Expiry month and year of the debit card (in MM/YY format) | 06/24 | 15 | | **email** | **string** | | Email address of the customer that is registered to the partner channel | test.email@xendit.co | 16 | | **account_number** | **string** | | Account number of the customer | 12345678 | 17 | 18 | 19 | [[Back to README]](../../README.md) 20 | -------------------------------------------------------------------------------- /docs/PaymentMethod/DirectDebitParameters.md: -------------------------------------------------------------------------------- 1 | # # DirectDebitParameters 2 | 3 | 4 | ```php 5 | use Xendit\PaymentMethod\DirectDebitParameters; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **channel_code** | [**DirectDebitChannelCode**](DirectDebitChannelCode.md) | ☑️ | | null | 13 | | **channel_properties** | [**DirectDebitChannelProperties**](DirectDebitChannelProperties.md) | ☑️ | | null | 14 | 15 | 16 | [[Back to README]](../../README.md) 17 | -------------------------------------------------------------------------------- /docs/PaymentMethod/DirectDebitType.md: -------------------------------------------------------------------------------- 1 | # # DirectDebitType 2 | 3 | 4 | ```php 5 | use Xendit\PaymentMethod\DirectDebitType; 6 | ``` 7 | 8 | 9 | ## Enum 10 | 11 | 12 | * `DEBIT_CARD` (value: `'DEBIT_CARD'`) 13 | 14 | * `BANK_ACCOUNT` (value: `'BANK_ACCOUNT'`) 15 | 16 | * `BANK_REDIRECT` (value: `'BANK_REDIRECT'`) 17 | 18 | * `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) 19 | 20 | If you encounter `UNKNOWN_ENUM_VALUE`, it means that this ENUM is unavailable in your current SDK version. Please upgrade to get the newest ENUM. 21 | 22 | [[Back to README]](../../README.md) 23 | -------------------------------------------------------------------------------- /docs/PaymentMethod/EWallet.md: -------------------------------------------------------------------------------- 1 | # # EWallet 2 | Ewallet Payment Method Details 3 | 4 | ```php 5 | use Xendit\PaymentMethod\EWallet; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **channel_code** | [**EWalletChannelCode**](EWalletChannelCode.md) | ☑️ | | null | 13 | | **channel_properties** | [**EWalletChannelProperties**](EWalletChannelProperties.md) | | | null | 14 | | **account** | [**EWalletAccount**](EWalletAccount.md) | | | null | 15 | 16 | 17 | [[Back to README]](../../README.md) 18 | -------------------------------------------------------------------------------- /docs/PaymentMethod/EWalletAccount.md: -------------------------------------------------------------------------------- 1 | # # EWalletAccount 2 | EWallet Account Properties 3 | 4 | ```php 5 | use Xendit\PaymentMethod\EWalletAccount; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **name** | **string** | | Name of the eWallet account holder. The value is null if unavailableName of the eWallet account holder. The value is null if unavailable | null | 13 | | **account_details** | **string** | | Identifier from eWallet provider e.g. phone number. The value is null if unavailable | null | 14 | | **balance** | **float** | | The main balance amount on eWallet account provided from eWallet provider. The value is null if unavailable | null | 15 | | **point_balance** | **float** | | The point balance amount on eWallet account. Applicable only on some eWallet provider that has point system. The value is null if unavailabl | null | 16 | 17 | 18 | [[Back to README]](../../README.md) 19 | -------------------------------------------------------------------------------- /docs/PaymentMethod/EWalletChannelCode.md: -------------------------------------------------------------------------------- 1 | # # EWalletChannelCode 2 | EWallet Channel Code 3 | 4 | ```php 5 | use Xendit\PaymentMethod\EWalletChannelCode; 6 | ``` 7 | 8 | 9 | ## Enum 10 | 11 | 12 | * `GCASH` (value: `'GCASH'`) 13 | 14 | * `GRABPAY` (value: `'GRABPAY'`) 15 | 16 | * `PAYMAYA` (value: `'PAYMAYA'`) 17 | 18 | * `OVO` (value: `'OVO'`) 19 | 20 | * `DANA` (value: `'DANA'`) 21 | 22 | * `LINKAJA` (value: `'LINKAJA'`) 23 | 24 | * `SHOPEEPAY` (value: `'SHOPEEPAY'`) 25 | 26 | * `SAKUKU` (value: `'SAKUKU'`) 27 | 28 | * `NEXCASH` (value: `'NEXCASH'`) 29 | 30 | * `ASTRAPAY` (value: `'ASTRAPAY'`) 31 | 32 | * `JENIUSPAY` (value: `'JENIUSPAY'`) 33 | 34 | * `APPOTA` (value: `'APPOTA'`) 35 | 36 | * `MOMO` (value: `'MOMO'`) 37 | 38 | * `VNPTWALLET` (value: `'VNPTWALLET'`) 39 | 40 | * `VIETTELPAY` (value: `'VIETTELPAY'`) 41 | 42 | * `ZALOPAY` (value: `'ZALOPAY'`) 43 | 44 | * `WECHATPAY` (value: `'WECHATPAY'`) 45 | 46 | * `LINEPAY` (value: `'LINEPAY'`) 47 | 48 | * `TRUEMONEY` (value: `'TRUEMONEY'`) 49 | 50 | * `ALIPAY` (value: `'ALIPAY'`) 51 | 52 | * `TOUCHNGO` (value: `'TOUCHNGO'`) 53 | 54 | * `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) 55 | 56 | If you encounter `UNKNOWN_ENUM_VALUE`, it means that this ENUM is unavailable in your current SDK version. Please upgrade to get the newest ENUM. 57 | 58 | [[Back to README]](../../README.md) 59 | -------------------------------------------------------------------------------- /docs/PaymentMethod/EWalletChannelProperties.md: -------------------------------------------------------------------------------- 1 | # # EWalletChannelProperties 2 | EWallet Channel Properties 3 | 4 | ```php 5 | use Xendit\PaymentMethod\EWalletChannelProperties; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **success_return_url** | **string** | | URL where the end-customer is redirected if the authorization is successful | https://webhook.site/f4b755f5-4770-4a11-8c72-cc0b3cc6b882 | 13 | | **failure_return_url** | **string** | | URL where the end-customer is redirected if the authorization failed | https://webhook.site/f4b755f5-4770-4a11-8c72-cc0b3cc6b882 | 14 | | **pending_return_url** | **string** | | URL where the end-customer is redirected if the authorization is pending | https://webhook.site/f4b755f5-4770-4a11-8c72-cc0b3cc6b882 | 15 | | **cancel_return_url** | **string** | | URL where the end-customer is redirected if the authorization cancelled | https://webhook.site/f4b755f5-4770-4a11-8c72-cc0b3cc6b882 | 16 | | **mobile_number** | **string** | | Mobile number of customer in E.164 format (e.g. +628123123123). For OVO one time payment use only. | +628123123123 | 17 | | **redeem_points** | **string** | | REDEEM_NONE will not use any point, REDEEM_ALL will use all available points before cash balance is used. For OVO and ShopeePay tokenized payment use only. | REDEEM_NONE | 18 | | **cashtag** | **string** | | Available for JENIUSPAY only | $abc1234 | 19 | | **promotion_label** | **string** | | Available only for OVO | ABC123 | 20 | 21 | 22 | [[Back to README]](../../README.md) 23 | -------------------------------------------------------------------------------- /docs/PaymentMethod/EWalletParameters.md: -------------------------------------------------------------------------------- 1 | # # EWalletParameters 2 | 3 | 4 | ```php 5 | use Xendit\PaymentMethod\EWalletParameters; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **channel_code** | [**EWalletChannelCode**](EWalletChannelCode.md) | ☑️ | | null | 13 | | **channel_properties** | [**EWalletChannelProperties**](EWalletChannelProperties.md) | | | null | 14 | | **account** | [**EWalletAccount**](EWalletAccount.md) | | | null | 15 | 16 | 17 | [[Back to README]](../../README.md) 18 | -------------------------------------------------------------------------------- /docs/PaymentMethod/GetAllPaymentMethods400Response.md: -------------------------------------------------------------------------------- 1 | # # GetAllPaymentMethods400Response 2 | 3 | 4 | ```php 5 | use Xendit\PaymentMethod\GetAllPaymentMethods400Response; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **error_code** | **string** | | | null | 13 | | **message** | **string** | | | An internal server error occurred | 14 | 15 | 16 | [[Back to README]](../../README.md) 17 | -------------------------------------------------------------------------------- /docs/PaymentMethod/GetAllPaymentMethods403Response.md: -------------------------------------------------------------------------------- 1 | # # GetAllPaymentMethods403Response 2 | 3 | 4 | ```php 5 | use Xendit\PaymentMethod\GetAllPaymentMethods403Response; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **error_code** | **string** | | | null | 13 | | **message** | **string** | | | An internal server error occurred | 14 | 15 | 16 | [[Back to README]](../../README.md) 17 | -------------------------------------------------------------------------------- /docs/PaymentMethod/GetAllPaymentMethods404Response.md: -------------------------------------------------------------------------------- 1 | # # GetAllPaymentMethods404Response 2 | 3 | 4 | ```php 5 | use Xendit\PaymentMethod\GetAllPaymentMethods404Response; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **error_code** | **string** | | | null | 13 | | **message** | **string** | | | An internal server error occurred | 14 | 15 | 16 | [[Back to README]](../../README.md) 17 | -------------------------------------------------------------------------------- /docs/PaymentMethod/GetAllPaymentMethodsDefaultResponse.md: -------------------------------------------------------------------------------- 1 | # # GetAllPaymentMethodsDefaultResponse 2 | 3 | 4 | ```php 5 | use Xendit\PaymentMethod\GetAllPaymentMethodsDefaultResponse; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **error_code** | **string** | | | null | 13 | | **message** | **string** | | | An internal server error occurred | 14 | 15 | 16 | [[Back to README]](../../README.md) 17 | -------------------------------------------------------------------------------- /docs/PaymentMethod/OverTheCounter.md: -------------------------------------------------------------------------------- 1 | # # OverTheCounter 2 | Over The Counter Payment Method Details 3 | 4 | ```php 5 | use Xendit\PaymentMethod\OverTheCounter; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **amount** | **float** | | | null | 13 | | **currency** | **string** | | | null | 14 | | **channel_code** | [**OverTheCounterChannelCode**](OverTheCounterChannelCode.md) | ☑️ | | null | 15 | | **channel_properties** | [**OverTheCounterChannelProperties**](OverTheCounterChannelProperties.md) | ☑️ | | null | 16 | 17 | 18 | [[Back to README]](../../README.md) 19 | -------------------------------------------------------------------------------- /docs/PaymentMethod/OverTheCounterChannelCode.md: -------------------------------------------------------------------------------- 1 | # # OverTheCounterChannelCode 2 | Over The Counter Channel Code 3 | 4 | ```php 5 | use Xendit\PaymentMethod\OverTheCounterChannelCode; 6 | ``` 7 | 8 | 9 | ## Enum 10 | 11 | 12 | * `_7_ELEVEN` (value: `'7ELEVEN'`) 13 | 14 | * `_7_ELEVEN_CLIQQ` (value: `'7ELEVEN_CLIQQ'`) 15 | 16 | * `CEBUANA` (value: `'CEBUANA'`) 17 | 18 | * `ECPAY` (value: `'ECPAY'`) 19 | 20 | * `PALAWAN` (value: `'PALAWAN'`) 21 | 22 | * `MLHUILLIER` (value: `'MLHUILLIER'`) 23 | 24 | * `ECPAY_DRAGONLOAN` (value: `'ECPAY_DRAGONLOAN'`) 25 | 26 | * `LBC` (value: `'LBC'`) 27 | 28 | * `ECPAY_SCHOOL` (value: `'ECPAY_SCHOOL'`) 29 | 30 | * `RD_PAWNSHOP` (value: `'RD_PAWNSHOP'`) 31 | 32 | * `CVM` (value: `'CVM'`) 33 | 34 | * `USSC` (value: `'USSC'`) 35 | 36 | * `SM_BILLS` (value: `'SM_BILLS'`) 37 | 38 | * `ROBINSONS_BILLS` (value: `'ROBINSONS_BILLS'`) 39 | 40 | * `ALFAMART` (value: `'ALFAMART'`) 41 | 42 | * `INDOMARET` (value: `'INDOMARET'`) 43 | 44 | * `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) 45 | 46 | If you encounter `UNKNOWN_ENUM_VALUE`, it means that this ENUM is unavailable in your current SDK version. Please upgrade to get the newest ENUM. 47 | 48 | [[Back to README]](../../README.md) 49 | -------------------------------------------------------------------------------- /docs/PaymentMethod/OverTheCounterChannelProperties.md: -------------------------------------------------------------------------------- 1 | # # OverTheCounterChannelProperties 2 | Over The Counter Channel Properties 3 | 4 | ```php 5 | use Xendit\PaymentMethod\OverTheCounterChannelProperties; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **payment_code** | **string** | | The payment code that you want to assign, e.g 12345. If you do not send one, one will be picked at random. | 12345 | 13 | | **customer_name** | **string** | ☑️ | Name of customer. | Rika Sutanto | 14 | | **expires_at** | **\DateTime** | | The time when the payment code will be expired. The minimum is 2 hours and the maximum is 9 days for 7ELEVEN. Default expired date will be 2 days from payment code generated. | 2022-01-01T00:00Z | 15 | 16 | 17 | [[Back to README]](../../README.md) 18 | -------------------------------------------------------------------------------- /docs/PaymentMethod/OverTheCounterChannelPropertiesUpdate.md: -------------------------------------------------------------------------------- 1 | # # OverTheCounterChannelPropertiesUpdate 2 | Over The Counter Channel properties that can be updated 3 | 4 | ```php 5 | use Xendit\PaymentMethod\OverTheCounterChannelPropertiesUpdate; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **customer_name** | **string** | | Name of customer. | Rika Sutanto | 13 | | **expires_at** | **\DateTime** | | The time when the payment code will be expired. The minimum is 2 hours and the maximum is 9 days for 7ELEVEN. Default expired date will be 2 days from payment code generated. | 2022-01-01T00:00Z | 14 | 15 | 16 | [[Back to README]](../../README.md) 17 | -------------------------------------------------------------------------------- /docs/PaymentMethod/OverTheCounterParameters.md: -------------------------------------------------------------------------------- 1 | # # OverTheCounterParameters 2 | 3 | 4 | ```php 5 | use Xendit\PaymentMethod\OverTheCounterParameters; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **amount** | **float** | | | null | 13 | | **currency** | **string** | | | null | 14 | | **channel_code** | [**OverTheCounterChannelCode**](OverTheCounterChannelCode.md) | ☑️ | | null | 15 | | **channel_properties** | [**OverTheCounterChannelProperties**](OverTheCounterChannelProperties.md) | ☑️ | | null | 16 | 17 | 18 | [[Back to README]](../../README.md) 19 | -------------------------------------------------------------------------------- /docs/PaymentMethod/OverTheCounterUpdateParameters.md: -------------------------------------------------------------------------------- 1 | # # OverTheCounterUpdateParameters 2 | 3 | 4 | ```php 5 | use Xendit\PaymentMethod\OverTheCounterUpdateParameters; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **amount** | **float** | | | null | 13 | | **channel_properties** | [**OverTheCounterChannelPropertiesUpdate**](OverTheCounterChannelPropertiesUpdate.md) | | | null | 14 | 15 | 16 | [[Back to README]](../../README.md) 17 | -------------------------------------------------------------------------------- /docs/PaymentMethod/PaymentMethod.md: -------------------------------------------------------------------------------- 1 | # # PaymentMethod 2 | 3 | 4 | ```php 5 | use Xendit\PaymentMethod\PaymentMethod; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **id** | **string** | ☑️ | | null | 13 | | **business_id** | **string** | | | null | 14 | | **type** | [**PaymentMethodType**](PaymentMethodType.md) | | | null | 15 | | **country** | [**PaymentMethodCountry**](PaymentMethodCountry.md) | | | null | 16 | | **customer_id** | **string** | | | null | 17 | | **customer** | **object** | | | null | 18 | | **reference_id** | **string** | | | null | 19 | | **description** | **string** | | | null | 20 | | **status** | [**PaymentMethodStatus**](PaymentMethodStatus.md) | | | null | 21 | | **reusability** | [**PaymentMethodReusability**](PaymentMethodReusability.md) | | | null | 22 | | **actions** | [**array**](PaymentMethodAction.md) | | | null | 23 | | **metadata** | **object** | | | null | 24 | | **billing_information** | [**BillingInformation**](BillingInformation.md) | | | null | 25 | | **failure_code** | **string** | | | null | 26 | | **created** | **\DateTime** | | | 2016-08-29T09:12:33.001Z | 27 | | **updated** | **\DateTime** | | | 2016-08-29T09:12:33.001Z | 28 | | **ewallet** | [**EWallet**](EWallet.md) | | | null | 29 | | **direct_debit** | [**DirectDebit**](DirectDebit.md) | | | null | 30 | | **over_the_counter** | [**OverTheCounter**](OverTheCounter.md) | | | null | 31 | | **card** | [**Card**](Card.md) | | | null | 32 | | **qr_code** | [**QRCode**](QRCode.md) | | | null | 33 | | **virtual_account** | [**VirtualAccount**](VirtualAccount.md) | | | null | 34 | 35 | 36 | [[Back to README]](../../README.md) 37 | -------------------------------------------------------------------------------- /docs/PaymentMethod/PaymentMethodAction.md: -------------------------------------------------------------------------------- 1 | # # PaymentMethodAction 2 | 3 | 4 | ```php 5 | use Xendit\PaymentMethod\PaymentMethodAction; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **action** | **string** | | | null | 13 | | **method** | **string** | | | null | 14 | | **url** | **string** | | | null | 15 | | **url_type** | **string** | | | null | 16 | 17 | 18 | [[Back to README]](../../README.md) 19 | -------------------------------------------------------------------------------- /docs/PaymentMethod/PaymentMethodAuthParameters.md: -------------------------------------------------------------------------------- 1 | # # PaymentMethodAuthParameters 2 | 3 | 4 | ```php 5 | use Xendit\PaymentMethod\PaymentMethodAuthParameters; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **auth_code** | **string** | ☑️ | | null | 13 | 14 | 15 | [[Back to README]](../../README.md) 16 | -------------------------------------------------------------------------------- /docs/PaymentMethod/PaymentMethodCallback.md: -------------------------------------------------------------------------------- 1 | # # PaymentMethodCallback 2 | Callback for active or expired E-Wallet or Direct Debit account linking, Virtual Accounts or QR strings 3 | 4 | ```php 5 | use Xendit\PaymentMethod\PaymentMethodCallback; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **event** | **string** | ☑️ | Identifies the event that triggered a notification to the merchant | null | 13 | | **business_id** | **string** | ☑️ | business_id | null | 14 | | **created** | **string** | ☑️ | | null | 15 | | **data** | [**PaymentMethod**](PaymentMethod.md) | | | null | 16 | 17 | 18 | [[Back to README]](../../README.md) 19 | -------------------------------------------------------------------------------- /docs/PaymentMethod/PaymentMethodCountry.md: -------------------------------------------------------------------------------- 1 | # # PaymentMethodCountry 2 | 3 | 4 | ```php 5 | use Xendit\PaymentMethod\PaymentMethodCountry; 6 | ``` 7 | 8 | 9 | ## Enum 10 | 11 | 12 | * `PH` (value: `'PH'`) 13 | 14 | * `ID` (value: `'ID'`) 15 | 16 | * `VN` (value: `'VN'`) 17 | 18 | * `TH` (value: `'TH'`) 19 | 20 | * `MY` (value: `'MY'`) 21 | 22 | * `US` (value: `'US'`) 23 | 24 | * `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) 25 | 26 | If you encounter `UNKNOWN_ENUM_VALUE`, it means that this ENUM is unavailable in your current SDK version. Please upgrade to get the newest ENUM. 27 | 28 | [[Back to README]](../../README.md) 29 | -------------------------------------------------------------------------------- /docs/PaymentMethod/PaymentMethodExpireParameters.md: -------------------------------------------------------------------------------- 1 | # # PaymentMethodExpireParameters 2 | 3 | 4 | ```php 5 | use Xendit\PaymentMethod\PaymentMethodExpireParameters; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **success_return_url** | **string** | | URL where the end customer is redirected if the unlinking authorization is successful. | null | 13 | | **failure_return_url** | **string** | | URL where the end customer is redirected if the unlinking authorization is failed. | null | 14 | 15 | 16 | [[Back to README]](../../README.md) 17 | -------------------------------------------------------------------------------- /docs/PaymentMethod/PaymentMethodList.md: -------------------------------------------------------------------------------- 1 | # # PaymentMethodList 2 | 3 | 4 | ```php 5 | use Xendit\PaymentMethod\PaymentMethodList; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **data** | [**array**](PaymentMethod.md) | ☑️ | | null | 13 | | **has_more** | **bool** | | | null | 14 | 15 | 16 | [[Back to README]](../../README.md) 17 | -------------------------------------------------------------------------------- /docs/PaymentMethod/PaymentMethodParameters.md: -------------------------------------------------------------------------------- 1 | # # PaymentMethodParameters 2 | 3 | 4 | ```php 5 | use Xendit\PaymentMethod\PaymentMethodParameters; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **type** | [**PaymentMethodType**](PaymentMethodType.md) | ☑️ | | null | 13 | | **country** | **string** | | | null | 14 | | **reusability** | [**PaymentMethodReusability**](PaymentMethodReusability.md) | ☑️ | | null | 15 | | **customer_id** | **string** | | | null | 16 | | **reference_id** | **string** | | | null | 17 | | **description** | **string** | | | null | 18 | | **card** | [**CardParameters**](CardParameters.md) | | | null | 19 | | **direct_debit** | [**DirectDebitParameters**](DirectDebitParameters.md) | | | null | 20 | | **ewallet** | [**EWalletParameters**](EWalletParameters.md) | | | null | 21 | | **over_the_counter** | [**OverTheCounterParameters**](OverTheCounterParameters.md) | | | null | 22 | | **virtual_account** | [**VirtualAccountParameters**](VirtualAccountParameters.md) | | | null | 23 | | **qr_code** | [**QRCodeParameters**](QRCodeParameters.md) | | | null | 24 | | **metadata** | **object** | | | null | 25 | | **billing_information** | [**BillingInformation**](BillingInformation.md) | | | null | 26 | 27 | 28 | [[Back to README]](../../README.md) 29 | -------------------------------------------------------------------------------- /docs/PaymentMethod/PaymentMethodReusability.md: -------------------------------------------------------------------------------- 1 | # # PaymentMethodReusability 2 | 3 | 4 | ```php 5 | use Xendit\PaymentMethod\PaymentMethodReusability; 6 | ``` 7 | 8 | 9 | ## Enum 10 | 11 | 12 | * `MULTIPLE_USE` (value: `'MULTIPLE_USE'`) 13 | 14 | * `ONE_TIME_USE` (value: `'ONE_TIME_USE'`) 15 | 16 | * `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) 17 | 18 | If you encounter `UNKNOWN_ENUM_VALUE`, it means that this ENUM is unavailable in your current SDK version. Please upgrade to get the newest ENUM. 19 | 20 | [[Back to README]](../../README.md) 21 | -------------------------------------------------------------------------------- /docs/PaymentMethod/PaymentMethodStatus.md: -------------------------------------------------------------------------------- 1 | # # PaymentMethodStatus 2 | 3 | 4 | ```php 5 | use Xendit\PaymentMethod\PaymentMethodStatus; 6 | ``` 7 | 8 | 9 | ## Enum 10 | 11 | 12 | * `ACTIVE` (value: `'ACTIVE'`) 13 | 14 | * `EXPIRED` (value: `'EXPIRED'`) 15 | 16 | * `INACTIVE` (value: `'INACTIVE'`) 17 | 18 | * `PENDING` (value: `'PENDING'`) 19 | 20 | * `REQUIRES_ACTION` (value: `'REQUIRES_ACTION'`) 21 | 22 | * `FAILED` (value: `'FAILED'`) 23 | 24 | * `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) 25 | 26 | If you encounter `UNKNOWN_ENUM_VALUE`, it means that this ENUM is unavailable in your current SDK version. Please upgrade to get the newest ENUM. 27 | 28 | [[Back to README]](../../README.md) 29 | -------------------------------------------------------------------------------- /docs/PaymentMethod/PaymentMethodType.md: -------------------------------------------------------------------------------- 1 | # # PaymentMethodType 2 | 3 | 4 | ```php 5 | use Xendit\PaymentMethod\PaymentMethodType; 6 | ``` 7 | 8 | 9 | ## Enum 10 | 11 | 12 | * `CARD` (value: `'CARD'`) 13 | 14 | * `CRYPTOCURRENCY` (value: `'CRYPTOCURRENCY'`) 15 | 16 | * `DIRECT_BANK_TRANSFER` (value: `'DIRECT_BANK_TRANSFER'`) 17 | 18 | * `DIRECT_DEBIT` (value: `'DIRECT_DEBIT'`) 19 | 20 | * `EWALLET` (value: `'EWALLET'`) 21 | 22 | * `OVER_THE_COUNTER` (value: `'OVER_THE_COUNTER'`) 23 | 24 | * `QR_CODE` (value: `'QR_CODE'`) 25 | 26 | * `VIRTUAL_ACCOUNT` (value: `'VIRTUAL_ACCOUNT'`) 27 | 28 | * `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) 29 | 30 | If you encounter `UNKNOWN_ENUM_VALUE`, it means that this ENUM is unavailable in your current SDK version. Please upgrade to get the newest ENUM. 31 | 32 | [[Back to README]](../../README.md) 33 | -------------------------------------------------------------------------------- /docs/PaymentMethod/PaymentMethodUpdateParameters.md: -------------------------------------------------------------------------------- 1 | # # PaymentMethodUpdateParameters 2 | 3 | 4 | ```php 5 | use Xendit\PaymentMethod\PaymentMethodUpdateParameters; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **description** | **string** | | | null | 13 | | **reference_id** | **string** | | | null | 14 | | **reusability** | [**PaymentMethodReusability**](PaymentMethodReusability.md) | | | null | 15 | | **status** | [**PaymentMethodStatus**](PaymentMethodStatus.md) | | | null | 16 | | **over_the_counter** | [**OverTheCounterUpdateParameters**](OverTheCounterUpdateParameters.md) | | | null | 17 | | **virtual_account** | [**VirtualAccountUpdateParameters**](VirtualAccountUpdateParameters.md) | | | null | 18 | 19 | 20 | [[Back to README]](../../README.md) 21 | -------------------------------------------------------------------------------- /docs/PaymentMethod/QRCode.md: -------------------------------------------------------------------------------- 1 | # # QRCode 2 | QR Code Payment Method Details 3 | 4 | ```php 5 | use Xendit\PaymentMethod\QRCode; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **amount** | **float** | | | null | 13 | | **currency** | **string** | | | null | 14 | | **channel_code** | [**QRCodeChannelCode**](QRCodeChannelCode.md) | | | null | 15 | | **channel_properties** | [**QRCodeChannelProperties**](QRCodeChannelProperties.md) | | | null | 16 | 17 | 18 | [[Back to README]](../../README.md) 19 | -------------------------------------------------------------------------------- /docs/PaymentMethod/QRCodeChannelCode.md: -------------------------------------------------------------------------------- 1 | # # QRCodeChannelCode 2 | QR Code Channel Code 3 | 4 | ```php 5 | use Xendit\PaymentMethod\QRCodeChannelCode; 6 | ``` 7 | 8 | 9 | ## Enum 10 | 11 | 12 | * `QRIS` (value: `'QRIS'`) 13 | 14 | * `DANA` (value: `'DANA'`) 15 | 16 | * `RCBC` (value: `'RCBC'`) 17 | 18 | * `PROMPTPAY` (value: `'PROMPTPAY'`) 19 | 20 | * `LINKAJA` (value: `'LINKAJA'`) 21 | 22 | * `XENDIT` (value: `'XENDIT'`) 23 | 24 | * `QRPH` (value: `'QRPH'`) 25 | 26 | * `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) 27 | 28 | If you encounter `UNKNOWN_ENUM_VALUE`, it means that this ENUM is unavailable in your current SDK version. Please upgrade to get the newest ENUM. 29 | 30 | [[Back to README]](../../README.md) 31 | -------------------------------------------------------------------------------- /docs/PaymentMethod/QRCodeChannelProperties.md: -------------------------------------------------------------------------------- 1 | # # QRCodeChannelProperties 2 | QR Code Channel Properties 3 | 4 | ```php 5 | use Xendit\PaymentMethod\QRCodeChannelProperties; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **qr_string** | **string** | | QR string to be rendered for display to end users. QR string to image rendering are commonly available in software libraries (e.g Nodejs, PHP, Java) | 0002010102##########CO.XENDIT.WWW011893600#######14220002152#####414220010303TTT####015CO.XENDIT.WWW02180000000000000000000TTT52 045######ID5911XenditQRIS6007Jakarta6105121606##########3k1mOnF73h11111111#3k1mOnF73h6v53033605401163040BDB | 13 | | **expires_at** | **\DateTime** | | | 2022-01-01T00:00Z | 14 | 15 | 16 | [[Back to README]](../../README.md) 17 | -------------------------------------------------------------------------------- /docs/PaymentMethod/QRCodeParameters.md: -------------------------------------------------------------------------------- 1 | # # QRCodeParameters 2 | 3 | 4 | ```php 5 | use Xendit\PaymentMethod\QRCodeParameters; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **amount** | **float** | | | null | 13 | | **currency** | **string** | | | null | 14 | | **channel_code** | [**QRCodeChannelCode**](QRCodeChannelCode.md) | | | null | 15 | | **channel_properties** | [**QRCodeChannelProperties**](QRCodeChannelProperties.md) | | | null | 16 | 17 | 18 | [[Back to README]](../../README.md) 19 | -------------------------------------------------------------------------------- /docs/PaymentMethod/SimulatePaymentRequest.md: -------------------------------------------------------------------------------- 1 | # # SimulatePaymentRequest 2 | 3 | 4 | ```php 5 | use Xendit\PaymentMethod\SimulatePaymentRequest; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **amount** | **float** | | | null | 13 | 14 | 15 | [[Back to README]](../../README.md) 16 | -------------------------------------------------------------------------------- /docs/PaymentMethod/TokenizedCardInformation.md: -------------------------------------------------------------------------------- 1 | # # TokenizedCardInformation 2 | Tokenized Card Information 3 | 4 | ```php 5 | use Xendit\PaymentMethod\TokenizedCardInformation; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **token_id** | **string** | | | null | 13 | | **masked_card_number** | **string** | | 1st 6 and last 4 digits of the card | null | 14 | | **cardholder_name** | **string** | | Cardholder name is optional but recommended for 3DS 2 / AVS verification | null | 15 | | **expiry_month** | **string** | | Card expiry month in MM format | null | 16 | | **expiry_year** | **string** | | Card expiry month in YY format | null | 17 | | **fingerprint** | **string** | | Xendit-generated identifier for the unique card number. Multiple payment method objects can be created for the same account - e.g. if the user first creates a one-time payment request, and then later on creates a multiple-use payment method using the same account. The fingerprint helps to identify the unique account being used. | null | 18 | | **type** | **string** | | Whether the card is a credit or debit card | null | 19 | | **network** | **string** | | Card network - VISA, MASTERCARD, JCB, AMEX, DISCOVER, BCA | null | 20 | | **country** | **string** | | Country where the card was issued ISO 3166-1 Alpha-2 | null | 21 | | **issuer** | **string** | | Issuer of the card, most often an issuing bank For example, “BCA”, “MANDIRI” | null | 22 | | **card_number** | **string** | | | null | 23 | | **one_time_token** | **string** | | | null | 24 | 25 | 26 | [[Back to README]](../../README.md) 27 | -------------------------------------------------------------------------------- /docs/PaymentMethod/VirtualAccount.md: -------------------------------------------------------------------------------- 1 | # # VirtualAccount 2 | Virtual Account Payment Method Details 3 | 4 | ```php 5 | use Xendit\PaymentMethod\VirtualAccount; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **amount** | **float** | | | null | 13 | | **min_amount** | **float** | | | null | 14 | | **max_amount** | **float** | | | null | 15 | | **currency** | **string** | | | null | 16 | | **channel_code** | [**VirtualAccountChannelCode**](VirtualAccountChannelCode.md) | ☑️ | | null | 17 | | **channel_properties** | [**VirtualAccountChannelProperties**](VirtualAccountChannelProperties.md) | ☑️ | | null | 18 | | **alternative_display_types** | **string[]** | | For payments in Vietnam only, alternative display requested for the virtual account | null | 19 | | **alternative_displays** | [**array**](VirtualAccountAlternativeDisplay.md) | | | null | 20 | 21 | 22 | [[Back to README]](../../README.md) 23 | -------------------------------------------------------------------------------- /docs/PaymentMethod/VirtualAccountAllOf.md: -------------------------------------------------------------------------------- 1 | # # VirtualAccountAllOf 2 | 3 | 4 | ```php 5 | use Xendit\PaymentMethod\VirtualAccountAllOf; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **alternative_displays** | [**array**](VirtualAccountAlternativeDisplay.md) | | | null | 13 | 14 | 15 | [[Back to README]](../../README.md) 16 | -------------------------------------------------------------------------------- /docs/PaymentMethod/VirtualAccountAlternativeDisplay.md: -------------------------------------------------------------------------------- 1 | # # VirtualAccountAlternativeDisplay 2 | Alternative Display Object 3 | 4 | ```php 5 | use Xendit\PaymentMethod\VirtualAccountAlternativeDisplay; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **type** | **string** | | Type of the alternative display | null | 13 | | **data** | **string** | | Data payload of the given alternative display | null | 14 | 15 | 16 | [[Back to README]](../../README.md) 17 | -------------------------------------------------------------------------------- /docs/PaymentMethod/VirtualAccountChannelCode.md: -------------------------------------------------------------------------------- 1 | # # VirtualAccountChannelCode 2 | Virtual Account Channel Code 3 | 4 | ```php 5 | use Xendit\PaymentMethod\VirtualAccountChannelCode; 6 | ``` 7 | 8 | 9 | ## Enum 10 | 11 | 12 | * `BCA` (value: `'BCA'`) 13 | 14 | * `BJB` (value: `'BJB'`) 15 | 16 | * `BNI` (value: `'BNI'`) 17 | 18 | * `BRI` (value: `'BRI'`) 19 | 20 | * `MANDIRI` (value: `'MANDIRI'`) 21 | 22 | * `PERMATA` (value: `'PERMATA'`) 23 | 24 | * `BSI` (value: `'BSI'`) 25 | 26 | * `CIMB` (value: `'CIMB'`) 27 | 28 | * `SAHABAT_SAMPOERNA` (value: `'SAHABAT_SAMPOERNA'`) 29 | 30 | * `ARTAJASA` (value: `'ARTAJASA'`) 31 | 32 | * `PV` (value: `'PV'`) 33 | 34 | * `VIETCAPITAL` (value: `'VIETCAPITAL'`) 35 | 36 | * `WOORI` (value: `'WOORI'`) 37 | 38 | * `MSB` (value: `'MSB'`) 39 | 40 | * `VPB` (value: `'VPB'`) 41 | 42 | * `BIDV` (value: `'BIDV'`) 43 | 44 | * `CAKE` (value: `'CAKE'`) 45 | 46 | * `STANDARD_CHARTERED` (value: `'STANDARD_CHARTERED'`) 47 | 48 | * `AMBANK` (value: `'AMBANK'`) 49 | 50 | * `UOB` (value: `'UOB'`) 51 | 52 | * `BNC` (value: `'BNC'`) 53 | 54 | * `HANA` (value: `'HANA'`) 55 | 56 | * `MUAMALAT` (value: `'MUAMALAT'`) 57 | 58 | * `BANK_TRANSFER` (value: `'BANK_TRANSFER'`) 59 | 60 | * `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) 61 | 62 | If you encounter `UNKNOWN_ENUM_VALUE`, it means that this ENUM is unavailable in your current SDK version. Please upgrade to get the newest ENUM. 63 | 64 | [[Back to README]](../../README.md) 65 | -------------------------------------------------------------------------------- /docs/PaymentMethod/VirtualAccountChannelProperties.md: -------------------------------------------------------------------------------- 1 | # # VirtualAccountChannelProperties 2 | Virtual Account Channel Properties 3 | 4 | ```php 5 | use Xendit\PaymentMethod\VirtualAccountChannelProperties; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **customer_name** | **string** | | Name of customer. | Rika Sutanto | 13 | | **virtual_account_number** | **string** | | You can assign specific Virtual Account number using this parameter. If you do not send one, one will be picked at random. Make sure the number you specify is within your Virtual Account range. | 262159999999999 | 14 | | **expires_at** | **\DateTime** | | The date and time in ISO 8601 UTC+0 when the virtual account number will be expired. Default: The default expiration date will be 31 years from creation date. | 2022-01-01T00:00Z | 15 | | **suggested_amount** | **float** | | The suggested amount you want to assign. Note: Suggested amounts is the amounts that can see as a suggestion, but user can still put any numbers (only supported for Mandiri and BRI) | 100000 | 16 | 17 | 18 | [[Back to README]](../../README.md) 19 | -------------------------------------------------------------------------------- /docs/PaymentMethod/VirtualAccountChannelPropertiesPatch.md: -------------------------------------------------------------------------------- 1 | # # VirtualAccountChannelPropertiesPatch 2 | Virtual Account Channel Properties 3 | 4 | ```php 5 | use Xendit\PaymentMethod\VirtualAccountChannelPropertiesPatch; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **expires_at** | **\DateTime** | | The date and time in ISO 8601 UTC+0 when the virtual account number will be expired. Default: The default expiration date will be 31 years from creation date. | 2022-01-01T00:00Z | 13 | | **suggested_amount** | **float** | | The suggested amount you want to assign. Note: Suggested amounts is the amounts that can see as a suggestion, but user can still put any numbers (only supported for Mandiri and BRI) | 100000 | 14 | 15 | 16 | [[Back to README]](../../README.md) 17 | -------------------------------------------------------------------------------- /docs/PaymentMethod/VirtualAccountParameters.md: -------------------------------------------------------------------------------- 1 | # # VirtualAccountParameters 2 | 3 | 4 | ```php 5 | use Xendit\PaymentMethod\VirtualAccountParameters; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **amount** | **float** | | | null | 13 | | **min_amount** | **float** | | | null | 14 | | **max_amount** | **float** | | | null | 15 | | **currency** | **string** | | | null | 16 | | **channel_code** | [**VirtualAccountChannelCode**](VirtualAccountChannelCode.md) | ☑️ | | null | 17 | | **channel_properties** | [**VirtualAccountChannelProperties**](VirtualAccountChannelProperties.md) | ☑️ | | null | 18 | | **alternative_display_types** | **string[]** | | For payments in Vietnam only, alternative display requested for the virtual account | null | 19 | 20 | 21 | [[Back to README]](../../README.md) 22 | -------------------------------------------------------------------------------- /docs/PaymentMethod/VirtualAccountUpdateParameters.md: -------------------------------------------------------------------------------- 1 | # # VirtualAccountUpdateParameters 2 | 3 | 4 | ```php 5 | use Xendit\PaymentMethod\VirtualAccountUpdateParameters; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **amount** | **float** | | | null | 13 | | **min_amount** | **float** | | | null | 14 | | **max_amount** | **float** | | | null | 15 | | **channel_properties** | [**VirtualAccountChannelPropertiesPatch**](VirtualAccountChannelPropertiesPatch.md) | | | null | 16 | | **alternative_display_types** | **string[]** | | For payments in Vietnam only, alternative display requested for the virtual account | null | 17 | 18 | 19 | [[Back to README]](../../README.md) 20 | -------------------------------------------------------------------------------- /docs/PaymentRequest/Capture.md: -------------------------------------------------------------------------------- 1 | # # Capture 2 | 3 | 4 | ```php 5 | use Xendit\PaymentRequest\Capture; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **id** | **string** | ☑️ | | null | 13 | | **payment_request_id** | **string** | ☑️ | | null | 14 | | **payment_id** | **string** | ☑️ | | null | 15 | | **reference_id** | **string** | ☑️ | | null | 16 | | **currency** | **string** | ☑️ | | null | 17 | | **authorized_amount** | **float** | ☑️ | | null | 18 | | **captured_amount** | **float** | ☑️ | | null | 19 | | **status** | **string** | ☑️ | | null | 20 | | **payment_method** | [**PaymentMethod**](PaymentMethod.md) | ☑️ | | null | 21 | | **failure_code** | **string** | ☑️ | | null | 22 | | **customer_id** | **string** | ☑️ | | null | 23 | | **metadata** | **object** | ☑️ | | null | 24 | | **channel_properties** | **object** | ☑️ | | null | 25 | | **created** | **string** | ☑️ | | null | 26 | | **updated** | **string** | ☑️ | | null | 27 | 28 | 29 | [[Back to README]](../../README.md) 30 | -------------------------------------------------------------------------------- /docs/PaymentRequest/CaptureListResponse.md: -------------------------------------------------------------------------------- 1 | # # CaptureListResponse 2 | 3 | 4 | ```php 5 | use Xendit\PaymentRequest\CaptureListResponse; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **data** | [**array**](Capture.md) | ☑️ | | null | 13 | | **has_more** | **bool** | ☑️ | | null | 14 | 15 | 16 | [[Back to README]](../../README.md) 17 | -------------------------------------------------------------------------------- /docs/PaymentRequest/CaptureParameters.md: -------------------------------------------------------------------------------- 1 | # # CaptureParameters 2 | 3 | 4 | ```php 5 | use Xendit\PaymentRequest\CaptureParameters; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **reference_id** | **string** | | | null | 13 | | **capture_amount** | **float** | ☑️ | | null | 14 | 15 | 16 | [[Back to README]](../../README.md) 17 | -------------------------------------------------------------------------------- /docs/PaymentRequest/Card.md: -------------------------------------------------------------------------------- 1 | # # Card 2 | 3 | 4 | ```php 5 | use Xendit\PaymentRequest\Card; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **channel_code** | [**CardChannelCode**](CardChannelCode.md) | | | null | 13 | | **currency** | [**PaymentRequestCurrency**](PaymentRequestCurrency.md) | | | null | 14 | | **channel_properties** | [**CardChannelProperties**](CardChannelProperties.md) | ☑️ | | null | 15 | | **card_information** | [**CardInformation**](CardInformation.md) | | | null | 16 | | **card_verification_results** | [**CardVerificationResults**](CardVerificationResults.md) | | | null | 17 | 18 | 19 | [[Back to README]](../../README.md) 20 | -------------------------------------------------------------------------------- /docs/PaymentRequest/CardChannelCode.md: -------------------------------------------------------------------------------- 1 | # # CardChannelCode 2 | Card Channel Code 3 | 4 | ```php 5 | use Xendit\PaymentRequest\CardChannelCode; 6 | ``` 7 | 8 | 9 | ## Enum 10 | 11 | 12 | * `BAY_CARD_INSTALLMENT` (value: `'BAY_CARD_INSTALLMENT'`) 13 | 14 | * `BBL_CARD_INSTALLMENT` (value: `'BBL_CARD_INSTALLMENT'`) 15 | 16 | * `GPN` (value: `'GPN'`) 17 | 18 | * `KBANK_CARD_INSTALLMENT` (value: `'KBANK_CARD_INSTALLMENT'`) 19 | 20 | * `KTB_CARD_INSTALLMENT` (value: `'KTB_CARD_INSTALLMENT'`) 21 | 22 | * `SCB_CARD_INSTALLMENT` (value: `'SCB_CARD_INSTALLMENT'`) 23 | 24 | * `TTB_CARD_INSTALLMENT` (value: `'TTB_CARD_INSTALLMENT'`) 25 | 26 | * `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) 27 | 28 | If you encounter `UNKNOWN_ENUM_VALUE`, it means that this ENUM is unavailable in your current SDK version. Please upgrade to get the newest ENUM. 29 | 30 | [[Back to README]](../../README.md) 31 | -------------------------------------------------------------------------------- /docs/PaymentRequest/CardChannelProperties.md: -------------------------------------------------------------------------------- 1 | # # CardChannelProperties 2 | Card Channel Properties 3 | 4 | ```php 5 | use Xendit\PaymentRequest\CardChannelProperties; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **skip_three_d_secure** | **bool** | | To indicate whether to perform 3DS during the linking phase | false | 13 | | **success_return_url** | **string** | | URL where the end-customer is redirected if the authorization is successful | https://webhook.site/f4b755f5-4770-4a11-8c72-cc0b3cc6b882 | 14 | | **failure_return_url** | **string** | | URL where the end-customer is redirected if the authorization failed | https://webhook.site/f4b755f5-4770-4a11-8c72-cc0b3cc6b882 | 15 | | **cardonfile_type** | **string** | | Type of “credential-on-file” / “card-on-file” payment being made. Indicate that this payment uses a previously linked Payment Method for charging. | RECURRING | 16 | | **merchant_id_tag** | **string** | | Tag for a Merchant ID that you want to associate this payment with. For merchants using their own MIDs to specify which MID they want to use | null | 17 | | **expires_at** | **\DateTime** | | | null | 18 | | **installment_configuration** | [**CardInstallmentConfiguration**](CardInstallmentConfiguration.md) | | | null | 19 | | **skip_authorization** | **bool** | | To indicate whether to skip the authorization phase | false | 20 | 21 | 22 | [[Back to README]](../../README.md) 23 | -------------------------------------------------------------------------------- /docs/PaymentRequest/CardInformation.md: -------------------------------------------------------------------------------- 1 | # # CardInformation 2 | Card Information 3 | 4 | ```php 5 | use Xendit\PaymentRequest\CardInformation; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **token_id** | **string** | | | null | 13 | | **masked_card_number** | **string** | | 1st 6 and last 4 digits of the card | null | 14 | | **expiry_month** | **string** | | Card expiry month in MM format | null | 15 | | **expiry_year** | **string** | | Card expiry month in YY format | null | 16 | | **cardholder_name** | **string** | | Cardholder name | null | 17 | | **fingerprint** | **string** | | | null | 18 | | **type** | **string** | | | null | 19 | | **network** | **string** | | | null | 20 | | **country** | **string** | | | null | 21 | | **issuer** | **string** | | | null | 22 | | **card_number** | **string** | | | null | 23 | | **one_time_token** | **string** | | | null | 24 | 25 | 26 | [[Back to README]](../../README.md) 27 | -------------------------------------------------------------------------------- /docs/PaymentRequest/CardInstallmentConfiguration.md: -------------------------------------------------------------------------------- 1 | # # CardInstallmentConfiguration 2 | Card Installment Configuration 3 | 4 | ```php 5 | use Xendit\PaymentRequest\CardInstallmentConfiguration; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **terms** | **int** | | | null | 13 | | **interval** | **string** | | | MONTH | 14 | | **code** | **string** | | | 123 | 15 | 16 | 17 | [[Back to README]](../../README.md) 18 | -------------------------------------------------------------------------------- /docs/PaymentRequest/CardParameters.md: -------------------------------------------------------------------------------- 1 | # # CardParameters 2 | 3 | 4 | ```php 5 | use Xendit\PaymentRequest\CardParameters; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **channel_properties** | [**CardChannelProperties**](CardChannelProperties.md) | ☑️ | | null | 13 | | **card_information** | [**CardInformation**](CardInformation.md) | | | null | 14 | 15 | 16 | [[Back to README]](../../README.md) 17 | -------------------------------------------------------------------------------- /docs/PaymentRequest/CardVerificationResults.md: -------------------------------------------------------------------------------- 1 | # # CardVerificationResults 2 | 3 | 4 | ```php 5 | use Xendit\PaymentRequest\CardVerificationResults; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **three_d_secure** | [**CardVerificationResultsThreeDSecure**](CardVerificationResultsThreeDSecure.md) | | | null | 13 | | **cvv_result** | **string** | | | null | 14 | | **address_verification_result** | **string** | | | null | 15 | 16 | 17 | [[Back to README]](../../README.md) 18 | -------------------------------------------------------------------------------- /docs/PaymentRequest/CardVerificationResultsThreeDSecure.md: -------------------------------------------------------------------------------- 1 | # # CardVerificationResultsThreeDSecure 2 | 3 | 4 | ```php 5 | use Xendit\PaymentRequest\CardVerificationResultsThreeDSecure; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **three_d_secure_flow** | **string** | | | null | 13 | | **eci_code** | **string** | | | null | 14 | | **three_d_secure_result** | **string** | | | null | 15 | | **three_d_secure_result_reason** | **string** | | | null | 16 | | **three_d_secure_version** | **string** | | | null | 17 | 18 | 19 | [[Back to README]](../../README.md) 20 | -------------------------------------------------------------------------------- /docs/PaymentRequest/DirectDebit.md: -------------------------------------------------------------------------------- 1 | # # DirectDebit 2 | Direct Debit Payment Method Details 3 | 4 | ```php 5 | use Xendit\PaymentRequest\DirectDebit; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **channel_code** | [**DirectDebitChannelCode**](DirectDebitChannelCode.md) | ☑️ | | null | 13 | | **channel_properties** | [**DirectDebitChannelProperties**](DirectDebitChannelProperties.md) | ☑️ | | null | 14 | | **type** | [**DirectDebitType**](DirectDebitType.md) | ☑️ | | null | 15 | | **bank_account** | [**DirectDebitBankAccount**](DirectDebitBankAccount.md) | | | null | 16 | | **debit_card** | [**DirectDebitDebitCard**](DirectDebitDebitCard.md) | | | null | 17 | 18 | 19 | [[Back to README]](../../README.md) 20 | -------------------------------------------------------------------------------- /docs/PaymentRequest/DirectDebitAllOf.md: -------------------------------------------------------------------------------- 1 | # # DirectDebitAllOf 2 | 3 | 4 | ```php 5 | use Xendit\PaymentRequest\DirectDebitAllOf; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **type** | [**DirectDebitType**](DirectDebitType.md) | ☑️ | | null | 13 | | **bank_account** | [**DirectDebitBankAccount**](DirectDebitBankAccount.md) | | | null | 14 | | **debit_card** | [**DirectDebitDebitCard**](DirectDebitDebitCard.md) | | | null | 15 | 16 | 17 | [[Back to README]](../../README.md) 18 | -------------------------------------------------------------------------------- /docs/PaymentRequest/DirectDebitBankAccount.md: -------------------------------------------------------------------------------- 1 | # # DirectDebitBankAccount 2 | 3 | 4 | ```php 5 | use Xendit\PaymentRequest\DirectDebitBankAccount; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **masked_bank_account_number** | **string** | | | 233eca40ff303ba15bf39052ca3102c6 | 13 | | **bank_account_hash** | **string** | | | 233eca40ff303ba15bf39052ca3102c6 | 14 | 15 | 16 | [[Back to README]](../../README.md) 17 | -------------------------------------------------------------------------------- /docs/PaymentRequest/DirectDebitChannelProperties.md: -------------------------------------------------------------------------------- 1 | # # DirectDebitChannelProperties 2 | 3 | 4 | ```php 5 | use Xendit\PaymentRequest\DirectDebitChannelProperties; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **email** | **string** | | Email address of the customer that is registered to the partner channel | test.email@xendit.co | 13 | | **mobile_number** | **string** | | Mobile number of the customer registered to the partner channel | +62818555988 | 14 | | **success_return_url** | **string** | | | null | 15 | | **failure_return_url** | **string** | | | null | 16 | | **identity_document_number** | **string** | | | null | 17 | | **account_number** | **string** | | | 1234567890 | 18 | | **card_last_four** | **string** | | Last four digits of the debit card | 8888 | 19 | | **card_expiry** | **string** | | Expiry month and year of the debit card (in MM/YY format) | 06/24 | 20 | 21 | 22 | [[Back to README]](../../README.md) 23 | -------------------------------------------------------------------------------- /docs/PaymentRequest/DirectDebitChannelPropertiesBankAccount.md: -------------------------------------------------------------------------------- 1 | # # DirectDebitChannelPropertiesBankAccount 2 | Direct Debit Bank Account Channel Properties 3 | 4 | ```php 5 | use Xendit\PaymentRequest\DirectDebitChannelPropertiesBankAccount; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **success_return_url** | **string** | | | null | 13 | | **failure_return_url** | **string** | | | null | 14 | | **mobile_number** | **string** | | | null | 15 | | **identity_document_number** | **string** | | | null | 16 | 17 | 18 | [[Back to README]](../../README.md) 19 | -------------------------------------------------------------------------------- /docs/PaymentRequest/DirectDebitChannelPropertiesBankRedirect.md: -------------------------------------------------------------------------------- 1 | # # DirectDebitChannelPropertiesBankRedirect 2 | Direct Debit Bank Account Channel Properties 3 | 4 | ```php 5 | use Xendit\PaymentRequest\DirectDebitChannelPropertiesBankRedirect; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **email** | **string** | | | null | 13 | | **mobile_number** | **string** | | Mobile number of the customer that is registered to channel | null | 14 | | **success_return_url** | **string** | | | null | 15 | | **failure_return_url** | **string** | | | null | 16 | 17 | 18 | [[Back to README]](../../README.md) 19 | -------------------------------------------------------------------------------- /docs/PaymentRequest/DirectDebitChannelPropertiesDebitCard.md: -------------------------------------------------------------------------------- 1 | # # DirectDebitChannelPropertiesDebitCard 2 | Direct Debit Debit Card Channel Properties 3 | 4 | ```php 5 | use Xendit\PaymentRequest\DirectDebitChannelPropertiesDebitCard; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **mobile_number** | **string** | | Mobile number of the customer registered to the partner channel | +62818555988 | 13 | | **account_number** | **string** | | | 1234567890 | 14 | | **card_last_four** | **string** | | Last four digits of the debit card | 8888 | 15 | | **card_expiry** | **string** | | Expiry month and year of the debit card (in MM/YY format) | 06/24 | 16 | | **email** | **string** | | Email address of the customer that is registered to the partner channel | test.email@xendit.co | 17 | 18 | 19 | [[Back to README]](../../README.md) 20 | -------------------------------------------------------------------------------- /docs/PaymentRequest/DirectDebitDebitCard.md: -------------------------------------------------------------------------------- 1 | # # DirectDebitDebitCard 2 | 3 | 4 | ```php 5 | use Xendit\PaymentRequest\DirectDebitDebitCard; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **mobile_number** | **string** | | Mobile number of the customer registered to the partner channel | +62818555988 | 13 | | **account_number** | **string** | | | 1234567890 | 14 | | **card_last_four** | **string** | | Last four digits of the debit card | 8888 | 15 | | **card_expiry** | **string** | | Expiry month and year of the debit card (in MM/YY format) | 06/24 | 16 | | **email** | **string** | | Email address of the customer that is registered to the partner channel | test.email@xendit.co | 17 | 18 | 19 | [[Back to README]](../../README.md) 20 | -------------------------------------------------------------------------------- /docs/PaymentRequest/DirectDebitParameters.md: -------------------------------------------------------------------------------- 1 | # # DirectDebitParameters 2 | 3 | 4 | ```php 5 | use Xendit\PaymentRequest\DirectDebitParameters; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **channel_code** | [**DirectDebitChannelCode**](DirectDebitChannelCode.md) | ☑️ | | null | 13 | | **channel_properties** | [**DirectDebitChannelProperties**](DirectDebitChannelProperties.md) | ☑️ | | null | 14 | | **type** | [**DirectDebitType**](DirectDebitType.md) | | | null | 15 | 16 | 17 | [[Back to README]](../../README.md) 18 | -------------------------------------------------------------------------------- /docs/PaymentRequest/DirectDebitType.md: -------------------------------------------------------------------------------- 1 | # # DirectDebitType 2 | 3 | 4 | ```php 5 | use Xendit\PaymentRequest\DirectDebitType; 6 | ``` 7 | 8 | 9 | ## Enum 10 | 11 | 12 | * `DEBIT_CARD` (value: `'DEBIT_CARD'`) 13 | 14 | * `BANK_ACCOUNT` (value: `'BANK_ACCOUNT'`) 15 | 16 | * `BANK_REDIRECT` (value: `'BANK_REDIRECT'`) 17 | 18 | * `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) 19 | 20 | If you encounter `UNKNOWN_ENUM_VALUE`, it means that this ENUM is unavailable in your current SDK version. Please upgrade to get the newest ENUM. 21 | 22 | [[Back to README]](../../README.md) 23 | -------------------------------------------------------------------------------- /docs/PaymentRequest/EWallet.md: -------------------------------------------------------------------------------- 1 | # # EWallet 2 | Ewallet Payment Method Details 3 | 4 | ```php 5 | use Xendit\PaymentRequest\EWallet; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **channel_code** | [**EWalletChannelCode**](EWalletChannelCode.md) | | | null | 13 | | **channel_properties** | [**EWalletChannelProperties**](EWalletChannelProperties.md) | | | null | 14 | | **account** | [**EWalletAccount**](EWalletAccount.md) | | | null | 15 | 16 | 17 | [[Back to README]](../../README.md) 18 | -------------------------------------------------------------------------------- /docs/PaymentRequest/EWalletAccount.md: -------------------------------------------------------------------------------- 1 | # # EWalletAccount 2 | EWallet Account Properties 3 | 4 | ```php 5 | use Xendit\PaymentRequest\EWalletAccount; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **name** | **string** | | Name of the eWallet account holder. The value is null if unavailableName of the eWallet account holder. The value is null if unavailable | null | 13 | | **account_details** | **string** | | Identifier from eWallet provider e.g. phone number. The value is null if unavailable | null | 14 | | **balance** | **float** | | The main balance amount on eWallet account provided from eWallet provider. The value is null if unavailable | null | 15 | | **point_balance** | **float** | | The point balance amount on eWallet account. Applicable only on some eWallet provider that has point system. The value is null if unavailabl | null | 16 | 17 | 18 | [[Back to README]](../../README.md) 19 | -------------------------------------------------------------------------------- /docs/PaymentRequest/EWalletAllOf.md: -------------------------------------------------------------------------------- 1 | # # EWalletAllOf 2 | 3 | 4 | ```php 5 | use Xendit\PaymentRequest\EWalletAllOf; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **account** | [**EWalletAccount**](EWalletAccount.md) | | | null | 13 | 14 | 15 | [[Back to README]](../../README.md) 16 | -------------------------------------------------------------------------------- /docs/PaymentRequest/EWalletChannelCode.md: -------------------------------------------------------------------------------- 1 | # # EWalletChannelCode 2 | Ewallet Channel Code 3 | 4 | ```php 5 | use Xendit\PaymentRequest\EWalletChannelCode; 6 | ``` 7 | 8 | 9 | ## Enum 10 | 11 | 12 | * `GCASH` (value: `'GCASH'`) 13 | 14 | * `GRABPAY` (value: `'GRABPAY'`) 15 | 16 | * `PAYMAYA` (value: `'PAYMAYA'`) 17 | 18 | * `DANA` (value: `'DANA'`) 19 | 20 | * `OVO` (value: `'OVO'`) 21 | 22 | * `LINKAJA` (value: `'LINKAJA'`) 23 | 24 | * `SHOPEEPAY` (value: `'SHOPEEPAY'`) 25 | 26 | * `NEXCASH` (value: `'NEXCASH'`) 27 | 28 | * `ASTRAPAY` (value: `'ASTRAPAY'`) 29 | 30 | * `JENIUSPAY` (value: `'JENIUSPAY'`) 31 | 32 | * `APPOTA` (value: `'APPOTA'`) 33 | 34 | * `MOMO` (value: `'MOMO'`) 35 | 36 | * `VNPTWALLET` (value: `'VNPTWALLET'`) 37 | 38 | * `VIETTELPAY` (value: `'VIETTELPAY'`) 39 | 40 | * `ZALOPAY` (value: `'ZALOPAY'`) 41 | 42 | * `WECHATPAY` (value: `'WECHATPAY'`) 43 | 44 | * `LINEPAY` (value: `'LINEPAY'`) 45 | 46 | * `TRUEMONEY` (value: `'TRUEMONEY'`) 47 | 48 | * `ALIPAY` (value: `'ALIPAY'`) 49 | 50 | * `TOUCHNGO` (value: `'TOUCHNGO'`) 51 | 52 | * `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) 53 | 54 | If you encounter `UNKNOWN_ENUM_VALUE`, it means that this ENUM is unavailable in your current SDK version. Please upgrade to get the newest ENUM. 55 | 56 | [[Back to README]](../../README.md) 57 | -------------------------------------------------------------------------------- /docs/PaymentRequest/EWalletChannelProperties.md: -------------------------------------------------------------------------------- 1 | # # EWalletChannelProperties 2 | Ewallet Channel Properties 3 | 4 | ```php 5 | use Xendit\PaymentRequest\EWalletChannelProperties; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **success_return_url** | **string** | | URL where the end-customer is redirected if the authorization is successful | https://webhook.site/f4b755f5-4770-4a11-8c72-cc0b3cc6b882 | 13 | | **pending_return_url** | **string** | | URL where the end-customer is redirected if the authorization is successful | https://webhook.site/f4b755f5-4770-4a11-8c72-cc0b3cc6b882 | 14 | | **failure_return_url** | **string** | | URL where the end-customer is redirected if the authorization failed | https://webhook.site/f4b755f5-4770-4a11-8c72-cc0b3cc6b882 | 15 | | **cancel_return_url** | **string** | | URL where the end-customer is redirected if the authorization cancelled | https://webhook.site/f4b755f5-4770-4a11-8c72-cc0b3cc6b882 | 16 | | **redeem_points** | **string** | | REDEEM_NONE will not use any point, REDEEM_ALL will use all available points before cash balance is used. For OVO and ShopeePay tokenized payment use only. | REDEEM_NONE | 17 | | **mobile_number** | **string** | | | null | 18 | | **cashtag** | **string** | | | null | 19 | | **promotion_label** | **string** | | | null | 20 | 21 | 22 | [[Back to README]](../../README.md) 23 | -------------------------------------------------------------------------------- /docs/PaymentRequest/EWalletParameters.md: -------------------------------------------------------------------------------- 1 | # # EWalletParameters 2 | 3 | 4 | ```php 5 | use Xendit\PaymentRequest\EWalletParameters; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **channel_code** | [**EWalletChannelCode**](EWalletChannelCode.md) | | | null | 13 | | **channel_properties** | [**EWalletChannelProperties**](EWalletChannelProperties.md) | | | null | 14 | 15 | 16 | [[Back to README]](../../README.md) 17 | -------------------------------------------------------------------------------- /docs/PaymentRequest/Error.md: -------------------------------------------------------------------------------- 1 | # # Error 2 | 3 | 4 | ```php 5 | use Xendit\PaymentRequest\Error; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **error_code** | **string** | | | null | 13 | | **message** | **string** | | | An internal server error occurred | 14 | 15 | 16 | [[Back to README]](../../README.md) 17 | -------------------------------------------------------------------------------- /docs/PaymentRequest/InvoicePartnerMetadata.md: -------------------------------------------------------------------------------- 1 | # # InvoicePartnerMetadata 2 | 3 | 4 | ```php 5 | use Xendit\PaymentRequest\InvoicePartnerMetadata; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **notes** | **string** | | | null | 13 | 14 | 15 | [[Back to README]](../../README.md) 16 | -------------------------------------------------------------------------------- /docs/PaymentRequest/OverTheCounter.md: -------------------------------------------------------------------------------- 1 | # # OverTheCounter 2 | Over the Counter Payment Method Details 3 | 4 | ```php 5 | use Xendit\PaymentRequest\OverTheCounter; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **amount** | **float** | | | null | 13 | | **currency** | [**PaymentRequestCurrency**](PaymentRequestCurrency.md) | | | null | 14 | | **channel_code** | [**OverTheCounterChannelCode**](OverTheCounterChannelCode.md) | ☑️ | | null | 15 | | **channel_properties** | [**OverTheCounterChannelProperties**](OverTheCounterChannelProperties.md) | ☑️ | | null | 16 | 17 | 18 | [[Back to README]](../../README.md) 19 | -------------------------------------------------------------------------------- /docs/PaymentRequest/OverTheCounterChannelCode.md: -------------------------------------------------------------------------------- 1 | # # OverTheCounterChannelCode 2 | Over The Counter Channel Code 3 | 4 | ```php 5 | use Xendit\PaymentRequest\OverTheCounterChannelCode; 6 | ``` 7 | 8 | 9 | ## Enum 10 | 11 | 12 | * `_7_ELEVEN` (value: `'7ELEVEN'`) 13 | 14 | * `_7_ELEVEN_CLIQQ` (value: `'7ELEVEN_CLIQQ'`) 15 | 16 | * `CEBUANA` (value: `'CEBUANA'`) 17 | 18 | * `ECPAY` (value: `'ECPAY'`) 19 | 20 | * `PALAWAN` (value: `'PALAWAN'`) 21 | 22 | * `MLHUILLIER` (value: `'MLHUILLIER'`) 23 | 24 | * `ECPAY_DRAGONLOAN` (value: `'ECPAY_DRAGONLOAN'`) 25 | 26 | * `LBC` (value: `'LBC'`) 27 | 28 | * `ECPAY_SCHOOL` (value: `'ECPAY_SCHOOL'`) 29 | 30 | * `RD_PAWNSHOP` (value: `'RD_PAWNSHOP'`) 31 | 32 | * `CVM` (value: `'CVM'`) 33 | 34 | * `USSC` (value: `'USSC'`) 35 | 36 | * `SM_BILLS` (value: `'SM_BILLS'`) 37 | 38 | * `ROBINSONS_BILLS` (value: `'ROBINSONS_BILLS'`) 39 | 40 | * `ALFAMART` (value: `'ALFAMART'`) 41 | 42 | * `INDOMARET` (value: `'INDOMARET'`) 43 | 44 | * `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) 45 | 46 | If you encounter `UNKNOWN_ENUM_VALUE`, it means that this ENUM is unavailable in your current SDK version. Please upgrade to get the newest ENUM. 47 | 48 | [[Back to README]](../../README.md) 49 | -------------------------------------------------------------------------------- /docs/PaymentRequest/OverTheCounterChannelProperties.md: -------------------------------------------------------------------------------- 1 | # # OverTheCounterChannelProperties 2 | Over The Counter Channel Properties 3 | 4 | ```php 5 | use Xendit\PaymentRequest\OverTheCounterChannelProperties; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **payment_code** | **string** | | The payment code that you want to assign, e.g 12345. If you do not send one, one will be picked at random. | 12345 | 13 | | **customer_name** | **string** | ☑️ | Name of customer. | Rika Sutanto | 14 | | **expires_at** | **\DateTime** | | The time when the payment code will be expired. The minimum is 2 hours and the maximum is 9 days for 7ELEVEN. Default expired date will be 2 days from payment code generated. | 2022-01-01T00:00Z | 15 | 16 | 17 | [[Back to README]](../../README.md) 18 | -------------------------------------------------------------------------------- /docs/PaymentRequest/OverTheCounterParameters.md: -------------------------------------------------------------------------------- 1 | # # OverTheCounterParameters 2 | 3 | 4 | ```php 5 | use Xendit\PaymentRequest\OverTheCounterParameters; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **amount** | **float** | | | null | 13 | | **currency** | [**PaymentRequestCurrency**](PaymentRequestCurrency.md) | | | null | 14 | | **channel_code** | [**OverTheCounterChannelCode**](OverTheCounterChannelCode.md) | ☑️ | | null | 15 | | **channel_properties** | [**OverTheCounterChannelProperties**](OverTheCounterChannelProperties.md) | ☑️ | | null | 16 | 17 | 18 | [[Back to README]](../../README.md) 19 | -------------------------------------------------------------------------------- /docs/PaymentRequest/PaymentCallback.md: -------------------------------------------------------------------------------- 1 | # # PaymentCallback 2 | Callback for successful or failed payments made via the Payments API 3 | 4 | ```php 5 | use Xendit\PaymentRequest\PaymentCallback; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **event** | **string** | ☑️ | Identifies the event that triggered a notification to the merchant | null | 13 | | **business_id** | **string** | ☑️ | business_id | null | 14 | | **created** | **string** | ☑️ | | null | 15 | | **data** | [**PaymentCallbackData**](PaymentCallbackData.md) | | | null | 16 | 17 | 18 | [[Back to README]](../../README.md) 19 | -------------------------------------------------------------------------------- /docs/PaymentRequest/PaymentCallbackData.md: -------------------------------------------------------------------------------- 1 | # # PaymentCallbackData 2 | Represents the actual funds transaction/attempt made to a payment method 3 | 4 | ```php 5 | use Xendit\PaymentRequest\PaymentCallbackData; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **id** | **string** | ☑️ | | null | 13 | | **payment_request_id** | **string** | | | null | 14 | | **reference_id** | **string** | ☑️ | | null | 15 | | **customer_id** | **string** | | | null | 16 | | **currency** | **string** | ☑️ | | null | 17 | | **amount** | **float** | ☑️ | | null | 18 | | **country** | **string** | ☑️ | | null | 19 | | **status** | **string** | ☑️ | | null | 20 | | **payment_method** | [**PaymentMethod**](PaymentMethod.md) | ☑️ | | null | 21 | | **channel_properties** | [**PaymentRequestChannelProperties**](PaymentRequestChannelProperties.md) | | | null | 22 | | **payment_detail** | **object** | | | null | 23 | | **failure_code** | **string** | | | null | 24 | | **created** | **string** | ☑️ | | null | 25 | | **updated** | **string** | ☑️ | | null | 26 | | **metadata** | **object** | | | null | 27 | 28 | 29 | [[Back to README]](../../README.md) 30 | -------------------------------------------------------------------------------- /docs/PaymentRequest/PaymentMethod.md: -------------------------------------------------------------------------------- 1 | # # PaymentMethod 2 | 3 | 4 | ```php 5 | use Xendit\PaymentRequest\PaymentMethod; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **id** | **string** | ☑️ | | null | 13 | | **type** | [**PaymentMethodType**](PaymentMethodType.md) | ☑️ | | null | 14 | | **created** | **string** | | | null | 15 | | **updated** | **string** | | | null | 16 | | **description** | **string** | | | null | 17 | | **reference_id** | **string** | | | null | 18 | | **card** | [**Card**](Card.md) | | | null | 19 | | **direct_debit** | [**DirectDebit**](DirectDebit.md) | | | null | 20 | | **ewallet** | [**EWallet**](EWallet.md) | | | null | 21 | | **over_the_counter** | [**OverTheCounter**](OverTheCounter.md) | | | null | 22 | | **virtual_account** | [**VirtualAccount**](VirtualAccount.md) | | | null | 23 | | **qr_code** | [**QRCode**](QRCode.md) | | | null | 24 | | **reusability** | [**PaymentMethodReusability**](PaymentMethodReusability.md) | ☑️ | | null | 25 | | **status** | [**PaymentMethodStatus**](PaymentMethodStatus.md) | ☑️ | | null | 26 | | **metadata** | **object** | | | null | 27 | 28 | 29 | [[Back to README]](../../README.md) 30 | -------------------------------------------------------------------------------- /docs/PaymentRequest/PaymentMethodParameters.md: -------------------------------------------------------------------------------- 1 | # # PaymentMethodParameters 2 | 3 | 4 | ```php 5 | use Xendit\PaymentRequest\PaymentMethodParameters; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **type** | [**PaymentMethodType**](PaymentMethodType.md) | ☑️ | | null | 13 | | **reusability** | [**PaymentMethodReusability**](PaymentMethodReusability.md) | ☑️ | | null | 14 | | **description** | **string** | | | null | 15 | | **reference_id** | **string** | | | null | 16 | | **card** | [**CardParameters**](CardParameters.md) | | | null | 17 | | **direct_debit** | [**DirectDebitParameters**](DirectDebitParameters.md) | | | null | 18 | | **ewallet** | [**EWalletParameters**](EWalletParameters.md) | | | null | 19 | | **over_the_counter** | [**OverTheCounterParameters**](OverTheCounterParameters.md) | | | null | 20 | | **virtual_account** | [**VirtualAccountParameters**](VirtualAccountParameters.md) | | | null | 21 | | **qr_code** | [**QRCodeParameters**](QRCodeParameters.md) | | | null | 22 | 23 | 24 | [[Back to README]](../../README.md) 25 | -------------------------------------------------------------------------------- /docs/PaymentRequest/PaymentMethodReusability.md: -------------------------------------------------------------------------------- 1 | # # PaymentMethodReusability 2 | 3 | 4 | ```php 5 | use Xendit\PaymentRequest\PaymentMethodReusability; 6 | ``` 7 | 8 | 9 | ## Enum 10 | 11 | 12 | * `MULTIPLE_USE` (value: `'MULTIPLE_USE'`) 13 | 14 | * `ONE_TIME_USE` (value: `'ONE_TIME_USE'`) 15 | 16 | * `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) 17 | 18 | If you encounter `UNKNOWN_ENUM_VALUE`, it means that this ENUM is unavailable in your current SDK version. Please upgrade to get the newest ENUM. 19 | 20 | [[Back to README]](../../README.md) 21 | -------------------------------------------------------------------------------- /docs/PaymentRequest/PaymentMethodStatus.md: -------------------------------------------------------------------------------- 1 | # # PaymentMethodStatus 2 | 3 | 4 | ```php 5 | use Xendit\PaymentRequest\PaymentMethodStatus; 6 | ``` 7 | 8 | 9 | ## Enum 10 | 11 | 12 | * `ACTIVE` (value: `'ACTIVE'`) 13 | 14 | * `INACTIVE` (value: `'INACTIVE'`) 15 | 16 | * `PENDING` (value: `'PENDING'`) 17 | 18 | * `EXPIRED` (value: `'EXPIRED'`) 19 | 20 | * `FAILED` (value: `'FAILED'`) 21 | 22 | * `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) 23 | 24 | If you encounter `UNKNOWN_ENUM_VALUE`, it means that this ENUM is unavailable in your current SDK version. Please upgrade to get the newest ENUM. 25 | 26 | [[Back to README]](../../README.md) 27 | -------------------------------------------------------------------------------- /docs/PaymentRequest/PaymentMethodType.md: -------------------------------------------------------------------------------- 1 | # # PaymentMethodType 2 | 3 | 4 | ```php 5 | use Xendit\PaymentRequest\PaymentMethodType; 6 | ``` 7 | 8 | 9 | ## Enum 10 | 11 | 12 | * `CARD` (value: `'CARD'`) 13 | 14 | * `DIRECT_DEBIT` (value: `'DIRECT_DEBIT'`) 15 | 16 | * `EWALLET` (value: `'EWALLET'`) 17 | 18 | * `OVER_THE_COUNTER` (value: `'OVER_THE_COUNTER'`) 19 | 20 | * `QR_CODE` (value: `'QR_CODE'`) 21 | 22 | * `VIRTUAL_ACCOUNT` (value: `'VIRTUAL_ACCOUNT'`) 23 | 24 | * `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) 25 | 26 | If you encounter `UNKNOWN_ENUM_VALUE`, it means that this ENUM is unavailable in your current SDK version. Please upgrade to get the newest ENUM. 27 | 28 | [[Back to README]](../../README.md) 29 | -------------------------------------------------------------------------------- /docs/PaymentRequest/PaymentRequest.md: -------------------------------------------------------------------------------- 1 | # # PaymentRequest 2 | 3 | 4 | ```php 5 | use Xendit\PaymentRequest\PaymentRequest; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **id** | **string** | ☑️ | | null | 13 | | **created** | **string** | ☑️ | | null | 14 | | **updated** | **string** | ☑️ | | null | 15 | | **reference_id** | **string** | ☑️ | | null | 16 | | **business_id** | **string** | ☑️ | | null | 17 | | **customer_id** | **string** | | | null | 18 | | **customer** | **object** | | | null | 19 | | **amount** | **float** | | | null | 20 | | **min_amount** | **float** | | | null | 21 | | **max_amount** | **float** | | | null | 22 | | **country** | [**PaymentRequestCountry**](PaymentRequestCountry.md) | | | null | 23 | | **currency** | [**PaymentRequestCurrency**](PaymentRequestCurrency.md) | ☑️ | | null | 24 | | **payment_method** | [**PaymentMethod**](PaymentMethod.md) | ☑️ | | null | 25 | | **description** | **string** | | | null | 26 | | **failure_code** | **string** | | | null | 27 | | **capture_method** | [**PaymentRequestCaptureMethod**](PaymentRequestCaptureMethod.md) | | | null | 28 | | **initiator** | [**PaymentRequestInitiator**](PaymentRequestInitiator.md) | | | null | 29 | | **card_verification_results** | [**PaymentRequestCardVerificationResults**](PaymentRequestCardVerificationResults.md) | | | null | 30 | | **status** | [**PaymentRequestStatus**](PaymentRequestStatus.md) | ☑️ | | null | 31 | | **actions** | [**array**](PaymentRequestAction.md) | | | null | 32 | | **metadata** | **object** | | | null | 33 | | **shipping_information** | [**PaymentRequestShippingInformation**](PaymentRequestShippingInformation.md) | | | null | 34 | | **items** | [**array**](PaymentRequestBasketItem.md) | | | null | 35 | 36 | 37 | [[Back to README]](../../README.md) 38 | -------------------------------------------------------------------------------- /docs/PaymentRequest/PaymentRequestAction.md: -------------------------------------------------------------------------------- 1 | # # PaymentRequestAction 2 | 3 | 4 | ```php 5 | use Xendit\PaymentRequest\PaymentRequestAction; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **action** | **string** | ☑️ | | null | 13 | | **url_type** | **string** | ☑️ | | null | 14 | | **method** | **string** | ☑️ | | null | 15 | | **url** | **string** | ☑️ | | null | 16 | | **qr_code** | **string** | ☑️ | | null | 17 | 18 | 19 | [[Back to README]](../../README.md) 20 | -------------------------------------------------------------------------------- /docs/PaymentRequest/PaymentRequestAuthParameters.md: -------------------------------------------------------------------------------- 1 | # # PaymentRequestAuthParameters 2 | 3 | 4 | ```php 5 | use Xendit\PaymentRequest\PaymentRequestAuthParameters; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **auth_code** | **string** | ☑️ | | null | 13 | 14 | 15 | [[Back to README]](../../README.md) 16 | -------------------------------------------------------------------------------- /docs/PaymentRequest/PaymentRequestBasketItem.md: -------------------------------------------------------------------------------- 1 | # # PaymentRequestBasketItem 2 | 3 | 4 | ```php 5 | use Xendit\PaymentRequest\PaymentRequestBasketItem; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **reference_id** | **string** | | | null | 13 | | **name** | **string** | ☑️ | | null | 14 | | **description** | **string** | | | null | 15 | | **type** | **string** | | | null | 16 | | **category** | **string** | ☑️ | | null | 17 | | **sub_category** | **string** | | | null | 18 | | **currency** | **string** | ☑️ | | null | 19 | | **quantity** | **float** | ☑️ | | null | 20 | | **price** | **float** | ☑️ | | null | 21 | | **payer_charged_currency** | **string** | | | null | 22 | | **payer_charged_price** | **float** | | | null | 23 | | **url** | **string** | | | null | 24 | | **metadata** | **object** | | | null | 25 | 26 | 27 | [[Back to README]](../../README.md) 28 | -------------------------------------------------------------------------------- /docs/PaymentRequest/PaymentRequestCaptureMethod.md: -------------------------------------------------------------------------------- 1 | # # PaymentRequestCaptureMethod 2 | 3 | 4 | ```php 5 | use Xendit\PaymentRequest\PaymentRequestCaptureMethod; 6 | ``` 7 | 8 | 9 | ## Enum 10 | 11 | 12 | * `AUTOMATIC` (value: `'AUTOMATIC'`) 13 | 14 | * `MANUAL` (value: `'MANUAL'`) 15 | 16 | * `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) 17 | 18 | If you encounter `UNKNOWN_ENUM_VALUE`, it means that this ENUM is unavailable in your current SDK version. Please upgrade to get the newest ENUM. 19 | 20 | [[Back to README]](../../README.md) 21 | -------------------------------------------------------------------------------- /docs/PaymentRequest/PaymentRequestCardVerificationResults.md: -------------------------------------------------------------------------------- 1 | # # PaymentRequestCardVerificationResults 2 | 3 | 4 | ```php 5 | use Xendit\PaymentRequest\PaymentRequestCardVerificationResults; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **three_d_secure** | [**PaymentRequestCardVerificationResultsThreeDeeSecure**](PaymentRequestCardVerificationResultsThreeDeeSecure.md) | ☑️ | | null | 13 | | **cvv_result** | **string** | | | null | 14 | | **address_verification_result** | **string** | | | null | 15 | 16 | 17 | [[Back to README]](../../README.md) 18 | -------------------------------------------------------------------------------- /docs/PaymentRequest/PaymentRequestCardVerificationResultsThreeDeeSecure.md: -------------------------------------------------------------------------------- 1 | # # PaymentRequestCardVerificationResultsThreeDeeSecure 2 | 3 | 4 | ```php 5 | use Xendit\PaymentRequest\PaymentRequestCardVerificationResultsThreeDeeSecure; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **three_d_secure_flow** | **string** | | | null | 13 | | **eci_code** | **string** | | | null | 14 | | **three_d_secure_result** | **string** | | | null | 15 | | **three_d_secure_result_reason** | **string** | | | null | 16 | | **three_d_secure_version** | **string** | | | null | 17 | 18 | 19 | [[Back to README]](../../README.md) 20 | -------------------------------------------------------------------------------- /docs/PaymentRequest/PaymentRequestCountry.md: -------------------------------------------------------------------------------- 1 | # # PaymentRequestCountry 2 | 3 | 4 | ```php 5 | use Xendit\PaymentRequest\PaymentRequestCountry; 6 | ``` 7 | 8 | 9 | ## Enum 10 | 11 | 12 | * `ID` (value: `'ID'`) 13 | 14 | * `PH` (value: `'PH'`) 15 | 16 | * `VN` (value: `'VN'`) 17 | 18 | * `TH` (value: `'TH'`) 19 | 20 | * `MY` (value: `'MY'`) 21 | 22 | * `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) 23 | 24 | If you encounter `UNKNOWN_ENUM_VALUE`, it means that this ENUM is unavailable in your current SDK version. Please upgrade to get the newest ENUM. 25 | 26 | [[Back to README]](../../README.md) 27 | -------------------------------------------------------------------------------- /docs/PaymentRequest/PaymentRequestCurrency.md: -------------------------------------------------------------------------------- 1 | # # PaymentRequestCurrency 2 | 3 | 4 | ```php 5 | use Xendit\PaymentRequest\PaymentRequestCurrency; 6 | ``` 7 | 8 | 9 | ## Enum 10 | 11 | 12 | * `IDR` (value: `'IDR'`) 13 | 14 | * `PHP` (value: `'PHP'`) 15 | 16 | * `VND` (value: `'VND'`) 17 | 18 | * `THB` (value: `'THB'`) 19 | 20 | * `MYR` (value: `'MYR'`) 21 | 22 | * `USD` (value: `'USD'`) 23 | 24 | * `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) 25 | 26 | If you encounter `UNKNOWN_ENUM_VALUE`, it means that this ENUM is unavailable in your current SDK version. Please upgrade to get the newest ENUM. 27 | 28 | [[Back to README]](../../README.md) 29 | -------------------------------------------------------------------------------- /docs/PaymentRequest/PaymentRequestInitiator.md: -------------------------------------------------------------------------------- 1 | # # PaymentRequestInitiator 2 | 3 | 4 | ```php 5 | use Xendit\PaymentRequest\PaymentRequestInitiator; 6 | ``` 7 | 8 | 9 | ## Enum 10 | 11 | 12 | * `CUSTOMER` (value: `'CUSTOMER'`) 13 | 14 | * `MERCHANT` (value: `'MERCHANT'`) 15 | 16 | * `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) 17 | 18 | If you encounter `UNKNOWN_ENUM_VALUE`, it means that this ENUM is unavailable in your current SDK version. Please upgrade to get the newest ENUM. 19 | 20 | [[Back to README]](../../README.md) 21 | -------------------------------------------------------------------------------- /docs/PaymentRequest/PaymentRequestListResponse.md: -------------------------------------------------------------------------------- 1 | # # PaymentRequestListResponse 2 | 3 | 4 | ```php 5 | use Xendit\PaymentRequest\PaymentRequestListResponse; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **data** | [**array**](PaymentRequest.md) | ☑️ | | null | 13 | | **has_more** | **bool** | ☑️ | | null | 14 | 15 | 16 | [[Back to README]](../../README.md) 17 | -------------------------------------------------------------------------------- /docs/PaymentRequest/PaymentRequestParameters.md: -------------------------------------------------------------------------------- 1 | # # PaymentRequestParameters 2 | 3 | 4 | ```php 5 | use Xendit\PaymentRequest\PaymentRequestParameters; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **reference_id** | **string** | | | null | 13 | | **amount** | **float** | | | null | 14 | | **currency** | [**PaymentRequestCurrency**](PaymentRequestCurrency.md) | ☑️ | | null | 15 | | **payment_method** | [**PaymentMethodParameters**](PaymentMethodParameters.md) | | | null | 16 | | **description** | **string** | | | null | 17 | | **capture_method** | [**PaymentRequestCaptureMethod**](PaymentRequestCaptureMethod.md) | | | null | 18 | | **initiator** | [**PaymentRequestInitiator**](PaymentRequestInitiator.md) | | | null | 19 | | **payment_method_id** | **string** | | | null | 20 | | **channel_properties** | [**PaymentRequestParametersChannelProperties**](PaymentRequestParametersChannelProperties.md) | | | null | 21 | | **shipping_information** | [**PaymentRequestShippingInformation**](PaymentRequestShippingInformation.md) | | | null | 22 | | **items** | [**array**](PaymentRequestBasketItem.md) | | | null | 23 | | **customer_id** | **string** | | | null | 24 | | **customer** | **object** | | | null | 25 | | **metadata** | **object** | | | null | 26 | 27 | 28 | [[Back to README]](../../README.md) 29 | -------------------------------------------------------------------------------- /docs/PaymentRequest/PaymentRequestParametersChannelPropertiesAllOf.md: -------------------------------------------------------------------------------- 1 | # # PaymentRequestParametersChannelPropertiesAllOf 2 | 3 | 4 | ```php 5 | use Xendit\PaymentRequest\PaymentRequestParametersChannelPropertiesAllOf; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **cvv** | **string** | | Three digit code written on the back of the card (usually called CVV/CVN). | 123 | 13 | 14 | 15 | [[Back to README]](../../README.md) 16 | -------------------------------------------------------------------------------- /docs/PaymentRequest/PaymentRequestShippingInformation.md: -------------------------------------------------------------------------------- 1 | # # PaymentRequestShippingInformation 2 | 3 | 4 | ```php 5 | use Xendit\PaymentRequest\PaymentRequestShippingInformation; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **country** | **string** | ☑️ | | null | 13 | | **street_line1** | **string** | | | null | 14 | | **street_line2** | **string** | | | null | 15 | | **city** | **string** | | | null | 16 | | **province_state** | **string** | | | null | 17 | | **postal_code** | **string** | | | null | 18 | 19 | 20 | [[Back to README]](../../README.md) 21 | -------------------------------------------------------------------------------- /docs/PaymentRequest/PaymentRequestStatus.md: -------------------------------------------------------------------------------- 1 | # # PaymentRequestStatus 2 | 3 | 4 | ```php 5 | use Xendit\PaymentRequest\PaymentRequestStatus; 6 | ``` 7 | 8 | 9 | ## Enum 10 | 11 | 12 | * `PENDING` (value: `'PENDING'`) 13 | 14 | * `REQUIRES_ACTION` (value: `'REQUIRES_ACTION'`) 15 | 16 | * `CANCELED` (value: `'CANCELED'`) 17 | 18 | * `SUCCEEDED` (value: `'SUCCEEDED'`) 19 | 20 | * `FAILED` (value: `'FAILED'`) 21 | 22 | * `VOIDED` (value: `'VOIDED'`) 23 | 24 | * `UNKNOWN` (value: `'UNKNOWN'`) 25 | 26 | * `AWAITING_CAPTURE` (value: `'AWAITING_CAPTURE'`) 27 | 28 | * `EXPIRED` (value: `'EXPIRED'`) 29 | 30 | * `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) 31 | 32 | If you encounter `UNKNOWN_ENUM_VALUE`, it means that this ENUM is unavailable in your current SDK version. Please upgrade to get the newest ENUM. 33 | 34 | [[Back to README]](../../README.md) 35 | -------------------------------------------------------------------------------- /docs/PaymentRequest/PaymentSimulation.md: -------------------------------------------------------------------------------- 1 | # # PaymentSimulation 2 | 3 | 4 | ```php 5 | use Xendit\PaymentRequest\PaymentSimulation; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **status** | **string** | | | null | 13 | | **message** | **string** | | | null | 14 | 15 | 16 | [[Back to README]](../../README.md) 17 | -------------------------------------------------------------------------------- /docs/PaymentRequest/QRCode.md: -------------------------------------------------------------------------------- 1 | # # QRCode 2 | QRCode Payment Method Details 3 | 4 | ```php 5 | use Xendit\PaymentRequest\QRCode; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **channel_code** | [**QRCodeChannelCode**](QRCodeChannelCode.md) | | | null | 13 | | **channel_properties** | [**QRCodeChannelProperties**](QRCodeChannelProperties.md) | | | null | 14 | 15 | 16 | [[Back to README]](../../README.md) 17 | -------------------------------------------------------------------------------- /docs/PaymentRequest/QRCodeChannelCode.md: -------------------------------------------------------------------------------- 1 | # # QRCodeChannelCode 2 | QR Code Channel Code 3 | 4 | ```php 5 | use Xendit\PaymentRequest\QRCodeChannelCode; 6 | ``` 7 | 8 | 9 | ## Enum 10 | 11 | 12 | * `QRIS` (value: `'QRIS'`) 13 | 14 | * `DANA` (value: `'DANA'`) 15 | 16 | * `RCBC` (value: `'RCBC'`) 17 | 18 | * `LINKAJA` (value: `'LINKAJA'`) 19 | 20 | * `PROMPTPAY` (value: `'PROMPTPAY'`) 21 | 22 | * `XENDIT` (value: `'XENDIT'`) 23 | 24 | * `QRPH` (value: `'QRPH'`) 25 | 26 | * `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) 27 | 28 | If you encounter `UNKNOWN_ENUM_VALUE`, it means that this ENUM is unavailable in your current SDK version. Please upgrade to get the newest ENUM. 29 | 30 | [[Back to README]](../../README.md) 31 | -------------------------------------------------------------------------------- /docs/PaymentRequest/QRCodeChannelProperties.md: -------------------------------------------------------------------------------- 1 | # # QRCodeChannelProperties 2 | QR Code Channel Properties 3 | 4 | ```php 5 | use Xendit\PaymentRequest\QRCodeChannelProperties; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **qr_string** | **string** | | | null | 13 | | **expires_at** | **\DateTime** | | | 2022-01-01T00:00Z | 14 | 15 | 16 | [[Back to README]](../../README.md) 17 | -------------------------------------------------------------------------------- /docs/PaymentRequest/QRCodeParameters.md: -------------------------------------------------------------------------------- 1 | # # QRCodeParameters 2 | 3 | 4 | ```php 5 | use Xendit\PaymentRequest\QRCodeParameters; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **channel_code** | [**QRCodeChannelCode**](QRCodeChannelCode.md) | | | null | 13 | | **channel_properties** | [**QRCodeChannelProperties**](QRCodeChannelProperties.md) | | | null | 14 | 15 | 16 | [[Back to README]](../../README.md) 17 | -------------------------------------------------------------------------------- /docs/PaymentRequest/VirtualAccount.md: -------------------------------------------------------------------------------- 1 | # # VirtualAccount 2 | Virtual Account Payment Method Details 3 | 4 | ```php 5 | use Xendit\PaymentRequest\VirtualAccount; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **min_amount** | **float** | | | null | 13 | | **max_amount** | **float** | | | null | 14 | | **amount** | **float** | | | null | 15 | | **currency** | [**PaymentRequestCurrency**](PaymentRequestCurrency.md) | | | null | 16 | | **channel_code** | [**VirtualAccountChannelCode**](VirtualAccountChannelCode.md) | ☑️ | | null | 17 | | **channel_properties** | [**VirtualAccountChannelProperties**](VirtualAccountChannelProperties.md) | ☑️ | | null | 18 | | **alternative_display_types** | **string[]** | | Alternative display requested for the virtual account | null | 19 | | **alternative_displays** | [**array**](VirtualAccountAlternativeDisplay.md) | | | null | 20 | 21 | 22 | [[Back to README]](../../README.md) 23 | -------------------------------------------------------------------------------- /docs/PaymentRequest/VirtualAccountAllOf.md: -------------------------------------------------------------------------------- 1 | # # VirtualAccountAllOf 2 | 3 | 4 | ```php 5 | use Xendit\PaymentRequest\VirtualAccountAllOf; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **alternative_displays** | [**array**](VirtualAccountAlternativeDisplay.md) | | | null | 13 | 14 | 15 | [[Back to README]](../../README.md) 16 | -------------------------------------------------------------------------------- /docs/PaymentRequest/VirtualAccountAlternativeDisplay.md: -------------------------------------------------------------------------------- 1 | # # VirtualAccountAlternativeDisplay 2 | Alternative Display Object 3 | 4 | ```php 5 | use Xendit\PaymentRequest\VirtualAccountAlternativeDisplay; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **type** | **string** | | Type of the alternative display | null | 13 | | **data** | **string** | | Data payload of the given alternative display | null | 14 | 15 | 16 | [[Back to README]](../../README.md) 17 | -------------------------------------------------------------------------------- /docs/PaymentRequest/VirtualAccountChannelCode.md: -------------------------------------------------------------------------------- 1 | # # VirtualAccountChannelCode 2 | Virtual Account Channel Code 3 | 4 | ```php 5 | use Xendit\PaymentRequest\VirtualAccountChannelCode; 6 | ``` 7 | 8 | 9 | ## Enum 10 | 11 | 12 | * `BCA` (value: `'BCA'`) 13 | 14 | * `BJB` (value: `'BJB'`) 15 | 16 | * `BNI` (value: `'BNI'`) 17 | 18 | * `BRI` (value: `'BRI'`) 19 | 20 | * `MANDIRI` (value: `'MANDIRI'`) 21 | 22 | * `PERMATA` (value: `'PERMATA'`) 23 | 24 | * `BSI` (value: `'BSI'`) 25 | 26 | * `CIMB` (value: `'CIMB'`) 27 | 28 | * `SAHABAT_SAMPOERNA` (value: `'SAHABAT_SAMPOERNA'`) 29 | 30 | * `ARTAJASA` (value: `'ARTAJASA'`) 31 | 32 | * `PV` (value: `'PV'`) 33 | 34 | * `VIETCAPITAL` (value: `'VIETCAPITAL'`) 35 | 36 | * `WOORI` (value: `'WOORI'`) 37 | 38 | * `MSB` (value: `'MSB'`) 39 | 40 | * `VPB` (value: `'VPB'`) 41 | 42 | * `BIDV` (value: `'BIDV'`) 43 | 44 | * `STANDARD_CHARTERED` (value: `'STANDARD_CHARTERED'`) 45 | 46 | * `AMBANK` (value: `'AMBANK'`) 47 | 48 | * `UOB` (value: `'UOB'`) 49 | 50 | * `BNC` (value: `'BNC'`) 51 | 52 | * `HANA` (value: `'HANA'`) 53 | 54 | * `MUAMALAT` (value: `'MUAMALAT'`) 55 | 56 | * `BANK_TRANSFER` (value: `'BANK_TRANSFER'`) 57 | 58 | * `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) 59 | 60 | If you encounter `UNKNOWN_ENUM_VALUE`, it means that this ENUM is unavailable in your current SDK version. Please upgrade to get the newest ENUM. 61 | 62 | [[Back to README]](../../README.md) 63 | -------------------------------------------------------------------------------- /docs/PaymentRequest/VirtualAccountChannelProperties.md: -------------------------------------------------------------------------------- 1 | # # VirtualAccountChannelProperties 2 | Virtual Account Channel Properties 3 | 4 | ```php 5 | use Xendit\PaymentRequest\VirtualAccountChannelProperties; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **customer_name** | **string** | ☑️ | Name of customer. | Rika Sutanto | 13 | | **virtual_account_number** | **string** | | You can assign specific Virtual Account number using this parameter. If you do not send one, one will be picked at random. Make sure the number you specify is within your Virtual Account range. | 262159999999999 | 14 | | **expires_at** | **\DateTime** | | The date and time in ISO 8601 UTC+0 when the virtual account number will be expired. Default: The default expiration date will be 31 years from creation date. | 2022-01-01T00:00Z | 15 | | **suggested_amount** | **float** | | The suggested amount you want to assign. Note: Suggested amounts is the amounts that can see as a suggestion, but user can still put any numbers (only supported for Mandiri and BRI) | 100000 | 16 | 17 | 18 | [[Back to README]](../../README.md) 19 | -------------------------------------------------------------------------------- /docs/PaymentRequest/VirtualAccountParameters.md: -------------------------------------------------------------------------------- 1 | # # VirtualAccountParameters 2 | 3 | 4 | ```php 5 | use Xendit\PaymentRequest\VirtualAccountParameters; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **min_amount** | **float** | | | null | 13 | | **max_amount** | **float** | | | null | 14 | | **amount** | **float** | | | null | 15 | | **currency** | [**PaymentRequestCurrency**](PaymentRequestCurrency.md) | | | null | 16 | | **channel_code** | [**VirtualAccountChannelCode**](VirtualAccountChannelCode.md) | ☑️ | | null | 17 | | **channel_properties** | [**VirtualAccountChannelProperties**](VirtualAccountChannelProperties.md) | ☑️ | | null | 18 | | **alternative_display_types** | **string[]** | | Alternative display requested for the virtual account | null | 19 | 20 | 21 | [[Back to README]](../../README.md) 22 | -------------------------------------------------------------------------------- /docs/Payout/Channel.md: -------------------------------------------------------------------------------- 1 | # # Channel 2 | Channel information where you can send the money to 3 | 4 | ```php 5 | use Xendit\Payout\Channel; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **channel_code** | **string** | ☑️ | Destination channel to send the money to, prefixed by ISO-3166 country code | ID_MANDIRI | 13 | | **channel_category** | [**ChannelCategory**](ChannelCategory.md) | ☑️ | | null | 14 | | **currency** | **string** | ☑️ | Currency of the destination channel using ISO-4217 currency code | IDR | 15 | | **channel_name** | **string** | ☑️ | Name of the destination channel | Bank Mandiri | 16 | | **amount_limits** | [**ChannelAmountLimits**](ChannelAmountLimits.md) | ☑️ | | null | 17 | 18 | 19 | [[Back to README]](../../README.md) 20 | -------------------------------------------------------------------------------- /docs/Payout/ChannelAccountType.md: -------------------------------------------------------------------------------- 1 | # # ChannelAccountType 2 | Available account types (applicable for MY_DUITNOW) 3 | 4 | ```php 5 | use Xendit\Payout\ChannelAccountType; 6 | ``` 7 | 8 | 9 | ## Enum 10 | 11 | 12 | * `NATIONAL_ID` (value: `'NATIONAL_ID'`) 13 | 14 | * `MOBILE_NO` (value: `'MOBILE_NO'`) 15 | 16 | * `PASSPORT` (value: `'PASSPORT'`) 17 | 18 | * `BUSINESS_REGISTRATION` (value: `'BUSINESS_REGISTRATION'`) 19 | 20 | * `BANK_ACCOUNT` (value: `'BANK_ACCOUNT'`) 21 | 22 | * `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) 23 | 24 | If you encounter `UNKNOWN_ENUM_VALUE`, it means that this ENUM is unavailable in your current SDK version. Please upgrade to get the newest ENUM. 25 | 26 | [[Back to README]](../../README.md) 27 | -------------------------------------------------------------------------------- /docs/Payout/ChannelAmountLimits.md: -------------------------------------------------------------------------------- 1 | # # ChannelAmountLimits 2 | Supported amount ranges for payouts to this channel 3 | 4 | ```php 5 | use Xendit\Payout\ChannelAmountLimits; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **minimum** | **float** | ☑️ | Lowest amount supported for a payout to this channel | 1 | 13 | | **maximum** | **float** | ☑️ | Highest amount supported for a payout to this channel | 50000000 | 14 | | **minimum_increment** | **float** | ☑️ | Supported increments | 1 | 15 | 16 | 17 | [[Back to README]](../../README.md) 18 | -------------------------------------------------------------------------------- /docs/Payout/ChannelCategory.md: -------------------------------------------------------------------------------- 1 | # # ChannelCategory 2 | Category of channel code, as some channels might require more fields during processing 3 | 4 | ```php 5 | use Xendit\Payout\ChannelCategory; 6 | ``` 7 | 8 | 9 | ## Enum 10 | 11 | 12 | * `BANK` (value: `'BANK'`) 13 | 14 | * `EWALLET` (value: `'EWALLET'`) 15 | 16 | * `OTC` (value: `'OTC'`) 17 | 18 | * `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) 19 | 20 | If you encounter `UNKNOWN_ENUM_VALUE`, it means that this ENUM is unavailable in your current SDK version. Please upgrade to get the newest ENUM. 21 | 22 | [[Back to README]](../../README.md) 23 | -------------------------------------------------------------------------------- /docs/Payout/CreatePayoutRequest.md: -------------------------------------------------------------------------------- 1 | # # CreatePayoutRequest 2 | Information needed by Xendit to send money to the destination channel provided 3 | 4 | ```php 5 | use Xendit\Payout\CreatePayoutRequest; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **reference_id** | **string** | ☑️ | A client defined payout identifier | DISB-001 | 13 | | **channel_code** | **string** | ☑️ | Channel code of selected destination bank or e-wallet | PH_BDO | 14 | | **channel_properties** | [**DigitalPayoutChannelProperties**](DigitalPayoutChannelProperties.md) | ☑️ | | null | 15 | | **amount** | **float** | ☑️ | Amount to be sent to the destination account and should be a multiple of the minimum increment for the selected channel | 15000.05 | 16 | | **description** | **string** | | Description to send with the payout, the recipient may see this e.g., in their bank statement (if supported) or in email receipts we send on your behalf | Cashback 2020 | 17 | | **currency** | **string** | ☑️ | Currency of the destination channel using ISO-4217 currency code | PHP | 18 | | **receipt_notification** | [**ReceiptNotification**](ReceiptNotification.md) | | | null | 19 | | **metadata** | **object** | | Object of additional information you may use | {"external_party":"xendit"} | 20 | 21 | 22 | [[Back to README]](../../README.md) 23 | -------------------------------------------------------------------------------- /docs/Payout/DigitalPayoutChannelProperties.md: -------------------------------------------------------------------------------- 1 | # # DigitalPayoutChannelProperties 2 | Channel information for digital destinations (banks, e-wallets) 3 | 4 | ```php 5 | use Xendit\Payout\DigitalPayoutChannelProperties; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **account_holder_name** | **string** | | Registered account name | Adam Gilcrist | 13 | | **account_number** | **string** | ☑️ | Registered account number | 9999999999 | 14 | | **account_type** | [**ChannelAccountType**](ChannelAccountType.md) | | | null | 15 | 16 | 17 | [[Back to README]](../../README.md) 18 | -------------------------------------------------------------------------------- /docs/Payout/Error.md: -------------------------------------------------------------------------------- 1 | # # Error 2 | 3 | 4 | ```php 5 | use Xendit\Payout\Error; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **error_code** | **string** | ☑️ | Specific error encountered when processing the request, can refer to the API documentation on proper handling of each available error code https://developers.xendit.co/api-reference/#payouts | SERVER_ERROR | 13 | | **message** | **string** | ☑️ | Human readable error message | null | 14 | | **errors** | [**array**](ErrorErrorsInner.md) | | | null | 15 | 16 | 17 | [[Back to README]](../../README.md) 18 | -------------------------------------------------------------------------------- /docs/Payout/ErrorErrorsInner.md: -------------------------------------------------------------------------------- 1 | # # ErrorErrorsInner 2 | 3 | 4 | ```php 5 | use Xendit\Payout\ErrorErrorsInner; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **path** | **string** | ☑️ | Precise location of the error | null | 13 | | **message** | **string** | ☑️ | Specific description of the error | null | 14 | 15 | 16 | [[Back to README]](../../README.md) 17 | -------------------------------------------------------------------------------- /docs/Payout/GetPayouts200Response.md: -------------------------------------------------------------------------------- 1 | # # GetPayouts200Response 2 | 3 | 4 | ```php 5 | use Xendit\Payout\GetPayouts200Response; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **data** | [**array**](GetPayouts200ResponseDataInner.md) | | | null | 13 | | **has_more** | **bool** | | | null | 14 | | **links** | [**GetPayouts200ResponseLinks**](GetPayouts200ResponseLinks.md) | | | null | 15 | 16 | 17 | [[Back to README]](../../README.md) 18 | -------------------------------------------------------------------------------- /docs/Payout/GetPayouts200ResponseLinks.md: -------------------------------------------------------------------------------- 1 | # # GetPayouts200ResponseLinks 2 | 3 | 4 | ```php 5 | use Xendit\Payout\GetPayouts200ResponseLinks; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **href** | **string** | | | null | 13 | | **rel** | **string** | | | null | 14 | | **method** | **string** | | | null | 15 | 16 | 17 | [[Back to README]](../../README.md) 18 | -------------------------------------------------------------------------------- /docs/Payout/PayoutAllOf.md: -------------------------------------------------------------------------------- 1 | # # PayoutAllOf 2 | 3 | 4 | ```php 5 | use Xendit\Payout\PayoutAllOf; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **id** | **string** | ☑️ | Xendit-generated unique identifier for each payout | disb_4203234e-48f5-11eb-b378-0242ac130002 | 13 | | **created** | **\DateTime** | ☑️ | The time payout was created on Xendit's system, in ISO 8601 format | 2019-11-01T12:34:56.007Z | 14 | | **updated** | **\DateTime** | ☑️ | The time payout was last updated on Xendit's system, in ISO 8601 format | 2019-11-01T12:34:56.007Z | 15 | | **business_id** | **string** | ☑️ | Xendit Business ID | 4203234e-48f5-11eb-b378-0242ac130002 | 16 | | **status** | **string** | ☑️ | Status of payout | ACCEPTED | 17 | | **failure_code** | **string** | | If the Payout failed, we include a failure code for more details on the failure. | null | 18 | | **estimated_arrival_time** | **\DateTime** | | Our estimated time on to when your payout is reflected to the destination account | null | 19 | 20 | 21 | [[Back to README]](../../README.md) 22 | -------------------------------------------------------------------------------- /docs/Payout/ReceiptNotification.md: -------------------------------------------------------------------------------- 1 | # # ReceiptNotification 2 | Additional notification for completed payout 3 | 4 | ```php 5 | use Xendit\Payout\ReceiptNotification; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **email_to** | **string[]** | | Valid email address to send the payout receipt | ["user_to@example.com","user_to2@example.com","user_to3@example.com"] | 13 | | **email_cc** | **string[]** | | Valid email address to cc the payout receipt | ["user_cc@example.com","user_cc2@example.com"] | 14 | | **email_bcc** | **string[]** | | Valid email address to bcc the payout receipt | ["user_bcc@example.com"] | 15 | 16 | 17 | [[Back to README]](../../README.md) 18 | -------------------------------------------------------------------------------- /docs/Refund/CreateRefund.md: -------------------------------------------------------------------------------- 1 | # # CreateRefund 2 | 3 | 4 | ```php 5 | use Xendit\Refund\CreateRefund; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **payment_request_id** | **string** | | | pr-3ece8615-41b7-4983-a3f0-a037430b6036 | 13 | | **invoice_id** | **string** | | | 7a2c81d4f9e052a870bf37d2 | 14 | | **reference_id** | **string** | | | order-1234 | 15 | | **amount** | **float** | | | 1500 | 16 | | **currency** | **string** | | | PHP | 17 | | **reason** | **string** | | | CANCELLATION | 18 | | **metadata** | **object** | | | {"foo":"bar"} | 19 | 20 | 21 | [[Back to README]](../../README.md) 22 | -------------------------------------------------------------------------------- /docs/Refund/CreateRefund400Response.md: -------------------------------------------------------------------------------- 1 | # # CreateRefund400Response 2 | 3 | 4 | ```php 5 | use Xendit\Refund\CreateRefund400Response; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **error_code** | **string** | | | MAXIMUM_REFUND_AMOUNT_REACHED | 13 | | **message** | **string** | | | Error because the provided amount is greater than the allowed refund amount. | 14 | 15 | 16 | [[Back to README]](../../README.md) 17 | -------------------------------------------------------------------------------- /docs/Refund/CreateRefund403Response.md: -------------------------------------------------------------------------------- 1 | # # CreateRefund403Response 2 | 3 | 4 | ```php 5 | use Xendit\Refund\CreateRefund403Response; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **error_code** | **string** | | | UNAUTHORIZED | 13 | | **message** | **string** | | | No valid API key provided | 14 | 15 | 16 | [[Back to README]](../../README.md) 17 | -------------------------------------------------------------------------------- /docs/Refund/CreateRefund404Response.md: -------------------------------------------------------------------------------- 1 | # # CreateRefund404Response 2 | 3 | 4 | ```php 5 | use Xendit\Refund\CreateRefund404Response; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **error_code** | **string** | | | DATA_NOT_FOUND | 13 | | **message** | **string** | | | Data not found | 14 | 15 | 16 | [[Back to README]](../../README.md) 17 | -------------------------------------------------------------------------------- /docs/Refund/CreateRefund409Response.md: -------------------------------------------------------------------------------- 1 | # # CreateRefund409Response 2 | 3 | 4 | ```php 5 | use Xendit\Refund\CreateRefund409Response; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **error_code** | **string** | | | DUPLICATE_ERROR | 13 | | **message** | **string** | | | duplicate value on idempotency_key, try again with a new key | 14 | 15 | 16 | [[Back to README]](../../README.md) 17 | -------------------------------------------------------------------------------- /docs/Refund/CreateRefund503Response.md: -------------------------------------------------------------------------------- 1 | # # CreateRefund503Response 2 | 3 | 4 | ```php 5 | use Xendit\Refund\CreateRefund503Response; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **error_code** | **string** | | | CHANNEL_UNAVAILABLE | 13 | | **message** | **string** | | | The payment channel requested is currently experiencing unexpected issues. | 14 | 15 | 16 | [[Back to README]](../../README.md) 17 | -------------------------------------------------------------------------------- /docs/Refund/GetAllRefundsDefaultResponse.md: -------------------------------------------------------------------------------- 1 | # # GetAllRefundsDefaultResponse 2 | 3 | 4 | ```php 5 | use Xendit\Refund\GetAllRefundsDefaultResponse; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **error_code** | **string** | | | null | 13 | | **message** | **string** | | | An unexpected error occured. Our team has been notified and will troubleshoot the issue. | 14 | 15 | 16 | [[Back to README]](../../README.md) 17 | -------------------------------------------------------------------------------- /docs/Refund/Refund.md: -------------------------------------------------------------------------------- 1 | # # Refund 2 | 3 | 4 | ```php 5 | use Xendit\Refund\Refund; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **id** | **string** | | | rfd-3ece8615-41b7-4983-a3f0-a037430b6036 | 13 | | **payment_request_id** | **string** | | | pr-f4a6f77c-4835-4630-9617-2cdc34ee26ee | 14 | | **amount** | **float** | | | 1500 | 15 | | **channel_code** | **string** | | | SHOPEEPAY | 16 | | **country** | **string** | | | PH | 17 | | **currency** | **string** | | | PHP | 18 | | **reference_id** | **string** | | | order-1234 | 19 | | **failure_code** | **string** | | | REFUND_FAILED | 20 | | **refund_fee_amount** | **float** | | | null | 21 | | **created** | **string** | | | 2023-01-24T07:05:07.859363326Z | 22 | | **updated** | **string** | | | 2023-01-24T07:05:07.859363326Z | 23 | | **metadata** | **object** | | | null | 24 | 25 | 26 | [[Back to README]](../../README.md) 27 | -------------------------------------------------------------------------------- /docs/Refund/RefundCallback.md: -------------------------------------------------------------------------------- 1 | # # RefundCallback 2 | Callback for successful or failed Refunds made via the Payments API 3 | 4 | ```php 5 | use Xendit\Refund\RefundCallback; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **event** | **string** | ☑️ | Identifies the event that triggered a notification to the merchant | null | 13 | | **business_id** | **string** | ☑️ | business_id | null | 14 | | **created** | **string** | ☑️ | | null | 15 | | **data** | [**RefundCallbackData**](RefundCallbackData.md) | | | null | 16 | 17 | 18 | [[Back to README]](../../README.md) 19 | -------------------------------------------------------------------------------- /docs/Refund/RefundCallbackData.md: -------------------------------------------------------------------------------- 1 | # # RefundCallbackData 2 | 3 | 4 | ```php 5 | use Xendit\Refund\RefundCallbackData; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **id** | **string** | ☑️ | | rfd-3ece8615-41b7-4983-a3f0-a037430b6036 | 13 | | **payment_id** | **string** | ☑️ | | pr-f4a6f77c-4835-4630-9617-2cdc34ee26ee | 14 | | **invoice_id** | **string** | | | null | 15 | | **payment_method_type** | **string** | ☑️ | | null | 16 | | **amount** | **float** | ☑️ | | 1500 | 17 | | **channel_code** | **string** | ☑️ | | SHOPEEPAY | 18 | | **status** | **string** | ☑️ | | null | 19 | | **reason** | **string** | ☑️ | | null | 20 | | **country** | **string** | ☑️ | | PH | 21 | | **currency** | **string** | ☑️ | | PHP | 22 | | **reference_id** | **string** | | | order-1234 | 23 | | **failure_code** | **string** | | | REFUND_FAILED | 24 | | **refund_fee_amount** | **float** | | | null | 25 | | **created** | **string** | ☑️ | | 2023-01-24T07:05:07.859363326Z | 26 | | **updated** | **string** | ☑️ | | 2023-01-24T07:05:07.859363326Z | 27 | | **metadata** | **object** | | | null | 28 | 29 | 30 | [[Back to README]](../../README.md) 31 | -------------------------------------------------------------------------------- /docs/Refund/RefundList.md: -------------------------------------------------------------------------------- 1 | # # RefundList 2 | 3 | 4 | ```php 5 | use Xendit\Refund\RefundList; 6 | ``` 7 | 8 | ## Properties 9 | 10 | | Name | Type | Required | Description | Examples | 11 | |------------|:-------------:|:-------------:|-------------|:-------------:| 12 | | **data** | [**array**](Refund.md) | ☑️ | | [{"id":"rfd-1fdaf346-dd2e-4b6c-b938-124c7167a822'","payment_request_id":"pr-f4a6f77c-4835-4630-9617-2cdc34ee26ee","amount":1500,"channel_code":"SHOPEEPAY","country":"PH","currency":"PHP","reference_id":"order-1234","failure_code":null,"refund_fee_amount":null,"created":"2023-01-24T07:05:07.859363326Z","updated":"2023-01-24T07:05:07.859363326Z","metadata":null},{"id":"rfd-db61bc21-8686-49d9-9be1-168cbf45d83f'","payment_request_id":"pr-3af41122-a608-4356-a0fe-1f67f5cf4637","amount":1500,"channel_code":"GRABPAY","country":"PH","currency":"PHP","reference_id":"order-5678","failure_code":null,"refund_fee_amount":null,"created":"2023-01-24T07:05:07.859363326Z","updated":"2023-01-24T07:05:07.859363326Z","metadata":null}] | 13 | | **has_more** | **bool** | | | false | 14 | 15 | 16 | [[Back to README]](../../README.md) 17 | -------------------------------------------------------------------------------- /images/header.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/xendit/xendit-php/4c6e1b9899aef8c6224c7c1ae46963b71435280b/images/header.jpg -------------------------------------------------------------------------------- /lib/Customer/AddressStatus.php: -------------------------------------------------------------------------------- 1 | value = $value; 49 | } 50 | 51 | public function getValue() { 52 | return $this->value; 53 | } 54 | 55 | public function setValue($value) { 56 | if (!self::isValid($value)) { 57 | throw new \InvalidArgumentException(sprintf('Invalid value for enum AddressStatus: %s', $value)); 58 | } 59 | $this->value = $value; 60 | } 61 | 62 | public function __toString() { 63 | return (string)$this->value; 64 | } 65 | 66 | /** 67 | * Gets allowable values of the enum 68 | * @return string[] 69 | */ 70 | public static function getAllowableEnumValues() 71 | { 72 | return [ 73 | self::ACTIVE, 74 | self::DELETED, 75 | self::XENDIT_ENUM_DEFAULT_FALLBACK 76 | ]; 77 | } 78 | } 79 | 80 | 81 | -------------------------------------------------------------------------------- /lib/PaymentMethod/PaymentMethodReusability.php: -------------------------------------------------------------------------------- 1 | value = $value; 49 | } 50 | 51 | public function getValue() { 52 | return $this->value; 53 | } 54 | 55 | public function setValue($value) { 56 | if (!self::isValid($value)) { 57 | throw new \InvalidArgumentException(sprintf('Invalid value for enum PaymentMethodReusability: %s', $value)); 58 | } 59 | $this->value = $value; 60 | } 61 | 62 | public function __toString() { 63 | return (string)$this->value; 64 | } 65 | 66 | /** 67 | * Gets allowable values of the enum 68 | * @return string[] 69 | */ 70 | public static function getAllowableEnumValues() 71 | { 72 | return [ 73 | self::MULTIPLE_USE, 74 | self::ONE_TIME_USE, 75 | self::XENDIT_ENUM_DEFAULT_FALLBACK 76 | ]; 77 | } 78 | } 79 | 80 | 81 | -------------------------------------------------------------------------------- /lib/PaymentRequest/PaymentMethodReusability.php: -------------------------------------------------------------------------------- 1 | value = $value; 49 | } 50 | 51 | public function getValue() { 52 | return $this->value; 53 | } 54 | 55 | public function setValue($value) { 56 | if (!self::isValid($value)) { 57 | throw new \InvalidArgumentException(sprintf('Invalid value for enum PaymentMethodReusability: %s', $value)); 58 | } 59 | $this->value = $value; 60 | } 61 | 62 | public function __toString() { 63 | return (string)$this->value; 64 | } 65 | 66 | /** 67 | * Gets allowable values of the enum 68 | * @return string[] 69 | */ 70 | public static function getAllowableEnumValues() 71 | { 72 | return [ 73 | self::MULTIPLE_USE, 74 | self::ONE_TIME_USE, 75 | self::XENDIT_ENUM_DEFAULT_FALLBACK 76 | ]; 77 | } 78 | } 79 | 80 | 81 | -------------------------------------------------------------------------------- /lib/PaymentRequest/PaymentRequestCaptureMethod.php: -------------------------------------------------------------------------------- 1 | value = $value; 49 | } 50 | 51 | public function getValue() { 52 | return $this->value; 53 | } 54 | 55 | public function setValue($value) { 56 | if (!self::isValid($value)) { 57 | throw new \InvalidArgumentException(sprintf('Invalid value for enum PaymentRequestCaptureMethod: %s', $value)); 58 | } 59 | $this->value = $value; 60 | } 61 | 62 | public function __toString() { 63 | return (string)$this->value; 64 | } 65 | 66 | /** 67 | * Gets allowable values of the enum 68 | * @return string[] 69 | */ 70 | public static function getAllowableEnumValues() 71 | { 72 | return [ 73 | self::AUTOMATIC, 74 | self::MANUAL, 75 | self::XENDIT_ENUM_DEFAULT_FALLBACK 76 | ]; 77 | } 78 | } 79 | 80 | 81 | -------------------------------------------------------------------------------- /lib/PaymentRequest/PaymentRequestInitiator.php: -------------------------------------------------------------------------------- 1 | value = $value; 49 | } 50 | 51 | public function getValue() { 52 | return $this->value; 53 | } 54 | 55 | public function setValue($value) { 56 | if (!self::isValid($value)) { 57 | throw new \InvalidArgumentException(sprintf('Invalid value for enum PaymentRequestInitiator: %s', $value)); 58 | } 59 | $this->value = $value; 60 | } 61 | 62 | public function __toString() { 63 | return (string)$this->value; 64 | } 65 | 66 | /** 67 | * Gets allowable values of the enum 68 | * @return string[] 69 | */ 70 | public static function getAllowableEnumValues() 71 | { 72 | return [ 73 | self::CUSTOMER, 74 | self::MERCHANT, 75 | self::XENDIT_ENUM_DEFAULT_FALLBACK 76 | ]; 77 | } 78 | } 79 | 80 | 81 | -------------------------------------------------------------------------------- /phpunit.xml.dist: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | ./lib/Api 6 | ./lib/Model 7 | 8 | 9 | 10 | 11 | ./test 12 | 13 | 14 | 15 | 16 | 17 | 18 | -------------------------------------------------------------------------------- /test/.env.test: -------------------------------------------------------------------------------- 1 | IGNORED_ERRORCODE=INVALID_API_KEY, 2 | --------------------------------------------------------------------------------