GRgroupebpce
Transfers

Get a transfer request line with details

Get a transfer request line with details.

get/transferRequests/{transferRequestId}/transferRequestLines/{transferRequestLineId}

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:READ

Response

OK - Details of the transfer in the request.

transferRequestLineIdstring required

Identifier of a transfer request line.

transferRequestIdstring required

Identifier of a transfer request within the transfer request line is embedded.

creationDateTimestring date-time

Timestamp of transfer request creation

status'TO_VALIDATE' | 'VALIDATED' | 'WAITING_DECISION' | 'PENDING' | 'REFUSED' | 'CANCELED' | 'REJECTED' | 'EXECUTED' | 'REFUNDED' | 'TERMINATED' | 'REJECTED_BY_RECIPIENT_BANK_AND_REFUNDED' required

Transfer processing status (i.e. a transfer request line status).<table><tr><td> Status </td> <td> Meaning </td></tr> <tr><td>TO_VALIDATE</td> <td>Needs to be validated.</td></tr><tr><td>VALIDATED</td> <td>Validated by the subscriber or by an authorized validator.</td></tr><tr><td>WAITING_DECISION</td> <td>Waiting for a decision.</td></tr><tr><td>PENDING</td> <td>Waiting for execution.</td></tr><tr><td>REFUSED</td> <td>Refused.</td></tr><tr><td>CANCELED</td> <td>Canceled by the subscriber.</td></tr><tr><td>REJECTED</td> <td>Rejected by the system.</td></tr><tr><td>EXECUTED</td> <td>Executed.</td></tr><tr><td>REFUNDED</td> <td>Refunded.</td></tr><tr><td>TERMINATED</td> <td>Terminated.</td></tr><tr><td>REJECTED_BY_RECIPIENT_BANK_AND_REFUNDED</td> <td>Transfer that has been rejected by the beneficiary bank and so the transfer request line is refunded in an individual way.</td></tr></table>

frequencyType'ONESHOT' | 'STANDING' required

Indicates if a transfer will be processed only one time or if it is a standing transfer.<table><tr><td>Code</td> <td>Meaning</td></tr><tr><td>ONESHOT</td> <td>The transfer will be processed only one time</td></tr><tr><td>STANDING</td> <td>The transfer will be processed several times in a periodic way</td></tr></table>

requestedExecutionDatestring date

Requested execution date of the transfer. Significant if executionDeadlineType is DELAYED.

executionDatestring date

Date of execution of the transfer.

remittanceInformationstring required

Reason for transfer, transmitted to the recipient

sourceAccountstring required

Identifier of an account.

recipientAccountstring required

Identifier of an account.

executionDeadlineType'INSTANT' | 'ASAP' | 'DELAYED' required

Execution delay type. <table><tr><td>Code</td> <td>Meaning</td></tr><tr><td>INSTANT</td> <td>Within the minute (instant payment).</td></tr><tr><td>ASAP</td> <td>=As soon as possible (today). The transfer request lines may be processed in the following days.</td></tr><tr><td>DELAYED</td> <td>For a date in the future.</td></tr></table>

executionSettlement'INTERNAL' | 'SEPA' required

Type of transfer processing chain used.<table><tr><td>Code</td> <td>Meaning</td></tr><tr><td>INTERNAL</td> <td>Between two internal accounts belonging to the subscriber and managed by the same BPCE bank establishment.</td></tr><tr><td>SEPA</td> <td>SCT Transfer using the SEPA scheme.</td></tr></table>

reasonLabelstring

Reason label in the transfer historic view in the bank web site

forecastedExecutionDatestring date

Execution date planned for the execution of the transfer (but not contractual)

economicReasonLabelstring

Economic reason code (mandatory if very high amount)

Example response

{
  "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.