@payabli/sdk-node 0.0.129 → 0.0.131

package/dist/esm/api/resources/moneyOutTypes/types/VCardGetResponse.d.mts

@@ -1,58 +1,58 @@
 import type * as Payabli from "../../../index.mjs";
 export interface VCardGetResponse {
     /** Indicates if the virtual card was sent. */
-    vcardSent?: boolean;
+    vcardSent?: boolean | undefined;
     /** A unique token identifier for the card. */
-    cardToken?: string;
+    cardToken?: string | undefined;
     /** The masked number of the card. */
-    cardNumber?: string;
+    cardNumber?: string | undefined;
     /** Masked Card Verification Code. */
-    cvc?: string;
+    cvc?: string | undefined;
     /** The expiration date of the card. */
-    expirationDate?: string;
+    expirationDate?: string | undefined;
     /** The current status of the card. */
-    status?: string;
+    status?: string | undefined;
     /** The initial amount loaded on the card. */
-    amount?: number;
+    amount?: number | undefined;
     /** The current balance available on the card. */
-    currentBalance?: number;
+    currentBalance?: number | undefined;
     /** The set limit for expenses. */
-    expenseLimit?: number;
+    expenseLimit?: number | undefined;
     /** The period for the expense limit. */
-    expenseLimitPeriod?: string;
+    expenseLimitPeriod?: string | undefined;
     /** Maximum number of uses allowed for the card. */
-    maxNumberOfUses?: number;
+    maxNumberOfUses?: number | undefined;
     /** The current number of times the card has been used. */
-    currentNumberOfUses?: number;
+    currentNumberOfUses?: number | undefined;
     /** Indicates if only the exact amount is allowed for transactions. */
-    exactAmount?: boolean;
+    exactAmount?: boolean | undefined;
     /** Merchant Category Code, if applicable. */
-    mcc?: string;
+    mcc?: string | undefined;
     /** Transaction Category Code, if applicable. */
-    tcc?: string;
+    tcc?: string | undefined;
     /** A miscellaneous field for additional information. */
-    misc1?: string;
+    misc1?: string | undefined;
     /** Another miscellaneous field for extra information. */
-    misc2?: string;
+    misc2?: string | undefined;
     /** The creation date of the record. */
-    dateCreated?: string;
+    dateCreated?: string | undefined;
     /** The last modified date of the record. */
-    dateModified?: string;
+    dateModified?: string | undefined;
     /** Information about the associated vendor. */
-    associatedVendor?: VCardGetResponse.AssociatedVendor;
+    associatedVendor?: VCardGetResponse.AssociatedVendor | undefined;
     /** Information about the associated customer, if applicable. */
-    associatedCustomer?: string;
+    associatedCustomer?: string | undefined;
     /** Name of the parent organization. */
-    ParentOrgName?: string;
+    ParentOrgName?: string | undefined;
     /** The 'Doing Business As' name of the Paypoint. */
-    PaypointDbaname?: string;
+    PaypointDbaname?: string | undefined;
     /** The legal name of the Paypoint. */
-    PaypointLegalname?: string;
+    PaypointLegalname?: string | undefined;
     /** Entry name for the Paypoint, if applicable. */
-    PaypointEntryname?: string;
-    externalPaypointID?: Payabli.ExternalPaypointId;
+    PaypointEntryname?: string | undefined;
+    externalPaypointID?: Payabli.ExternalPaypointId | undefined;
     /** The unique identifier for the paypoint. */
-    paypointId?: number;
+    paypointId?: number | undefined;
 }
 export declare namespace VCardGetResponse {
     /**
@@ -60,84 +60,84 @@ export declare namespace VCardGetResponse {
      */
     interface AssociatedVendor {
         /** Unique code identifying the vendor. */
-        VendorNumber?: string;
+        VendorNumber?: string | undefined;
         /** The primary name associated with the vendor. */
-        Name1?: string;
+        Name1?: string | undefined;
         /** Additional name information for the vendor. */
-        Name2?: string;
+        Name2?: string | undefined;
         /** Employer Identification Number of the vendor. */
-        EIN?: string;
+        EIN?: string | undefined;
         /** Contact phone number of the vendor. */
-        Phone?: string;
+        Phone?: string | undefined;
         /** Contact email address of the vendor. */
-        Email?: string;
+        Email?: string | undefined;
         /** Email address for remittance. */
-        RemitEmail?: string;
+        RemitEmail?: string | undefined;
         /** Primary address line of the vendor. */
-        Address1?: string;
+        Address1?: string | undefined;
         /** Secondary address line of the vendor. */
-        Address2?: string;
+        Address2?: string | undefined;
         /** City where the vendor is located. */
-        City?: string;
+        City?: string | undefined;
         /** State where the vendor is located. */
-        State?: string;
+        State?: string | undefined;
         /** ZIP code for the vendor's location. */
-        Zip?: string;
+        Zip?: string | undefined;
         /** Country where the vendor is located. */
-        Country?: string;
+        Country?: string | undefined;
         /** Merchant Category Code for the vendor. */
-        Mcc?: string;
-        LocationCode?: Payabli.LocationCode;
+        Mcc?: string | undefined;
+        LocationCode?: Payabli.LocationCode | undefined;
         /** Array of objects describing the vendor's contacts. */
-        Contacts?: AssociatedVendor.Contacts.Item[];
+        Contacts?: AssociatedVendor.Contacts.Item[] | undefined;
         /** Billing data for the vendor. */
-        BillingData?: AssociatedVendor.BillingData;
+        BillingData?: AssociatedVendor.BillingData | undefined;
         /** Preferred payment method for vendor. */
-        PaymentMethod?: string;
+        PaymentMethod?: string | undefined;
         /** Status of the vendor. */
-        VendorStatus?: number;
+        VendorStatus?: number | undefined;
         /** Unique identifier for the vendor. */
-        VendorId?: number;
+        VendorId?: number | undefined;
         /** Enrollment status of the vendor. */
-        EnrollmentStatus?: string;
+        EnrollmentStatus?: string | undefined;
         /** Summary of vendor's billing and transaction status. */
-        Summary?: AssociatedVendor.Summary;
+        Summary?: AssociatedVendor.Summary | undefined;
         /** Legal name of the paypoint. */
-        PaypointLegalname?: Payabli.Legalname;
+        PaypointLegalname?: Payabli.Legalname | undefined;
         /** DBA name of the paypoint. */
-        PaypointDbaname?: Payabli.Dbaname;
+        PaypointDbaname?: Payabli.Dbaname | undefined;
         /** Entryname of the paypoint. */
-        PaypointEntryname?: string;
-        ParentOrgName?: Payabli.OrgParentName;
+        PaypointEntryname?: string | undefined;
+        ParentOrgName?: Payabli.OrgParentName | undefined;
         /** ID of the parent organization. */
-        ParentOrgId?: number;
+        ParentOrgId?: number | undefined;
         /** Date when the vendor record was created. */
-        CreatedDate?: string;
+        CreatedDate?: string | undefined;
         /** Date when the vendor's information was last updated. */
-        LastUpdated?: string;
-        remitAddress1?: Payabli.Remitaddress1;
-        remitAddress2?: Payabli.Remitaddress2;
-        remitCity?: Payabli.Remitcity;
-        remitState?: Payabli.Remitstate;
-        remitZip?: Payabli.Remitzip;
-        remitCountry?: Payabli.Remitcountry;
+        LastUpdated?: string | undefined;
+        remitAddress1?: Payabli.Remitaddress1 | undefined;
+        remitAddress2?: Payabli.Remitaddress2 | undefined;
+        remitCity?: Payabli.Remitcity | undefined;
+        remitState?: Payabli.Remitstate | undefined;
+        remitZip?: Payabli.Remitzip | undefined;
+        remitCountry?: Payabli.Remitcountry | undefined;
         /** Primary name of the payee. */
-        payeeName1?: string;
+        payeeName1?: string | undefined;
         /** Secondary name of the payee. */
-        payeeName2?: string;
+        payeeName2?: string | undefined;
         /** A custom field for additional data. */
-        customField1?: string;
+        customField1?: string | undefined;
         /** Another custom field for extra data. */
-        customField2?: string;
+        customField2?: string | undefined;
         /** Account number of paypoint in the vendor side. */
-        customerVendorAccount?: string;
+        customerVendorAccount?: string | undefined;
         /** Internal reference ID used within the system. */
-        InternalReferenceId?: number;
+        InternalReferenceId?: number | undefined;
         /** Field for additional data, if any. */
-        additionalData?: string;
-        externalPaypointID?: Payabli.ExternalPaypointId;
+        additionalData?: string | undefined;
+        externalPaypointID?: Payabli.ExternalPaypointId | undefined;
         /** Stored payment methods for the vendor. */
-        StoredMethods?: string;
+        StoredMethods?: string | undefined;
     }
     namespace AssociatedVendor {
         type Contacts = Contacts.Item[];
@@ -147,13 +147,13 @@ export declare namespace VCardGetResponse {
              */
             interface Item {
                 /** Name of the contact. */
-                ContactName?: string;
+                ContactName?: string | undefined;
                 /** Email of the contact. */
-                ContactEmail?: string;
+                ContactEmail?: string | undefined;
                 /** Title of the contact. */
-                ContactTitle?: string;
+                ContactTitle?: string | undefined;
                 /** Phone number of the contact. */
-                ContactPhone?: string;
+                ContactPhone?: string | undefined;
             }
         }
         /**
@@ -161,70 +161,70 @@ export declare namespace VCardGetResponse {
          */
         interface BillingData {
             /** Unique identifier for billing data. */
-            id?: number;
+            id?: number | undefined;
             /** Account identifier. */
-            accountId?: string;
+            accountId?: string | undefined;
             /** Nickname for the account. */
-            nickname?: string;
+            nickname?: string | undefined;
             /** Name of the bank used for transactions. */
-            bankName?: string;
+            bankName?: string | undefined;
             /** Routing number for the bank account. */
-            routingAccount?: string;
+            routingAccount?: string | undefined;
             /** Masked account number for transactions. */
-            accountNumber?: string;
+            accountNumber?: string | undefined;
             /** Type of the bank account. */
-            typeAccount?: string;
+            typeAccount?: string | undefined;
             /** Name of the bank account holder. */
-            bankAccountHolderName?: string;
+            bankAccountHolderName?: string | undefined;
             /** Type of bank account holder. */
-            bankAccountHolderType?: string;
+            bankAccountHolderType?: string | undefined;
             /** Function of the bank account. */
-            bankAccountFunction?: number;
+            bankAccountFunction?: number | undefined;
             /** Indicates if the account is verified. */
-            verified?: boolean;
+            verified?: boolean | undefined;
             /** Status of the billing data. */
-            status?: number;
+            status?: number | undefined;
             /** Services associated with the account. */
-            services?: unknown[];
+            services?: unknown[] | undefined;
             /** Indicates if this is the default billing account. */
-            default?: boolean;
+            default?: boolean | undefined;
         }
         /**
          * Summary of vendor's billing and transaction status.
          */
         interface Summary {
             /** Number of active bills. */
-            ActiveBills?: number;
+            ActiveBills?: number | undefined;
             /** Number of bills pending approval or payment. */
-            PendingBills?: number;
+            PendingBills?: number | undefined;
             /** Number of bills in transit. */
-            InTransitBills?: number;
+            InTransitBills?: number | undefined;
             /** Number of bills that have been paid. */
-            PaidBills?: number;
+            PaidBills?: number | undefined;
             /** Number of bills that are overdue. */
-            OverdueBills?: number;
+            OverdueBills?: number | undefined;
             /** Number of bills that have been approved. */
-            ApprovedBills?: number;
+            ApprovedBills?: number | undefined;
             /** Number of bills that have been disapproved. */
-            DisapprovedBills?: number;
+            DisapprovedBills?: number | undefined;
             /** Total number of bills. */
-            TotalBills?: number;
+            TotalBills?: number | undefined;
             /** Total amount of active bills. */
-            ActiveBillsAmount?: number;
+            ActiveBillsAmount?: number | undefined;
             /** Total amount of pending bills. */
-            PendingBillsAmount?: number;
+            PendingBillsAmount?: number | undefined;
             /** Total amount of bills in transit. */
-            InTransitBillsAmount?: number;
+            InTransitBillsAmount?: number | undefined;
             /** Total amount of paid bills. */
-            PaidBillsAmount?: number;
+            PaidBillsAmount?: number | undefined;
             /** Total amount of overdue bills. */
-            OverdueBillsAmount?: number;
+            OverdueBillsAmount?: number | undefined;
             /** Total amount of approved bills. */
-            ApprovedBillsAmount?: number;
+            ApprovedBillsAmount?: number | undefined;
             /** Total amount of rejected bills. */
-            DisapprovedBillsAmount?: number;
+            DisapprovedBillsAmount?: number | undefined;
             /** Total amount of all bills. */
-            TotalBillsAmount?: number;
+            TotalBillsAmount?: number | undefined;
         }
     }
 }

