connect-sdk-nodejs
Version:
SDK to communicate with the Worldline Global Collect platform using the Worldline Connect Server API
1,445 lines • 84 kB
TypeScript
export interface APIError {
category?: string | null;
code?: string | null;
httpStatusCode?: number | null;
id?: string | null;
message?: string | null;
propertyName?: string | null;
requestId?: string | null;
}
export interface AbstractBankTransferPaymentMethodSpecificInput extends AbstractPaymentMethodSpecificInput {
additionalReference?: string | null;
}
export interface AbstractCardPaymentMethodSpecificInput extends AbstractPaymentMethodSpecificInput {
acquirerPromotionCode?: string | null;
authorizationMode?: string | null;
customerReference?: string | null;
initialSchemeTransactionId?: string | null;
recurring?: CardRecurrenceDetails | null;
/**
* @deprecated Use recurring.recurringPaymentSequenceIndicator instead
*/
recurringPaymentSequenceIndicator?: string | null;
requiresApproval?: boolean | null;
/**
* @deprecated Use threeDSecure.skipAuthentication instead
*/
skipAuthentication?: boolean | null;
skipFraudService?: boolean | null;
token?: string | null;
tokenize?: boolean | null;
transactionChannel?: string | null;
/**
* @deprecated Use unscheduledCardOnFileSequenceIndicator instead
*/
unscheduledCardOnFileIndicator?: string | null;
unscheduledCardOnFileRequestor?: string | null;
unscheduledCardOnFileSequenceIndicator?: string | null;
}
export interface AbstractCashPaymentMethodSpecificInput extends AbstractPaymentMethodSpecificInput {
}
export interface AbstractEInvoicePaymentMethodSpecificInput extends AbstractPaymentMethodSpecificInput {
requiresApproval?: boolean | null;
}
export interface AbstractIndicator {
name?: string | null;
value?: string | null;
}
export interface AbstractMobilePaymentMethodSpecificInput extends AbstractPaymentMethodSpecificInput {
authorizationMode?: string | null;
customerReference?: string | null;
initialSchemeTransactionId?: string | null;
recurring?: CardRecurrenceDetails | null;
requiresApproval?: boolean | null;
skipFraudService?: boolean | null;
token?: string | null;
tokenize?: boolean | null;
unscheduledCardOnFileRequestor?: string | null;
unscheduledCardOnFileSequenceIndicator?: string | null;
}
export interface AbstractOrderStatus {
id?: string | null;
}
export interface AbstractPaymentMethodSpecificInput {
paymentProductId?: number | null;
}
export interface AbstractPaymentMethodSpecificOutput {
paymentProductId?: number | null;
}
export interface AbstractPayoutMethodSpecificInput {
}
export interface AbstractRedirectPaymentMethodSpecificInput extends AbstractPaymentMethodSpecificInput {
expirationPeriod?: number | null;
recurringPaymentSequenceIndicator?: string | null;
requiresApproval?: boolean | null;
token?: string | null;
tokenize?: boolean | null;
}
export interface AbstractRedirectPaymentProduct4101SpecificInput {
}
export interface AbstractRedirectPaymentProduct838SpecificInput {
interoperabilityData?: string | null;
interoperabilityToken?: string | null;
}
export interface AbstractRedirectPaymentProduct840SpecificInput {
addressSelectionAtPayPal?: boolean | null;
}
export interface AbstractSepaDirectDebitPaymentMethodSpecificInput extends AbstractPaymentMethodSpecificInput {
}
export interface AbstractSepaDirectDebitPaymentProduct771SpecificInput {
/**
* @deprecated Use existingUniqueMandateReference or mandate.uniqueMandateReference instead
*/
mandateReference?: string | null;
}
export interface AbstractThreeDSecure {
authenticationAmount?: AmountOfMoney | null;
authenticationFlow?: string | null;
challengeCanvasSize?: string | null;
challengeIndicator?: string | null;
exemptionRequest?: string | null;
priorThreeDSecureData?: ThreeDSecureData | null;
sdkData?: SdkDataInput | null;
skipAuthentication?: boolean | null;
transactionRiskLevel?: string | null;
}
export interface AbstractToken {
alias?: string | null;
}
export interface AccountFundingRecipient {
accountNumber?: string | null;
accountNumberType?: string | null;
address?: Address | null;
dateOfBirth?: string | null;
name?: AfrName | null;
partialPan?: string | null;
}
export interface AccountOnFile {
attributes?: AccountOnFileAttribute[] | null;
displayHints?: AccountOnFileDisplayHints | null;
id?: number | null;
paymentProductId?: number | null;
}
export interface AccountOnFileAttribute extends KeyValuePair {
mustWriteReason?: string | null;
status?: string | null;
}
export interface AccountOnFileDisplayHints {
labelTemplate?: LabelTemplateElement[] | null;
logo?: string | null;
}
export interface AdditionalOrderInput {
accountFundingRecipient?: AccountFundingRecipient | null;
airlineData?: AirlineData | null;
installments?: Installments | null;
/**
* @deprecated Use Order.shoppingCart.amountBreakdown instead
*/
level3SummaryData?: Level3SummaryData | null;
/**
* @deprecated No replacement
*/
loanRecipient?: LoanRecipient | null;
lodgingData?: LodgingData | null;
/**
* @deprecated Use installments.numberOfInstallments instead
*/
numberOfInstallments?: number | null;
orderDate?: string | null;
typeInformation?: OrderTypeInformation | null;
}
export interface AdditionalOrderInputAirlineData {
airlineData?: AirlineData | null;
lodgingData?: LodgingData | null;
}
export interface Address {
additionalInfo?: string | null;
city?: string | null;
countryCode?: string | null;
houseNumber?: string | null;
state?: string | null;
stateCode?: string | null;
street?: string | null;
zip?: string | null;
}
export interface AddressPersonal extends Address {
name?: PersonalName | null;
}
export interface AfrName {
firstName?: string | null;
surname?: string | null;
}
export interface AirlineData {
agentNumericCode?: string | null;
code?: string | null;
flightDate?: string | null;
flightLegs?: AirlineFlightLeg[] | null;
invoiceNumber?: string | null;
isETicket?: boolean | null;
/**
* @deprecated Use Order.customer.accountType instead
*/
isRegisteredCustomer?: boolean | null;
isRestrictedTicket?: boolean | null;
isThirdParty?: boolean | null;
issueDate?: string | null;
merchantCustomerId?: string | null;
name?: string | null;
numberInParty?: number | null;
passengerName?: string | null;
passengers?: AirlinePassenger[] | null;
placeOfIssue?: string | null;
pnr?: string | null;
pointOfSale?: string | null;
posCityCode?: string | null;
ticketDeliveryMethod?: string | null;
ticketNumber?: string | null;
totalFare?: number | null;
totalFee?: number | null;
totalTaxes?: number | null;
travelAgencyName?: string | null;
}
export interface AirlineFlightLeg {
airlineClass?: string | null;
arrivalAirport?: string | null;
arrivalTime?: string | null;
carrierCode?: string | null;
conjunctionTicket?: string | null;
couponNumber?: string | null;
date?: string | null;
departureTime?: string | null;
endorsementOrRestriction?: string | null;
exchangeTicket?: string | null;
fare?: string | null;
fareBasis?: string | null;
fee?: number | null;
flightNumber?: string | null;
number?: number | null;
originAirport?: string | null;
passengerClass?: string | null;
/**
* @deprecated Use passengerClass instead
*/
serviceClass?: string | null;
stopoverCode?: string | null;
taxes?: number | null;
}
export interface AirlinePassenger {
firstName?: string | null;
surname?: string | null;
surnamePrefix?: string | null;
title?: string | null;
}
export interface AmountBreakdown {
amount?: number | null;
type?: string | null;
}
export interface AmountOfMoney {
amount?: number | null;
currencyCode?: string | null;
}
export interface ApprovePaymentCardPaymentMethodSpecificOutput {
voidResponseId?: string | null;
}
export interface ApprovePaymentDirectDebitPaymentMethodSpecificInput extends ApprovePaymentPaymentMethodSpecificInput {
}
export interface ApprovePaymentMobilePaymentMethodSpecificOutput {
voidResponseId?: string | null;
}
export interface ApprovePaymentNonSepaDirectDebitPaymentMethodSpecificInput extends ApprovePaymentDirectDebitPaymentMethodSpecificInput {
}
export interface ApprovePaymentPaymentMethodSpecificInput {
dateCollect?: string | null;
token?: string | null;
}
export interface ApprovePaymentRequest {
amount?: number | null;
directDebitPaymentMethodSpecificInput?: ApprovePaymentNonSepaDirectDebitPaymentMethodSpecificInput | null;
order?: OrderApprovePayment | null;
sepaDirectDebitPaymentMethodSpecificInput?: ApprovePaymentSepaDirectDebitPaymentMethodSpecificInput | null;
}
export interface ApprovePaymentSepaDirectDebitPaymentMethodSpecificInput extends ApprovePaymentDirectDebitPaymentMethodSpecificInput {
}
export interface ApprovePayoutRequest {
datePayout?: string | null;
}
export interface ApproveRefundRequest {
amount?: number | null;
}
export interface ApproveTokenRequest extends MandateApproval {
}
export interface AuthenticationIndicator extends AbstractIndicator {
}
export interface AutomaticReloadBillingDetails extends BaseBillingDetails {
automaticReloadPaymentThresholdAmount?: number | null;
}
export interface BankAccount {
accountHolderName?: string | null;
}
export interface BankAccountBban extends BankAccount {
accountNumber?: string | null;
bankCode?: string | null;
bankName?: string | null;
branchCode?: string | null;
checkDigit?: string | null;
countryCode?: string | null;
}
export interface BankAccountBbanRefund extends BankAccountBban {
bankCity?: string | null;
patronymicName?: string | null;
swiftCode?: string | null;
}
export interface BankAccountIban extends BankAccount {
iban?: string | null;
}
export interface BankData {
newBankName?: string | null;
reformattedAccountNumber?: string | null;
reformattedBankCode?: string | null;
reformattedBranchCode?: string | null;
}
export interface BankDetails {
bankAccountBban?: BankAccountBban | null;
bankAccountIban?: BankAccountIban | null;
}
export interface BankDetailsRequest extends BankDetails {
}
export interface BankDetailsResponse {
bankAccountBban?: BankAccountBban | null;
bankAccountIban?: BankAccountIban | null;
bankData?: BankData | null;
swift?: Swift | null;
}
export interface BankRefundMethodSpecificInput {
bankAccountBban?: BankAccountBbanRefund | null;
bankAccountIban?: BankAccountIban | null;
countryCode?: string | null;
}
export interface BankTransferPaymentMethodSpecificInput extends AbstractBankTransferPaymentMethodSpecificInput {
}
export interface BankTransferPaymentMethodSpecificInputBase extends AbstractBankTransferPaymentMethodSpecificInput {
}
export interface BankTransferPaymentMethodSpecificOutput extends AbstractPaymentMethodSpecificOutput {
fraudResults?: FraudResults | null;
}
export interface BankTransferPayoutMethodSpecificInput extends AbstractPayoutMethodSpecificInput {
bankAccountBban?: BankAccountBban | null;
bankAccountIban?: BankAccountIban | null;
/**
* @deprecated Moved to PayoutDetails
*/
customer?: PayoutCustomer | null;
payoutDate?: string | null;
payoutText?: string | null;
swiftCode?: string | null;
}
export interface BaseBillingDetails {
description?: string | null;
}
export interface BoletoBancarioRequirednessValidator {
fiscalNumberLength?: number | null;
}
export interface BrowserData {
colorDepth?: number | null;
innerHeight?: string | null;
innerWidth?: string | null;
javaEnabled?: boolean | null;
javaScriptEnabled?: boolean | null;
screenHeight?: string | null;
screenWidth?: string | null;
}
export interface CancelApprovalPaymentResponse {
payment?: Payment | null;
}
export interface CancelPaymentCardPaymentMethodSpecificOutput {
voidResponseId?: string | null;
}
export interface CancelPaymentMobilePaymentMethodSpecificOutput {
voidResponseId?: string | null;
}
export interface CancelPaymentResponse {
cardPaymentMethodSpecificOutput?: CancelPaymentCardPaymentMethodSpecificOutput | null;
mobilePaymentMethodSpecificOutput?: CancelPaymentMobilePaymentMethodSpecificOutput | null;
payment?: Payment | null;
}
export interface Capture extends AbstractOrderStatus {
captureOutput?: CaptureOutput | null;
status?: string | null;
statusOutput?: CaptureStatusOutput | null;
}
export interface CaptureOutput extends OrderOutput {
amountPaid?: number | null;
amountReversed?: number | null;
bankTransferPaymentMethodSpecificOutput?: BankTransferPaymentMethodSpecificOutput | null;
cardPaymentMethodSpecificOutput?: CardPaymentMethodSpecificOutput | null;
cashPaymentMethodSpecificOutput?: CashPaymentMethodSpecificOutput | null;
paymentMethod?: string | null;
redirectPaymentMethodSpecificOutput?: RedirectPaymentMethodSpecificOutput | null;
reversalReason?: string | null;
sepaDirectDebitPaymentMethodSpecificOutput?: SepaDirectDebitPaymentMethodSpecificOutput | null;
}
export interface CapturePaymentOrder {
additionalInput?: CapturePaymentOrderAdditionalInput | null;
references?: CapturePaymentOrderReferences | null;
}
export interface CapturePaymentOrderAdditionalInput {
airlineData?: AirlineData | null;
lodgingData?: LodgingData | null;
}
export interface CapturePaymentOrderReferences {
merchantCaptureReference?: string | null;
}
export interface CapturePaymentRequest {
amount?: number | null;
isFinal?: boolean | null;
order?: CapturePaymentOrder | null;
}
export interface CaptureResponse extends Capture {
}
export interface CaptureStatusOutput {
isFinal?: boolean | null;
isRefundable?: boolean | null;
isRetriable?: boolean | null;
providerRawOutput?: KeyValuePair[] | null;
statusCode?: number | null;
statusCodeChangeDateTime?: string | null;
}
export interface CapturesResponse {
captures?: Capture[] | null;
}
export interface Card extends CardWithoutCvv {
cvv?: string | null;
partialPin?: string | null;
}
export interface CardEssentials {
cardNumber?: string | null;
cardholderName?: string | null;
expiryDate?: string | null;
}
export interface CardFraudResults extends FraudResults {
avsResult?: string | null;
cvvResult?: string | null;
fraugster?: FraugsterResults | null;
retailDecisions?: FraudResultsRetailDecisions | null;
}
export interface CardPaymentMethodSpecificInput extends AbstractCardPaymentMethodSpecificInput {
card?: Card | null;
clickToPay?: ClickToPayInput | null;
/**
* @deprecated Use threeDSecure.externalCardholderAuthenticationData instead
*/
externalCardholderAuthenticationData?: ExternalCardholderAuthenticationData | null;
isRecurring?: boolean | null;
merchantInitiatedReasonIndicator?: string | null;
networkTokenData?: SchemeTokenData | null;
/**
* @deprecated Use threeDSecure.redirectionData.returnUrl instead
*/
returnUrl?: string | null;
threeDSecure?: ThreeDSecure | null;
}
export interface CardPaymentMethodSpecificInputBase extends AbstractCardPaymentMethodSpecificInput {
threeDSecure?: ThreeDSecureBase | null;
}
export interface CardPaymentMethodSpecificOutput extends AbstractPaymentMethodSpecificOutput {
authorisationCode?: string | null;
card?: CardEssentials | null;
clickToPayUsed?: boolean | null;
fraudResults?: CardFraudResults | null;
initialSchemeTransactionId?: string | null;
networkTokenData?: NetworkTokenData | null;
networkTokenUsed?: boolean | null;
paymentAccountReference?: string | null;
schemeTransactionId?: string | null;
threeDSecureResults?: ThreeDSecureResults | null;
token?: string | null;
}
export interface CardPayoutMethodSpecificInput extends AbstractPayoutMethodSpecificInput {
card?: Card | null;
paymentProductId?: number | null;
recipient?: PayoutRecipient | null;
token?: string | null;
}
export interface CardRecurrenceDetails {
endDate?: string | null;
minFrequency?: number | null;
recurringPaymentSequenceIndicator?: string | null;
}
export interface CardWithoutCvv extends CardEssentials {
issueNumber?: string | null;
}
export interface CashPaymentMethodSpecificInput extends AbstractCashPaymentMethodSpecificInput {
paymentProduct1502SpecificInput?: CashPaymentProduct1502SpecificInput | null;
/**
* @deprecated No replacement
*/
paymentProduct1503SpecificInput?: CashPaymentProduct1503SpecificInput | null;
paymentProduct1504SpecificInput?: CashPaymentProduct1504SpecificInput | null;
paymentProduct1506SpecificInput?: CashPaymentProduct1506SpecificInput | null;
paymentProduct1508SpecificInput?: CashPaymentProduct1508SpecificInput | null;
paymentProduct1521SpecificInput?: CashPaymentProduct1521SpecificInput | null;
paymentProduct1522SpecificInput?: CashPaymentProduct1522SpecificInput | null;
paymentProduct1523SpecificInput?: CashPaymentProduct1523SpecificInput | null;
paymentProduct1524SpecificInput?: CashPaymentProduct1524SpecificInput | null;
paymentProduct1525SpecificInput?: CashPaymentProduct1525SpecificInput | null;
paymentProduct1526SpecificInput?: CashPaymentProduct1526SpecificInput | null;
}
export interface CashPaymentMethodSpecificInputBase extends AbstractCashPaymentMethodSpecificInput {
}
export interface CashPaymentMethodSpecificOutput extends AbstractPaymentMethodSpecificOutput {
fraudResults?: FraudResults | null;
}
export interface CashPaymentProduct1502SpecificInput extends CashPaymentProductWithRedirectSpecificInputBase {
}
/**
* @deprecated No replacement
*/
export interface CashPaymentProduct1503SpecificInput {
/**
* @deprecated No replacement, since Boleto Bancario no longer needs a return URL
*/
returnUrl?: string | null;
}
export interface CashPaymentProduct1504SpecificInput extends CashPaymentProductWithRedirectSpecificInputBase {
}
export interface CashPaymentProduct1506SpecificInput extends CashPaymentProductWithRedirectSpecificInputBase {
}
export interface CashPaymentProduct1508SpecificInput extends CashPaymentProductWithRedirectSpecificInputBase {
}
export interface CashPaymentProduct1521SpecificInput extends CashPaymentProductWithRedirectSpecificInputBase {
}
export interface CashPaymentProduct1522SpecificInput extends CashPaymentProductWithRedirectSpecificInputBase {
}
export interface CashPaymentProduct1523SpecificInput extends CashPaymentProductWithRedirectSpecificInputBase {
}
export interface CashPaymentProduct1524SpecificInput extends CashPaymentProductWithRedirectSpecificInputBase {
}
export interface CashPaymentProduct1525SpecificInput extends CashPaymentProductWithRedirectSpecificInputBase {
}
export interface CashPaymentProduct1526SpecificInput extends CashPaymentProductWithRedirectSpecificInputBase {
}
export interface CashPaymentProductWithRedirectSpecificInputBase {
returnUrl?: string | null;
}
export interface ClickToPayConfiguration {
displayHints?: ClickToPayDisplayHints | null;
mastercard?: ClickToPayConfigurationMastercard | null;
visa?: ClickToPayConfigurationVisa | null;
}
export interface ClickToPayConfigurationMastercard extends ClickToPaySchemeConfigurationBase {
}
export interface ClickToPayConfigurationVisa extends ClickToPaySchemeConfigurationBase {
encryptionKey?: string | null;
nModulus?: string | null;
}
export interface ClickToPayDisplayHints {
logo?: string | null;
}
export interface ClickToPayInput {
checkoutResponseSignature?: string | null;
}
export interface ClickToPaySchemeConfigurationBase {
srcInitiatorId?: string | null;
srciDpaId?: string | null;
}
export interface CompanyInformation {
dateOfIncorporation?: string | null;
name?: string | null;
vatNumber?: string | null;
}
export interface CompletePaymentCardPaymentMethodSpecificInput {
card?: CardWithoutCvv | null;
}
export interface CompletePaymentRequest {
cardPaymentMethodSpecificInput?: CompletePaymentCardPaymentMethodSpecificInput | null;
merchant?: Merchant | null;
order?: Order | null;
}
export interface CompletePaymentResponse extends CreatePaymentResult {
}
export interface ContactDetails extends ContactDetailsBase {
faxNumber?: string | null;
mobilePhoneNumber?: string | null;
phoneNumber?: string | null;
workPhoneNumber?: string | null;
}
export interface ContactDetailsBase {
emailAddress?: string | null;
emailMessageType?: string | null;
}
export interface ContactDetailsRiskAssessment {
emailAddress?: string | null;
}
export interface ContactDetailsToken extends ContactDetailsBase {
}
export interface ConvertAmount {
convertedAmount?: number | null;
}
export interface CreateDisputeRequest {
amountOfMoney?: AmountOfMoney | null;
contactPerson?: string | null;
emailAddress?: string | null;
replyTo?: string | null;
requestMessage?: string | null;
}
export interface CreateHostedCheckoutRequest {
bankTransferPaymentMethodSpecificInput?: BankTransferPaymentMethodSpecificInputBase | null;
cardPaymentMethodSpecificInput?: CardPaymentMethodSpecificInputBase | null;
cashPaymentMethodSpecificInput?: CashPaymentMethodSpecificInputBase | null;
eInvoicePaymentMethodSpecificInput?: EInvoicePaymentMethodSpecificInputBase | null;
fraudFields?: FraudFields | null;
hostedCheckoutSpecificInput?: HostedCheckoutSpecificInput | null;
merchant?: Merchant | null;
mobilePaymentMethodSpecificInput?: MobilePaymentMethodSpecificInputHostedCheckout | null;
order?: Order | null;
redirectPaymentMethodSpecificInput?: RedirectPaymentMethodSpecificInputBase | null;
sepaDirectDebitPaymentMethodSpecificInput?: SepaDirectDebitPaymentMethodSpecificInputBase | null;
}
export interface CreateHostedCheckoutResponse {
RETURNMAC?: string | null;
hostedCheckoutId?: string | null;
invalidTokens?: string[] | null;
merchantReference?: string | null;
partialRedirectUrl?: string | null;
}
export interface CreateHostedMandateManagementRequest {
createMandateInfo?: HostedMandateInfo | null;
hostedMandateManagementSpecificInput?: HostedMandateManagementSpecificInput | null;
}
export interface CreateHostedMandateManagementResponse {
RETURNMAC?: string | null;
hostedMandateManagementId?: string | null;
partialRedirectUrl?: string | null;
}
export interface CreateMandateBase {
alias?: string | null;
customer?: MandateCustomer | null;
customerReference?: string | null;
language?: string | null;
recurrenceType?: string | null;
signatureType?: string | null;
uniqueMandateReference?: string | null;
}
export interface CreateMandateRequest extends CreateMandateWithReturnUrl {
}
export interface CreateMandateResponse {
mandate?: MandateResponse | null;
merchantAction?: MandateMerchantAction | null;
}
export interface CreateMandateWithReturnUrl extends CreateMandateBase {
returnUrl?: string | null;
}
export interface CreatePaymentProductSessionRequest {
paymentProductSession302SpecificInput?: MobilePaymentProductSession302SpecificInput | null;
}
export interface CreatePaymentProductSessionResponse {
paymentProductSession302SpecificOutput?: MobilePaymentProductSession302SpecificOutput | null;
}
export interface CreatePaymentRequest {
bankTransferPaymentMethodSpecificInput?: BankTransferPaymentMethodSpecificInput | null;
cardPaymentMethodSpecificInput?: CardPaymentMethodSpecificInput | null;
cashPaymentMethodSpecificInput?: CashPaymentMethodSpecificInput | null;
directDebitPaymentMethodSpecificInput?: NonSepaDirectDebitPaymentMethodSpecificInput | null;
eInvoicePaymentMethodSpecificInput?: EInvoicePaymentMethodSpecificInput | null;
encryptedCustomerInput?: string | null;
fraudFields?: FraudFields | null;
invoicePaymentMethodSpecificInput?: InvoicePaymentMethodSpecificInput | null;
merchant?: Merchant | null;
mobilePaymentMethodSpecificInput?: MobilePaymentMethodSpecificInput | null;
order?: Order | null;
redirectPaymentMethodSpecificInput?: RedirectPaymentMethodSpecificInput | null;
sepaDirectDebitPaymentMethodSpecificInput?: SepaDirectDebitPaymentMethodSpecificInput | null;
}
export interface CreatePaymentResponse extends CreatePaymentResult {
}
export interface CreatePaymentResult {
creationOutput?: PaymentCreationOutput | null;
merchantAction?: MerchantAction | null;
payment?: Payment | null;
}
export interface CreatePayoutRequest {
/**
* @deprecated Moved to PayoutDetails
*/
amountOfMoney?: AmountOfMoney | null;
/**
* @deprecated Moved to BankTransferPayoutMethodSpecificInput
*/
bankAccountBban?: BankAccountBban | null;
/**
* @deprecated Moved to BankTransferPayoutMethodSpecificInput
*/
bankAccountIban?: BankAccountIban | null;
bankTransferPayoutMethodSpecificInput?: BankTransferPayoutMethodSpecificInput | null;
cardPayoutMethodSpecificInput?: CardPayoutMethodSpecificInput | null;
/**
* @deprecated Moved to PayoutDetails
*/
customer?: PayoutCustomer | null;
merchant?: PayoutMerchant | null;
/**
* @deprecated Moved to BankTransferPayoutMethodSpecificInput
*/
payoutDate?: string | null;
payoutDetails?: PayoutDetails | null;
/**
* @deprecated Moved to BankTransferPayoutMethodSpecificInput
*/
payoutText?: string | null;
/**
* @deprecated Moved to PayoutDetails
*/
references?: PayoutReferences | null;
/**
* @deprecated Moved to BankTransferPayoutMethodSpecificInput
*/
swiftCode?: string | null;
}
export interface CreateTokenRequest {
card?: TokenCard | null;
eWallet?: TokenEWallet | null;
encryptedCustomerInput?: string | null;
nonSepaDirectDebit?: TokenNonSepaDirectDebit | null;
paymentProductId?: number | null;
sepaDirectDebit?: TokenSepaDirectDebitWithoutCreditor | null;
}
export interface CreateTokenResponse {
isNewToken?: boolean | null;
originalPaymentId?: string | null;
token?: string | null;
}
export interface CreatedPaymentOutput {
displayedData?: DisplayedData | null;
isCheckedRememberMe?: boolean | null;
payment?: Payment | null;
paymentCreationReferences?: PaymentCreationReferences | null;
/**
* @deprecated Use Payment.statusOutput.statusCategory instead
*/
paymentStatusCategory?: string | null;
tokenizationSucceeded?: boolean | null;
tokens?: string | null;
}
export interface Creditor {
additionalAddressInfo?: string | null;
city?: string | null;
countryCode?: string | null;
houseNumber?: string | null;
iban?: string | null;
id?: string | null;
name?: string | null;
referenceParty?: string | null;
referencePartyId?: string | null;
street?: string | null;
zip?: string | null;
}
export interface Customer extends CustomerBase {
account?: CustomerAccount | null;
accountType?: string | null;
billingAddress?: Address | null;
contactDetails?: ContactDetails | null;
device?: CustomerDevice | null;
fiscalNumber?: string | null;
isCompany?: boolean | null;
isPreviousCustomer?: boolean | null;
locale?: string | null;
personalInformation?: PersonalInformation | null;
/**
* @deprecated Use Order.shipping.address instead
*/
shippingAddress?: AddressPersonal | null;
}
export interface CustomerAccount {
authentication?: CustomerAccountAuthentication | null;
changeDate?: string | null;
changedDuringCheckout?: boolean | null;
createDate?: string | null;
hadSuspiciousActivity?: boolean | null;
hasForgottenPassword?: boolean | null;
hasPassword?: boolean | null;
passwordChangeDate?: string | null;
passwordChangedDuringCheckout?: boolean | null;
paymentAccountOnFile?: PaymentAccountOnFile | null;
paymentAccountOnFileType?: string | null;
paymentActivity?: CustomerPaymentActivity | null;
}
export interface CustomerAccountAuthentication {
data?: string | null;
method?: string | null;
utcTimestamp?: string | null;
}
export interface CustomerAccountRiskAssessment {
hasForgottenPassword?: boolean | null;
hasPassword?: boolean | null;
}
export interface CustomerApprovePayment {
accountType?: string | null;
}
export interface CustomerBase {
companyInformation?: CompanyInformation | null;
merchantCustomerId?: string | null;
/**
* @deprecated Use companyInformation.vatNumber instead
*/
vatNumber?: string | null;
}
export interface CustomerDevice {
acceptHeader?: string | null;
browserData?: BrowserData | null;
defaultFormFill?: string | null;
deviceFingerprintTransactionId?: string | null;
ipAddress?: string | null;
locale?: string | null;
timezoneOffsetUtcMinutes?: string | null;
userAgent?: string | null;
}
export interface CustomerDeviceRiskAssessment {
defaultFormFill?: string | null;
deviceFingerprintTransactionId?: string | null;
}
export interface CustomerPaymentActivity {
numberOfPaymentAttemptsLast24Hours?: number | null;
numberOfPaymentAttemptsLastYear?: number | null;
numberOfPurchasesLast6Months?: number | null;
}
export interface CustomerRiskAssessment {
account?: CustomerAccountRiskAssessment | null;
accountType?: string | null;
billingAddress?: Address | null;
contactDetails?: ContactDetailsRiskAssessment | null;
device?: CustomerDeviceRiskAssessment | null;
isPreviousCustomer?: boolean | null;
locale?: string | null;
personalInformation?: PersonalInformationRiskAssessment | null;
/**
* @deprecated Use Order.shipping.address instead
*/
shippingAddress?: AddressPersonal | null;
}
export interface CustomerToken extends CustomerBase {
billingAddress?: Address | null;
personalInformation?: PersonalInformationToken | null;
}
export interface CustomerTokenWithContactDetails extends CustomerToken {
contactDetails?: ContactDetailsToken | null;
}
export interface CybersourceDecisionManager {
clauseName?: string | null;
fraudScore?: number | null;
policyApplied?: string | null;
reasonCodes?: string[] | null;
}
export interface Debtor {
additionalAddressInfo?: string | null;
city?: string | null;
countryCode?: string | null;
firstName?: string | null;
houseNumber?: string | null;
state?: string | null;
stateCode?: string | null;
street?: string | null;
surname?: string | null;
surnamePrefix?: string | null;
zip?: string | null;
}
export interface DecryptedPaymentData {
/**
* @deprecated Use decryptedPaymentData.paymentMethod instead
*/
authMethod?: string | null;
cardholderName?: string | null;
cryptogram?: string | null;
dpan?: string | null;
eci?: number | null;
expiryDate?: string | null;
pan?: string | null;
paymentMethod?: string | null;
}
export interface DeferredBillingDetails extends BaseBillingDetails {
deferredPaymentAmount?: number | null;
deferredPaymentDate?: string | null;
freeCancellationDate?: string | null;
freeCancellationDateTimeZone?: string | null;
}
export interface DeviceFingerprintDetails {
paymentId?: string | null;
rawDeviceFingerprintOutput?: string | null;
}
export interface DeviceFingerprintRequest {
collectorCallback?: string | null;
}
export interface DeviceFingerprintResponse {
deviceFingerprintTransactionId?: string | null;
html?: string | null;
}
export interface DeviceRenderOptions {
sdkInterface?: string | null;
/**
* @deprecated Use deviceRenderOptions.sdkUiTypes instead
*/
sdkUiType?: string | null;
sdkUiTypes?: string[] | null;
}
export interface Directory {
entries?: DirectoryEntry[] | null;
}
export interface DirectoryEntry {
countryNames?: string[] | null;
issuerId?: string | null;
issuerList?: string | null;
issuerName?: string | null;
}
export interface DisplayedData {
displayedDataType?: string | null;
renderingData?: string | null;
showData?: KeyValuePair[] | null;
}
export interface Dispute {
captureId?: string | null;
disputeOutput?: DisputeOutput | null;
id?: string | null;
paymentId?: string | null;
status?: string | null;
statusOutput?: DisputeStatusOutput | null;
}
export interface DisputeCreationDetail {
disputeCreationDate?: string | null;
disputeOriginator?: string | null;
userName?: string | null;
}
export interface DisputeOutput {
amountOfMoney?: AmountOfMoney | null;
contactPerson?: string | null;
creationDetails?: DisputeCreationDetail | null;
emailAddress?: string | null;
files?: HostedFile[] | null;
reference?: DisputeReference | null;
replyTo?: string | null;
requestMessage?: string | null;
responseMessage?: string | null;
}
export interface DisputeReference {
merchantOrderId?: string | null;
merchantReference?: string | null;
paymentReference?: string | null;
providerId?: string | null;
providerReference?: string | null;
}
export interface DisputeResponse extends Dispute {
}
export interface DisputeStatusOutput {
isCancellable?: boolean | null;
statusCategory?: string | null;
statusCode?: number | null;
statusCodeChangeDateTime?: string | null;
}
export interface DisputesResponse {
disputes?: Dispute[] | null;
}
export interface EInvoicePaymentMethodSpecificInput extends AbstractEInvoicePaymentMethodSpecificInput {
acceptedTermsAndConditions?: boolean | null;
paymentProduct9000SpecificInput?: EInvoicePaymentProduct9000SpecificInput | null;
}
export interface EInvoicePaymentMethodSpecificInputBase extends AbstractEInvoicePaymentMethodSpecificInput {
}
export interface EInvoicePaymentMethodSpecificOutput extends AbstractPaymentMethodSpecificOutput {
fraudResults?: FraudResults | null;
paymentProduct9000SpecificOutput?: EInvoicePaymentProduct9000SpecificOutput | null;
}
export interface EInvoicePaymentProduct9000SpecificInput {
bankAccountIban?: BankAccountIban | null;
installmentId?: string | null;
}
export interface EInvoicePaymentProduct9000SpecificOutput {
installmentId?: string | null;
}
export interface EmptyValidator {
}
export interface ErrorResponse {
errorId?: string | null;
errors?: APIError[] | null;
}
export interface ExemptionOutput {
exemptionRaised?: string | null;
exemptionRejectionReason?: string | null;
exemptionRequest?: string | null;
}
export interface ExternalCardholderAuthenticationData {
acsTransactionId?: string | null;
appliedExemption?: string | null;
cavv?: string | null;
cavvAlgorithm?: string | null;
directoryServerTransactionId?: string | null;
eci?: number | null;
schemeRiskScore?: number | null;
threeDSecureVersion?: string | null;
/**
* @deprecated No replacement
*/
threeDServerTransactionId?: string | null;
validationResult?: string | null;
xid?: string | null;
}
export interface FindPaymentsResponse {
limit?: number | null;
offset?: number | null;
payments?: Payment[] | null;
totalCount?: number | null;
}
export interface FindPayoutsResponse {
limit?: number | null;
offset?: number | null;
payouts?: PayoutResult[] | null;
totalCount?: number | null;
}
export interface FindRefundsResponse {
limit?: number | null;
offset?: number | null;
refunds?: RefundResult[] | null;
totalCount?: number | null;
}
export interface FixedListValidator {
allowedValues?: string[] | null;
}
export interface FraudFields {
/**
* @deprecated For risk assessments there is no replacement. For other calls, use Order.shipping.addressIndicator instead
*/
addressesAreIdentical?: boolean | null;
blackListData?: string | null;
/**
* @deprecated This should be the same as Order.customer.billingAddress
*/
cardOwnerAddress?: Address | null;
customerIpAddress?: string | null;
/**
* @deprecated Use Order.customer.device.defaultFormFill instead
*/
defaultFormFill?: string | null;
/**
* @deprecated No replacement
*/
deviceFingerprintActivated?: boolean | null;
/**
* @deprecated Use Order.customer.device.deviceFingerprintTransactionId instead
*/
deviceFingerprintTransactionId?: string | null;
giftCardType?: string | null;
giftMessage?: string | null;
/**
* @deprecated Use Order.customer.account.hasForgottenPassword instead
*/
hasForgottenPwd?: boolean | null;
/**
* @deprecated Use Order.customer.account.hasPassword instead
*/
hasPassword?: boolean | null;
/**
* @deprecated Use Order.customer.isPreviousCustomer instead
*/
isPreviousCustomer?: boolean | null;
orderTimezone?: string | null;
/**
* @deprecated Use Order.shipping.comments instead
*/
shipComments?: string | null;
/**
* @deprecated Use Order.shipping.trackingNumber instead
*/
shipmentTrackingNumber?: string | null;
/**
* @deprecated No replacement
*/
shippingDetails?: FraudFieldsShippingDetails | null;
userData?: string[] | null;
/**
* @deprecated Use Merchant.websiteUrl instead
*/
website?: string | null;
}
/**
* @deprecated No replacement
*/
export interface FraudFieldsShippingDetails {
/**
* @deprecated No replacement
*/
methodDetails?: string | null;
/**
* @deprecated No replacement
*/
methodSpeed?: number | null;
/**
* @deprecated No replacement
*/
methodType?: number | null;
}
export interface FraudResults {
cybersourceDecisionManager?: CybersourceDecisionManager | null;
fraudServiceResult?: string | null;
inAuth?: InAuth | null;
microsoftFraudProtection?: MicrosoftFraudResults | null;
}
export interface FraudResultsRetailDecisions {
fraudCode?: string | null;
fraudNeural?: string | null;
fraudRCF?: string | null;
}
export interface FraugsterResults {
fraudInvestigationPoints?: string | null;
fraudScore?: number | null;
}
export interface Frequency {
interval?: string | null;
intervalFrequency?: number | null;
}
export interface GPayThreeDSecure {
challengeCanvasSize?: string | null;
challengeIndicator?: string | null;
exemptionRequest?: string | null;
redirectionData?: RedirectionData | null;
skipAuthentication?: boolean | null;
}
export interface GetCustomerDetailsRequest {
countryCode?: string | null;
values?: KeyValuePair[] | null;
}
export interface GetCustomerDetailsResponse {
city?: string | null;
country?: string | null;
emailAddress?: string | null;
firstName?: string | null;
fiscalNumber?: string | null;
languageCode?: string | null;
phoneNumber?: string | null;
street?: string | null;
surname?: string | null;
zip?: string | null;
}
export interface GetHostedCheckoutResponse {
createdPaymentOutput?: CreatedPaymentOutput | null;
status?: string | null;
}
export interface GetHostedMandateManagementResponse {
mandate?: MandateResponse | null;
status?: string | null;
}
export interface GetIINDetailsRequest {
bin?: string | null;
paymentContext?: PaymentContext | null;
}
export interface GetIINDetailsResponse {
coBrands?: IINDetail[] | null;
countryCode?: string | null;
isAllowedInContext?: boolean | null;
paymentProductId?: number | null;
}
export interface GetInstallmentRequest {
amountOfMoney?: AmountOfMoney | null;
bin?: string | null;
countryCode?: string | null;
paymentProductId?: number | null;
}
export interface GetMandateResponse {
mandate?: MandateResponse | null;
}
export interface GetPrivacyPolicyResponse {
htmlContent?: string | null;
}
export interface GiftCardPurchase {
amountOfMoney?: AmountOfMoney | null;
numberOfGiftCards?: number | null;
}
export interface HostedCheckoutSpecificInput {
allowClickToPay?: boolean | null;
isRecurring?: boolean | null;
locale?: string | null;
paymentProductFilters?: PaymentProductFiltersHostedCheckout | null;
recurringPaymentsData?: RecurringPaymentsData | null;
returnCancelState?: boolean | null;
returnUrl?: string | null;
showResultPage?: boolean | null;
tokens?: string | null;
validateShoppingCart?: boolean | null;
variant?: string | null;
}
export interface HostedCheckoutSpecificOutput {
hostedCheckoutId?: string | null;
variant?: string | null;
}
export interface HostedFile {
fileName?: string | null;
fileSize?: string | null;
fileType?: string | null;
id?: string | null;
}
export interface HostedMandateInfo {
alias?: string | null;
customer?: MandateCustomer | null;
customerReference?: string | null;
recurrenceType?: string | null;
signatureType?: string | null;
uniqueMandateReference?: string | null;
}
export interface HostedMandateManagementSpecificInput {
locale?: string | null;
returnUrl?: string | null;
showResultPage?: boolean | null;
variant?: string | null;
}
export interface IINDetail {
isAllowedInContext?: boolean | null;
paymentProductId?: number | null;
}
export interface InAuth {
deviceCategory?: string | null;
deviceId?: string | null;
riskScore?: string | null;
trueIpAddress?: string | null;
trueIpAddressCountry?: string | null;
}
export interface InstallmentDisplayHints {
displayOrder?: number | null;
label?: string | null;
logo?: string | null;
}
export interface InstallmentOptions {
displayHints?: InstallmentDisplayHints | null;
id?: string | null;
installmentPlans?: Installments[] | null;
}
export interface InstallmentOptionsResponse {
installmentOptions?: InstallmentOptions[] | null;
}
export interface Installments {
amountOfMoneyPerInstallment?: AmountOfMoney | null;
amountOfMoneyTotal?: AmountOfMoney | null;
frequencyOfInstallments?: string | null;
installmentPlanCode?: number | null;
interestRate?: string | null;
numberOfInstallments?: number | null;
}
export interface InvoicePaymentMethodSpecificInput extends AbstractPaymentMethodSpecificInput {
additionalReference?: string | null;
}
export interface InvoicePaymentMethodSpecificOutput extends AbstractPaymentMethodSpecificOutput {
fraudResults?: FraudResults | null;
}
export interface KeyValuePair {
key?: string | null;
value?: string | null;
}
export interface LabelTemplateElement {
attributeKey?: string | null;
mask?: string | null;
}
export interface LengthValidator {
maxLength?: number | null;
minLength?: number | null;
}
/**
* @deprecated Use ShoppingCart.amountBreakdown instead
*/
export interface Level3SummaryData {
/**
* @deprecated Use ShoppingCart.amountBreakdown with type DISCOUNT instead
*/
discountAmount?: number | null;
/**
* @deprecated Use ShoppingCart.amountBreakdown with type DUTY instead
*/
dutyAmount?: number | null;
/**
* @deprecated Use ShoppingCart.amountBreakdown with type SHIPPING instead
*/
shippingAmount?: number | null;
}
export interface LineItem {
amountOfMoney?: AmountOfMoney | null;
invoiceData?: LineItemInvoiceData | null;
/**
* @deprecated Use orderLineDetails instead
*/
level3InterchangeInformation?: LineItemLevel3InterchangeInformation | null;
orderLineDetails?: OrderLineDetails | null;
}
export interface LineItemInvoiceData {
description?: string | null;
merchantLinenumber?: string | null;
merchantPagenumber?: string | null;
nrOfItems?: string | null;
pricePerItem?: number | null;
}
export interface LineItemLevel3InterchangeInformation {
discountAmount?: number | null;
lineAmountTotal?: number | null;
productCode?: string | null;
productPrice?: number | null;
productType?: string | null;
quantity?: number | null;
taxAmount?: number | null;
unit?: string | null;
}
/**
* @deprecated No replacement
*/
export interface LoanRecipient {
/**
* @deprecated No replacement
*/
accountNumber?: string | null;
/**
* @deprecated No replacement
*/
dateOfBirth?: string | null;
/**
* @deprecated No replacement
*/
partialPan?: string | null;
/**
* @deprecated No replacement
*/
surname?: string | null;
/**
* @deprecated No replacement
*/
zip?: string | null;
}
export interface LodgingCharge {
chargeAmount?: number | null;
chargeAmountCurrencyCode?: string | null;
chargeType?: string | null;
}
export interface LodgingData {
charges?: LodgingCharge[] | null;
checkInDate?: string | null;
checkOutDate?: string | null;
folioNumber?: string | null;
isConfirmedReservation?: boolean | null;
isFacilityFireSafetyConform?: boolean | null;
isNoShow?: boolean | null;
isPreferenceSmokingRoom?: boolean | null;
numberOfAdults?: number | null;
numberOfNights?: number | null;
numberOfRooms?: number | null;
programCode?: string | null;
propertyCustomerServicePhoneNumber?: string | null;
propertyPhoneNumber?: string | null;
renterName?: string | null;
rooms?: LodgingRoom[] | null;
}
export interface LodgingRoom {
dailyRoomRate?: string | null;
dailyRoomRateCurrencyCode?: string | null;
dailyRoomTaxAmount?: string | null;
dailyRoomTaxAmountCurrencyCode?: string | null;
numberOfNightsAtRoomRate?: number | null;
roomLocation?: string | null;
roomNumber?: string | null;
typeOfBed?: string | null;
typeOfRoom?: string | null;
}
export interface MandateAddress {
city?: string | null;
countryCode?: string | null;
houseNumber?: string | null;
street?: string | null;
zip?: string | null;
}
export interface MandateApproval {
mandateSignatureDate?: string | null;
mandateSignaturePlace?: string | null;
mandateSigned?: boolean | null;
}
export interface MandateContactDetails {
emailAddress?: string | null;
}
export interface MandateCustomer {
bankAccountIban?: BankAccountIban | null;
companyName?: string | null;
contactDetails?: MandateContactDetails | null;
mandateAddress?: MandateAddress | null;
personalInformation?: MandatePersonalInformation | null;
}
export interface MandateMerchantAction {
actionType?: string | null;
redirectData?: MandateRedirectData | null;
}
export interface MandateNonSepaDirectDebit {
paymentProduct705SpecificData?: TokenNonSepaDirectDebitPaymentProduct705SpecificData | null;
paymentProduct730SpecificData?: TokenNonSepaDirectDebitPaymentProduct730SpecificData | null;
}
export interface MandatePersonalInformation {
name?: MandatePersonalName | null;
title?: string | null;
}
export interface MandatePersonalName {
firstName?: string | null;
surname?: string | null;
}
export interface MandateRedirectData extends RedirectDataBase {
}
export interface MandateResponse {
alias?: string | null;
customer?: MandateCustomer | null;
customerReference?: string | null;
recurrenceType?: string | null;
status?: string | null;
uniqueMandateReference?: string | null;
}
export interface MandateSepaDirectDebit extends MandateSepaDirectDebitWithMandateId {
creditor?: Creditor | null;
}
export interface MandateSepaDirectDebitWithMandateId extends MandateSepaDirectDebitWithoutCreditor {
mandateId?: string | null;
}
export interface MandateSepaDirectDebitWithoutCreditor {
bankAccountIban?: BankAccountIban | null;
customerContractIdentifier?: string | null;
debtor?: Debtor | null;
isRecurring?: boolean | null;
mandateApproval?: MandateApproval | null;
preNotification?: string | null;
}
export interface Merchant {
configurationId?: string | null;
contactWebsiteUrl?: string | null;
seller?: Seller | null;
websiteUrl?: string | null;
}
export interface MerchantAction {
actionType?: string | null;
formFields?: PaymentProductField[] | null;
mobileThreeDSecureChallengeParameters?: MobileThreeDSecureChallengeParameters | null;
redirectData?: RedirectData | null;
renderingData?: string | null;
showData?: KeyValuePair[] | null;
thirdPartyData?: ThirdPartyData | null;
}
export interface MerchantRiskAssessment {
websiteUrl?: string | null;
}
export interface MicrosoftFraudResults {
clauseName?: string | null;
deviceCountryCode?: string | null;
deviceId?: string | null;
fraudScore?: number | null;
policyApplied?: string | null;
reasonCodes?: string[] | null;
trueIpAddress?: string | null;
userDeviceType?: string | null;
}
export interface MobilePaymentData {
dpan?: string | null;
expiryDate?: string | null;
}
export interface MobilePaymentMethodSpecificInput extends AbstractMobilePaymentMethodSpecificInput {
decryptedPaymentData?: DecryptedPaymentData | null;
encryptedPaymentData?: string | null;
isRecurring?: boolean | null;
merchantInitiatedReasonIndicator?: string | null;
paymentProduct320SpecificInput?: MobilePaymentProduct320SpecificInput | null;
}
export interface MobilePaymentMethodSpecificInputHostedCheckout extends AbstractMobilePaymentMethodSpecificInput {
paymentProduct302SpecificInput?: MobilePaymentProduct302SpecificInputHostedCheckout | null;
paymentProduct320SpecificInput?: MobilePaymentProduct320SpecificInputHostedCheckout | n