POST
/
batch_templates
Create Batch Payment Template
curl --request POST \
  --url https://api.synctera.com/v1/batch_templates \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "config": {
    "external_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "max_individual_transaction_amount": 123,
    "max_total_transaction_amount": 123,
    "max_transaction_count": 123,
    "min_individual_transaction_amount": 123,
    "min_total_transaction_amount": 123,
    "min_transaction_count": 123,
    "settlement_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "settlement_customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "subtypes": [
      "<string>"
    ],
    "type": "<string>"
  },
  "description": "This template is used for international remittance",
  "enabled": true,
  "extra_rail_params": {},
  "name": "International Remittance",
  "rules": {
    "disable_four_eyes_review": true,
    "hold_time": 123,
    "payment_rail": "<string>"
  },
  "tenant": "abcdef_ghijkl"
}'
{
  "config": {
    "external_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "max_individual_transaction_amount": 123,
    "max_total_transaction_amount": 123,
    "max_transaction_count": 123,
    "min_individual_transaction_amount": 123,
    "min_total_transaction_amount": 123,
    "min_transaction_count": 123,
    "settlement_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "settlement_customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "subtypes": [
      "<string>"
    ],
    "type": "<string>"
  },
  "description": "This template is used for international remittance",
  "enabled": true,
  "extra_rail_params": {},
  "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
  "name": "International Remittance",
  "rules": {
    "disable_four_eyes_review": true,
    "hold_time": 123,
    "payment_rail": "<string>"
  },
  "tenant": "abcdef_ghijkl"
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json

Attributes of the Batch Payment template

A Batch Payment Template is a template that is used when creating a batch transfer.

​
config
object
required

The config of a Batch Payment Template. This is used the match the Batch Payment Template to a batch transfer.

​
name
string
required
Example:

"International Remittance"

​
rules
object
required

The rules of a Batch Payment Template. This is used when processing a batch transfer.

​
tenant
string
required

The id of the tenant containing the resource.

Example:

"abcdef_ghijkl"

​
description
string
Example:

"This template is used for international remittance"

​
enabled
boolean

Whether or not the template is enabled. If the template is not enabled, it will not be used when creating a batch transfer.

​
extra_rail_params
object

Additional parameters to be passed through to the payment rail.

Response

Successful creation of a Batch Payment template

A Batch Payment Template is a template that is used when creating a batch transfer.

​
config
object
required

The config of a Batch Payment Template. This is used the match the Batch Payment Template to a batch transfer.

​
name
string
required
Example:

"International Remittance"

​
rules
object
required

The rules of a Batch Payment Template. This is used when processing a batch transfer.

​
tenant
string
required

The id of the tenant containing the resource.

Example:

"abcdef_ghijkl"

​
description
string
Example:

"This template is used for international remittance"

​
enabled
boolean

Whether or not the template is enabled. If the template is not enabled, it will not be used when creating a batch transfer.

​
extra_rail_params
object

Additional parameters to be passed through to the payment rail.

​
id
string<uuid>
Example:

"d290f1ee-6c54-4b01-90e6-d701748f0851"