mangopay4-nodejs-sdk 1.64.0

package/typings/models/event.d.ts

@@ -0,0 +1,142 @@
+import { Timestamp } from "../types";
+
+export namespace event {
+    type EventType =
+        | "PAYIN_NORMAL_CREATED"
+        | "PAYIN_NORMAL_SUCCEEDED"
+        | "PAYIN_NORMAL_FAILED"
+        | "PAYOUT_NORMAL_CREATED"
+        | "PAYOUT_NORMAL_SUCCEEDED"
+        | "PAYOUT_NORMAL_FAILED"
+        | "TRANSFER_NORMAL_CREATED"
+        | "TRANSFER_NORMAL_SUCCEEDED"
+        | "TRANSFER_NORMAL_FAILED"
+        | "PAYIN_REFUND_CREATED"
+        | "PAYIN_REFUND_SUCCEEDED"
+        | "PAYIN_REFUND_FAILED"
+        | "PAYOUT_REFUND_CREATED"
+        | "PAYOUT_REFUND_SUCCEEDED"
+        | "PAYOUT_REFUND_FAILED"
+        | "INSTANT_PAYOUT_SUCCEEDED"
+        | "INSTANT_PAYOUT_FALLBACKED"
+        | "TRANSFER_REFUND_CREATED"
+        | "TRANSFER_REFUND_SUCCEEDED"
+        | "TRANSFER_REFUND_FAILED"
+        | "KYC_CREATED"
+        | "KYC_OUTDATED"
+        | "KYC_VALIDATION_ASKED"
+        | "KYC_SUCCEEDED"
+        | "KYC_FAILED"
+        | "PAYIN_REPUDIATION_CREATED"
+        | "PAYIN_REPUDIATION_SUCCEEDED"
+        | "PAYIN_REPUDIATION_FAILED"
+        | "DISPUTE_DOCUMENT_CREATED"
+        | "DISPUTE_DOCUMENT_VALIDATION_ASKED"
+        | "DISPUTE_DOCUMENT_SUCCEEDED"
+        | "DISPUTE_DOCUMENT_FAILED"
+        | "DISPUTE_CREATED"
+        | "DISPUTE_SUBMITTED"
+        | "DISPUTE_ACTION_REQUIRED"
+        | "DISPUTE_FURTHER_ACTION_REQUIRED"
+        | "DISPUTE_CLOSED"
+        | "DISPUTE_SENT_TO_BANK"
+        | "TRANSFER_SETTLEMENT_CREATED"
+        | "TRANSFER_SETTLEMENT_SUCCEEDED"
+        | "TRANSFER_SETTLEMENT_FAILED"
+        | "MANDATE_CREATED"
+        | "MANDATE_FAILED"
+        | "MANDATE_ACTIVATED"
+        | "MANDATE_SUBMITTED"
+        | "MANDATE_EXPIRED"
+        | "PREAUTHORIZATION_PAYMENT_WAITING"
+        | "PREAUTHORIZATION_PAYMENT_EXPIRED"
+        | "PREAUTHORIZATION_PAYMENT_CANCELED"
+        | "PREAUTHORIZATION_PAYMENT_VALIDATED"
+        | "UBO_DECLARATION_CREATED"
+        | "UBO_DECLARATION_VALIDATION_ASKED"
+        | "UBO_DECLARATION_REFUSED"
+        | "UBO_DECLARATION_VALIDATED"
+        | "UBO_DECLARATION_INCOMPLETE"
+        | "USER_KYC_REGULAR"
+        | "USER_KYC_LIGHT"
+        | "USER_INFLOWS_BLOCKED"
+        | "USER_INFLOWS_UNBLOCKED"
+        | "USER_OUTFLOWS_BLOCKED"
+        | "USER_OUTFLOWS_UNBLOCKED"
+        | "PREAUTHORIZATION_CREATED"
+        | "PREAUTHORIZATION_SUCCEEDED"
+        | "PREAUTHORIZATION_FAILED"
+        | "DEPOSIT_PREAUTHORIZATION_CREATED"
+        | "DEPOSIT_PREAUTHORIZATION_FAILED"
+        | "DEPOSIT_PREAUTHORIZATION_PAYMENT_WAITING"
+        | "DEPOSIT_PREAUTHORIZATION_PAYMENT_EXPIRED"
+        | "DEPOSIT_PREAUTHORIZATION_PAYMENT_CANCEL_REQUEST"
+        | "DEPOSIT_PREAUTHORIZATION_PAYMENT_CANCELED"
+        | "DEPOSIT_PREAUTHORIZATION_PAYMENT_VALIDATED"
+        | "CARD_VALIDATION_CREATED"
+        | "CARD_VALIDATION_SUCCEEDED"
+        | "CARD_VALIDATION_FAILED"
+        | "VIRTUAL_ACCOUNT_ACTIVE"
+        | "VIRTUAL_ACCOUNT_BLOCKED"
+        | "VIRTUAL_ACCOUNT_CLOSED"
+        | "VIRTUAL_ACCOUNT_FAILED"
+        | "PAYIN_NORMAL_PROCESSING_STATUS_PENDING_SUCCEEDED"
+        | "IDENTITY_VERIFICATION_VALIDATED"
+        | "IDENTITY_VERIFICATION_FAILED"
+        | "IDENTITY_VERIFICATION_INCONCLUSIVE"
+        | "IDENTITY_VERIFICATION_OUTDATED"
+        | "IDENTITY_VERIFICATION_TIMEOUT"
+        | "IDENTITY_VERIFICATION_PENDING"
+        | "RECIPIENT_ACTIVE"
+        | "RECIPIENT_CANCELED"
+        | "RECIPIENT_DEACTIVATED"
+        | "USER_ACCOUNT_VALIDATION_ASKED"
+        | "USER_ACCOUNT_ACTIVATED"
+        | "USER_ACCOUNT_CLOSED"
+        | "USER_CATEGORY_UPDATED_TO_OWNER"
+        | "USER_CATEGORY_UPDATED_TO_PAYER"
+        | "USER_CATEGORY_UPDATED_TO_PLATFORM"
+        | "INSTANT_CONVERSION_CREATED"
+        | "INSTANT_CONVERSION_SUCCEEDED"
+        | "INSTANT_CONVERSION_FAILED"
+        | "QUOTED_CONVERSION_CREATED"
+        | "QUOTED_CONVERSION_SUCCEEDED"
+        | "QUOTED_CONVERSION_FAILED"
+        | "SCA_ENROLLMENT_SUCCEEDED"
+        | "SCA_ENROLLMENT_FAILED"
+        | "SCA_ENROLLMENT_EXPIRED"
+        | "REPORT_GENERATED"
+        | "REPORT_FAILED"
+        | "INTENT_AUTHORIZED"
+        | "INTENT_CAPTURED"
+        | "INTENT_REFUNDED"
+        | "INTENT_REFUND_REVERSED"
+        | "INTENT_DISPUTE_CREATED"
+        | "INTENT_DISPUTE_DEFENDED"
+        | "INTENT_DISPUTE_WON"
+        | "INTENT_DISPUTE_LOST"
+        | "INTENT_SETTLED_NOT_PAID"
+        | "INTENT_PAID"
+        | "SPLIT_CREATED"
+        | "SPLIT_PENDING_FUNDS_RECEPTION"
+        | "SPLIT_AVAILABLE"
+        | "SPLIT_REJECTED"
+        | "SPLIT_REVERSED"
+
+    interface EventData {
+        /**
+         * The ID of whatever the event is
+         */
+        ResourceId: string;
+
+        /**
+         * When the event happened
+         */
+        Date: Timestamp;
+
+        /**
+         * The event type
+         */
+        EventType: EventType;
+    }
+}

