v1

latestOpenAPI 3.1.02026-07-24320172.9 KB

Retrieve Payment groups by taxId

get/api/v2.0/accounts/{accountId}/payments/taxid/{taxId}

Path parameters

versionstring required

The current version of BaaSiC API

accountIdstring required

Target withdraw account identification

taxIdstring required

Field that uniquely identifies the individual or country. Only numbers accepted, all number should be sent, including leading zeros when applicable

Query parameters

taxIdCountry'ALB' | 'AND' | 'ARE' | 'ARG' | 'ARM' | 'AUS' | 'AUT' | 'AZE' | 'BEL' | 'BGR' | 'BHR' | 'BIH' | 'BLR' | 'BOL' | 'BRA' | 'CAN' | 'CHE' | 'CHL' | 'CHN' | 'COL' | 'CRI' | 'CUB' | 'CYP' | 'CZE' | 'DEU' | 'DNK' | 'DOM' | 'ECU' | 'ESP' | 'EST' | 'FIN' | 'FLK' | 'FRA' | 'FRO' | 'GBR' | 'GEO' | 'GRC' | 'GTM' | 'GUF' | 'GUY' | 'HKG' | 'HRV' | 'HUN' | 'IDN' | 'IND' | 'IRL' | 'ISL' | 'ISR' | 'ITA' | 'JPN' | 'KAZ' | 'KOR' | 'LTU' | 'LUX' | 'LVA' | 'MCO' | 'MDA' | 'MEX' | 'MKD' | 'MLT' | 'MNE' | 'MUS' | 'MYS' | 'NGA' | 'NLD' | 'NOR' | 'NZL' | 'PAK' | 'PER' | 'PHL' | 'POL' | 'PRT' | 'PRY' | 'ROU' | 'RUS' | 'SLV' | 'SMR' | 'SRB' | 'SUR' | 'SVK' | 'SVN' | 'SWE' | 'THA' | 'TUR' | 'TWN' | 'UKR' | 'URY' | 'USA' | 'UZB' | 'VEN' | 'ZAF'

The drawer's country

paymentStatusstring

Current payment status

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"
  }
]