# Make a purchase

Executes a purchase.

A purchase can be completed both with and without authentication.
Purchases that use a pre-created payment instrument must use authentication.

To preview the purchase before completing it,
use the Purchase preview operation.

Endpoint: POST /storefront/purchase
Version: latest
Security: CustomerJWT, PublishableApiKey

## Request fields (application/json):

  - `orderId` (string)
    Unique resource ID.
    Example: "4f6cf35x-2c4y-483z-a0a9-158621f77a21"

  - `websiteId` (string, required)
    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"

  - `items` (array, required)

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

  - `items.quantity` (integer)
    Number of product units in the specified plan.

  - `billingAddress` (object,null)
    Billing address details.

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

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

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

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

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

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

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

  - `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"

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

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

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

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

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

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

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

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

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

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

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

  - `deliveryAddress` (object,null)
    Delivery address details.

  - `shippingRateId` (string)
    Unique resource ID.
    Example: "4f6cf35x-2c4y-483z-a0a9-158621f77a21"

  - `paymentInstruction` (any, required)
    Payment instruction for the purchase.

  - `couponIds` (array)
    List of coupons that are applied to the order.

  - `password` (string,null)
    Customer account password.
If this value is set, it is used to create a customer account.

  - `redirectUrl` (string,null)
    URL to redirect the end-user when an offsite transaction is completed.
If  is ,
then the  can be set to one the following:

- 

- 

- 

- 

This field defaults to the configured website URL.
You may use  or  as placeholders in the URL.
These placeholders are replaced with the transaction ID and result.

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

  - `customFields` (object)
    Custom fields copied to resources.

  - `customFields.customers` (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).
    Example: {"foo":"bar"}

  - `customFields.subscriptions` (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).
    Example: {"foo":"bar"}

  - `customFields.transactions` (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).
    Example: {"foo":"bar"}

## Response 201 fields (application/json):

  - `orderId` (string)
    Unique resource ID.
    Example: "4f6cf35x-2c4y-483z-a0a9-158621f77a21"

  - `invoice` (object)
    Initial invoice.

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

  - `invoice.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"

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

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

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

  - `invoice.currency` (string)
    Currency code in ISO 4217 format.
    Example: "USD"

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

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

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

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

  - `invoice.shipping` (object)
    Shipping settings.

  - `invoice.tax` (object)
    Taxes.

  - `invoice.billingAddress` (object)
    Contact's information.

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

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

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

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

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

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

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

  - `invoice.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"

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

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

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

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

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

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

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

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

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

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

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

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

  - `invoice.deliveryAddress` (object)
    Contact's information.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  - `invoice.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.

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

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

  - `invoice.items.tax` (object,null)
    Invoice item tax.

  - `invoice.items.tax.amount` (number, required)
    Amount of the tax.

  - `invoice.items.tax.description` (string, required)
    Description of the tax.

  - `invoice.items.tax.rate` (number,null)
    Overall sales tax rate which includes state, county, city and district tax.

  - `invoice.items.tax.stateAmount` (number,null)
    Amount of sales tax to collect for the state.
    Example: 0.94

  - `invoice.items.tax.countyAmount` (number,null)
    Amount of sales tax to collect for the county.
    Example: 0.04

  - `invoice.items.tax.cityAmount` (number,null)
    Amount of sales tax to collect for the city.

  - `invoice.items.tax.specialDistrictAmount` (number,null)
    Amount of sales tax to collect for the special district.
    Example: 0.38

  - `invoice.items.tax.stateRate` (number,null)
    State sales tax rate for given location.

  - `invoice.items.tax.countyRate` (number,null)
    County sales tax rate for given location.

  - `invoice.items.tax.cityRate` (number,null)
    City sales tax rate for given location.

  - `invoice.items.tax.specialDistrictRate` (number,null)
    Special district sales tax rate for given location.

  - `invoice.items.tax.jurisdictions` (object,null)
    Jurisdiction names for the invoice.

  - `invoice.items.tax.jurisdictions.country` (string,null)
    Two-letter ISO country code for the provided location.
    Example: "US"

  - `invoice.items.tax.jurisdictions.state` (string,null)
    Postal abbreviated state name for the provided location.
    Example: "CA"

  - `invoice.items.tax.jurisdictions.county` (string,null)
    County name for the provided location.
    Example: "LOS ANGELES"

  - `invoice.items.tax.jurisdictions.city` (string,null)
    City name for the provided location.
    Example: "LOS ANGELES"

  - `invoice.items._links` (array)
    Related links.

  - `invoice.items._links.href` (string)
    Link URL.

  - `invoice.items._links.rel` (string)
    Type of link.
    Enum: "self", "product", "subscription", "plan"

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

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

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

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

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

  - `invoice.discounts.redemptionId` (string)
    Unique resource ID.
    Example: "4f6cf35x-2c4y-483z-a0a9-158621f77a21"

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

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

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

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

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

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

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

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

  - `invoice.abandonedTime` (string)
    Read-only timestamp in ISO 8601 date-time format.

  - `invoice.voidedTime` (string)
    Read-only timestamp in ISO 8601 date-time format.

  - `invoice.paidTime` (string)
    Read-only timestamp in ISO 8601 date-time format.

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

  - `invoice.issuedTime` (string)
    Read-only timestamp in ISO 8601 date-time format.

  - `invoice.paymentFormUrl` (string)
    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
