Get a transaction receipt

curl --request POST \
  --url https://sandbox-platform.jupico.com/v1/query/transactions/receipt \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "transactionId": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "subMerchantId": "jpt-sim-md-1"
}
'

import requests

url = "https://sandbox-platform.jupico.com/v1/query/transactions/receipt"

payload = {
    "transactionId": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "subMerchantId": "jpt-sim-md-1"
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    transactionId: 'b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e',
    subMerchantId: 'jpt-sim-md-1'
  })
};

fetch('https://sandbox-platform.jupico.com/v1/query/transactions/receipt', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

const url = 'https://sandbox-platform.jupico.com/v1/query/transactions/receipt';
const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    transactionId: 'b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e',
    subMerchantId: 'jpt-sim-md-1'
  })
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

{
  "success": true,
  "status": "<string>",
  "code": "<string>",
  "data": {
    "transactionId": "<string>",
    "referenceId": "<string>",
    "invoiceNumber": "<string>",
    "approvalNumber": "<string>",
    "status": "<string>",
    "operation": "<string>",
    "date": "2023-11-07T05:31:56Z",
    "amount": 123,
    "currency": "USD",
    "taxAmount": 123,
    "items": [
      {
        "description": "<string>",
        "quantity": 123,
        "amount": 123,
        "taxRate": 123
      }
    ],
    "merchant": {
      "name": "<string>",
      "address": "<string>",
      "phone": "<string>",
      "website": "<string>"
    },
    "customer": {
      "name": "<string>",
      "email": "<string>",
      "phone": "<string>",
      "address": "<string>"
    },
    "paymentMethod": {
      "type": "<string>",
      "brand": "<string>",
      "last4": "<string>",
      "cardHolderName": "<string>",
      "accountType": "<string>"
    },
    "description": "<string>"
  },
  "message": "<string>",
  "error": {}
}

POST

https://sandbox-platform.jupico.com

query

transactions

receipt

Get a transaction receipt

curl --request POST \
  --url https://sandbox-platform.jupico.com/v1/query/transactions/receipt \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "transactionId": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "subMerchantId": "jpt-sim-md-1"
}
'

import requests

url = "https://sandbox-platform.jupico.com/v1/query/transactions/receipt"

payload = {
    "transactionId": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "subMerchantId": "jpt-sim-md-1"
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    transactionId: 'b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e',
    subMerchantId: 'jpt-sim-md-1'
  })
};

fetch('https://sandbox-platform.jupico.com/v1/query/transactions/receipt', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

const url = 'https://sandbox-platform.jupico.com/v1/query/transactions/receipt';
const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    transactionId: 'b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e',
    subMerchantId: 'jpt-sim-md-1'
  })
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

{
  "success": true,
  "status": "<string>",
  "code": "<string>",
  "data": {
    "transactionId": "<string>",
    "referenceId": "<string>",
    "invoiceNumber": "<string>",
    "approvalNumber": "<string>",
    "status": "<string>",
    "operation": "<string>",
    "date": "2023-11-07T05:31:56Z",
    "amount": 123,
    "currency": "USD",
    "taxAmount": 123,
    "items": [
      {
        "description": "<string>",
        "quantity": 123,
        "amount": 123,
        "taxRate": 123
      }
    ],
    "merchant": {
      "name": "<string>",
      "address": "<string>",
      "phone": "<string>",
      "website": "<string>"
    },
    "customer": {
      "name": "<string>",
      "email": "<string>",
      "phone": "<string>",
      "address": "<string>"
    },
    "paymentMethod": {
      "type": "<string>",
      "brand": "<string>",
      "last4": "<string>",
      "cardHolderName": "<string>",
      "accountType": "<string>"
    },
    "description": "<string>"
  },
  "message": "<string>",
  "error": {}
}

Authorizations

Authorization

string

header

required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json

Identify the transaction and the sub-merchant that owns it. responseFormat is optional and defaults to json.

transactionId

string

required

Identifier of the transaction to build the receipt for.

Example:

"b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e"

subMerchantId

string

required

Sub-merchant that owns the transaction. Only one sub-merchant per request.

Example:

"jpt-sim-md-1"

responseFormat

enum<string>

default:json

Format of the returned receipt. Defaults to json, which is currently the only supported value.

Available options:

json

Response

200 - application/json

Receipt data for the transaction.

success

boolean

Whether the request was processed successfully.

status

string

Result status of the request, such as succeeded.

code

string

Machine-readable result code. See the Error Codes reference.

data

object

The receipt payload. A field is omitted when the transaction does not carry a value for it.

Hide child attributes

data.transactionId

string

Identifier of the transaction.

data.referenceId

string

Your reference for the transaction, if one was sent.

data.invoiceNumber

string

Invoice number recorded on the transaction.

data.approvalNumber

string

Approval number returned by the processor.

data.status

string

Status of the transaction, such as succeeded.

data.operation

string

Operation the receipt covers, such as sale, refund, or void.

data.date

string<date-time>

Date and time the transaction was processed.

data.amount

number

Amount to show on the receipt. For an approved transaction this is the remaining balance when the transaction tracks one (for example, a sale that has been partially refunded), otherwise the original amount. A declined transaction always shows the original amount.

data.currency

string

Currency of the transaction. Defaults to USD when the transaction does not record one.

Example:

"USD"

data.taxAmount

number

Tax amount recorded on the transaction.

data.items

object[]

Line items recorded on the transaction.

Hide child attributes

data.items.description

string

Description of the line item.

data.items.quantity

number

Number of units.

data.items.amount

number

Price per unit.

data.items.taxRate

number

Tax rate applied to this line item, as a percentage.

data.merchant

object

Business details of the sub-merchant that took the payment.

Hide child attributes

data.merchant.name

string

Sub-merchant's DBA name.

data.merchant.address

string

Sub-merchant's business address as a single line: street, city, state, postal code, and country.

data.merchant.phone

string

Sub-merchant's business phone number.

data.merchant.website

string

Sub-merchant's business website.

data.customer

object

Customer details taken from the transaction's billing information.

Hide child attributes

data.customer.name

string

Billing name, falling back to the cardholder or account holder name when no billing name was sent.

data.customer.email

string

Billing email address.

data.customer.phone

string

Billing phone number.

data.customer.address

string

Billing address as a single line: address, city, state, ZIP code, and country.

data.paymentMethod

object

How the transaction was paid. Brand and cardholder name are present for cards; account type is present for eCheck.

Hide child attributes

data.paymentMethod.type

string

Payment method used, such as creditCard or eCheck.

data.paymentMethod.brand

string

Card brand. Cards only.

data.paymentMethod.last4

string

Last 4 digits of the card number or of the bank account number.

data.paymentMethod.cardHolderName

string

Name on the card. Cards only.

data.paymentMethod.accountType

string

Bank account type, such as checking. eCheck only.

data.description

string

Description recorded on the transaction.

message

string

Human-readable result message.

error

object

Error detail. Absent on a successful request.

API Overview

API Reference

Resources

Get a transaction receipt

Authorizations

Body

Response