Disputes

Enroll Descriptors for Dispute Alerts

Enroll one or more merchant descriptors with a pre-chargeback alert program. Runs synchronously and returns once the provider has accepted the enrollment.

post/dispute/disputes/alert-enrollments

Request

Base URL
https://api.staging.payrails.io
Auth
HTTP bearer
TypeScript
https://skmtc.dev/payrails/apis/payrails-api-reference/docs/dispute/disputes/alert-enrollments/post.ts
A function with typed inputs. Its response is checked against the schema.

Headers

x-idempotency-keystring uuid required

Idempotency key to be used. Sending again the same key would return the same result without re-executing the update.

Request body

workspaceIdstring uuid required

The workspace the enrollment belongs to.

providerIdstring uuid required

providerConfigIdstring uuid required

descriptorsstring[] required

The merchant descriptors to enroll for alerts.

program'Ethoca' | 'CDRN' | 'RDR' | 'SAFE' required

The network program to enroll the descriptors in.

rulesetstring

Optional provider ruleset to apply.

Response

Enrollment created.

Changes

No recorded changes to this operation across all 1 revision of this API.