# Search merchant data

Searches merchant data to return resources such as customers, invoices, orders, transactions.

Endpoint: GET /search
Version: latest
Security: SecretApiKey, JWT

## Query parameters:

  - `sort` (array)
    Sorts and orders the collection of items. To sort in descending
order, prefix with . Multiple fields can be sorted by separating each with .

  - `limit` (integer)
    Limits the number of collection items to be returned.

  - `offset` (integer)
    Specifies the starting point within the collection of items to be returned.

  - `q` (string)
    Default search. Searches across resources and fields.

## Response 200 fields (application/json):

  - `customers` (array)
    List of returned customers.

  - `customers.id` (string)
    ID of the customer.
    Example: "cus_0YV7DDSDD1C8DA64KHH2W33CPF"

  - `customers.email` (string,null)
    Customer's email address.

  - `customers.firstName` (string,null)
    Customer's first name.

  - `customers.lastName` (string,null)
    Customer's last name.

  - `customers.websiteId` (string)
    ID of the website.
A website is where an organization obtains a customer.
For more information, see [Obtain an organization ID and website ID](https://www.rebilly.com/docs/settings/organizations-and-websites/#obtain-your-organization-id-and-website-id).
    Example: "web_0YV7DE4Z26DQSA1AC92FBJ7SEG"

  - `customers.defaultPaymentInstrument` (any)

  - `customers.createdTime` (string)
    Date and time which is set automatically when the resource is created.

  - `customers.updatedTime` (string)
    Date and time which updates automatically when the resource is updated.

  - `customers.customFields` (object)
    Use custom fields to extend a resource scheme to include custom data that is not provided as a common field.
For more information, see [Custom fields](https://www.rebilly.com/catalog/all/custom-fields).

  - `customers.primaryAddress` (any)
    Customer's primary address.

  - `customers.company` (object,null)
    Company information that is associated with the customer's primary email address domain.

This is a paid feature, to enable it [contact Rebilly](https://www.rebilly.com/support/).

  - `customers.company.name` (string,null)
    Name of the company.

  - `customers.company.domain` (string)
    Website domain of the company.

  - `customers.company.yearFounded` (number,null)
    Founding year of the company.

  - `customers.company.industry` (string,null)
    Industry the company is associated with.

  - `customers.company.employeesCount` (number,null)
    Number of employees in the company.

  - `customers.company.country` (string,null)
    Country where the company is based.

  - `customers.company.locality` (string,null)
    Locality or region where the company is based.

  - `customers.company._links` (array)

  - `customers.company._links.href` (string)
    Link URL.

  - `customers.company._links.rel` (string)
    Type of link.
    Enum: "linkedin"

  - `customers.averageValue` (object)
    Average customer value.

  - `customers.averageValue.currency` (string)
    Merchant's reporting currency.

  - `customers.averageValue.amount` (number)
    Average approved payment amount in merchant's reporting currency.

  - `customers.averageValue.amountUsd` (number)
    Average approved payment amount in USD.

  - `customers.paymentCount` (integer)
    Total number of approved payments made by the customer.
Payments are the result of  or  transactions.

  - `customers.lastPaymentTime` (string,null)
    Date and time of the customer's last approved payment.
Payments are the result of  or  transactions.

  - `customers.lifetimeRevenue` (object)
    Customer's lifetime revenue.

  - `customers.lifetimeRevenue.amount` (number)
    Revenue amount in the merchant's reporting currency.

  - `customers.lifetimeRevenue.amountUsd` (number)
    Revenue amount in USD.

  - `customers.invoiceCount` (integer)
    Total number of invoices issued to the customer.
This value is auto-incrementing.
If this value is , the record relates to a lead.
A lead is a customer who has not made a payment yet.
If this value is greater than or equal to  the record relates to a customer.

  - `customers.tags` (array)
    List of customer tags.

  - `customers.tags.id` (string)
    ID of the tag.

  - `customers.tags.name` (string, required)
    Unique name for the tag.
Tag names are not case-sensitive.
    Example: "New"

  - `customers.tags.type` (string, required)
    Type of tag.
Tags of a specific type can only be assigned to corresponding entity types.
For example, you can only use customer tags on customers.
    Enum: "customer", "kyc-document", "aml-check"

  - `customers.tags._links` (array)
    Related links.

  - `customers.revision` (integer)
    Number of times the customer's data has been modified.

Use this value when analyzing webhook data to determine if a change must take precedence over the current representation.

  - `customers.isEddRequired` (boolean)
    Specifies if Enhanced Due Diligence (EDD) is enabled for this customer.
For more information, see [Enhanced Due Diligence](https://www.rebilly.com/docs/kyc-and-aml/edd/).

  - `customers.hasFulfilledKyc` (boolean)
    Specifies if the customer has accepted and reviewed identity and address documents, or an accepted credit file document.

  - `customers.organizationId` (string)
    Unique organization identifier.
An organization is an entity that represents a company.
For more information, see [Obtain an organization ID](https://www.rebilly.com/docs/settings/organizations-and-websites/#obtain-your-organization-id-and-website-id).
    Example: "org_0YVDM8RC7GDADADSBSMW124JA8"

  - `customers.locale` (string,null)
    Language locale identifier in [RFC 5646](https://tools.ietf.org/html/rfc5646) format.
    Example: "fr-FR"

  - `customers.taxNumbers` (array,null)
    Tax numbers of the customer.

  - `customers.taxNumbers.type` (string, required)
    Type of the tax number.
    Enum: "eu-vat", "other"

  - `customers.taxNumbers.value` (string, required)
    Value of the tax number.
    Example: "GB980780684"

  - `customers.taxNumbers.isDefault` (boolean)
    Determines if the tax number is selected as default to display on invoices.
    Example: true

  - `customers.taxNumbers.isValid` (boolean,null)
    Determines if the tax number passed the EU official [VIES validation](https://ec.europa.eu/taxation_customs/vies/#/vat-validation).
    Example: true

  - `customers._embedded` (object)
    Embedded objects that are requested using the  query string parameter.

  - `customers._embedded.website` (object)

  - `customers._embedded.leadSource` (object)

  - `invoices` (array)
    List of returned invoices.

  - `invoices.id` (string)
    ID of the invoice.
    Example: "in_0YVF9605RKC62BP14NE2R7V2XT"

  - `invoices.invoiceNumber` (integer)
    Auto-incrementing number based on the sequence of invoices for any particular customer.

  - `invoices.orderId` (string,null)
    ID of the order (experimental).
    Example: "ord_01HVKA5975PJBSQ1SX72G3MSZC"

  - `invoices.subscriptionId` (string)
    ID of the related subscription order, if available.
This field is  if there are no related subscription orders.
    Example: "sub_01HRF27SATGE4Z6PBJE6PD8328"

  - `invoices.quoteId` (string,null)
    ID of the related quote, if available.
This field is  if there are no related quotes.
    Example: "qt_01HXBZMEGPETPHJZH6V4RHBMA8"

  - `invoices.currency` (string, required)
    Currency code in ISO 4217 format.

  - `invoices.amount` (number)
    Amount of the invoice.

  - `invoices.amountDue` (number)
    Amount that is due on the invoice.

  - `invoices.subtotalAmount` (number)
    Subtotal amount of the invoice.

  - `invoices.discountAmount` (number)
    Discount amount that is applied to the invoice.

  - `invoices.shipping` (any)

  - `invoices.tax` (object)
    Taxes.

  - `invoices.organizationTaxIdNumber` (object,null)
    Organization tax ID number that is displayed on the invoice.

  - `invoices.organizationTaxIdNumber.type` (string, required)
    Type of the tax ID number.
    Enum: "eu-vat", "other"

  - `invoices.organizationTaxIdNumber.value` (string, required)
    Value of the tax ID number.
    Example: "GB980780684"

  - `invoices.customerTaxIdNumber` (object,null)
    Customer tax ID number that is displayed on the invoice.

  - `invoices.billingAddress` (object)
    Billing address of the invoice.

  - `invoices.billingAddress.firstName` (string,null)
    Contact's first name.
    Example: "Benjamin"

  - `invoices.billingAddress.lastName` (string,null)
    Contact's last name.
    Example: "Franklin"

  - `invoices.billingAddress.organization` (string,null)
    Contact's organization.
    Example: "Rebilly"

  - `invoices.billingAddress.address` (string,null)
    First line of the contact's street address.
    Example: "36 Craven St"

  - `invoices.billingAddress.address2` (string,null)
    Second line of the contact's street address.

  - `invoices.billingAddress.city` (string,null)
    Contact's city of residence.
    Example: "Austin"

  - `invoices.billingAddress.region` (string,null)
    Contact's region of residence.
    Example: "Texas"

  - `invoices.billingAddress.country` (string,null)
    Contact's country of residence in ISO 3166 alpha-2 country code.
For examples, see [ISO.org](https://www.iso.org/obp/ui/#search/code/).
    Example: "GB"

  - `invoices.billingAddress.postalCode` (string,null)
    Contact's postal code.
    Example: "WC2N 5NF"

  - `invoices.billingAddress.phoneNumbers` (array)
    List of phone numbers associated with the contact.

  - `invoices.billingAddress.phoneNumbers.label` (string, required)
    Phone number label or name.
    Example: "main"

  - `invoices.billingAddress.phoneNumbers.value` (string, required)
    Phone number value.
    Example: "1-512-777-0269"

  - `invoices.billingAddress.phoneNumbers.primary` (boolean)
    Specifies if the phone number is the contact's primary phone number.
    Example: true

  - `invoices.billingAddress.emails` (array)
    List of email addresses associated with the contact.

  - `invoices.billingAddress.emails.label` (string, required)
    Email label or name.
    Example: "main"

  - `invoices.billingAddress.emails.value` (string, required)
    Email address value.
    Example: "rebilly@example.com"

  - `invoices.billingAddress.emails.primary` (boolean)
    Specifies if the email address is the contact's primary email address.
    Example: true

  - `invoices.billingAddress.dob` (string,null)
    Contact's date of birth in ISO-8601  format.
    Example: "1980-04-01"

  - `invoices.billingAddress.jobTitle` (string,null)
    Contact's job title.
    Example: "CEO"

  - `invoices.billingAddress.hash` (string)
    Use this value to compare contacts for identical attribute values.
    Example: "056ae6d97c788b9e98b049ebafd7b229bf852221"

  - `invoices.deliveryAddress` (object)
    Delivery address of the invoice.

  - `invoices.poNumber` (string,null)
    Purchase order number that is displayed on the invoice.
    Example: "PO123456"

  - `invoices.notes` (string)
    Notes for the customer that are displayed on the invoice.

  - `invoices.items` (array)
    Invoice items array.

  - `invoices.items.id` (string)
    ID of the invoice item.
    Example: "ii_0YVFDEQS2KCFTBN9HXWJFY55GV"

  - `invoices.items.type` (string, required)
    Type of invoice item.
    Enum: "debit", "credit"

  - `invoices.items.description` (string)
    Description of the invoice item.

  - `invoices.items.unitPrice` (number, required)
    Unit price of the invoice item.

  - `invoices.items.quantity` (integer)
    Quantity of the invoice item.

  - `invoices.items.price` (number)
    Total price of the invoice item.

  - `invoices.items.productId` (string,null)
    ID of the product.
    Example: "prod_0YV7DES3WPC5J8JD8QTVNZBZNZ"

  - `invoices.items.planId` (string,null)
    ID of the plan.
    Example: "plan_0YV7DENSVGDBW9S71XZNNYYQ0X"

  - `invoices.items.subscriptionId` (string,null)
    ID of the order.
    Example: "sub_01HRF27SATGE4Z6PBJE6PD8328"

  - `invoices.items.discountAmount` (number)
    Discount amount applied to the invoice item.

  - `invoices.items.periodStartTime` (string,null)
    Date and time when the billing period starts.

  - `invoices.items.periodEndTime` (string,null)
    Date and time when the billing period ends.

  - `invoices.items.periodNumber` (integer,null)
    Billing period number that is associated with the invoice item.
For example, an invoice item for a service is included in billing period number 3.
The invoice item is only applied to billing period number 3.

  - `invoices.items.tax` (any)
    Invoice item tax.

  - `invoices.items._embedded` (object)
    Embedded objects that are requested by the  query parameter.

  - `invoices.items._embedded.product` (object)

  - `invoices.items._embedded.plan` (object)

  - `invoices.discounts` (array)
    Discounts applied.

  - `invoices.discounts.couponId` (string)
    ID of the coupon.
    Example: "cpn_0YVCNKF81GD778N4YNVGDJK558"

  - `invoices.discounts.redemptionId` (string)
    ID of the redemption.

  - `invoices.discounts.amount` (number)
    Total amount discounted by this coupon.

  - `invoices.discounts.description` (string)
    Description of the discount.

  - `invoices.discounts.context` (string)
    Context in which the discount applies.
    Enum: "items", "shipping", "items-and-shipping"

  - `invoices.autopayScheduledTime` (string,null)
    Date and time when an automatic payment (autopay) is scheduled.

  - `invoices.autopayRetryNumber` (integer)
    Number of times that an automatic payment (autopay) has been attempted on an invoice.

  - `invoices.status` (string)
    Status of the invoice.
    Enum: "draft", "quotation", "unpaid", "paid", "partially-paid", "past-due", "abandoned", "voided", "partially-refunded", "refunded", "disputed"

  - `invoices.delinquentCollectionPeriod` (integer)
    Length of time, in days, between when the invoice is due and when the invoice is paid.

  - `invoices.collectionPeriod` (integer)
    Length of time, in days, between when the invoice is issued and when the invoice is paid.

  - `invoices.abandonedTime` (string,null)
    Date and time when the invoice is abandoned.

  - `invoices.voidedTime` (string,null)
    Date and time when the invoice is voided.

  - `invoices.paidTime` (string,null)
    Date and time when the invoice is paid.

  - `invoices.dueTime` (string)
    Date and time when the invoice is due for payment.

  - `invoices.issuedTime` (string)
    Date and time when the invoice is issued.

  - `invoices.paymentFormUrl` (string,null)
    URL where the customer is redirected to pay the invoice
using one of the methods which are available to the customer.
This is an alternative to creating a new transaction with empty
.

  - `invoices.creditMemoAllocations` (array)
    Credit memo allocations to an invoice.

  - `invoices.creditMemoAllocations.invoiceId` (string)
    ID of invoice to which the credit memo is allocated.
    Example: "in_0YVF9605RKC62BP14NE2R7V2XT"

  - `invoices.creditMemoAllocations.amount` (number)
    Amount of credit that is allocated from the credit memo to the invoice.
If the  value is not supplied or exceeds the unused amount of the credit memo or the invoice due amount, the lesser of the following two values is used:
- The unused amount of the credit memo.
- The invoice due amount.

  - `invoices.creditMemoAllocations.createdTime` (string)
    Date and time at which a credit memo is allocated.

  - `invoices.customerId` (string, required)
    ID of the customer resource.
    Example: "cus_0YV7DDSDD1C8DA64KHH2W33CPF"

  - `invoices.transactions` (array)
    Invoice transactions array.

  - `invoices.transactions.id` (string)
    ID of the transaction.

  - `invoices.transactions.type` (string)
    Type of transaction.
    Enum: "3ds-authentication", "authorize", "capture", "credit", "refund", "sale", "setup", "void"

  - `invoices.transactions.status` (string)
    Status of the transaction.
    Enum: "completed", "conn-error", "disputed", "never-sent", "offsite", "partially-refunded", "pending", "refunded", "sending", "timeout", "voided", "waiting-approval", "waiting-capture", "waiting-gateway", "waiting-refund"

  - `invoices.transactions.result` (string)
    Result of the transaction.
    Enum: "abandoned", "approved", "canceled", "declined", "unknown"

  - `invoices.transactions.amount` (number)
    Total amount of the transaction.

  - `invoices.transactions.purchaseAmount` (number)
    Amount by which the purchase is completed.
If an adjustment occurs, the purchased amount may differ from the requested amount.

  - `invoices.transactions.purchaseCurrency` (string)
    Currency code in ISO 4217 format.

  - `invoices.transactions.requestAmount` (number)
    Amount of the payment request.
If an adjustment occurs,
the purchase amount may differ from the billing amount.

  - `invoices.transactions.requestCurrency` (string)
    Currency code in ISO 4217 format.

  - `invoices.transactions.parentTransactionId` (string)
    ID of the parent transaction.
    Example: "txn_0YVDTQJ8YWDGQACV2N2N5SPWQ0"

  - `invoices.transactions.childTransactions` (array)
    IDs of child transactions.
    Example: ["4f6cf35x-2c4y-483z-a0a9-158621f77a21"]

  - `invoices.transactions.invoiceIds` (array)
    Related invoice IDs.
    Example: ["4f6cf35x-2c4y-483z-a0a9-158621f77a21"]

  - `invoices.transactions.subscriptionIds` (array)
    Subscription IDs of invoices that are related to the transaction.
    Example: ["4f6cf35x-2c4y-483z-a0a9-158621f77a21"]

  - `invoices.transactions.planIds` (array)
    Plan IDs of orders that are related to the transaction.
    Example: ["4f6cf35x-2c4y-483z-a0a9-158621f77a21"]

  - `invoices.transactions.isRebill` (boolean)
    Specifies if the transaction is one of a number of recurring payments in a subscription, excluding trials or setup fees.

  - `invoices.transactions.rebillNumber` (integer)
    Rebill number of the transaction.
A rebill number is the number of recurring payments in a subscription, excluding trials or setup fees.

  - `invoices.transactions.billingAddress` (object)
    Billing address.

  - `invoices.transactions.has3ds` (boolean)
    Specifies if the transaction uses 3D Secure.

  - `invoices.transactions.3ds` (object)
    Authentication object.
For more information, see [3D Secure (3DS)](https://www.rebilly.com/docs/docs/settings/3ds/).

  - `invoices.transactions.3ds.server` (string)
    Name of the 3D Secure server.

  - `invoices.transactions.3ds.version` (string)
    Version of 3D Secure.
    Enum: "1.0.2", "2.1.0", "2.2.0"

  - `invoices.transactions.3ds.enrolled` (string)
    Specifies if the cardholder is enrolled in 3D Secure.
    Enum: "yes", "no", "invalid card/timeout", "unavailable"

  - `invoices.transactions.3ds.authenticated` (string)
    Authentication response status for 3D Secure.
    Enum: "yes", "no", "not applicable", "attempted"

  - `invoices.transactions.3ds.liability` (string)
    Enum: "protected", "not protected", "protected (attempt)"

  - `invoices.transactions.3ds.flow` (string)
    Authentication flow for 3D Secure 2.
    Enum: "frictionless", "challenge"

  - `invoices.transactions.3ds.isDowngraded` (boolean)
    Specifies if 3D Secure 2 is attempted and downgraded to 3D Secure 1.

  - `invoices.transactions.redirectUrl` (string,null)
    URL where the end-user is redirected to when an offsite transaction is completed.
The default value is the website URL.

  - `invoices.transactions.retryNumber` (integer)
    Position of the transaction in the sequence of retries.

  - `invoices.transactions.isRetry` (boolean)
    Specifies if a transaction is a retry.

  - `invoices.transactions.billingDescriptor` (string,null)
    Billing descriptor that appears on the periodic billing statement.
For a credit card statement, this field commonly contains 12 or fewer characters.

  - `invoices.transactions.description` (string)
    Description of the payment.

  - `invoices.transactions.requestId` (string)
    Request ID of the transaction. This ID must be unique within a 24 hour period.
Use this field to prevent duplicated transactions.

  - `invoices.transactions.hasAmountAdjustment` (boolean)
    Specifies if the transaction has amount adjustment.

  - `invoices.transactions.gatewayName` (string,null)
    Name of the payment gateway that processed, or is selected to process, the transaction.
This value is only available after a gateway is selected for the transaction.
    Enum: "A1Gateway", "ACI", "Adyen", "Aircash", "Airpay", "Airwallex", "AmazonPay", "AmexVPC", "ApcoPay", "AsiaPaymentGateway", "AstroPayCard", "AuthorizeNet", "Awepay", "Bambora", "BankSEND", "BitPay", "BlueSnap", "BraintreePayments", "Buckaroo", "BVNK", "Cardknox", "Cashflows", "CASHlib", "Cashterminal", "CashToCode", "CauriPayment", "Cayan", "CCAvenue", "Chase", "CheckoutCom", "Chillstock", "Circle", "Citadel", "Clearhaus", "Cleo", "CODVoucher", "Coinbase", "CoinGate", "CoinPayments", "Conekta", "Coppr", "Credorax", "Cryptonator", "CyberSource", "DataCash", "Dengi", "Dimoco", "Directa24", "dLocal", "Dragonphoenix", "Dropayment", "EasyPayDirect", "EBANX", "ecoPayz", "EcorePay", "Elavon", "Euteller", "eMerchantPay", "EMS", "ePay", "EPG", "EPro", "Ezeebill", "eZeeWallet", "ezyEFT", "FasterPay", "Finrax", "Flexepin", "FinTecSystems", "FundSend", "Forte", "gate2way", "GET", "Gigadat", "GlobalOnePay", "GoCardless", "Gooney", "Gpaysafe", "Greenbox", "HiPay", "iCashOne", "iCanPay", "ICEPAY", "iCheque", "iDebit", "Ilixium", "Ingenico", "INOVAPAY", "Inovio", "Intuit", "InstaDebit", "IpayOptions", "JetPay", "Jeton", "JPMOrbital", "Khelocard", "Klarna", "Konnektive", "Kushki", "LaCore", "Limepay", "Loonio", "loonie", "LPG", "MaxiCash", "MercadoPago", "MiFinity", "MobilePay", "Moneris", "Monolo", "MonRem", "MtaPay", "MuchBetter", "MuchBetterGateway", "MyFatoorah", "Neosurf", "Netbanking", "Neteller", "NGenius", "NinjaWallet", "NMI", "NordikCoin", "NOWPayments", "NuaPay", "OchaPay", "OmniMatrix", "Onlineueberweisen", "OnRamp", "Orbital", "Pagadito", "Pagsmile", "Panamerican", "ParamountCommerce", "ParamountEft", "ParamountInterac", "PandaGateway", "Pay4Fun", "PayCash", "Paycly", "PayClub", "PayCom", "PayEcards", "Payeezy", "Payflow", "Paynote", "PaymentAsia", "PaymenTechnologies", "PaymentsOS", "Paymero", "PayPal", "Payper", "Payr", "PayRedeem", "PayRetailers", "Paysafe", "Paysafecard", "Paysafecash", "PayTabs", "PayU", "PayULatam", "Payvision", "PharosPayments", "Piastrix", "Pin4Pay", "Plugnpay", "PostFinance", "PPRO", "Prosa", "PSiGate", "Rapyd", "Realex", "Realtime", "Redsys", "Rotessa", "RPN", "Safecharge", "SaltarPay", "Sagepay", "SeamlessChex", "SecureTrading", "SecurionPay", "Skrill", "SmartInvoice", "SMSVoucher", "Sofort", "SparkPay", "StaticGateway", "STPMexico", "Stripe", "Tabby", "Telr", "TestProcessor", "ToditoCash", "Triple000", "Truevo", "TrustsPay", "Trustly", "TWINT", "Unlimit", "UPayCard", "USAePay", "VantivLitle", "vegaaH", "VCreditos", "VegaWallet", "Wallet88", "Walpay", "WesternUnion", "Wirecard", "WorldlineAtosFrankfurt", "Worldpay", "XPay", "Zimpler", "Zotapay"

  - `invoices.transactions.processedTime` (string)
    Date and time when the transaction is processed.

  - `invoices.transactions.gatewayAccountId` (string,null)
    ID of the gateway account that processed the transaction.
    Example: "gw_acc_0YVCXMF26DDNKAERE5NW727S34"

  - `invoices.transactions.gatewayTransactionId` (string,null)
    ID of the gateway transaction.
    Example: "txn_0YVDTQJ8YWDGQACV2N2N5SPWQ0"

  - `invoices.transactions.gateway` (object)
    Related gateway information.

  - `invoices.transactions.gateway.response` (object)
    Gateway response.

  - `invoices.transactions.gateway.response.code` (string,null)
    Gateway response code.

  - `invoices.transactions.gateway.response.message` (string,null)
    Gateway response message.

  - `invoices.transactions.gateway.response.type` (string,null)
    Gateway response type.

  - `invoices.transactions.gateway.response.originalCode` (string,null)
    Raw, unmapped gateway response code.

  - `invoices.transactions.gateway.response.originalMessage` (string,null)
    Raw, unmapped gateway response message.

  - `invoices.transactions.gateway.avsResponse` (object)
    Gateway Address Verification System (AVS) response.

  - `invoices.transactions.gateway.avsResponse.code` (string,null)
    Response code.

  - `invoices.transactions.gateway.avsResponse.message` (string,null)
    Response message.

  - `invoices.transactions.gateway.avsResponse.originalCode` (string,null)
    Raw response code.

  - `invoices.transactions.gateway.avsResponse.originalMessage` (string,null)
    Raw response message.

  - `invoices.transactions.gateway.cvvResponse` (object)
    Gateway Card Verification Value (CVV) response.

  - `invoices.transactions.acquirerName` (string,null)
    Acquirer name.
This value is only available when a transaction uses a payment gateway.
If a transaction does not use a payment gateway, this value is .
    Enum: "Adyen", "ACI", "Alipay", "AIB", "Aircash", "Airpay", "AmazonPay", "ApcoPay", "AsiaPaymentGateway", "AstroPay Card", "Awepay", "Ipay Options", "B+S", "Bambora", "BitPay", "Bank of America", "Bank of Moscow", "Bank of Rebilly", "Bank One", "BankSEND", "BMO Harris Bank", "Borgun", "BraintreePayments", "Buckaroo", "BVNK", "Cardknox", "CASHlib", "Cashterminal", "CashToCode", "Catalunya Caixa", "CCAvenue", "Chase", "CheckoutCom", "Chillstock", "ChinaUnionPay", "CIM", "Circle", "Citadel", "Clearhaus", "Cleo", "CODVoucher", "Coinbase", "CoinGate", "CoinPayments", "Conekta", "Coppr", "Credorax", "Cryptonator", "CyberSource", "Dimoco", "dLocal", "Dragonphoenix", "Dropayment", "EasyPayDirect", "EBANX", "ecoPayz", "EcorePay", "Elavon", "EMS", "ePay", "EPG", "Euteller", "Ezeebill", "eZeeWallet", "ezyEFT", "Fifth Third Bank", "Finrax", "First Data Buypass", "First Data Nashville", "First Data North", "First Data Omaha", "FinTecSystems", "Flexepin", "Forte", "FundSend", "gate2way", "Gigadat", "Global East", "Gooney", "Gpaysafe", "Heartland", "HiPay", "HSBC", "iCashOne", "iCanPay", "ICEPAY", "iCheque", "Ilixium", "Ingenico", "INOVAPAY", "Intuit", "Jeton", "JPMOrbital", "Khelocard", "Klarna", "Konnektive", "Kushki", "Limepay", "Loonio", "loonie", "LPG", "Masapay", "MaxiCash", "MercadoPago", "Merrick", "Mission Valley Bank", "MiFinity", "MobilePay", "Moneris", "Monolo", "MonRem", "MuchBetter", "MuchBetterGateway", "MyFatoorah", "NATWEST", "Neosurf", "Netbanking", "Neteller", "NinjaWallet", "NMI", "NordikCoin", "NOWPayments", "NuaPay", "Nuvei", "OchaPay", "OmniMatrix", "Onlineueberweisen", "OnRamp", "Orbital", "Other", "Panamerican", "Panda Bank", "Paramount", "ParamountCommerce", "ParamountEft", "ParamountInterac", "Pay4fun", "PayCash", "PayClub", "PayEcards", "PaymentAsia", "PaymenTechnologies", "PaymentsOS", "Paymero", "Paynetics", "PayPal", "Payper", "Payr", "PayRedeem", "PayRetailers", "PayTabs", "PayU", "PayULatam", "Payvision", "PharosPayments", "Piastrix", "Pin4Pay", "Peoples Trust Company", "PostFinance", "PPRO", "Privatbank", "Prosa", "PSiGate", "QQPay", "Rapyd", "RBC", "RBS WorldPay", "RealTime", "Rotessa", "Safecharge", "SaltarPay", "SecureTrading", "SecurionPay", "Skrill", "SmartInvoice", "SMSVoucher", "Sofort", "SparkPay", "State Bank of Mauritius", "STPMexico", "Stripe", "Tabby", "TBI", "Telr", "TestProcessor", "ToditoCash", "Triple000", "Truevo", "Trustly", "TrustPay", "TrustsPay", "TSYS", "TWINT", "UPayCard", "Vantiv", "VCreditos", "VegaWallet", "VoicePay", "Wallet88", "WeChat Pay", "Wells Fargo", "Wing Hang Bank", "Wirecard", "WorldPay", "XPay", "Zimpler", "Zotapay"

  - `invoices.transactions.velocity` (integer)
    Number of transactions by the same customer in the past 24 hours.

  - `invoices.transactions.revision` (integer)
    Number of times the transaction data has been modified.

This revision number is useful when analyzing webhook data to determine if the change takes precedence over the current representation.

  - `invoices.transactions.referenceData` (object,null)
    Transaction reference data.
    Example: {"gatewayTransactionId":"GAT123"}

  - `invoices.transactions.bin` (string,null)
    Payment card Bank Identification Number (BIN).

  - `invoices.transactions.paymentInstrument` (object)

  - `invoices.transactions.hasDcc` (boolean)
    Specifies if Dynamic Currency Conversion (DCC) applies to the transaction.

  - `invoices.transactions.dcc` (object,null)
    Detailed Dynamic currency conversion (DCC).
If DCC is not applied to the transaction, this value is .

  - `invoices.transactions.dcc.base` (object)
    Initial amount and currency to convert from.

  - `invoices.transactions.dcc.base.amount` (number, required)

  - `invoices.transactions.dcc.quote` (object)
    Suggested amount and currency to convert to.

  - `invoices.transactions.dcc.usdMarkup` (number)
    Markup amount converted to USD.

  - `invoices.transactions.dcc.outcome` (string)
    Dynamic currency conversion outcome.
    Enum: "rejected", "selected", "unknown"

  - `invoices.transactions.riskScore` (integer)
    Risk score for the transaction.

  - `invoices.transactions.riskMetadata` (any)

  - `invoices.transactions.notificationUrl` (string,null)
    URL where a server-to-server POST notification is sent.
This notification is sent when the transaction result is finalized after a timeout or an offsite interaction.

Do not interpret this notification as a confirmation,
complete a  request to confirm the result of the transaction.
To ensure the request is not reattempted,
when the result is confirmed, respond with a  HTTP status code.

The following placeholders are available to use in this URI:  and .
These placeholders are replaced the with the transaction ID and result accordingly.

  - `invoices.transactions.isDisputed` (boolean)
    Specifies if a transaction is disputed.

  - `invoices.transactions.disputeTime` (string,null)
    Date and time when the dispute is created.
If the transaction is not disputed, this value is .

  - `invoices.transactions.disputeStatus` (string,null)
    Status of the dispute.
    Enum: null, "response-needed", "under-review", "forfeited", "won", "lost", "unknown"

  - `invoices.transactions.isReconciled` (boolean)
    Specifies if the transaction is verified with gateway batch data.

  - `invoices.transactions.isProcessedOutside` (boolean)
    Specifies if the transaction is processed outside of Rebilly.

  - `invoices.transactions.isMerchantInitiated` (boolean)
    Specifies if the transaction is initiated by the merchant.

  - `invoices.transactions.hadDiscrepancy` (boolean)
    Specifies if the transaction is updated due to a discrepancy with its source of truth.

  - `invoices.transactions.arn` (string,null)
    Acquirer reference number.
    Example: "74836950144358910018150"

  - `invoices.transactions.reportAmount` (number)
    Transaction amount converted to the report currency of the organization.

  - `invoices.transactions.reportCurrency` (string)
    Currency code in ISO 4217 format.

  - `invoices.transactions.settlementTime` (string,null)
    Date and time when the transaction is settled by the banking institution.

  - `invoices.transactions.discrepancyTime` (string,null)
    Date and time of the most recent discrepancy on the transaction.

  - `invoices.transactions.limits` (object,null)
    Transaction amount limit information.

  - `invoices.transactions.limits.amount` (number)
    Limit amount.
    Example: 275.35

  - `invoices.transactions.limits.resetTime` (string,null)
    Date and time in which the limit amount resets.
This value may be used for user interfaces.

  - `invoices.transactions.depositRequestId` (string,null)
    ID of the deposit request if applicable. The created transaction is based on the properties of this deposit request.
    Example: "dep_req_0YVJ65BSGYC3EAT58SEX8KY6J7"

  - `invoices.transactions.payoutRequestId` (string,null)
    ID of the payout request if applicable. The created transaction is based on the properties of this payout request.
    Example: "pout_req_0YVDMDE2BMC6KBB5MX76RF6T80"

  - `invoices.transactions.method` (string)
    Payment method.

> Use  instead.
    Enum: "payment-card", "ach", "cash", "check", "paypal", "AdvCash", "Affirm", "Afterpay", "Aircash", "Airpay", "Alfa-click", "Alipay", "AmazonPay", "Apple Pay", "AstroPay Card", "AstroPay-GO", "BankSEND", "BankReferenced", "bank-transfer", "bank-transfer-2", "bank-transfer-3", "bank-transfer-4", "bank-transfer-5", "bank-transfer-6", "bank-transfer-7", "bank-transfer-8", "bank-transfer-9", "Baloto", "Beeline", "Belfius-direct-net", "bitcoin", "Bizum", "Blik", "Boleto", "Boleto-2", "Boleto-3", "cash-deposit", "CASHlib", "CashToCode", "CCAvenue", "China UnionPay", "Clearpay", "Cleo", "CODVoucher", "Conekta-oxxo", "Conekta-spei", "cryptocurrency", "Cupon-de-pagos", "CyberSource", "Dimoco-pay-smart", "Directa24Card", "domestic-cards", "Efecty", "echeck", "ecoPayz", "ecoVoucher", "EPS", "ePay.bg", "Ethereum", "e-wallet", "ezyEFT", "eZeeWallet", "FasterPay", "Flexepin", "Giropay", "Google Pay", "Gpaysafe", "iCashOne Voucher", "iDebit", "iDEAL", "ING-homepay", "INOVAPAY-pin", "INOVAPAY-wallet", "InstaDebit", "InstantPayments", "instant-bank-transfer", "Interac-online", "Interac-eTransfer", "Interac-express-connect", "Interac", "invoice", "iWallet", "Jeton", "JetonCash", "jpay", "KakaoPay", "Khelocard", "Klarna", "KNOT", "Litecoin", "loonie", "LPG-online", "LPG-payment-card", "Matrix", "MaxiCash", "Megafon", "MercadoPago", "MiFinity-eWallet", "miscellaneous", "MobilePay", "Multibanco", "Bancontact", "Bancontact-mobile", "MTS", "MuchBetter", "MyFatoorah", "Neosurf", "Netbanking", "Neteller", "Nordea-Solo", "NordikCoin", "OchaPay", "online-bank-transfer", "Onlineueberweisen", "oriental-wallet", "OXXO", "P24", "Pagadito", "PagoEffectivo", "Pagsmile-lottery", "Pagsmile-deposit-express", "PayCash", "Payco", "Payeer", "PaymentAsia-crypto", "Paysafecard", "PayTabs", "Pay4Fun", "Paynote", "Paymero", "Paymero-QR", "PayU", "PayULatam", "Perfect-money", "Piastrix", "PIX", "PinPay", "phone", "PhonePe", "POLi", "PostFinance-card", "PostFinance-e-finance", "QIWI", "QPay", "QQPay", "rapyd-checkout", "rebilly-hosted-payment-form", "Resurs", "Ripple", "SafetyPay", "Samsung Pay", "SEPA", "Siirto", "Skrill", "Skrill Rapid Transfer", "SMSVoucher", "Sofort", "SparkPay", "SPEI", "swift-dbt", "Tele2", "Telr", "Terminaly-RF", "Tether", "ToditoCash-card", "Trustly", "Tupay", "TWINT", "UniCrypt", "UPayCard", "UPI", "USD-coin", "VCreditos", "VegaWallet", "VenusPoint", "voucher", "voucher-2", "voucher-3", "voucher-4", "Wallet88", "Webmoney", "Webpay", "Webpay-2", "Webpay Card", "WeChat Pay", "XPay-P2P", "XPay-QR", "Yandex-money", "Zotapay", "Zimpler", "Zip"

  - `invoices.transactions.orderId` (string)
    Order ID of the transaction.
This ID must be unique within a 24 hour period.

>  Use the  field instead.

  - `invoices.retryInstruction` (object,null)
    Invoice payment retry instruction.
This object specifies how to proceed if a payment related to the invoice fails.

  - `invoices.retryInstruction.attempts` (array, required)
    Describes the retry instruction.

  - `invoices.retryInstruction.attempts.scheduleInstruction` (object, required)
    Specifies when the payment retry instruction is performed.

  - `invoices.retryInstruction.attempts.amountAdjustmentInstruction` (any)

  - `invoices.retryInstruction.attempts.tryBackupInstruments` (boolean)
    Specifies whether to use backup payment instruments on an invoice payment retry.

  - `invoices.retryInstruction.afterAttemptPolicies` (array, required)
    Describes the action to take when a payment attempt concludes, and payment is not collected.
    Enum: "change-subscription-renewal-time"

  - `invoices.retryInstruction.afterRetryEndPolicies` (array, required)
    Describes the action to take when all scheduled payment retries, in a retry instruction, have concluded and payment is not collected.
    Enum: "abandon-invoice", "cancel-subscription"

  - `invoices.revision` (integer)
    Number of times the invoice data has been modified.

Use the revision number when analyzing webhook data to
determine if a change should take precedence over the current
representation.

  - `invoices.type` (string)
    Type of invoice.
    Enum: "initial", "renewal", "interim", "cancellation", "one-time", "refund", "charge", "one-time-sale"

  - `invoices.dueReminderTime` (string,null)
    Date and time when a past due reminder event is triggered.

  - `invoices.dueReminderNumber` (integer,null)
    Number of past due reminder events that have been triggered.

  - `invoices.delinquencyTime` (string,null)
    Date and time when the related order is considered delinquent, and is canceled.
If this value is , no delinquency time is configured.
If the  of the order becomes greater than the  value,
the  value becomes equal to .

If an invoice is not related to an order, this field can only be .

  - `orders` (array)
    List of returned orders.

  - `transactions` (array)
    List of returned transactions.

  - `searched` (array)
    Names of searched resources.
Includes all searched resources.

## Response 401 fields (application/json):

  - `status` (integer)
    HTTP status code.

  - `type` (string)
    Problem type in the form of a [URI](https://tools.ietf.org/html/rfc3986) reference.
It should provide human-readable documentation for the problem type.
When this member is not present, its value is assumed to be "about:blank".

  - `title` (string)
    Short, human-readable summary of the problem type.
Other than for the purposes of localization, this should not change from occurrence to occurrence of the problem.

  - `detail` (string)
    Human-readable explanation that is specific to this occurrence of the problem.

  - `instance` (string)
    URI reference that identifies the specific occurrence of the problem.
It may or may not yield further information if dereferenced.

## Response 403 fields (application/json):

  - `status` (integer)
    HTTP status code.

  - `type` (string)
    Problem type in the form of a [URI](https://tools.ietf.org/html/rfc3986) reference.
It should provide human-readable documentation for the problem type.
When this member is not present, its value is assumed to be "about:blank".

  - `title` (string)
    Short, human-readable summary of the problem type.
Other than for the purposes of localization, this should not change from occurrence to occurrence of the problem.

  - `detail` (string)
    Human-readable explanation that is specific to this occurrence of the problem.

  - `instance` (string)
    URI reference that identifies the specific occurrence of the problem.
It may or may not yield further information if dereferenced.