All documentation

Processing Authorized Charges

Access Endpoint URL: https://rest.everyware.com/api/Default/ProcessAuthorization [POST]

The ProcesssAuthorization method allows for pre-authorized, validated charges to be processed or voided on your schedule.

Inbound Parameters

Parameters should be passed in a single JSON-body object.

Parameter Description Optional/Required
TransactionID The InvoiceID from the CreatePayment or CreateInvoice response.
    This can also be found in the  InvoiceID column of the "Process Authorizations" in Portal.
  </td><td>
    Required
  </td></tr><tr><td>
    ChargeType
  </td><td>
    Either "Capture" or "Void" will be entered in this parameter.  

    Capture: Completes the authorized transaction.  

    Void: Releases an authorized transaction.
  </td><td>
    Required
  </td></tr><tr><td>
    Amount
  </td><td>
    The total amount to capture or void.
  </td><td>
    Required
  </td></tr></tbody></table>

Sample Use Case 1: Capture Charges

{
  "TransactionID": "ch_3Ja1hfAawEMtODxF1hl11Sta",
  "ChargeType": "Capture",
  "Amount": "1.00"
}
curl --location 'https://rest.everyware.com/api/Default/processauthorization' \
--header 'Authorization: Basic [xxx]' \
--header 'Content-Type: application/json' \
--data-raw ' {
  "TransactionID": "ch_3Ja1hfAawEMtODxF1hl11Sta",
  "ChargeType": "Capture",
  "Amount": "1.00"
}
{
    "IsSuccess": true,
    "Message": "The credit card has been accepted.",
    "Data": "ch_3Ja1hfAawEMtODxF1hl11Sta",
    "OrderNumber": null
}

Sample Use Case 2: Void Charges

{
    "TransactionID": "ch_3JaTxbAawEMtODxF1m7CbS8Q",
    "ChargeType": "Void",
    "Amount": "1.00"
}
curl --location 'https://rest.everyware.com/api/Default/processauthorization' \
--header 'Authorization: Basic [xxx]' \
--header 'Content-Type: application/json' \
--data-raw ' {
    "TransactionID": "ch_3JaTxbAawEMtODxF1m7CbS8Q",
    "ChargeType": "Void",
    "Amount": "1.00"
}
{
    "IsSuccess": true,
    "Message": "The transaction has been voided.",
    "Data": null,
    "OrderNumber": null
}