package/typings/models/hook.d.ts

@@ -0,0 +1,39 @@
+import { event } from "./event";
+import { entityBase } from "./entityBase";
+import { PickPartialRequired } from "../types";
+
+export namespace hook {
+    type HookValidity = "UNKNOWN" | "VALID" | "INVALID";
+
+    type HookStatus = "DISABLED" | "ENABLED";
+
+    interface HookData extends entityBase.EntityBaseData {
+        /**
+         * This is the URL where your receive notification for each EventType
+         */
+        Url: string;
+
+        /**
+         * Whether the hook is enabled or not
+         */
+        Status: HookStatus;
+
+        /**
+         * Whether the hook is valid or not
+         */
+        Validity: HookValidity;
+
+        /**
+         * The event type
+         */
+        EventType: event.EventType;
+    }
+
+    interface CreateHook extends PickPartialRequired<HookData, "Tag", "EventType" | "Url"> {
+    }
+
+    interface UpdateHook extends PickPartialRequired<HookData,
+        "EventType" | "Url" | "Tag" | "Status",
+        "Id"> {
+    }
+}

package/typings/models/idempotency.d.ts

@@ -0,0 +1,36 @@
+import { entityBase } from "./entityBase";
+import { Timestamp } from "../types";
+
+export namespace idempotency {
+    interface IdempotencyData extends entityBase.EntityBaseData {
+        /**
+         * The status code of the API response
+         */
+        StatusCode: string;
+
+        /**
+         * The content length of the API response
+         */
+        ContentLength: string;
+
+        /**
+         * The content type of the API response
+         */
+        ContentType: string;
+
+        /**
+         * The long format date when the API request was received
+         */
+        Date: Timestamp;
+
+        /**
+         * An API resource
+         */
+        Resource: any;
+
+        /**
+         * The URL of the API request
+         */
+        RequestURL: string;
+    }
+}