package/dist/esm/api/resources/moneyOutTypes/types/index.d.mts

@@ -1,3 +1,4 @@
+export * from "./AllowedCheckPaymentStatus.mjs";
 export * from "./AuthCapturePayoutResponse.mjs";
 export * from "./AuthorizePaymentMethod.mjs";
 export * from "./AuthorizePayoutBody.mjs";

package/dist/esm/api/resources/moneyOutTypes/types/index.mjs

@@ -1,3 +1,4 @@
+export * from "./AllowedCheckPaymentStatus.mjs";
 export * from "./AuthCapturePayoutResponse.mjs";
 export * from "./AuthorizePaymentMethod.mjs";
 export * from "./AuthorizePayoutBody.mjs";

package/dist/esm/api/resources/notificationlogs/client/Client.mjs

@@ -53,13 +53,10 @@ export class NotificationlogsClient {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c, _d, _e, _f, _g, _h, _j;
             const { PageSize: pageSize, Page: page, body: _body } = request;
-            const _queryParams = {};
-            if (pageSize != null) {
-                _queryParams.PageSize = pageSize.toString();
-            }
-            if (page != null) {
-                _queryParams.Page = page.toString();
-            }
+            const _queryParams = {
+                PageSize: pageSize,
+                Page: page,
+            };
             const _authRequest = yield this._options.authProvider.getAuthRequest();
             const _headers = mergeHeaders(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
             const _response = yield core.fetcher({

package/dist/esm/api/resources/notificationlogs/types/KeyValueArray.d.mts

@@ -1,4 +1,4 @@
 export interface KeyValueArray {
-    key?: string;
-    value?: string[];
+    key?: string | undefined;
+    value?: string[] | undefined;
 }

package/dist/esm/api/resources/notificationlogs/types/NotificationLogDetail.d.mts

@@ -1,6 +1,6 @@
 import type * as Payabli from "../../../index.mjs";
 export interface NotificationLogDetail extends Payabli.NotificationLog {
-    webHeaders?: Payabli.StringStringKeyValuePair[];
-    responseHeaders?: Payabli.KeyValueArray[];
-    responseContent?: string;
+    webHeaders?: Payabli.StringStringKeyValuePair[] | undefined;
+    responseHeaders?: Payabli.KeyValueArray[] | undefined;
+    responseContent?: string | undefined;
 }

package/dist/esm/api/resources/notificationlogs/types/NotificationLogSearchRequest.d.mts

@@ -4,11 +4,11 @@ export interface NotificationLogSearchRequest {
     /** The end date for the search. */
     endDate: string;
     /** The type of notification event to filter by. */
-    notificationEvent?: string;
+    notificationEvent?: string | undefined;
     /** Indicates whether the notification was successful. */
-    succeeded?: boolean;
+    succeeded?: boolean | undefined;
     /** The ID of the organization to filter by. */
-    orgId?: number;
+    orgId?: number | undefined;
     /** The ID of the paypoint to filter by. */
-    paypointId?: number;
+    paypointId?: number | undefined;
 }

package/dist/esm/api/resources/notificationlogs/types/StringStringKeyValuePair.d.mts

@@ -1,4 +1,4 @@
 export interface StringStringKeyValuePair {
-    key?: string;
-    value?: string;
+    key?: string | undefined;
+    value?: string | undefined;
 }

package/dist/esm/api/resources/ocr/types/FileContentImageOnly.d.mts

@@ -1,11 +1,11 @@
 export interface FileContentImageOnly {
-    ftype?: FileContentImageOnly.Ftype;
+    ftype?: FileContentImageOnly.Ftype | undefined;
     /** The name of the file to be uploaded */
-    filename?: string;
+    filename?: string | undefined;
     /** Optional URL link to the file */
-    furl?: string;
+    furl?: string | undefined;
     /** Base64-encoded file content */
-    fContent?: string;
+    fContent?: string | undefined;
 }
 export declare namespace FileContentImageOnly {
     /** The MIME type of the file (if content is provided) */

package/dist/esm/api/resources/ocr/types/OcrAttachment.d.mts

@@ -1,7 +1,7 @@
 export interface OcrAttachment {
-    ftype?: string;
-    filename?: string;
-    fileDescriptor?: string;
-    furl?: string;
-    fContent?: string;
+    ftype?: string | undefined;
+    filename?: string | undefined;
+    fileDescriptor?: string | undefined;
+    furl?: string | undefined;
+    fContent?: string | undefined;
 }

package/dist/esm/api/resources/ocr/types/OcrBillItem.d.mts

@@ -1,14 +1,14 @@
 export interface OcrBillItem {
-    itemTotalAmount?: number;
-    itemTaxAmount?: number;
-    itemTaxRate?: number;
-    itemProductCode?: string;
-    itemProductName?: string;
-    itemDescription?: string;
-    itemCommodityCode?: string;
-    itemUnitOfMeasure?: string;
-    itemCost?: number;
-    itemQty?: number;
-    itemMode?: number;
-    itemCategories?: string[];
+    itemTotalAmount?: number | undefined;
+    itemTaxAmount?: number | undefined;
+    itemTaxRate?: number | undefined;
+    itemProductCode?: string | undefined;
+    itemProductName?: string | undefined;
+    itemDescription?: string | undefined;
+    itemCommodityCode?: string | undefined;
+    itemUnitOfMeasure?: string | undefined;
+    itemCost?: number | undefined;
+    itemQty?: number | undefined;
+    itemMode?: number | undefined;
+    itemCategories?: string[] | undefined;
 }

package/dist/esm/api/resources/ocr/types/OcrBillItemAdditionalData.d.mts

@@ -1,6 +1,6 @@
 export interface OcrBillItemAdditionalData {
-    category?: string;
-    currency_code?: string;
-    type?: string;
-    reference_number?: string;
+    category?: string | undefined;
+    currency_code?: string | undefined;
+    type?: string | undefined;
+    reference_number?: string | undefined;
 }

package/dist/esm/api/resources/ocr/types/OcrResponseData.d.mts

@@ -1,4 +1,4 @@
 import type * as Payabli from "../../../index.mjs";
 export interface OcrResponseData {
-    resultData?: Payabli.OcrResultData;
+    resultData?: Payabli.OcrResultData | undefined;
 }

package/dist/esm/api/resources/ocr/types/OcrResultData.d.mts

@@ -1,20 +1,20 @@
 import type * as Payabli from "../../../index.mjs";
 export interface OcrResultData {
-    billNumber?: string;
-    netAmount?: number;
-    billDate?: string;
-    dueDate?: string;
-    comments?: string;
-    billItems?: Payabli.OcrBillItem[];
-    mode?: number;
-    accountingField1?: string;
-    accountingField2?: string;
-    additionalData?: Payabli.OcrBillItemAdditionalData;
-    vendor?: Payabli.OcrVendor;
-    endDate?: string;
-    frequency?: string;
-    terms?: string;
-    status?: number;
-    lotNumber?: string;
-    attachments?: Payabli.OcrAttachment[];
+    billNumber?: string | undefined;
+    netAmount?: number | undefined;
+    billDate?: string | undefined;
+    dueDate?: string | undefined;
+    comments?: string | undefined;
+    billItems?: Payabli.OcrBillItem[] | undefined;
+    mode?: number | undefined;
+    accountingField1?: string | undefined;
+    accountingField2?: string | undefined;
+    additionalData?: Payabli.OcrBillItemAdditionalData | undefined;
+    vendor?: Payabli.OcrVendor | undefined;
+    endDate?: string | undefined;
+    frequency?: string | undefined;
+    terms?: string | undefined;
+    status?: number | undefined;
+    lotNumber?: string | undefined;
+    attachments?: Payabli.OcrAttachment[] | undefined;
 }

package/dist/esm/api/resources/ocr/types/OcrVendor.d.mts

@@ -1,34 +1,34 @@
 import type * as Payabli from "../../../index.mjs";
 export interface OcrVendor {
-    vendorNumber?: string;
-    name1?: string;
-    name2?: string;
-    ein?: string;
-    phone?: string;
-    email?: string;
-    address1?: string;
-    address2?: string;
-    city?: string;
-    state?: string;
-    zip?: string;
-    country?: string;
-    mcc?: string;
-    locationCode?: string;
-    contacts?: Payabli.Contacts[];
-    billingData?: Payabli.OcrVendorBillingData;
-    paymentMethod?: string;
-    vendorStatus?: number;
-    remitAddress1?: string;
-    remitAddress2?: string;
-    remitCity?: string;
-    remitState?: string;
-    remitZip?: string;
-    remitCountry?: string;
-    payeeName1?: string;
-    payeeName2?: string;
-    customerVendorAccount?: string;
-    internalReferenceId?: number;
-    customField1?: string;
-    customField2?: string;
-    additionalData?: Payabli.OcrVendorAdditionalData;
+    vendorNumber?: string | undefined;
+    name1?: string | undefined;
+    name2?: string | undefined;
+    ein?: string | undefined;
+    phone?: string | undefined;
+    email?: string | undefined;
+    address1?: string | undefined;
+    address2?: string | undefined;
+    city?: string | undefined;
+    state?: string | undefined;
+    zip?: string | undefined;
+    country?: string | undefined;
+    mcc?: string | undefined;
+    locationCode?: string | undefined;
+    contacts?: Payabli.Contacts[] | undefined;
+    billingData?: Payabli.OcrVendorBillingData | undefined;
+    paymentMethod?: string | undefined;
+    vendorStatus?: number | undefined;
+    remitAddress1?: string | undefined;
+    remitAddress2?: string | undefined;
+    remitCity?: string | undefined;
+    remitState?: string | undefined;
+    remitZip?: string | undefined;
+    remitCountry?: string | undefined;
+    payeeName1?: string | undefined;
+    payeeName2?: string | undefined;
+    customerVendorAccount?: string | undefined;
+    internalReferenceId?: number | undefined;
+    customField1?: string | undefined;
+    customField2?: string | undefined;
+    additionalData?: Payabli.OcrVendorAdditionalData | undefined;
 }

package/dist/esm/api/resources/ocr/types/OcrVendorAdditionalData.d.mts

@@ -1,3 +1,3 @@
 export interface OcrVendorAdditionalData {
-    web?: string;
+    web?: string | undefined;
 }

package/dist/esm/api/resources/ocr/types/OcrVendorBillingData.d.mts

@@ -1,10 +1,10 @@
 export interface OcrVendorBillingData {
-    id?: number;
-    bankName?: string;
-    routingAccount?: string;
-    accountNumber?: string;
-    typeAccount?: string;
-    bankAccountHolderName?: string;
-    bankAccountHolderType?: string;
-    bankAccountFunction?: number;
+    id?: number | undefined;
+    bankName?: string | undefined;
+    routingAccount?: string | undefined;
+    accountNumber?: string | undefined;
+    typeAccount?: string | undefined;
+    bankAccountHolderName?: string | undefined;
+    bankAccountHolderType?: string | undefined;
+    bankAccountFunction?: number | undefined;
 }

package/dist/esm/api/resources/ocr/types/PayabliApiResponseOcr.d.mts

@@ -4,5 +4,5 @@ export interface PayabliApiResponseOcr {
     responseText: Payabli.ResponseText;
     responseCode: Payabli.Responsecode;
     /** Details of the OCR processing result */
-    responseData?: Payabli.OcrResponseData;
+    responseData?: Payabli.OcrResponseData | undefined;
 }

package/dist/esm/api/resources/organization/client/Client.d.mts

@@ -118,7 +118,7 @@ export declare class OrganizationClient {
     /**
      * Gets an organization's basic information by entry name (entrypoint identifier).
      *
-     * @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/api-reference/api-overview#entrypoint-vs-entry)
+     * @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
      * @param {OrganizationClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Payabli.BadRequestError}