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
GET Merchants request allows the requestor to locate this value for any merchant.
GET Merchants - 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.
|Field Name||State||Data Type||Description|
GET Merchants - 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.|
|isActive||Boolean||Confirms whether the merchant is active.|
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.|
|processor||Boolean||Allows the requestor to filter merchants returned by the processor of the transactions.|
Example Request and Response
GET Merchant Storage
You can store the
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.