Sign in

v1

latestOpenAPI 3.0.02026-07-2480677847.6 KB
Endpoints

List Fundings

Return a list of all funding records, restricted by your allianceCode, partnerCode or merchant ID (as appropriate) for the given datetime range.

get/fundings

Query parameters

fundedAfterstring date

Filter fundings on the funded field from the given date value in ISO 8601 format yyyy-MM-dd, anything from the time 00:00:00 on the given day would match.

Default: 30 days prior to the current day

fundedBeforestring date

Filter fundings on the funded field up to and including the given date value in ISO 8601 format yyyy-MM-dd, anything up the the time 23:59:59 on the given day would match.

Default: Current day

limitinteger

Number of elements to be returned in a single query.

Can be used for page/offset or cursor based pagination

offsetinteger

Starting point to start retrieving the elements from. It is "0" based i.e. value "0" signifies the first page.

This can be used with "limit".

Can be used for page/offset based pagination.

sortstring

Specifies the sequence of elements and order to sort the payload by

Defines how to sort the records returned. Must be specified in the syntax '+' (ascending) or '-' (descending) followed by the field name.

For example: +funded would sort by the 'funded' field ascending.

Allowed fields: funded

Default: +funded (oldest first)

fundingDetailIdstring
Example:890123456

Filter for records linked by a funding detail record's id via the /fundings/{id}/details endpoint.

Headers

Partner-Codestring
Example:DIGI_PAYMENTS

For use by an alliance when there is a need to filter on a specific partner within their scope. May be restricted based on the API key.

Merchant-Idstring
Example:1234567890

For use by an alliance or partner when there is a need to filter on a specific merchant within their scope. May be restricted based on the API key.

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"
      }
    }
  }
]