Documentation API Reference Ask AI Assistant

Settlement

PreviousRecurring Schedule NextText to Pay

Last updated 2 months ago

Was this helpful?

Execute selective batch settlement

post

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

TransactionIDsinteger[]Optional

List of transaction IDs to be settled

Example: [52]

MerchIDintegerOptional

The merchant identifier

Example: 1

Responses

post

POST /APIcardProcREST/v1.0.0/Settlement/ExecuteBatch_Selective HTTP/1.1
Host: easypay5.com
SessKey: A1842D663E9A4A72XXXXXXXX303541303234373138
Content-Type: application/json
Accept: application/json
Content-Length: 35

{
  "TransactionIDs": [
    52
  ],
  "MerchID": 1
}

200

Successfully executed batch settlement

{
  "Settlement_ExecuteBatch_SelectiveResult": {
    "BatchResult": {
      "BatchClose": "0720191352",
      "BatchLogID": 103,
      "BatchNetAmount": 10,
      "BatchNum": 3,
      "BatchOpen": "0720191352",
      "BatchTransCount": 1,
      "Code": "A",
      "RemainingUnsettled": 0,
      "ResultText": "OK 003 0720 0000                ",
      "TxLock": "7A639CD720CE4B14"
    },
    "ErrCode": 0,
    "ErrMsg": "",
    "FunctionOk": true,
    "RespMsg": "Successful Settlement : OK 003 0720 0000                ",
    "SettlementApproved": true
  }
}

Execute batch settlement for all transactions

post

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

MerchIDintegerOptional

The merchant identifier

Example: 1

Responses

post

POST /APIcardProcREST/v1.0.0/Settlement/ExecuteBatch_All HTTP/1.1
Host: easypay5.com
SessKey: A1842D663E9A4A72XXXXXXXX303541303234373138
Content-Type: application/json
Accept: application/json
Content-Length: 13

{
  "MerchID": 1
}

200

Successfully executed batch settlement for all transactions

{
  "Settlement_ExecuteBatch_AllResult": {
    "BatchResult": {
      "BatchClose": "0720191352",
      "BatchLogID": 103,
      "BatchNetAmount": 10,
      "BatchNum": 3,
      "BatchOpen": "0720191352",
      "BatchTransCount": 1,
      "Code": "A",
      "RemainingUnsettled": 0,
      "ResultText": "OK 003 0720 0000                ",
      "TxLock": "7A639CD720CE4B14"
    },
    "ErrCode": 0,
    "ErrMsg": "",
    "FunctionOk": true,
    "RespMsg": "Successful Settlement : OK 006 0808 0000                ",
    "SettlementApproved": true
  }
}