Sign in

v1

latestOpenAPI 3.0.32026-07-248079274.0 KB
Pay by Bank

Single immediate payment

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

post/single-immediate-payment

Headers

Company-Idstring uuid

Unique identifier assigned by Acquired.com for your account.

Midstring uuid

Unique identifier assigned by Acquired.com allowing you to specify which bank account funds should be settled.

Request body

redirect_urlstring uri

Where we should send the user back to once the payment has been completed.

webhook_urlstring uri

Where we should send webhook notifications throughout the authorisation process.

Example request

{
  "transaction": {
    "order_id": "1f1f2a61-5b68-4725-a0ce-9560514ec00b",
    "amount": 15.02,
    "currency": "GBP"
  },
  "payment": {
    "single_immediate_payment": {
      "reference": "Custom Ref 001"
    },
    "debtor": {
      "name": "Edward Johnson",
      "sort_code": "123456",
      "account_number": "87654321"
    }
  },
  "customer": {
    "reference": "customer_number_00001",
    "first_name": "Edward",
    "last_name": "Johnson",
    "dob": "1988-10-03",
    "custom_data": "L3BheW1lbnQtbGlua3MgcGF5IGN1c3RvbV9kYXRh",
    "billing": {
      "address": {
        "line_1": "152 Aldgate Drive",
        "city": "London",
        "postcode": "E1 7RT",
        "country_code": "GB"
      },
      "email": "ejohnson@acquired.com",
      "phone": {
        "country_code": "44",
        "number": "2039826580"
      }
    },
    "shipping": {
      "address": {
        "line_1": "152 Aldgate Drive",
        "city": "London",
        "postcode": "E1 7RT",
        "country_code": "GB"
      },
      "email": "ejohnson@acquired.com",
      "phone": {
        "country_code": "44",
        "number": "2039826580"
      }
    }
  },
  "redirect_url": "https://example.com/redirect",
  "webhook_url": "https://example.com/webhook"
}

Response

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

transaction_idstring uuid
status'awaiting_authorisation'
auth_type'redirect'

The payment flow that should be used to authenticate the user.

urlstring uri

URL the user should be redirected to in order to authenticate themselves with the ASPSP.

qr_codestring

QR Code which can be displayed to the user in order to faciliate a decoupled flow on desktop.

expires_ininteger

Time in seconds until the url value expires.

Example response

{
  "expires_in": 600
}