.

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

  - `invoice.transactions.id` (string)
    ID of the transaction.
    Example: "txn_0YVDTQJ8YWDGQACV2N2N5SPWQ0"

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

  - `invoice.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"

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

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

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

  - `invoice.transactions.purchaseCurrency` (string)
    Currency code in ISO 4217 format.
    Example: "USD"

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

  - `invoice.transactions.requestCurrency` (string)
    Currency code in ISO 4217 format.
    Example: "USD"

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

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

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

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

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

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

  - `invoice.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.

  - `invoice.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.

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

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

  - `invoice.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.

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

  - `invoice.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.

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

  - `invoice.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", "ecoPayzTurkey", "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"

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

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

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

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

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

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

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

  - `invoice.transactions.gateway.response.humanMessage` (string,null)
    Human-readable gateway response message.

  - `invoice.transactions.gateway.response.humanDescription` (string,null)
    Human-readable gateway response description with more detailed information.

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

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

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

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

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

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

  - `invoice.transactions.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).
    Example: {"foo":"bar"}

  - `invoice.transactions.processedTime` (string)
    Read-only timestamp in ISO 8601 date-time format.

  - `invoice.transactions.paymentInstrument` (object)
    Default payment instrument information.

  - `invoice.transactions.paymentInstrument.method` (string, required)
    Payment method.
    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", "reverse-withdrawal", "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"

  - `invoice.transactions.paymentInstrument.paymentInstrumentId` (string)
    ID of the payment instrument.
    Example: "inst_0YVB8KPKNXCBR9EDX7JHSED75N"

  - `invoice.transactions.approvalUrl` (string)
    URL to redirect the end-customer when transaction  is  or .

  - `invoice.transactions.token` (string)
    Session token that is used for authentication. This token provides access to created orders, invoices, and transactions.

  - `invoice.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"

  - `transaction` (object)
    Initial transaction.

  - `token` (string)
    Session token that is used for authentication.
This token can be used to view the created order, invoice, and transaction.

  - `shippingRateId` (string)
    Unique resource ID.
    Example: "4f6cf35x-2c4y-483z-a0a9-158621f77a21"

## 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.

## Response 422 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.

  - `invalidFields` (array)
    Invalid field details.
    Example: [{"field":"field1","message":"field1 is invalid"},{"field":"subObject.field2","message":"field2 is invalid"},{"field":"subObject.field2","message":"another error in the field2"}]

  - `invalidFields.field` (string)
    Name of the field.
Dot notation is used for nested object field names.

  - `invalidFields.message` (string)
    Message field.

## Response 429 fields (application/json):

  - `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".
    Example: "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.
    Example: "Rate Limit Exceeded"

  - `status` (integer)
    HTTP status code.

  - `detail` (string)
    Human-readable explanation that is specific to this occurrence of the problem.
    Example: "A request cannot be executed because the user has sent too many requests within a certain period of time"

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