Skip to main content
POST
/
payment-batches
cURL
curl --request POST \
  --url 'https://api.equalsmoney.com/v2/payment-batches?accountId={{accountId}}' \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "string",
  "visible": true,
  "payments": {
    "defaultFundingBudgetId": "771967a7-f0f7-4137-a6bf-494452ba6549",
    "rows": [
      {
        "amount": "string",
        "currencyCode": "USD",
        "fundingBudgetId": "6ee672f6-226f-4a72-8592-0f8dc5284ab1",
        "purposeCode": "string",
        "purpose": "string",
        "reference": "Invoice INV-12345 for Q1 consulting services",
        "externalId": "string",
        "recipient": {
          "id": "string",
          "defaultReference": "string",
          "type": "individual",
          "name": "string",
          "displayName": "string",
          "subscribedEmails": [
            {
              "name": "string",
              "email": "user@example.com"
            }
          ],
          "accountIdentifier": "string",
          "bankIdentifier": "string",
          "secondaryBankIdentifier": "string",
          "intermediaryBankIdentifier": "string",
          "paymentNetwork": "SWIFT",
          "address": {
            "addressType": "ADDR",
            "streetName": "string",
            "buildingNumber": "string",
            "buildingName": "string",
            "postcode": "string",
            "city": "string",
            "region": "string",
            "countryCode": "GB"
          },
          "bankAddress": {
            "countryCode": "GB"
          }
        }
      }
    ]
  }
}
'
import requests

url = "https://api.equalsmoney.com/v2/payment-batches"

payload = {
    "name": "string",
    "visible": True,
    "payments": {
        "defaultFundingBudgetId": "771967a7-f0f7-4137-a6bf-494452ba6549",
        "rows": [
            {
                "amount": "string",
                "currencyCode": "USD",
                "fundingBudgetId": "6ee672f6-226f-4a72-8592-0f8dc5284ab1",
                "purposeCode": "string",
                "purpose": "string",
                "reference": "Invoice INV-12345 for Q1 consulting services",
                "externalId": "string",
                "recipient": {
                    "id": "string",
                    "defaultReference": "string",
                    "type": "individual",
                    "name": "string",
                    "displayName": "string",
                    "subscribedEmails": [
                        {
                            "name": "string",
                            "email": "user@example.com"
                        }
                    ],
                    "accountIdentifier": "string",
                    "bankIdentifier": "string",
                    "secondaryBankIdentifier": "string",
                    "intermediaryBankIdentifier": "string",
                    "paymentNetwork": "SWIFT",
                    "address": {
                        "addressType": "ADDR",
                        "streetName": "string",
                        "buildingNumber": "string",
                        "buildingName": "string",
                        "postcode": "string",
                        "city": "string",
                        "region": "string",
                        "countryCode": "GB"
                    },
                    "bankAddress": { "countryCode": "GB" }
                }
            }
        ]
    }
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'string',
    visible: true,
    payments: {
      defaultFundingBudgetId: '771967a7-f0f7-4137-a6bf-494452ba6549',
      rows: [
        {
          amount: 'string',
          currencyCode: 'USD',
          fundingBudgetId: '6ee672f6-226f-4a72-8592-0f8dc5284ab1',
          purposeCode: 'string',
          purpose: 'string',
          reference: 'Invoice INV-12345 for Q1 consulting services',
          externalId: 'string',
          recipient: {
            id: 'string',
            defaultReference: 'string',
            type: 'individual',
            name: 'string',
            displayName: 'string',
            subscribedEmails: [{name: 'string', email: 'user@example.com'}],
            accountIdentifier: 'string',
            bankIdentifier: 'string',
            secondaryBankIdentifier: 'string',
            intermediaryBankIdentifier: 'string',
            paymentNetwork: 'SWIFT',
            address: {
              addressType: 'ADDR',
              streetName: 'string',
              buildingNumber: 'string',
              buildingName: 'string',
              postcode: 'string',
              city: 'string',
              region: 'string',
              countryCode: 'GB'
            },
            bankAddress: {countryCode: 'GB'}
          }
        }
      ]
    }
  })
};

