Skip to main content
GET
Get Batch Payment Template

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

The unique resource identifier

Example:

"7d943c51-e4ff-4e57-9558-08cab6b963c7"

Response

Retrieve a Batch Payment template

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

config
Batch Payment Template 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
Batch Payment Template 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>
read-only
Example:

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