Skip to main content
Create Bulk Payment
curl --request POST \
  --url https://api.yapily.com/bulk-payments \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json;charset=UTF-8' \
  --header 'consent: <consent>' \
  --data '
{
  "idempotencyId": "1cc3e60d-5500-42be-aaeb-3c5e2f5ed048",
  "payments": [
    {
      "type": "DOMESTIC_PAYMENT",
      "paymentIdempotencyId": "d78fy48uh8f9odhde68dfi38di9",
      "reference": "payment1",
      "contextType": "BILL_IN_ARREARS",
      "purposeCode": "COMT",
      "amount": {
        "amount": 2,
        "currency": "GBP"
      },
      "payee": {
        "name": "Jane Doe",
        "accountIdentifications": [
          {
            "type": "ACCOUNT_NUMBER",
            "identification": "12345678"
          },
          {
            "type": "SORT_CODE",
            "identification": "123456"
          }
        ],
        "accountType": "BUSINESS_SAVING"
      }
    },
    {
      "type": "DOMESTIC_PAYMENT",
      "paymentIdempotencyId": "4279gdy8t63dg73gd8gx87738dg",
      "reference": "payment2",
      "amount": {
        "amount": 5,
        "currency": "GBP"
      },
      "payee": {
        "name": "John Doe",
        "accountIdentifications": [
          {
            "type": "ACCOUNT_NUMBER",
            "identification": "87654321"
          },
          {
            "type": "SORT_CODE",
            "identification": "654321"
          }
        ]
      }
    }
  ]
}
'
import requests

url = "https://api.yapily.com/bulk-payments"

payload = {
    "idempotencyId": "1cc3e60d-5500-42be-aaeb-3c5e2f5ed048",
    "payments": [
        {
            "type": "DOMESTIC_PAYMENT",
            "paymentIdempotencyId": "d78fy48uh8f9odhde68dfi38di9",
            "reference": "payment1",
            "contextType": "BILL_IN_ARREARS",
            "purposeCode": "COMT",
            "amount": {
                "amount": 2,
                "currency": "GBP"
            },
            "payee": {
                "name": "Jane Doe",
                "accountIdentifications": [
                    {
                        "type": "ACCOUNT_NUMBER",
                        "identification": "12345678"
                    },
                    {
                        "type": "SORT_CODE",
                        "identification": "123456"
                    }
                ],
                "accountType": "BUSINESS_SAVING"
            }
        },
        {
            "type": "DOMESTIC_PAYMENT",
            "paymentIdempotencyId": "4279gdy8t63dg73gd8gx87738dg",
            "reference": "payment2",
            "amount": {
                "amount": 5,
                "currency": "GBP"
            },
            "payee": {
                "name": "John Doe",
                "accountIdentifications": [
                    {
                        "type": "ACCOUNT_NUMBER",
                        "identification": "87654321"
                    },
                    {
                        "type": "SORT_CODE",
                        "identification": "654321"
                    }
                ]
            }
        }
    ]
}
headers = {
    "consent": "<consent>",
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json;charset=UTF-8"
}

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

print(response.text)
const options = {
  method: 'POST',
  headers: {
    consent: '<consent>',
    Authorization: 'Basic <encoded-value>',
    'Content-Type': 'application/json;charset=UTF-8'
  },
  body: JSON.stringify({
    idempotencyId: '1cc3e60d-5500-42be-aaeb-3c5e2f5ed048',
    payments: [
      {
        type: 'DOMESTIC_PAYMENT',
        paymentIdempotencyId: 'd78fy48uh8f9odhde68dfi38di9',
        reference: 'payment1',
        contextType: 'BILL_IN_ARREARS',
        purposeCode: 'COMT',
        amount: {amount: 2, currency: 'GBP'},
        payee: {
          name: 'Jane Doe',
          accountIdentifications: [
            {type: 'ACCOUNT_NUMBER', identification: '12345678'},
            {type: 'SORT_CODE', identification: '123456'}
          ],
          accountType: 'BUSINESS_SAVING'
        }
      },
      {
        type: 'DOMESTIC_PAYMENT',
        paymentIdempotencyId: '4279gdy8t63dg73gd8gx87738dg',
        reference: 'payment2',
        amount: {amount: 5, currency: 'GBP'},
        payee: {
          name: 'John Doe',
          accountIdentifications: [
            {type: 'ACCOUNT_NUMBER', identification: '87654321'},
            {type: 'SORT_CODE', identification: '654321'}
          ]
        }
      }
    ]
  })
};

