ATatlar
Credit Transfers

List credit transfer batches

Changed on

Returns credit transfer batches — groups of outbound payments created together (for example via CSV/JSON upload or API). Newest batches first.

Individual payments belonging to a batch are credit transfer resources whose batch.id matches this batch.

get/payments/v2beta/credit-transfer-batches

Request

Query parameters

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 transfer batches.

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",
      "treatment": "INDIVIDUAL_PAYMENTS",
      "input": {
        "sums": [
          {
            "currency": "EUR",
            "stringValue": "15.02",
            "value": 1502
          }
        ],
        "content": {
          "size": 4711,
          "checksum": "sha256:08343d976a896e8563b4915c84878207199b5fa139d3edde1bd77d99339bd18c",
          "filename": "batch-2022-05-07.csv"
        }
      },
      "inputContent": {
        "size": 4711,
        "checksum": "sha256:08343d976a896e8563b4915c84878207199b5fa139d3edde1bd77d99339bd18c",
        "filename": "batch-2022-05-07.csv"
      },
      "inputDetails": {
        "sums": [
          {
            "currency": "EUR",
            "stringValue": "15.02",
            "value": 1502
          }
        ]
      },
      "results": {
        "sums": [
          {
            "currency": "EUR",
            "stringValue": "15.02",
            "value": 1502
          }
        ]
      },
      "resultDetails": {
        "sums": [
          {
            "currency": "EUR",
            "stringValue": "15.02",
            "value": 1502
          }
        ]
      },
      "status": "COMPLETED",
      "errors": [
        {
          "code": "invalid_value",
          "error": "Must be one of [direct_debits mandates payments]",
          "field": "filter.0.resource",
          "metadata": {
            "resource": "credit_transfers",
            "method": "read"
          }
        }
      ],
      "externalId": "walVNuin6X5Mvte4xhg1ibTAVSACfN4Q9hl",
      "creatorUserId": "2ed9a3ee-60aa-4f9f-a858-2eed4eefbbc8",
      "sourceAccountIds": [
        "2ed9a3ee-60aa-4f9f-a858-2eed4eefbbc8"
      ],
      "metadata": {
        "my_metadata_key": "2a9a79b9-601c-449b-aa05-432f41dbbc4a"
      },
      "etag": "version:3",
      "version": 1,
      "created": "2022-05-04T18:31:12.889104898Z",
      "updated": "2022-05-04T18:47:32.213842599Z"
    }
  ],
  "nextToken": "eyIxIjogIlRoaXMgaXMgYSBkdW1teSBwYWdpbmF0aW9uIHRva2VuLiJ9",
  "token": "eyIwIjogIlRoaXMgaXMgYSBkdW1teSBwYWdpbmF0aW9uIHRva2VuLiJ9",
  "limit": 100
}

Changes

  • b49df1e4b3e9Revision changes
    • breaking

      removed the required property /// from the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property // to the response with the status