GET
/
merchantAccounts
/
{merchantAccountId}
/
payinSettlements
/
{payinSettlementId}
Retrieve a Payin Settlement
curl --request GET \
  --url https://prod.api.palomma.com/v0/merchantAccounts/{merchantAccountId}/payinSettlements/{payinSettlementId} \
  --header 'Authorization: Bearer <token>'
{
  "id": "01HPR57X6QR5ZRKEEKBSDBW4RA",
  "merchantAccountId": "01HPR8S7YF43PV3QV16TZDC80P",
  "totalAmountCollected": 100000,
  "totalFees": 500,
  "numberOfPayins": 5,
  "payinSettlementDate": "2024-08-28",
  "payinSettlementCycle": 11,
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
merchantAccountId
string
required

Unique identifier of the merchant account.

​
payinSettlementId
string
required

Unique identifier of the payin settlement.

Response

Payin Settlement retrieved successfully.

​
id
string

Unique identifier for this Payin Settlement.

Example:

"01HPR57X6QR5ZRKEEKBSDBW4RA"

​
merchantAccountId
string

Reference to Merchant Account to which the Payin Settlement belongs.

Example:

"01HPR8S7YF43PV3QV16TZDC80P"

​
totalAmountCollected
number

Total amount collected by payins included in the Payin Settlement.

Example:

100000

​
totalFees
number

Total fees associated to payins included in the Payin Settlement.

Example:

500

​
numberOfPayins
number

Total number of payins included in the Payin Settlement.

Example:

5

​
payinSettlementDate
string

Date of the Payin Settlement.

Example:

"2024-08-28"

​
payinSettlementCycle
number

Cycle of the Payin Settlement. It can be one of the five cycles of the day: 11, 13, 16, 18, 20, corresponding to the hour in the day when the payin settlement was created.

Example:

11

​
createdAt
string<date-time>

ISO string indicating when the Payin Settlement was created.

​
updatedAt
string<date-time>

ISO string indicating when the Payin Settlement was last updated.