| Code | Meaning |
| INITIALIZED | 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. |
| CONFIRMABLE | The transfer request has been accepted and all transfer lines has been processed so that the transfer request confirmation step is available. |
| CONFIRMED | The transfer request has been confirmed. One cannot add additional transfer lines to the transfer request anymore. |
| REJECTED | The BPCE system has rejected all the lines (for a common cause). |
| DELETED | The subscriber has canceled the transfer request (all lines are canceled). |
type: string
enum:
- INITIALIZED
- CONFIRMABLE
- CONFIRMED
- REJECTED
- DELETED
readOnly: true
example: CONFIRMABLE
responses:
Unavailable:
description: Service Unavailable - HTTP 503.
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
Forbidden:
description: Forbidden - HTTP 403
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
NotImplemented:
description: Not Implemented - HTTP 501.
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
NoContent:
description: No content on response - HTTP 204
Unauthorized:
description: Unauthorized - HTTP 401
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
Unexpected:
description: Internal Server Error - HTTP 500.
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
BadRequest:
description: Bad Request - HTTP 400
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
examples:
closed source account:
value:
errors:
- code: bpce.accountDebtor
message: Le compte émetteur n'a pas été trouvé ou a été clôturé.
attribute: string
Refusal for confirming a transfer request due to delegation issue:
value:
errors:
- code: bpce.delegation.hasToBeDoneOnBankWebSite
message: le lot de virement doit être validé sur le site WEB de la Banque à Distance
NotFound:
description: Resource Not Found - HTTP 404
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
ForbiddenDueToRequiredStepup:
description: Forbidden - HTTP 403
headers:
X-StepUp-Token:
schema:
type: string
description: token for stepup process. This token must be passed in the xstepuptoken parameter of the next request (GET /stepup)
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
examples:
A stepup is required to do this action:
value:
errors:
- code: insufficientAuthLevel
message: Niveau d'authentification insuffisant
parameters:
After:
name: after
in: query
required: false
schema:
type: string
description: Cursor of the last element of the previous call. Used to get the next page. Default value point to the first element
transferRequestLineId:
name: transferRequestLineId
schema:
type: string
pattern: ^[0-9]{5}-[a-zA-Z0-9-]{1,100}$
in: path
example: 13807-0610601194-0610601195
required: true
description: Transfer request line identifier, i.e. transfer identifier.
PageSize:
name: pageSize
in: query
example: 50
required: false
schema:
type: integer
format: int32
description: Number of elements per page
transferRequestId:
name: transferRequestId
schema:
type: string
pattern: ^[0-9]{5}-[a-zA-Z0-9-]{1,100}$
in: path
example: 13807-0610601194
required: true
description: Transfer request identifier.
PageNumber:
name: pageNumber
in: query
example: 2
required: false
schema:
type: integer
format: int32
description: Number of the current page
securitySchemes:
oauth2-authorizationCodePKCE-moneyTransfer:
type: oauth2
flows:
authorizationCode:
scopes:
moneyTransfer.externalAccounts:READ: Scope for read External accounts
moneyTransfer.externalAccounts:WRITE: Scope for write External accounts
moneyTransfer.internalAccounts:READ: Scope for read Internal accounts
moneyTransfer.transferRequests:READ: Minimal scope for consultation of transfer requests
moneyTransfer.transferRequests:WRITE: Scope to create or modify transfer requests
moneyTransfer.transferRequests:DELETE: Scope to delete transfer requests.
moneyTransfer.transferRequests.confirmations:WRITE: Scope for transfer requests confirmations.
authorizationUrl: /api/oauth/authorize
refreshUrl: /api/oauth/refresh
tokenUrl: /api/oauth/token
description: ''
x-refined-from:
- moneytransfer-oas3-public-v1.1.1.json
- groupe-bpce-open-finance-transfer-openapi.yml