Merchants & Providers
These queries return information about the authenticated merchant and the transaction providers configured for that merchant account.
merchantApi
Return the authenticated merchant's profile. Useful for verifying credentials and retrieving the merchant's public ID.
query GetMerchant {
merchantApi {
id
name
publicId
createdAt
updatedAt
}
}
Arguments
None. The merchant is determined from the accrupay-api-secret header.
Return shape
| Field | Type | Description |
|---|---|---|
id | String | AccruPay merchant UUID |
name | String | Merchant display name |
publicId | String | Public-facing merchant identifier — used by the React SDK to initialize the checkout component |
createdAt | DateTime | Account creation timestamp |
updatedAt | DateTime | Last update timestamp |
merchantApiTransactionProviders
List all transaction providers configured for the authenticated merchant.
query ListProviders {
merchantApiTransactionProviders {
id
provider
label
isActive
createdAt
}
}
Arguments
None.
Return shape (array)
| Field | Type | Description |
|---|---|---|
id | String | AccruPay provider record UUID — use this as merchantTransactionProviderId in mutations |
provider | TRANSACTION_PROVIDER | Provider enum identifier (e.g. NUVEI) |
label | String | Human-readable label set in the dashboard |
isActive | Boolean | Whether this provider is enabled for new transactions |
createdAt | DateTime | Provider record creation timestamp |
merchantApiTransactionProvider
Fetch a single transaction provider record by ID.
query GetProvider($id: String!) {
merchantApiTransactionProvider(id: $id) {
id
provider
label
isActive
createdAt
updatedAt
}
}
Arguments
| Argument | Type | Required | Description |
|---|---|---|---|
id | String | Yes | AccruPay provider record UUID |
Return shape
| Field | Type | Description |
|---|---|---|
id | String | Provider record UUID |
provider | TRANSACTION_PROVIDER | Provider enum |
label | String | Human-readable label |
isActive | Boolean | Whether this provider accepts new transactions |
createdAt | DateTime | Creation timestamp |
updatedAt | DateTime | Last update timestamp |
Provider IDs vs provider enums
Most mutations accept either merchantTransactionProviderId or transactionProvider to specify which provider to route through.
| Option | When to use |
|---|---|
merchantTransactionProviderId | You have multiple providers of the same type, or you want to be explicit about which configured record to use |
transactionProvider | You have exactly one provider of that type; AccruPay resolves the record automatically |
If both are provided, merchantTransactionProviderId takes precedence. If neither is provided, the mutation returns a VALIDATION_ERROR.