Card Operations

Process a refund to a settled charge

post

Use this call to process a refund to a settled charge. You will need the Transaction ID and the amount to be refunded.

Header parameters

SessKeystringRequired

A unique session key used for authentication in API calls. This key is generated upon successful authentication and must be included in all subsequent requests.

Example: A1842D663E9A4A72XXXXXXXX303541303234373138

Content-TypestringRequiredExample: application/json

AcceptstringRequiredExample: application/json

Body

TxIDintegerOptional

Transaction ID of the charge to be refunded

Example: 56

CreditAmountnumber · floatOptional

Amount to be refunded

Example: 5

Responses

post

HTTPcURLJavaScriptPython

POST /APIcardProcREST/v1.0.0/CardSale/ApplyCredit HTTP/1.1
Host: easypay5.com
SessKey: A1842D663E9A4A72XXXXXXXX303541303234373138
Content-Type: application/json
Accept: application/json
Content-Length: 28

{
  "TxID": 56,
  "CreditAmount": 5
}

200

Successful processing of the refund

{
  "Transaction_ApplyCreditResult": {
    "ErrCode": 0,
    "ErrMsg": "",
    "FunctionOk": true,
    "RespMsg": "Successful Credit Pending Transaction ID : 000057",
    "TxApproved": true,
    "TxID": 57
  }
}

Void a pending charge

post

Use this call to void a pending charge. The status of the transaction needs to be OPEN, such as transactions that have not settled yet. To refund a transaction that was previously settled, use the Credit method. You will need the Transaction ID of the charge to be voided.

Header parameters

SessKeystringRequired

A unique session key used for authentication in API calls. This key is generated upon successful authentication and must be included in all subsequent requests.

Example: A1842D663E9A4A72XXXXXXXX303541303234373138

Content-TypestringRequiredExample: application/json

AcceptstringRequiredExample: application/json

Body

TxIDintegerOptional

Transaction ID of the charge to be voided

Example: 53

Responses

post

HTTPcURLJavaScriptPython

POST /APIcardProcREST/v1.0.0/CardSale/Void HTTP/1.1
Host: easypay5.com
SessKey: A1842D663E9A4A72XXXXXXXX303541303234373138
Content-Type: application/json
Accept: application/json
Content-Length: 11

{
  "TxID": 53
}

200

Successful voiding of the transaction

{
  "Transaction_VoidResult": {
    "ErrCode": 0,
    "ErrMsg": "",
    "FunctionOk": true,
    "RespMsg": "Successful Transaction Void TxID : 53 [097706]",
    "TxApproved": true,
    "TxID": 53
  }
}