v1

latestOpenAPI 3.1.02026-07-24320172.9 KB

Retrieve Payment groups by account

get/api/v2.0/accounts/{accountId}/paymentgroup

Path parameters

versionstring required

The current version of BaaSiC API

accountIdstring required

Target withdraw account identification

Query parameters

beginDatestring

Start date for range search of payment group. This field must follow one of the patterns: YYYY-MM-dd'T'HH:mm:ss or YYYY-MM-dd HH:mm:sszzz

endDatestring

Final date for range search of payment group. This field must follow one of the patterns: YYYY-MM-dd'T'HH:mm:ss or YYYY-MM-dd HH:mm:sszzz

limitinteger

The maximum number of items returned.

offsetinteger

The page for a pagination

Headers

Authorizationstring required

The personal authentication token obtained by each user from the token authentication endpoint

Response

200

paymentGroupIdstring

totalAmountinteger

totalAmountPaymentsCompletedWithSuccessinteger

numberOfPaymentsinteger

numberOfPaymentsPendinginteger

numberOfPaymentsProcessinginteger

numberOfPaymentsCompletedWithSuccessinteger

numberOfPaymentsCompletedWithErrorinteger

createdAtstring

createdAtDetailedstring

Example response

[
  {
    "paymentGroupId": "86571dbd-e97f-4552-ae9c-22f0e81abfba",
    "totalAmount": 4000,
    "numberOfPayments": 2,
    "numberOfPaymentsPending": 1,
    "numberOfPaymentsProcessing": 1,
    "createdAt": "2020-05-14",
    "createdAtDetailed": "0001-01-01T12:00:00Z"
  }
]