fetch('https://api.yapily.com/bulk-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.yapily.com/bulk-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([
    'idempotencyId' => '1cc3e60d-5500-42be-aaeb-3c5e2f5ed048',
    'payments' => [
        [
                'type' => 'DOMESTIC_PAYMENT',
                'paymentIdempotencyId' => 'd78fy48uh8f9odhde68dfi38di9',
                'reference' => 'payment1',
                'contextType' => 'BILL_IN_ARREARS',
                'purposeCode' => 'COMT',
                'amount' => [
                                'amount' => 2,
                                'currency' => 'GBP'
                ],
                'payee' => [
                                'name' => 'Jane Doe',
                                'accountIdentifications' => [
                                                                [
                                                                                                                                'type' => 'ACCOUNT_NUMBER',
                                                                                                                                'identification' => '12345678'
                                                                ],
                                                                [
                                                                                                                                'type' => 'SORT_CODE',
                                                                                                                                'identification' => '123456'
                                                                ]
                                ],
                                'accountType' => 'BUSINESS_SAVING'
                ]
        ],
        [
                'type' => 'DOMESTIC_PAYMENT',
                'paymentIdempotencyId' => '4279gdy8t63dg73gd8gx87738dg',
                'reference' => 'payment2',
                'amount' => [
                                'amount' => 5,
                                'currency' => 'GBP'
                ],
                'payee' => [
                                'name' => 'John Doe',
                                'accountIdentifications' => [
                                                                [
                                                                                                                                'type' => 'ACCOUNT_NUMBER',
                                                                                                                                'identification' => '87654321'
                                                                ],
                                                                [
                                                                                                                                'type' => 'SORT_CODE',
                                                                                                                                'identification' => '654321'
                                                                ]
                                ]
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>",
    "Content-Type: application/json;charset=UTF-8",
    "consent: <consent>"
  ],
]);

$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.yapily.com/bulk-payments"

	payload := strings.NewReader("{\n  \"idempotencyId\": \"1cc3e60d-5500-42be-aaeb-3c5e2f5ed048\",\n  \"payments\": [\n    {\n      \"type\": \"DOMESTIC_PAYMENT\",\n      \"paymentIdempotencyId\": \"d78fy48uh8f9odhde68dfi38di9\",\n      \"reference\": \"payment1\",\n      \"contextType\": \"BILL_IN_ARREARS\",\n      \"purposeCode\": \"COMT\",\n      \"amount\": {\n        \"amount\": 2,\n        \"currency\": \"GBP\"\n      },\n      \"payee\": {\n        \"name\": \"Jane Doe\",\n        \"accountIdentifications\": [\n          {\n            \"type\": \"ACCOUNT_NUMBER\",\n            \"identification\": \"12345678\"\n          },\n          {\n            \"type\": \"SORT_CODE\",\n            \"identification\": \"123456\"\n          }\n        ],\n        \"accountType\": \"BUSINESS_SAVING\"\n      }\n    },\n    {\n      \"type\": \"DOMESTIC_PAYMENT\",\n      \"paymentIdempotencyId\": \"4279gdy8t63dg73gd8gx87738dg\",\n      \"reference\": \"payment2\",\n      \"amount\": {\n        \"amount\": 5,\n        \"currency\": \"GBP\"\n      },\n      \"payee\": {\n        \"name\": \"John Doe\",\n        \"accountIdentifications\": [\n          {\n            \"type\": \"ACCOUNT_NUMBER\",\n            \"identification\": \"87654321\"\n          },\n          {\n            \"type\": \"SORT_CODE\",\n            \"identification\": \"654321\"\n          }\n        ]\n      }\n    }\n  ]\n}")

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

	req.Header.Add("consent", "<consent>")
	req.Header.Add("Authorization", "Basic <encoded-value>")
	req.Header.Add("Content-Type", "application/json;charset=UTF-8")

	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.yapily.com/bulk-payments")
  .header("consent", "<consent>")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/json;charset=UTF-8")
  .body("{\n  \"idempotencyId\": \"1cc3e60d-5500-42be-aaeb-3c5e2f5ed048\",\n  \"payments\": [\n    {\n      \"type\": \"DOMESTIC_PAYMENT\",\n      \"paymentIdempotencyId\": \"d78fy48uh8f9odhde68dfi38di9\",\n      \"reference\": \"payment1\",\n      \"contextType\": \"BILL_IN_ARREARS\",\n      \"purposeCode\": \"COMT\",\n      \"amount\": {\n        \"amount\": 2,\n        \"currency\": \"GBP\"\n      },\n      \"payee\": {\n        \"name\": \"Jane Doe\",\n        \"accountIdentifications\": [\n          {\n            \"type\": \"ACCOUNT_NUMBER\",\n            \"identification\": \"12345678\"\n          },\n          {\n            \"type\": \"SORT_CODE\",\n            \"identification\": \"123456\"\n          }\n        ],\n        \"accountType\": \"BUSINESS_SAVING\"\n      }\n    },\n    {\n      \"type\": \"DOMESTIC_PAYMENT\",\n      \"paymentIdempotencyId\": \"4279gdy8t63dg73gd8gx87738dg\",\n      \"reference\": \"payment2\",\n      \"amount\": {\n        \"amount\": 5,\n        \"currency\": \"GBP\"\n      },\n      \"payee\": {\n        \"name\": \"John Doe\",\n        \"accountIdentifications\": [\n          {\n            \"type\": \"ACCOUNT_NUMBER\",\n            \"identification\": \"87654321\"\n          },\n          {\n            \"type\": \"SORT_CODE\",\n            \"identification\": \"654321\"\n          }\n        ]\n      }\n    }\n  ]\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.yapily.com/bulk-payments")

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

request = Net::HTTP::Post.new(url)
request["consent"] = '<consent>'
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json;charset=UTF-8'
request.body = "{\n  \"idempotencyId\": \"1cc3e60d-5500-42be-aaeb-3c5e2f5ed048\",\n  \"payments\": [\n    {\n      \"type\": \"DOMESTIC_PAYMENT\",\n      \"paymentIdempotencyId\": \"d78fy48uh8f9odhde68dfi38di9\",\n      \"reference\": \"payment1\",\n      \"contextType\": \"BILL_IN_ARREARS\",\n      \"purposeCode\": \"COMT\",\n      \"amount\": {\n        \"amount\": 2,\n        \"currency\": \"GBP\"\n      },\n      \"payee\": {\n        \"name\": \"Jane Doe\",\n        \"accountIdentifications\": [\n          {\n            \"type\": \"ACCOUNT_NUMBER\",\n            \"identification\": \"12345678\"\n          },\n          {\n            \"type\": \"SORT_CODE\",\n            \"identification\": \"123456\"\n          }\n        ],\n        \"accountType\": \"BUSINESS_SAVING\"\n      }\n    },\n    {\n      \"type\": \"DOMESTIC_PAYMENT\",\n      \"paymentIdempotencyId\": \"4279gdy8t63dg73gd8gx87738dg\",\n      \"reference\": \"payment2\",\n      \"amount\": {\n        \"amount\": 5,\n        \"currency\": \"GBP\"\n      },\n      \"payee\": {\n        \"name\": \"John Doe\",\n        \"accountIdentifications\": [\n          {\n            \"type\": \"ACCOUNT_NUMBER\",\n            \"identification\": \"87654321\"\n          },\n          {\n            \"type\": \"SORT_CODE\",\n            \"identification\": \"654321\"\n          }\n        ]\n      }\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body
{
  "meta": {
    "tracingId": "0cda48c70f3941148bbee775a65fa3d0"
  },
  "data": {
    "id": "pv3-a1e2ecb0-270c-42e2-8ba5-005261b629d2",
    "institutionConsentId": "sdp-6-b06f9a82-c641-4aba-b76d-43e6bc052f75",
    "institutionInteractionId": "2bb95cee-4118-7844-ae5b-b48c8c9a1b87",
    "paymentIdempotencyId": "d06e26d3-8cd6-bc74-86eb-8f0f4fe355b2",
    "paymentScheme": "UK.OBIE.SWIFT",
    "status": "COMPLETED",
    "statusDetails": {
      "status": "COMPLETED",
      "statusUpdateDate": "2021-06-09T13:53:28.67Z"
    },
    "createdAt": "2021-06-09T13:53:28.67Z",
    "bulkAmountSum": 7
  }
}
{
  "error": {
    "code": 401,
    "status": "UNAUTHORIZED",
    "message": "Full authentication is required to access this resource"
  }
}
Learn more: Bulk Payments Overview

Authorizations

​
Authorization
string
header
required

Use HTTP Basic Authentication with your Application ID as username and Application Secret as password. Manage credentials in the Yapily Console. See Authentication for details.

Headers

​
consent
string
required

Mandatory. The consent-token containing the user's authorisation to make the request.

​
psu-id
string

Conditional. Represents the user's login ID for the Institution to a personal account.

See PSU identifiers to see if this header is required.

​
psu-corporate-id
string

Conditional. Represents the user's login ID for the Institution to a business account.

See PSU identifiers to see if this header is required.

​
psu-ip-address
string

Conditional. The IP address of the PSU.

See PSU identifiers to see if this header is required.

Body

application/json;charset=UTF-8

The payment request object defining the details of the bulk payment

​
payments
object[]
required

Mandatory. The array of PaymentRequest objects to initiate in the bulk payment.

​
idempotencyId
string

Optional. An alphanumeric string (1-40 chars) used for idempotency. Unique per consent ID for 24 hours. Prevents duplicate bulk file payment submissions.

Required string length: 1 - 40
Pattern: ^\S{1,40}$
Example:

"1cc3e60d-5500-42be-aaeb-3c5e2f5ed048"

​
originatorIdentificationNumber
string

Conditional. The identification number of the originator.

  • Mandatory for AIB bulk payments
​
executionDateTime
string<date-time>

Optional. Used to schedule the bulk payment to be executed at a future date if supported by the Institution. This value must fall on the same calendar day as the executionDateTime provided in the consent/authorisation phase. If the dates do not match, the bulk file payment will fail.

Response

Created

​
meta
object
​
data
object
​
links
object
​
forwardedData
object[]
​
raw
object[]
deprecated