Sign in

v1

latestOpenAPI 3.1.0Apache 2.02026-07-2498321298.8 KB
Credit Transfers

List credit transfers

Returns a list of credit transfers. Sort order is always descending on date.

get/payments/v2/credit-transfers

Query parameters

accountIdstring

Include only credit transfers for the given source account.

status'CREATED' | 'APPROVED'

Include only credit transfers with the given status.

string date

Include only credit transfers with date equal to the given value.

OR
Example:2022-01-15

Include only credit transfers with property date matching the given value. The parameter value may be either a string for equality matching, or an object for range-like matching criteria.

batchIdstring

Include only credit transfers that are part of the payment batch with the given batch ID.

limitinteger

Limit the number of items in resulting query response.

tokenstring

If a query response contains a non-empty nextToken, use that value as token query parameter to continue pagination.

Response

A list of credit transfers.

nextTokenstring required

Pagination token for next page. The value will be a non-empty string if there are more resources to be fetched. The value will be an empty string if there are no more resources to be fetched.

tokenstring required

The pagination token that was used for this request. The value will be an empty string if no token query parameter was provided with the request.

limitinteger required

The page limit that was used for this request.

Example response

{
  "items": [
    {
      "id": "2ed9a3ee-60aa-4f9f-a858-2eed4eefbbc8",
      "organizationId": "0160f6ab-5741-49e1-af46-9138927e547e",
      "creatorUserId": "2ed9a3ee-60aa-4f9f-a858-2eed4eefbbc8",
      "amount": {
        "currency": "EUR",
        "stringValue": "15.02",
        "value": 1502
      },
      "scheme": "SCT",
      "schemeDetails": {
        "instrument": {
          "type": "CITI_WORLDLINK",
          "citiWorldlinkId": "123456789"
        }
      },
      "date": "2022-05-07",
      "status": "SENT",
      "statusReason": {
        "code": "DS02",
        "description": "EBICS VEU/EDS signature cancelled by user"
      },
      "source": {
        "id": "ac1963d7-fff9-4783-aa1d-92acb7b21a19",
        "type": "ACCOUNT",
        "organizationId": "0160f6ab-5741-49e1-af46-9138927e547e",
        "market": "DE",
        "currency": "EUR",
        "identifiers": [
          {
            "market": "DE",
            "type": "IBAN",
            "number": "DE89370400440532013000"
          }
        ],
        "routing": [
          {
            "type": "BIC",
            "number": "COBADEFFXXX"
          }
        ]
      },
      "sourceHolder": {
        "type": "ENTITY",
        "id": "29a4555b-99b2-4de7-9062-47c8ebc03f56",
        "legalName": "Example Company GmbH",
        "address": {
          "country": "DE",
          "city": "Munich",
          "postalCode": "123456"
        }
      },
      "destination": {
        "id": "31d593d7-fff9-4783-aa1d-92acb7b21a19",
        "organizationId": "605e26fc-4fce-495a-a92f-2c3592d7287e",
        "market": "GB",
        "type": "EXTERNAL_ACCOUNT",
        "identifiers": [
          {
            "type": "IBAN",
            "market": "GB",
            "number": "GB33BUKB20201555555555"
          }
        ],
        "routing": [
          {
            "type": "BIC",
            "number": "BUKBGB22XXX"
          }
        ]
      },
      "destinationHolder": {
        "type": "ENTITY",
        "id": "29a4555b-99b2-4de7-9062-47c8ebc03f56",
        "legalName": "Example Company GmbH",
        "address": {
          "country": "DE",
          "city": "Munich",
          "postalCode": "123456"
        }
      },
      "approvalSteps": [
        {
          "id": "735c7b8c-ef29-456a-8caf-113be117d131",
          "status": "APPROVED",
          "approver": {
            "id": "2ed9a3ee-60aa-4f9f-a858-2eed4eefbbc8",
            "username": "john.smith@example.com",
            "name": "John Smith",
            "roleId": "2a1e16eb-2f83-4597-99e2-cffbc4311df2"
          }
        }
      ],
      "attachedTransactions": [
        {
          "type": "TRANSACTION",
          "id": "27abf7cb-3867-4119-bfa7-ee3fb667ecf3"
        }
      ],
      "referenceType": "CREDITOR_REFERENCE",
      "categoryPurpose": "SALA",
      "chargeBearer": "SHARED",
      "regulatoryReporting": [
        {
          "market": "DE",
          "indicator": "CREDITOR"
        }
      ],
      "taxDetails": {
        "type": "PL_MPP",
        "amount": {
          "currency": "EUR",
          "stringValue": "15.02",
          "value": 1502
        }
      },
      "connectionInstructionId": "c1d6502c-07c7-4c77-bee5-963f9464c7d8",
      "batch": {
        "id": "2ed9a3ee-60aa-4f9f-a858-2eed4eefbbc8",
        "treatment": "INDIVIDUAL_PAYMENTS"
      },
      "paymentScheduleId": "2ed9a3ee-60aa-4f9f-a858-2eed4eefbbc8",
      "etag": "version:3",
      "externalId": "walVNuin6X5Mvte4xhg1ibTAVSACfN4Q9hl",
      "metadata": {
        "my_metadata_key": "2a9a79b9-601c-449b-aa05-432f41dbbc4a"
      },
      "version": 1,
      "created": "2022-05-04T18:31:12.889104898Z",
      "updated": "2022-05-04T18:47:32.213842599Z"
    }
  ],
  "nextToken": "eyIxIjogIlRoaXMgaXMgYSBkdW1teSBwYWdpbmF0aW9uIHRva2VuLiJ9",
  "token": "eyIwIjogIlRoaXMgaXMgYSBkdW1teSBwYWdpbmF0aW9uIHRva2VuLiJ9",
  "limit": 100
}