processingAccounts

Create reminder for processing account

Changed on

Use this method to prompt a merchant to sign their pricing agreement.

You can create a reminder only if you requested the merchant’s signature by email when you created the processing account for the merchant.

To create a reminder, you need the processingAccountId. Our gateway returned the processingAccountId in the response of the Create Merchant Platform method or Create Processing Account method.

Note: If you don’t know the processingAccountId, use our List Merchant Platform’s Processing Accounts method to search for the processing account.

When you send a successful request, we send an email to the merchant that prompts them to sign their pricing agreement.

post/processing-accounts/{processingAccountId}/reminders

Request

  • Base URL
    https://api.payroc.com/v1
  • URL
    https://api.payroc.com/v1/processing-accounts/{processingAccountId}/reminders
  • Auth
    HTTP bearer

Path parameters

processingAccountIdstring required

Unique identifier that we assigned to the processing account.

Headers

Idempotency-Keystring uuid required

Unique identifier that you generate for each request. You must use the UUID v4 format for the identifier. For more information about the idempotency key, go to Idempotency.

Request body

type'pricingAgreement' required

Discriminator value: pricingAgreement

reminderIdstring

Unique ID of the reminder.

Response

Successful request. We sent an email to the merchant and we return a polymorphic object that contains reminder details.

type'pricingAgreement' required

Discriminator value: pricingAgreement

reminderIdstring

Unique ID of the reminder.

Changes