Merchants Function
Some of the queries available via the Partners Reporting API allow the requestor to limit the responses to a specific merchant. This is achieved via the supply of the DNA Payments merchantId. The two different GET Merchants requests allows the requestor to locate this value for any merchant.
GET Merchants Version 1
Request
The Merchant request is completed via a GET request to the test URL shown above, and should contain the below header data. The access_token will be the one received in the Authentication Response.
| HTTP Header | |||
|---|---|---|---|
| Field Name | State | Data Type | Description |
| Content-Type | Mandatory | String | application/json |
| Authorization | Mandatory | String | Bearer access_token |
Response
If the request is successful, the method will return a 200 response code. All your merchants will be returned as an array containing the following fields:
| GET Merchant Response | ||
|---|---|---|
| Field Name | Data Type | Description |
| id | String | Unique ID for the merchant, allocated by DNA Payments. |
| name | Integer | Name of the merchant. |
GET Merchants Version 2
Request
The Merchant request is completed via a GET request to the test URL shown above, and should contain the below header data. The access_token will be the one received in the Authentication Response.
| HTTP Header | |||
|---|---|---|---|
| Field Name | State | Data Type | Description |
| Content-Type | Mandatory | String | application/json |
| Authorization | Mandatory | String | Bearer access_token |
In Version 2, you are able to query with the following parameters:
| Query Parameters | |||||||
|---|---|---|---|---|---|---|---|
| Field Name | State | Data Type | Description | ||||
| processor | Optional | String | Processor of transactions. Supported values are:
| ||||
| page | Optional | Integer | Specifies which set of records to retrieve. Default = 1 | ||||
| size | Optional | Integer | Specifies how many records per page will be returned. Default = 1000. Max = 5000 | ||||
Response
If the request is successful, the method will return a 200 response code. All your merchants will be returned as an array of objects, each containing the following fields:
| GET Merchant Response | ||||||
|---|---|---|---|---|---|---|
| Field Name | Data Type | Description | ||||
| descriptor | String | Merchant Descriptor i.e. What will appear on consumers Bank Statement when using DNA Acquiring. | ||||
| id | String | Unique ID for the merchant, allocated by DNA Payments. | ||||
| name | Integer | Name of the merchant. | ||||
| isActive | Boolean | Confirms whether the merchant is active.
| ||||
| reconcilitationId | Integer | Unique Id allocated by DNA Payments to the merchant account. This reference appears on the merchant bank statement when payment/settlements are made. | ||||
| terminals | Array | List of all Terminal ID's configured for the merchant along with some other details. | ||||
| processor | Boolean | Allows the requestor to filter merchants returned by the processor of the transactions.
| ||||
Response - terminals Array
| terminals Array | ||||||
|---|---|---|---|---|---|---|
| Field Name | Data Type | Description | ||||
| id | String | Unique Terminal ID for the merchant, allocated by DNA Payments. | ||||
| dailySettlement | Boolean | If set to true, you will receive a separate payment on each day. The default is to receive a single payment on Monday for the entire weekend i.e. Friday, Saturday & Sunday combined. | ||||
| settlementPeriod | Integer | Number of days after which Settlement is processed for this Merchant. | ||||
| storeName | String | Name of the merchant store which was provided during the onboarding process. | ||||
| type | String | Type of terminal
| ||||
Example Requests and Response
- V1 Request
- V2 Request
- V1 Response
- V2 Response
GET Merchant Storage
You can store the id and name locally as these values will not change, but it is best practice to re-query this each time you need to make a merchant specific request.