Processing Authorized Charges
Endpoint Access 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
Parameter | Description | Required/Not |
---|---|---|
TransactionID | The InvoiceID from CreatePayment or CreateInvoice response. You can also find this in the Everyware portal Process Authorizations page table in the InvoiceID column. | REQUIRED |
ChargeType | Void: Releases an authorized transaction Capture: Completes/Captures the authorized transaction | REQUIRED |
Amount | Total Amount to capture or void. | REQUIRED |
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
}
Updated about 2 months ago