Sign in

v1

latestOpenAPI 3.0.02026-07-2480677847.6 KB
Endpoints

Retrieve a single funding

Returns a single Funding for the given unique ID

get/fundings/{id}

Path parameters

idstring required

Unique system identifier of the record in our system.

Example:54321123456

The funding Id for the record being retrieved, found in the id field in listed records

Response

OK

idstring required

Unique system identifier of the record in our system.

fundedstring date-time required

The date and time (in ISO 8601 format yyyy-MM-ddTHH:mm:ssZ) the money is ready to be funded into the recipients account.

postedstring date-time required

The date and time (in ISO 8601 format yyyy-MM-ddTHH:mm:ssZ) the funding order was generated.

status'RELEASED' | 'HELD' | 'UNKNOWN' required

Whether the money has actually been released to the merchant account or is still being held

Example response

{
  "id": "54321123456",
  "funded": "2021-08-16T14:12:43Z",
  "posted": "2021-08-16T14:12:43Z",
  "type": {
    "code": "250",
    "description": "Merchant Payment"
  },
  "merchant": {
    "id": "520334547514337",
    "name": "Matt's Bicycles Ltd",
    "allianceCode": "FISV",
    "partnerCode": "DIGI_PMNTS"
  },
  "account": {
    "id": "54321123456",
    "reference": "80002192",
    "iban": "GB****************5555",
    "currencyCode": "GBP",
    "type": {
      "code": "170",
      "description": "Payment Account Retail"
    }
  },
  "financial": {
    "netAmount": "20.99"
  },
  "meta": {
    "paymentReference": "764933301"
  },
  "_links": {
    "transactions": {
      "href": "/transactions?postedAfter=2021-08-15&postedBefore=2021-08-16&fundingId=54321123456"
    },
    "funding-details": {
      "href": "/fundings/54321123456/details"
    }
  }
}