package/typings/models/identityVerification.d.ts

@@ -0,0 +1,98 @@
+import {entityBase} from "./entityBase";
+
+export namespace identityVerification {
+
+    interface IdentityVerificationData extends entityBase.EntityBaseData {
+        /**
+         * The URL to redirect the user to for the hosted identity verification session.
+         */
+        HostedUrl: string;
+
+        /**
+         * The status of the identity verification session:
+         * <p>PENDING – The session is available on the HostedUrl, to which the user must be redirected to complete it.</p>
+         * <p>VALIDATED – The session was successful.</p>
+         * <p>REFUSED – The session was refused.</p>
+         * <p>REVIEW – The session is under manual review by Mangopay.</p>
+         * <p>OUT_OF_DATE – The session is no longer valid (likely due to expired documents used during the session).</p>
+         * <p>TIMEOUT – The session timed out due to inactivity.</p>
+         * <p>ERROR – The session was not completed because an error occurred.</p>
+         */
+        Status: string;
+
+        /**
+         * The URL to which the user is returned after the hosted identity verification session, regardless of the outcome.
+         */
+        ReturnUrl: string;
+
+        LastUpdate: number;
+
+        UserId: string;
+
+        /**
+         * The details of the individual verification checks performed during the session.
+         */
+        Checks: Check[];
+    }
+
+    interface CreateIdentityVerification {
+        /**
+         * The URL to which the user is returned after the hosted identity verification session, regardless of the outcome.
+         */
+        ReturnUrl: string;
+
+        /**
+         * Custom data that you can add to this object.
+         */
+        Tag?: string;
+    }
+
+    interface CheckData {
+        /**
+         * The type of the data point.
+         */
+        Type: string;
+
+        /**
+         * The value of the data point.
+         */
+        Value: string;
+    }
+
+    interface Check {
+        /**
+         * The unique identifier of the verification check.
+         */
+        CheckId: string;
+
+        /**
+         * Type of verification check performed:
+         * <p>BUSINESS_VERIFICATION - Verification of the business entity of a Legal User.</p>
+         * <p>IDENTITY_DOCUMENT_VERIFICATION - Verification of the identity document of a Natural User or the legal representative of a Legal User.</p>
+         * <p>PERSONS_SIGNIFICANT_CONTROL - Verification of a person of significant control of a Legal User.</p>
+         */
+        Type: string;
+
+        /**
+         * Returned values: VALIDATED, REFUSED, REVIEW
+         */
+        CheckStatus: string;
+
+        /**
+         * The date and time at which the check was created.
+         */
+        CreationDate: number;
+
+        /**
+         * The date and time at which the check was last updated.
+         */
+        LastUpdate: number;
+
+        /**
+         * The data points collected and verified during the check.
+         */
+        Data: CheckData[];
+
+        Reasons: CheckData[];
+    }
+}

