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

1
{
2
"merchant_id": "a447b0b8-0dbb-4e07-bfc2-c35bba8d71e8",
3
"data": {
4
"transactionAmount": "110.00",
5
"cardToken": "card_sandbox_xxxx"
6
}
7
}
Copied!

Example Response

1
{
2
"data": {
3
"ID": "bf9a0bf0-34f6-48f6-8329-db0ea0fc2b03",
4
"TransactionID": "93fb1936-9381-422a-a66d-32c2277bc5f7",
5
"MerchantID": "8357832f-79c9-48fd-9647-d1dae251e434",
6
"AuthResponse": {
7
"status": "PASS",
8
"responseCode": "A0000",
9
"responseMessage": "Success",
10
"authCode": 511728,
11
"hostReferenceNumber": "236879761011",
12
"hostResponseCode": "00",
13
"taskID": "76451910",
14
"transactionID": "47541494",
15
"transactionTimestamp": "2022-05-16T05:01:21",
16
"transactionAmount": "100.00",
17
"processedAmount": "100.00",
18
"totalAmount": "100.00",
19
"addressVerificationCode": "Z",
20
"cardHolderVerificationCode": "N",
21
"cardType": "V",
22
"maskedCardNumber": "1111",
23
"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",
24
"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"
25
}
26
}
27
}
Copied!
Webhook event: PAYMENT_AUTH

Webhook Payload Example

1
{
2
event_uid: '4d304a4ed5a4e338b4753ab832efd9c0',
3
event: 'PAYMENT_AUTH',
4
data: {
5
account_id: 'e90c1de6-4e87-4c9e-bcbc-c535d6e349ec',
6
payment_id: '41c4772c-aa78-41d2-b60b-52de07ec6df2',
7
merchant_id: 'c404d923-226f-4aae-92da-22c1ef370434',
8
transaction_id: '549f998c-2733-4c75-9420-17d097e95156',
9
auth_response: {
10
status: 'PASS',
11
taskID: '37549653',
12
authCode: 'DSC633',
13
cardType: 'V',
14
totalAmount: '75.48',
15
responseCode: 'A0000',
16
transactionID: '12544747',
17
customerReceipt: '<Printable Customer Receipt>',
18
merchantReceipt: '<Printable Customer Receipt>',
19
processedAmount: '75.48',
20
responseMessage: 'Success',
21
hostResponseCode: '00',
22
maskedCardNumber: '1111',
23
transactionAmount: '75.48',
24
hostReferenceNumber: '937213156263',
25
transactionTimestamp: '2022-02-04T20:59:24',
26
addressVerificationCode: 'Z',
27
cardTransactionIdentifier: '123456789012345',
28
cardHolderVerificationCode: 'N'
29
}
30
}
31
}
Copied!