Update a Transaction
Send the parameters that you want to update. All other parameters will remain the same
Note: Transaction Fields can only be Updated before settlement, whereas Billing Contact fields, Shipping Contact fields; invoiceNumber; purchaseOrderNumber can be updated Anytime. Fields not listed in the tables below can Never be updated.
Parameters
Transaction Fields
| required | name | format | description | when |
|---|---|---|---|---|
| status | HOLD | CAPTURE | VOID | Transaction Status affects whether or not the transaction will be settled. More Details | Before Settlement | |
| amountBase | Money, Format: X.XX Ex: 1000.00 |
Base amount to charge. | Before Settlement | |
| amountShipping | Money, Format: X.XX Ex: 1000.00 |
If you want to track separate shipping amounts use this parameter. | Before Settlement | |
| amountTip | Money, Format: X.XX Ex: 1000.00 |
If you want to add a tip to the transaction then use this parameter. | Before Settlement | |
| amountReject | Money, Format: X.XX Ex: 1000.00 |
If you are re-billing a rejected ACH transaction and you want to charge a reject fee then use this parameter. | Before Settlement | |
| amountTax | Money, Format: X.XX Ex: 1000.00 |
If you are billing tax then use this parameter. | Before Settlement | |
| amountSurcharge | Money, Format: X.XX Ex: 1000.00 |
If you want to add a surcharge to the transaction then use this parameter. | Before Settlement |
Billing Contact
| required | name | format | description | when |
|---|---|---|---|---|
| billingIdentifier | Max Length 64 | Billing customer id. If you have your own customer ID you want to associate with the transaction. | Anytime | |
| billingFirstName | Max Length 16 | Billing first name. | Anytime | |
| billingLastName | Max Length 32 | Billing last name. | Anytime | |
| billingCompanyName | Max Length 64 | Billing company name. | Anytime | |
| billingJobTitle | Max Length 32 | Billing job title. Ex: President | Anytime | |
| billingPhone | Max Length 24 | Billing phone number. | Anytime | |
| billingPhone2 | Max Length 24 | Billing alternate phone number. | Anytime | |
| billingAddress | Max Length 128 | Billing street address. | Anytime (AVS won't run again) |
|
| billingCity | Max Length 32 | Billing city. | Anytime | |
| billingState | Max Length 32 | Billing state. | Anytime | |
| billingZip | Max Length 12 | Billing zip. | Anytime (AVS won't run again) |
|
| billingCountry | Max Length 32 | Billing country. | Anytime | |
| billingEmail | Max Length 128 | Billing email. | Anytime | |
| billingWebsite | Max Length 128 | Billing website. | Anytime |
Shipping Contact
| required | name | format | description | when |
|---|---|---|---|---|
| shippingIdentifier | Max Length 64 | Shipping customer id. If you have your own customer ID you want to associate with the transaction. | Anytime | |
| shippingFirstName | Max Length 16 | Shipping first name. | Anytime | |
| shippingMiddleName | Max Length 32 | Shipping middle name. | Anytime | |
| shippingLastName | Max Length 32 | Shipping last name. | Anytime | |
| shippingCompanyName | Max Length 64 | Shipping company name. | Anytime | |
| shippingJobTitle | Max Length 32 | Shipping job title. Ex: President | Anytime | |
| shippingPhone | Max Length 24 | Shipping phone number | Anytime | |
| shippingPhone2 | Max Length 24 | Shipping alternate phone number. | Anytime | |
| shippingAddress | Max Length 128 | Shipping street address. | Anytime | |
| shippingCity | Max Length 32 | Shipping city. | Anytime | |
| shippingState | Max Length 32 | Shipping state | Anytime | |
| shippingZip | Max Length 12 | Shipping zip. | Anytime | |
| shippingCountry | Max Length 32 | Shipping country. | Anytime | |
| shippingEmail | Shipping email address. | Shipping email address. | Anytime | |
| shippingWebsite | Max Length 128 | Shipping website. | Anytime |
Other Fields
| required | name | format | description | when |
|---|---|---|---|---|
| invoiceNumber | Max Length 32 | Invoice number. If would would like to mark this transaction with your own invoice number for accounting. | Anytime | |
| purchaseOrderNumber | Max Length 32 | Purchase order number. If you would like to mark this transaction with your own PO for accounting. | Anytime |
Example Response
API version 2020-04-13 or above required to receive the service field in transaction response details.
API version 2023-05-16 or above required to receive the surcharge object and fields in transaction response details. Additionally, all businesses that are interested in applying a surcharge on transactions must first contact PayJunction's customer support team and submit a request to enable Surcharge on their account.
{
"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"
},
"invoiceNumber": "Invoice 5",
"method": "KEYED",
"purchaseOrderNumber": "Custom PO",
"service": "QUICKSHOP",
"signatureStatus": "SIGNED",
"status": "CAPTURE",
"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": false
},
"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"
}
}
}