Skip to main content

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

FieldTypeDescription
idStringAccruPay merchant UUID
nameStringMerchant display name
publicIdStringPublic-facing merchant identifier — used by the React SDK to initialize the checkout component
createdAtDateTimeAccount creation timestamp
updatedAtDateTimeLast 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)

FieldTypeDescription
idStringAccruPay provider record UUID — use this as merchantTransactionProviderId in mutations
providerTRANSACTION_PROVIDERProvider enum identifier (e.g. NUVEI)
labelStringHuman-readable label set in the dashboard
isActiveBooleanWhether this provider is enabled for new transactions
createdAtDateTimeProvider 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

ArgumentTypeRequiredDescription
idStringYesAccruPay provider record UUID

Return shape

FieldTypeDescription
idStringProvider record UUID
providerTRANSACTION_PROVIDERProvider enum
labelStringHuman-readable label
isActiveBooleanWhether this provider accepts new transactions
createdAtDateTimeCreation timestamp
updatedAtDateTimeLast update timestamp

Provider IDs vs provider enums

Most mutations accept either merchantTransactionProviderId or transactionProvider to specify which provider to route through.

OptionWhen to use
merchantTransactionProviderIdYou have multiple providers of the same type, or you want to be explicit about which configured record to use
transactionProviderYou 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.