Sign in

v1

latestOpenAPI 3.0.32026-07-248079274.0 KB
Payments

Process a payment

Submit a payment request into the API and receive a response. If you want to create a card for future use, submit the full card details within the card object and set the create_card parameter to true (if not, set the create_card parameter to false).

post/payments

Headers

Company-Idstring uuid

Unique ID assigned by Acquired.com for your company.

Midstring uuid

Unique ID assigned by Acquired.com connecting to a specific acquiring bank.

Request body

Example request

{
  "transaction": {
    "order_id": "1f1f2a61-5b68-4725-a0ce-9560514ec00b",
    "amount": 15.02,
    "currency": "gbp",
    "custom_data": "L3BheW1lbnQtbGlua3MgcGF5IGN1c3RvbV9kYXRh"
  },
  "payment": {
    "card": {
      "holder_name": "E Johnson",
      "number": "4000011180138710",
      "expiry_month": 10,
      "expiry_year": 30,
      "cvv": "123"
    },
    "reference": "Custom Ref 001"
  },
  "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"
      }
    }
  },
  "tds": {
    "challenge_preference": "no_preference",
    "challenge_window_size": "full_screen",
    "contact_url": "https://example.com/contact",
    "redirect_url": "https://example.com/redirect",
    "webhook_url": "https://example.com/webhook"
  }
}

Response

Created

transaction_idstring uuid

Unique identifier assigned by Acquired.com for the transaction.

status'blocked' | 'declined' | 'tds_error' | 'tds_expired' | 'tds_failed' | 'success'
reason'6012_data' | 'above_max_amount' | 'above_max_refund_amount' | 'above_max_transactions' | 'acs_technical_issue' | 'bad_gateway' | 'below_min_amount' | 'below_min_refund_amount' | 'bin_bank' | 'bin_country' | 'bin_level' | 'bin_product' | 'bin_scheme' | 'blocklist_bin' | 'blocklist_card' | 'blocklist_email' | 'blocklist_ip' | 'blocklist_phone' | 'card_authentication_failed' | 'card_not_active' | 'cardholder_cancellation' | 'cardholder_cancelled' | 'challenge_failed' | 'challenge_limit_exceeded' | 'challenge_not_completed' | 'challenge_time_out' | 'closed_account' | 'exceeds_authentication_frequency_limit' | 'exceeds_max_amount' | 'exceeds_max_refund_amount' | 'exceeds_max_transactions' | 'expired_card' | 'fraud_scoring' | 'fraud_scoring_error' | 'generic_decline' | 'insufficient_funds' | 'invalid_avs' | 'invalid_card_number' | 'invalid_cvv' | 'invalid_pin' | 'invalid_transaction' | 'low_confidence' | 'lost_or_stolen' | 'max_amount_day' | 'max_amount_month' | 'max_card_attempts' | 'max_card_success' | 'max_daily_refunds_amount' | 'max_daily_refunds_count' | 'max_email_day' | 'max_email_month' | 'max_ip_day' | 'max_ip_month' | 'max_monthly_refunds_amount' | 'max_monthly_refunds_count' | 'max_phone_day' | 'max_phone_month' | 'max_post_day' | 'max_post_month' | 'max_refunds_count' | 'medium_confidence' | 'no_card_record' | 'restricted_card' | 'scheme_status_reason' | 'security_failure' | 'suspected_fraud' | 'transaction_disputed' | 'transaction_fraud' | 'transaction_not_permitted_to_cardholder'
issuer_response_code'00' | '01' | '02' | '03' | '04' | '05' | '06' | '07' | '08' | '09' | '10' | '11' | '12' | '13' | '14' | '15' | '16' | '17' | '18' | '19' | '20' | '21' | '22' | '23' | '24' | '25' | '26' | '27' | '28' | '29' | '30' | '31' | '32' | '33' | '34' | '35' | '36' | '37' | '38' | '39' | '40' | '41' | '42' | '43' | '44' | '51' | '52' | '53' | '54' | '55' | '56' | '57' | '59' | '60' | '61' | '62' | '63' | '64' | '65' | '66' | '67' | '68' | '75' | '76' | '77' | '80' | '81' | '82' | '83' | '84' | '85' | '86' | '87' | '88' | '89' | '90' | '91' | '92' | '93' | '94' | '95' | '96' | '97' | '98' | '99' | 'N0' | 'N3' | 'N4' | 'N7' | 'P5' | 'P6' | 'XA' | 'XD'
card_idstring uuid

Unique identifier assigned by us for the card.

Example response

{
  "transaction_id": "a7e3fde5-5b83-44f4-9915-782bc7121717",
  "status": "success",
  "issuer_response_code": "00",
  "retry_advice": {
    "category": "retry_later",
    "detail": null,
    "retry_after": "2026-03-04T00:00:00Z",
    "acquirer_code": "25"
  },
  "card_id": "a84fb738-0886-42ca-8711-3d6c0f586b08",
  "links": [
    {
      "rel": "self",
      "href": "/v1/transactions/a7e3fde5-5b83-44f4-9915-782bc7121717"
    }
  ]
}