fetch('https://api.equalsmoney.com/v2/payment-batches', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.equalsmoney.com/v2/payment-batches",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'string',
    'visible' => true,
    'payments' => [
        'defaultFundingBudgetId' => '771967a7-f0f7-4137-a6bf-494452ba6549',
        'rows' => [
                [
                                'amount' => 'string',
                                'currencyCode' => 'USD',
                                'fundingBudgetId' => '6ee672f6-226f-4a72-8592-0f8dc5284ab1',
                                'purposeCode' => 'string',
                                'purpose' => 'string',
                                'reference' => 'Invoice INV-12345 for Q1 consulting services',
                                'externalId' => 'string',
                                'recipient' => [
                                                                'id' => 'string',
                                                                'defaultReference' => 'string',
                                                                'type' => 'individual',
                                                                'name' => 'string',
                                                                'displayName' => 'string',
                                                                'subscribedEmails' => [
                                                                                                                                [
                                                                                                                                                                                                                                                                'name' => 'string',
                                                                                                                                                                                                                                                                'email' => 'user@example.com'
                                                                                                                                ]
                                                                ],
                                                                'accountIdentifier' => 'string',
                                                                'bankIdentifier' => 'string',
                                                                'secondaryBankIdentifier' => 'string',
                                                                'intermediaryBankIdentifier' => 'string',
                                                                'paymentNetwork' => 'SWIFT',
                                                                'address' => [
                                                                                                                                'addressType' => 'ADDR',
                                                                                                                                'streetName' => 'string',
                                                                                                                                'buildingNumber' => 'string',
                                                                                                                                'buildingName' => 'string',
                                                                                                                                'postcode' => 'string',
                                                                                                                                'city' => 'string',
                                                                                                                                'region' => 'string',
                                                                                                                                'countryCode' => 'GB'
                                                                ],
                                                                'bankAddress' => [
                                                                                                                                'countryCode' => 'GB'
                                                                ]
                                ]
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.equalsmoney.com/v2/payment-batches"

	payload := strings.NewReader("{\n  \"name\": \"string\",\n  \"visible\": true,\n  \"payments\": {\n    \"defaultFundingBudgetId\": \"771967a7-f0f7-4137-a6bf-494452ba6549\",\n    \"rows\": [\n      {\n        \"amount\": \"string\",\n        \"currencyCode\": \"USD\",\n        \"fundingBudgetId\": \"6ee672f6-226f-4a72-8592-0f8dc5284ab1\",\n        \"purposeCode\": \"string\",\n        \"purpose\": \"string\",\n        \"reference\": \"Invoice INV-12345 for Q1 consulting services\",\n        \"externalId\": \"string\",\n        \"recipient\": {\n          \"id\": \"string\",\n          \"defaultReference\": \"string\",\n          \"type\": \"individual\",\n          \"name\": \"string\",\n          \"displayName\": \"string\",\n          \"subscribedEmails\": [\n            {\n              \"name\": \"string\",\n              \"email\": \"user@example.com\"\n            }\n          ],\n          \"accountIdentifier\": \"string\",\n          \"bankIdentifier\": \"string\",\n          \"secondaryBankIdentifier\": \"string\",\n          \"intermediaryBankIdentifier\": \"string\",\n          \"paymentNetwork\": \"SWIFT\",\n          \"address\": {\n            \"addressType\": \"ADDR\",\n            \"streetName\": \"string\",\n            \"buildingNumber\": \"string\",\n            \"buildingName\": \"string\",\n            \"postcode\": \"string\",\n            \"city\": \"string\",\n            \"region\": \"string\",\n            \"countryCode\": \"GB\"\n          },\n          \"bankAddress\": {\n            \"countryCode\": \"GB\"\n          }\n        }\n      }\n    ]\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.equalsmoney.com/v2/payment-batches")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"string\",\n  \"visible\": true,\n  \"payments\": {\n    \"defaultFundingBudgetId\": \"771967a7-f0f7-4137-a6bf-494452ba6549\",\n    \"rows\": [\n      {\n        \"amount\": \"string\",\n        \"currencyCode\": \"USD\",\n        \"fundingBudgetId\": \"6ee672f6-226f-4a72-8592-0f8dc5284ab1\",\n        \"purposeCode\": \"string\",\n        \"purpose\": \"string\",\n        \"reference\": \"Invoice INV-12345 for Q1 consulting services\",\n        \"externalId\": \"string\",\n        \"recipient\": {\n          \"id\": \"string\",\n          \"defaultReference\": \"string\",\n          \"type\": \"individual\",\n          \"name\": \"string\",\n          \"displayName\": \"string\",\n          \"subscribedEmails\": [\n            {\n              \"name\": \"string\",\n              \"email\": \"user@example.com\"\n            }\n          ],\n          \"accountIdentifier\": \"string\",\n          \"bankIdentifier\": \"string\",\n          \"secondaryBankIdentifier\": \"string\",\n          \"intermediaryBankIdentifier\": \"string\",\n          \"paymentNetwork\": \"SWIFT\",\n          \"address\": {\n            \"addressType\": \"ADDR\",\n            \"streetName\": \"string\",\n            \"buildingNumber\": \"string\",\n            \"buildingName\": \"string\",\n            \"postcode\": \"string\",\n            \"city\": \"string\",\n            \"region\": \"string\",\n            \"countryCode\": \"GB\"\n          },\n          \"bankAddress\": {\n            \"countryCode\": \"GB\"\n          }\n        }\n      }\n    ]\n  }\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.equalsmoney.com/v2/payment-batches")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"string\",\n  \"visible\": true,\n  \"payments\": {\n    \"defaultFundingBudgetId\": \"771967a7-f0f7-4137-a6bf-494452ba6549\",\n    \"rows\": [\n      {\n        \"amount\": \"string\",\n        \"currencyCode\": \"USD\",\n        \"fundingBudgetId\": \"6ee672f6-226f-4a72-8592-0f8dc5284ab1\",\n        \"purposeCode\": \"string\",\n        \"purpose\": \"string\",\n        \"reference\": \"Invoice INV-12345 for Q1 consulting services\",\n        \"externalId\": \"string\",\n        \"recipient\": {\n          \"id\": \"string\",\n          \"defaultReference\": \"string\",\n          \"type\": \"individual\",\n          \"name\": \"string\",\n          \"displayName\": \"string\",\n          \"subscribedEmails\": [\n            {\n              \"name\": \"string\",\n              \"email\": \"user@example.com\"\n            }\n          ],\n          \"accountIdentifier\": \"string\",\n          \"bankIdentifier\": \"string\",\n          \"secondaryBankIdentifier\": \"string\",\n          \"intermediaryBankIdentifier\": \"string\",\n          \"paymentNetwork\": \"SWIFT\",\n          \"address\": {\n            \"addressType\": \"ADDR\",\n            \"streetName\": \"string\",\n            \"buildingNumber\": \"string\",\n            \"buildingName\": \"string\",\n            \"postcode\": \"string\",\n            \"city\": \"string\",\n            \"region\": \"string\",\n            \"countryCode\": \"GB\"\n          },\n          \"bankAddress\": {\n            \"countryCode\": \"GB\"\n          }\n        }\n      }\n    ]\n  }\n}"

response = http.request(request)
puts response.read_body
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "accountId": "string",
  "name": "string",
  "createdBy": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "type": "person"
  },
  "product": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "status": "draft",
  "visible": true,
  "visibleAt": "2019-08-24T14:15:22Z",
  "confirmedBy": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "type": "person"
  },
  "confirmedAt": "2019-08-24T14:15:22Z",
  "passedMfaCheckAt": "2019-08-24T14:15:22Z",
  "riskCheckedAt": "2019-08-24T14:15:22Z",
  "ordersSentAt": "2019-08-24T14:15:22Z",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "alerts": [
    {
      "timestamp": "2019-08-24T14:15:22Z",
      "type": "Error",
      "code": "string",
      "message": "string"
    }
  ],
  "ordersSummary": {
    "numberOfOrders": 0,
    "uniqueCurrencyCodes": [
      "USD"
    ]
  },
  "input": {
    "format": "json",
    "status": "accepted",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z"
  }
}
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "accountId": "string",
  "name": "string",
  "createdBy": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "type": "person"
  },
  "product": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "status": "draft",
  "visible": true,
  "visibleAt": "2019-08-24T14:15:22Z",
  "confirmedBy": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "type": "person"
  },
  "confirmedAt": "2019-08-24T14:15:22Z",
  "passedMfaCheckAt": "2019-08-24T14:15:22Z",
  "riskCheckedAt": "2019-08-24T14:15:22Z",
  "ordersSentAt": "2019-08-24T14:15:22Z",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "alerts": [
    {
      "timestamp": "2019-08-24T14:15:22Z",
      "type": "Error",
      "code": "string",
      "message": "string"
    }
  ],
  "ordersSummary": {
    "numberOfOrders": 0,
    "uniqueCurrencyCodes": [
      "USD"
    ]
  },
  "input": {
    "format": "json",
    "status": "accepted",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z"
  }
}

