Credit Transfers

Create credit transfer batch

Changed on Nov 3, 2026

Create a batch of credit transfer payments.

See https://docs.atlar.com/docs/batch-payments for more information.

post/payments/v2beta/credit-transfer-batches

Request

Base URL
https://api.atlar.com
Auth
HTTP basic
TypeScript
https://skmtc.dev/atlar/apis/atlar-api-v2/docs/payments/v2beta/credit-transfer-batches/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

treatment'INDIVIDUAL_PAYMENTS' | 'BATCH' required

Deprecated: You can approve or reject on batch and individual level regardless of the treatment type.

externalIdstring

External ID is optional to use, but if used, the Atlar platform will persist it, index it, as well as require it to be unique across all resources. It is possible to retrieve a resource using the external ID using the prefix external:.

skipValidationErrorsboolean

Skip/ignore input records that contain validation errors.

metadataMetadata nullable

Metadata is a string-string key-value container that can be used to store information known at the time of resource creation. This can be retrieved later on, for instance when a payment or expected transaction is reconciled with the booked transaction on the bank statement.

Metadata can have at most 20 entries. Keys may have a maximum length of 64 chars and values a maximum length of 512 chars.

By default, this field is optional. It is possible to make it required in the Atlar Dashboard by visiting the Metadata keys page. Requirement rules can be specified per API resource. Both the Dashboard and the API will then enforce these rules and give validation errors when the required fields are not set.

Example request

{
  "treatment": "INDIVIDUAL_PAYMENTS",
  "payments": [
    {
      "amount": {
        "currency": "EUR",
        "value": 1502
      },
      "scheme": "SCT",
      "schemeDetails": {
        "instrument": {
          "type": "CITI_WORLDLINK"
        }
      },
      "date": "2022-05-07",
      "source": {
        "type": "ACCOUNT",
        "id": "31d593d7-fff9-4783-aa1d-92acb7b21a19"
      },
      "destination": {
        "type": "ACCOUNT",
        "id": "31d593d7-fff9-4783-aa1d-92acb7b21a19"
      },
      "referenceType": "CREDITOR_REFERENCE",
      "categoryPurpose": "SALA",
      "chargeBearer": "SHARED",
      "regulatoryReporting": [
        {
          "market": "DE",
          "indicator": "CREDITOR"
        }
      ],
      "taxDetails": {
        "type": "PL_MPP",
        "amount": {
          "currency": "EUR",
          "value": 1502
        },
        "creditorId": "1234567890",
        "invoiceNumber": "FV/2024/001"
      },
      "fxInstruction": {
        "rate": {
          "unitCurrency": "EUR"
        }
      },
      "externalId": "walVNuin6X5Mvte4xhg1ibTAVSACfN4Q9hl",
      "metadata": {
        "my_metadata_key": "2a9a79b9-601c-449b-aa05-432f41dbbc4a"
      },
      "paymentScheduleId": "2ed9a3ee-60aa-4f9f-a858-2eed4eefbbc8"
    }
  ],
  "externalId": "walVNuin6X5Mvte4xhg1ibTAVSACfN4Q9hl",
  "metadata": {
    "my_metadata_key": "2a9a79b9-601c-449b-aa05-432f41dbbc4a"
  }
}

Response

The created credit transfer batch.

idstring required

Unique resource identifier.

organizationIdstring required

Unique resource identifier for an Organization.

treatment'INDIVIDUAL_PAYMENTS' | 'BATCH' required

Deprecated: You can approve or reject on batch and individual level regardless of the treatment type.

status'CREATED' | 'PROCESSING_STARTED' | 'COMPLETED' required

The status of this batch. The status only refers to the processing of the input, not the processing or success of the resources themselves.

COMPLETED is the only end-state. Failure is indicated by a non-empty list of errors.

externalIdstring

creatorUserIdstring

Unique resource identifier.

sourceAccountIdsResourceID[]

IDs of the accounts that the payments in this batch are initiated from.

metadataMetadata nullable

Metadata can have at most 20 entries. Keys may have a maximum length of 64 chars and values a maximum length of 512 chars.

etagstring required

ETag based on the resource version. This can be passed along in If-Match HTTP header when updating a resource to perform a conditional update.

versioninteger required

Resource version. Starts at value 1 when the resource is created and increases by one for each successive update.

createdstring date-time required

Time at which the resource was created.

updatedstring date-time required

Time at which the resource was last updated.

Example response

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

Changes

Nov 3, 2026b49df1e4b3e9 Revision changes
- breaking
  removed the enum value CN_CT of the request property //
- breaking
  removed the required property from the response with the status
- info
  added the new optional request property ////////
- info
  added the new optional request property ////////
- info
  added the new optional request property //
- info
  added the new BD_BRN enum value to the request property /////////
- info
  added the new BD_CT_BEFTN enum value to the request property //
- info
  added the new BD_CT_RTGS enum value to the request property //
- info
  added the new CL_CT enum value to the request property //
- info
  added the new CN_CT_BEPS enum value to the request property //
- info
  added the new CN_CT_HVPS enum value to the request property //
- info
  added the new CO_CT enum value to the request property //
- info
  added the new CR_CT enum value to the request property //
- info
  added the new CZ_NBC enum value to the request property /////////
- info
  added the new DK_CT_T2 enum value to the request property //
- info
  added the new GE_CT_RTGS enum value to the request property //
- info
  added the new HK_CT_CHATS enum value to the request property //
- info
  added the new HK_CT_FPS enum value to the request property //
- info
  added the new HU_CT_GIRO enum value to the request property //
- info
  added the new HU_CT_VIBER enum value to the request property //
- info
  added the new KE_CT_RTGS enum value to the request property //
- info
  added the new MA_CT enum value to the request property //
- info
  added the new MU_CT enum value to the request property //
- info
  added the new MX_CT_SPEI enum value to the request property //
- info
  added the new MX_CT_TEF enum value to the request property //
- info
  added the new MY_CT_JOMPAY enum value to the request property //
- info
  added the new MY_JOMPAY_BILLER_CODE enum value to the request property /////////
- info
  added the new MY_JOMPAY_BILLER_CODE enum value to the request property //////////
- info
  added the new PE_CT enum value to the request property //
- info
  added the new PH_BRSTN enum value to the request property /////////
- info
  added the new SA_CT_SARIE enum value to the request property //
- info
  added the new SG_CT_GIRO enum value to the request property //
- info
  added the new SG_CT_MEPS enum value to the request property //
- info
  added the new TH_CT_BAHTNET enum value to the request property //
- info
  added the new TH_CT_SMART enum value to the request property //
- info
  added the new TW_CT_ACH enum value to the request property //
- info
  added the new TW_CT_FISC enum value to the request property //
- info
  added the new WALLET_AIRWALLEX_NUMBER enum value to the request property /////////
- info
  added the new WALLET_AIRWALLEX_NUMBER enum value to the request property //////////
- info
  added the new WALLET_UNIT enum value to the request property /////////
- info
  added the new WALLET_UNIT enum value to the request property //////////
- info
  added the new ZA_CT_EFT enum value to the request property //
- 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

Operation history