YAyapily
Payments

Create Bulk Payment

Creates a bulk payment after obtaining the user's authorisation.

Feature: CREATE_BULK_PAYMENT

post/bulk-payments

Request

  • Base URL
    https://api.yapily.com
  • Auth
    HTTP basic

Headers

consentstring required

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

psu-idstring

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-idstring

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-addressstring

Conditional. The IP address of the PSU.

See PSU identifiers to see if this header is required.

Request body

idempotencyIdstring

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

originatorIdentificationNumberstring

Conditional. The identification number of the originator.

  • Mandatory for AIB bulk payments
executionDateTimestring 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.

Example request

{
  "idempotencyId": "1cc3e60d-5500-42be-aaeb-3c5e2f5ed048",
  "payments": [
    {
      "paymentIdempotencyId": "04ab4536gaerfc0e1f93c4f4",
      "payer": {
        "name": "John Doe",
        "accountIdentifications": [
          {
            "type": "SORT_CODE",
            "identification": "401016"
          }
        ],
        "address": {
          "country": "GB"
        }
      },
      "reference": "Bill payment",
      "payee": {
        "name": "Jane Doe",
        "accountIdentifications": [
          {
            "identification": "401016",
            "type": "SORT_CODE"
          },
          {
            "identification": "71518920",
            "type": "ACCOUNT_NUMBER"
          }
        ],
        "address": {
          "country": "GB"
        },
        "merchantId": "24589303",
        "merchantCategoryCode": "0742"
      },
      "periodicPayment": {
        "frequency": {
          "intervalWeek": 1,
          "intervalMonth": 1,
          "executionDay": 1
        },
        "numberOfPayments": 5,
        "nextPaymentDateTime": "2018-01-10T00:00:00Z",
        "nextPaymentAmount": {
          "amount": 10,
          "currency": "GBP"
        },
        "finalPaymentDateTime": "2030-01-10T00:00:00Z",
        "finalPaymentAmount": {
          "amount": 10,
          "currency": "GBP"
        }
      },
      "amount": {
        "amount": 10,
        "currency": "GBP"
      },
      "paymentDateTime": "2021-07-21T17:32:28Z"
    }
  ]
}

Response

Created

linksobject
tracingIdstring

Example response

{
  "data": {
    "statusDetails": {
      "isoStatus": {
        "code": "ACSP",
        "name": "AcceptedSettlementInProcess"
      }
    },
    "payer": {
      "name": "John Doe",
      "accountIdentifications": [
        {
          "type": "SORT_CODE",
          "identification": "401016"
        }
      ],
      "address": {
        "country": "GB"
      }
    },
    "payeeDetails": {
      "name": "Jane Doe",
      "accountIdentifications": [
        {
          "identification": "401016",
          "type": "SORT_CODE"
        },
        {
          "identification": "71518920",
          "type": "ACCOUNT_NUMBER"
        }
      ],
      "address": {
        "country": "GB"
      },
      "merchantId": "24589303",
      "merchantCategoryCode": "0742"
    },
    "amountDetails": {
      "amount": 10,
      "currency": "GBP"
    },
    "firstPaymentAmount": {
      "amount": 10,
      "currency": "GBP"
    },
    "nextPaymentAmount": {
      "amount": 10,
      "currency": "GBP"
    },
    "finalPaymentAmount": {
      "amount": 10,
      "currency": "GBP"
    },
    "previousPaymentAmount": {
      "amount": 10,
      "currency": "GBP"
    },
    "chargeDetails": [
      {
        "chargeAmount": {
          "amount": 10,
          "currency": "GBP"
        }
      }
    ],
    "refundAccount": {
      "accountIdentifications": [
        {
          "type": "SORT_CODE",
          "identification": "401016"
        }
      ]
    }
  }
}

Changes

No recorded changes to this operation across all 4 revisions of this API.