Skip to content

Commit a8b340e

Browse files
authored
Merge pull request #154 from paytrail/payment-report-api-reportfields
Payment report api reportfields
2 parents af2748c + 595a9a2 commit a8b340e

1 file changed

Lines changed: 58 additions & 1 deletion

File tree

docs/paytrail-api.yaml

Lines changed: 58 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1968,7 +1968,7 @@ components:
19681968
properties:
19691969
type:
19701970
type: string
1971-
description: Card type, for example Visa
1971+
description: Card type, for example 'Visa'
19721972
example: Visa
19731973
partial_pan:
19741974
type: string
@@ -2288,6 +2288,11 @@ components:
22882288
shopInShopCommission,
22892289
shopInShopCommissionVatPercentage,
22902290
shopInShopCommissionVatAmount,
2291+
settlementReference,
2292+
transactionId,
2293+
settlementDueDate,
2294+
companyName,
2295+
vatId,
22912296
refunditems,
22922297
tradeitems,
22932298
]
@@ -2643,6 +2648,13 @@ components:
26432648
shopInShopCommission,
26442649
shopInShopCommissionVatPercentage,
26452650
shopInShopCommissionVatAmount,
2651+
settlementReference,
2652+
transactionId,
2653+
settlementDueDate,
2654+
companyName,
2655+
vatId,
2656+
refunditems,
2657+
tradeitems,
26462658
]
26472659
submerchant:
26482660
type: integer
@@ -2785,6 +2797,51 @@ components:
27852797
type: string
27862798
description: Contains a `|` (pipe) -delimited list of *stamp*:*amount* pairs. Pairs are delimited by a `:` (colon). Stamp refers to the payment item's stamp that was refunded.
27872799
example: 'stamp1:400|stamp2:200'
2800+
settlementReference:
2801+
type: string
2802+
description: Settlement reference
2803+
example: '45667372'
2804+
transactionId:
2805+
type: string
2806+
description: Assigned transaction ID for the payment
2807+
example: '5770642a-9a02-4ca2-8eaa-cc6260a78eb6'
2808+
settlementDueDate:
2809+
type: string
2810+
description: When the payment settlement is due
2811+
format: DD-MM-YYYY
2812+
example: '2019-04-10'
2813+
tradeitems:
2814+
type: array
2815+
description: Trade items included in the payment
2816+
items:
2817+
type: object
2818+
properties:
2819+
stamp:
2820+
type: string
2821+
description: Payment item stamp
2822+
amount:
2823+
type: number
2824+
description: Item amount in cents
2825+
description:
2826+
type: string
2827+
description: Item description
2828+
vat:
2829+
type: number
2830+
description: VAT percentage
2831+
code:
2832+
type: string
2833+
description: Product code
2834+
quantity:
2835+
type: number
2836+
description: Quantity
2837+
companyName:
2838+
type: string
2839+
description: Company name
2840+
example: 'Example company'
2841+
vatId:
2842+
type: string
2843+
description: Company VAT ID in international format
2844+
example: 'FI02454583'
27882845

27892846
GroupedPaymentProvidersResponse:
27902847
description: List grouped providers response body

0 commit comments

Comments
 (0)