GRgroupebpce
Transfers

Create a transfer request

Create a transfer request. A transfer request contains one or several transfer request lines. Each transfer request line will be processed as a transfer.

post/transferRequests

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

transferRequestIdstring required

Identifier related to the transfer request

transferRequestStatus'INITIALIZED' | 'CONFIRMABLE' | 'CONFIRMED' | 'REJECTED' | 'DELETED' required

State of the transfer request. This state is useful to follow and manage a transfer request only during the entry phase. Once confirmed, rejected or canceled, the transfer request is in a terminal state and will not change, so that it is the state of the transfer request line one must then examinate to know if a transfer have been well processed or not.<table><tr><td>Code</td> <td>Meaning</td></tr><tr><td>INITIALIZED</td> <td>The transfer request has been accepted but all transfer lines has not been processed so that the transfer request confirmation step is not yet available.</td></tr><tr><td>CONFIRMABLE</td> <td>The transfer request has been accepted and all transfer lines has been processed so that the transfer request confirmation step is available.</td></tr><tr><td>CONFIRMED</td> <td>The transfer request has been confirmed. One cannot add additional transfer lines to the transfer request anymore.</td></tr><tr><td>REJECTED</td> <td>The BPCE system has rejected all the lines (for a common cause).</td></tr><tr><td>DELETED</td> <td>The subscriber has canceled the transfer request (all lines are canceled).</td></tr></table>

transfersCountinteger required

Number of transfers included in this request.

creationDateTimestring date-time required

Date and time of creation for the request.

modificationDateTimestring date-time

Date and time of modification for the request.

requestedDebitMode'SINGLE' | 'GROUPED'

Indicates how the caller wishes the set of transfer request lines to be debited from the source account ; that is if there should be only one global accounting entry with the global amount or alternatively there should be n single transfers (one accounting entry for one transfer request line). <table><tr><td>Code</td> <td>Meaning</td></tr><tr><td>GROUPED</td> <td>One global accounting entry with the global amount.</td></tr><tr><td>SINGLE</td> <td>One accounting entry for each transfer request line.</td></tr></table>

Example request

{
  "transferRequestId": "13807-0610601194",
  "globalAmount": {
    "value": 517.14,
    "currencyCode": "EUR"
  },
  "transferRequestStatus": "CONFIRMABLE",
  "transfersCount": 5,
  "creationDateTime": "2024-04-23T13:56:23+01:00",
  "modificationDateTime": "2024-04-23T13:56:23+01:00",
  "requestedDebitMode": "GROUPED",
  "globalFee": {
    "value": 517.14,
    "currencyCode": "EUR"
  },
  "lines": [
    {
      "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 entry phase is completed and the status of the transfer request can go directly to CONFIRMABLE state.

transferRequestIdstring required

Identifier related to the transfer request

transferRequestStatus'INITIALIZED' | 'CONFIRMABLE' | 'CONFIRMED' | 'REJECTED' | 'DELETED' required

State of the transfer request. This state is useful to follow and manage a transfer request only during the entry phase. Once confirmed, rejected or canceled, the transfer request is in a terminal state and will not change, so that it is the state of the transfer request line one must then examinate to know if a transfer have been well processed or not.<table><tr><td>Code</td> <td>Meaning</td></tr><tr><td>INITIALIZED</td> <td>The transfer request has been accepted but all transfer lines has not been processed so that the transfer request confirmation step is not yet available.</td></tr><tr><td>CONFIRMABLE</td> <td>The transfer request has been accepted and all transfer lines has been processed so that the transfer request confirmation step is available.</td></tr><tr><td>CONFIRMED</td> <td>The transfer request has been confirmed. One cannot add additional transfer lines to the transfer request anymore.</td></tr><tr><td>REJECTED</td> <td>The BPCE system has rejected all the lines (for a common cause).</td></tr><tr><td>DELETED</td> <td>The subscriber has canceled the transfer request (all lines are canceled).</td></tr></table>

transfersCountinteger required

Number of transfers included in this request.

creationDateTimestring date-time required

Date and time of creation for the request.

modificationDateTimestring date-time

Date and time of modification for the request.

requestedDebitMode'SINGLE' | 'GROUPED'

Indicates how the caller wishes the set of transfer request lines to be debited from the source account ; that is if there should be only one global accounting entry with the global amount or alternatively there should be n single transfers (one accounting entry for one transfer request line). <table><tr><td>Code</td> <td>Meaning</td></tr><tr><td>GROUPED</td> <td>One global accounting entry with the global amount.</td></tr><tr><td>SINGLE</td> <td>One accounting entry for each transfer request line.</td></tr></table>

Example response

{
  "transferRequestId": "13807-0610601194",
  "globalAmount": {
    "value": 517.14,
    "currencyCode": "EUR"
  },
  "transferRequestStatus": "CONFIRMABLE",
  "transfersCount": 5,
  "creationDateTime": "2024-04-23T13:56:23+01:00",
  "modificationDateTime": "2024-04-23T13:56:23+01:00",
  "requestedDebitMode": "GROUPED",
  "globalFee": {
    "value": 517.14,
    "currencyCode": "EUR"
  }
}

Changes

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