---
title: "Upload Orders"
method: POST
path: "/api/v2/orders/upload"
tags: ["Sync Data"]
---

# Upload Orders

`POST /api/v2/orders/upload`

## Request

- Base URL: `https://api.chargeblast.com`
- URL: `https://api.chargeblast.com/api/v2/orders/upload`
- Auth: none declared. Required headers: `X-API-Key`

Upload orders to the chargeblast system. This will allow you to match disputes and chargebacks to the orders you have uploaded. Amount should be in cents, e.g. $19.99 => amount = 1999. This endpoint is rate limited to 100 requests every 10 seconds.

## Headers

- `X-API-Key` string, required

## Request body

- OrderUploadBody
  - `orders` OrderUploadBodyOrder[], required
    - `ip` string, nullable: The ip address of the customer.
    - `authCode` string, nullable: The authorization code of the charge. Used for matching purposes.
    - `amount` integer, required: The amount, in cents, of the order. For example, $19.99 would be 1999.
    - `bin` string, nullable: First 6 digits of the card.
    - `descriptor` string, nullable: The billing descriptor of the charge.
    - `id` string, required: The internal id of the order in your CRM.
    - `currency` string, required: The 3 character currency (case insensitive). E.g. 'usd'.
    - `transactionDate` string, required: The date of the charge either in yyyy-MM-dd'T'HH:mm:ssZ format or yyyy-MM-dd format.
    - `brand` string, nullable: The brand of the card (case insensitive). visa, mastercard, amex, discover. Other values will default to unknown
    - `gateway` string, nullable: If multiple gateways are used, the gateway of the transaction. Used for analytics only.
    - `arn` string, nullable: The acquirer reference number of the charge, if available.
    - `status` string, nullable: The status of the transaction. Should be either 'succeeded' or 'failed'
    - `last4` string, nullable: Last 4 digits of the card.
    - `refunded` boolean, nullable: Whether the transaction has already been refunded.
    - `receipt` Receipt
      - `merchantInfo` MerchantInfo
        - `merchantReceiptContact` MerchantContact
          - `phoneForReceipt` string, nullable: The phone number to appear on the digital receipt, for the merchant's contact.
          - `emailForReceipt` string, nullable: The email address to appear on the digital receipt, for the merchant's contact.
          - `websiteForReceipt` string, nullable: The website URL to appear on the digital receipt, for the merchant's contact.
          - `receiptAddress` Address
            - `line1` string, nullable
            - `line2` string, nullable
            - `city` string, nullable
            - `countrySubdivision` string, nullable: For US addresses, the state - two letter coded. E.g. CA
            - `postalCode` string, nullable
            - `country` string, nullable: The country spelled out, e.g. 'United States of America' or abbreviated 'USA'.
            - `latitude` string, nullable
            - `longitude` string, nullable
        - `name` string, nullable: The name of the merchant to appear on the digital receipt, e.g. 'Netflix'
        - `description` string, nullable: A brief description of the business, e.g. 'Media Streaming Business'
        - `refundPolicyLink` string, nullable: A url linking to a refund policy. Include https://, e.g. 'https://netflix.com/refund-policy'
        - `cancellationPolicyLink` string, nullable: A url linking to a cancel policy. Include https://, e.g. 'https://netflix.com/cancel-policy'
        - `termsAndConditionsLink` string, nullable: A url linking to a terms of service. Include https://, e.g. 'https://netflix.com/terms-of-service'
        - `logoUrl` string, nullable: A url linking to a logo of the business. For best results use square pngs (ideally 256x256, though other resolutions are supported).
      - `lineItems` LineItem[]: Line items for the receipt.
        - `productName` string: The name of the product.
        - `productDescription` string, nullable: A more detailed description of the product.
        - `currency` string, nullable: 3 character ISO currency code. If nil, defaults to USD.
        - `quantity` integer, nullable: The quantity of the line item (defaults to 1).
        - `price` integer: The total price (in cents) of the line item. For if you bought 5 socks at $2 each, this field would be 1000.
      - `customerEmail` string, nullable
      - `customerPhone` string, nullable: Phone number if applicable, e.g. +14016993099. String in any ISO format is acceptable.
      - `shippingAddress` Address
        - `line1` string, nullable
        - `line2` string, nullable
        - `city` string, nullable
        - `countrySubdivision` string, nullable: For US addresses, the state - two letter coded. E.g. CA
        - `postalCode` string, nullable
        - `country` string, nullable: The country spelled out, e.g. 'United States of America' or abbreviated 'USA'.
        - `latitude` string, nullable
        - `longitude` string, nullable
      - `billingAddress` Address
        - `line1` string, nullable
        - `line2` string, nullable
        - `city` string, nullable
        - `countrySubdivision` string, nullable: For US addresses, the state - two letter coded. E.g. CA
        - `postalCode` string, nullable
        - `country` string, nullable: The country spelled out, e.g. 'United States of America' or abbreviated 'USA'.
        - `latitude` string, nullable
        - `longitude` string, nullable
      - `name` Name
        - `givenName` string, nullable: First name, e.g. 'Elon'
        - `familyName` string, nullable: Last name, e.g. 'Musk'
    - `network_id` string, nullable: The network transaction identifier. Sometimes known as network_transaction_identifier. Example values: 'MAHAQMP03' (Mastercard), '306054697896273' (Visa).

## Response `200`

OK

- OrderUploadResponse
  - `message` string, required

---

[API](https://skmtc.dev/chargeblast/apis/chargeblast-api-2.md) · [All operations](https://skmtc.dev/chargeblast/apis/chargeblast-api-2/llms.txt) · [OpenAPI document](https://skmtc.dev/chargeblast/apis/chargeblast-api-2/revisions/882dd27a5692?raw)