Skip to content

Commit

Permalink
Merge pull request #93 from paytrail/maksu-by-rahalaitos
Browse files Browse the repository at this point in the history 
Documentation for Maksu by Rahalaitos
  • Loading branch information
@pt-ossi
pt-ossi authored Oct 30, 2023
2 parents ff23ea0 + 741f95c commit 283ac26
Show file tree
Hide file tree
Showing 7 changed files with 62 additions and 63 deletions.
31 changes: 15 additions & 16 deletions docs/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -247,20 +247,20 @@ Get transaction info. Payments are reported primarily via callbacks, and impleme

#### Response

| Field | Type | Description |
| ------------- | ------- | -------------------------------------------------------------------------------------------------------------------- |
| transactionId | string | Assigned transaction ID for the payment |
| status | string | `new`, `ok`, `fail`, `pending`, or `delayed`. Statuses are described [above](#statuses). |
| amount | integer | Total amount of the payment in currency's minor units, e.g. for Euros use cents |
| currency | alpha3 | Currency |
| stamp | string | Merchant unique identifier for the order |
| reference | string | Order reference |
| createdAt | string | Transaction creation timestamp |
| href | string | If transaction is in status `new`, link to the hosted payment gateway |
| provider | string | If processed, the name of the payment method provider |
| filingCode | string | If paid, the filing code issued by the payment method provider if any. Some providers do not return the filing code. |
| paidAt | string | Timestamp when the transaction was paid |
| settlementReference | string | If payment is settled, corresponding settlement reference is included |
| Field | Type | Description |
| ------------------- | ------- | -------------------------------------------------------------------------------------------------------------------- |
| transactionId | string | Assigned transaction ID for the payment |
| status | string | `new`, `ok`, `fail`, `pending`, or `delayed`. Statuses are described [above](#statuses). |
| amount | integer | Total amount of the payment in currency's minor units, e.g. for Euros use cents |
| currency | alpha3 | Currency |
| stamp | string | Merchant unique identifier for the order |
| reference | string | Order reference |
| createdAt | string | Transaction creation timestamp |
| href | string | If transaction is in status `new`, link to the hosted payment gateway |
| provider | string | If processed, the name of the payment method provider |
| filingCode | string | If paid, the filing code issued by the payment method provider if any. Some providers do not return the filing code. |
| paidAt | string | Timestamp when the transaction was paid |
| settlementReference | string | If payment is settled, corresponding settlement reference is included |

See [example response](/examples#get) from examples tab.

Expand Down Expand Up @@ -787,7 +787,7 @@ A Shop-in-Shop aggregate merchant can also fetch its submerchant's payment repor
| limit | integer | <center></center> | `50000` | Limit the amount of payments included in the report. Maximum 50000. |
| reportFields | string[] | <center></center> | all | Limit the fields that will be included in the report. Leaving this empty will include all fields. Possible values: `entryDate`, `created`, `amount`, `status`, `firstname`, `familyname`, `description`, `reference`, `paymentMethod`, `stamp`, `address`, `postcode`, `postoffice`, `country`, `checkoutReference`, `archiveNumber`, `payerName`, `settlementId`, `settlementDate`, `settlementReference`, `originalTradeReference`, `vatPercentage`, `vatAmount`, `paymentMethodFee`, `paymentMethodCommission`, `shopInShopCommission`, `shopInShopCommissionVatPercentage`, `shopInShopCommissionVatAmount`, `companyName`, `vatId` and `refunditems` |
| submerchant | integer | <center></center> | | Get submerchant's payment report (aggregate only) |
| includeItems | boolean | <center></center> | false | Include trade items in generated report. Only applicable when requestType is set to `json` |
| includeItems | boolean | <center></center> | false | Include trade items in generated report. Only applicable when requestType is set to `json` |

#### Response

Expand Down Expand Up @@ -855,7 +855,6 @@ Example of the refunditems serialised into CSV
...;"stamp1:-4,00|stamp2:-5,00"
```


!> When validating report signature, body must be in raw body format in order to signature match.

### Payment report request by settlement ID
Expand Down
2 changes: 1 addition & 1 deletion docs/examples.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1386,7 +1386,7 @@ const responseToHtml = (response) =>
`<form method="POST" action="${provider.url}">
${provider.parameters.map(parameterToInput)}
<button><img src="${provider.svg}" /></button>
</form>`
</form>`,
)
.join('\n');
```
2 changes: 1 addition & 1 deletion docs/index.html
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<!DOCTYPE html>
<!doctype html>
<html lang="en">
<head>
<meta charset="UTF-8" />
Expand Down
Loading

0 comments on commit 283ac26

Please sign in to comment.