Welcome
curl --request POST \
--url https://api.chargeblast.com/api/v2/orders/upload \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <x-api-key>' \
--data '
{
"orders": [
{
"amount": 123,
"id": "<string>",
"currency": "<string>",
"transactionDate": "<string>",
"ip": "<string>",
"authCode": "<string>",
"bin": "<string>",
"descriptor": "<string>",
"brand": "<string>",
"gateway": "<string>",
"arn": "<string>",
"status": "<string>",
"last4": "<string>",
"refunded": true,
"receipt": {
"merchantInfo": {
"merchantReceiptContact": {
"phoneForReceipt": "<string>",
"emailForReceipt": "<string>",
"websiteForReceipt": "<string>",
"receiptAddress": {
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"countrySubdivision": "<string>",
"postalCode": "<string>",
"country": "<string>",
"latitude": "<string>",
"longitude": "<string>"
}
},
"name": "<string>",
"description": "<string>",
"refundPolicyLink": "<string>",
"cancellationPolicyLink": "<string>",
"termsAndConditionsLink": "<string>",
"logoUrl": "<string>"
},
"lineItems": [
{
"productName": "<string>",
"productDescription": "<string>",
"currency": "<string>",
"quantity": 123,
"price": 123
}
],
"customerEmail": "<string>",
"customerPhone": "<string>",
"shippingAddress": {
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"countrySubdivision": "<string>",
"postalCode": "<string>",
"country": "<string>",
"latitude": "<string>",
"longitude": "<string>"
},
"billingAddress": {
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"countrySubdivision": "<string>",
"postalCode": "<string>",
"country": "<string>",
"latitude": "<string>",
"longitude": "<string>"
},
"name": {
"givenName": "<string>",
"familyName": "<string>"
}
}
}
]
}
'{
"message": "<string>"
}Upload Orders
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.
curl --request POST \
--url https://api.chargeblast.com/api/v2/orders/upload \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <x-api-key>' \
--data '
{
"orders": [
{
"amount": 123,
"id": "<string>",
"currency": "<string>",
"transactionDate": "<string>",
"ip": "<string>",
"authCode": "<string>",
"bin": "<string>",
"descriptor": "<string>",
"brand": "<string>",
"gateway": "<string>",
"arn": "<string>",
"status": "<string>",
"last4": "<string>",
"refunded": true,
"receipt": {
"merchantInfo": {
"merchantReceiptContact": {
"phoneForReceipt": "<string>",
"emailForReceipt": "<string>",
"websiteForReceipt": "<string>",
"receiptAddress": {
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"countrySubdivision": "<string>",
"postalCode": "<string>",
"country": "<string>",
"latitude": "<string>",
"longitude": "<string>"
}
},
"name": "<string>",
"description": "<string>",
"refundPolicyLink": "<string>",
"cancellationPolicyLink": "<string>",
"termsAndConditionsLink": "<string>",
"logoUrl": "<string>"
},
"lineItems": [
{
"productName": "<string>",
"productDescription": "<string>",
"currency": "<string>",
"quantity": 123,
"price": 123
}
],
"customerEmail": "<string>",
"customerPhone": "<string>",
"shippingAddress": {
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"countrySubdivision": "<string>",
"postalCode": "<string>",
"country": "<string>",
"latitude": "<string>",
"longitude": "<string>"
},
"billingAddress": {
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"countrySubdivision": "<string>",
"postalCode": "<string>",
"country": "<string>",
"latitude": "<string>",
"longitude": "<string>"
},
"name": {
"givenName": "<string>",
"familyName": "<string>"
}
}
}
]
}
'{
"message": "<string>"
}Headers
Your API key. Sent in the X-API-Key header.
Body
Show child attributes
Show child attributes
The amount, in cents, of the order. For example, $19.99 would be 1999.
The internal id of the order in your CRM.
The 3 character currency (case insensitive). E.g. 'usd'.
The date of the charge either in yyyy-MM-dd'T'HH:mm:ssZ format or yyyy-MM-dd format.
The ip address of the customer.
The authorization code of the charge. Used for matching purposes.
First 6 digits of the card.
The billing descriptor of the charge.
The brand of the card (case insensitive). visa, mastercard, amex, discover. Other values will default to unknown
If multiple gateways are used, the gateway of the transaction. Used for analytics only.
The acquirer reference number of the charge, if available.
The status of the transaction. Should be either 'succeeded' or 'failed'
Last 4 digits of the card.
Whether the transaction has already been refunded.
Additional info on the transaction. Only required for digital receipts and compelling evidence (pre-dispute re-presentment).
Show child attributes
Show child attributes
Override default merchant info. We recommend leaving this blank unless you are a merchant of record platform.
Show child attributes
Show child attributes
Your business contact information. Mandatory field if you are passing in merchant level details for each order.
Show child attributes
Show child attributes
The phone number to appear on the digital receipt, for the merchant's contact.
The email address to appear on the digital receipt, for the merchant's contact.
The website URL to appear on the digital receipt, for the merchant's contact.
The address to appear on the digital receipt, for the merchant's contact.
Show child attributes
Show child attributes
For US addresses, the state - two letter coded. E.g. CA
The country spelled out, e.g. 'United States of America' or abbreviated 'USA'.
The name of the merchant to appear on the digital receipt, e.g. 'Netflix'
A brief description of the business, e.g. 'Media Streaming Business'
A url linking to a refund policy. Include https://, e.g. 'https://netflix.com/refund-policy'
A url linking to a cancel policy. Include https://, e.g. 'https://netflix.com/cancel-policy'
A url linking to a terms of service. Include https://, e.g. 'https://netflix.com/terms-of-service'
A url linking to a logo of the business. For best results use square pngs (ideally 256x256, though other resolutions are supported).
Line items for the receipt.
Show child attributes
Show child attributes
The name of the product.
A more detailed description of the product.
3 character ISO currency code. If nil, defaults to USD.
The quantity of the line item (defaults to 1).
The total price (in cents) of the line item. For if you bought 5 socks at $2 each, this field would be 1000.
Phone number if applicable, e.g. +14016993099. String in any ISO format is acceptable.
If a physical product, the shipping address of the customer.
Show child attributes
Show child attributes
For US addresses, the state - two letter coded. E.g. CA
The country spelled out, e.g. 'United States of America' or abbreviated 'USA'.
The billing address of the customer.
Show child attributes
Show child attributes
For US addresses, the state - two letter coded. E.g. CA
The country spelled out, e.g. 'United States of America' or abbreviated 'USA'.
Response
OK