Documentation API Reference Ask AI Assistant

Settlement

PreviousRecurring Schedule NextText to Pay

Last updated 16 days ago

Was this helpful?

Execute selective batch settlement

post

/APIcardProcREST/v1.0.0/Settlement/ExecuteBatch_Selective

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-Typestringrequired

Example: application/json

Acceptstringrequired

Example: application/json

Body

MerchIDinteger

The merchant identifier

Example: 1

TransactionIDsinteger[]

List of transaction IDs to be settled

Example: [52]

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://easypay5.com/APIcardProcREST/v1.0.0/Settlement/ExecuteBatch_Selective' \
  --header 'SessKey: A1842D663E9A4A72XXXXXXXX303541303234373138' \
  --header 'Content-Type: application/json' \
  --header 'Accept: application/json' \
  --data '{"MerchID":1,"TransactionIDs":[52]}'

200

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

Successfully executed batch settlement

Execute batch settlement for all transactions

post

/APIcardProcREST/v1.0.0/Settlement/ExecuteBatch_All

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-Typestringrequired

Example: application/json

Acceptstringrequired

Example: application/json

Body

MerchIDinteger

The merchant identifier

Example: 1

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://easypay5.com/APIcardProcREST/v1.0.0/Settlement/ExecuteBatch_All' \
  --header 'SessKey: A1842D663E9A4A72XXXXXXXX303541303234373138' \
  --header 'Content-Type: application/json' \
  --header 'Accept: application/json' \
  --data '{"MerchID":1}'

200

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

Successfully executed batch settlement for all transactions