---
updatedAt: 2025-02-20T00:12:50.000Z
agentTools:
  projectIndex: https://developers.credrails.com/llms.txt
---

# Recurring Payments

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "Credrails OpenBanking API",
    "description": "APIs that allows customers to share their financial data with authorized third parties, such as other banks and fintech companies, to access new financial services and products.",
    "license": {
      "name": "Credrails Website",
      "url": "http://www.credrails.com"
    },
    "version": "v2,3,0"
  },
  "externalDocs": {
    "description": "API Documentation",
    "url": "https://credrails.readme.io/docs/open-banking"
  },
  "servers": [
    {
      "url": "https://dev-openbanking.pub.credrails.com",
      "description": "Dev Testing Environment"
    }
  ],
  "tags": [
    {
      "name": "Payments",
      "description": "Making payments"
    }
  ],
  "paths": {
    "/api/v2/payments/recurring": {
      "post": {
        "tags": [
          "Payments"
        ],
        "summary": "Recurring Payments",
        "operationId": "recurringPayment",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/PaymentRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "The recurring payments have been scheduled successfully",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SimpleRequestResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad request, related to invalid parameters",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SimpleRequestResponse"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "content": {
              "*/*": {
                "schema": {
                  "type": "object"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "SimpleRequestResponse": {
        "type": "object",
        "properties": {
          "code": {
            "type": "string",
            "description": "Code representing request status",
            "enum": [
              "SUCCESS",
              "SECURITY_ANSWER_REQUESTED",
              "INVALID_USERNAME_OR_PASSWORD",
              "INVALID_INSTITUTION_PROVIDED",
              "INVALID_SECURITY_QUESTION_FOR_SESSION",
              "AUTH_NOT_PERFORMED_OR_TIMEDOUT",
              "INVALID_SESSION_ID",
              "UNKNOWN_ERROR",
              "OTP_REQUIRED",
              "INVALID_PAYMENT_TYPE_PROVIDED",
              "DUPLICATE_SESSION_ID",
              "UNSUPPORTED_FEATURE",
              "MISSING_KEY_VALUES",
              "FAILURE",
              "ERROR_RETRIEVING_BALANCE",
              "ERROR_LOGIN_IN",
              "INVALID_SECURITY_ANSWER",
              "INVALID_OTP",
              "ERROR_FETCHING_STATEMENTS",
              "BROWSER_CLOSED",
              "ERROR_RETRIEVING_CREDENTIALS",
              "ERROR_STARTING_BROWSER_SESSION",
              "INSTITUTION_NOT_REACHABLE",
              "BANK_NOT_FOUND",
              "ACCOUNT_PROVIDED_NOT_FOUND",
              "ERROR_MAKING_PAYMENT",
              "INSUFFICIENT_BALANCE",
              "INVALID_AMOUNT",
              "EMPTY_STATEMENT",
              "SESSION_INITIATION_ERROR",
              "OTP_OR_SECURITY_ANSWER_NOT_PROVIDED",
              "INCOMPLETE_OTP",
              "INVALID_CREDENTIALS",
              "ERROR",
              "NO_DATA",
              "RECEIVED",
              "CONSENT_ERROR",
              "USER_DISABLED",
              "REQUEST_CHANGE_PASSWORD",
              "ACCOUNT_BLOCKED",
              "CONFIG_EXISTS",
              "CONFIG_NOT_FOUND",
              "USERNAME_EXISTS",
              "INVALID_REFRESH_TOKEN",
              "LOGOUT_FAILURE",
              "BALANCE_CHECK_REQUEST_EXISTS",
              "PAYMENT_REQUEST_EXISTS",
              "CONSENT_NOT_OBTAINED",
              "INVALID_CONSENT",
              "INVALID_CONSENT_CREDENTIALS",
              "CONSENT_BEING_VALIDATED",
              "VALIDATION_FAILED",
              "PAYMENT_FAILED",
              "BALANCE_CHECK_FAILED",
              "BALANCE_CHECK_REQUEST_NOT_FOUND",
              "TRANSACTIONS_REQUEST_NOT_FOUND",
              "PAYMENT_REQUEST_NOT_FOUND",
              "INVALID_DATES",
              "CHARGES_NOT_SET",
              "INVALID_REQUEST_ID",
              "INVALID_FREQUENCY",
              "STATEMENT_FETCH_FAILED",
              "TRANSACTIONS_CALLBACK_FAILURE",
              "INVALID_USER",
              "TRANSACTIONS_QUEUING_FAILURE",
              "CHARGES_CREATION_FAILURE",
              "CHARGES_UPDATE_FAILURE",
              "GET_CHARGES_FAILURE",
              "PASSWORD_DECRYPTION_FAILED",
              "UNSUPPORTED_BANK_FOR_TRANSACTIONS",
              "INTEGRATION_TYPE_NOT_SUPPORTED",
              "SERVICE_UNAVAILABLE",
              "ERROR_RESETTING_PASSWORD",
              "SCOPE_NOT_SUPPORTED"
            ]
          },
          "message": {
            "type": "string",
            "description": "A message related with the response"
          },
          "requestId": {
            "type": "string",
            "description": "A uuid representing the request from the user"
          }
        }
      },
      "Beneficiary": {
        "required": [
          "account",
          "name"
        ],
        "type": "object",
        "properties": {
          "account": {
            "type": "string"
          },
          "accountType": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "physicalAddress": {
            "type": "string"
          },
          "city": {
            "type": "string"
          },
          "country": {
            "type": "string"
          }
        },
        "description": "The recipient details"
      },
      "DestinationBank": {
        "required": [
          "branch",
          "name"
        ],
        "type": "object",
        "properties": {
          "name": {
            "type": "string"
          },
          "branch": {
            "type": "string"
          },
          "swiftCode": {
            "type": "string"
          },
          "city": {
            "type": "string"
          },
          "country": {
            "type": "string"
          }
        },
        "description": "The recipient bank details"
      },
      "PaymentDetails": {
        "required": [
          "amount",
          "currency"
        ],
        "type": "object",
        "properties": {
          "amount": {
            "type": "string"
          },
          "currency": {
            "type": "string"
          },
          "costBearer": {
            "type": "string"
          }
        },
        "description": "The amount details"
      },
      "PaymentRequest": {
        "required": [
          "beneficiary",
          "callbackUrl",
          "destinationBank",
          "paymentDetails",
          "paymentType",
          "requestId",
          "serviceName",
          "tpaAccessToken"
        ],
        "type": "object",
        "properties": {
          "tpaAccessToken": {
            "type": "string",
            "description": "A token representing consent to a customer account"
          },
          "requestId": {
            "maxLength": 64,
            "minLength": 6,
            "pattern": "[\\w_/.-]+",
            "type": "string",
            "description": "A uuid representing the request from the user"
          },
          "originatingAccount": {
            "type": "string",
            "description": "The account number to pay from"
          },
          "paymentType": {
            "type": "string",
            "description": "The type of payment, currently supports INTERNAL or RTGS"
          },
          "paymentDetails": {
            "$ref": "#/components/schemas/PaymentDetails"
          },
          "beneficiary": {
            "$ref": "#/components/schemas/Beneficiary"
          },
          "destinationBank": {
            "$ref": "#/components/schemas/DestinationBank"
          },
          "callbackUrl": {
            "type": "string",
            "description": "The url the payment results will be sent to"
          },
          "remarks": {
            "type": "string",
            "description": "A description of what the payment is about"
          },
          "serviceName": {
            "type": "string",
            "description": "Internal service name"
          },
          "startAt": {
            "type": "string",
            "description": "The date the payment requests start at, dateformat is yyyy-MM-dd'T'HH:mm:ssZ",
            "format": "date-time"
          },
          "endAt": {
            "type": "string",
            "description": "The date the payment requests end at, dateformat is yyyy-MM-dd'T'HH:mm:ssZ",
            "format": "date-time"
          },
          "frequency": {
            "type": "string",
            "description": "A cron expression representing the intervals the payments will be made"
          },
          "paymentCollectionId": {
            "type": "string"
          },
          "integrationType": {
            "type": "string"
          }
        }
      }
    }
  },
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  }
}
```