Authorizations

​
Authorization
string
header
required

Query Parameters

​
accountId
string
required

The ID of the account to work with.

Example:

"F50091"

Body

application/json

Body

​
name
string

The name of the Payment Batch, if one is not provided then a default name will be generated.

Maximum string length: 256
​
visible
boolean

Whether the payment batch is visible to other API users

​
payments
object

Response

Created

​
id
string<uuid>
required

The unique ID of the Payment Batch.

Maximum string length: 36
​
accountId
string
required

The ID of the account the Payment Batch belongs.

Maximum string length: 16
​
name
string | null
required

The name of the Payment Batch.

Maximum string length: 256
​
createdBy
object
required

The creator of the payment batch.

​
product
object
required
​
status
enum<string>
required

The status of the Payment Batch.

Available options:
draft,
validated,
confirmed,
started,
completed,
failed,
cancelled
​
visible
boolean | null
required

Whether the payment batch is visible to other API users

​
visibleAt
string<date-time> | null
required

Timestamp indicating when the payment batch was made visible. UTC.

​
confirmedBy
object | null
required

The initiator of the payment batch.

​
confirmedAt
string<date-time> | null
required

Timestamp indicating when the payment batch was confirmed. UTC.

​
passedMfaCheckAt
string<date-time> | null
required

Timestamp indicating when the payment batch passed MFA check. UTC.

​
riskCheckedAt
string<date-time> | null
required

Timestamp indicating when the payment batch was risk checked. UTC.

​
ordersSentAt
string<date-time> | null
required

Timestamp indicating when the orders were sent. UTC.

​
createdAt
string<date-time>
required

Timestamp indicating when the payment batch was created. UTC.

​
updatedAt
string<date-time>
required

Timestamp indicating when the payment batch was updated. UTC.

​
input
object | null
required
​
alerts
object[] | null
​
ordersSummary
object | null