STstarlingbank
Payments

Get a payment order

Changed on
get/api/v2/payments/local/payment-order/{paymentOrderUid}

Request

Path parameters

paymentOrderUidstring uuid required
Example:aaaaaaaa-aaaa-4aaa-aaaa-aaaaaaaaaaaa

Payment order uid

Response

Successful operation

paymentOrderUidstring uuid required

UID of this payment order

referencestring required

The reference set by the payer

payeeUidstring uuid required

The ID of the payee receiving this payment

payeeAccountUidstring uuid required

The account ID of the payee account receiving this payment

spendingCategory'BIKE' | 'BILLS_AND_SERVICES' | 'BUCKET_LIST' | 'CAR' | 'CASH' | 'CELEBRATION' | 'CHARITY' | 'CHILDREN' | 'CLOTHES' | 'COFFEE' | 'DEBT_REPAYMENT' | 'DIY' | 'DRINKS' | 'EATING_OUT' | 'EDUCATION' | 'EMERGENCY' | 'ENTERTAINMENT' | 'ESSENTIAL_SPEND' | 'EXPENSES' | 'FAMILY' | 'FITNESS' | 'FUEL' | 'GAMBLING' | 'GAMING' | 'GARDEN' | 'GENERAL' | 'GIFTS' | 'GROCERIES' | 'HOBBY' | 'HOLIDAYS' | 'HOME' | 'IMPULSE_BUY' | 'INCOME' | 'INSURANCE' | 'INVESTMENTS' | 'LIFESTYLE' | 'MAINTENANCE_AND_REPAIRS' | 'MEDICAL' | 'MORTGAGE' | 'NON_ESSENTIAL_SPEND' | 'PAYMENTS' | 'PERSONAL_CARE' | 'PERSONAL_TRANSFERS' | 'PETS' | 'PROJECTS' | 'RELATIONSHIPS' | 'RENT' | 'SAVING' | 'SHOPPING' | 'SUBSCRIPTIONS' | 'TAKEAWAY' | 'TAXI' | 'TRANSPORT' | 'TREATS' | 'WEDDING' | 'WELLBEING' | 'NONE' | 'REVENUE' | 'OTHER_INCOME' | 'CLIENT_REFUNDS' | 'INVENTORY' | 'STAFF' | 'TRAVEL' | 'WORKPLACE' | 'REPAIRS_AND_MAINTENANCE' | 'ADMIN' | 'MARKETING' | 'BUSINESS_ENTERTAINMENT' | 'INTEREST_PAYMENTS' | 'BANK_CHARGES' | 'OTHER' | 'FOOD_AND_DRINK' | 'EQUIPMENT' | 'PROFESSIONAL_SERVICES' | 'PHONE_AND_INTERNET' | 'VEHICLES' | 'DIRECTORS_WAGES' | 'VAT' | 'CORPORATION_TAX' | 'SELF_ASSESSMENT_TAX' | 'INVESTMENT_CAPITAL' | 'TRANSFERS' | 'LOAN_PRINCIPAL' | 'PERSONAL' | 'DIVIDENDS' | 'MONEY_OWED_FROM_CLIENTS' | 'CONSULTANCY_FEES' | 'OFFICE_AND_POSTAGE_COSTS' | 'TRAINING' | 'EMPLOYEE_BENEFITS' | 'ACCOUNTANCY_FEES' | 'IMPORT_VAT' | 'CATEGORISE_LATER' | 'SOFTWARE_AND_SUBSCRIPTIONS' | 'EXCHANGE_RATE_CHANGES' | 'EMPLOYEE_PENSIONS' | 'STAFF_TAXES' | 'SOFTWARE' | 'EQUIPMENT_HIRE' | 'CAPITAL_INTRODUCED' | 'DONATIONS' | 'PENSION_CONTRIBUTIONS' | 'PERSONAL_WITHDRAWALS' | 'CREDIT_CARD_REPAYMENTS' | 'TAX_POT_SAVINGS' | 'GRANTS' | 'REIMBURSED_EXPENSES' | 'VEHICLE_PURCHASES' | 'RENTAL_INCOME' | 'RENTAL_SERVICES' | 'RESIDENTIAL_PROPERTY_FINANCE_COSTS' | 'NON_RESIDENTIAL_PROPERTY_FINANCE_COSTS' | 'AGENT_MANAGEMENT_AND_LEGAL_FEES' | 'RENT_PAID_BY_YOU' | 'COUNCIL_TAX_PAID_BY_YOU' | 'OTHER_RATES_PAID_BY_YOU' | 'UTILITIES_PAID_BY_YOU' | 'RENTAL_INSURANCE' | 'REPLACING_DAMAGED_FURNISHINGS_AND_APPLIANCES' | 'GARDENING_CLEANING_AND_OTHER_SERVICES' | 'ADVERTISING' | 'MILEAGE_AND_OTHER_TRAVEL_COSTS' | 'OTHER_ALLOWABLE_COSTS' | 'MORTGAGE_CAPITAL_REPAYMENTS' | 'PROPERTY_UPGRADES' | 'RENTAL_REPAIRS_AND_MAINTENANCE' | 'DISPOSAL_OF_ASSETS' | 'COST_OF_SALES' | 'EMPLOYEE_AND_EMPLOYER_PENSIONS' | 'PAYE_AND_NI' | 'PENALTIES_AND_FINES' | 'COMPUTER_HARDWARE' | 'BUILDINGS' | 'FURNITURE_AND_EQUIPMENT' | 'INTANGIBLE_ASSETS' | 'MONEY_OWED_TO_THE_BUSINESS' | 'STOCK' | 'MONEY_OWED_TO_SUPPLIERS' | 'OWED_TO_PAYE_AND_NI' | 'CORPORATION_TAX_OWED' | 'DIRECTORS_LOAN' | 'MONEY_OWED_TO_OTHERS' | 'PENSION_CONTRIBUTIONS_OWED' | 'MONEY_OWED_TO_EMPLOYEES' | 'VEHICLE_AND_FUEL_COSTS' | 'INTEREST_GAINED' | 'UTILITIES' | 'EMPLOYEE_ENTERTAINING' | 'PLATFORM_FEES' | 'SHARE_CAPITAL_OUTSTANDING' | 'CAPITALISED_COSTS' | 'CHARITABLE_DONATIONS' | 'SHARE_PREMIUM' | 'MULTIPLE' nullable

