---
api: 'Open Banking API'
---

# Create a domestic scheduled payment

Create a domestic scheduled payment.

:::note
As is defined in the Open Banking Specifications, the `/Data/Initiation` and the `/Data/Risk` sections of the request must be an exact match for the related consent passed in `ConsentId`.
:::

See also [Tutorials: Initiate your first payment](/docs/guides/build-banking-apps/tutorials/initiate-your-first-payment#6-initiate-the-domestic-payment).

## Endpoint

POST `/domestic-scheduled-payments`

## Parameters

### header parameters

- `x-fapi-financial-id` (string, required)
  The unique ID of the [ASPSP](/docs/guides/build-banking-apps/glossary) that the request is issued to.
  The ID of Revolut is `001580000103UAvAAM`.

- `x-fapi-customer-last-logged-time` (string, optional)
  The date and time when the [PSU](/docs/guides/build-banking-apps/glossary) last logged in with the [TPP](/docs/guides/build-banking-apps/glossary).
  
  All dates in the HTTP headers are represented as [RFC 7231](https://datatracker.ietf.org/doc/html/rfc7231#section-7.1.1.1) Full Dates.
  For example: <nobr>`Sun, 10 Sep 2017 19:43:31 UTC`</nobr>.

- `x-fapi-customer-ip-address` (string, optional)
  The IP address of the [PSU](/docs/guides/build-banking-apps/glossary) if the PSU is logged in with the [TPP](/docs/guides/build-banking-apps/glossary).

- `x-fapi-interaction-id` (string, optional)
  An [RFC4122](https://datatracker.ietf.org/doc/html/rfc4122) UUID used as a correlation ID.

- `Authorization` (string, required)
  The access token that you've generated.
  For more information, see [Generate an access token](/docs/guides/build-banking-apps/get-started/get-access-token).

- `x-idempotency-key` (string, required)
  Each request is processed only once per `x-idempotency-key`.
  The idempotency key is valid for 24 hours.

- `x-jws-signature` (string, required)
  A [detached JWS signature](/docs/guides/build-banking-apps/tutorials/work-with-json-web-signatures) of the body of the payload.

- `x-customer-user-agent` (string, optional)
  The user agent that the [PSU](/docs/guides/build-banking-apps/glossary) is using.

## Request body

### Attributes

- `Data` (object)
  - `Data.ConsentId` (string)
      The unique ID that the [ASPSP](/docs/guides/build-banking-apps/glossary) assigns to identify the consent resource.
  - `Data.Initiation` (object)
      The Initiation payload that the initiating party sends to the [ASPSP](/docs/guides/build-banking-apps/glossary), which is used to request movement of funds from the debtor account to the creditor for a single scheduled domestic payment.
    - `Data.Initiation.InstructionIdentification` (string)
        The unique ID that an instructing party assigns for an instructed party to unambiguously identify the instruction.
        
        This ID is used between the instructing party and the instructed party to refer to an individual instruction.
        It can be included in the messages related to the instruction.
    - `Data.Initiation.EndToEndIdentification` (string, optional)
        The unique and immutable ID that the initiating party assigns to unambiguously identify the transaction.
        
        This ID is used for reconciliation or to link tasks related to the transaction.
        It can be included in the messages related to the transaction.
        
        :::note
        Faster Payments Scheme can access only 31 characters for the `EndToEndIdentification` field.
        :::
    - `Data.Initiation.RequestedExecutionDateTime` (string)
        The date and time when the initiating party requests the clearing agent to process the payment.
        
        This is the date the debtor's account is to be debited.
        
        All dates in the JSON payloads are represented in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time format.
        All date-time fields in responses must include the timezone.
        
        For example: `2017-04-05T10:43:07+00:00`.
    - `Data.Initiation.InstructedAmount` (object)
        The amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency that the initiating party instructs.
        
        This amount has to be transported unchanged through the transaction chain.
      - `Data.Initiation.InstructedAmount.Amount` (string)
          The amount of money where the unit of currency is explicit and compliant with [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).
      - `Data.Initiation.InstructedAmount.Currency` (string)
          [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code in upper case.
    - `Data.Initiation.CreditorAccount` (object)
        The details to identify the account.
      - `Data.Initiation.CreditorAccount.SchemeName` (enum)
          The name of the identification scheme.
          Possible enum values:

          - `UK.OBIE.IBAN`
          - `UK.OBIE.SortCodeAccountNumber`
          - `US.RoutingNumberAccountNumber`
          - `US.BranchCodeAccountNumber`
      - `Data.Initiation.CreditorAccount.Identification` (string)
          The account ID that the institution assigns to identify an account, which is known by the account owner.
      - `Data.Initiation.CreditorAccount.Name` (string)
          The account name that the account servicing institution assigns.
          
          The account name is the name or names of the account owner(s) represented at an account level.
          
          The account name is not the product name or the nickname of the account.
          
          :::note
          [ASPSP](/docs/guides/build-banking-apps/glossary)s might optionally validate this name to confirm the payee.
          :::
      - `Data.Initiation.CreditorAccount.SecondaryIdentification` (string, optional)
          The secondary account ID that the account servicing institution assigns.
          
          Building societies can use this ID to identify accounts with a roll number in addition to a sort code and account number combination.
    - `Data.Initiation.CreditorPostalAddress` (object, optional)
        The postal address of the creditor, as defined by postal services.
      - `Data.Initiation.CreditorPostalAddress.Department` (string, optional)
          The name of the department.
      - `Data.Initiation.CreditorPostalAddress.SubDepartment` (string, optional)
          The name of the sub-department.
      - `Data.Initiation.CreditorPostalAddress.StreetName` (string, optional)
          The name of the street.
      - `Data.Initiation.CreditorPostalAddress.BuildingNumber` (string, optional)
          The number of the building.
      - `Data.Initiation.CreditorPostalAddress.PostCode` (string, optional)
          The post code of the address.
      - `Data.Initiation.CreditorPostalAddress.TownName` (string, optional)
          The name of the town.
      - `Data.Initiation.CreditorPostalAddress.CountrySubDivision` (string, optional)
          The subdivision of the country, such as state, region, or county.
      - `Data.Initiation.CreditorPostalAddress.Country` (string, optional)
          The name of the country.
      - `Data.Initiation.CreditorPostalAddress.AddressLine` (array of string, optional)
          The information that locates and identifies the address of the creditor, presented in free format text.
    - `Data.Initiation.RemittanceInformation` (object, optional)
        The information used for matching an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system.
      - `Data.Initiation.RemittanceInformation.Unstructured` (string, optional)
          The information used for matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form.
      - `Data.Initiation.RemittanceInformation.Reference` (string, optional)
          The unique reference that the creditor assigns to unambiguously identify the payment transaction.
          
          If available, the initiating party should provide this reference in the structured remittance information to enable reconciliation by the creditor upon receipt of the amount of money.
          
          If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification.
          
          :::note
          Faster Payments Scheme can accept only 18 characters for the `Reference` field.
          :::
          
          :::warning
          Only one reference should be provided, if both `Reference` and `Unstructured` parameters are provided, then the `Unstructured` parameter will be ignored.
          :::
    - `Data.Initiation.DebtorAccount` (object, optional)
        The details to identify the account from which the payment consent can be approved.
        
        If provided in the consent, the [PSU](/docs/guides/build-banking-apps/glossary) will only be able to approve the payment consent from an account which matches the provided account identifier.
      - `Data.Initiation.DebtorAccount.SchemeName` (enum)
          The name of the identification scheme.
          Possible enum values:

          - `UK.OBIE.IBAN`
          - `UK.OBIE.SortCodeAccountNumber`
          - `US.RoutingNumberAccountNumber`
          - `US.BranchCodeAccountNumber`
      - `Data.Initiation.DebtorAccount.Identification` (string)
          The identifier assigned to the account, which is known by the account owner.
      - `Data.Initiation.DebtorAccount.Name` (string, optional)
          The name or names of the account owner(s) represented at an account level.
          
          The account name is not the product name or the nickname of the account.
          
          :::warning
          The name value is not validated against the actual owner name of the account.
          :::
      - `Data.Initiation.DebtorAccount.SecondaryIdentification` (string, optional)
          The secondary account ID that the account servicing institution assigns.
          
          Building societies can use this ID to identify accounts with a roll number in addition to a sort code and account number combination.
- `Risk` (object)
    The Risk section contains the risk indicators that the initiating party sends to the [ASPSP](/docs/guides/build-banking-apps/glossary), which can be used to specify additional details for risk scoring for account information.
  - `Risk.PaymentContextCode` (enum, optional)
      The payment context.
      Possible enum values:

      - `BillPayment`
      - `EcommerceGoods`
      - `EcommerceServices`
      - `Other`
      - `PartyToParty`
  - `Risk.MerchantCategoryCode` (string, optional)
      The merchant category code.
  - `Risk.MerchantCustomerIdentification` (string, optional)
      The merchant customer identification.
  - `Risk.DeliveryAddress` (object, optional)
      The information that locates and identifies the delivery address, as defined by postal services or in free format text.
    - `Risk.DeliveryAddress.AddressLine` (array of string, optional)
        The information that locates and identifies the delivery address, as defined by postal services, that is presented in free format text.
    - `Risk.DeliveryAddress.StreetName` (string, optional)
        The name of the street.
    - `Risk.DeliveryAddress.BuildingNumber` (string, optional)
        The number of the building.
    - `Risk.DeliveryAddress.PostCode` (string, optional)
        The post code of the delivery address.
    - `Risk.DeliveryAddress.TownName` (string)
        The name of the town.
    - `Risk.DeliveryAddress.CountrySubDivision` (array of string, optional)
        The subdivision of the country, for example, state, region or county.
    - `Risk.DeliveryAddress.Country` (string)
        The name of the country.

## Returns

### 201

Domestic Scheduled Payments Created

#### Response attributes

- `Data` (object)
  - `Data.DomesticScheduledPaymentId` (string)
      The unique ID that the [ASPSP](/docs/guides/build-banking-apps/glossary) assigns to identify the domestic schedule payment resource.
  - `Data.ConsentId` (string)
      The unique ID that the [ASPSP](/docs/guides/build-banking-apps/glossary) assigns to identify the consent resource.
  - `Data.CreationDateTime` (string)
      The date and time when the message was created.
      
      All dates in the JSON payloads are represented in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time format.
      All date-time fields in responses must include the timezone.
      
      For example: `2017-04-05T10:43:07+00:00`.
  - `Data.Status` (enum)
      The status of the payment.
      Possible enum values:

      - `InitiationCompleted`
      - `InitiationFailed`
      - `InitiationPending`
  - `Data.StatusUpdateDateTime` (string)
      The date and time when the resource status was updated.
      
      All dates in the JSON payloads are represented in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time format.
      All date-time fields in responses must include the timezone.
      
      For example: `2017-04-05T10:43:07+00:00`.
  - `Data.Initiation` (object)
      The Initiation payload that the initiating party sends to the [ASPSP](/docs/guides/build-banking-apps/glossary), which is used to request movement of funds from the debtor account to the creditor for a single scheduled domestic payment.
    - `Data.Initiation.InstructionIdentification` (string)
        The unique ID that an instructing party assigns for an instructed party to unambiguously identify the instruction.
        
        This ID is used between the instructing party and the instructed party to refer to an individual instruction.
        It can be included in the messages related to the instruction.
    - `Data.Initiation.EndToEndIdentification` (string, optional)
        The unique and immutable ID that the initiating party assigns to unambiguously identify the transaction.
        
        This ID is used for reconciliation or to link tasks related to the transaction.
        It can be included in the messages related to the transaction.
        
        :::note
        Faster Payments Scheme can access only 31 characters for the `EndToEndIdentification` field.
        :::
    - `Data.Initiation.RequestedExecutionDateTime` (string)
        The date and time when the initiating party requests the clearing agent to process the payment.
        
        This is the date the debtor's account is to be debited.
        
        All dates in the JSON payloads are represented in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time format.
        All date-time fields in responses must include the timezone.
        
        For example: `2017-04-05T10:43:07+00:00`.
    - `Data.Initiation.InstructedAmount` (object)
        The amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency that the initiating party instructs.
        
        This amount has to be transported unchanged through the transaction chain.
      - `Data.Initiation.InstructedAmount.Amount` (string)
          The amount of money where the unit of currency is explicit and compliant with [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).
      - `Data.Initiation.InstructedAmount.Currency` (string)
          [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code in upper case.
    - `Data.Initiation.CreditorAccount` (object)
        The details to identify the account.
      - `Data.Initiation.CreditorAccount.SchemeName` (enum)
          The name of the identification scheme.
          Possible enum values:

          - `UK.OBIE.IBAN`
          - `UK.OBIE.SortCodeAccountNumber`
          - `US.RoutingNumberAccountNumber`
          - `US.BranchCodeAccountNumber`
      - `Data.Initiation.CreditorAccount.Identification` (string)
          The account ID that the institution assigns to identify an account, which is known by the account owner.
      - `Data.Initiation.CreditorAccount.Name` (string)
          The account name that the account servicing institution assigns.
          
          The account name is the name or names of the account owner(s) represented at an account level.
          
          The account name is not the product name or the nickname of the account.
          
          :::note
          [ASPSP](/docs/guides/build-banking-apps/glossary)s might optionally validate this name to confirm the payee.
          :::
      - `Data.Initiation.CreditorAccount.SecondaryIdentification` (string, optional)
          The secondary account ID that the account servicing institution assigns.
          
          Building societies can use this ID to identify accounts with a roll number in addition to a sort code and account number combination.
    - `Data.Initiation.CreditorPostalAddress` (object, optional)
        The postal address of the creditor, as defined by postal services.
      - `Data.Initiation.CreditorPostalAddress.Department` (string, optional)
          The name of the department.
      - `Data.Initiation.CreditorPostalAddress.SubDepartment` (string, optional)
          The name of the sub-department.
      - `Data.Initiation.CreditorPostalAddress.StreetName` (string, optional)
          The name of the street.
      - `Data.Initiation.CreditorPostalAddress.BuildingNumber` (string, optional)
          The number of the building.
      - `Data.Initiation.CreditorPostalAddress.PostCode` (string, optional)
          The post code of the address.
      - `Data.Initiation.CreditorPostalAddress.TownName` (string, optional)
          The name of the town.
      - `Data.Initiation.CreditorPostalAddress.CountrySubDivision` (string, optional)
          The subdivision of the country, such as state, region, or county.
      - `Data.Initiation.CreditorPostalAddress.Country` (string, optional)
          The name of the country.
      - `Data.Initiation.CreditorPostalAddress.AddressLine` (array of string, optional)
          The information that locates and identifies the address of the creditor, presented in free format text.
    - `Data.Initiation.RemittanceInformation` (object, optional)
        The information used for matching an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system.
      - `Data.Initiation.RemittanceInformation.Unstructured` (string, optional)
          The information used for matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form.
      - `Data.Initiation.RemittanceInformation.Reference` (string, optional)
          The unique reference that the creditor assigns to unambiguously identify the payment transaction.
          
          If available, the initiating party should provide this reference in the structured remittance information to enable reconciliation by the creditor upon receipt of the amount of money.
          
          If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification.
          
          :::note
          Faster Payments Scheme can accept only 18 characters for the `Reference` field.
          :::
          
          :::warning
          Only one reference should be provided, if both `Reference` and `Unstructured` parameters are provided, then the `Unstructured` parameter will be ignored.
          :::
    - `Data.Initiation.DebtorAccount` (object)
        The details to identify the account which was used to approve the payment consent.
        
        This information can be used as a refund address.
      - `Data.Initiation.DebtorAccount.SchemeName` (enum)
          The name of the identification scheme.
          Possible enum values:

          - `UK.OBIE.IBAN`
          - `UK.OBIE.SortCodeAccountNumber`
          - `US.RoutingNumberAccountNumber`
          - `US.BranchCodeAccountNumber`
      - `Data.Initiation.DebtorAccount.Identification` (string)
          The identifier assigned to the account, which is known by the account owner.
      - `Data.Initiation.DebtorAccount.Name` (string, optional)
          The name or names of the account owner(s) represented at an account level.
          
          The account name is not the product name or the nickname of the account.
          
          :::warning[Name validation]
          This field will only return the actual owner(s) name if `DebtorAccount` was not defined in the consent.
          
          If it was defined in the consent, the same value from the consent will be returned.
          :::
      - `Data.Initiation.DebtorAccount.SecondaryIdentification` (string, optional)
          The secondary account ID that the account servicing institution assigns.
          
          Building societies can use this ID to identify accounts with a roll number in addition to a sort code and account number combination.
  - `Data.Permission` (enum, optional)
      The Open Banking service request type.
      Possible enum values:

      - `Create`
- `Links` (object)
    Links relevant to the payload.
  - `Links.Self` (string)
      The absolute URI to the resource.
  - `Links.Next` (string, optional)
      The absolute URI to the next pagination resource.
  - `Links.Prev` (string, optional)
      The absolute URI to the previous pagination resource.
- `Meta` (object)
    Meta data relevant to the payload.
  - `Meta.TotalPages` (integer, optional)
      Used for pagination. Indicates how many pages of results are available.

## Error responses

| HTTP status code | Description |
| --- | --- |
| 400 | Bad request |
| 401 | Unauthorized |
| 403 | Forbidden |
| 405 | Method Not Allowed |
| 406 | Not Acceptable |
| 415 | Unsupported Media Type |
| 429 | Too Many Requests |
| 500 | Internal Server Error |