PATCH
/
batches
/
{id}
Update Batch Payment
curl --request PATCH \
  --url https://api.synctera.com/v1/batches/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "batched_transfer_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "status": "CANCELLED",
  "tenant": "abcdef_ghijkl"
}'
{
  "amount": 123,
  "batch_payment_template_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "batched_transfer_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "creation_time": "2010-05-06T12:23:34.321Z",
  "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
  "last_updated_time": "2010-05-06T12:23:34.321Z",
  "payment_rail": "<string>",
  "payment_rail_transfer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "CANCELLED",
  "tenant": "abcdef_ghijkl",
  "transaction_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string<uuid>
required

ID

Body

application/json

Attributes of the Batch Payment for udpate

The body is of type object.

Response

201
application/json

Successful update of a Batch Payment

A Batch Payment is a collection of transfers that are processed together. These transfers represent a new transfer on the ledger.