Get payments on specific application

GET 
/financing/v1/applications/:applicationId/payments

Get payments on specific application

List of realized payments from Skip Pay to partner. In case of multiple invoices, list may contain more items.

feature	supported by resource
pagingheader-paging	yes
sortingheader-sorting	no
filteringheader-filtering	no

This resource supports paging. As a value to before and after parameters, use paymentId attribute.

Collection is sorted by paymentId attribute.

Request

Path Parameters

applicationId stringrequired

applicationId

Responses

200

List of payments. May be empty if no payment was processed yet.

application/json

Schema

Schema

data

object[]

required

Array [

paymentId stringrequired

unique payment identifier

date daterequired

Payment date

applicationId stringrequired

Application ID that this payment belongs to

value

object

required

Financial amount

amount numberrequired

Amount in minor units (12590 represents 125,90 CZK) ISO 4217

currency stringrequired

Amount currency. ISO 4217 (only CZK and EUR values are allowed)

invoice

object

Billing information, to be included in invoice.

fullName stringnullable

Customer full name, including academical degrees and salutation (Mr./Mrs./..). Empty if requested via customerDueDateCategory.

address

object

Address

name stringnullable

Possible values: <= 100 characters

Name on address

country stringrequired

Country. (see ISO 3166 alpha-2)

city stringrequired

Possible values: <= 100 characters

City

streetAddress stringrequired

Possible values: <= 100 characters

Street/city part

streetNumber stringnullable

Possible values: <= 100 characters

Street number

zip stringrequired

Possible values: <= 30 characters

Postal code

addressType addressTyperequired

Possible values: [PERMANENT, CONTACT, DELIVERY, BILLING]

Type of the address. Only some of the types are allowed in each context.

dueDate daterequired

Invoice due date.

accountNumber

object

required

Account number with bank code.

accountNumber stringrequired

Account number (IBAN, BIC, etc.).

bankCode stringrequired

Bank code (SWIFT, etc.).

]

pagingInfo

object

itemsPerPage numberrequired

Number of items per page

nextPage string

Request to retrieve next page, if it exists and can be unambiguously specified

prevPage string

Request to retrieve previous page, if it exists and can be unambiguously specified

Example (from schema)

{
  "data": [
    {
      "paymentId": "1a12",
      "date": "2017-05-20",
      "applicationId": "11200a0ee1",
      "value": {
        "amount": 12590,
        "currency": "CZK"
      },
      "invoice": {
        "fullName": "Ing. Jan Novák, Csc.",
        "address": {
          "name": "John Doe",
          "country": "CZ",
          "city": "Prague",
          "streetAddress": "Letenská",
          "streetNumber": "22",
          "zip": "140 00",
          "addressType": "PERMANENT"
        },
        "dueDate": "2017-06-20",
        "accountNumber": {
          "accountNumber": "123-123456789",
          "bankCode": "0100"
        }
      }
    }
  ],
  "pagingInfo": {
    "itemsPerPage": 10,
    "nextPage": "transactions?sort=category&limit=10&after=25",
    "prevPage": "transactions?sort=category&limit=10&before=25"
  }
}

404

Application does not exist

application/json

Schema

Schema

errors

object[]

required

Array with errors

Array [

code stringrequired

Unique internal error code

message stringrequired

Human readable error description (non-localized)

severity Severityrequired

Possible values: [ERROR, WARN, INFO]

attribute string

JSON path of request attribute that caused the error (if applicable)

ticketId string

Internal ticket ID, used for error backtracking

]

Example (from schema)

{
  "errors": [
    {
      "code": "ERR_1000_SOME_ERROR_CODE",
      "message": "Some error/validation message description",
      "severity": "ERROR",
      "attribute": "personalBirthNumber",
      "ticketId": "UAT1:AMS:20160516-091658.450:45e4"
    }
  ]
}

Loading...