Get credit transfer batch

get https://api.atlar.com/payments/v2beta/credit-transfer-batches/{id}

Retrieve a specific credit transfer batch.

Responses

Response body

object

string

required

length between 32 and 64

ID of the batch.

organizationId

string

required

Unique resource identifier for an Organization.

treatment

string

required

The way this batch treats the underlying payments.

INDIVIDUAL_PAYMENTS means that each payment is treated individually.

BATCH means that payment approvals (or rejections) are handled at batch level.

INDIVIDUAL_PAYMENTS BATCH

inputContent

object

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

int64

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.

results

object

Deprecated - use resultSummary and resultDetails. Summary of processing results.

The summary is only populated when the batch status is COMPLETED.

Detailed processing results can be retrieved using
https://docs.atlar.com/v2.0/reference/get_payments-v2beta-credit-transfer-batches-id-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

object

required

Aggregate summary of batch processing results.

sums

array of objects

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).

sums*

object

currency

string

required

length between 3 and 3

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

int64

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

object

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.

status

string

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.

CREATED PROCESSING_STARTED COMPLETED

errors

array of objects

length ≤ 255

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.

errors

object

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

array of objects

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).

approvalSteps*

object

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

array of strings

length ≤ 10

IDs of the Roles that can approve/reject. Not specified if the step was automatically approved based on an auto-approval chain.

requiredRoleIds

status

string

required

The status of the approval step. PENDING if step is not yet interacted with.

PENDING APPROVED REJECTED

approver

object

User information about the user who approved/rejected. Omitted if step is not yet approved/rejected.

updated

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:.

metadata

object | null

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 12 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.

Has additional fields

etag

string

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.

version

integer

required

≥ 1

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

created

date-time

required

Time at which the resource was created.

updated

date-time

required

Time at which the resource was last updated.

Language

Credentials

Basic

base64


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api.atlar.com/payments/v2beta/credit-transfer-batches/id \
3
     --header 'accept: application/json'


xxxxxxxxxx
74
}
1
{
2
  "id": "2ed9a3ee-60aa-4f9f-a858-2eed4eefbbc8",
3
  "organizationId": "0160f6ab-5741-49e1-af46-9138927e547e",
4
  "treatment": "INDIVIDUAL_PAYMENTS",
5
  "inputContent": {
6
    "contentType": "string",
7
    "recordCount": 0,
8
    "size": 4711,
9
    "checksum": "sha256:08343d976a896e8563b4915c84878207199b5fa139d3edde1bd77d99339bd18c",
10
    "filename": "batch-2022-05-07.csv"
11
  },
12
  "results": {
13
    "total": 0,
14
    "succeeded": 0,
15
    "failed": 0,
16
    "skipped": 0,
17
    "processed": {
18
      "total": 0,
19
      "succeeded": 0,
20
      "failed": 0,
21
      "skipped": 0
22
    },
23
    "sums": [
24
      {
25
        "currency": "EUR",

200A credit transfer batch.

404Resource not found.