Sign in

v1

latestOpenAPI 3.1.02026-08-0670151364.9 KB
Recurring payment requests

Create a recurring payment request

post/schedules/payment_requests

Request body

Example request

{
  "cadence": {
    "type": "INTERVAL",
    "timeUnit": "MONTHS",
    "frequency": 1,
    "startDate": "2025-01-01T00:00:00Z"
  },
  "paymentRequestDetails": {
    "customer": {
      "id": "80349480-490b-4234-92e7-fad697e3d446"
    },
    "paymentTerm": {
      "timeUnit": "DAYS",
      "value": 30
    },
    "distribution": {
      "collectionMethod": "AUTO_COLLECT",
      "templateId": "d290f1ee-6c54-4b01-90e6-d701748f0851",
      "customMessage": "Thank you for your business!",
      "approvedForSending": true
    },
    "amount": "10.00",
    "taxRate": "0.1",
    "currencyCode": "GBP",
    "description": "Monthly subscription for January",
    "reference": "PR-01"
  }
}

Response

The request was successful and the recurring payment request was created

idstring

The Adfin ID of the recurring payment request.

recurringPaymentRequestNostring

A system-generated, unique identifier for the recurring payment request. Automatically created using the prefix SCH followed by a numeric sequence (e.g., SCH-1, SCH-2, ...).

nextDatestring date-time

The next date a new payment request will be generated.

statusstring

Indicates the current status of the recurring payment request. Possible values might include:

  • ACTIVE – currently generating new payment request
  • FINISHED – has finished all planned occurrences
  • CANCELLED – has been cancelled before finishing all planned occurrences
creationTimestring date-time

The date and time when the recurring payment request was created.

lastUpdatedTimestring date-time

The date and time when the recurring payment request was last updated.

totalPaymentRequestsinteger

The total number of payment requests this recurring payment request is expected to generate based on cadence, start date, and end date.

Example response

{
  "recurringPaymentRequestNo": "SCH-42",
  "nextDate": "2025-10-15T00:00:00Z",
  "status": "ACTIVE",
  "cadence": {
    "timeUnit": "WEEK",
    "frequency": 2,
    "startDate": "2025-01-01T00:00:00.000Z",
    "endDate": "2025-12-31T23:59:59.000Z"
  },
  "paymentRequestDetails": {
    "customer": {
      "id": "80349480-490b-4234-92e7-fad697e3d446"
    },
    "paymentTerm": {
      "timeUnit": "DAY",
      "value": 30
    },
    "distribution": {
      "collectionMethod": "AUTO_COLLECT",
      "templateId": "dc9c7c6e-4c12-4cc9-8d22-20c5b2a7f8f7",
      "customMessage": "Please review and confirm payment.",
      "approvedForSending": true
    },
    "amount": 1200,
    "taxRate": 20,
    "currencyCode": "GBP",
    "description": "Quarterly service fee",
    "reference": "Q1-2025"
  },
  "creationTime": "2025-09-27T12:00:00Z",
  "lastUpdatedTime": "2025-10-01T08:30:00Z",
  "totalPaymentRequests": 10,
  "nextPaymentRequests": [
    {
      "index": 3,
      "issueDate": "2025-11-01T00:00:00Z",
      "payByDate": "2025-11-08T00:00:00Z"
    }
  ]
}