Merchants
Get Merchant By Id
Partner access
If you have a PaySimple Reseller API key, use the
PaySimple-Merchant-Id
header to specify the integer id of the merchant (see authorization). The PaySimple merchant id can be retrieved from the List Merchants endpoint.
Retrieves merchant information. The merchant_key
value is required to set up a new Embeddable.
Request:
GET /ps/merchant/info
Response:
200 OK
{
"data": {
"merchant_key": "559d5e8ba8975f0df42911ee",
"time_zone": "Mountain Standard Time"
}
}
List Merchants
Partner access only
You must be a PaySimple Reseller with a Reseller API key to list merchant accounts.
Retrieves a list of all merchants for the reseller key provided in the authorization header. The merchant_id
value is useful for populating the PaySimple-Merchant-Id
header used for accessing merchant specific API endpoints.
Request:
GET /ps/merchants
Response:
200 OK
{
"total_item_count": 2,
"data": [
{
"merchant_id": 2852,
"company_name": "Fantastic Shop",
"email": "[email protected]",
"status": "enabled"
},
{
"merchant_id": 17887,
"company_name": "Awesome Personal Training",
"email": "[email protected]",
"status": "restricted"
}
]
}
Merchant Properties
Property | Type | Description |
---|---|---|
merchant_id | integer | PaySimple unique identifier for a merchant. |
company_name | string | Company name of the merchant. |
string | Primary email address of the merchant. | |
status | string | State of the merchant account. Values: enabled , restricted (may log in but not make payments), disabled (cannot log in) |
Updated over 6 years ago