As of API version 2020-04-21, the service field representing the specific PayJunction service used to process a transaction is included in the transaction details. This is primarily to allow integrators using the TRANSACTION webhook to enable different workflows depending on the service used, such as Hosted Payments.

Get a Transaction

Returns all of the transaction details.

API version 2023-05-16 or above required to receive the surcharge object and fields in transaction response details. See how to use API versions here.

Click here for more information regarding surcharge.

Example Response

{
      "transactionId": 3601, 
      "uri": "https://api.payjunction.com/transactions/3601", 
      "terminalId" : 10000,
      "action" : "CHARGE",
      "amountBase" : "1.11",
      "amountTax" : "3.00",
      "amountShipping" : "1.00",
      "amountTip" : "2.00",
      "amountSurcharge" : "0.21",
      "amountTotal" : "7.32",
      "surcharge" : {
            "percentage" : 3.00000,
            "status" : "APPLIED"
      },
      "custom1": "88888888444444444444cccccccccccc",
      "invoiceId": "6de5394f-5e3b-469e-bc19-01fcc27c2724",
      "invoiceNumber": "Invoice 5", 
      "purchaseOrderNumber": "Custom PO", 
      "method": "KEYED",
      "service": "RECURRING",
      "status": "CAPTURE",
      "signatureStatus": "SIGNED", 
      "created": "2013-11-18T22:15:32Z", 
      "lastModified": "2013-11-18T22:15:32Z", 
      "response": {
            "approved": true, 
            "code": "00", 
            "message": "Approved", 
            "processor": {
                  "authorized": true, 
                  "approvalCode": "PJ20AP", 
                  "avs": {
                        "status": "REQUESTED", 
                        "requested": "BYPASS", 
                        "match": {
                              "ZIP": true, 
                              "ADDRESS": true
                        }
                  }, 
                  "cvv": {
                        "status": "NOT_REQUESTED"
                  }
            }
      }, 
      "settlement": {
            "settled": true, 
            "settlementId": 99
      }, 
      "vault": {
            "type": "CARD", 
            "accountType": "VISA", 
            "lastFour": "1111"
      }, 
      "billing": {
            "firstName": "John", 
            "middleName": "J", 
            "lastName": "Doe", 
            "companyName": "PayJunction", 
            "email": "jdoe@payjunction.com", 
            "phone": "8006010230 x2", 
            "phone2": "8006010230 x2", 
            "jobTitle": "Support", 
            "identifier": "Billing Customer id", 
            "website": "http://www.payjunction.com", 
            "address": {
                  "address": "1903 State St", 
                  "city": "Santa Barbara", 
                  "state": "CA", 
                  "country": "USA", 
                  "zip": "93101"
            }
      }, 
      "shipping": {
            "firstName": "Jane", 
            "middleName": "J", 
            "lastName": "Doe", 
            "companyName": "PayJunction", 
            "email": "janedoe@payjunction.com", 
            "phone": "8006010230 x2", 
            "phone2": "8006010230 x2", 
            "jobTitle": "Support", 
            "identifier": "Shipping Customer Id", 
            "website": "https://www.payjunction.com", 
            "address": {
                  "address": "1903 State St", 
                  "city": "Santa Barbara", 
                  "state": "CA", 
                  "country": "USA", 
                  "zip": "93101"
            }
      }
}

Available Results for "service" Response

• API (Transactions processed directly through the REST API, without use of a Smart Terminal)
• SMART_TERMINAL (Any transaction processed through a Smart Terminal will display this value)
• QUICKSHOP (Transactions processed through the Hosted Payments secure checkout service)
• RECURRING (Transactions processed through the PayJunction Recurring or Schedules service)
• VIRTUAL_TERMINAL (Transactions processed directly by the merchant in the PayJunction Virtual Terminal's Card tab)
• MOBILE (Transactions processed using the PayJunction Mobile app on an iOS device)
• PHONE_CHARGE (Transactions processed using the legacy phone charge system)
• INVOICE (Transactions processed from an invoice)
  • An invoiceId pointing to the invoice object field is added to the response
    • e.g: "invoiceId": "6de5394f-5e3b-469e-bc19-01fcc27c2724" see response example above.

"service": "API|SMART_TERMINAL|QUICKSHOP|RECURRING|VIRTUAL_TERMINAL|MOBILE|PHONE_CHARGE|INVOICE",

Available Results for "method" Response

• KEYED (Manually entered to the system)
• SWIPED (Read from a swipe of a card)
• CHIP (Read via EMV chip).
• RECURRING (Previously saved payment ran as recurring).
• INSTANT (Recharged by Vault or recharged by transaction id)
• CONTACTLESS (Apple Pay, Android Pay, etc. Any "tap to pay" methods)

"method": "KEYED|SWIPED|CHIP|RECURRING|INSTANT|CONTACTLESS",

Available Results for "signatureStatus" Response

• PENDING (waiting for signature capture).
• NOT_REQUIRED (signature not required).
  • The card brand association did not require a signature.
    - OR -
  • A PIN was requested and verified.
• NOT_REQUESTED (a request for signature was not sent).
• SIGNED (transaction has a signature captured).

"signatureStatus": "PENDING|NOT_REQUIRED|NOT_REQUESTED|SIGNED",

API versions prior to 2019-12-09 returned NOT_REQUIRED_PIN instead of NOT_REQUIRED. The change to NOT_REQUIRED in API version 2019-12-09 more accurately reflects that a signature was not obtained either because a PIN was entered or because the card association rules did not require a signature to be collected to prove card holder authorization.

Available Card Brands for "vault" Response

These are all of the available card brands (accountType) that are returned in the response for "vault".

• AMERICAN_EXPRESS
• DEBIT
• DISCOVER
• DINERS
• GENERAL_LEDGER
• JCB
• MASTERCARD
• UNKNOWN
• VISA

Card Transactions

"vault": {
     "type": "CARD", 
     "accountType": "AMERICAN_EXPRESS|DEBIT|DISCOVER|DINERS|GENERAL_LEDGER|JCB|MASTERCARD|UNKNOWN|VISA", 
     "lastFour": "1111"
},

Available Results for for Surcharge Enabled Transactions

API version 2023-05-16 or above required to receive the surcharge object and fields in transaction response details.
Click here for more information regarding surcharge.

See how to use API versions here.

{
      "surcharge" : {
            "percentage" : 3.00000,
            "status" : "APPLIED|NOT_APPLIED_DEBIT"
      },
}

ACH Transactions

"vault": {
     "type": "ACH", 
     "accountType": "CHECKING|SAVINGS", 
     "lastFour": "1111",
     "achRoutingNumber": "121000358"     
},