Skip to main content
Ready-to-LaunchCustom Builds
Start Building Now

Resources

BatchRelease​

BatchRelease is a JSON:API resource, top-level fields:

id
string
Identifier of the batch-release resource.
type
string
Type of the batch-release resource. The value is always batchRelease.
attributes
JSON Object
JSON object representing the batch-release data.
relationships
JSON:API Relationships
Describes relationships between the batch-release resource and other resources (accounts).

Attributes​

amount
integer
The amount (in cents) to move from the batch account to the receiver account.
description
string
Description of the payment.
senderName
string
Name of the sender, before combining the payments.
senderAddress
Address
Address of the sender, before combining the payments.
senderAccountNumber
string
Account number of the sender, before combining the payments.

Relationships​

batchAccount
JSON:API Relationship
The batch account to release the funds from.
receiver
JSON:API Relationship
The account to release the funds to.
Example BatchRelease resource:
{
  "type": "batchRelease",
  "id": "100123",
  "attributes": {
    "amount": 3000,
    "description": "Gift",
    "senderName": "Sherlock Holmes",
    "senderAccountNumber": "4581133972",
    "senderAddress": {
      "street": "221B Baker Street",
      "city": "London",
      "postalCode": "NW1 6XE",
      "country": "UK"
    }
  },
  "relationships": {
    "batchAccount": {
      "data": {
        "type": "batchAccount",
        "id": "10104"
      }
    },
    "receiver": {
      "data": {
        "type": "depositAccount",
        "id": "10097"
      }
    }
  }
}

Release Transaction​

A Release Transaction is created when funds are released from a batch account to a receiver account. See the Release Transaction in the central Resources documentation for the full schema.