|
2 | 2 | sidebar_position: 3 |
3 | 3 | --- |
4 | 4 |
|
5 | | -# Invoice Issuers |
| 5 | +:::caution |
6 | 6 |
|
7 | | -Businesses that need to send invoices to their customers commonly use MobilePay invoices. For example, a consulting business might send invoices for the time and resources that each consultation uses. Our MobilePay Invoice API enables you to send Invoice directly into the MobilePay app or use MobilePay as a payment method in an existing Invoice flow (self serve environments, e-mails and etc.) |
| 7 | +Please notice that as part of the merger between MobilePay and Norwegian Vipps, we will consolidate products on one joint platform. |
| 8 | +This product is now closed. Please visit our new developer documentation to see the new APIs we offer https://developer.vippsmobilepay.com/ |
8 | 9 |
|
9 | | -## Get an invoice issuer |
10 | | - |
11 | | -Invoice Issuer represents merchant's company information. Before using *MobilePay Invoices* merchant must have at least one invoice issuer which can be created via [MobilePay Portal Denmark](https://admin.mobilepay.dk) or [Finland](https://admin.mobilepay.fi). Each invoice issuer contains its own address information, account data and logo. The merchant is the customer company and the Invoice Issuer is the actual service provider name under which they create invoices |
12 | | - |
13 | | -```json |
14 | | -GET /api/v1/merchants/{merchantId}/invoiceissuers |
15 | | -``` |
16 | | - |
17 | | -```json title="Response" |
18 | | -HTTP 200 OK |
19 | | - |
20 | | -{ |
21 | | - "InvoiceIssuers": [ |
22 | | - { |
23 | | - "Id": "6a33d969-fa86-44af-a23b-731da0e4d50d", |
24 | | - "Name": "MyAwesomeStore", |
25 | | - "AccountType": "Account", |
26 | | - "Status": "enabled", |
27 | | - "Address": "Paradisæblevej 13", |
28 | | - "City": "Andeby", |
29 | | - "ZipCode": "1234" |
30 | | - } |
31 | | - ] |
32 | | -} |
33 | | -``` |
34 | | - |
35 | | -| Property | Type | Description | |
36 | | -|-------------|----------|------------------------------------------------------------------------------------------------------| |
37 | | -|`Id` | `guid` | Id of an invoice issuer associated with your `merchantId`. | |
38 | | -|`Name` | `string` | Your invoice issuer's name. | |
39 | | -|`AccountType`| `string` | The type of account associated with an invoice issuer. At the moment there's only one type `Account`.| |
40 | | -|`Status` | `string` | Issuer status. | |
41 | | -|`Address` | `string` | Issuer address line. | |
42 | | -|`City` | `string` | Issuer city. | |
43 | | -|`ZipCode` | `string` | Issuer Zip code. | |
44 | | - |
45 | | -### Invoice issuer statuses |
46 | | - |
47 | | -There are three invoice issuer `Status` values that can be explained in following order: |
48 | | - |
49 | | -| Status | Explanation | |
50 | | -|------------|---------------------------------------------------| |
51 | | -| `pending` | Issuer was created and is pending for an approval.| |
52 | | -| `enabled` | Issuer is active & ready to be used. | |
53 | | -| `disabled` | Merchant has disabled invoice issuer. | |
54 | | - |
55 | | -## Get your merchant id |
56 | | - |
57 | | -`MerchantId` is a unique identifier of a merchant in our system. After you retrieve an access token from OpenID flow use the following endpoint to retrieve your `MerchantId`. |
58 | | - |
59 | | -```json |
60 | | -GET /api/v1/merchants/me |
61 | | -``` |
62 | | - |
63 | | -```json title="Response" |
64 | | -HTTP 200 OK |
65 | | -{ |
66 | | - "MerchantId": "e3465d75-8fd4-4ea4-8881-304c464f1d24" |
67 | | -} |
68 | | -``` |
| 10 | +::: |
0 commit comments