GRgroupebpce
Transfers

Confirm a transfer request

Confirm a transfer request. The entry phase is over with calling this endpoint. At first call of this endpoint, a strong authentication may be generally demanded in order to seal the transfer. So an HTTP error 403 is returned at first call with presence of a HTTP header called "X-Stepup-Token". In this case, the consumer must forward to "BPCE_CONNECT" urls to enter into a stepup process. After that, a second call of this endpoint will be possible and needed to really do the confirmation of the transfer request. In particular and rare cases, besides the confirmation of the transfer request is necessary, it is not allowed at all via this API ; in this case, an HTTP 400 error with code "bpce.delegation.hasToBeDoneOnBankWebSite" indicates the end user customer to validate the transfer within the BPCE web site.

post/transferRequests/{transferRequestId}/confirmations

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.confirmations:WRITE

Response

Confirmation of the transfer. The request goes into CONFIRMED status. It is no longer possible to modify the request (by adding lines for example).

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.