---
title: "Get credit transfer batch"
method: GET
path: "/payments/v2beta/credit-transfer-batches/{id}"
tags: ["Credit Transfers"]
---

# Get credit transfer batch

`GET /payments/v2beta/credit-transfer-batches/{id}`

Retrieve a specific credit transfer batch.

## Path parameters

- `id` string, required

## Response `200`

A credit transfer batch.

- PaymentBatch
  - `id` string, required — Unique resource identifier.
  - `organizationId` string, 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.
  - `input` BatchInputMetadata, required — Metadata describing the original input that was used to create a payments batch.
    - `recordCount` integer, required — Deprecated. Has moved into `content`. Total count of input records (payments) in the input batch.
    - `sums` Amount[], required — The total amount sum per each currency of resources in this batch. Note that batch amount sums reported on the batch input metadata refer to the total amount sums of the input records (resources) while the batch amount sums reported on the batch result refer to the total amount sums of the successfully processed records (resources). This means that there may be a difference in the total sum for the input vs the result, due to skipped records (resources).
      - `currency` string, required — Three-letter ISO 4217 currency code.
      - `stringValue` string, required — A string representation of the amount value. This will be a decimal number if the currency has decimals. The number is not formatted for display purposes (e.g. with locale specific thousand separator) and always contains the dot `.` character as decimal separator.
      - `value` integer, required — The amount value as an integer (int64) represented in currency minor units (e.g. 15.02 EUR is represented as the value 1502).
    - `content` BatchInputContent, required — Metadata describing the input contents that was used to create this batch.
      - `contentType` string, required
      - `recordCount` integer, required — Total count of input records (resources) in the input batch.
      - `size` integer, required — The size of the input content in bytes. If the batch was created by uploading a file using `multipart/form-data` the `contentSize` will be the file size. If the batch was created with JSON input this will be the raw JSON size.
      - `checksum` string, required — A checksum of the batch input contents. The checksum digest value will be prefixed by an identifier of the hash algorithm used, e.g. `sha256`. A colon `:` is used as separator between the algorithm identifier and the digest value.
      - `filename` string — The name of the file that was used as input to create the batch. Filename will only available if the batch input was provided using `multipart/form-data`.
  - `inputContent` BatchInputContent, required — Metadata describing the input contents that was used to create this batch.
    - `contentType` string, required
    - `recordCount` integer, required — Total count of input records (resources) in the input batch.
    - `size` integer, required — The size of the input content in bytes. If the batch was created by uploading a file using `multipart/form-data` the `contentSize` will be the file size. If the batch was created with JSON input this will be the raw JSON size.
    - `checksum` string, required — A checksum of the batch input contents. The checksum digest value will be prefixed by an identifier of the hash algorithm used, e.g. `sha256`. A colon `:` is used as separator between the algorithm identifier and the digest value.
    - `filename` string — The name of the file that was used as input to create the batch. Filename will only available if the batch input was provided using `multipart/form-data`.
  - `inputDetails` PaymentBatchDetails, required — Details summarizing the contents of the batch.
    - `sums` Amount[], required — The total amount sum per each currency of resources in this batch. Note that batch amount sums reported on the batch input metadata refer to the total amount sums of the input records (resources) while the batch amount sums reported on the batch result refer to the total amount sums of the successfully processed records (resources). This means that there may be a difference in the total sum for the input vs the result, due to skipped records (resources).
      - `currency` string, required — Three-letter ISO 4217 currency code.
      - `stringValue` string, required — A string representation of the amount value. This will be a decimal number if the currency has decimals. The number is not formatted for display purposes (e.g. with locale specific thousand separator) and always contains the dot `.` character as decimal separator.
      - `value` integer, required — The amount value as an integer (int64) represented in currency minor units (e.g. 15.02 EUR is represented as the value 1502).
  - `results` BatchResultsSummary — Aggregate summary of payment batch processing results.
    - `total` integer, required — Deprecated. Moved to `processed`. Number of input records that were attempted to be processed.
    - `succeeded` integer, required — Deprecated. Moved to `processed`. Number of input records that resulted in a successfully created payment.
    - `failed` integer, required — Deprecated. Moved to `processed`. Number of failed records.
    - `skipped` integer, required — Deprecated. Moved to `processed`. Number of input records that were skipped.
    - `processed` BatchResultSummary, required — Aggregate summary of batch processing results.
      - `total` integer, required — Number of input records that were attempted to be processed.
      - `succeeded` integer, required — Number of input records that resulted in a successfully created resource.
      - `failed` integer, required — Number of failed records.
      - `skipped` integer, required — Number of input records that were skipped.
    - `sums` Amount[], required — The total amount sum per each currency of resources in this batch. Note that batch amount sums reported on the batch input metadata refer to the total amount sums of the input records (resources) while the batch amount sums reported on the batch result refer to the total amount sums of the successfully processed records (resources). This means that there may be a difference in the total sum for the input vs the result, due to skipped records (resources).
      - `currency` string, required — Three-letter ISO 4217 currency code.
      - `stringValue` string, required — A string representation of the amount value. This will be a decimal number if the currency has decimals. The number is not formatted for display purposes (e.g. with locale specific thousand separator) and always contains the dot `.` character as decimal separator.
      - `value` integer, required — The amount value as an integer (int64) represented in currency minor units (e.g. 15.02 EUR is represented as the value 1502).
  - `resultSummary` BatchResultSummary — Aggregate summary of batch processing results.
    - `total` integer, required — Number of input records that were attempted to be processed.
    - `succeeded` integer, required — Number of input records that resulted in a successfully created resource.
    - `failed` integer, required — Number of failed records.
    - `skipped` integer, required — Number of input records that were skipped.
  - `resultDetails` PaymentBatchDetails — Details summarizing the contents of the batch.
    - `sums` Amount[], required — The total amount sum per each currency of resources in this batch. Note that batch amount sums reported on the batch input metadata refer to the total amount sums of the input records (resources) while the batch amount sums reported on the batch result refer to the total amount sums of the successfully processed records (resources). This means that there may be a difference in the total sum for the input vs the result, due to skipped records (resources).
      - `currency` string, required — Three-letter ISO 4217 currency code.
      - `stringValue` string, required — A string representation of the amount value. This will be a decimal number if the currency has decimals. The number is not formatted for display purposes (e.g. with locale specific thousand separator) and always contains the dot `.` character as decimal separator.
      - `value` integer, required — The amount value as an integer (int64) represented in currency minor units (e.g. 15.02 EUR is represented as the value 1502).
  - `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`.
  - `errors` ErrorDetails[] — A list of error details if the batch failed. Only populated once the batch has reached status `COMPLETED`. Only the first 255 errors (if any) will be present in this list. If there are more errors, the complete list can be retrieved using the results endpoint for the batch.
    - `code` string — An error code for this error. Not always present.
    - `error` string — A description of this specific error.
    - `field` string — The field which has an error. This only set if the error has to do with a specific field, such as for validation errors. Nested fields are concatenated with `.`, as well as indexed fields in lists.
  - `approvalSteps` PaymentApprovalStep[], required — Batch approval steps. Approval steps will only be available once the the batch `status` is `COMPLETED`. I.e. no action must be taken based on the absence of approval steps (empty array).
    - `id` string, required — The ID of this step. Used when approving/rejecting.
    - `approvalChainId` string, required — The ID of the approval chain that triggered this approval step.
    - `requiredRoleIds` string[] — IDs of the Roles that can approve/reject. Not specified if the step was automatically approved based on an auto-approval chain.
    - `status` 'PENDING' | 'APPROVED' | 'REJECTED', required — The status of the approval step.
    - `approver` UserAuditInfo — User information for audit trail.
      - `id` string, required — Unique resource identifier.
      - `username` string, required
      - `name` string — User given name(s) information. May be a concatenation of firstname, lastname etc.
      - `roleId` string — Role ID
    - `updated` string, date-time — Timestamp when approved/rejected. Omitted if the step is not yet approved/rejected.
    - `autoApproved` boolean, required
    - `allowCreatorApproval` boolean — Allow approval by the user creating this resource if they have the role required for this step. By default, this is not allowed to conform with a four-eyes principle where approval by another person is required.
    - `sequentialApproval` boolean — If true, the approval steps for this approval chain, specified by `approvalChainId`, need to be approved in the the order specified by `sequenceNumber`.
    - `sequenceNumber` integer — The sequence number of this step in the approval chain.
  - `externalId` string — 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:`.
  - `approvalResults` ApprovalResults, required
    - `approved` integer, required — Number of fully approved credit transfers.
    - `rejected` integer, required — Number of rejected credit transfers.
  - `creatorUserId` string — Unique resource identifier.
  - `metadata` Metadata, 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](https://app.atlar.com/metadata-keys). 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.
  - `etag` string, required — [ETag](https://en.wikipedia.org/wiki/HTTP_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.
  - `version` integer, required — Resource version. Starts at value `1` when the resource is created and increases by one for each successive update.
  - `created` string, date-time, required — Time at which the resource was created.
  - `updated` string, date-time, required — Time at which the resource was last updated.

## Other responses

- `404` — Resource not found.

---

[API](https://skmtc.net/atlar/apis/atlar-api-v2.md) · [All operations](https://skmtc.net/atlar/apis/atlar-api-v2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/atlar/atlar-api-v2/revisions/9c5e194ccf5d/schema)