---
title: "Single immediate payment"
method: POST
path: "/single-immediate-payment"
tags: ["Pay by Bank"]
---

# Single immediate payment

`POST /single-immediate-payment`

Request consent from the ASPSP and generate a URL for the user to authenticate themselves.

## Headers

- `Company-Id` string, uuid
- `Mid` string, uuid

## Request body

- object
  - `transaction` object
    - `order_id` string, required — Unique reference assigned by you for the payment request.
    - `amount` number, float, required — The total amount that you want to charge.
    - `currency` 'gbp', required — ISO 4217 currency code in lower case.
  - `payment` object
    - `single_immediate_payment` object
      - `aspsp_id` 'santander' | 'bank_of_scotland' | 'first_direct' | 'halifax' | 'hsbc' | 'lloyds' | 'monzo' | 'nationwide' | 'natwest' | 'starling_bank' | 'revolut' | 'rbs' | 'tsb' — The unique identifier assigned by Acquired.com of the bank which the user wants to pay with.
      - `context` 'bill_payment' | 'ecommerce_goods' | 'ecommerce_services' | 'other' | 'party_to_party' — Detail on the type of service you are offering to the user.
      - `reference` string — The reference shown on the account holder's statement. Avoid consecutive special characters (e.g. --) which may result in rejection.
    - `debtor` object
      - `format` 'sort_code_account_number' — Defines required debtor account identification requirements.
      - `name` string — The name of the account holder.
      - `sort_code` string — Sort code of the account.
      - `account_number` string — The account number.
  - `customer` CustomerRequest
    - `customer_id` string, uuid — Unique ID assigned by Acquired.com to the customer when it is created.
    - `reference` string — Unique reference assigned by you for the customer when it is created.
    - `first_name` string — The customer's first name.
    - `last_name` string — The customer's last name. **Required for MCC 6012 merchants.**
    - `dob` string, date — The customer's date of birth. **Required for MCC 6012 merchants.**
    - `custom_data` string — Base64 encoded string detailing custom data passed in the request.
    - `billing` object
      - `address` Address
        - `line_1` string — The first line of the customer's address. **Recommended when processing EMV 3DS transactions and for AVS checks.**
        - `line_2` string — The second line of the customer's address.
        - `city` string — The city of the customer's address.
        - `state` string — The 3 letter ISO 3166-2 3-character state code of the customer's address. This should only be sent when processing in the US.
        - `postcode` string — The postcode of the customer's address. **Recommended for MCC 6012 merchants. Required when processing EMV 3DS transactions and for AVS checks.**
        - `country_code` 'al' | 'al' | 'dz' | 'as' | 'ad' | 'ao' | 'ai' | 'aq' | 'ag' | 'ar' | 'am' | 'aw' | 'au' | 'at' | 'az' | 'bs' | 'bh' | 'bd' | 'bb' | 'by' | 'be' | 'bz' | 'bj' | 'bm' | 'bt' | 'bo' | 'ba' | 'bw' | 'br' | 'io' | 'bn' | 'bg' | 'bf' | 'bi' | 'cv' | 'kh' | 'cm' | 'ca' | 'ky' | 'cf' | 'td' | 'cl' | 'cn' | 'co' | 'km' | 'cg' | 'cd' | 'cr' | 'hr' | 'cu' | 'cy' | 'cz' | 'dk' | 'dj' | 'dm' | 'do' | 'ec' | 'eg' | 'sv' | 'gq' | 'er' | 'ee' | 'sz' | 'et' | 'fk' | 'fo' | 'fj' | 'fi' | 'fr' | 'gf' | 'pf' | 'ga' | 'gm' | 'ge' | 'de' | 'gh' | 'gi' | 'gr' | 'gl' | 'gd' | 'gu' | 'gt' | 'gg' | 'gn' | 'gw' | 'gy' | 'ht' | 'hn' | 'hk' | 'hu' | 'is' | 'in' | 'id' | 'ir' | 'iq' | 'ie' | 'im' | 'il' | 'it' | 'jm' | 'jp' | 'je' | 'jo' | 'kz' | 'ke' | 'ki' | 'kp' | 'kr' | 'kw' | 'kg' | 'la' | 'lv' | 'lb' | 'ls' | 'lr' | 'ly' | 'li' | 'lt' | 'lu' | 'mo' | 'mk' | 'mg' | 'mw' | 'my' | 'mv' | 'ml' | 'mt' | 'mh' | 'mq' | 'mr' | 'mu' | 'yt' | 'mx' | 'fm' | 'md' | 'mc' | 'mn' | 'me' | 'ms' | 'ma' | 'mz' | 'mm' | 'na' | 'nr' | 'np' | 'nl' | 'nc' | 'nz' | 'ni' | 'ne' | 'ng' | 'nu' | 'nf' | 'mp' | 'no' | 'om' | 'pk' | 'pw' | 'ps' | 'pa' | 'pg' | 'py' | 'pe' | 'ph' | 'pl' | 'pt' | 'pr' | 'qa' | 'ro' | 'ru' | 'rw' | 're' | 'bl' | 'sh' | 'kn' | 'lc' | 'mf' | 'pm' | 'vc' | 'ws' | 'sm' | 'st' | 'sa' | 'sn' | 'rs' | 'sc' | 'sl' | 'sg' | 'sx' | 'sk' | 'si' | 'sb' | 'so' | 'za' | 'gs' | 'ss' | 'es' | 'lk' | 'sd' | 'sr' | 'se' | 'ch' | 'sx' | 'sy' | 'tw' | 'tj' | 'tz' | 'th' | 'tg' | 'tk' | 'to' | 'tt' | 'tn' | 'tr' | 'tm' | 'tc' | 'tv' | 'ug' | 'ua' | 'ae' | 'gb' | 'us' | 'uy' | 'uz' | 'vu' | 've' | 'vn' | 'vg' | 'vi' | 'wf' | 'eh' | 'ye' | 'zm' | 'zw' — The ISO 3166 2-character code of the customer's address. **Recommended when processing EMV 3DS transactions.**
      - `email` string, email — The customer's email address. **Recommended for processing EMV 3DS transactions.**
      - `phone` Phone
        - `country_code` string — The international dialling code of the customer's phone number.
        - `number` string — The customer's phone number.
    - `shipping` object
      - `address_match` boolean — Set to true if the customer's billing and shipping address are the same to auto populate.
      - `address` Address
        - `line_1` string — The first line of the customer's address. **Recommended when processing EMV 3DS transactions and for AVS checks.**
        - `line_2` string — The second line of the customer's address.
        - `city` string — The city of the customer's address.
        - `state` string — The 3 letter ISO 3166-2 3-character state code of the customer's address. This should only be sent when processing in the US.
        - `postcode` string — The postcode of the customer's address. **Recommended for MCC 6012 merchants. Required when processing EMV 3DS transactions and for AVS checks.**
        - `country_code` 'al' | 'al' | 'dz' | 'as' | 'ad' | 'ao' | 'ai' | 'aq' | 'ag' | 'ar' | 'am' | 'aw' | 'au' | 'at' | 'az' | 'bs' | 'bh' | 'bd' | 'bb' | 'by' | 'be' | 'bz' | 'bj' | 'bm' | 'bt' | 'bo' | 'ba' | 'bw' | 'br' | 'io' | 'bn' | 'bg' | 'bf' | 'bi' | 'cv' | 'kh' | 'cm' | 'ca' | 'ky' | 'cf' | 'td' | 'cl' | 'cn' | 'co' | 'km' | 'cg' | 'cd' | 'cr' | 'hr' | 'cu' | 'cy' | 'cz' | 'dk' | 'dj' | 'dm' | 'do' | 'ec' | 'eg' | 'sv' | 'gq' | 'er' | 'ee' | 'sz' | 'et' | 'fk' | 'fo' | 'fj' | 'fi' | 'fr' | 'gf' | 'pf' | 'ga' | 'gm' | 'ge' | 'de' | 'gh' | 'gi' | 'gr' | 'gl' | 'gd' | 'gu' | 'gt' | 'gg' | 'gn' | 'gw' | 'gy' | 'ht' | 'hn' | 'hk' | 'hu' | 'is' | 'in' | 'id' | 'ir' | 'iq' | 'ie' | 'im' | 'il' | 'it' | 'jm' | 'jp' | 'je' | 'jo' | 'kz' | 'ke' | 'ki' | 'kp' | 'kr' | 'kw' | 'kg' | 'la' | 'lv' | 'lb' | 'ls' | 'lr' | 'ly' | 'li' | 'lt' | 'lu' | 'mo' | 'mk' | 'mg' | 'mw' | 'my' | 'mv' | 'ml' | 'mt' | 'mh' | 'mq' | 'mr' | 'mu' | 'yt' | 'mx' | 'fm' | 'md' | 'mc' | 'mn' | 'me' | 'ms' | 'ma' | 'mz' | 'mm' | 'na' | 'nr' | 'np' | 'nl' | 'nc' | 'nz' | 'ni' | 'ne' | 'ng' | 'nu' | 'nf' | 'mp' | 'no' | 'om' | 'pk' | 'pw' | 'ps' | 'pa' | 'pg' | 'py' | 'pe' | 'ph' | 'pl' | 'pt' | 'pr' | 'qa' | 'ro' | 'ru' | 'rw' | 're' | 'bl' | 'sh' | 'kn' | 'lc' | 'mf' | 'pm' | 'vc' | 'ws' | 'sm' | 'st' | 'sa' | 'sn' | 'rs' | 'sc' | 'sl' | 'sg' | 'sx' | 'sk' | 'si' | 'sb' | 'so' | 'za' | 'gs' | 'ss' | 'es' | 'lk' | 'sd' | 'sr' | 'se' | 'ch' | 'sx' | 'sy' | 'tw' | 'tj' | 'tz' | 'th' | 'tg' | 'tk' | 'to' | 'tt' | 'tn' | 'tr' | 'tm' | 'tc' | 'tv' | 'ug' | 'ua' | 'ae' | 'gb' | 'us' | 'uy' | 'uz' | 'vu' | 've' | 'vn' | 'vg' | 'vi' | 'wf' | 'eh' | 'ye' | 'zm' | 'zw' — The ISO 3166 2-character code of the customer's address. **Recommended when processing EMV 3DS transactions.**
      - `email` string, email — The customer's email address.
      - `phone` Phone
        - `country_code` string — The international dialling code of the customer's phone number.
        - `number` string — The customer's phone number.
  - `redirect_url` string, uri — Where we should send the user back to once the payment has been completed.
  - `webhook_url` string, uri — Where we should send webhook notifications throughout the authorisation process.

## Response `201`

Consent was granted by the ASPSP and you should redirect the PSU to the url.

- object
  - `transaction_id` string, uuid
  - `status` 'awaiting_authorisation'
  - `auth_type` 'redirect' — The payment flow that should be used to authenticate the user.
  - `url` string, uri — URL the user should be redirected to in order to authenticate themselves with the ASPSP.
  - `qr_code` string — QR Code which can be displayed to the user in order to faciliate a decoupled flow on desktop.
  - `expires_in` integer — Time in seconds until the url value expires.

## Other responses

- `400` — An error occurred
- `401` — An error occurred
- `500` — Internal Server error

---

[API](https://skmtc.dev/acquired/apis/acquired-api.md) · [All operations](https://skmtc.dev/acquired/apis/acquired-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/acquired/acquired-api/revisions/7ae178a046f2/schema)