--- api: 'Open Banking API' --- # Retrieve an international standing order Get the status of an international standing order. See also [Tutorials: Initiate your first payment](/docs/guides/build-banking-apps/tutorials/initiate-your-first-payment#7-check-the-status-of-the-payment). ## Endpoint GET `/international-standing-orders/{InternationalStandingOrderId}` ## 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: `Sun, 10 Sep 2017 19:43:31 UTC`. - `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-customer-user-agent` (string, optional) The user agent that the [PSU](/docs/guides/build-banking-apps/glossary) is using. ### path parameters - `InternationalStandingOrderId` (string, required) The ID of the international standing order payment. ## Returns ### 200 International Standing Orders Read #### Response attributes - `Data` (object) - `Data.InternationalStandingOrderId` (string) The unique ID that the [ASPSP](/docs/guides/build-banking-apps/glossary) assigns to identify the international standing order 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 resource 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 an international standing order. - `Data.Initiation.Frequency` (string) The frequency of the standing order: - `EvryDay`: Every day - `IntrvlWkDay`: Only one week interval is supported (01) and any day within the week (01 to 07) - `IntrvlMnthDay`: Only one month interval is supported (01) and any day within the month (1 to 31) Example values: - `EvryDay` - `IntrvlWkDay:01:0[1-7]` - `IntrvlMnthDay:01:(0[1-9]|[12][0-9]|3[01])` :::warning The day of the interval must agree with the day from `FirstPaymentDateTime`, otherwise, for `POST` requests, the `Unsupported frequency` error is returned. For example: - Correct: `Frequency=IntrvlMnthDay:01:03` and `FirstPaymentDateTime=2026-02-03T14:15:22Z` - the day to schedule the payment is the 3rd day of the month, and the first occurrence will be on the 3rd of February - Incorrect: `Frequency=IntrvlMnthDay:01:03` and `FirstPaymentDateTime=2026-02-17T14:15:22Z` - the day to schedule the payment is the 3rd day of the month, but the first occurrence is set to the 17th of February, so the days don't match. ::: - `Data.Initiation.Reference` (string, optional) The unique reference that the creditor assigns to unambiguously refer to 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. - `Data.Initiation.NumberOfPayments` (string, optional) :::warning Currently, standing orders do not support ending conditions, so using this field will result in an error. ::: The number of payments to make, with the interval set in `frequency`, counting from the start date set in `FirstPaymentDateTime`. - `Data.Initiation.FirstPaymentDateTime` (string) The date and time when the first payment for a standing order schedule is made. 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`. :::warning The day part of the date must agree with the day of the interval set in `Frequency`, otherwise, for `POST` requests, the `Unsupported frequency` error is returned. For example: - Correct: `Frequency=IntrvlMnthDay:01:03` and `FirstPaymentDateTime=2026-02-03T14:15:22Z` - the day to schedule the payment is the 3rd day of the month, and the first occurrence will be on the 3rd of February - Incorrect: `Frequency=IntrvlMnthDay:01:03` and `FirstPaymentDateTime=2026-02-17T14:15:22Z` - the day to schedule the payment is the 3rd day of the month, but the first occurrence is set to the 17th of February, so the days don't match. ::: - `Data.Initiation.FinalPaymentDateTime` (string, optional) :::warning Currently, standing orders do not support ending conditions, so this field is ignored. ::: The date and time when the final payment for a standing order schedule is made. 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.ChargeBearer` (enum, optional) The party or parties bear the charges associated with the processing of the payment transaction. Possible enum values: - `BorneByDebtor` - `FollowingServiceLevel` - `Data.Initiation.CurrencyOfTransfer` (string) The currency of the money to be transferred, which is different from the currency of the debtor's account. - `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.Creditor` (object, optional) The party that an amount of money is due to. - `Data.Initiation.Creditor.Name` (string, optional) The name of a known party used to identify the party. - `Data.Initiation.Creditor.PostalAddress` (object, optional) The postal address of the creditor, as defined by postal services. - `Data.Initiation.Creditor.PostalAddress.Department` (string, optional) The name of the department. - `Data.Initiation.Creditor.PostalAddress.SubDepartment` (string, optional) The name of the sub-department. - `Data.Initiation.Creditor.PostalAddress.StreetName` (string, optional) The name of the street. - `Data.Initiation.Creditor.PostalAddress.BuildingNumber` (string, optional) The number of the building. - `Data.Initiation.Creditor.PostalAddress.PostCode` (string, optional) The post code of the address. - `Data.Initiation.Creditor.PostalAddress.TownName` (string, optional) The name of the town. - `Data.Initiation.Creditor.PostalAddress.CountrySubDivision` (string, optional) The subdivision of the country, such as state, region, or county. - `Data.Initiation.Creditor.PostalAddress.Country` (string, optional) The name of the country. - `Data.Initiation.Creditor.PostalAddress.AddressLine` (array of string, optional) The information that locates and identifies the address of the creditor, presented in free format text. - `Data.Initiation.CreditorAgent` (object, optional) The party that manages the account on behalf of the account owner by: - Managing the registration and booking of entries on the account. - Calculating balances on the account. - Providing information about the account. This is the servicer of the beneficiary account. - `Data.Initiation.CreditorAgent.SchemeName` (array of string, optional) The name of the identification scheme, which is published in an external list. - `Data.Initiation.CreditorAgent.Identification` (string, optional) The unique ID of the servicing institution. - `Data.Initiation.CreditorAgent.Name` (string, optional) The name of a known agent used to identify the agent. - `Data.Initiation.CreditorAgent.PostalAddress` (object, optional) The postal address of the creditor, as defined by postal services. - `Data.Initiation.CreditorAgent.PostalAddress.Department` (string, optional) The name of the department. - `Data.Initiation.CreditorAgent.PostalAddress.SubDepartment` (string, optional) The name of the sub-department. - `Data.Initiation.CreditorAgent.PostalAddress.StreetName` (string, optional) The name of the street. - `Data.Initiation.CreditorAgent.PostalAddress.BuildingNumber` (string, optional) The number of the building. - `Data.Initiation.CreditorAgent.PostalAddress.PostCode` (string, optional) The post code of the address. - `Data.Initiation.CreditorAgent.PostalAddress.TownName` (string, optional) The name of the town. - `Data.Initiation.CreditorAgent.PostalAddress.CountrySubDivision` (string, optional) The subdivision of the country, such as state, region, or county. - `Data.Initiation.CreditorAgent.PostalAddress.Country` (string, optional) The name of the country. - `Data.Initiation.CreditorAgent.PostalAddress.AddressLine` (array of string, optional) The information that locates and identifies the address of the creditor, presented in free format text. - `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.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 | | 429 | Too Many Requests | | 500 | Internal Server Error |