package/typings/models/kycDocument.d.ts

@@ -0,0 +1,114 @@
+import { Timestamp } from "../types";
+import { entityBase } from "./entityBase";
+
+export namespace kycDocument {
+    type KycDocumentType =
+        | "IDENTITY_PROOF"
+        | "REGISTRATION_PROOF"
+        | "ARTICLES_OF_ASSOCIATION"
+        | "SHAREHOLDER_DECLARATION"
+        | "ADDRESS_PROOF";
+
+    type DocumentStatus =
+        | "CREATED"
+        | "VALIDATION_ASKED"
+        | "VALIDATED"
+        | "REFUSED"
+        | "OUT_OF_DATE";
+
+    type KYCDocumentRefusedReasonType =
+        | "DOCUMENT_UNREADABLE"
+        | "DOCUMENT_NOT_ACCEPTED"
+        | "DOCUMENT_HAS_EXPIRED"
+        | "DOCUMENT_INCOMPLETE"
+        | "DOCUMENT_MISSING"
+        | "DOCUMENT_DO_NOT_MATCH_USER_DATA"
+        | "DOCUMENT_DO_NOT_MATCH_ACCOUNT_DATA"
+        | "DOCUMENT_FALSIFIED"
+        | "UNDERAGE_PERSON"
+        | "SPECIFIC_CASE";
+
+    interface KycDocumentData extends entityBase.EntityBaseData {
+        /**
+         * Gives the type of the KYC document
+         */
+        Type: KycDocumentType;
+
+        /**
+         * The object owner's UserId
+         */
+        UserId: string;
+
+        /**
+         * The status of this KYC/Dispute document
+         */
+        Status: DocumentStatus;
+
+        /**
+         * The message accompanying a refusal
+         */
+        RefusedReasonMessage: string;
+
+        /**
+         * The type of reason for refusal
+         */
+        RefusedReasonType: KYCDocumentRefusedReasonType;
+
+        /**
+         * The date when the document was processed by MANGOPAY
+         */
+        ProcessedDate: Timestamp;
+
+        /**
+         * More information regarding why the document has been rejected
+         */
+        Flags: string[];
+    }
+
+    interface CreateKycDocument {
+        /**
+         * Gives the type of the KYC document
+         */
+        Type: KycDocumentType;
+
+        /**
+         * Custom data that you can add to this item
+         */
+        Tag?: string;
+    }
+
+    interface SubmitKycDocument {
+        /**
+         * The status of this KYC/Dispute document
+         */
+        Status: "VALIDATION_ASKED";
+
+        Id: string;
+
+        Tag?: string;
+    }
+
+    /**
+     * - Documents have to be in "CREATED" Status
+     * - You can create as many pages as needed
+     *
+     * Remember to change Status to "VALIDATION_ASKED" to submit KYC documents
+     * The maximum size per page is about 7Mb (or 10Mb when base64encoded). The following formats are accepted for the documents : .pdf, .jpeg, .jpg, .gif and .png. The minimum size is 1Kb.
+     */
+    interface CreateKycPage {
+        /**
+         * The base64 encoded file which needs to be uploaded
+         *
+         * You need to fill in only the binary code. Do not send the first part that some converters add into the binary code which is
+         * `<img src=" data:image/png;base64..." />`
+         *
+         * e.g.
+         * ```json
+         * {
+         *   "File": "/9j/4AAQSkZJRgABAQEBLAEsAAD/.../wgARCAAyADIDAREAAhEBAxEB/8QAGwAAAgMBAQEA"
+         * }
+         * ```
+         */
+        File: string;
+    }
+}

