Upload payments
Uploads payments to an existing payment batch.
POST
/
payment-batches
/
{paymentBatchId}
/
payments
cURL
curl --request POST \
--url 'https://api.equalsmoney.com/v2/payment-batches/{paymentBatchId}/payments?accountId={{accountId}}' \
--header 'Authorization: <api-key>'import requests
url = "https://api.equalsmoney.com/v2/payment-batches/{paymentBatchId}/payments"
payload = {
"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 = {
"content-type": "<content-type>",
"Authorization": "<api-key>"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'content-type': '<content-type>', Authorization: '<api-key>'},
body: JSON.stringify({
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/{paymentBatchId}/payments', 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/{paymentBatchId}/payments",
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([
'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: <content-type>"
],
]);
$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/{paymentBatchId}/payments"
payload := strings.NewReader("{\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}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("content-type", "<content-type>")
req.Header.Add("Authorization", "<api-key>")
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/{paymentBatchId}/payments")
.header("content-type", "<content-type>")
.header("Authorization", "<api-key>")
.body("{\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}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.equalsmoney.com/v2/payment-batches/{paymentBatchId}/payments")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["content-type"] = '<content-type>'
request["Authorization"] = '<api-key>'
request.body = "{\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}"
response = http.request(request)
puts response.read_body{
"format": "json",
"status": "accepted",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}Authorizations
Headers
Format for the payments upload.
Path Parameters
The unique ID of the Payment Batch.
Maximum string length:
36Query Parameters
The ID of the account to work with.
Example:
"F50091"
Body
application/json
Body
Response
202 - application/json
Accepted
The format that the payments were uploaded in.
Available options:
json, csv The status of the upload
Available options:
accepted, uploaded, validated, failed The date the Resource was initially created. ISO 8601 format without milliseconds.
The date the Resource was last modified. ISO 8601 format without milliseconds.
Was this page helpful?
⌘I
cURL
curl --request POST \
--url 'https://api.equalsmoney.com/v2/payment-batches/{paymentBatchId}/payments?accountId={{accountId}}' \
--header 'Authorization: <api-key>'import requests
url = "https://api.equalsmoney.com/v2/payment-batches/{paymentBatchId}/payments"
payload = {
"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 = {
"content-type": "<content-type>",
"Authorization": "<api-key>"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'content-type': '<content-type>', Authorization: '<api-key>'},
body: JSON.stringify({
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/{paymentBatchId}/payments', 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/{paymentBatchId}/payments",
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([
'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: <content-type>"
],
]);
$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/{paymentBatchId}/payments"
payload := strings.NewReader("{\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}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("content-type", "<content-type>")
req.Header.Add("Authorization", "<api-key>")
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/{paymentBatchId}/payments")
.header("content-type", "<content-type>")
.header("Authorization", "<api-key>")
.body("{\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}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.equalsmoney.com/v2/payment-batches/{paymentBatchId}/payments")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["content-type"] = '<content-type>'
request["Authorization"] = '<api-key>'
request.body = "{\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}"
response = http.request(request)
puts response.read_body{
"format": "json",
"status": "accepted",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}