Process a card sale

curl --request POST \
  --url https://sandbox-platform.jupico.com/v1/transactions/creditcard/sale \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "subMerchantId": "jpt-sim-md-1",
  "paymentToken": {
    "type": "creditcard",
    "token": {
      "provider": "jupico",
      "token": "5dd19881-b437-42b0-9c9b-7773ebb598eb"
    }
  },
  "amount": 40,
  "cardHolderInitiated": true
}
'

{
  "success": true,
  "data": {
    "status": "<string>",
    "transactionId": "<string>",
    "approvalNumber": "<string>",
    "operation": "<string>",
    "subMerchantId": "<string>",
    "amount": 123,
    "txDate": "<string>",
    "referenceNumber": "<string>",
    "referenceId": "<string>",
    "taxAmount": 123,
    "taxWithHold": true,
    "items": [
      {
        "description": "Consulting services",
        "quantity": 5,
        "amount": 100,
        "taxRate": 123
      }
    ],
    "balanceAmount": 123,
    "parentId": "<string>",
    "description": "<string>",
    "dynamicFee": {
      "fixed": 123,
      "discountRatePerc": 123
    },
    "paymentMethod": {
      "type": "<string>",
      "eCheck": {},
      "cc": {
        "card": {
          "cardHolderName": "<string>",
          "last4Digits": "<string>",
          "expirationMonth": "<string>",
          "expirationYear": "<string>",
          "logo": "<string>"
        },
        "provider": "<string>",
        "cardHolderInitiated": true,
        "networkTransactionID": "<string>",
        "token": "<string>"
      }
    },
    "billing": {
      "address": "<string>",
      "city": "<string>",
      "zipCode": "<string>",
      "state": "<string>",
      "email": "<string>",
      "name": "<string>",
      "phone": "<string>"
    },
    "shipping": {
      "address": "<string>",
      "city": "<string>",
      "zipCode": "<string>",
      "state": "<string>",
      "email": "<string>",
      "name": "<string>",
      "phone": "<string>"
    },
    "validations": {
      "avs": {
        "addressNumber": "<string>",
        "addressPostalCode": "<string>"
      },
      "cvv": {
        "cvcCheck": "<string>"
      }
    },
    "paymentToken": {
      "type": "<string>",
      "token": {
        "provider": "<string>",
        "token": "<string>",
        "cardHolderName": "<string>",
        "expirationMonth": "<string>",
        "expirationYear": "<string>",
        "logo": "<string>",
        "cardLogo": "<string>",
        "last4Digits": "<string>",
        "truncatedCardNumber": "<string>"
      }
    }
  },
  "message": "<string>",
  "code": "<string>"
}

POST

https://sandbox-platform.jupico.com

transactions

creditcard

sale

curl --request POST \
  --url https://sandbox-platform.jupico.com/v1/transactions/creditcard/sale \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "subMerchantId": "jpt-sim-md-1",
  "paymentToken": {
    "type": "creditcard",
    "token": {
      "provider": "jupico",
      "token": "5dd19881-b437-42b0-9c9b-7773ebb598eb"
    }
  },
  "amount": 40,
  "cardHolderInitiated": true
}
'

{
  "success": true,
  "data": {
    "status": "<string>",
    "transactionId": "<string>",
    "approvalNumber": "<string>",
    "operation": "<string>",
    "subMerchantId": "<string>",
    "amount": 123,
    "txDate": "<string>",
    "referenceNumber": "<string>",
    "referenceId": "<string>",
    "taxAmount": 123,
    "taxWithHold": true,
    "items": [
      {
        "description": "Consulting services",
        "quantity": 5,
        "amount": 100,
        "taxRate": 123
      }
    ],
    "balanceAmount": 123,
    "parentId": "<string>",
    "description": "<string>",
    "dynamicFee": {
      "fixed": 123,
      "discountRatePerc": 123
    },
    "paymentMethod": {
      "type": "<string>",
      "eCheck": {},
      "cc": {
        "card": {
          "cardHolderName": "<string>",
          "last4Digits": "<string>",
          "expirationMonth": "<string>",
          "expirationYear": "<string>",
          "logo": "<string>"
        },
        "provider": "<string>",
        "cardHolderInitiated": true,
        "networkTransactionID": "<string>",
        "token": "<string>"
      }
    },
    "billing": {
      "address": "<string>",
      "city": "<string>",
      "zipCode": "<string>",
      "state": "<string>",
      "email": "<string>",
      "name": "<string>",
      "phone": "<string>"
    },
    "shipping": {
      "address": "<string>",
      "city": "<string>",
      "zipCode": "<string>",
      "state": "<string>",
      "email": "<string>",
      "name": "<string>",
      "phone": "<string>"
    },
    "validations": {
      "avs": {
        "addressNumber": "<string>",
        "addressPostalCode": "<string>"
      },
      "cvv": {
        "cvcCheck": "<string>"
      }
    },
    "paymentToken": {
      "type": "<string>",
      "token": {
        "provider": "<string>",
        "token": "<string>",
        "cardHolderName": "<string>",
        "expirationMonth": "<string>",
        "expirationYear": "<string>",
        "logo": "<string>",
        "cardLogo": "<string>",
        "last4Digits": "<string>",
        "truncatedCardNumber": "<string>"
      }
    }
  },
  "message": "<string>",
  "code": "<string>"
}

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

API support various types of use. Required fields are defined by the most basic call. For other uses be sure to send the required information defined in the schema and examples.

subMerchantId

string

required

Unique identifier of the submerchant.

amount

number

required

The amount to charge.

paymentToken

object

required

The payment credential to charge: a one-time token from the web component or a stored Jupico token.

Show child attributes

cardHolderInitiated

boolean

required

True when the cardholder actively initiates the payment; false for merchant-initiated transactions such as recurring charges.

items

object[]

Line items included in the total amount.

Show child attributes

description

string

Free-text description of the transaction.

taxAmount

number

The total amount of sales tax must be between: Visa: 0.1% - 18% MasterCard: 0.1% - 23% Default: 0.1% - 50%

taxWithHold

boolean

When true, the sales tax portion is withheld from the merchant's settlement until released.

dynamicFee

object

Fee added to the transaction at processing time and itemized separately.

Show child attributes

cvv

string

Card verification code (CVV/CVC).

referenceId

string

Your own reference for this transaction. Returned in responses and query results for reconciliation.

billing

object

Billing contact and address details for the payer.

Show child attributes

shipping

object

Shipping contact and address details for the order.

Show child attributes

metadata

object

metadata is an object that can host as much as 50 key-value pairs, where the keys can be at most 40 char length and can’t include the characters “[“ or “]”, and the values must be strings and cannot exceed 500 chars Learn more about metadata

Show child attributes

billingDescriptor

object

Overrides the descriptor that appears on the cardholder's statement.

Show child attributes

Response

200 - application/json

Successful sale

success

boolean

Whether the request was processed successfully. Declines return HTTP 200 with success: false.

data

object

The response payload.

Show child attributes

message

string

Human-readable result message.

code

string

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

Last modified on July 14, 2026

Delete a customer Authorize a card

⌘I

API Overview

API Reference

Resources

Process a card sale

Authorizations

Body

Response