package/typings/models/mandate.d.ts

@@ -0,0 +1,93 @@
+import { PickPartialRequired, ValueOf } from "../types";
+import { enums } from "../enums";
+import { entityBase } from "./entityBase";
+
+export namespace mandate {
+    /**
+     * - "CREATED" - the mandate has been created
+     * - "SUBMITTED" - the mandate has been submitted to the banks and you can now do payments with this mandate
+     * - "ACTIVE" - the mandate is active and has been accepted by the banks and/or successfully used in a payment
+     * - "FAILED" - the mandate has failed for a variety of reasons and is no longer available for payments
+     */
+    type MandateStatus = ValueOf<enums.IMandateStatus>;
+
+    type MandateScheme = "SEPA" | "BACS";
+
+    type MandateCultureCode = "EN" | "FR" | "NL" | "DE" | "ES" | "IT" | "PL";
+
+    type MandateExecutionType = "WEB";
+
+    type MandateType = "DIRECT_DEBIT";
+
+    interface MandateData extends entityBase.EntityBaseData {
+        /**
+         * An ID of a Bank Account
+         */
+        BankAccountId: string;
+
+        /**
+         * The object owner's UserId
+         */
+        UserId: string;
+
+        /**
+         * The URL to redirect to after payment (whether successful or not)
+         */
+        ReturnURL: string;
+
+        /**
+         * The URL to redirect to user to for them to proceed with the payment
+         */
+        RedirectURL: string;
+
+        /**
+         * The URL to download the mandate
+         */
+        DocumentURL: string;
+
+        /**
+         * The language to use for the mandate confirmation page - needs to be the ISO code of the language
+         */
+        Culture: MandateCultureCode;
+
+        /**
+         * The type of mandate, but will only be completed once the mandate has been submitted
+         */
+        Scheme: MandateScheme;
+
+        /**
+         * The status of the mandate:
+         */
+        Status: MandateStatus;
+
+        /**
+         * The result code
+         */
+        ResultCode: string;
+
+        /**
+         * A verbal explanation of the ResultCode
+         */
+        ResultMessage: string;
+
+        /**
+         * The execution type for creating the mandate
+         */
+        ExecutionType: MandateExecutionType;
+
+        /**
+         * The type of Mandate
+         */
+        MandateType: MandateType;
+
+        /**
+         * The banking reference for this mandate
+         */
+        BankReference: string;
+    }
+
+    interface CreateMandate extends PickPartialRequired<MandateData,
+        "Tag",
+        "BankAccountId" | "Culture" | "ReturnURL"> {
+    }
+}

package/typings/models/money.d.ts

@@ -0,0 +1,45 @@
+import { CurrencyISO } from "../types";
+import { entityBase } from "./entityBase";
+
+export namespace money {
+    interface MoneyData {
+        /**
+         * The currency - should be ISO_4217 format
+         */
+        Currency: CurrencyISO;
+
+        /**
+         * An amount of money in the smallest sub-division of the currency, e.g. 12.60 EUR would be represented as 1260 whereas 12 JPY would be represented as just 12)
+         */
+        Amount: number;
+    }
+
+    interface MoneyDataOptionalAmount {
+        /**
+         * The currency - should be ISO_4217 format
+         */
+        Currency: CurrencyISO;
+
+        /**
+         * An amount of money in the smallest sub-division of the currency, e.g. 12.60 EUR would be represented as 1260 whereas 12 JPY would be represented as just 12)
+         */
+        Amount?: number;
+    }
+
+    interface EMoneyData extends entityBase.EntityBaseData {
+        /**
+         * The object owner's UserId
+         */
+        UserId: string;
+
+        /**
+         * The amount of money that has been credited to this user
+         */
+        CreditedEMoney: MoneyData;
+
+        /**
+         * The amount of money that has been debited from this user
+         */
+        DebitedEMoney: MoneyData;
+    }
+}