Transfers

Add additional transfers within a transfer request

Add transfer lines into a transfer request. The transfer request must not have been confirmed yet.

post/transferRequests/{transferRequestId}/transferRequestLines

Request

  • Base URL
    https://api.groupebpce.com/retail/moneyTransfer/v1
  • Auth
    OAuth 2
    Authorization code: /api/oauth/authorize
    Token URL: /api/oauth/token scopes: moneyTransfer.transferRequests:WRITE

Request body

Example request

{
  "transfers": [
    {
      "transferRequestLineId": "13807-0656574820",
      "transferRequestId": "13807-0656574819",
      "amount": {
        "value": 517.14,
        "currencyCode": "EUR"
      },
      "creationDateTime": "2024-04-30T17:35:00Z",
      "status": "EXECUTED",
      "frequencyType": "ONESHOT",
      "requestedExecutionDate": "2024-04-30",
      "executionDate": "2024-05-03",
      "remittanceInformation": "Mon reglement de facture urgente pour juin",
      "sourceAccount": "13807-2-196717-0000001-00000992-5ab5f5df2ed9f5a224952e23adccc37ca9a09c9b23493916720e78295f69e790",
      "recipientAccount": "13807-2-196717-0000001-00000992-5ab5f5df2ed9f5a224952e23adccc37ca9a09c9b23493916720e78295f69e790",
      "debitEntry": {
        "amount": {
          "value": 517.14,
          "currencyCode": "EUR"
        },
        "debitMode": "GROUPED"
      },
      "executionDeadlineType": "DELAYED",
      "executionSettlement": "SEPA",
      "reasonLabel": "Facture plombier",
      "forecastedExecutionDate": "2024-05-02",
      "allTheWayToRecipientInformation": {
        "endToEndReference": "FACT2024-948786",
        "categoryPurposeType": "CASH"
      },
      "standingTransfer": {
        "frequency": "MONTHLY",
        "startDate": "2024-02-02",
        "endDate": "2024-11-02",
        "lastExecutionDate": "2024-05-02"
      },
      "fee": {
        "value": 517.14,
        "currencyCode": "EUR"
      }
    }
  ]
}

Response

Created. The response is a list of TransferRequestLines

Example response

{
  "transfers": [
    {
      "transferRequestLineId": "13807-0656574820",
      "transferRequestId": "13807-0656574819",
      "amount": {
        "value": 517.14,
        "currencyCode": "EUR"
      },
      "creationDateTime": "2024-04-30T17:35:00Z",
      "status": "EXECUTED",
      "frequencyType": "ONESHOT",
      "requestedExecutionDate": "2024-04-30",
      "executionDate": "2024-05-03",
      "remittanceInformation": "Mon reglement de facture urgente pour juin",
      "sourceAccount": "13807-2-196717-0000001-00000992-5ab5f5df2ed9f5a224952e23adccc37ca9a09c9b23493916720e78295f69e790",
      "recipientAccount": "13807-2-196717-0000001-00000992-5ab5f5df2ed9f5a224952e23adccc37ca9a09c9b23493916720e78295f69e790",
      "debitEntry": {
        "amount": {
          "value": 517.14,
          "currencyCode": "EUR"
        },
        "debitMode": "GROUPED"
      },
      "executionDeadlineType": "DELAYED",
      "executionSettlement": "SEPA",
      "reasonLabel": "Facture plombier",
      "forecastedExecutionDate": "2024-05-02",
      "allTheWayToRecipientInformation": {
        "endToEndReference": "FACT2024-948786",
        "categoryPurposeType": "CASH"
      },
      "standingTransfer": {
        "frequency": "MONTHLY",
        "startDate": "2024-02-02",
        "endDate": "2024-11-02",
        "lastExecutionDate": "2024-05-02"
      },
      "fee": {
        "value": 517.14,
        "currencyCode": "EUR"
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.