Sign in

v1

latestOpenAPI 3.1.02026-07-24170121.2 MB

Post Auth

post/v2/Transactions

Headers

Acceptstring required

Indicates which content types, expressed as MIME types, the client is able to understand.

Content-Typestring required

Indicates the media type of the resource sent in the HTTP message body. <br /><br /><b>Possible Values:</b><br /> application/json<br />application/x-www-form-urlencoded

Request body

TransTypestring required
<table style='width: 100%; border-collapse: collapse;'><tr><td style='text-align: center;'><b>Type</b></td><td style='text-align: center;'><b>Format</b></td><td style='text-align: center;'><b>Allowed Values</b></td></tr><tr><td>String</td><td>Alpha</td><td>POSTAUTH</td></tr></table>
ECRRefNumstring required

Unique code for this transaction provided by the user. This code will be used later for voids.<br><table style='width: 100%; border-collapse: collapse;'><tr><td style='text-align: center;'><b>Type</b></td><td style='text-align: center;'><b>Format</b></td></tr><tr><td>String</td><td>Alphanumeric</td></tr></table>

OrigRefNumstring required

This number is obtained from the paymentResponse object from an auth transaction.<br><table style='width: 100%; border-collapse: collapse;'><tr><td style='text-align: center;'><b>Type</b></td><td style='text-align: center;'><b>Format</b></td></tr><tr><td>String</td><td>Alphanumeric</td></tr></table>

Amountstring required

Amount to capture. Cannot exceed auth amount. If you need to exceed the auth amount, perform another sale and the auth will fall off.<br><table style='width: 100%; border-collapse: collapse;'><tr><td style='text-align: center;'><b>Type</b></td><td style='text-align: center;'><b>Format</b></td><td style='text-align: center;'><b>Examples</b></td></tr><tr><td>Decimal</td><td>Decimal</td><td>99.99</td></tr></table>

DeviceSerialNostring required

Serial number of your terminal.<br><table style='width: 100%; border-collapse: collapse;'><tr><td style='text-align: center;'><b>Type</b></td><td style='text-align: center;'><b>Format</b></td></tr><tr><td>String</td><td>Alphanumeric</td></tr></table>

CallbackURLstring required

A user provided URL of your webhook endpoint that will receive the response from Payarc.<br><table style=width:100%;border-collapse:collapse><tr><td style=text-align:center><b>Type</b><td style=text-align:center><b>Format</b><td style=text-align:center><b>Max Length</b><tr><td>String<td>Alphanumeric<td>500 characters</table>

Response

200

TraceIdstring
ErrorCodeinteger
ErrorMessagestring

Example response

{
  "TraceId": "string",
  "ErrorMessage": "Transaction initiated."
}