v1

latestOpenAPI 3.0.32026-07-248079274.0 KB

Direct Debit

Create a collection

Create a Direct Debit collection against a mandate_id to collect payments from the customer's bank account.

post/payments/collections

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",
    "custom1": "4f0a0e0d-a407-46d8-841a-3409831d69a3",
    "custom2": "eb031f5b-9c34-4101-8dea-269ca88fcadb"
  },
  "payment": {
    "mandate_id": "18456786-5d7a-44a6-a4cb-aaaf95590f87",
    "charge_date": "2024-08-05"
  }
}

Response

Created

status'pending'

All Direct Debit collections will initially reside in a pending status, we will then send webhook notifications to inform you of the subsequent statuses.

transaction_idstring uuid

Unique identifier assigned by Acquired.com for the transaction record.

Example response

{
  "status": "pending",
  "transaction_id": "bd3fbbcd-411e-4760-8a9f-7af420d26314"
}