Get Partner Savings Payments

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Query Parameters

userId*string

Identifier of the partner user whose payments are requested

Formatuuid

limit?integer

Default20

offset?integer

Default0

filter[status]?string

Value in

"pending"
"processing"
"processed"
"succeeded"
"failed"
"cancelled"

filter[transactionState]?string

Value in

"unconfirmed"
"confirmed"
"failed"

filter[periodDate]?string

Formatdate

filter[savingsPaymentStartDate]?string

Formatdate-time

filter[savingsPaymentEndDate]?string

Formatdate-time

sort_by?string

Value in

"level"
"paymentAmount"
"paymentCurrencyCode"
"periodDate"
"status"
"transactionState"
"processedAt"
"createdAt"
"programName"

sort_order?string

Value in

"asc"
"desc"

Response Body

`application/json`

curl -X GET "https://example.com/partner/savings-payments?userId=497f6eca-6276-4993-bfeb-53cbbbba6f08"

{  "total": 0,  "savingsPayments": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "savingsClientAcquisitionId": "34dc90c8-8f0b-43d6-8d56-318197995c50",      "savingsProgramLevelId": "c6c2c896-9fd8-4581-9d56-07634224d20d",      "partnerUserId": "44fdac44-a971-4677-9dc8-ac85dc826fb3",      "clientExternalId": 0,      "savingsProgramId": "e85e6f4f-93e7-4ca2-b1e5-e56a2346eaa3",      "programName": "string",      "level": 0,      "periodDate": "2019-08-24",      "paymentAmount": "string",      "paymentCurrencyCode": "string",      "status": "pending",      "transactionState": "unconfirmed",      "confirmedAt": "2019-08-24T14:15:22Z",      "failedAt": "2019-08-24T14:15:22Z",      "externalOperationId": 0,      "failedPaymentId": 0,      "processedAt": "2019-08-24T14:15:22Z",      "createdAt": "2019-08-24T14:15:22Z",      "profile": {        "firstName": "string",        "middleName": "string",        "lastName": "string",        "contacts": [          {            "key": "string",            "value": "string"          }        ]      }    }  ]}

{  "message": "string",  "errors": {    "property1": [      "string"    ],    "property2": [      "string"    ]  }}

{  "message": "string",  "errors": {    "property1": [      "string"    ],    "property2": [      "string"    ]  }}

{  "message": "string",  "errors": {    "property1": [      "string"    ],    "property2": [      "string"    ]  }}

{  "message": "string",  "errors": {    "property1": [      "string"    ],    "property2": [      "string"    ]  }}

Get Partner Savings Payments

Authorization

Query Parameters

Response Body

200application/json

401application/json

422application/json

429application/json

503application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`