Credit Card Authorization

Authorizes transaction immediately but is not flagged for settlement. Authorized transactions must be capture to settle.
post
https://<PayEngine-host>
/api/payment/auth

Sample Request / Response

Request
Response

Example Request

{
"merchant_id": "a447b0b8-0dbb-4e07-bfc2-c35bba8d71e8",
"data": {
"transactionAmount": "110.00",
"cardToken": "card_sandbox_xxxx"
}
}

Example Response

{
"data": {
"ID": "bf9a0bf0-34f6-48f6-8329-db0ea0fc2b03",
"TransactionID": "93fb1936-9381-422a-a66d-32c2277bc5f7",
"MerchantID": "8357832f-79c9-48fd-9647-d1dae251e434",
"AuthResponse": {
"status": "PASS",
"responseCode": "A0000",
"responseMessage": "Success",
"authCode": 511728,
"hostReferenceNumber": "236879761011",
"hostResponseCode": "00",
"taskID": "76451910",
"transactionID": "47541494",
"transactionTimestamp": "2022-05-16T05:01:21",
"transactionAmount": "100.00",
"processedAmount": "100.00",
"totalAmount": "100.00",
"addressVerificationCode": "Z",
"cardHolderVerificationCode": "N",
"cardType": "V",
"maskedCardNumber": "1111",
"customerReceipt": " Moore - Legros \\n Stark Flats \\n Hirtheland, RI 90001 \\n 2022-05-16T05:01:21 \\n CREDIT - SALE \\n CARD # : **** **** **** 1111 \\n CARD TYPE: V \\n Entry Mode : MANUAL \\n TRANSACTION ID : 47541494 \\n Invoice Number: 47541494 \\n AUTH CODE : DSC633 \\n Subtotal: $100.00 \\n Total: $100.00 \\n--------------------------------------\\n \\n \\n CUSTOMER ACKNOWLEDGES RECEIPT OF \\nGOODS AND/OR SERVICES IN THE AMOUNT \\nOF THE TOTAL SHOWN HEREON AND AGREES\\nTO PERFORM THE OBLIGATIONS SET FORTH\\nBY THE CUSTOMER`S AGREEMENT WITH THE\\n ISSUER \\n APPROVED \\n \\n \\n Customer Copy \\n",
"merchantReceipt": " Moore - Legros \\n Stark Flats \\n Hirtheland, RI 90001 \\n 2022-05-16T05:01:21 \\n CREDIT - SALE \\n CARD # : **** **** **** 1111 \\n CARD TYPE: V \\n Entry Mode : MANUAL \\n TRANSACTION ID : 47541494 \\n Invoice Number: 47541494 \\n AUTH CODE : DSC633 \\n Subtotal: $100.00 \\n Total: $100.00 \\n--------------------------------------\\n \\n \\n CUSTOMER ACKNOWLEDGES RECEIPT OF \\nGOODS AND/OR SERVICES IN THE AMOUNT \\nOF THE TOTAL SHOWN HEREON AND AGREES\\nTO PERFORM THE OBLIGATIONS SET FORTH\\nBY THE CUSTOMER`S AGREEMENT WITH THE\\n ISSUER \\n APPROVED \\n \\n \\n Merchant Copy \\n"
}
}
}
Webhook event: PAYMENT_AUTH

Webhook Payload Example

{
event_uid: '4d304a4ed5a4e338b4753ab832efd9c0',
event: 'PAYMENT_AUTH',
data: {
account_id: 'e90c1de6-4e87-4c9e-bcbc-c535d6e349ec',
payment_id: '41c4772c-aa78-41d2-b60b-52de07ec6df2',
merchant_id: 'c404d923-226f-4aae-92da-22c1ef370434',
transaction_id: '549f998c-2733-4c75-9420-17d097e95156',
auth_response: {
status: 'PASS',
taskID: '37549653',
authCode: 'DSC633',
cardType: 'V',
totalAmount: '75.48',
responseCode: 'A0000',
transactionID: '12544747',
customerReceipt: '<Printable Customer Receipt>',
merchantReceipt: '<Printable Customer Receipt>',
processedAmount: '75.48',
responseMessage: 'Success',
hostResponseCode: '00',
maskedCardNumber: '1111',
transactionAmount: '75.48',
hostReferenceNumber: '937213156263',
transactionTimestamp: '2022-02-04T20:59:24',
addressVerificationCode: 'Z',
cardTransactionIdentifier: '123456789012345',
cardHolderVerificationCode: 'N'
}
}
}