Create an Intrabank Batch

Set up a batch of intrabank transfers to send and/or receive funds between accounts on your program
Batch
Create an Intrabank Batch
 last updated: 
November 30, 2023

Set up a batch of intrabank transfers to send and/or receive funds between accounts on your program. Follow these guidelines:
- sd-person-id header should have access to all accountId passed in the request body
- contactId should already be created and contain the Intrabank sub-object
- specify "send" or "receive" in the "api" field
- specify the order of the transfers by setting the "sequence" field. Sequences can be any integer and are not correlated between different batches
- maximum 500 objects or 256KB can be sent per API call

ENDPOINT

  1. POST /v1/batch/intrabank

REQUEST

  1. {
  2.  "data": [
  3.    {
  4.      "api": "send",
  5.      "accountId": "{{accountId}}",
  6.      "contactId": "{{contactId}}",
  7.      "amount": "25.00",
  8.      "title": "Batch intrabank 1",
  9.      "sequence": "1",
  10.      "description": "Funding"
  11.    },
  12.    {
  13.      "api": "receive",
  14.      "accountId": "{{accountId}}",
  15.      "contactId": "{{contactId}}",
  16.      "amount": "25.00",
  17.      "title": "Batch intrabank 2",
  18.      "sequence": "2",
  19.      "description": "Pull"
  20.    }
  21.  ]
  22. }

RESPONSE

  1. {
  2.  "batchId": "bch-d8b8825a-baa9-469c-9d32-8f6677031350",
  3.  "status": "submitted",
  4.  "transferType": "intrabank",
  5.  "totalCount": 2,
  6.  "successCount": 0,
  7.  "failedCount": 0,
  8.  "createdAt": "2023-07-17T16:50:03Z",
  9.  "completedAt": "",
  10.  "modifiedAt": "2023-07-17T16:50:03Z"
  11. }

The response is a batch object. You can retrieve an intrabank batch after it is sent to view its status, and you can retrieve a specific transaction by including the sequence number in the call.