Provides stored information for a specific batch identified by its settlementId.
Production Request
curl -X GET -u "login:password" -H "Accept: application/json" -H "X-PJ-Application-Key: YOUR_PRODUCTION_APP_KEY" \
"https://api.payjunction.com/settlements/477"
Sandbox Request
curl -X GET -u "pj-ql-01:pj-ql-01p" -H "Accept: application/json" -H "X-PJ-Application-Key: YOUR_LABS_APP_KEY" \
"https://api.payjunctionlabs.com/settlements/477"
Example Response
{
"settlementId": 477,
"terminalId": 11495,
"created": "2018-08-28T00:00:04Z",
"amountNet": 3493.44,
"status": "COMPLETE",
"breakdown": [
{
"brand": "MASTERCARD",
"action": "CHARGE",
"status": "CAPTURED",
"count": 10,
"amount": 1100.05
},
{
"brand": "VISA",
"action": "CHARGE",
"status": "CAPTURED",
"count": 15,
"amount": 5500.50
},
{
"brand": "VISA",
"action": "REFUND",
"status": "CAPTURED",
"count": 5,
"amount": 3107.11
}
]
}
Response Fields
| Name | Format | Description |
|---|---|---|
| settlementId | numeric | The identifier for the settled batch. |
| terminalId | numeric | The identifier for the terminal/account the batch was settled to. |
| created | date | The date and time (in UTC) the batch was settled. |
| amountNet | money | A signed (positive or negative) amount representing the sum of all charges and refunds. |
| status | string |
COMPLETE - transactions have been settled with the card issuing bank. PENDING - transactions are in the process of being settled with the card issuing bank. |
| breakdown | array |
An array of objects describing the charges and refunds for each card brand (e.g. Visa, MasterCard, Discover, Amex) and each status (CAPTURED, VOID or DECLINED) present in each batch. |
Breakdown Format
| Name | Format | Description |
|---|---|---|
| brand | string |
Possible values are: VISA MASTERCARD DISCOVER AMERICAN_EXPRESS CHECKING SAVINGS OTHER
|
| action | string |
CHARGE REFUND |
| status | string |
CAPTURED VOID DECLINED REJECT |
| count | numeric | The number of transactions matching the card brand, action, and status types |
| amount | numeric | The gross volume of the applicable transactions. Unlike amountNet, this value will be positive regardless if it is a charge or a refund. |