PaymentInitiationAPI

Swagger for Payment Initiation API Specification
More information: https://helloreverb.com
Contact Info: ServiceDesk@openbanking.org.uk
Version: v3.1
BasePath:/open-banking/v3.1/pisp
open-licence
https://www.openbanking.org.uk/open-licence

Access

  1. OAuth AuthorizationUrl:https://authserver.example/authorizationTokenUrl:https://authserver.example/token
  2. OAuth AuthorizationUrl:TokenUrl:https://authserver.example/token
  3. OAuth AuthorizationUrl:https://apim.dev02.bank.local:8243/authorizeTokenUrl:

Methods

[ Jump to Models ]

Table of Contents

DomesticPayments

DomesticScheduledPayments

DomesticStandingOrders

FilePayments

InternationalPayments

InternationalScheduledPayments

InternationalStandingOrders

DomesticPayments

Up
post /domestic-payment-consents
Create Domestic Payment Consents (createDomesticPaymentConsents)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

OBWriteDomesticConsent2Param OBWriteDomesticConsent2 (required)
Body Parameter Default

Request headers

Return type

OBWriteDomesticConsentResponse2

Example data

Content-Type: application/json
{
  "Meta" : {
    "FirstAvailableDateTime" : { },
    "TotalPages" : 0
  },
  "Risk" : {
    "PaymentContextCode" : { },
    "DeliveryAddress" : {
      "StreetName" : "StreetName",
      "CountrySubDivision" : "",
      "AddressLine" : "",
      "BuildingNumber" : "BuildingNumber",
      "TownName" : "TownName",
      "Country" : "Country",
      "PostCode" : "PostCode"
    },
    "MerchantCategoryCode" : "MerchantCategoryCode",
    "MerchantCustomerIdentification" : "MerchantCustomerIdentification"
  },
  "Links" : {
    "Last" : "http://example.com/aeiou",
    "Prev" : "http://example.com/aeiou",
    "Next" : "http://example.com/aeiou",
    "Self" : "http://example.com/aeiou",
    "First" : "http://example.com/aeiou"
  },
  "Data" : {
    "Status" : { },
    "StatusUpdateDateTime" : "2000-01-23T04:56:07.000+00:00",
    "CreationDateTime" : "2000-01-23T04:56:07.000+00:00",
    "ExpectedExecutionDateTime" : "2000-01-23T04:56:07.000+00:00",
    "CutOffDateTime" : "2000-01-23T04:56:07.000+00:00",
    "Authorisation" : {
      "CompletionDateTime" : "2000-01-23T04:56:07.000+00:00",
      "AuthorisationType" : { }
    },
    "Charges" : [ {
      "Type" : [ "UK.OBIE.CHAPSOut", "UK.OBIE.BalanceTransferOut", "UK.OBIE.MoneyTransferOut" ],
      "Amount" : {
        "Amount" : {
          "Amount" : "Amount",
          "Currency" : "Currency"
        },
        "Currency" : "Currency"
      },
      "ChargeBearer" : { }
    }, {
      "Type" : [ "UK.OBIE.CHAPSOut", "UK.OBIE.BalanceTransferOut", "UK.OBIE.MoneyTransferOut" ],
      "Amount" : {
        "Amount" : {
          "Amount" : "Amount",
          "Currency" : "Currency"
        },
        "Currency" : "Currency"
      },
      "ChargeBearer" : { }
    } ],
    "ConsentId" : "ConsentId",
    "Initiation" : {
      "SupplementaryData" : { },
      "LocalInstrument" : [ "UK.OBIE.BACS", "UK.OBIE.BalanceTransfer", "UK.OBIE.CHAPS", "UK.OBIE.Euro1", "UK.OBIE.FPS", "UK.OBIE.Link", "UK.OBIE.MoneyTransfer", "UK.OBIE.Paym", "UK.OBIE.SEPACreditTransfer", "UK.OBIE.SEPAInstantCreditTransfer", "UK.OBIE.SWIFT", "UK.OBIE.Target2" ],
      "DebtorAccount" : {
        "SecondaryIdentification" : "SecondaryIdentification",
        "SchemeName" : [ "UK.OBIE.BBAN", "UK.OBIE.IBAN", "UK.OBIE.PAN", "UK.OBIE.Paym", "UK.OBIE.SortCodeAccountNumber" ],
        "Identification" : "Identification",
        "Name" : "Name"
      },
      "RemittanceInformation" : {
        "Unstructured" : "Unstructured",
        "Reference" : "Reference"
      },
      "EndToEndIdentification" : "EndToEndIdentification",
      "InstructionIdentification" : "InstructionIdentification",
      "CreditorAccount" : {
        "SecondaryIdentification" : "SecondaryIdentification",
        "SchemeName" : [ "UK.OBIE.BBAN", "UK.OBIE.IBAN", "UK.OBIE.PAN", "UK.OBIE.Paym", "UK.OBIE.SortCodeAccountNumber" ],
        "Identification" : "Identification",
        "Name" : "Name"
      },
      "InstructedAmount" : {
        "Amount" : "Amount",
        "Currency" : "Currency"
      },
      "CreditorPostalAddress" : {
        "StreetName" : "StreetName",
        "CountrySubDivision" : "CountrySubDivision",
        "Department" : "Department",
        "AddressLine" : "",
        "BuildingNumber" : "BuildingNumber",
        "TownName" : "TownName",
        "Country" : "Country",
        "SubDepartment" : "SubDepartment",
        "AddressType" : { },
        "PostCode" : "PostCode"
      }
    },
    "ExpectedSettlementDateTime" : "2000-01-23T04:56:07.000+00:00"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Domestic Payment Consents Created OBWriteDomesticConsentResponse2

400

Bad request OBErrorResponse1

401

Unauthorized

403

Forbidden

405

Method Not Allowed

406

Not Acceptable

415

Unsupported Media Type

429

Too Many Requests

500

Internal Server Error OBErrorResponse1

Up
post /domestic-payments
Create Domestic Payments (createDomesticPayments)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

OBWriteDomestic2Param OBWriteDomestic2 (required)
Body Parameter Default

Request headers

Return type

OBWriteDomesticResponse2

Example data

Content-Type: application/json
{
  "Meta" : {
    "FirstAvailableDateTime" : { },
    "TotalPages" : 0
  },
  "Links" : {
    "Last" : "http://example.com/aeiou",
    "Prev" : "http://example.com/aeiou",
    "Next" : "http://example.com/aeiou",
    "Self" : "http://example.com/aeiou",
    "First" : "http://example.com/aeiou"
  },
  "Data" : {
    "DomesticPaymentId" : "DomesticPaymentId",
    "Status" : { },
    "StatusUpdateDateTime" : "2000-01-23T04:56:07.000+00:00",
    "CreationDateTime" : "2000-01-23T04:56:07.000+00:00",
    "ExpectedExecutionDateTime" : "2000-01-23T04:56:07.000+00:00",
    "Charges" : [ {
      "Type" : [ "UK.OBIE.CHAPSOut", "UK.OBIE.BalanceTransferOut", "UK.OBIE.MoneyTransferOut" ],
      "Amount" : {
        "Amount" : {
          "Amount" : "Amount",
          "Currency" : "Currency"
        },
        "Currency" : "Currency"
      },
      "ChargeBearer" : { }
    }, {
      "Type" : [ "UK.OBIE.CHAPSOut", "UK.OBIE.BalanceTransferOut", "UK.OBIE.MoneyTransferOut" ],
      "Amount" : {
        "Amount" : {
          "Amount" : "Amount",
          "Currency" : "Currency"
        },
        "Currency" : "Currency"
      },
      "ChargeBearer" : { }
    } ],
    "ConsentId" : "ConsentId",
    "Initiation" : {
      "SupplementaryData" : { },
      "LocalInstrument" : [ "UK.OBIE.BACS", "UK.OBIE.BalanceTransfer", "UK.OBIE.CHAPS", "UK.OBIE.Euro1", "UK.OBIE.FPS", "UK.OBIE.Link", "UK.OBIE.MoneyTransfer", "UK.OBIE.Paym", "UK.OBIE.SEPACreditTransfer", "UK.OBIE.SEPAInstantCreditTransfer", "UK.OBIE.SWIFT", "UK.OBIE.Target2" ],
      "DebtorAccount" : {
        "SecondaryIdentification" : "SecondaryIdentification",
        "SchemeName" : [ "UK.OBIE.BBAN", "UK.OBIE.IBAN", "UK.OBIE.PAN", "UK.OBIE.Paym", "UK.OBIE.SortCodeAccountNumber" ],
        "Identification" : "Identification",
        "Name" : "Name"
      },
      "RemittanceInformation" : {
        "Unstructured" : "Unstructured",
        "Reference" : "Reference"
      },
      "EndToEndIdentification" : "EndToEndIdentification",
      "InstructionIdentification" : "InstructionIdentification",
      "CreditorAccount" : {
        "SecondaryIdentification" : "SecondaryIdentification",
        "SchemeName" : [ "UK.OBIE.BBAN", "UK.OBIE.IBAN", "UK.OBIE.PAN", "UK.OBIE.Paym", "UK.OBIE.SortCodeAccountNumber" ],
        "Identification" : "Identification",
        "Name" : "Name"
      },
      "InstructedAmount" : {
        "Amount" : "Amount",
        "Currency" : "Currency"
      },
      "CreditorPostalAddress" : {
        "StreetName" : "StreetName",
        "CountrySubDivision" : "CountrySubDivision",
        "Department" : "Department",
        "AddressLine" : "",
        "BuildingNumber" : "BuildingNumber",
        "TownName" : "TownName",
        "Country" : "Country",
        "SubDepartment" : "SubDepartment",
        "AddressType" : { },
        "PostCode" : "PostCode"
      }
    },
    "ExpectedSettlementDateTime" : "2000-01-23T04:56:07.000+00:00",
    "MultiAuthorisation" : {
      "Status" : { },
      "NumberReceived" : 6,
      "LastUpdateDateTime" : "2000-01-23T04:56:07.000+00:00",
      "ExpirationDateTime" : "2000-01-23T04:56:07.000+00:00",
      "NumberRequired" : 0
    }
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Domestic Payments Created OBWriteDomesticResponse2

400

Bad request OBErrorResponse1

401

Unauthorized

403

Forbidden

405

Method Not Allowed

406

Not Acceptable

415

Unsupported Media Type

429

Too Many Requests

500

Internal Server Error OBErrorResponse1

Up
get /domestic-payment-consents/{ConsentId}
Get Domestic Payment Consents (getDomesticPaymentConsentsConsentId)

Path parameters

ConsentId (required)
Path Parameter ConsentId

Consumes

This API call consumes the following media types via the Content-Type request header:

Request headers

Return type

OBWriteDomesticConsentResponse2

Example data

Content-Type: application/json
{
  "Meta" : {
    "FirstAvailableDateTime" : { },
    "TotalPages" : 0
  },
  "Risk" : {
    "PaymentContextCode" : { },
    "DeliveryAddress" : {
      "StreetName" : "StreetName",
      "CountrySubDivision" : "",
      "AddressLine" : "",
      "BuildingNumber" : "BuildingNumber",
      "TownName" : "TownName",
      "Country" : "Country",
      "PostCode" : "PostCode"
    },
    "MerchantCategoryCode" : "MerchantCategoryCode",
    "MerchantCustomerIdentification" : "MerchantCustomerIdentification"
  },
  "Links" : {
    "Last" : "http://example.com/aeiou",
    "Prev" : "http://example.com/aeiou",
    "Next" : "http://example.com/aeiou",
    "Self" : "http://example.com/aeiou",
    "First" : "http://example.com/aeiou"
  },
  "Data" : {
    "Status" : { },
    "StatusUpdateDateTime" : "2000-01-23T04:56:07.000+00:00",
    "CreationDateTime" : "2000-01-23T04:56:07.000+00:00",
    "ExpectedExecutionDateTime" : "2000-01-23T04:56:07.000+00:00",
    "CutOffDateTime" : "2000-01-23T04:56:07.000+00:00",
    "Authorisation" : {
      "CompletionDateTime" : "2000-01-23T04:56:07.000+00:00",
      "AuthorisationType" : { }
    },
    "Charges" : [ {
      "Type" : [ "UK.OBIE.CHAPSOut", "UK.OBIE.BalanceTransferOut", "UK.OBIE.MoneyTransferOut" ],
      "Amount" : {
        "Amount" : {
          "Amount" : "Amount",
          "Currency" : "Currency"
        },
        "Currency" : "Currency"
      },
      "ChargeBearer" : { }
    }, {
      "Type" : [ "UK.OBIE.CHAPSOut", "UK.OBIE.BalanceTransferOut", "UK.OBIE.MoneyTransferOut" ],
      "Amount" : {
        "Amount" : {
          "Amount" : "Amount",
          "Currency" : "Currency"
        },
        "Currency" : "Currency"
      },
      "ChargeBearer" : { }
    } ],
    "ConsentId" : "ConsentId",
    "Initiation" : {
      "SupplementaryData" : { },
      "LocalInstrument" : [ "UK.OBIE.BACS", "UK.OBIE.BalanceTransfer", "UK.OBIE.CHAPS", "UK.OBIE.Euro1", "UK.OBIE.FPS", "UK.OBIE.Link", "UK.OBIE.MoneyTransfer", "UK.OBIE.Paym", "UK.OBIE.SEPACreditTransfer", "UK.OBIE.SEPAInstantCreditTransfer", "UK.OBIE.SWIFT", "UK.OBIE.Target2" ],
      "DebtorAccount" : {
        "SecondaryIdentification" : "SecondaryIdentification",
        "SchemeName" : [ "UK.OBIE.BBAN", "UK.OBIE.IBAN", "UK.OBIE.PAN", "UK.OBIE.Paym", "UK.OBIE.SortCodeAccountNumber" ],
        "Identification" : "Identification",
        "Name" : "Name"
      },
      "RemittanceInformation" : {
        "Unstructured" : "Unstructured",
        "Reference" : "Reference"
      },
      "EndToEndIdentification" : "EndToEndIdentification",
      "InstructionIdentification" : "InstructionIdentification",
      "CreditorAccount" : {
        "SecondaryIdentification" : "SecondaryIdentification",
        "SchemeName" : [ "UK.OBIE.BBAN", "UK.OBIE.IBAN", "UK.OBIE.PAN", "UK.OBIE.Paym", "UK.OBIE.SortCodeAccountNumber" ],
        "Identification" : "Identification",
        "Name" : "Name"
      },
      "InstructedAmount" : {
        "Amount" : "Amount",
        "Currency" : "Currency"
      },
      "CreditorPostalAddress" : {
        "StreetName" : "StreetName",
        "CountrySubDivision" : "CountrySubDivision",
        "Department" : "Department",
        "AddressLine" : "",
        "BuildingNumber" : "BuildingNumber",
        "TownName" : "TownName",
        "Country" : "Country",
        "SubDepartment" : "SubDepartment",
        "AddressType" : { },
        "PostCode" : "PostCode"
      }
    },
    "ExpectedSettlementDateTime" : "2000-01-23T04:56:07.000+00:00"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Domestic Payment Consents Read OBWriteDomesticConsentResponse2

400

Bad request OBErrorResponse1

401

Unauthorized

403

Forbidden

405

Method Not Allowed

406

Not Acceptable

429

Too Many Requests

500

Internal Server Error OBErrorResponse1

Up
get /domestic-payment-consents/{ConsentId}/funds-confirmation
Get Domestic Payment Consents Funds Confirmation (getDomesticPaymentConsentsConsentIdFundsConfirmation)

Path parameters

ConsentId (required)
Path Parameter ConsentId

Consumes

This API call consumes the following media types via the Content-Type request header:

Request headers

Return type

OBWriteFundsConfirmationResponse1

Example data

Content-Type: application/json
{
  "Meta" : {
    "FirstAvailableDateTime" : { },
    "TotalPages" : 0
  },
  "Links" : {
    "Last" : "http://example.com/aeiou",
    "Prev" : "http://example.com/aeiou",
    "Next" : "http://example.com/aeiou",
    "Self" : "http://example.com/aeiou",
    "First" : "http://example.com/aeiou"
  },
  "Data" : {
    "SupplementaryData" : { },
    "FundsAvailableResult" : {
      "FundsAvailableDateTime" : "2000-01-23T04:56:07.000+00:00",
      "FundsAvailable" : true
    }
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Domestic Payment Consents Funds Confirmation Read OBWriteFundsConfirmationResponse1

400

Bad request OBErrorResponse1

401

Unauthorized

403

Forbidden

405

Method Not Allowed

406

Not Acceptable

429

Too Many Requests

500

Internal Server Error OBErrorResponse1

Up
get /domestic-payments/{DomesticPaymentId}
Get Domestic Payments (getDomesticPaymentsDomesticPaymentId)

Path parameters

DomesticPaymentId (required)
Path Parameter DomesticPaymentId

Consumes

This API call consumes the following media types via the Content-Type request header:

Request headers

Return type

OBWriteDomesticResponse2

Example data

Content-Type: application/json
{
  "Meta" : {
    "FirstAvailableDateTime" : { },
    "TotalPages" : 0
  },
  "Links" : {
    "Last" : "http://example.com/aeiou",
    "Prev" : "http://example.com/aeiou",
    "Next" : "http://example.com/aeiou",
    "Self" : "http://example.com/aeiou",
    "First" : "http://example.com/aeiou"
  },
  "Data" : {
    "DomesticPaymentId" : "DomesticPaymentId",
    "Status" : { },
    "StatusUpdateDateTime" : "2000-01-23T04:56:07.000+00:00",
    "CreationDateTime" : "2000-01-23T04:56:07.000+00:00",
    "ExpectedExecutionDateTime" : "2000-01-23T04:56:07.000+00:00",
    "Charges" : [ {
      "Type" : [ "UK.OBIE.CHAPSOut", "UK.OBIE.BalanceTransferOut", "UK.OBIE.MoneyTransferOut" ],
      "Amount" : {
        "Amount" : {
          "Amount" : "Amount",
          "Currency" : "Currency"
        },
        "Currency" : "Currency"
      },
      "ChargeBearer" : { }
    }, {
      "Type" : [ "UK.OBIE.CHAPSOut", "UK.OBIE.BalanceTransferOut", "UK.OBIE.MoneyTransferOut" ],
      "Amount" : {
        "Amount" : {
          "Amount" : "Amount",
          "Currency" : "Currency"
        },
        "Currency" : "Currency"
      },
      "ChargeBearer" : { }
    } ],
    "ConsentId" : "ConsentId",
    "Initiation" : {
      "SupplementaryData" : { },
      "LocalInstrument" : [ "UK.OBIE.BACS", "UK.OBIE.BalanceTransfer", "UK.OBIE.CHAPS", "UK.OBIE.Euro1", "UK.OBIE.FPS", "UK.OBIE.Link", "UK.OBIE.MoneyTransfer", "UK.OBIE.Paym", "UK.OBIE.SEPACreditTransfer", "UK.OBIE.SEPAInstantCreditTransfer", "UK.OBIE.SWIFT", "UK.OBIE.Target2" ],
      "DebtorAccount" : {
        "SecondaryIdentification" : "SecondaryIdentification",
        "SchemeName" : [ "UK.OBIE.BBAN", "UK.OBIE.IBAN", "UK.OBIE.PAN", "UK.OBIE.Paym", "UK.OBIE.SortCodeAccountNumber" ],
        "Identification" : "Identification",
        "Name" : "Name"
      },
      "RemittanceInformation" : {
        "Unstructured" : "Unstructured",
        "Reference" : "Reference"
      },
      "EndToEndIdentification" : "EndToEndIdentification",
      "InstructionIdentification" : "InstructionIdentification",
      "CreditorAccount" : {
        "SecondaryIdentification" : "SecondaryIdentification",
        "SchemeName" : [ "UK.OBIE.BBAN", "UK.OBIE.IBAN", "UK.OBIE.PAN", "UK.OBIE.Paym", "UK.OBIE.SortCodeAccountNumber" ],
        "Identification" : "Identification",
        "Name" : "Name"
      },
      "InstructedAmount" : {
        "Amount" : "Amount",
        "Currency" : "Currency"
      },
      "CreditorPostalAddress" : {
        "StreetName" : "StreetName",
        "CountrySubDivision" : "CountrySubDivision",
        "Department" : "Department",
        "AddressLine" : "",
        "BuildingNumber" : "BuildingNumber",
        "TownName" : "TownName",
        "Country" : "Country",
        "SubDepartment" : "SubDepartment",
        "AddressType" : { },
        "PostCode" : "PostCode"
      }
    },
    "ExpectedSettlementDateTime" : "2000-01-23T04:56:07.000+00:00",
    "MultiAuthorisation" : {
      "Status" : { },
      "NumberReceived" : 6,
      "LastUpdateDateTime" : "2000-01-23T04:56:07.000+00:00",
      "ExpirationDateTime" : "2000-01-23T04:56:07.000+00:00",
      "NumberRequired" : 0
    }
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Domestic Payments Read OBWriteDomesticResponse2

400

Bad request OBErrorResponse1

401

Unauthorized

403

Forbidden

405

Method Not Allowed

406

Not Acceptable

429

Too Many Requests

500

Internal Server Error OBErrorResponse1

DomesticScheduledPayments

Up
post /domestic-scheduled-payment-consents
Create Domestic Scheduled Payment Consents (createDomesticScheduledPaymentConsents)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

OBWriteDomesticScheduledConsent2Param OBWriteDomesticScheduledConsent2 (required)
Body Parameter Default

Request headers

Return type

OBWriteDomesticScheduledConsentResponse2

Example data

Content-Type: application/json
{
  "Meta" : {
    "FirstAvailableDateTime" : { },
    "TotalPages" : 0
  },
  "Risk" : {
    "PaymentContextCode" : { },
    "DeliveryAddress" : {
      "StreetName" : "StreetName",
      "CountrySubDivision" : "",
      "AddressLine" : "",
      "BuildingNumber" : "BuildingNumber",
      "TownName" : "TownName",
      "Country" : "Country",
      "PostCode" : "PostCode"
    },
    "MerchantCategoryCode" : "MerchantCategoryCode",
    "MerchantCustomerIdentification" : "MerchantCustomerIdentification"
  },
  "Links" : {
    "Last" : "http://example.com/aeiou",
    "Prev" : "http://example.com/aeiou",
    "Next" : "http://example.com/aeiou",
    "Self" : "http://example.com/aeiou",
    "First" : "http://example.com/aeiou"
  },
  "Data" : {
    "Status" : { },
    "StatusUpdateDateTime" : "2000-01-23T04:56:07.000+00:00",
    "CreationDateTime" : "2000-01-23T04:56:07.000+00:00",
    "ExpectedExecutionDateTime" : "2000-01-23T04:56:07.000+00:00",
    "CutOffDateTime" : "2000-01-23T04:56:07.000+00:00",
    "Authorisation" : {
      "CompletionDateTime" : "2000-01-23T04:56:07.000+00:00",
      "AuthorisationType" : { }
    },
    "Permission" : { },
    "Charges" : [ {
      "Type" : [ "UK.OBIE.CHAPSOut", "UK.OBIE.BalanceTransferOut", "UK.OBIE.MoneyTransferOut" ],
      "Amount" : {
        "Amount" : {
          "Amount" : "Amount",
          "Currency" : "Currency"
        },
        "Currency" : "Currency"
      },
      "ChargeBearer" : { }
    }, {
      "Type" : [ "UK.OBIE.CHAPSOut", "UK.OBIE.BalanceTransferOut", "UK.OBIE.MoneyTransferOut" ],
      "Amount" : {
        "Amount" : {
          "Amount" : "Amount",
          "Currency" : "Currency"
        },
        "Currency" : "Currency"
      },
      "ChargeBearer" : { }
    } ],
    "ConsentId" : "ConsentId",
    "Initiation" : {
      "SupplementaryData" : { },
      "LocalInstrument" : [ "UK.OBIE.BACS", "UK.OBIE.BalanceTransfer", "UK.OBIE.CHAPS", "UK.OBIE.Euro1", "UK.OBIE.FPS", "UK.OBIE.Link", "UK.OBIE.MoneyTransfer", "UK.OBIE.Paym", "UK.OBIE.SEPACreditTransfer", "UK.OBIE.SEPAInstantCreditTransfer", "UK.OBIE.SWIFT", "UK.OBIE.Target2" ],
      "DebtorAccount" : {
        "SecondaryIdentification" : "SecondaryIdentification",
        "SchemeName" : [ "UK.OBIE.BBAN", "UK.OBIE.IBAN", "UK.OBIE.PAN", "UK.OBIE.Paym", "UK.OBIE.SortCodeAccountNumber" ],
        "Identification" : "Identification",
        "Name" : "Name"
      },
      "RemittanceInformation" : {
        "Unstructured" : "Unstructured",
        "Reference" : "Reference"
      },
      "EndToEndIdentification" : "EndToEndIdentification",
      "InstructionIdentification" : "InstructionIdentification",
      "CreditorAccount" : {
        "SecondaryIdentification" : "SecondaryIdentification",
        "SchemeName" : [ "UK.OBIE.BBAN", "UK.OBIE.IBAN", "UK.OBIE.PAN", "UK.OBIE.Paym", "UK.OBIE.SortCodeAccountNumber" ],
        "Identification" : "Identification",
        "Name" : "Name"
      },
      "RequestedExecutionDateTime" : "2000-01-23T04:56:07.000+00:00",
      "InstructedAmount" : {
        "Amount" : "Amount",
        "Currency" : "Currency"
      },
      "CreditorPostalAddress" : {
        "StreetName" : "StreetName",
        "CountrySubDivision" : "CountrySubDivision",
        "Department" : "Department",
        "AddressLine" : "",
        "BuildingNumber" : "BuildingNumber",
        "TownName" : "TownName",
        "Country" : "Country",
        "SubDepartment" : "SubDepartment",
        "AddressType" : { },
        "PostCode" : "PostCode"
      }
    },
    "ExpectedSettlementDateTime" : "2000-01-23T04:56:07.000+00:00"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Domestic Scheduled Payment Consents Created OBWriteDomesticScheduledConsentResponse2

400

Bad request OBErrorResponse1

401

Unauthorized

403

Forbidden

404

Not found

405

Method Not Allowed

406

Not Acceptable

415

Unsupported Media Type

429

Too Many Requests

500

Internal Server Error OBErrorResponse1

Up
post /domestic-scheduled-payments
Create Domestic Scheduled Payments (createDomesticScheduledPayments)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

OBWriteDomesticScheduled2Param OBWriteDomesticScheduled2 (required)
Body Parameter Default

Request headers

Return type

OBWriteDomesticScheduledResponse2

Example data

Content-Type: application/json
{
  "Meta" : {
    "FirstAvailableDateTime" : { },
    "TotalPages" : 0
  },
  "Links" : {
    "Last" : "http://example.com/aeiou",
    "Prev" : "http://example.com/aeiou",
    "Next" : "http://example.com/aeiou",
    "Self" : "http://example.com/aeiou",
    "First" : "http://example.com/aeiou"
  },
  "Data" : {
    "Status" : { },
    "StatusUpdateDateTime" : "2000-01-23T04:56:07.000+00:00",
    "CreationDateTime" : "2000-01-23T04:56:07.000+00:00",
    "ExpectedExecutionDateTime" : "2000-01-23T04:56:07.000+00:00",
    "DomesticScheduledPaymentId" : "DomesticScheduledPaymentId",
    "Charges" : [ {
      "Type" : [ "UK.OBIE.CHAPSOut", "UK.OBIE.BalanceTransferOut", "UK.OBIE.MoneyTransferOut" ],
      "Amount" : {
        "Amount" : {
          "Amount" : "Amount",
          "Currency" : "Currency"
        },
        "Currency" : "Currency"
      },
      "ChargeBearer" : { }
    }, {
      "Type" : [ "UK.OBIE.CHAPSOut", "UK.OBIE.BalanceTransferOut", "UK.OBIE.MoneyTransferOut" ],
      "Amount" : {
        "Amount" : {
          "Amount" : "Amount",
          "Currency" : "Currency"
        },
        "Currency" : "Currency"
      },
      "ChargeBearer" : { }
    } ],
    "ConsentId" : "ConsentId",
    "Initiation" : {
      "SupplementaryData" : { },
      "LocalInstrument" : [ "UK.OBIE.BACS", "UK.OBIE.BalanceTransfer", "UK.OBIE.CHAPS", "UK.OBIE.Euro1", "UK.OBIE.FPS", "UK.OBIE.Link", "UK.OBIE.MoneyTransfer", "UK.OBIE.Paym", "UK.OBIE.SEPACreditTransfer", "UK.OBIE.SEPAInstantCreditTransfer", "UK.OBIE.SWIFT", "UK.OBIE.Target2" ],
      "DebtorAccount" : {
        "SecondaryIdentification" : "SecondaryIdentification",
        "SchemeName" : [ "UK.OBIE.BBAN", "UK.OBIE.IBAN", "UK.OBIE.PAN", "UK.OBIE.Paym", "UK.OBIE.SortCodeAccountNumber" ],
        "Identification" : "Identification",
        "Name" : "Name"
      },
      "RemittanceInformation" : {
        "Unstructured" : "Unstructured",
        "Reference" : "Reference"
      },
      "EndToEndIdentification" : "EndToEndIdentification",
      "InstructionIdentification" : "InstructionIdentification",
      "CreditorAccount" : {
        "SecondaryIdentification" : "SecondaryIdentification",
        "SchemeName" : [ "UK.OBIE.BBAN", "UK.OBIE.IBAN", "UK.OBIE.PAN", "UK.OBIE.Paym", "UK.OBIE.SortCodeAccountNumber" ],
        "Identification" : "Identification",
        "Name" : "Name"
      },
      "RequestedExecutionDateTime" : "2000-01-23T04:56:07.000+00:00",
      "InstructedAmount" : {
        "Amount" : "Amount",
        "Currency" : "Currency"
      },
      "CreditorPostalAddress" : {
        "StreetName" : "StreetName",
        "CountrySubDivision" : "CountrySubDivision",
        "Department" : "Department",
        "AddressLine" : "",
        "BuildingNumber" : "BuildingNumber",
        "TownName" : "TownName",
        "Country" : "Country",
        "SubDepartment" : "SubDepartment",
        "AddressType" : { },
        "PostCode" : "PostCode"
      }
    },
    "ExpectedSettlementDateTime" : "2000-01-23T04:56:07.000+00:00",
    "MultiAuthorisation" : {
      "Status" : { },
      "NumberReceived" : 6,
      "LastUpdateDateTime" : "2000-01-23T04:56:07.000+00:00",
      "ExpirationDateTime" : "2000-01-23T04:56:07.000+00:00",
      "NumberRequired" : 0
    }
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Domestic Scheduled Payments Created OBWriteDomesticScheduledResponse2

400

Bad request OBErrorResponse1

401

Unauthorized

403

Forbidden

404

Not found

405

Method Not Allowed

406

Not Acceptable

415

Unsupported Media Type

429

Too Many Requests

500

Internal Server Error OBErrorResponse1

Up
get /domestic-scheduled-payment-consents/{ConsentId}
Get Domestic Scheduled Payment Consents (getDomesticScheduledPaymentConsentsConsentId)

Path parameters

ConsentId (required)
Path Parameter ConsentId

Consumes

This API call consumes the following media types via the Content-Type request header:

Request headers

Return type

OBWriteDomesticScheduledConsentResponse2

Example data

Content-Type: application/json
{
  "Meta" : {
    "FirstAvailableDateTime" : { },
    "TotalPages" : 0
  },
  "Risk" : {
    "PaymentContextCode" : { },
    "DeliveryAddress" : {
      "StreetName" : "StreetName",
      "CountrySubDivision" : "",
      "AddressLine" : "",
      "BuildingNumber" : "BuildingNumber",
      "TownName" : "TownName",
      "Country" : "Country",
      "PostCode" : "PostCode"
    },
    "MerchantCategoryCode" : "MerchantCategoryCode",
    "MerchantCustomerIdentification" : "MerchantCustomerIdentification"
  },
  "Links" : {
    "Last" : "http://example.com/aeiou",
    "Prev" : "http://example.com/aeiou",
    "Next" : "http://example.com/aeiou",
    "Self" : "http://example.com/aeiou",
    "First" : "http://example.com/aeiou"
  },
  "Data" : {
    "Status" : { },
    "StatusUpdateDateTime" : "2000-01-23T04:56:07.000+00:00",
    "CreationDateTime" : "2000-01-23T04:56:07.000+00:00",
    "ExpectedExecutionDateTime" : "2000-01-23T04:56:07.000+00:00",
    "CutOffDateTime" : "2000-01-23T04:56:07.000+00:00",
    "Authorisation" : {
      "CompletionDateTime" : "2000-01-23T04:56:07.000+00:00",
      "AuthorisationType" : { }
    },
    "Permission" : { },
    "Charges" : [ {
      "Type" : [ "UK.OBIE.CHAPSOut", "UK.OBIE.BalanceTransferOut", "UK.OBIE.MoneyTransferOut" ],
      "Amount" : {
        "Amount" : {
          "Amount" : "Amount",
          "Currency" : "Currency"
        },
        "Currency" : "Currency"
      },
      "ChargeBearer" : { }
    }, {
      "Type" : [ "UK.OBIE.CHAPSOut", "UK.OBIE.BalanceTransferOut", "UK.OBIE.MoneyTransferOut" ],
      "Amount" : {
        "Amount" : {
          "Amount" : "Amount",
          "Currency" : "Currency"
        },
        "Currency" : "Currency"
      },
      "ChargeBearer" : { }
    } ],
    "ConsentId" : "ConsentId",
    "Initiation" : {
      "SupplementaryData" : { },
      "LocalInstrument" : [ "UK.OBIE.BACS", "UK.OBIE.BalanceTransfer", "UK.OBIE.CHAPS", "UK.OBIE.Euro1", "UK.OBIE.FPS", "UK.OBIE.Link", "UK.OBIE.MoneyTransfer", "UK.OBIE.Paym", "UK.OBIE.SEPACreditTransfer", "UK.OBIE.SEPAInstantCreditTransfer", "UK.OBIE.SWIFT", "UK.OBIE.Target2" ],
      "DebtorAccount" : {
        "SecondaryIdentification" : "SecondaryIdentification",
        "SchemeName" : [ "UK.OBIE.BBAN", "UK.OBIE.IBAN", "UK.OBIE.PAN", "UK.OBIE.Paym", "UK.OBIE.SortCodeAccountNumber" ],
        "Identification" : "Identification",
        "Name" : "Name"
      },
      "RemittanceInformation" : {
        "Unstructured" : "Unstructured",
        "Reference" : "Reference"
      },
      "EndToEndIdentification" : "EndToEndIdentification",
      "InstructionIdentification" : "InstructionIdentification",
      "CreditorAccount" : {
        "SecondaryIdentification" : "SecondaryIdentification",
        "SchemeName" : [ "UK.OBIE.BBAN", "UK.OBIE.IBAN", "UK.OBIE.PAN", "UK.OBIE.Paym", "UK.OBIE.SortCodeAccountNumber" ],
        "Identification" : "Identification",
        "Name" : "Name"
      },
      "RequestedExecutionDateTime" : "2000-01-23T04:56:07.000+00:00",
      "InstructedAmount" : {
        "Amount" : "Amount",
        "Currency" : "Currency"
      },
      "CreditorPostalAddress" : {
        "StreetName" : "StreetName",
        "CountrySubDivision" : "CountrySubDivision",
        "Department" : "Department",
        "AddressLine" : "",
        "BuildingNumber" : "BuildingNumber",
        "TownName" : "TownName",
        "Country" : "Country",
        "SubDepartment" : "SubDepartment",
        "AddressType" : { },
        "PostCode" : "PostCode"
      }
    },
    "ExpectedSettlementDateTime" : "2000-01-23T04:56:07.000+00:00"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Domestic Scheduled Payment Consents Read OBWriteDomesticScheduledConsentResponse2

400

Bad request OBErrorResponse1

401

Unauthorized

403

Forbidden

404

Not found

405

Method Not Allowed

406

Not Acceptable

429

Too Many Requests

500

Internal Server Error OBErrorResponse1

Up
get /domestic-scheduled-payments/{DomesticScheduledPaymentId}
Get Domestic Scheduled Payments (getDomesticScheduledPaymentsDomesticScheduledPaymentId)

Path parameters

DomesticScheduledPaymentId (required)
Path Parameter DomesticScheduledPaymentId

Consumes

This API call consumes the following media types via the Content-Type request header:

Request headers

Return type

OBWriteDomesticScheduledResponse2

Example data

Content-Type: application/json
{
  "Meta" : {
    "FirstAvailableDateTime" : { },
    "TotalPages" : 0
  },
  "Links" : {
    "Last" : "http://example.com/aeiou",
    "Prev" : "http://example.com/aeiou",
    "Next" : "http://example.com/aeiou",
    "Self" : "http://example.com/aeiou",
    "First" : "http://example.com/aeiou"
  },
  "Data" : {
    "Status" : { },
    "StatusUpdateDateTime" : "2000-01-23T04:56:07.000+00:00",
    "CreationDateTime" : "2000-01-23T04:56:07.000+00:00",
    "ExpectedExecutionDateTime" : "2000-01-23T04:56:07.000+00:00",
    "DomesticScheduledPaymentId" : "DomesticScheduledPaymentId",
    "Charges" : [ {
      "Type" : [ "UK.OBIE.CHAPSOut", "UK.OBIE.BalanceTransferOut", "UK.OBIE.MoneyTransferOut" ],
      "Amount" : {
        "Amount" : {
          "Amount" : "Amount",
          "Currency" : "Currency"
        },
        "Currency" : "Currency"
      },
      "ChargeBearer" : { }
    }, {
      "Type" : [ "UK.OBIE.CHAPSOut", "UK.OBIE.BalanceTransferOut", "UK.OBIE.MoneyTransferOut" ],
      "Amount" : {
        "Amount" : {
          "Amount" : "Amount",
          "Currency" : "Currency"
        },
        "Currency" : "Currency"
      },
      "ChargeBearer" : { }
    } ],
    "ConsentId" : "ConsentId",
    "Initiation" : {
      "SupplementaryData" : { },
      "LocalInstrument" : [ "UK.OBIE.BACS", "UK.OBIE.BalanceTransfer", "UK.OBIE.CHAPS", "UK.OBIE.Euro1", "UK.OBIE.FPS", "UK.OBIE.Link", "UK.OBIE.MoneyTransfer", "UK.OBIE.Paym", "UK.OBIE.SEPACreditTransfer", "UK.OBIE.SEPAInstantCreditTransfer", "UK.OBIE.SWIFT", "UK.OBIE.Target2" ],
      "DebtorAccount" : {
        "SecondaryIdentification" : "SecondaryIdentification",
        "SchemeName" : [ "UK.OBIE.BBAN", "UK.OBIE.IBAN", "UK.OBIE.PAN", "UK.OBIE.Paym", "UK.OBIE.SortCodeAccountNumber" ],
        "Identification" : "Identification",
        "Name" : "Name"
      },
      "RemittanceInformation" : {
        "Unstructured" : "Unstructured",
        "Reference" : "Reference"
      },
      "EndToEndIdentification" : "EndToEndIdentification",
      "InstructionIdentification" : "InstructionIdentification",
      "CreditorAccount" : {
        "SecondaryIdentification" : "SecondaryIdentification",
        "SchemeName" : [ "UK.OBIE.BBAN", "UK.OBIE.IBAN", "UK.OBIE.PAN", "UK.OBIE.Paym", "UK.OBIE.SortCodeAccountNumber" ],
        "Identification" : "Identification",
        "Name" : "Name"
      },
      "RequestedExecutionDateTime" : "2000-01-23T04:56:07.000+00:00",
      "InstructedAmount" : {
        "Amount" : "Amount",
        "Currency" : "Currency"
      },
      "CreditorPostalAddress" : {
        "StreetName" : "StreetName",
        "CountrySubDivision" : "CountrySubDivision",
        "Department" : "Department",
        "AddressLine" : "",
        "BuildingNumber" : "BuildingNumber",
        "TownName" : "TownName",
        "Country" : "Country",
        "SubDepartment" : "SubDepartment",
        "AddressType" : { },
        "PostCode" : "PostCode"
      }
    },
    "ExpectedSettlementDateTime" : "2000-01-23T04:56:07.000+00:00",
    "MultiAuthorisation" : {
      "Status" : { },
      "NumberReceived" : 6,
      "LastUpdateDateTime" : "2000-01-23T04:56:07.000+00:00",
      "ExpirationDateTime" : "2000-01-23T04:56:07.000+00:00",
      "NumberRequired" : 0
    }
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Domestic Scheduled Payments Read OBWriteDomesticScheduledResponse2

400

Bad request OBErrorResponse1

401

Unauthorized

403

Forbidden

404

Not found

405

Method Not Allowed

406

Not Acceptable

429

Too Many Requests

500

Internal Server Error OBErrorResponse1

DomesticStandingOrders

Up
post /domestic-standing-order-consents
Create Domestic Standing Order Consents (createDomesticStandingOrderConsents)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

OBWriteDomesticStandingOrderConsent2Param OBWriteDomesticStandingOrderConsent2 (required)
Body Parameter Default

Request headers

Return type

OBWriteDomesticStandingOrderConsentResponse2

Example data

Content-Type: application/json
{
  "Meta" : {
    "FirstAvailableDateTime" : { },
    "TotalPages" : 0
  },
  "Risk" : {
    "PaymentContextCode" : { },
    "DeliveryAddress" : {
      "StreetName" : "StreetName",
      "CountrySubDivision" : "",
      "AddressLine" : "",
      "BuildingNumber" : "BuildingNumber",
      "TownName" : "TownName",
      "Country" : "Country",
      "PostCode" : "PostCode"
    },
    "MerchantCategoryCode" : "MerchantCategoryCode",
    "MerchantCustomerIdentification" : "MerchantCustomerIdentification"
  },
  "Links" : {
    "Last" : "http://example.com/aeiou",
    "Prev" : "http://example.com/aeiou",
    "Next" : "http://example.com/aeiou",
    "Self" : "http://example.com/aeiou",
    "First" : "http://example.com/aeiou"
  },
  "Data" : {
    "Status" : { },
    "StatusUpdateDateTime" : "2000-01-23T04:56:07.000+00:00",
    "CreationDateTime" : "2000-01-23T04:56:07.000+00:00",
    "CutOffDateTime" : "2000-01-23T04:56:07.000+00:00",
    "Authorisation" : {
      "CompletionDateTime" : "2000-01-23T04:56:07.000+00:00",
      "AuthorisationType" : { }
    },
    "Permission" : { },
    "Charges" : [ {
      "Type" : [ "UK.OBIE.CHAPSOut", "UK.OBIE.BalanceTransferOut", "UK.OBIE.MoneyTransferOut" ],
      "Amount" : {
        "Amount" : {
          "Amount" : "Amount",
          "Currency" : "Currency"
        },
        "Currency" : "Currency"
      },
      "ChargeBearer" : { }
    }, {
      "Type" : [ "UK.OBIE.CHAPSOut", "UK.OBIE.BalanceTransferOut", "UK.OBIE.MoneyTransferOut" ],
      "Amount" : {
        "Amount" : {
          "Amount" : "Amount",
          "Currency" : "Currency"
        },
        "Currency" : "Currency"
      },
      "ChargeBearer" : { }
    } ],
    "ConsentId" : "ConsentId",
    "Initiation" : {
      "SupplementaryData" : { },
      "DebtorAccount" : {
        "SecondaryIdentification" : "SecondaryIdentification",
        "SchemeName" : [ "UK.OBIE.BBAN", "UK.OBIE.IBAN", "UK.OBIE.PAN", "UK.OBIE.Paym", "UK.OBIE.SortCodeAccountNumber" ],
        "Identification" : "Identification",
        "Name" : "Name"
      },
      "Reference" : "Reference",
      "RecurringPaymentDateTime" : "2000-01-23T04:56:07.000+00:00",
      "RecurringPaymentAmount" : {
        "Amount" : "Amount",
        "Currency" : "Currency"
      },
      "CreditorAccount" : {
        "SecondaryIdentification" : "SecondaryIdentification",
        "SchemeName" : [ "UK.OBIE.BBAN", "UK.OBIE.IBAN", "UK.OBIE.PAN", "UK.OBIE.Paym", "UK.OBIE.SortCodeAccountNumber" ],
        "Identification" : "Identification",
        "Name" : "Name"
      },
      "Frequency" : "Frequency",
      "FirstPaymentAmount" : {
        "Amount" : "Amount",
        "Currency" : "Currency"
      },
      "FirstPaymentDateTime" : "2000-01-23T04:56:07.000+00:00",
      "FinalPaymentAmount" : {
        "Amount" : "Amount",
        "Currency" : "Currency"
      },
      "NumberOfPayments" : "NumberOfPayments",
      "FinalPaymentDateTime" : "2000-01-23T04:56:07.000+00:00"
    }
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Domestic Standing Order Consents Created OBWriteDomesticStandingOrderConsentResponse2

400

Bad request OBErrorResponse1

401

Unauthorized

403

Forbidden

404

Not found

405

Method Not Allowed

406

Not Acceptable

415

Unsupported Media Type

429

Too Many Requests

500

Internal Server Error OBErrorResponse1

Up
post /domestic-standing-orders
Create Domestic Standing Orders (createDomesticStandingOrders)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

OBWriteDomesticStandingOrder2Param OBWriteDomesticStandingOrder2 (required)
Body Parameter Default

Request headers

Return type

OBWriteDomesticStandingOrderResponse2

Example data

Content-Type: application/json
{
  "Meta" : {
    "FirstAvailableDateTime" : { },
    "TotalPages" : 0
  },
  "Links" : {
    "Last" : "http://example.com/aeiou",
    "Prev" : "http://example.com/aeiou",
    "Next" : "http://example.com/aeiou",
    "Self" : "http://example.com/aeiou",
    "First" : "http://example.com/aeiou"
  },
  "Data" : {
    "Status" : { },
    "StatusUpdateDateTime" : "2000-01-23T04:56:07.000+00:00",
    "CreationDateTime" : "2000-01-23T04:56:07.000+00:00",
    "Charges" : [ {
      "Type" : [ "UK.OBIE.CHAPSOut", "UK.OBIE.BalanceTransferOut", "UK.OBIE.MoneyTransferOut" ],
      "Amount" : {
        "Amount" : {
          "Amount" : "Amount",
          "Currency" : "Currency"
        },
        "Currency" : "Currency"
      },
      "ChargeBearer" : { }
    }, {
      "Type" : [ "UK.OBIE.CHAPSOut", "UK.OBIE.BalanceTransferOut", "UK.OBIE.MoneyTransferOut" ],
      "Amount" : {
        "Amount" : {
          "Amount" : "Amount",
          "Currency" : "Currency"
        },
        "Currency" : "Currency"
      },
      "ChargeBearer" : { }
    } ],
    "DomesticStandingOrderId" : "DomesticStandingOrderId",
    "ConsentId" : "ConsentId",
    "Initiation" : {
      "SupplementaryData" : { },
      "DebtorAccount" : {
        "SecondaryIdentification" : "SecondaryIdentification",
        "SchemeName" : [ "UK.OBIE.BBAN", "UK.OBIE.IBAN", "UK.OBIE.PAN", "UK.OBIE.Paym", "UK.OBIE.SortCodeAccountNumber" ],
        "Identification" : "Identification",
        "Name" : "Name"
      },
      "Reference" : "Reference",
      "RecurringPaymentDateTime" : "2000-01-23T04:56:07.000+00:00",
      "RecurringPaymentAmount" : {
        "Amount" : "Amount",
        "Currency" : "Currency"
      },
      "CreditorAccount" : {
        "SecondaryIdentification" : "SecondaryIdentification",
        "SchemeName" : [ "UK.OBIE.BBAN", "UK.OBIE.IBAN", "UK.OBIE.PAN", "UK.OBIE.Paym", "UK.OBIE.SortCodeAccountNumber" ],
        "Identification" : "Identification",
        "Name" : "Name"
      },
      "Frequency" : "Frequency",
      "FirstPaymentAmount" : {
        "Amount" : "Amount",
        "Currency" : "Currency"
      },
      "FirstPaymentDateTime" : "2000-01-23T04:56:07.000+00:00",
      "FinalPaymentAmount" : {
        "Amount" : "Amount",
        "Currency" : "Currency"
      },
      "NumberOfPayments" : "NumberOfPayments",
      "FinalPaymentDateTime" : "2000-01-23T04:56:07.000+00:00"
    },
    "MultiAuthorisation" : {
      "Status" : { },
      "NumberReceived" : 6,
      "LastUpdateDateTime" : "2000-01-23T04:56:07.000+00:00",
      "ExpirationDateTime" : "2000-01-23T04:56:07.000+00:00",
      "NumberRequired" : 0
    }
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Domestic Standing Orders Created OBWriteDomesticStandingOrderResponse2

400

Bad request OBErrorResponse1

401

Unauthorized

403

Forbidden

404

Not found

405

Method Not Allowed

406

Not Acceptable

415

Unsupported Media Type

429

Too Many Requests

500

Internal Server Error OBErrorResponse1

Up
get /domestic-standing-order-consents/{ConsentId}
Get Domestic Standing Order Consents (getDomesticStandingOrderConsentsConsentId)

Path parameters

ConsentId (required)
Path Parameter ConsentId

Consumes

This API call consumes the following media types via the Content-Type request header:

Request headers

Return type

OBWriteDomesticStandingOrderConsentResponse2

Example data

Content-Type: application/json
{
  "Meta" : {
    "FirstAvailableDateTime" : { },
    "TotalPages" : 0
  },
  "Risk" : {
    "PaymentContextCode" : { },
    "DeliveryAddress" : {
      "StreetName" : "StreetName",
      "CountrySubDivision" : "",
      "AddressLine" : "",
      "BuildingNumber" : "BuildingNumber",
      "TownName" : "TownName",
      "Country" : "Country",
      "PostCode" : "PostCode"
    },
    "MerchantCategoryCode" : "MerchantCategoryCode",
    "MerchantCustomerIdentification" : "MerchantCustomerIdentification"
  },
  "Links" : {
    "Last" : "http://example.com/aeiou",
    "Prev" : "http://example.com/aeiou",
    "Next" : "http://example.com/aeiou",
    "Self" : "http://example.com/aeiou",
    "First" : "http://example.com/aeiou"
  },
  "Data" : {
    "Status" : { },
    "StatusUpdateDateTime" : "2000-01-23T04:56:07.000+00:00",
    "CreationDateTime" : "2000-01-23T04:56:07.000+00:00",
    "CutOffDateTime" : "2000-01-23T04:56:07.000+00:00",
    "Authorisation" : {
      "CompletionDateTime" : "2000-01-23T04:56:07.000+00:00",
      "AuthorisationType" : { }
    },
    "Permission" : { },
    "Charges" : [ {
      "Type" : [ "UK.OBIE.CHAPSOut", "UK.OBIE.BalanceTransferOut", "UK.OBIE.MoneyTransferOut" ],
      "Amount" : {
        "Amount" : {
          "Amount" : "Amount",
          "Currency" : "Currency"
        },
        "Currency" : "Currency"
      },
      "ChargeBearer" : { }
    }, {
      "Type" : [ "UK.OBIE.CHAPSOut", "UK.OBIE.BalanceTransferOut", "UK.OBIE.MoneyTransferOut" ],
      "Amount" : {
        "Amount" : {
          "Amount" : "Amount",
          "Currency" : "Currency"
        },
        "Currency" : "Currency"
      },
      "ChargeBearer" : { }
    } ],
    "ConsentId" : "ConsentId",
    "Initiation" : {
      "SupplementaryData" : { },
      "DebtorAccount" : {
        "SecondaryIdentification" : "SecondaryIdentification",
        "SchemeName" : [ "UK.OBIE.BBAN", "UK.OBIE.IBAN", "UK.OBIE.PAN", "UK.OBIE.Paym", "UK.OBIE.SortCodeAccountNumber" ],
        "Identification" : "Identification",
        "Name" : "Name"
      },
      "Reference" : "Reference",
      "RecurringPaymentDateTime" : "2000-01-23T04:56:07.000+00:00",
      "RecurringPaymentAmount" : {
        "Amount" : "Amount",
        "Currency" : "Currency"
      },
      "CreditorAccount" : {
        "SecondaryIdentification" : "SecondaryIdentification",
        "SchemeName" : [ "UK.OBIE.BBAN", "UK.OBIE.IBAN", "UK.OBIE.PAN", "UK.OBIE.Paym", "UK.OBIE.SortCodeAccountNumber" ],
        "Identification" : "Identification",
        "Name" : "Name"
      },
      "Frequency" : "Frequency",
      "FirstPaymentAmount" : {
        "Amount" : "Amount",
        "Currency" : "Currency"
      },
      "FirstPaymentDateTime" : "2000-01-23T04:56:07.000+00:00",
      "FinalPaymentAmount" : {
        "Amount" : "Amount",
        "Currency" : "Currency"
      },
      "NumberOfPayments" : "NumberOfPayments",
      "FinalPaymentDateTime" : "2000-01-23T04:56:07.000+00:00"
    }
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Domestic Standing Order Consents Read OBWriteDomesticStandingOrderConsentResponse2

400

Bad request OBErrorResponse1

401

Unauthorized

403

Forbidden

404

Not found

405

Method Not Allowed

406

Not Acceptable

429

Too Many Requests

500

Internal Server Error OBErrorResponse1

Up
get /domestic-standing-orders/{DomesticStandingOrderId}
Get Domestic Standing Orders (getDomesticStandingOrdersDomesticStandingOrderId)

Path parameters

DomesticStandingOrderId (required)
Path Parameter DomesticStandingOrderId

Consumes

This API call consumes the following media types via the Content-Type request header:

Request headers

Return type

OBWriteDomesticStandingOrderResponse2

Example data

Content-Type: application/json
{
  "Meta" : {
    "FirstAvailableDateTime" : { },
    "TotalPages" : 0
  },
  "Links" : {
    "Last" : "http://example.com/aeiou",
    "Prev" : "http://example.com/aeiou",
    "Next" : "http://example.com/aeiou",
    "Self" : "http://example.com/aeiou",
    "First" : "http://example.com/aeiou"
  },
  "Data" : {
    "Status" : { },
    "StatusUpdateDateTime" : "2000-01-23T04:56:07.000+00:00",
    "CreationDateTime" : "2000-01-23T04:56:07.000+00:00",
    "Charges" : [ {
      "Type" : [ "UK.OBIE.CHAPSOut", "UK.OBIE.BalanceTransferOut", "UK.OBIE.MoneyTransferOut" ],
      "Amount" : {
        "Amount" : {
          "Amount" : "Amount",
          "Currency" : "Currency"
        },
        "Currency" : "Currency"
      },
      "ChargeBearer" : { }
    }, {
      "Type" : [ "UK.OBIE.CHAPSOut", "UK.OBIE.BalanceTransferOut", "UK.OBIE.MoneyTransferOut" ],
      "Amount" : {
        "Amount" : {
          "Amount" : "Amount",
          "Currency" : "Currency"
        },
        "Currency" : "Currency"
      },
      "ChargeBearer" : { }
    } ],
    "DomesticStandingOrderId" : "DomesticStandingOrderId",
    "ConsentId" : "ConsentId",
    "Initiation" : {
      "SupplementaryData" : { },
      "DebtorAccount" : {
        "SecondaryIdentification" : "SecondaryIdentification",
        "SchemeName" : [ "UK.OBIE.BBAN", "UK.OBIE.IBAN", "UK.OBIE.PAN", "UK.OBIE.Paym", "UK.OBIE.SortCodeAccountNumber" ],
        "Identification" : "Identification",
        "Name" : "Name"
      },
      "Reference" : "Reference",
      "RecurringPaymentDateTime" : "2000-01-23T04:56:07.000+00:00",
      "RecurringPaymentAmount" : {
        "Amount" : "Amount",
        "Currency" : "Currency"
      },
      "CreditorAccount" : {
        "SecondaryIdentification" : "SecondaryIdentification",
        "SchemeName" : [ "UK.OBIE.BBAN", "UK.OBIE.IBAN", "UK.OBIE.PAN", "UK.OBIE.Paym", "UK.OBIE.SortCodeAccountNumber" ],
        "Identification" : "Identification",
        "Name" : "Name"
      },
      "Frequency" : "Frequency",
      "FirstPaymentAmount" : {
        "Amount" : "Amount",
        "Currency" : "Currency"
      },
      "FirstPaymentDateTime" : "2000-01-23T04:56:07.000+00:00",
      "FinalPaymentAmount" : {
        "Amount" : "Amount",
        "Currency" : "Currency"
      },
      "NumberOfPayments" : "NumberOfPayments",
      "FinalPaymentDateTime" : "2000-01-23T04:56:07.000+00:00"
    },
    "MultiAuthorisation" : {
      "Status" : { },
      "NumberReceived" : 6,
      "LastUpdateDateTime" : "2000-01-23T04:56:07.000+00:00",
      "ExpirationDateTime" : "2000-01-23T04:56:07.000+00:00",
      "NumberRequired" : 0
    }
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Domestic Standing Orders Read OBWriteDomesticStandingOrderResponse2

400

Bad request OBErrorResponse1

401

Unauthorized

403

Forbidden

404

Not found

405

Method Not Allowed

406

Not Acceptable

429

Too Many Requests

500

Internal Server Error OBErrorResponse1

FilePayments

Up
post /file-payment-consents
Create File Payment Consents (createFilePaymentConsents)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

OBWriteFileConsent2Param OBWriteFileConsent2 (required)
Body Parameter Default

Request headers

Return type

OBWriteFileConsentResponse2

Example data

Content-Type: application/json
{
  "Meta" : {
    "FirstAvailableDateTime" : { },
    "TotalPages" : 0
  },
  "Links" : {
    "Last" : "http://example.com/aeiou",
    "Prev" : "http://example.com/aeiou",
    "Next" : "http://example.com/aeiou",
    "Self" : "http://example.com/aeiou",
    "First" : "http://example.com/aeiou"
  },
  "Data" : {
    "Status" : { },
    "StatusUpdateDateTime" : "2000-01-23T04:56:07.000+00:00",
    "CreationDateTime" : "2000-01-23T04:56:07.000+00:00",
    "CutOffDateTime" : "2000-01-23T04:56:07.000+00:00",
    "Authorisation" : {
      "CompletionDateTime" : "2000-01-23T04:56:07.000+00:00",
      "AuthorisationType" : { }
    },
    "Charges" : [ {
      "Type" : [ "UK.OBIE.CHAPSOut", "UK.OBIE.BalanceTransferOut", "UK.OBIE.MoneyTransferOut" ],
      "Amount" : {
        "Amount" : {
          "Amount" : "Amount",
          "Currency" : "Currency"
        },
        "Currency" : "Currency"
      },
      "ChargeBearer" : { }
    }, {
      "Type" : [ "UK.OBIE.CHAPSOut", "UK.OBIE.BalanceTransferOut", "UK.OBIE.MoneyTransferOut" ],
      "Amount" : {
        "Amount" : {
          "Amount" : "Amount",
          "Currency" : "Currency"
        },
        "Currency" : "Currency"
      },
      "ChargeBearer" : { }
    } ],
    "ConsentId" : "ConsentId",
    "Initiation" : {
      "SupplementaryData" : { },
      "ControlSum" : 0.80082819046101150206595775671303272247314453125,
      "LocalInstrument" : [ "UK.OBIE.BACS", "UK.OBIE.BalanceTransfer", "UK.OBIE.CHAPS", "UK.OBIE.Euro1", "UK.OBIE.FPS", "UK.OBIE.Link", "UK.OBIE.MoneyTransfer", "UK.OBIE.Paym", "UK.OBIE.SEPACreditTransfer", "UK.OBIE.SEPAInstantCreditTransfer", "UK.OBIE.SWIFT", "UK.OBIE.Target2" ],
      "DebtorAccount" : {
        "SecondaryIdentification" : "SecondaryIdentification",
        "SchemeName" : [ "UK.OBIE.BBAN", "UK.OBIE.IBAN", "UK.OBIE.PAN", "UK.OBIE.Paym", "UK.OBIE.SortCodeAccountNumber" ],
        "Identification" : "Identification",
        "Name" : "Name"
      },
      "RemittanceInformation" : {
        "Unstructured" : "Unstructured",
        "Reference" : "Reference"
      },
      "FileType" : [ "UK.OBIE.PaymentInitiation.3.1", "UK.OBIE.pain.001.001.08" ],
      "FileHash" : "FileHash",
      "NumberOfTransactions" : "NumberOfTransactions",
      "FileReference" : "FileReference",
      "RequestedExecutionDateTime" : "2000-01-23T04:56:07.000+00:00"
    }
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

File Payment Consents Created OBWriteFileConsentResponse2

400

Bad request OBErrorResponse1

401

Unauthorized

403

Forbidden

404

Not found

405

Method Not Allowed

406

Not Acceptable

415

Unsupported Media Type

429

Too Many Requests

500

Internal Server Error OBErrorResponse1

Up
post /file-payment-consents/{ConsentId}/file
Create File Payment Consents (createFilePaymentConsentsConsentIdFile)

Path parameters

ConsentId (required)
Path Parameter ConsentId

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

FileParam File (required)
Body Parameter Default

Request headers

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

File Payment Consents Created

400

Bad request OBErrorResponse1

401

Unauthorized

403

Forbidden

404

Not found

405

Method Not Allowed

406

Not Acceptable

415

Unsupported Media Type

429

Too Many Requests

500

Internal Server Error OBErrorResponse1

Up
post /file-payments
Create File Payments (createFilePayments)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

OBWriteFile2Param OBWriteFile2 (required)
Body Parameter Default

Request headers

Return type

OBWriteFileResponse2

Example data

Content-Type: application/json
{
  "Meta" : {
    "FirstAvailableDateTime" : { },
    "TotalPages" : 0
  },
  "Links" : {
    "Last" : "http://example.com/aeiou",
    "Prev" : "http://example.com/aeiou",
    "Next" : "http://example.com/aeiou",
    "Self" : "http://example.com/aeiou",
    "First" : "http://example.com/aeiou"
  },
  "Data" : {
    "Status" : { },
    "StatusUpdateDateTime" : "2000-01-23T04:56:07.000+00:00",
    "CreationDateTime" : "2000-01-23T04:56:07.000+00:00",
    "FilePaymentId" : "FilePaymentId",
    "Charges" : [ {
      "Type" : [ "UK.OBIE.CHAPSOut", "UK.OBIE.BalanceTransferOut", "UK.OBIE.MoneyTransferOut" ],
      "Amount" : {
        "Amount" : {
          "Amount" : "Amount",
          "Currency" : "Currency"
        },
        "Currency" : "Currency"
      },
      "ChargeBearer" : { }
    }, {
      "Type" : [ "UK.OBIE.CHAPSOut", "UK.OBIE.BalanceTransferOut", "UK.OBIE.MoneyTransferOut" ],
      "Amount" : {
        "Amount" : {
          "Amount" : "Amount",
          "Currency" : "Currency"
        },
        "Currency" : "Currency"
      },
      "ChargeBearer" : { }
    } ],
    "ConsentId" : "ConsentId",
    "Initiation" : {
      "SupplementaryData" : { },
      "ControlSum" : 0.80082819046101150206595775671303272247314453125,
      "LocalInstrument" : [ "UK.OBIE.BACS", "UK.OBIE.BalanceTransfer", "UK.OBIE.CHAPS", "UK.OBIE.Euro1", "UK.OBIE.FPS", "UK.OBIE.Link", "UK.OBIE.MoneyTransfer", "UK.OBIE.Paym", "UK.OBIE.SEPACreditTransfer", "UK.OBIE.SEPAInstantCreditTransfer", "UK.OBIE.SWIFT", "UK.OBIE.Target2" ],
      "DebtorAccount" : {
        "SecondaryIdentification" : "SecondaryIdentification",
        "SchemeName" : [ "UK.OBIE.BBAN", "UK.OBIE.IBAN", "UK.OBIE.PAN", "UK.OBIE.Paym", "UK.OBIE.SortCodeAccountNumber" ],
        "Identification" : "Identification",
        "Name" : "Name"
      },
      "RemittanceInformation" : {
        "Unstructured" : "Unstructured",
        "Reference" : "Reference"
      },
      "FileType" : [ "UK.OBIE.PaymentInitiation.3.1", "UK.OBIE.pain.001.001.08" ],
      "FileHash" : "FileHash",
      "NumberOfTransactions" : "NumberOfTransactions",
      "FileReference" : "FileReference",
      "RequestedExecutionDateTime" : "2000-01-23T04:56:07.000+00:00"
    },
    "MultiAuthorisation" : {
      "Status" : { },
      "NumberReceived" : 6,
      "LastUpdateDateTime" : "2000-01-23T04:56:07.000+00:00",
      "ExpirationDateTime" : "2000-01-23T04:56:07.000+00:00",
      "NumberRequired" : 0
    }
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

File Payments Created OBWriteFileResponse2

400

Bad request OBErrorResponse1

401

Unauthorized

403

Forbidden

404

Not found

405

Method Not Allowed

406

Not Acceptable

415

Unsupported Media Type

429

Too Many Requests

500

Internal Server Error OBErrorResponse1

Up
get /file-payment-consents/{ConsentId}
Get File Payment Consents (getFilePaymentConsentsConsentId)

Path parameters

ConsentId (required)
Path Parameter ConsentId

Consumes

This API call consumes the following media types via the Content-Type request header:

Request headers

Return type

OBWriteFileConsentResponse2

Example data

Content-Type: application/json
{
  "Meta" : {
    "FirstAvailableDateTime" : { },
    "TotalPages" : 0
  },
  "Links" : {
    "Last" : "http://example.com/aeiou",
    "Prev" : "http://example.com/aeiou",
    "Next" : "http://example.com/aeiou",
    "Self" : "http://example.com/aeiou",
    "First" : "http://example.com/aeiou"
  },
  "Data" : {
    "Status" : { },
    "StatusUpdateDateTime" : "2000-01-23T04:56:07.000+00:00",
    "CreationDateTime" : "2000-01-23T04:56:07.000+00:00",
    "CutOffDateTime" : "2000-01-23T04:56:07.000+00:00",
    "Authorisation" : {
      "CompletionDateTime" : "2000-01-23T04:56:07.000+00:00",
      "AuthorisationType" : { }
    },
    "Charges" : [ {
      "Type" : [ "UK.OBIE.CHAPSOut", "UK.OBIE.BalanceTransferOut", "UK.OBIE.MoneyTransferOut" ],
      "Amount" : {
        "Amount" : {
          "Amount" : "Amount",
          "Currency" : "Currency"
        },
        "Currency" : "Currency"
      },
      "ChargeBearer" : { }
    }, {
      "Type" : [ "UK.OBIE.CHAPSOut", "UK.OBIE.BalanceTransferOut", "UK.OBIE.MoneyTransferOut" ],
      "Amount" : {
        "Amount" : {
          "Amount" : "Amount",
          "Currency" : "Currency"
        },
        "Currency" : "Currency"
      },
      "ChargeBearer" : { }
    } ],
    "ConsentId" : "ConsentId",
    "Initiation" : {
      "SupplementaryData" : { },
      "ControlSum" : 0.80082819046101150206595775671303272247314453125,
      "LocalInstrument" : [ "UK.OBIE.BACS", "UK.OBIE.BalanceTransfer", "UK.OBIE.CHAPS", "UK.OBIE.Euro1", "UK.OBIE.FPS", "UK.OBIE.Link", "UK.OBIE.MoneyTransfer", "UK.OBIE.Paym", "UK.OBIE.SEPACreditTransfer", "UK.OBIE.SEPAInstantCreditTransfer", "UK.OBIE.SWIFT", "UK.OBIE.Target2" ],
      "DebtorAccount" : {
        "SecondaryIdentification" : "SecondaryIdentification",
        "SchemeName" : [ "UK.OBIE.BBAN", "UK.OBIE.IBAN", "UK.OBIE.PAN", "UK.OBIE.Paym", "UK.OBIE.SortCodeAccountNumber" ],
        "Identification" : "Identification",
        "Name" : "Name"
      },
      "RemittanceInformation" : {
        "Unstructured" : "Unstructured",
        "Reference" : "Reference"
      },
      "FileType" : [ "UK.OBIE.PaymentInitiation.3.1", "UK.OBIE.pain.001.001.08" ],
      "FileHash" : "FileHash",
      "NumberOfTransactions" : "NumberOfTransactions",
      "FileReference" : "FileReference",
      "RequestedExecutionDateTime" : "2000-01-23T04:56:07.000+00:00"
    }
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

File Payment Consents Read OBWriteFileConsentResponse2

400

Bad request OBErrorResponse1

401

Unauthorized

403

Forbidden

404

Not found

405

Method Not Allowed

406

Not Acceptable

429

Too Many Requests

500

Internal Server Error OBErrorResponse1

Up
get /file-payment-consents/{ConsentId}/file
Get File Payment Consents (getFilePaymentConsentsConsentIdFile)

Path parameters

ConsentId (required)
Path Parameter ConsentId

Consumes

This API call consumes the following media types via the Content-Type request header:

Request headers

Return type

File

Example data

Content-Type:

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

File Payment Consents Read File

400

Bad request OBErrorResponse1

401

Unauthorized

403

Forbidden

404

Not found

405

Method Not Allowed

406

Not Acceptable

429

Too Many Requests

500

Internal Server Error OBErrorResponse1

Up
get /file-payments/{FilePaymentId}
Get File Payments (getFilePaymentsFilePaymentId)

Path parameters

FilePaymentId (required)
Path Parameter FilePaymentId

Consumes

This API call consumes the following media types via the Content-Type request header:

Request headers

Return type

OBWriteFileResponse2

Example data

Content-Type: application/json
{
  "Meta" : {
    "FirstAvailableDateTime" : { },
    "TotalPages" : 0
  },
  "Links" : {
    "Last" : "http://example.com/aeiou",
    "Prev" : "http://example.com/aeiou",
    "Next" : "http://example.com/aeiou",
    "Self" : "http://example.com/aeiou",
    "First" : "http://example.com/aeiou"
  },
  "Data" : {
    "Status" : { },
    "StatusUpdateDateTime" : "2000-01-23T04:56:07.000+00:00",
    "CreationDateTime" : "2000-01-23T04:56:07.000+00:00",
    "FilePaymentId" : "FilePaymentId",
    "Charges" : [ {
      "Type" : [ "UK.OBIE.CHAPSOut", "UK.OBIE.BalanceTransferOut", "UK.OBIE.MoneyTransferOut" ],
      "Amount" : {
        "Amount" : {
          "Amount" : "Amount",
          "Currency" : "Currency"
        },
        "Currency" : "Currency"
      },
      "ChargeBearer" : { }
    }, {
      "Type" : [ "UK.OBIE.CHAPSOut", "UK.OBIE.BalanceTransferOut", "UK.OBIE.MoneyTransferOut" ],
      "Amount" : {
        "Amount" : {
          "Amount" : "Amount",
          "Currency" : "Currency"
        },
        "Currency" : "Currency"
      },
      "ChargeBearer" : { }
    } ],
    "ConsentId" : "ConsentId",
    "Initiation" : {
      "SupplementaryData" : { },
      "ControlSum" : 0.80082819046101150206595775671303272247314453125,
      "LocalInstrument" : [ "UK.OBIE.BACS", "UK.OBIE.BalanceTransfer", "UK.OBIE.CHAPS", "UK.OBIE.Euro1", "UK.OBIE.FPS", "UK.OBIE.Link", "UK.OBIE.MoneyTransfer", "UK.OBIE.Paym", "UK.OBIE.SEPACreditTransfer", "UK.OBIE.SEPAInstantCreditTransfer", "UK.OBIE.SWIFT", "UK.OBIE.Target2" ],
      "DebtorAccount" : {
        "SecondaryIdentification" : "SecondaryIdentification",
        "SchemeName" : [ "UK.OBIE.BBAN", "UK.OBIE.IBAN", "UK.OBIE.PAN", "UK.OBIE.Paym", "UK.OBIE.SortCodeAccountNumber" ],
        "Identification" : "Identification",
        "Name" : "Name"
      },
      "RemittanceInformation" : {
        "Unstructured" : "Unstructured",
        "Reference" : "Reference"
      },
      "FileType" : [ "UK.OBIE.PaymentInitiation.3.1", "UK.OBIE.pain.001.001.08" ],
      "FileHash" : "FileHash",
      "NumberOfTransactions" : "NumberOfTransactions",
      "FileReference" : "FileReference",
      "RequestedExecutionDateTime" : "2000-01-23T04:56:07.000+00:00"
    },
    "MultiAuthorisation" : {
      "Status" : { },
      "NumberReceived" : 6,
      "LastUpdateDateTime" : "2000-01-23T04:56:07.000+00:00",
      "ExpirationDateTime" : "2000-01-23T04:56:07.000+00:00",
      "NumberRequired" : 0
    }
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

File Payments Read OBWriteFileResponse2

400

Bad request OBErrorResponse1

401

Unauthorized

403

Forbidden

404

Not found

405

Method Not Allowed

406

Not Acceptable

429

Too Many Requests

500

Internal Server Error OBErrorResponse1

Up
get /file-payments/{FilePaymentId}/report-file
Get File Payments (getFilePaymentsFilePaymentIdReportFile)

Path parameters

FilePaymentId (required)
Path Parameter FilePaymentId

Consumes

This API call consumes the following media types via the Content-Type request header:

Request headers

Return type

File

Example data

Content-Type:

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

File Payments Read File

400

Bad request OBErrorResponse1

401

Unauthorized

403

Forbidden

404

Not found

405

Method Not Allowed

406

Not Acceptable

429

Too Many Requests

500

Internal Server Error OBErrorResponse1

InternationalPayments

Up
post /international-payment-consents
Create International Payment Consents (createInternationalPaymentConsents)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

OBWriteInternationalConsent2Param OBWriteInternationalConsent2 (required)
Body Parameter Default

Request headers

Return type

OBWriteInternationalConsentResponse2

Example data

Content-Type: application/json
{
  "Meta" : {
    "FirstAvailableDateTime" : { },
    "TotalPages" : 0
  },
  "Risk" : {
    "PaymentContextCode" : { },
    "DeliveryAddress" : {
      "StreetName" : "StreetName",
      "CountrySubDivision" : "",
      "AddressLine" : "",
      "BuildingNumber" : "BuildingNumber",
      "TownName" : "TownName",
      "Country" : "Country",
      "PostCode" : "PostCode"
    },
    "MerchantCategoryCode" : "MerchantCategoryCode",
    "MerchantCustomerIdentification" : "MerchantCustomerIdentification"
  },
  "Links" : {
    "Last" : "http://example.com/aeiou",
    "Prev" : "http://example.com/aeiou",
    "Next" : "http://example.com/aeiou",
    "Self" : "http://example.com/aeiou",
    "First" : "http://example.com/aeiou"
  },
  "Data" : {
    "Status" : { },
    "StatusUpdateDateTime" : "2000-01-23T04:56:07.000+00:00",
    "CreationDateTime" : "2000-01-23T04:56:07.000+00:00",
    "ExpectedExecutionDateTime" : "2000-01-23T04:56:07.000+00:00",
    "CutOffDateTime" : "2000-01-23T04:56:07.000+00:00",
    "ExchangeRateInformation" : {
      "ExchangeRate" : 0.80082819046101150206595775671303272247314453125,
      "ExpirationDateTime" : "2000-01-23T04:56:07.000+00:00",
      "RateType" : { },
      "UnitCurrency" : "UnitCurrency",
      "ContractIdentification" : "ContractIdentification"
    },
    "Authorisation" : {
      "CompletionDateTime" : "2000-01-23T04:56:07.000+00:00",
      "AuthorisationType" : { }
    },
    "Charges" : [ {
      "Type" : [ "UK.OBIE.CHAPSOut", "UK.OBIE.BalanceTransferOut", "UK.OBIE.MoneyTransferOut" ],
      "Amount" : {
        "Amount" : {
          "Amount" : "Amount",
          "Currency" : "Currency"
        },
        "Currency" : "Currency"
      },
      "ChargeBearer" : { }
    }, {
      "Type" : [ "UK.OBIE.CHAPSOut", "UK.OBIE.BalanceTransferOut", "UK.OBIE.MoneyTransferOut" ],
      "Amount" : {
        "Amount" : {
          "Amount" : "Amount",
          "Currency" : "Currency"
        },
        "Currency" : "Currency"
      },
      "ChargeBearer" : { }
    } ],
    "ConsentId" : "ConsentId",
    "Initiation" : {
      "SupplementaryData" : { },
      "DebtorAccount" : {
        "SecondaryIdentification" : "SecondaryIdentification",
        "SchemeName" : [ "UK.OBIE.BBAN", "UK.OBIE.IBAN", "UK.OBIE.PAN", "UK.OBIE.Paym", "UK.OBIE.SortCodeAccountNumber" ],
        "Identification" : "Identification",
        "Name" : "Name"
      },
      "CreditorAgent" : {
        "PostalAddress" : {
          "StreetName" : "StreetName",
          "CountrySubDivision" : "CountrySubDivision",
          "Department" : "Department",
          "AddressLine" : "",
          "BuildingNumber" : "BuildingNumber",
          "TownName" : "TownName",
          "Country" : "Country",
          "SubDepartment" : "SubDepartment",
          "AddressType" : { },
          "PostCode" : "PostCode"
        },
        "SchemeName" : [ "UK.OBIE.BICFI" ],
        "Identification" : "Identification",
        "Name" : "Name"
      },
      "EndToEndIdentification" : "EndToEndIdentification",
      "InstructionIdentification" : "InstructionIdentification",
      "CurrencyOfTransfer" : "CurrencyOfTransfer",
      "CreditorAccount" : {
        "SecondaryIdentification" : "SecondaryIdentification",
        "SchemeName" : [ "UK.OBIE.BBAN", "UK.OBIE.IBAN", "UK.OBIE.PAN", "UK.OBIE.Paym", "UK.OBIE.SortCodeAccountNumber" ],
        "Identification" : "Identification",
        "Name" : "Name"
      },
      "Purpose" : { },
      "ChargeBearer" : { },
      "InstructionPriority" : { },
      "LocalInstrument" : [ "UK.OBIE.BACS", "UK.OBIE.BalanceTransfer", "UK.OBIE.CHAPS", "UK.OBIE.Euro1", "UK.OBIE.FPS", "UK.OBIE.Link", "UK.OBIE.MoneyTransfer", "UK.OBIE.Paym", "UK.OBIE.SEPACreditTransfer", "UK.OBIE.SEPAInstantCreditTransfer", "UK.OBIE.SWIFT", "UK.OBIE.Target2" ],
      "RemittanceInformation" : {
        "Unstructured" : "Unstructured",
        "Reference" : "Reference"
      },
      "ExchangeRateInformation" : {
        "ExchangeRate" : 6.02745618307040320615897144307382404804229736328125,
        "UnitCurrency" : "UnitCurrency",
        "ContractIdentification" : "ContractIdentification"
      },
      "Creditor" : {
        "PostalAddress" : {
          "StreetName" : "StreetName",
          "CountrySubDivision" : "CountrySubDivision",
          "Department" : "Department",
          "AddressLine" : "",
          "BuildingNumber" : "BuildingNumber",
          "TownName" : "TownName",
          "Country" : "Country",
          "SubDepartment" : "SubDepartment",
          "AddressType" : { },
          "PostCode" : "PostCode"
        },
        "Name" : "Name"
      },
      "InstructedAmount" : {
        "Amount" : "Amount",
        "Currency" : "Currency"
      }
    },
    "ExpectedSettlementDateTime" : "2000-01-23T04:56:07.000+00:00"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

International Payment Consents Created OBWriteInternationalConsentResponse2

400

Bad request OBErrorResponse1

401

Unauthorized

403

Forbidden

404

Not found

405

Method Not Allowed

406

Not Acceptable

415

Unsupported Media Type

429

Too Many Requests

500

Internal Server Error OBErrorResponse1

Up
post /international-payments
Create International Payments (createInternationalPayments)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

OBWriteInternational2Param OBWriteInternational2 (required)
Body Parameter Default

Request headers

Return type

OBWriteInternationalResponse2

Example data

Content-Type: application/json
{
  "Meta" : {
    "FirstAvailableDateTime" : { },
    "TotalPages" : 0
  },
  "Links" : {
    "Last" : "http://example.com/aeiou",
    "Prev" : "http://example.com/aeiou",
    "Next" : "http://example.com/aeiou",
    "Self" : "http://example.com/aeiou",
    "First" : "http://example.com/aeiou"
  },
  "Data" : {
    "Status" : { },
    "StatusUpdateDateTime" : "2000-01-23T04:56:07.000+00:00",
    "CreationDateTime" : "2000-01-23T04:56:07.000+00:00",
    "ExpectedExecutionDateTime" : "2000-01-23T04:56:07.000+00:00",
    "ExchangeRateInformation" : {
      "ExchangeRate" : 0.80082819046101150206595775671303272247314453125,
      "ExpirationDateTime" : "2000-01-23T04:56:07.000+00:00",
      "RateType" : { },
      "UnitCurrency" : "UnitCurrency",
      "ContractIdentification" : "ContractIdentification"
    },
    "Charges" : [ {
      "Type" : [ "UK.OBIE.CHAPSOut", "UK.OBIE.BalanceTransferOut", "UK.OBIE.MoneyTransferOut" ],
      "Amount" : {
        "Amount" : {
          "Amount" : "Amount",
          "Currency" : "Currency"
        },
        "Currency" : "Currency"
      },
      "ChargeBearer" : { }
    }, {
      "Type" : [ "UK.OBIE.CHAPSOut", "UK.OBIE.BalanceTransferOut", "UK.OBIE.MoneyTransferOut" ],
      "Amount" : {
        "Amount" : {
          "Amount" : "Amount",
          "Currency" : "Currency"
        },
        "Currency" : "Currency"
      },
      "ChargeBearer" : { }
    } ],
    "InternationalPaymentId" : "InternationalPaymentId",
    "ConsentId" : "ConsentId",
    "Initiation" : {
      "SupplementaryData" : { },
      "DebtorAccount" : {
        "SecondaryIdentification" : "SecondaryIdentification",
        "SchemeName" : [ "UK.OBIE.BBAN", "UK.OBIE.IBAN", "UK.OBIE.PAN", "UK.OBIE.Paym", "UK.OBIE.SortCodeAccountNumber" ],
        "Identification" : "Identification",
        "Name" : "Name"
      },
      "CreditorAgent" : {
        "PostalAddress" : {
          "StreetName" : "StreetName",
          "CountrySubDivision" : "CountrySubDivision",
          "Department" : "Department",
          "AddressLine" : "",
          "BuildingNumber" : "BuildingNumber",
          "TownName" : "TownName",
          "Country" : "Country",
          "SubDepartment" : "SubDepartment",
          "AddressType" : { },
          "PostCode" : "PostCode"
        },
        "SchemeName" : [ "UK.OBIE.BICFI" ],
        "Identification" : "Identification",
        "Name" : "Name"
      },
      "EndToEndIdentification" : "EndToEndIdentification",
      "InstructionIdentification" : "InstructionIdentification",
      "CurrencyOfTransfer" : "CurrencyOfTransfer",
      "CreditorAccount" : {
        "SecondaryIdentification" : "SecondaryIdentification",
        "SchemeName" : [ "UK.OBIE.BBAN", "UK.OBIE.IBAN", "UK.OBIE.PAN", "UK.OBIE.Paym", "UK.OBIE.SortCodeAccountNumber" ],
        "Identification" : "Identification",
        "Name" : "Name"
      },
      "Purpose" : { },
      "ChargeBearer" : { },
      "InstructionPriority" : { },
      "LocalInstrument" : [ "UK.OBIE.BACS", "UK.OBIE.BalanceTransfer", "UK.OBIE.CHAPS", "UK.OBIE.Euro1", "UK.OBIE.FPS", "UK.OBIE.Link", "UK.OBIE.MoneyTransfer", "UK.OBIE.Paym", "UK.OBIE.SEPACreditTransfer", "UK.OBIE.SEPAInstantCreditTransfer", "UK.OBIE.SWIFT", "UK.OBIE.Target2" ],
      "RemittanceInformation" : {
        "Unstructured" : "Unstructured",
        "Reference" : "Reference"
      },
      "ExchangeRateInformation" : {
        "ExchangeRate" : 6.02745618307040320615897144307382404804229736328125,
        "UnitCurrency" : "UnitCurrency",
        "ContractIdentification" : "ContractIdentification"
      },
      "Creditor" : {
        "PostalAddress" : {
          "StreetName" : "StreetName",
          "CountrySubDivision" : "CountrySubDivision",
          "Department" : "Department",
          "AddressLine" : "",
          "BuildingNumber" : "BuildingNumber",
          "TownName" : "TownName",
          "Country" : "Country",
          "SubDepartment" : "SubDepartment",
          "AddressType" : { },
          "PostCode" : "PostCode"
        },
        "Name" : "Name"
      },
      "InstructedAmount" : {
        "Amount" : "Amount",
        "Currency" : "Currency"
      }
    },
    "ExpectedSettlementDateTime" : "2000-01-23T04:56:07.000+00:00",
    "MultiAuthorisation" : {
      "Status" : { },
      "NumberReceived" : 6,
      "LastUpdateDateTime" : "2000-01-23T04:56:07.000+00:00",
      "ExpirationDateTime" : "2000-01-23T04:56:07.000+00:00",
      "NumberRequired" : 0
    }
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

International Payments Created OBWriteInternationalResponse2

400

Bad request OBErrorResponse1

401

Unauthorized

403

Forbidden

404

Not found

405

Method Not Allowed

406

Not Acceptable

415

Unsupported Media Type

429

Too Many Requests

500

Internal Server Error OBErrorResponse1

Up
get /international-payment-consents/{ConsentId}
Get International Payment Consents (getInternationalPaymentConsentsConsentId)

Path parameters

ConsentId (required)
Path Parameter ConsentId

Consumes

This API call consumes the following media types via the Content-Type request header:

Request headers

Return type

OBWriteInternationalConsentResponse2

Example data

Content-Type: application/json
{
  "Meta" : {
    "FirstAvailableDateTime" : { },
    "TotalPages" : 0
  },
  "Risk" : {
    "PaymentContextCode" : { },
    "DeliveryAddress" : {
      "StreetName" : "StreetName",
      "CountrySubDivision" : "",
      "AddressLine" : "",
      "BuildingNumber" : "BuildingNumber",
      "TownName" : "TownName",
      "Country" : "Country",
      "PostCode" : "PostCode"
    },
    "MerchantCategoryCode" : "MerchantCategoryCode",
    "MerchantCustomerIdentification" : "MerchantCustomerIdentification"
  },
  "Links" : {
    "Last" : "http://example.com/aeiou",
    "Prev" : "http://example.com/aeiou",
    "Next" : "http://example.com/aeiou",
    "Self" : "http://example.com/aeiou",
    "First" : "http://example.com/aeiou"
  },
  "Data" : {
    "Status" : { },
    "StatusUpdateDateTime" : "2000-01-23T04:56:07.000+00:00",
    "CreationDateTime" : "2000-01-23T04:56:07.000+00:00",
    "ExpectedExecutionDateTime" : "2000-01-23T04:56:07.000+00:00",
    "CutOffDateTime" : "2000-01-23T04:56:07.000+00:00",
    "ExchangeRateInformation" : {
      "ExchangeRate" : 0.80082819046101150206595775671303272247314453125,
      "ExpirationDateTime" : "2000-01-23T04:56:07.000+00:00",
      "RateType" : { },
      "UnitCurrency" : "UnitCurrency",
      "ContractIdentification" : "ContractIdentification"
    },
    "Authorisation" : {
      "CompletionDateTime" : "2000-01-23T04:56:07.000+00:00",
      "AuthorisationType" : { }
    },
    "Charges" : [ {
      "Type" : [ "UK.OBIE.CHAPSOut", "UK.OBIE.BalanceTransferOut", "UK.OBIE.MoneyTransferOut" ],
      "Amount" : {
        "Amount" : {
          "Amount" : "Amount",
          "Currency" : "Currency"
        },
        "Currency" : "Currency"
      },
      "ChargeBearer" : { }
    }, {
      "Type" : [ "UK.OBIE.CHAPSOut", "UK.OBIE.BalanceTransferOut", "UK.OBIE.MoneyTransferOut" ],
      "Amount" : {
        "Amount" : {
          "Amount" : "Amount",
          "Currency" : "Currency"
        },
        "Currency" : "Currency"
      },
      "ChargeBearer" : { }
    } ],
    "ConsentId" : "ConsentId",
    "Initiation" : {
      "SupplementaryData" : { },
      "DebtorAccount" : {
        "SecondaryIdentification" : "SecondaryIdentification",
        "SchemeName" : [ "UK.OBIE.BBAN", "UK.OBIE.IBAN", "UK.OBIE.PAN", "UK.OBIE.Paym", "UK.OBIE.SortCodeAccountNumber" ],
        "Identification" : "Identification",
        "Name" : "Name"
      },
      "CreditorAgent" : {
        "PostalAddress" : {
          "StreetName" : "StreetName",
          "CountrySubDivision" : "CountrySubDivision",
          "Department" : "Department",
          "AddressLine" : "",
          "BuildingNumber" : "BuildingNumber",
          "TownName" : "TownName",
          "Country" : "Country",
          "SubDepartment" : "SubDepartment",
          "AddressType" : { },
          "PostCode" : "PostCode"
        },
        "SchemeName" : [ "UK.OBIE.BICFI" ],
        "Identification" : "Identification",
        "Name" : "Name"
      },
      "EndToEndIdentification" : "EndToEndIdentification",
      "InstructionIdentification" : "InstructionIdentification",
      "CurrencyOfTransfer" : "CurrencyOfTransfer",
      "CreditorAccount" : {
        "SecondaryIdentification" : "SecondaryIdentification",
        "SchemeName" : [ "UK.OBIE.BBAN", "UK.OBIE.IBAN", "UK.OBIE.PAN", "UK.OBIE.Paym", "UK.OBIE.SortCodeAccountNumber" ],
        "Identification" : "Identification",
        "Name" : "Name"
      },
      "Purpose" : { },
      "ChargeBearer" : { },
      "InstructionPriority" : { },
      "LocalInstrument" : [ "UK.OBIE.BACS", "UK.OBIE.BalanceTransfer", "UK.OBIE.CHAPS", "UK.OBIE.Euro1", "UK.OBIE.FPS", "UK.OBIE.Link", "UK.OBIE.MoneyTransfer", "UK.OBIE.Paym", "UK.OBIE.SEPACreditTransfer", "UK.OBIE.SEPAInstantCreditTransfer", "UK.OBIE.SWIFT", "UK.OBIE.Target2" ],
      "RemittanceInformation" : {
        "Unstructured" : "Unstructured",
        "Reference" : "Reference"
      },
      "ExchangeRateInformation" : {
        "ExchangeRate" : 6.02745618307040320615897144307382404804229736328125,
        "UnitCurrency" : "UnitCurrency",
        "ContractIdentification" : "ContractIdentification"
      },
      "Creditor" : {
        "PostalAddress" : {
          "StreetName" : "StreetName",
          "CountrySubDivision" : "CountrySubDivision",
          "Department" : "Department",
          "AddressLine" : "",
          "BuildingNumber" : "BuildingNumber",
          "TownName" : "TownName",
          "Country" : "Country",
          "SubDepartment" : "SubDepartment",
          "AddressType" : { },
          "PostCode" : "PostCode"
        },
        "Name" : "Name"
      },
      "InstructedAmount" : {
        "Amount" : "Amount",
        "Currency" : "Currency"
      }
    },
    "ExpectedSettlementDateTime" : "2000-01-23T04:56:07.000+00:00"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

International Payment Consents Read OBWriteInternationalConsentResponse2

400

Bad request OBErrorResponse1

401

Unauthorized

403

Forbidden

404

Not found

405

Method Not Allowed

406

Not Acceptable

429

Too Many Requests

500

Internal Server Error OBErrorResponse1

Up
get /international-payment-consents/{ConsentId}/funds-confirmation
Get International Payment Consents Funds Confirmation (getInternationalPaymentConsentsConsentIdFundsConfirmation)

Path parameters

ConsentId (required)
Path Parameter ConsentId

Consumes

This API call consumes the following media types via the Content-Type request header:

Request headers

Return type

OBWriteFundsConfirmationResponse1

Example data

Content-Type: application/json
{
  "Meta" : {
    "FirstAvailableDateTime" : { },
    "TotalPages" : 0
  },
  "Links" : {
    "Last" : "http://example.com/aeiou",
    "Prev" : "http://example.com/aeiou",
    "Next" : "http://example.com/aeiou",
    "Self" : "http://example.com/aeiou",
    "First" : "http://example.com/aeiou"
  },
  "Data" : {
    "SupplementaryData" : { },
    "FundsAvailableResult" : {
      "FundsAvailableDateTime" : "2000-01-23T04:56:07.000+00:00",
      "FundsAvailable" : true
    }
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

International Payment Consents Read OBWriteFundsConfirmationResponse1

400

Bad request OBErrorResponse1

401

Unauthorized

403

Forbidden

404

Not found

405

Method Not Allowed

406

Not Acceptable

429

Too Many Requests

500

Internal Server Error OBErrorResponse1

Up
get /international-payments/{InternationalPaymentId}
Get International Payments (getInternationalPaymentsInternationalPaymentId)

Path parameters

InternationalPaymentId (required)
Path Parameter InternationalPaymentId

Consumes

This API call consumes the following media types via the Content-Type request header:

Request headers

Return type

OBWriteInternationalResponse2

Example data

Content-Type: application/json
{
  "Meta" : {
    "FirstAvailableDateTime" : { },
    "TotalPages" : 0
  },
  "Links" : {
    "Last" : "http://example.com/aeiou",
    "Prev" : "http://example.com/aeiou",
    "Next" : "http://example.com/aeiou",
    "Self" : "http://example.com/aeiou",
    "First" : "http://example.com/aeiou"
  },
  "Data" : {
    "Status" : { },
    "StatusUpdateDateTime" : "2000-01-23T04:56:07.000+00:00",
    "CreationDateTime" : "2000-01-23T04:56:07.000+00:00",
    "ExpectedExecutionDateTime" : "2000-01-23T04:56:07.000+00:00",
    "ExchangeRateInformation" : {
      "ExchangeRate" : 0.80082819046101150206595775671303272247314453125,
      "ExpirationDateTime" : "2000-01-23T04:56:07.000+00:00",
      "RateType" : { },
      "UnitCurrency" : "UnitCurrency",
      "ContractIdentification" : "ContractIdentification"
    },
    "Charges" : [ {
      "Type" : [ "UK.OBIE.CHAPSOut", "UK.OBIE.BalanceTransferOut", "UK.OBIE.MoneyTransferOut" ],
      "Amount" : {
        "Amount" : {
          "Amount" : "Amount",
          "Currency" : "Currency"
        },
        "Currency" : "Currency"
      },
      "ChargeBearer" : { }
    }, {
      "Type" : [ "UK.OBIE.CHAPSOut", "UK.OBIE.BalanceTransferOut", "UK.OBIE.MoneyTransferOut" ],
      "Amount" : {
        "Amount" : {
          "Amount" : "Amount",
          "Currency" : "Currency"
        },
        "Currency" : "Currency"
      },
      "ChargeBearer" : { }
    } ],
    "InternationalPaymentId" : "InternationalPaymentId",
    "ConsentId" : "ConsentId",
    "Initiation" : {
      "SupplementaryData" : { },
      "DebtorAccount" : {
        "SecondaryIdentification" : "SecondaryIdentification",
        "SchemeName" : [ "UK.OBIE.BBAN", "UK.OBIE.IBAN", "UK.OBIE.PAN", "UK.OBIE.Paym", "UK.OBIE.SortCodeAccountNumber" ],
        "Identification" : "Identification",
        "Name" : "Name"
      },
      "CreditorAgent" : {
        "PostalAddress" : {
          "StreetName" : "StreetName",
          "CountrySubDivision" : "CountrySubDivision",
          "Department" : "Department",
          "AddressLine" : "",
          "BuildingNumber" : "BuildingNumber",
          "TownName" : "TownName",
          "Country" : "Country",
          "SubDepartment" : "SubDepartment",
          "AddressType" : { },
          "PostCode" : "PostCode"
        },
        "SchemeName" : [ "UK.OBIE.BICFI" ],
        "Identification" : "Identification",
        "Name" : "Name"
      },
      "EndToEndIdentification" : "EndToEndIdentification",
      "InstructionIdentification" : "InstructionIdentification",
      "CurrencyOfTransfer" : "CurrencyOfTransfer",
      "CreditorAccount" : {
        "SecondaryIdentification" : "SecondaryIdentification",
        "SchemeName" : [ "UK.OBIE.BBAN", "UK.OBIE.IBAN", "UK.OBIE.PAN", "UK.OBIE.Paym", "UK.OBIE.SortCodeAccountNumber" ],
        "Identification" : "Identification",
        "Name" : "Name"
      },
      "Purpose" : { },
      "ChargeBearer" : { },
      "InstructionPriority" : { },
      "LocalInstrument" : [ "UK.OBIE.BACS", "UK.OBIE.BalanceTransfer", "UK.OBIE.CHAPS", "UK.OBIE.Euro1", "UK.OBIE.FPS", "UK.OBIE.Link", "UK.OBIE.MoneyTransfer", "UK.OBIE.Paym", "UK.OBIE.SEPACreditTransfer", "UK.OBIE.SEPAInstantCreditTransfer", "UK.OBIE.SWIFT", "UK.OBIE.Target2" ],
      "RemittanceInformation" : {
        "Unstructured" : "Unstructured",
        "Reference" : "Reference"
      },
      "ExchangeRateInformation" : {
        "ExchangeRate" : 6.02745618307040320615897144307382404804229736328125,
        "UnitCurrency" : "UnitCurrency",
        "ContractIdentification" : "ContractIdentification"
      },
      "Creditor" : {
        "PostalAddress" : {
          "StreetName" : "StreetName",
          "CountrySubDivision" : "CountrySubDivision",
          "Department" : "Department",
          "AddressLine" : "",
          "BuildingNumber" : "BuildingNumber",
          "TownName" : "TownName",
          "Country" : "Country",
          "SubDepartment" : "SubDepartment",
          "AddressType" : { },
          "PostCode" : "PostCode"
        },
        "Name" : "Name"
      },
      "InstructedAmount" : {
        "Amount" : "Amount",
        "Currency" : "Currency"
      }
    },
    "ExpectedSettlementDateTime" : "2000-01-23T04:56:07.000+00:00",
    "MultiAuthorisation" : {
      "Status" : { },
      "NumberReceived" : 6,
      "LastUpdateDateTime" : "2000-01-23T04:56:07.000+00:00",
      "ExpirationDateTime" : "2000-01-23T04:56:07.000+00:00",
      "NumberRequired" : 0
    }
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

International Payments Read OBWriteInternationalResponse2

400

Bad request OBErrorResponse1

401

Unauthorized

403

Forbidden

404

Not found

405

Method Not Allowed

406

Not Acceptable

429

Too Many Requests

500

Internal Server Error OBErrorResponse1

InternationalScheduledPayments

Up
post /international-scheduled-payment-consents
Create International Scheduled Payment Consents (createInternationalScheduledPaymentConsents)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

OBWriteInternationalScheduledConsent2Param OBWriteInternationalScheduledConsent2 (required)
Body Parameter Default

Request headers

Return type

OBWriteInternationalScheduledConsentResponse2

Example data

Content-Type: application/json
{
  "Meta" : {
    "FirstAvailableDateTime" : { },
    "TotalPages" : 0
  },
  "Risk" : {
    "PaymentContextCode" : { },
    "DeliveryAddress" : {
      "StreetName" : "StreetName",
      "CountrySubDivision" : "",
      "AddressLine" : "",
      "BuildingNumber" : "BuildingNumber",
      "TownName" : "TownName",
      "Country" : "Country",
      "PostCode" : "PostCode"
    },
    "MerchantCategoryCode" : "MerchantCategoryCode",
    "MerchantCustomerIdentification" : "MerchantCustomerIdentification"
  },
  "Links" : {
    "Last" : "http://example.com/aeiou",
    "Prev" : "http://example.com/aeiou",
    "Next" : "http://example.com/aeiou",
    "Self" : "http://example.com/aeiou",
    "First" : "http://example.com/aeiou"
  },
  "Data" : {
    "Status" : { },
    "StatusUpdateDateTime" : "2000-01-23T04:56:07.000+00:00",
    "CreationDateTime" : "2000-01-23T04:56:07.000+00:00",
    "ExpectedExecutionDateTime" : "2000-01-23T04:56:07.000+00:00",
    "CutOffDateTime" : "2000-01-23T04:56:07.000+00:00",
    "ExchangeRateInformation" : {
      "ExchangeRate" : 0.80082819046101150206595775671303272247314453125,
      "ExpirationDateTime" : "2000-01-23T04:56:07.000+00:00",
      "RateType" : { },
      "UnitCurrency" : "UnitCurrency",
      "ContractIdentification" : "ContractIdentification"
    },
    "Authorisation" : {
      "CompletionDateTime" : "2000-01-23T04:56:07.000+00:00",
      "AuthorisationType" : { }
    },
    "Permission" : { },
    "Charges" : [ {
      "Type" : [ "UK.OBIE.CHAPSOut", "UK.OBIE.BalanceTransferOut", "UK.OBIE.MoneyTransferOut" ],
      "Amount" : {
        "Amount" : {
          "Amount" : "Amount",
          "Currency" : "Currency"
        },
        "Currency" : "Currency"
      },
      "ChargeBearer" : { }
    }, {
      "Type" : [ "UK.OBIE.CHAPSOut", "UK.OBIE.BalanceTransferOut", "UK.OBIE.MoneyTransferOut" ],
      "Amount" : {
        "Amount" : {
          "Amount" : "Amount",
          "Currency" : "Currency"
        },
        "Currency" : "Currency"
      },
      "ChargeBearer" : { }
    } ],
    "ConsentId" : "ConsentId",
    "Initiation" : {
      "SupplementaryData" : { },
      "DebtorAccount" : {
        "SecondaryIdentification" : "SecondaryIdentification",
        "SchemeName" : [ "UK.OBIE.BBAN", "UK.OBIE.IBAN", "UK.OBIE.PAN", "UK.OBIE.Paym", "UK.OBIE.SortCodeAccountNumber" ],
        "Identification" : "Identification",
        "Name" : "Name"
      },
      "CreditorAgent" : {
        "PostalAddress" : {
          "StreetName" : "StreetName",
          "CountrySubDivision" : "CountrySubDivision",
          "Department" : "Department",
          "AddressLine" : "",
          "BuildingNumber" : "BuildingNumber",
          "TownName" : "TownName",
          "Country" : "Country",
          "SubDepartment" : "SubDepartment",
          "AddressType" : { },
          "PostCode" : "PostCode"
        },
        "SchemeName" : [ "UK.OBIE.BICFI" ],
        "Identification" : "Identification",
        "Name" : "Name"
      },
      "EndToEndIdentification" : "EndToEndIdentification",
      "InstructionIdentification" : "InstructionIdentification",
      "CurrencyOfTransfer" : "CurrencyOfTransfer",
      "CreditorAccount" : {
        "SecondaryIdentification" : "SecondaryIdentification",
        "SchemeName" : [ "UK.OBIE.BBAN", "UK.OBIE.IBAN", "UK.OBIE.PAN", "UK.OBIE.Paym", "UK.OBIE.SortCodeAccountNumber" ],
        "Identification" : "Identification",
        "Name" : "Name"
      },
      "Purpose" : { },
      "ChargeBearer" : { },
      "InstructionPriority" : { },
      "RequestedExecutionDateTime" : "2000-01-23T04:56:07.000+00:00",
      "LocalInstrument" : [ "UK.OBIE.BACS", "UK.OBIE.BalanceTransfer", "UK.OBIE.CHAPS", "UK.OBIE.Euro1", "UK.OBIE.FPS", "UK.OBIE.Link", "UK.OBIE.MoneyTransfer", "UK.OBIE.Paym", "UK.OBIE.SEPACreditTransfer", "UK.OBIE.SEPAInstantCreditTransfer", "UK.OBIE.SWIFT", "UK.OBIE.Target2" ],
      "RemittanceInformation" : {
        "Unstructured" : "Unstructured",
        "Reference" : "Reference"
      },
      "ExchangeRateInformation" : {
        "ExchangeRate" : 6.02745618307040320615897144307382404804229736328125,
        "UnitCurrency" : "UnitCurrency",
        "ContractIdentification" : "ContractIdentification"
      },
      "Creditor" : {
        "PostalAddress" : {
          "StreetName" : "StreetName",
          "CountrySubDivision" : "CountrySubDivision",
          "Department" : "Department",
          "AddressLine" : "",
          "BuildingNumber" : "BuildingNumber",
          "TownName" : "TownName",
          "Country" : "Country",
          "SubDepartment" : "SubDepartment",
          "AddressType" : { },
          "PostCode" : "PostCode"
        },
        "Name" : "Name"
      },
      "InstructedAmount" : {
        "Amount" : "Amount",
        "Currency" : "Currency"
      }
    },
    "ExpectedSettlementDateTime" : "2000-01-23T04:56:07.000+00:00"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

International Scheduled Payment Consents Created OBWriteInternationalScheduledConsentResponse2

400

Bad request OBErrorResponse1

401

Unauthorized

403

Forbidden

404

Not found

405

Method Not Allowed

406

Not Acceptable

415

Unsupported Media Type

429

Too Many Requests

500

Internal Server Error OBErrorResponse1

Up
post /international-scheduled-payments
Create International Scheduled Payments (createInternationalScheduledPayments)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

OBWriteInternationalScheduled2Param OBWriteInternationalScheduled2 (required)
Body Parameter Default

Request headers

Return type

OBWriteInternationalScheduledResponse2

Example data

Content-Type: application/json
{
  "Meta" : {
    "FirstAvailableDateTime" : { },
    "TotalPages" : 0
  },
  "Links" : {
    "Last" : "http://example.com/aeiou",
    "Prev" : "http://example.com/aeiou",
    "Next" : "http://example.com/aeiou",
    "Self" : "http://example.com/aeiou",
    "First" : "http://example.com/aeiou"
  },
  "Data" : {
    "Status" : { },
    "StatusUpdateDateTime" : "2000-01-23T04:56:07.000+00:00",
    "CreationDateTime" : "2000-01-23T04:56:07.000+00:00",
    "ExpectedExecutionDateTime" : "2000-01-23T04:56:07.000+00:00",
    "ExchangeRateInformation" : {
      "ExchangeRate" : 0.80082819046101150206595775671303272247314453125,
      "ExpirationDateTime" : "2000-01-23T04:56:07.000+00:00",
      "RateType" : { },
      "UnitCurrency" : "UnitCurrency",
      "ContractIdentification" : "ContractIdentification"
    },
    "InternationalScheduledPaymentId" : "InternationalScheduledPaymentId",
    "Charges" : [ {
      "Type" : [ "UK.OBIE.CHAPSOut", "UK.OBIE.BalanceTransferOut", "UK.OBIE.MoneyTransferOut" ],
      "Amount" : {
        "Amount" : {
          "Amount" : "Amount",
          "Currency" : "Currency"
        },
        "Currency" : "Currency"
      },
      "ChargeBearer" : { }
    }, {
      "Type" : [ "UK.OBIE.CHAPSOut", "UK.OBIE.BalanceTransferOut", "UK.OBIE.MoneyTransferOut" ],
      "Amount" : {
        "Amount" : {
          "Amount" : "Amount",
          "Currency" : "Currency"
        },
        "Currency" : "Currency"
      },
      "ChargeBearer" : { }
    } ],
    "ConsentId" : "ConsentId",
    "Initiation" : {
      "SupplementaryData" : { },
      "DebtorAccount" : {
        "SecondaryIdentification" : "SecondaryIdentification",
        "SchemeName" : [ "UK.OBIE.BBAN", "UK.OBIE.IBAN", "UK.OBIE.PAN", "UK.OBIE.Paym", "UK.OBIE.SortCodeAccountNumber" ],
        "Identification" : "Identification",
        "Name" : "Name"
      },
      "CreditorAgent" : {
        "PostalAddress" : {
          "StreetName" : "StreetName",
          "CountrySubDivision" : "CountrySubDivision",
          "Department" : "Department",
          "AddressLine" : "",
          "BuildingNumber" : "BuildingNumber",
          "TownName" : "TownName",
          "Country" : "Country",
          "SubDepartment" : "SubDepartment",
          "AddressType" : { },
          "PostCode" : "PostCode"
        },
        "SchemeName" : [ "UK.OBIE.BICFI" ],
        "Identification" : "Identification",
        "Name" : "Name"
      },
      "EndToEndIdentification" : "EndToEndIdentification",
      "InstructionIdentification" : "InstructionIdentification",
      "CurrencyOfTransfer" : "CurrencyOfTransfer",
      "CreditorAccount" : {
        "SecondaryIdentification" : "SecondaryIdentification",
        "SchemeName" : [ "UK.OBIE.BBAN", "UK.OBIE.IBAN", "UK.OBIE.PAN", "UK.OBIE.Paym", "UK.OBIE.SortCodeAccountNumber" ],
        "Identification" : "Identification",
        "Name" : "Name"
      },
      "Purpose" : { },
      "ChargeBearer" : { },
      "InstructionPriority" : { },
      "RequestedExecutionDateTime" : "2000-01-23T04:56:07.000+00:00",
      "LocalInstrument" : [ "UK.OBIE.BACS", "UK.OBIE.BalanceTransfer", "UK.OBIE.CHAPS", "UK.OBIE.Euro1", "UK.OBIE.FPS", "UK.OBIE.Link", "UK.OBIE.MoneyTransfer", "UK.OBIE.Paym", "UK.OBIE.SEPACreditTransfer", "UK.OBIE.SEPAInstantCreditTransfer", "UK.OBIE.SWIFT", "UK.OBIE.Target2" ],
      "RemittanceInformation" : {
        "Unstructured" : "Unstructured",
        "Reference" : "Reference"
      },
      "ExchangeRateInformation" : {
        "ExchangeRate" : 6.02745618307040320615897144307382404804229736328125,
        "UnitCurrency" : "UnitCurrency",
        "ContractIdentification" : "ContractIdentification"
      },
      "Creditor" : {
        "PostalAddress" : {
          "StreetName" : "StreetName",
          "CountrySubDivision" : "CountrySubDivision",
          "Department" : "Department",
          "AddressLine" : "",
          "BuildingNumber" : "BuildingNumber",
          "TownName" : "TownName",
          "Country" : "Country",
          "SubDepartment" : "SubDepartment",
          "AddressType" : { },
          "PostCode" : "PostCode"
        },
        "Name" : "Name"
      },
      "InstructedAmount" : {
        "Amount" : "Amount",
        "Currency" : "Currency"
      }
    },
    "ExpectedSettlementDateTime" : "2000-01-23T04:56:07.000+00:00",
    "MultiAuthorisation" : {
      "Status" : { },
      "NumberReceived" : 6,
      "LastUpdateDateTime" : "2000-01-23T04:56:07.000+00:00",
      "ExpirationDateTime" : "2000-01-23T04:56:07.000+00:00",
      "NumberRequired" : 0
    }
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

International Scheduled Payments Created OBWriteInternationalScheduledResponse2

400

Bad request OBErrorResponse1

401

Unauthorized

403

Forbidden

404

Not found

405

Method Not Allowed

406

Not Acceptable

415

Unsupported Media Type

429

Too Many Requests

500

Internal Server Error OBErrorResponse1

Up
get /international-scheduled-payment-consents/{ConsentId}
Get International Scheduled Payment Consents (getInternationalScheduledPaymentConsentsConsentId)

Path parameters

ConsentId (required)
Path Parameter ConsentId

Consumes

This API call consumes the following media types via the Content-Type request header:

Request headers

Return type

OBWriteInternationalScheduledConsentResponse2

Example data

Content-Type: application/json
{
  "Meta" : {
    "FirstAvailableDateTime" : { },
    "TotalPages" : 0
  },
  "Risk" : {
    "PaymentContextCode" : { },
    "DeliveryAddress" : {
      "StreetName" : "StreetName",
      "CountrySubDivision" : "",
      "AddressLine" : "",
      "BuildingNumber" : "BuildingNumber",
      "TownName" : "TownName",
      "Country" : "Country",
      "PostCode" : "PostCode"
    },
    "MerchantCategoryCode" : "MerchantCategoryCode",
    "MerchantCustomerIdentification" : "MerchantCustomerIdentification"
  },
  "Links" : {
    "Last" : "http://example.com/aeiou",
    "Prev" : "http://example.com/aeiou",
    "Next" : "http://example.com/aeiou",
    "Self" : "http://example.com/aeiou",
    "First" : "http://example.com/aeiou"
  },
  "Data" : {
    "Status" : { },
    "StatusUpdateDateTime" : "2000-01-23T04:56:07.000+00:00",
    "CreationDateTime" : "2000-01-23T04:56:07.000+00:00",
    "ExpectedExecutionDateTime" : "2000-01-23T04:56:07.000+00:00",
    "CutOffDateTime" : "2000-01-23T04:56:07.000+00:00",
    "ExchangeRateInformation" : {
      "ExchangeRate" : 0.80082819046101150206595775671303272247314453125,
      "ExpirationDateTime" : "2000-01-23T04:56:07.000+00:00",
      "RateType" : { },
      "UnitCurrency" : "UnitCurrency",
      "ContractIdentification" : "ContractIdentification"
    },
    "Authorisation" : {
      "CompletionDateTime" : "2000-01-23T04:56:07.000+00:00",
      "AuthorisationType" : { }
    },
    "Permission" : { },
    "Charges" : [ {
      "Type" : [ "UK.OBIE.CHAPSOut", "UK.OBIE.BalanceTransferOut", "UK.OBIE.MoneyTransferOut" ],
      "Amount" : {
        "Amount" : {
          "Amount" : "Amount",
          "Currency" : "Currency"
        },
        "Currency" : "Currency"
      },
      "ChargeBearer" : { }
    }, {
      "Type" : [ "UK.OBIE.CHAPSOut", "UK.OBIE.BalanceTransferOut", "UK.OBIE.MoneyTransferOut" ],
      "Amount" : {
        "Amount" : {
          "Amount" : "Amount",
          "Currency" : "Currency"
        },
        "Currency" : "Currency"
      },
      "ChargeBearer" : { }
    } ],
    "ConsentId" : "ConsentId",
    "Initiation" : {
      "SupplementaryData" : { },
      "DebtorAccount" : {
        "SecondaryIdentification" : "SecondaryIdentification",
        "SchemeName" : [ "UK.OBIE.BBAN", "UK.OBIE.IBAN", "UK.OBIE.PAN", "UK.OBIE.Paym", "UK.OBIE.SortCodeAccountNumber" ],
        "Identification" : "Identification",
        "Name" : "Name"
      },
      "CreditorAgent" : {
        "PostalAddress" : {
          "StreetName" : "StreetName",
          "CountrySubDivision" : "CountrySubDivision",
          "Department" : "Department",
          "AddressLine" : "",
          "BuildingNumber" : "BuildingNumber",
          "TownName" : "TownName",
          "Country" : "Country",
          "SubDepartment" : "SubDepartment",
          "AddressType" : { },
          "PostCode" : "PostCode"
        },
        "SchemeName" : [ "UK.OBIE.BICFI" ],
        "Identification" : "Identification",
        "Name" : "Name"
      },
      "EndToEndIdentification" : "EndToEndIdentification",
      "InstructionIdentification" : "InstructionIdentification",
      "CurrencyOfTransfer" : "CurrencyOfTransfer",
      "CreditorAccount" : {
        "SecondaryIdentification" : "SecondaryIdentification",
        "SchemeName" : [ "UK.OBIE.BBAN", "UK.OBIE.IBAN", "UK.OBIE.PAN", "UK.OBIE.Paym", "UK.OBIE.SortCodeAccountNumber" ],
        "Identification" : "Identification",
        "Name" : "Name"
      },
      "Purpose" : { },
      "ChargeBearer" : { },
      "InstructionPriority" : { },
      "RequestedExecutionDateTime" : "2000-01-23T04:56:07.000+00:00",
      "LocalInstrument" : [ "UK.OBIE.BACS", "UK.OBIE.BalanceTransfer", "UK.OBIE.CHAPS", "UK.OBIE.Euro1", "UK.OBIE.FPS", "UK.OBIE.Link", "UK.OBIE.MoneyTransfer", "UK.OBIE.Paym", "UK.OBIE.SEPACreditTransfer", "UK.OBIE.SEPAInstantCreditTransfer", "UK.OBIE.SWIFT", "UK.OBIE.Target2" ],
      "RemittanceInformation" : {
        "Unstructured" : "Unstructured",
        "Reference" : "Reference"
      },
      "ExchangeRateInformation" : {
        "ExchangeRate" : 6.02745618307040320615897144307382404804229736328125,
        "UnitCurrency" : "UnitCurrency",
        "ContractIdentification" : "ContractIdentification"
      },
      "Creditor" : {
        "PostalAddress" : {
          "StreetName" : "StreetName",
          "CountrySubDivision" : "CountrySubDivision",
          "Department" : "Department",
          "AddressLine" : "",
          "BuildingNumber" : "BuildingNumber",
          "TownName" : "TownName",
          "Country" : "Country",
          "SubDepartment" : "SubDepartment",
          "AddressType" : { },
          "PostCode" : "PostCode"
        },
        "Name" : "Name"
      },
      "InstructedAmount" : {
        "Amount" : "Amount",
        "Currency" : "Currency"
      }
    },
    "ExpectedSettlementDateTime" : "2000-01-23T04:56:07.000+00:00"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

International Scheduled Payment Consents Read OBWriteInternationalScheduledConsentResponse2

400

Bad request OBErrorResponse1

401

Unauthorized

403

Forbidden

404

Not found

405

Method Not Allowed

406

Not Acceptable

429

Too Many Requests

500

Internal Server Error OBErrorResponse1

Up
get /international-scheduled-payment-consents/{ConsentId}/funds-confirmation
Get International Scheduled Payment Consents Funds Confirmation (getInternationalScheduledPaymentConsentsConsentIdFundsConfirmation)

Path parameters

ConsentId (required)
Path Parameter ConsentId

Consumes

This API call consumes the following media types via the Content-Type request header:

Request headers

Return type

OBWriteFundsConfirmationResponse1

Example data

Content-Type: application/json
{
  "Meta" : {
    "FirstAvailableDateTime" : { },
    "TotalPages" : 0
  },
  "Links" : {
    "Last" : "http://example.com/aeiou",
    "Prev" : "http://example.com/aeiou",
    "Next" : "http://example.com/aeiou",
    "Self" : "http://example.com/aeiou",
    "First" : "http://example.com/aeiou"
  },
  "Data" : {
    "SupplementaryData" : { },
    "FundsAvailableResult" : {
      "FundsAvailableDateTime" : "2000-01-23T04:56:07.000+00:00",
      "FundsAvailable" : true
    }
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

International Payment Consents Read OBWriteFundsConfirmationResponse1

400

Bad request OBErrorResponse1

401

Unauthorized

403

Forbidden

404

Not found

405

Method Not Allowed

406

Not Acceptable

429

Too Many Requests

500

Internal Server Error OBErrorResponse1

Up
get /international-scheduled-payments/{InternationalScheduledPaymentId}
Get International Scheduled Payments (getInternationalScheduledPaymentsInternationalScheduledPaymentId)

Path parameters

InternationalScheduledPaymentId (required)
Path Parameter InternationalScheduledPaymentId

Consumes

This API call consumes the following media types via the Content-Type request header:

Request headers

Return type

OBWriteInternationalScheduledResponse2

Example data

Content-Type: application/json
{
  "Meta" : {
    "FirstAvailableDateTime" : { },
    "TotalPages" : 0
  },
  "Links" : {
    "Last" : "http://example.com/aeiou",
    "Prev" : "http://example.com/aeiou",
    "Next" : "http://example.com/aeiou",
    "Self" : "http://example.com/aeiou",
    "First" : "http://example.com/aeiou"
  },
  "Data" : {
    "Status" : { },
    "StatusUpdateDateTime" : "2000-01-23T04:56:07.000+00:00",
    "CreationDateTime" : "2000-01-23T04:56:07.000+00:00",
    "ExpectedExecutionDateTime" : "2000-01-23T04:56:07.000+00:00",
    "ExchangeRateInformation" : {
      "ExchangeRate" : 0.80082819046101150206595775671303272247314453125,
      "ExpirationDateTime" : "2000-01-23T04:56:07.000+00:00",
      "RateType" : { },
      "UnitCurrency" : "UnitCurrency",
      "ContractIdentification" : "ContractIdentification"
    },
    "InternationalScheduledPaymentId" : "InternationalScheduledPaymentId",
    "Charges" : [ {
      "Type" : [ "UK.OBIE.CHAPSOut", "UK.OBIE.BalanceTransferOut", "UK.OBIE.MoneyTransferOut" ],
      "Amount" : {
        "Amount" : {
          "Amount" : "Amount",
          "Currency" : "Currency"
        },
        "Currency" : "Currency"
      },
      "ChargeBearer" : { }
    }, {
      "Type" : [ "UK.OBIE.CHAPSOut", "UK.OBIE.BalanceTransferOut", "UK.OBIE.MoneyTransferOut" ],
      "Amount" : {
        "Amount" : {
          "Amount" : "Amount",
          "Currency" : "Currency"
        },
        "Currency" : "Currency"
      },
      "ChargeBearer" : { }
    } ],
    "ConsentId" : "ConsentId",
    "Initiation" : {
      "SupplementaryData" : { },
      "DebtorAccount" : {
        "SecondaryIdentification" : "SecondaryIdentification",
        "SchemeName" : [ "UK.OBIE.BBAN", "UK.OBIE.IBAN", "UK.OBIE.PAN", "UK.OBIE.Paym", "UK.OBIE.SortCodeAccountNumber" ],
        "Identification" : "Identification",
        "Name" : "Name"
      },
      "CreditorAgent" : {
        "PostalAddress" : {
          "StreetName" : "StreetName",
          "CountrySubDivision" : "CountrySubDivision",
          "Department" : "Department",
          "AddressLine" : "",
          "BuildingNumber" : "BuildingNumber",
          "TownName" : "TownName",
          "Country" : "Country",
          "SubDepartment" : "SubDepartment",
          "AddressType" : { },
          "PostCode" : "PostCode"
        },
        "SchemeName" : [ "UK.OBIE.BICFI" ],
        "Identification" : "Identification",
        "Name" : "Name"
      },
      "EndToEndIdentification" : "EndToEndIdentification",
      "InstructionIdentification" : "InstructionIdentification",
      "CurrencyOfTransfer" : "CurrencyOfTransfer",
      "CreditorAccount" : {
        "SecondaryIdentification" : "SecondaryIdentification",
        "SchemeName" : [ "UK.OBIE.BBAN", "UK.OBIE.IBAN", "UK.OBIE.PAN", "UK.OBIE.Paym", "UK.OBIE.SortCodeAccountNumber" ],
        "Identification" : "Identification",
        "Name" : "Name"
      },
      "Purpose" : { },
      "ChargeBearer" : { },
      "InstructionPriority" : { },
      "RequestedExecutionDateTime" : "2000-01-23T04:56:07.000+00:00",
      "LocalInstrument" : [ "UK.OBIE.BACS", "UK.OBIE.BalanceTransfer", "UK.OBIE.CHAPS", "UK.OBIE.Euro1", "UK.OBIE.FPS", "UK.OBIE.Link", "UK.OBIE.MoneyTransfer", "UK.OBIE.Paym", "UK.OBIE.SEPACreditTransfer", "UK.OBIE.SEPAInstantCreditTransfer", "UK.OBIE.SWIFT", "UK.OBIE.Target2" ],
      "RemittanceInformation" : {
        "Unstructured" : "Unstructured",
        "Reference" : "Reference"
      },
      "ExchangeRateInformation" : {
        "ExchangeRate" : 6.02745618307040320615897144307382404804229736328125,
        "UnitCurrency" : "UnitCurrency",
        "ContractIdentification" : "ContractIdentification"
      },
      "Creditor" : {
        "PostalAddress" : {
          "StreetName" : "StreetName",
          "CountrySubDivision" : "CountrySubDivision",
          "Department" : "Department",
          "AddressLine" : "",
          "BuildingNumber" : "BuildingNumber",
          "TownName" : "TownName",
          "Country" : "Country",
          "SubDepartment" : "SubDepartment",
          "AddressType" : { },
          "PostCode" : "PostCode"
        },
        "Name" : "Name"
      },
      "InstructedAmount" : {
        "Amount" : "Amount",
        "Currency" : "Currency"
      }
    },
    "ExpectedSettlementDateTime" : "2000-01-23T04:56:07.000+00:00",
    "MultiAuthorisation" : {
      "Status" : { },
      "NumberReceived" : 6,
      "LastUpdateDateTime" : "2000-01-23T04:56:07.000+00:00",
      "ExpirationDateTime" : "2000-01-23T04:56:07.000+00:00",
      "NumberRequired" : 0
    }
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

International Scheduled Payments Read OBWriteInternationalScheduledResponse2

400

Bad request OBErrorResponse1

401

Unauthorized

403

Forbidden

404

Not found

405

Method Not Allowed

406

Not Acceptable

429

Too Many Requests

500

Internal Server Error OBErrorResponse1

InternationalStandingOrders

Up
post /international-standing-order-consents
Create International Standing Order Consents (createInternationalStandingOrderConsents)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

OBWriteInternationalStandingOrderConsent2Param OBWriteInternationalStandingOrderConsent2 (required)
Body Parameter Default

Request headers

Return type

OBWriteInternationalStandingOrderConsentResponse2

Example data

Content-Type: application/json
{
  "Meta" : {
    "FirstAvailableDateTime" : { },
    "TotalPages" : 0
  },
  "Risk" : {
    "PaymentContextCode" : { },
    "DeliveryAddress" : {
      "StreetName" : "StreetName",
      "CountrySubDivision" : "",
      "AddressLine" : "",
      "BuildingNumber" : "BuildingNumber",
      "TownName" : "TownName",
      "Country" : "Country",
      "PostCode" : "PostCode"
    },
    "MerchantCategoryCode" : "MerchantCategoryCode",
    "MerchantCustomerIdentification" : "MerchantCustomerIdentification"
  },
  "Links" : {
    "Last" : "http://example.com/aeiou",
    "Prev" : "http://example.com/aeiou",
    "Next" : "http://example.com/aeiou",
    "Self" : "http://example.com/aeiou",
    "First" : "http://example.com/aeiou"
  },
  "Data" : {
    "Status" : { },
    "StatusUpdateDateTime" : "2000-01-23T04:56:07.000+00:00",
    "CreationDateTime" : "2000-01-23T04:56:07.000+00:00",
    "CutOffDateTime" : "2000-01-23T04:56:07.000+00:00",
    "Authorisation" : {
      "CompletionDateTime" : "2000-01-23T04:56:07.000+00:00",
      "AuthorisationType" : { }
    },
    "Permission" : { },
    "Charges" : [ {
      "Type" : [ "UK.OBIE.CHAPSOut", "UK.OBIE.BalanceTransferOut", "UK.OBIE.MoneyTransferOut" ],
      "Amount" : {
        "Amount" : {
          "Amount" : "Amount",
          "Currency" : "Currency"
        },
        "Currency" : "Currency"
      },
      "ChargeBearer" : { }
    }, {
      "Type" : [ "UK.OBIE.CHAPSOut", "UK.OBIE.BalanceTransferOut", "UK.OBIE.MoneyTransferOut" ],
      "Amount" : {
        "Amount" : {
          "Amount" : "Amount",
          "Currency" : "Currency"
        },
        "Currency" : "Currency"
      },
      "ChargeBearer" : { }
    } ],
    "ConsentId" : "ConsentId",
    "Initiation" : {
      "SupplementaryData" : { },
      "DebtorAccount" : {
        "SecondaryIdentification" : "SecondaryIdentification",
        "SchemeName" : [ "UK.OBIE.BBAN", "UK.OBIE.IBAN", "UK.OBIE.PAN", "UK.OBIE.Paym", "UK.OBIE.SortCodeAccountNumber" ],
        "Identification" : "Identification",
        "Name" : "Name"
      },
      "CreditorAgent" : {
        "PostalAddress" : {
          "StreetName" : "StreetName",
          "CountrySubDivision" : "CountrySubDivision",
          "Department" : "Department",
          "AddressLine" : "",
          "BuildingNumber" : "BuildingNumber",
          "TownName" : "TownName",
          "Country" : "Country",
          "SubDepartment" : "SubDepartment",
          "AddressType" : { },
          "PostCode" : "PostCode"
        },
        "SchemeName" : [ "UK.OBIE.BICFI" ],
        "Identification" : "Identification",
        "Name" : "Name"
      },
      "Reference" : "Reference",
      "CurrencyOfTransfer" : "CurrencyOfTransfer",
      "CreditorAccount" : {
        "SecondaryIdentification" : "SecondaryIdentification",
        "SchemeName" : [ "UK.OBIE.BBAN", "UK.OBIE.IBAN", "UK.OBIE.PAN", "UK.OBIE.Paym", "UK.OBIE.SortCodeAccountNumber" ],
        "Identification" : "Identification",
        "Name" : "Name"
      },
      "Purpose" : { },
      "ChargeBearer" : { },
      "FinalPaymentDateTime" : "2000-01-23T04:56:07.000+00:00",
      "Frequency" : "Frequency",
      "FirstPaymentDateTime" : "2000-01-23T04:56:07.000+00:00",
      "NumberOfPayments" : "NumberOfPayments",
      "Creditor" : {
        "PostalAddress" : {
          "StreetName" : "StreetName",
          "CountrySubDivision" : "CountrySubDivision",
          "Department" : "Department",
          "AddressLine" : "",
          "BuildingNumber" : "BuildingNumber",
          "TownName" : "TownName",
          "Country" : "Country",
          "SubDepartment" : "SubDepartment",
          "AddressType" : { },
          "PostCode" : "PostCode"
        },
        "Name" : "Name"
      },
      "InstructedAmount" : {
        "Amount" : "Amount",
        "Currency" : "Currency"
      }
    }
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

International Standing Order Consents Created OBWriteInternationalStandingOrderConsentResponse2

400

Bad request OBErrorResponse1

401

Unauthorized

403

Forbidden

404

Not found

405

Method Not Allowed

406

Not Acceptable

415

Unsupported Media Type

429

Too Many Requests

500

Internal Server Error OBErrorResponse1

Up
post /international-standing-orders
Create International Standing Orders (createInternationalStandingOrders)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

OBWriteInternationalStandingOrder2Param OBWriteInternationalStandingOrder2 (required)
Body Parameter Default

Request headers

Return type

OBWriteInternationalStandingOrderResponse2

Example data

Content-Type: application/json
{
  "Meta" : {
    "FirstAvailableDateTime" : { },
    "TotalPages" : 0
  },
  "Links" : {
    "Last" : "http://example.com/aeiou",
    "Prev" : "http://example.com/aeiou",
    "Next" : "http://example.com/aeiou",
    "Self" : "http://example.com/aeiou",
    "First" : "http://example.com/aeiou"
  },
  "Data" : {
    "Status" : { },
    "StatusUpdateDateTime" : "2000-01-23T04:56:07.000+00:00",
    "CreationDateTime" : "2000-01-23T04:56:07.000+00:00",
    "Charges" : [ {
      "Type" : [ "UK.OBIE.CHAPSOut", "UK.OBIE.BalanceTransferOut", "UK.OBIE.MoneyTransferOut" ],
      "Amount" : {
        "Amount" : {
          "Amount" : "Amount",
          "Currency" : "Currency"
        },
        "Currency" : "Currency"
      },
      "ChargeBearer" : { }
    }, {
      "Type" : [ "UK.OBIE.CHAPSOut", "UK.OBIE.BalanceTransferOut", "UK.OBIE.MoneyTransferOut" ],
      "Amount" : {
        "Amount" : {
          "Amount" : "Amount",
          "Currency" : "Currency"
        },
        "Currency" : "Currency"
      },
      "ChargeBearer" : { }
    } ],
    "InternationalStandingOrderId" : "InternationalStandingOrderId",
    "ConsentId" : "ConsentId",
    "Initiation" : {
      "SupplementaryData" : { },
      "DebtorAccount" : {
        "SecondaryIdentification" : "SecondaryIdentification",
        "SchemeName" : [ "UK.OBIE.BBAN", "UK.OBIE.IBAN", "UK.OBIE.PAN", "UK.OBIE.Paym", "UK.OBIE.SortCodeAccountNumber" ],
        "Identification" : "Identification",
        "Name" : "Name"
      },
      "CreditorAgent" : {
        "PostalAddress" : {
          "StreetName" : "StreetName",
          "CountrySubDivision" : "CountrySubDivision",
          "Department" : "Department",
          "AddressLine" : "",
          "BuildingNumber" : "BuildingNumber",
          "TownName" : "TownName",
          "Country" : "Country",
          "SubDepartment" : "SubDepartment",
          "AddressType" : { },
          "PostCode" : "PostCode"
        },
        "SchemeName" : [ "UK.OBIE.BICFI" ],
        "Identification" : "Identification",
        "Name" : "Name"
      },
      "Reference" : "Reference",
      "CurrencyOfTransfer" : "CurrencyOfTransfer",
      "CreditorAccount" : {
        "SecondaryIdentification" : "SecondaryIdentification",
        "SchemeName" : [ "UK.OBIE.BBAN", "UK.OBIE.IBAN", "UK.OBIE.PAN", "UK.OBIE.Paym", "UK.OBIE.SortCodeAccountNumber" ],
        "Identification" : "Identification",
        "Name" : "Name"
      },
      "Purpose" : { },
      "ChargeBearer" : { },
      "FinalPaymentDateTime" : "2000-01-23T04:56:07.000+00:00",
      "Frequency" : "Frequency",
      "FirstPaymentDateTime" : "2000-01-23T04:56:07.000+00:00",
      "NumberOfPayments" : "NumberOfPayments",
      "Creditor" : {
        "PostalAddress" : {
          "StreetName" : "StreetName",
          "CountrySubDivision" : "CountrySubDivision",
          "Department" : "Department",
          "AddressLine" : "",
          "BuildingNumber" : "BuildingNumber",
          "TownName" : "TownName",
          "Country" : "Country",
          "SubDepartment" : "SubDepartment",
          "AddressType" : { },
          "PostCode" : "PostCode"
        },
        "Name" : "Name"
      },
      "InstructedAmount" : {
        "Amount" : "Amount",
        "Currency" : "Currency"
      }
    },
    "MultiAuthorisation" : {
      "Status" : { },
      "NumberReceived" : 6,
      "LastUpdateDateTime" : "2000-01-23T04:56:07.000+00:00",
      "ExpirationDateTime" : "2000-01-23T04:56:07.000+00:00",
      "NumberRequired" : 0
    }
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

International Standing Orders Created OBWriteInternationalStandingOrderResponse2

400

Bad request OBErrorResponse1

401

Unauthorized

403

Forbidden

404

Not found

405

Method Not Allowed

406

Not Acceptable

415

Unsupported Media Type

429

Too Many Requests

500

Internal Server Error OBErrorResponse1

Up
get /international-standing-order-consents/{ConsentId}
Get International Standing Order Consents (getInternationalStandingOrderConsentsConsentId)

Path parameters

ConsentId (required)
Path Parameter ConsentId

Consumes

This API call consumes the following media types via the Content-Type request header:

Request headers

Return type

OBWriteInternationalStandingOrderConsentResponse2

Example data

Content-Type: application/json
{
  "Meta" : {
    "FirstAvailableDateTime" : { },
    "TotalPages" : 0
  },
  "Risk" : {
    "PaymentContextCode" : { },
    "DeliveryAddress" : {
      "StreetName" : "StreetName",
      "CountrySubDivision" : "",
      "AddressLine" : "",
      "BuildingNumber" : "BuildingNumber",
      "TownName" : "TownName",
      "Country" : "Country",
      "PostCode" : "PostCode"
    },
    "MerchantCategoryCode" : "MerchantCategoryCode",
    "MerchantCustomerIdentification" : "MerchantCustomerIdentification"
  },
  "Links" : {
    "Last" : "http://example.com/aeiou",
    "Prev" : "http://example.com/aeiou",
    "Next" : "http://example.com/aeiou",
    "Self" : "http://example.com/aeiou",
    "First" : "http://example.com/aeiou"
  },
  "Data" : {
    "Status" : { },
    "StatusUpdateDateTime" : "2000-01-23T04:56:07.000+00:00",
    "CreationDateTime" : "2000-01-23T04:56:07.000+00:00",
    "CutOffDateTime" : "2000-01-23T04:56:07.000+00:00",
    "Authorisation" : {
      "CompletionDateTime" : "2000-01-23T04:56:07.000+00:00",
      "AuthorisationType" : { }
    },
    "Permission" : { },
    "Charges" : [ {
      "Type" : [ "UK.OBIE.CHAPSOut", "UK.OBIE.BalanceTransferOut", "UK.OBIE.MoneyTransferOut" ],
      "Amount" : {
        "Amount" : {
          "Amount" : "Amount",
          "Currency" : "Currency"
        },
        "Currency" : "Currency"
      },
      "ChargeBearer" : { }
    }, {
      "Type" : [ "UK.OBIE.CHAPSOut", "UK.OBIE.BalanceTransferOut", "UK.OBIE.MoneyTransferOut" ],
      "Amount" : {
        "Amount" : {
          "Amount" : "Amount",
          "Currency" : "Currency"
        },
        "Currency" : "Currency"
      },
      "ChargeBearer" : { }
    } ],
    "ConsentId" : "ConsentId",
    "Initiation" : {
      "SupplementaryData" : { },
      "DebtorAccount" : {
        "SecondaryIdentification" : "SecondaryIdentification",
        "SchemeName" : [ "UK.OBIE.BBAN", "UK.OBIE.IBAN", "UK.OBIE.PAN", "UK.OBIE.Paym", "UK.OBIE.SortCodeAccountNumber" ],
        "Identification" : "Identification",
        "Name" : "Name"
      },
      "CreditorAgent" : {
        "PostalAddress" : {
          "StreetName" : "StreetName",
          "CountrySubDivision" : "CountrySubDivision",
          "Department" : "Department",
          "AddressLine" : "",
          "BuildingNumber" : "BuildingNumber",
          "TownName" : "TownName",
          "Country" : "Country",
          "SubDepartment" : "SubDepartment",
          "AddressType" : { },
          "PostCode" : "PostCode"
        },
        "SchemeName" : [ "UK.OBIE.BICFI" ],
        "Identification" : "Identification",
        "Name" : "Name"
      },
      "Reference" : "Reference",
      "CurrencyOfTransfer" : "CurrencyOfTransfer",
      "CreditorAccount" : {
        "SecondaryIdentification" : "SecondaryIdentification",
        "SchemeName" : [ "UK.OBIE.BBAN", "UK.OBIE.IBAN", "UK.OBIE.PAN", "UK.OBIE.Paym", "UK.OBIE.SortCodeAccountNumber" ],
        "Identification" : "Identification",
        "Name" : "Name"
      },
      "Purpose" : { },
      "ChargeBearer" : { },
      "FinalPaymentDateTime" : "2000-01-23T04:56:07.000+00:00",
      "Frequency" : "Frequency",
      "FirstPaymentDateTime" : "2000-01-23T04:56:07.000+00:00",
      "NumberOfPayments" : "NumberOfPayments",
      "Creditor" : {
        "PostalAddress" : {
          "StreetName" : "StreetName",
          "CountrySubDivision" : "CountrySubDivision",
          "Department" : "Department",
          "AddressLine" : "",
          "BuildingNumber" : "BuildingNumber",
          "TownName" : "TownName",
          "Country" : "Country",
          "SubDepartment" : "SubDepartment",
          "AddressType" : { },
          "PostCode" : "PostCode"
        },
        "Name" : "Name"
      },
      "InstructedAmount" : {
        "Amount" : "Amount",
        "Currency" : "Currency"
      }
    }
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

International Standing Order Consents Read OBWriteInternationalStandingOrderConsentResponse2

400

Bad request OBErrorResponse1

401

Unauthorized

403

Forbidden

404

Not found

405

Method Not Allowed

406

Not Acceptable

429

Too Many Requests

500

Internal Server Error OBErrorResponse1

Up
get /international-standing-orders/{InternationalStandingOrderPaymentId}
Get International Standing Orders (getInternationalStandingOrdersInternationalStandingOrderPaymentId)

Path parameters

InternationalStandingOrderPaymentId (required)
Path Parameter InternationalStandingOrderPaymentId

Consumes

This API call consumes the following media types via the Content-Type request header:

Request headers

Return type

OBWriteInternationalStandingOrderResponse2

Example data

Content-Type: application/json
{
  "Meta" : {
    "FirstAvailableDateTime" : { },
    "TotalPages" : 0
  },
  "Links" : {
    "Last" : "http://example.com/aeiou",
    "Prev" : "http://example.com/aeiou",
    "Next" : "http://example.com/aeiou",
    "Self" : "http://example.com/aeiou",
    "First" : "http://example.com/aeiou"
  },
  "Data" : {
    "Status" : { },
    "StatusUpdateDateTime" : "2000-01-23T04:56:07.000+00:00",
    "CreationDateTime" : "2000-01-23T04:56:07.000+00:00",
    "Charges" : [ {
      "Type" : [ "UK.OBIE.CHAPSOut", "UK.OBIE.BalanceTransferOut", "UK.OBIE.MoneyTransferOut" ],
      "Amount" : {
        "Amount" : {
          "Amount" : "Amount",
          "Currency" : "Currency"
        },
        "Currency" : "Currency"
      },
      "ChargeBearer" : { }
    }, {
      "Type" : [ "UK.OBIE.CHAPSOut", "UK.OBIE.BalanceTransferOut", "UK.OBIE.MoneyTransferOut" ],
      "Amount" : {
        "Amount" : {
          "Amount" : "Amount",
          "Currency" : "Currency"
        },
        "Currency" : "Currency"
      },
      "ChargeBearer" : { }
    } ],
    "InternationalStandingOrderId" : "InternationalStandingOrderId",
    "ConsentId" : "ConsentId",
    "Initiation" : {
      "SupplementaryData" : { },
      "DebtorAccount" : {
        "SecondaryIdentification" : "SecondaryIdentification",
        "SchemeName" : [ "UK.OBIE.BBAN", "UK.OBIE.IBAN", "UK.OBIE.PAN", "UK.OBIE.Paym", "UK.OBIE.SortCodeAccountNumber" ],
        "Identification" : "Identification",
        "Name" : "Name"
      },
      "CreditorAgent" : {
        "PostalAddress" : {
          "StreetName" : "StreetName",
          "CountrySubDivision" : "CountrySubDivision",
          "Department" : "Department",
          "AddressLine" : "",
          "BuildingNumber" : "BuildingNumber",
          "TownName" : "TownName",
          "Country" : "Country",
          "SubDepartment" : "SubDepartment",
          "AddressType" : { },
          "PostCode" : "PostCode"
        },
        "SchemeName" : [ "UK.OBIE.BICFI" ],
        "Identification" : "Identification",
        "Name" : "Name"
      },
      "Reference" : "Reference",
      "CurrencyOfTransfer" : "CurrencyOfTransfer",
      "CreditorAccount" : {
        "SecondaryIdentification" : "SecondaryIdentification",
        "SchemeName" : [ "UK.OBIE.BBAN", "UK.OBIE.IBAN", "UK.OBIE.PAN", "UK.OBIE.Paym", "UK.OBIE.SortCodeAccountNumber" ],
        "Identification" : "Identification",
        "Name" : "Name"
      },
      "Purpose" : { },
      "ChargeBearer" : { },
      "FinalPaymentDateTime" : "2000-01-23T04:56:07.000+00:00",
      "Frequency" : "Frequency",
      "FirstPaymentDateTime" : "2000-01-23T04:56:07.000+00:00",
      "NumberOfPayments" : "NumberOfPayments",
      "Creditor" : {
        "PostalAddress" : {
          "StreetName" : "StreetName",
          "CountrySubDivision" : "CountrySubDivision",
          "Department" : "Department",
          "AddressLine" : "",
          "BuildingNumber" : "BuildingNumber",
          "TownName" : "TownName",
          "Country" : "Country",
          "SubDepartment" : "SubDepartment",
          "AddressType" : { },
          "PostCode" : "PostCode"
        },
        "Name" : "Name"
      },
      "InstructedAmount" : {
        "Amount" : "Amount",
        "Currency" : "Currency"
      }
    },
    "MultiAuthorisation" : {
      "Status" : { },
      "NumberReceived" : 6,
      "LastUpdateDateTime" : "2000-01-23T04:56:07.000+00:00",
      "ExpirationDateTime" : "2000-01-23T04:56:07.000+00:00",
      "NumberRequired" : 0
    }
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

International Standing Orders Read OBWriteInternationalStandingOrderResponse2

400

Bad request OBErrorResponse1

401

Unauthorized

403

Forbidden

404

Not found

405

Method Not Allowed

406

Not Acceptable

429

Too Many Requests

500

Internal Server Error OBErrorResponse1

Models

[ Jump to Methods ]

Table of Contents

  1. File -
  2. ISODateTime -
  3. Links -
  4. Meta - MetaData
  5. OBActiveCurrencyAndAmount_SimpleType -
  6. OBActiveOrHistoricCurrencyAndAmount -
  7. OBAddressLine -
  8. OBAddressTypeCode -
  9. OBAuthorisation1 -
  10. OBBranchAndFinancialInstitutionIdentification6 -
  11. OBCashAccountCreditor3 -
  12. OBCashAccountDebtor4 -
  13. OBCharge2 -
  14. OBCharge2_Amount -
  15. OBChargeBearerType1Code -
  16. OBCountrySubDiv -
  17. OBDeliverAddress -
  18. OBDomestic2 -
  19. OBDomesticScheduled2 -
  20. OBDomesticStandingOrder2 -
  21. OBError1 -
  22. OBErrorResponse1 -
  23. OBExchangeRate1 -
  24. OBExchangeRate2 -
  25. OBExchangeRateType2Code -
  26. OBExternalAccountIdentification4Code -
  27. OBExternalAuthorisation1Code -
  28. OBExternalConsentStatus1Code -
  29. OBExternalConsentStatus2Code -
  30. OBExternalFileType1Code -
  31. OBExternalFinancialInstitutionIdentification4Code -
  32. OBExternalLocalInstrument1Code -
  33. OBExternalPaymentChargeType1Code -
  34. OBExternalPaymentContext1Code -
  35. OBExternalPermissions2Code -
  36. OBExternalPurpose1Code1 -
  37. OBExternalStatus1Code -
  38. OBExternalStatus2Code -
  39. OBFile2 -
  40. OBFundsAvailableResult1 -
  41. OBInternational2 -
  42. OBInternationalScheduled2 -
  43. OBInternationalStandingOrder2 -
  44. OBMultiAuthorisation1 -
  45. OBPartyIdentification43 -
  46. OBPostalAddress6 -
  47. OBPostalAddressLine -
  48. OBPriority2Code -
  49. OBRemittanceInformation1 -
  50. OBRisk1 -
  51. OBSupplementaryData1 -
  52. OBTransactionIndividualStatus1Code -
  53. OBWriteDataDomestic2 -
  54. OBWriteDataDomesticConsent2 -
  55. OBWriteDataDomesticConsentResponse2 -
  56. OBWriteDataDomesticResponse2 -
  57. OBWriteDataDomesticScheduled2 -
  58. OBWriteDataDomesticScheduledConsent2 -
  59. OBWriteDataDomesticScheduledConsentResponse2 -
  60. OBWriteDataDomesticScheduledResponse2 -
  61. OBWriteDataDomesticStandingOrder2 -
  62. OBWriteDataDomesticStandingOrderConsent2 -
  63. OBWriteDataDomesticStandingOrderConsentResponse2 -
  64. OBWriteDataDomesticStandingOrderResponse2 -
  65. OBWriteDataFile2 -
  66. OBWriteDataFileConsent2 -
  67. OBWriteDataFileConsentResponse2 -
  68. OBWriteDataFileResponse2 -
  69. OBWriteDataFundsConfirmationResponse1 -
  70. OBWriteDataInternational2 -
  71. OBWriteDataInternationalConsent2 -
  72. OBWriteDataInternationalConsentResponse2 -
  73. OBWriteDataInternationalResponse2 -
  74. OBWriteDataInternationalScheduled2 -
  75. OBWriteDataInternationalScheduledConsent2 -
  76. OBWriteDataInternationalScheduledConsentResponse2 -
  77. OBWriteDataInternationalScheduledResponse2 -
  78. OBWriteDataInternationalStandingOrder2 -
  79. OBWriteDataInternationalStandingOrderConsent2 -
  80. OBWriteDataInternationalStandingOrderConsentResponse2 -
  81. OBWriteDataInternationalStandingOrderResponse2 -
  82. OBWriteDomestic2 -
  83. OBWriteDomesticConsent2 -
  84. OBWriteDomesticConsentResponse2 -
  85. OBWriteDomesticResponse2 -
  86. OBWriteDomesticScheduled2 -
  87. OBWriteDomesticScheduledConsent2 -
  88. OBWriteDomesticScheduledConsentResponse2 -
  89. OBWriteDomesticScheduledResponse2 -
  90. OBWriteDomesticStandingOrder2 -
  91. OBWriteDomesticStandingOrderConsent2 -
  92. OBWriteDomesticStandingOrderConsentResponse2 -
  93. OBWriteDomesticStandingOrderResponse2 -
  94. OBWriteFile2 -
  95. OBWriteFileConsent2 -
  96. OBWriteFileConsentResponse2 -
  97. OBWriteFileResponse2 -
  98. OBWriteFundsConfirmationResponse1 -
  99. OBWriteInternational2 -
  100. OBWriteInternationalConsent2 -
  101. OBWriteInternationalConsentResponse2 -
  102. OBWriteInternationalResponse2 -
  103. OBWriteInternationalScheduled2 -
  104. OBWriteInternationalScheduledConsent2 -
  105. OBWriteInternationalScheduledConsentResponse2 -
  106. OBWriteInternationalScheduledResponse2 -
  107. OBWriteInternationalStandingOrder2 -
  108. OBWriteInternationalStandingOrderConsent2 -
  109. OBWriteInternationalStandingOrderConsentResponse2 -
  110. OBWriteInternationalStandingOrderResponse2 -

File - Up

ISODateTime - Up

All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

Links - Up

Links relevant to the payload
Self
String format: uri
First (optional)
String format: uri
Prev (optional)
String format: uri
Next (optional)
String format: uri
Last (optional)
String format: uri

Meta - MetaData Up

Meta Data relevant to the payload
TotalPages (optional)
Integer format: int32
FirstAvailableDateTime (optional)
LastAvailableDateTime (optional)

OBActiveCurrencyAndAmount_SimpleType - Up

A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Amount
Currency

OBActiveOrHistoricCurrencyAndAmount - Up

OBAddressLine - Up

Information that locates and identifies a specific address, as defined by postal services, that is presented in free format text.

OBAddressTypeCode - Up

Identifies the nature of the postal address.

OBAuthorisation1 - Up

The authorisation type request from the TPP.
AuthorisationType
CompletionDateTime (optional)
Date Date and time at which the requested authorisation flow must be completed. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 format: date-time

OBBranchAndFinancialInstitutionIdentification6 - Up

Party that manages the account on behalf of the account owner, that is manages the registration and booking of entries on the account, calculates balances on the account and provides information about the account. This is the servicer of the beneficiary account.
SchemeName (optional)
Identification (optional)
String Unique and unambiguous identification of the servicing institution.
Name (optional)
String Name by which an agent is known and which is usually used to identify that agent.
PostalAddress (optional)

OBCashAccountCreditor3 - Up

Provides the details to identify the beneficiary account.
SchemeName
Identification
String Identification assigned by an institution to identify an account. This identification is known by the account owner.
Name
String Name of the account, as assigned by the account servicing institution. Usage: 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. OB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory.
SecondaryIdentification (optional)
String This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).

OBCashAccountDebtor4 - Up

Provides the details to identify the debtor account.
SchemeName
Identification
String Identification assigned by an institution to identify an account. This identification is known by the account owner.
Name (optional)
String Name of the account, as assigned by the account servicing institution. Usage: 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.
SecondaryIdentification (optional)
String This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).

OBCharge2 - Up

Set of elements used to provide details of a charge for the payment initiation.
ChargeBearer
Type
Amount

OBCharge2_Amount - Up

Amount of money associated with the charge type.
Amount
Currency

OBChargeBearerType1Code - Up

Specifies which party/parties will bear the charges associated with the processing of the payment transaction.

OBCountrySubDiv - Up

OBDeliverAddress - Up

Information that locates and identifies a specific address, as defined by postal services or in free format text.
AddressLine (optional)
StreetName (optional)
String Name of a street or thoroughfare.
BuildingNumber (optional)
String Number that identifies the position of a building on a street.
PostCode (optional)
String Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
TownName
String Name of a built-up area, with defined boundaries, and a local government.
CountrySubDivision (optional)
Country
String Nation with its own government, occupying a particular territory.

OBDomestic2 - Up

The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single domestic payment.
InstructionIdentification
String Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction. Usage: the instruction identification is a point to point reference that can be used between the instructing party and the instructed party to refer to the individual instruction. It can be included in several messages related to the instruction.
EndToEndIdentification
String Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain. Usage: The end-to-end identification can be used for reconciliation or to link tasks relating to the transaction. It can be included in several messages related to the transaction. OB: The Faster Payments Scheme can only access 31 characters for the EndToEndIdentification field.
LocalInstrument (optional)
InstructedAmount
OBActiveCurrencyAndAmount_SimpleType Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party. Usage: This amount has to be transported unchanged through the transaction chain.
DebtorAccount (optional)
CreditorAccount
CreditorPostalAddress (optional)
RemittanceInformation (optional)
SupplementaryData (optional)

OBDomesticScheduled2 - Up

The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single scheduled domestic payment.
InstructionIdentification
String Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction. Usage: the instruction identification is a point to point reference that can be used between the instructing party and the instructed party to refer to the individual instruction. It can be included in several messages related to the instruction.
EndToEndIdentification (optional)
String Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain. Usage: The end-to-end identification can be used for reconciliation or to link tasks relating to the transaction. It can be included in several messages related to the transaction. OB: The Faster Payments Scheme can only access 31 characters for the EndToEndIdentification field.
LocalInstrument (optional)
RequestedExecutionDateTime
Date Date at which the initiating party requests the clearing agent to process the payment. Usage: This is the date on which the debtor's account is to be debited. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 format: date-time
InstructedAmount
OBActiveCurrencyAndAmount_SimpleType Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party. Usage: This amount has to be transported unchanged through the transaction chain.
DebtorAccount (optional)
CreditorAccount
CreditorPostalAddress (optional)
RemittanceInformation (optional)
SupplementaryData (optional)

OBDomesticStandingOrder2 - Up

The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a domestic standing order.
Frequency
String Individual Definitions: EvryDay - Every day EvryWorkgDay - Every working day IntrvlDay - An interval specified in number of calendar days (02 to 31) IntrvlWkDay - An interval specified in weeks (01 to 09), and the day within the week (01 to 07) WkInMnthDay - A monthly interval, specifying the week of the month (01 to 05) and day within the week (01 to 07) IntrvlMnthDay - An interval specified in months (between 01 to 06, 12, 24), specifying the day within the month (-5 to -1, 1 to 31) QtrDay - Quarterly (either ENGLISH, SCOTTISH, or RECEIVED). ENGLISH = Paid on the 25th March, 24th June, 29th September and 25th December. SCOTTISH = Paid on the 2nd February, 15th May, 1st August and 11th November. RECEIVED = Paid on the 20th March, 19th June, 24th September and 20th December. Individual Patterns: EvryDay (ScheduleCode) EvryWorkgDay (ScheduleCode) IntrvlDay:NoOfDay (ScheduleCode + NoOfDay) IntrvlWkDay:IntervalInWeeks:DayInWeek (ScheduleCode + IntervalInWeeks + DayInWeek) WkInMnthDay:WeekInMonth:DayInWeek (ScheduleCode + WeekInMonth + DayInWeek) IntrvlMnthDay:IntervalInMonths:DayInMonth (ScheduleCode + IntervalInMonths + DayInMonth) QtrDay: + either (ENGLISH, SCOTTISH or RECEIVED) ScheduleCode + QuarterDay The regular expression for this element combines five smaller versions for each permitted pattern. To aid legibility - the components are presented individually here: EvryDay EvryWorkgDay IntrvlDay:((0[2-9])|([1-2][0-9])|3[0-1]) IntrvlWkDay:0[1-9]:0[1-7] WkInMnthDay:0[1-5]:0[1-7] IntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01]) QtrDay:(ENGLISH|SCOTTISH|RECEIVED) Full Regular Expression: ^(EvryDay)$|^(EvryWorkgDay)$|^(IntrvlDay:((0[2-9])|([1-2][0-9])|3[0-1]))$|^(IntrvlWkDay:0[1-9]:0[1-7])$|^(WkInMnthDay:0[1-5]:0[1-7])$|^(IntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01]))$|^(QtrDay:(ENGLISH|SCOTTISH|RECEIVED))$
Reference (optional)
String Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. Usage: 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.
NumberOfPayments (optional)
String Number of the payments that will be made in completing this frequency sequence including any executed since the sequence start date.
FirstPaymentDateTime
Date The date on which the first payment for a Standing Order schedule will be made. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 format: date-time
RecurringPaymentDateTime (optional)
Date The date on which the first recurring payment for a Standing Order schedule will be made. Usage: This must be populated only if the first recurring date is different to the first payment date. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 format: date-time
FinalPaymentDateTime (optional)
Date The date on which the final payment for a Standing Order schedule will be made. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 format: date-time
FirstPaymentAmount
OBActiveCurrencyAndAmount_SimpleType The amount of the first Standing Order
RecurringPaymentAmount (optional)
OBActiveCurrencyAndAmount_SimpleType The amount of the recurring Standing Order
FinalPaymentAmount (optional)
OBActiveCurrencyAndAmount_SimpleType The amount of the final Standing Order
DebtorAccount (optional)
CreditorAccount
SupplementaryData (optional)

OBError1 - Up

ErrorCode
String Low level textual error code, e.g., UK.OBIE.Field.Missing
Message
String A description of the error that occurred. e.g., 'A mandatory field isn't supplied' or 'RequestedExecutionDateTime must be in future' OBIE doesn't standardise this field
Path (optional)
String Recommended but optional reference to the JSON Path of the field with error, e.g., Data.Initiation.InstructedAmount.Currency
Url (optional)
String URL to help remediate the problem, or provide more information, or to API Reference, or help etc

OBErrorResponse1 - Up

An array of detail error codes, and messages, and URLs to documentation to help remediation.
Code
String High level textual error code, to help categorize the errors.
Id (optional)
String A unique reference for the error instance, for audit purposes, in case of unknown/unclassified errors.
Message
String Brief Error message, e.g., 'There is something wrong with the request parameters provided'
Errors

OBExchangeRate1 - Up

Provides details on the currency exchange rate and contract.
UnitCurrency
String Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP.
ExchangeRate (optional)
BigDecimal The factor used for conversion of an amount from one currency to another. This reflects the price at which one currency was bought with another currency.
RateType
ContractIdentification (optional)
String Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent.

OBExchangeRate2 - Up

Further detailed information on the exchange rate that has been used in the payment transaction.
UnitCurrency
String Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP.
ExchangeRate
BigDecimal The factor used for conversion of an amount from one currency to another. This reflects the price at which one currency was bought with another currency.
RateType
ContractIdentification (optional)
String Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent.
ExpirationDateTime (optional)
Date Specified date and time the exchange rate agreement will expire. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 format: date-time

OBExchangeRateType2Code - Up

Specifies the type used to complete the currency exchange.

OBExternalAccountIdentification4Code - Up

Name of the identification scheme, in a coded form as published in an external list.

OBExternalAuthorisation1Code - Up

Type of authorisation flow requested.

OBExternalConsentStatus1Code - Up

Specifies the status of resource in code form.

OBExternalConsentStatus2Code - Up

Specifies the status of consent resource in code form.

OBExternalFileType1Code - Up

Specifies the payment file type.

OBExternalFinancialInstitutionIdentification4Code - Up

Name of the identification scheme, in a coded form as published in an external list.

OBExternalLocalInstrument1Code - Up

User community specific instrument. Usage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.

OBExternalPaymentChargeType1Code - Up

Charge type, in a coded form.

OBExternalPaymentContext1Code - Up

Specifies the payment context

OBExternalPermissions2Code - Up

Specifies the Open Banking service request types.

OBExternalPurpose1Code1 - Up

Specifies the external purpose code in the format of character string with a maximum length of 4 characters. The list of valid codes is an external code list published separately. External code sets can be downloaded from www.iso20022.org.

OBExternalStatus1Code - Up

Specifies the status of resource in code form.

OBExternalStatus2Code - Up

Specifies the status of the authorisation flow in code form.

OBFile2 - Up

The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds using a payment file.
FileType
FileHash
String A base64 encoding of a SHA256 hash of the file to be uploaded.
FileReference (optional)
String Reference for the file.
NumberOfTransactions (optional)
String Number of individual transactions contained in the payment information group.
ControlSum (optional)
BigDecimal Total of all individual amounts included in the group, irrespective of currencies.
RequestedExecutionDateTime (optional)
Date Date at which the initiating party requests the clearing agent to process the payment. Usage: This is the date on which the debtor's account is to be debited. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 format: date-time
LocalInstrument (optional)
DebtorAccount (optional)
RemittanceInformation (optional)
SupplementaryData (optional)

OBFundsAvailableResult1 - Up

Result of a funds availability check.
FundsAvailableDateTime
Date Date and time at which the funds availability check was generated. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 format: date-time
FundsAvailable
Boolean Flag to indicate the availability of funds given the Amount in the consent request.

OBInternational2 - Up

The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single international payment.
InstructionIdentification
String Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction. Usage: the instruction identification is a point to point reference that can be used between the instructing party and the instructed party to refer to the individual instruction. It can be included in several messages related to the instruction.
EndToEndIdentification
String Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain. Usage: The end-to-end identification can be used for reconciliation or to link tasks relating to the transaction. It can be included in several messages related to the transaction. OB: The Faster Payments Scheme can only access 31 characters for the EndToEndIdentification field.
LocalInstrument (optional)
InstructionPriority (optional)
Purpose (optional)
ChargeBearer (optional)
CurrencyOfTransfer
String Specifies the currency of the to be transferred amount, which is different from the currency of the debtor's account.
InstructedAmount
OBActiveCurrencyAndAmount_SimpleType Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party. Usage: This amount has to be transported unchanged through the transaction chain.
ExchangeRateInformation (optional)
DebtorAccount (optional)
Creditor (optional)
CreditorAgent (optional)
CreditorAccount
RemittanceInformation (optional)
SupplementaryData (optional)

OBInternationalScheduled2 - Up

The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single scheduled international payment.
InstructionIdentification
String Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction. Usage: the instruction identification is a point to point reference that can be used between the instructing party and the instructed party to refer to the individual instruction. It can be included in several messages related to the instruction.
EndToEndIdentification (optional)
String Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain. Usage: The end-to-end identification can be used for reconciliation or to link tasks relating to the transaction. It can be included in several messages related to the transaction. OB: The Faster Payments Scheme can only access 31 characters for the EndToEndIdentification field.
LocalInstrument (optional)
InstructionPriority (optional)
Purpose (optional)
ChargeBearer (optional)
RequestedExecutionDateTime
Date Date at which the initiating party requests the clearing agent to process the payment. Usage: This is the date on which the debtor's account is to be debited. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 format: date-time
CurrencyOfTransfer
String Specifies the currency of the to be transferred amount, which is different from the currency of the debtor's account.
InstructedAmount
OBActiveCurrencyAndAmount_SimpleType Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party. Usage: This amount has to be transported unchanged through the transaction chain.
ExchangeRateInformation (optional)
DebtorAccount (optional)
Creditor (optional)
CreditorAgent (optional)
CreditorAccount
RemittanceInformation (optional)
SupplementaryData (optional)

OBInternationalStandingOrder2 - Up

The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for an international standing order.
Frequency
String Individual Definitions: EvryDay - Every day EvryWorkgDay - Every working day IntrvlDay - An interval specified in number of calendar days (02 to 31) IntrvlWkDay - An interval specified in weeks (01 to 09), and the day within the week (01 to 07) WkInMnthDay - A monthly interval, specifying the week of the month (01 to 05) and day within the week (01 to 07) IntrvlMnthDay - An interval specified in months (between 01 to 06, 12, 24), specifying the day within the month (-5 to -1, 1 to 31) QtrDay - Quarterly (either ENGLISH, SCOTTISH, or RECEIVED). ENGLISH = Paid on the 25th March, 24th June, 29th September and 25th December. SCOTTISH = Paid on the 2nd February, 15th May, 1st August and 11th November. RECEIVED = Paid on the 20th March, 19th June, 24th September and 20th December. Individual Patterns: EvryDay (ScheduleCode) EvryWorkgDay (ScheduleCode) IntrvlDay:NoOfDay (ScheduleCode + NoOfDay) IntrvlWkDay:IntervalInWeeks:DayInWeek (ScheduleCode + IntervalInWeeks + DayInWeek) WkInMnthDay:WeekInMonth:DayInWeek (ScheduleCode + WeekInMonth + DayInWeek) IntrvlMnthDay:IntervalInMonths:DayInMonth (ScheduleCode + IntervalInMonths + DayInMonth) QtrDay: + either (ENGLISH, SCOTTISH or RECEIVED) ScheduleCode + QuarterDay The regular expression for this element combines five smaller versions for each permitted pattern. To aid legibility - the components are presented individually here: EvryDay EvryWorkgDay IntrvlDay:((0[2-9])|([1-2][0-9])|3[0-1]) IntrvlWkDay:0[1-9]:0[1-7] WkInMnthDay:0[1-5]:0[1-7] IntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01]) QtrDay:(ENGLISH|SCOTTISH|RECEIVED) Full Regular Expression: ^(EvryDay)$|^(EvryWorkgDay)$|^(IntrvlDay:((0[2-9])|([1-2][0-9])|3[0-1]))$|^(IntrvlWkDay:0[1-9]:0[1-7])$|^(WkInMnthDay:0[1-5]:0[1-7])$|^(IntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01]))$|^(QtrDay:(ENGLISH|SCOTTISH|RECEIVED))$
Reference (optional)
String Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. Usage: 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.
NumberOfPayments (optional)
String Number of the payments that will be made in completing this frequency sequence including any executed since the sequence start date.
FirstPaymentDateTime
Date The date on which the first payment for a Standing Order schedule will be made. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 format: date-time
FinalPaymentDateTime (optional)
Date The date on which the final payment for a Standing Order schedule will be made. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 format: date-time
Purpose (optional)
ChargeBearer (optional)
CurrencyOfTransfer
String Specifies the currency of the to be transferred amount, which is different from the currency of the debtor's account.
InstructedAmount
OBActiveCurrencyAndAmount_SimpleType Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party. Usage: This amount has to be transported unchanged through the transaction chain.
DebtorAccount (optional)
Creditor (optional)
CreditorAgent (optional)
CreditorAccount
SupplementaryData (optional)

OBMultiAuthorisation1 - Up

The multiple authorisation flow response from the ASPSP.
Status
NumberRequired (optional)
Integer Number of authorisations required for payment order (total required at the start of the multi authorisation journey). format: int32
NumberReceived (optional)
Integer Number of authorisations required for payment order (total required at the start of the multi authorisation journey). format: int32
LastUpdateDateTime (optional)
Date Last date and time at the authorisation flow was updated. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 format: date-time
ExpirationDateTime (optional)
Date Date and time at which the requested authorisation flow must be completed. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 format: date-time

OBPartyIdentification43 - Up

Party to which an amount of money is due.
Name (optional)
String Name by which a party is known and which is usually used to identify that party.
PostalAddress (optional)

OBPostalAddress6 - Up

Information that locates and identifies a specific address, as defined by postal services.
AddressType (optional)
Department (optional)
String Identification of a division of a large organisation or building.
SubDepartment (optional)
String Identification of a sub-division of a large organisation or building.
StreetName (optional)
String Name of a street or thoroughfare.
BuildingNumber (optional)
String Number that identifies the position of a building on a street.
PostCode (optional)
String Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
TownName (optional)
String Name of a built-up area, with defined boundaries, and a local government.
CountrySubDivision (optional)
String Identifies a subdivision of a country such as state, region, county.
Country (optional)
String Nation with its own government.
AddressLine (optional)

OBPostalAddressLine - Up

Information that locates and identifies a specific address, as defined postal services, presented in free format text.

OBPriority2Code - Up

Indicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction.

OBRemittanceInformation1 - Up

Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system.
Unstructured (optional)
String Information supplied to enable the 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.
Reference (optional)
String Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. Usage: 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. OB: The Faster Payments Scheme can only accept 18 characters for the ReferenceInformation field - which is where this ISO field will be mapped.

OBRisk1 - Up

The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments.
PaymentContextCode (optional)
MerchantCategoryCode (optional)
String Category code conform to ISO 18245, related to the type of services or goods the merchant provides for the transaction.
MerchantCustomerIdentification (optional)
String The unique customer identifier of the PSU with the merchant.
DeliveryAddress (optional)

OBSupplementaryData1 - Up

Additional information that can not be captured in the structured fields and/or any other specific block.

OBTransactionIndividualStatus1Code - Up

Specifies the status of the payment information group.

OBWriteDataDomestic2 - Up

ConsentId
String OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.
Initiation

OBWriteDataDomesticConsent2 - Up

Initiation
Authorisation (optional)

OBWriteDataDomesticConsentResponse2 - Up

ConsentId
String OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.
CreationDateTime
Date Date and time at which the resource was created. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 format: date-time
Status
StatusUpdateDateTime
Date Date and time at which the resource status was updated. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 format: date-time
CutOffDateTime (optional)
Date Specified cut-off date and time for the payment consent. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 format: date-time
ExpectedExecutionDateTime (optional)
Date Expected execution date and time for the payment resource. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 format: date-time
ExpectedSettlementDateTime (optional)
Date Expected settlement date and time for the payment resource. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 format: date-time
Charges (optional)
array[OBCharge2] Set of elements used to provide details of a charge for the payment initiation.
Initiation
Authorisation (optional)

OBWriteDataDomesticResponse2 - Up

DomesticPaymentId
String OB: Unique identification as assigned by the ASPSP to uniquely identify the domestic payment resource.
ConsentId
String OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.
CreationDateTime
Date Date and time at which the message was created. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 format: date-time
Status
StatusUpdateDateTime
Date Date and time at which the resource status was updated. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 format: date-time
ExpectedExecutionDateTime (optional)
Date Expected execution date and time for the payment resource. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 format: date-time
ExpectedSettlementDateTime (optional)
Date Expected settlement date and time for the payment resource. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 format: date-time
Charges (optional)
array[OBCharge2] Set of elements used to provide details of a charge for the payment initiation.
Initiation
MultiAuthorisation (optional)

OBWriteDataDomesticScheduled2 - Up

ConsentId
String OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.
Initiation

OBWriteDataDomesticScheduledConsent2 - Up

Permission
Initiation
Authorisation (optional)

OBWriteDataDomesticScheduledConsentResponse2 - Up

ConsentId
String OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.
CreationDateTime
Date Date and time at which the resource was created. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 format: date-time
Status
StatusUpdateDateTime
Date Date and time at which the consent resource status was updated. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 format: date-time
Permission
CutOffDateTime (optional)
Date Specified cut-off date and time for the payment consent. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 format: date-time
ExpectedExecutionDateTime (optional)
Date Expected execution date and time for the payment resource. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 format: date-time
ExpectedSettlementDateTime (optional)
Date Expected settlement date and time for the payment resource. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 format: date-time
Charges (optional)
array[OBCharge2] Set of elements used to provide details of a charge for the payment initiation.
Initiation
Authorisation (optional)

OBWriteDataDomesticScheduledResponse2 - Up

DomesticScheduledPaymentId
String OB: Unique identification as assigned by the ASPSP to uniquely identify the domestic schedule payment resource.
ConsentId
String OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.
CreationDateTime
Date Date and time at which the message was created. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 format: date-time
Status
StatusUpdateDateTime
Date Date and time at which the resource status was updated. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 format: date-time
ExpectedExecutionDateTime (optional)
Date Expected execution date and time for the payment resource. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 format: date-time
ExpectedSettlementDateTime (optional)
Date Expected settlement date and time for the payment resource. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 format: date-time
Charges (optional)
array[OBCharge2] Set of elements used to provide details of a charge for the payment initiation.
Initiation
MultiAuthorisation (optional)

OBWriteDataDomesticStandingOrder2 - Up

ConsentId
String OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.
Initiation

OBWriteDataDomesticStandingOrderConsent2 - Up

Permission
Initiation
Authorisation (optional)

OBWriteDataDomesticStandingOrderConsentResponse2 - Up

ConsentId
String OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.
CreationDateTime
Date Date and time at which the resource was created. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 format: date-time
Status
StatusUpdateDateTime
Date Date and time at which the resource status was updated. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 format: date-time
Permission
CutOffDateTime (optional)
Date Specified cut-off date and time for the payment consent. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 format: date-time
Charges (optional)
array[OBCharge2] Set of elements used to provide details of a charge for the payment initiation.
Initiation
Authorisation (optional)

OBWriteDataDomesticStandingOrderResponse2 - Up

DomesticStandingOrderId
String OB: Unique identification as assigned by the ASPSP to uniquely identify the domestic standing order resource.
ConsentId
String OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.
CreationDateTime
Date Date and time at which the resource was created. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 format: date-time
Status
StatusUpdateDateTime
Date Date and time at which the resource status was updated. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 format: date-time
Charges (optional)
array[OBCharge2] Set of elements used to provide details of a charge for the payment initiation.
Initiation
MultiAuthorisation (optional)

OBWriteDataFile2 - Up

ConsentId
String OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.
Initiation

OBWriteDataFileConsent2 - Up

Initiation
Authorisation (optional)

OBWriteDataFileConsentResponse2 - Up

ConsentId
String OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.
CreationDateTime
Date Date and time at which the resource was created. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 format: date-time
Status
StatusUpdateDateTime
Date Date and time at which the consent resource status was updated. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 format: date-time
CutOffDateTime (optional)
Date Specified cut-off date and time for the payment consent. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 format: date-time
Charges (optional)
array[OBCharge2] Set of elements used to provide details of a charge for the payment initiation.
Initiation
Authorisation (optional)

OBWriteDataFileResponse2 - Up

FilePaymentId
String OB: Unique identification as assigned by the ASPSP to uniquely identify the file payment resource.
ConsentId
String OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.
CreationDateTime
Date Date and time at which the message was created. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 format: date-time
Status
StatusUpdateDateTime
Date Date and time at which the resource status was updated. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 format: date-time
Charges (optional)
array[OBCharge2] Set of elements used to provide details of a charge for the payment initiation.
Initiation
MultiAuthorisation (optional)

OBWriteDataFundsConfirmationResponse1 - Up

FundsAvailableResult (optional)
SupplementaryData (optional)

OBWriteDataInternational2 - Up

ConsentId
String OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.
Initiation

OBWriteDataInternationalConsent2 - Up

Initiation
Authorisation (optional)

OBWriteDataInternationalConsentResponse2 - Up

ConsentId
String OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.
CreationDateTime
Date Date and time at which the resource was created. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 format: date-time
Status
StatusUpdateDateTime
Date Date and time at which the resource status was updated. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 format: date-time
CutOffDateTime (optional)
Date Specified cut-off date and time for the payment consent. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 format: date-time
ExpectedExecutionDateTime (optional)
Date Expected execution date and time for the payment resource. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 format: date-time
ExpectedSettlementDateTime (optional)
Date Expected settlement date and time for the payment resource. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 format: date-time
Charges (optional)
array[OBCharge2] Set of elements used to provide details of a charge for the payment initiation.
ExchangeRateInformation (optional)
Initiation
Authorisation (optional)

OBWriteDataInternationalResponse2 - Up

InternationalPaymentId
String OB: Unique identification as assigned by the ASPSP to uniquely identify the international payment resource.
ConsentId
String OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.
CreationDateTime
Date Date and time at which the message was created. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 format: date-time
Status
StatusUpdateDateTime
Date Date and time at which the resource status was updated. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 format: date-time
ExpectedExecutionDateTime (optional)
Date Expected execution date and time for the payment resource. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 format: date-time
ExpectedSettlementDateTime (optional)
Date Expected settlement date and time for the payment resource. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 format: date-time
Charges (optional)
array[OBCharge2] Set of elements used to provide details of a charge for the payment initiation.
ExchangeRateInformation (optional)
Initiation
MultiAuthorisation (optional)

OBWriteDataInternationalScheduled2 - Up

ConsentId
String OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.
Initiation

OBWriteDataInternationalScheduledConsent2 - Up

Permission
Initiation
Authorisation (optional)

OBWriteDataInternationalScheduledConsentResponse2 - Up

ConsentId
String OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.
CreationDateTime
Date Date and time at which the resource was created. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 format: date-time
Status
StatusUpdateDateTime
Date Date and time at which the resource status was updated. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 format: date-time
Permission
CutOffDateTime (optional)
Date Specified cut-off date and time for the payment consent. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 format: date-time
ExpectedExecutionDateTime (optional)
Date Expected execution date and time for the payment resource. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 format: date-time
ExpectedSettlementDateTime (optional)
Date Expected settlement date and time for the payment resource. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 format: date-time
Charges (optional)
array[OBCharge2] Set of elements used to provide details of a charge for the payment initiation.
ExchangeRateInformation (optional)
Initiation
Authorisation (optional)

OBWriteDataInternationalScheduledResponse2 - Up

InternationalScheduledPaymentId
String OB: Unique identification as assigned by the ASPSP to uniquely identify the international scheduled payment resource.
ConsentId
String OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.
CreationDateTime
Date Date and time at which the message was created. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 format: date-time
Status
StatusUpdateDateTime
Date Date and time at which the resource status was updated. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 format: date-time
ExpectedExecutionDateTime (optional)
Date Expected execution date and time for the payment resource. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 format: date-time
ExpectedSettlementDateTime (optional)
Date Expected settlement date and time for the payment resource. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 format: date-time
Charges (optional)
array[OBCharge2] Set of elements used to provide details of a charge for the payment initiation.
ExchangeRateInformation (optional)
Initiation
MultiAuthorisation (optional)

OBWriteDataInternationalStandingOrder2 - Up

ConsentId
String OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.
Initiation

OBWriteDataInternationalStandingOrderConsent2 - Up

Permission
Initiation
Authorisation (optional)

OBWriteDataInternationalStandingOrderConsentResponse2 - Up

ConsentId
String OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.
CreationDateTime
Date Date and time at which the resource was created. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 format: date-time
Status
StatusUpdateDateTime
Date Date and time at which the resource status was updated. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 format: date-time
Permission
CutOffDateTime (optional)
Date Specified cut-off date and time for the payment consent. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 format: date-time
Charges (optional)
array[OBCharge2] Set of elements used to provide details of a charge for the payment initiation.
Initiation
Authorisation (optional)

OBWriteDataInternationalStandingOrderResponse2 - Up

InternationalStandingOrderId
String OB: Unique identification as assigned by the ASPSP to uniquely identify the international standing order resource.
ConsentId
String OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.
CreationDateTime
Date Date and time at which the resource was created. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 format: date-time
Status
StatusUpdateDateTime
Date Date and time at which the resource status was updated. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 format: date-time
Charges (optional)
array[OBCharge2] Set of elements used to provide details of a charge for the payment initiation.
Initiation
MultiAuthorisation (optional)

OBWriteDomestic2 - Up

Data
Risk

OBWriteDomesticConsent2 - Up

Data
Risk

OBWriteDomesticConsentResponse2 - Up

Data
Risk
Links
Meta

OBWriteDomesticResponse2 - Up

Data
Links
Meta

OBWriteDomesticScheduled2 - Up

Data
Risk

OBWriteDomesticScheduledConsent2 - Up

Data
Risk

OBWriteDomesticScheduledConsentResponse2 - Up

Data
Risk
Links
Meta

OBWriteDomesticScheduledResponse2 - Up

Data
Links
Meta

OBWriteDomesticStandingOrder2 - Up

Data
Risk

OBWriteDomesticStandingOrderConsent2 - Up

Data
Risk

OBWriteDomesticStandingOrderConsentResponse2 - Up

Data
Risk
Links
Meta

OBWriteDomesticStandingOrderResponse2 - Up

Data
Links
Meta

OBWriteFile2 - Up

Data

OBWriteFileConsent2 - Up

Data

OBWriteFileConsentResponse2 - Up

Data
Links
Meta

OBWriteFileResponse2 - Up

Data
Links
Meta

OBWriteFundsConfirmationResponse1 - Up

Data
Links
Meta

OBWriteInternational2 - Up

Data
Risk

OBWriteInternationalConsent2 - Up

Data
Risk

OBWriteInternationalConsentResponse2 - Up

Data
Risk
Links
Meta

OBWriteInternationalResponse2 - Up

Data
Links
Meta

OBWriteInternationalScheduled2 - Up

Data
Risk

OBWriteInternationalScheduledConsent2 - Up

Data
Risk

OBWriteInternationalScheduledConsentResponse2 - Up

Data
Risk
Links
Meta

OBWriteInternationalScheduledResponse2 - Up

Data
Links
Meta

OBWriteInternationalStandingOrder2 - Up

Data
Risk

OBWriteInternationalStandingOrderConsent2 - Up

Data
Risk

OBWriteInternationalStandingOrderConsentResponse2 - Up

Data
Risk
Links
Meta

OBWriteInternationalStandingOrderResponse2 - Up

Data
Links
Meta