The category of a transaction

Example response

{
  "paymentOrderUid": "33443344-3344-3344-3344-334433443344",
  "amount": {
    "currency": "GBP",
    "minorUnits": 123456
  },
  "reference": "Payment reference",
  "payeeUid": "55665566-5566-5566-5566-556655665566",
  "payeeAccountUid": "66776677-6677-6677-6677-667766776677"
}

Changes

  • 10e2d804aaabRevision changes
    • warning

      added the new ACCOUNTANCY_FEES enum value to the response property for the response status

    • warning

      added the new ADVERTISING enum value to the response property for the response status

    • warning

      added the new AGENT_MANAGEMENT_AND_LEGAL_FEES enum value to the response property for the response status

    • warning

      added the new BUILDINGS enum value to the response property for the response status

    • warning

      added the new CAPITALISED_COSTS enum value to the response property for the response status

    • warning

      added the new CAPITAL_INTRODUCED enum value to the response property for the response status

    • warning

      added the new CATEGORISE_LATER enum value to the response property for the response status

    • warning

      added the new CHARITABLE_DONATIONS enum value to the response property for the response status

    • warning

      added the new COMPUTER_HARDWARE enum value to the response property for the response status

    • warning

      added the new CONSULTANCY_FEES enum value to the response property for the response status

    • warning

      added the new CORPORATION_TAX_OWED enum value to the response property for the response status

    • warning

      added the new COST_OF_SALES enum value to the response property for the response status

    • warning

      added the new COUNCIL_TAX_PAID_BY_YOU enum value to the response property for the response status

    • warning

      added the new CREDIT_CARD_REPAYMENTS enum value to the response property for the response status

    • warning

      added the new DIRECTORS_LOAN enum value to the response property for the response status

    • warning

      added the new DISPOSAL_OF_ASSETS enum value to the response property for the response status

    • warning

      added the new DONATIONS enum value to the response property for the response status

    • warning

      added the new EMPLOYEE_AND_EMPLOYER_PENSIONS enum value to the response property for the response status

    • warning

      added the new EMPLOYEE_BENEFITS enum value to the response property for the response status

    • warning

      added the new EMPLOYEE_ENTERTAINING enum value to the response property for the response status

    • warning

      added the new EMPLOYEE_PENSIONS enum value to the response property for the response status

    • warning

      added the new EQUIPMENT_HIRE enum value to the response property for the response status

    • warning

      added the new EXCHANGE_RATE_CHANGES enum value to the response property for the response status

    • warning

      added the new FURNITURE_AND_EQUIPMENT enum value to the response property for the response status

    • warning

      added the new GARDENING_CLEANING_AND_OTHER_SERVICES enum value to the response property for the response status

    • warning

      added the new GRANTS enum value to the response property for the response status

    • warning

      added the new IMPORT_VAT enum value to the response property for the response status

    • warning

      added the new INTANGIBLE_ASSETS enum value to the response property for the response status

    • warning

      added the new INTEREST_GAINED enum value to the response property for the response status

    • warning

      added the new MILEAGE_AND_OTHER_TRAVEL_COSTS enum value to the response property for the response status

    • warning

      added the new MONEY_OWED_FROM_CLIENTS enum value to the response property for the response status

    • warning

      added the new MONEY_OWED_TO_EMPLOYEES enum value to the response property for the response status

    • warning

      added the new MONEY_OWED_TO_OTHERS enum value to the response property for the response status

    • warning

      added the new MONEY_OWED_TO_SUPPLIERS enum value to the response property for the response status

    • warning

      added the new MONEY_OWED_TO_THE_BUSINESS enum value to the response property for the response status

    • warning

      added the new MORTGAGE_CAPITAL_REPAYMENTS enum value to the response property for the response status

    • warning

      added the new MULTIPLE enum value to the response property for the response status

    • warning

      added the new NON_RESIDENTIAL_PROPERTY_FINANCE_COSTS enum value to the response property for the response status

    • warning

      added the new OFFICE_AND_POSTAGE_COSTS enum value to the response property for the response status

    • warning

      added the new OTHER_ALLOWABLE_COSTS enum value to the response property for the response status

    • warning

      added the new OTHER_RATES_PAID_BY_YOU enum value to the response property for the response status

    • warning

      added the new OWED_TO_PAYE_AND_NI enum value to the response property for the response status

    • warning

      added the new PAYE_AND_NI enum value to the response property for the response status

    • warning

      added the new PENALTIES_AND_FINES enum value to the response property for the response status

    • warning

      added the new PENSION_CONTRIBUTIONS enum value to the response property for the response status

    • warning

      added the new PENSION_CONTRIBUTIONS_OWED enum value to the response property for the response status

    • warning

      added the new PERSONAL_WITHDRAWALS enum value to the response property for the response status

    • warning

      added the new PLATFORM_FEES enum value to the response property for the response status

    • warning

      added the new PROPERTY_UPGRADES enum value to the response property for the response status

    • warning

      added the new REIMBURSED_EXPENSES enum value to the response property for the response status

    • warning

      added the new RENTAL_INCOME enum value to the response property for the response status

    • warning

      added the new RENTAL_INSURANCE enum value to the response property for the response status

    • warning

      added the new RENTAL_REPAIRS_AND_MAINTENANCE enum value to the response property for the response status

    • warning

      added the new RENTAL_SERVICES enum value to the response property for the response status

    • warning

      added the new RENT_PAID_BY_YOU enum value to the response property for the response status

    • warning

      added the new REPLACING_DAMAGED_FURNISHINGS_AND_APPLIANCES enum value to the response property for the response status

    • warning

      added the new RESIDENTIAL_PROPERTY_FINANCE_COSTS enum value to the response property for the response status

    • warning

      added the new SHARE_CAPITAL_OUTSTANDING enum value to the response property for the response status

    • warning

      added the new SHARE_PREMIUM enum value to the response property for the response status

    • warning

      added the new SOFTWARE enum value to the response property for the response status

    • warning

      added the new SOFTWARE_AND_SUBSCRIPTIONS enum value to the response property for the response status

    • warning

      added the new STAFF_TAXES enum value to the response property for the response status

    • warning

      added the new STOCK enum value to the response property for the response status

    • warning

      added the new TAX_POT_SAVINGS enum value to the response property for the response status

    • warning

      added the new TRAINING enum value to the response property for the response status

    • warning

      added the new UTILITIES enum value to the response property for the response status

    • warning

      added the new UTILITIES_PAID_BY_YOU enum value to the response property for the response status

    • warning

      added the new VEHICLE_AND_FUEL_COSTS enum value to the response property for the response status

    • warning

      added the new VEHICLE_PURCHASES enum value to the response property for the response status