Credit cards

List all credit card bills

Returns an array containing all credit card bills for all of your customers.

get/v1/credit_card_bills

Query parameters

page[size]integer

Specifies the number of results to return on each page.

page[number]integer

Specifies the number of results pages to return.

filter[application_id]string

Filters the results by credit card application ID (i.e., returns all bills related to a specific credit card).

filter[status]string

Filters the results by status.

filter[statement_date][min]string

Returns all credit card bills on or after the provided date.

filter[statement_date][max]string

Returns all credit card bills with a statement date up to the given date.

Response

List of bills for a credit card account

idstring

Unique ID of the credit card bill.

application_idstring

Unique ID of the credit card application with which the bill is associated.

status'PENDING' | 'PRELIMINARILY_PAID' | 'PAID' | 'IN_DUNNING' | 'CLOSED'

The current status of the credit card bill.

dunning_status'OPEN' | 'PAUSED' | 'CLOSED'

Optional dunning status of the credit card bill.

start_datestring date

The billing cycle start date.

end_datestring date

The billing cycle end date.

statement_datestring date

Date when the statement was issued.

due_datestring date

Date when payment for this bill is due.

sdd_collection_datestring date

Date when the SEPA Direct Debit for collecting the payment will occur.

repayment_type'FULL' | 'PARTIAL'

The type of credit card. Possible options are FULL (charge) and PARTIAL (revolving).

minimum_percentageinteger

The minimum percentage of the outstanding balance to be repaid each billing cycle.

grace_period_in_daysinteger

Indicates number of days in the grace period for paying off the required amount in each billing cycle.

postbox_item_idstring

ID of the Postbox item that corresponds with the credit card bill.

Example response

[
  {
    "id": "8d298774499c44349e3f2e98ba408e74",
    "application_id": "a8cafe0c24e949c78bfbea04cb5b2905ccla",
    "status": "PENDING",
    "dunning_status": "OPEN",
    "start_date": "2022-04-01",
    "end_date": "2022-04-30",
    "statement_date": "2022-05-01",
    "due_date": "2022-05-15",
    "sdd_collection_date": "2022-05-16",
    "previous_bill_amount": {
      "value": 100,
      "unit": "cents",
      "currency": "EUR"
    },
    "current_bill_amount": {
      "value": 100,
      "unit": "cents",
      "currency": "EUR"
    },
    "total_outstanding_amount": {
      "value": 100,
      "unit": "cents",
      "currency": "EUR"
    },
    "minimum_due_amount": {
      "value": 100,
      "unit": "cents",
      "currency": "EUR"
    },
    "outstanding_sddr_amount": {
      "value": 100,
      "unit": "cents",
      "currency": "EUR"
    },
    "outstanding_amount": {
      "value": 100,
      "unit": "cents",
      "currency": "EUR"
    },
    "repayment_type": "FULL",
    "minimum_amount": {
      "value": 100,
      "unit": "cents",
      "currency": "EUR"
    },
    "minimum_percentage": 3,
    "grace_period_in_days": 15,
    "dunning_fees": {
      "value": 100,
      "unit": "cents",
      "currency": "EUR"
    },
    "other_fees": {
      "value": 100,
      "unit": "cents",
      "currency": "EUR"
    },
    "accumulated_interest_amount": {
      "value": 100,
      "unit": "cents",
      "currency": "EUR"
    },
    "postbox_item_id": "c072c6e43f4d486cb553e9cd9fc1bae7pbxi"
  }
]