Transfers (obsolete)
The Pay product should be preferred to these services as it handles PSD2-compliant use-cases.
API endpoints
Authentication: endpoints listed in this page require header authentication with a user token.
List recipients
GET https://{domain}.biapi.pro/2.0/users/{userId}/recipients
Path Parameters
Response body: RecipientsList object
List recipient categories
GET https://{domain}.biapi.pro/2.0/users/{userId}/recipientCategories
Path Parameters
Response body: RecipientCategoriesList object
Add a recipient
POST https://{domain}.biapi.pro/2.0/users/{userId}/accounts/{accountId}/recipients
Request body: RecipientCreationRequest object
Path Parameters
Response body: Recipient object
Update a recipient
POST https://{domain}.biapi.pro/2.0/users/{userId}/accounts/{accountId}/recipients/{recipientId}
Request body: Key-value object build from the requested fields.
Path Parameters
Response body: Recipient object
Create a transfer
POST https://{domain}.biapi.pro/2.0/users/{userId}/transfers
Request body: TransferCreationRequest object
Path Parameters
Response body: Transfer object
List transfers
GET https://{domain}.biapi.pro/2.0/users/{userId}/transfers
Path Parameters
Response body: TransfersList object
Get a transfer
GET https://{domain}.biapi.pro/2.0/users/{userId}/transfers/{transferId}
Get a single transfer by ID.
Path Parameters
Response body: Transfer object
Update a transfer
POST https://{domain}.biapi.pro/2.0/users/{userId}/transfers/{transferId}
Request body: TransferUpdateRequest object
Path Parameters
Response body: Transfer object
Data model
RecipientsList object
Recipient object
RecipientState values
RecipientCategoriesList object
RecipientCreationRequest object
TransferCreationRequest object
BeneficiaryType values
Transfer object
TransferState values
TransferValidateMechanism values
TransfersList object
TransferUpdateRequest object
To validate a transfer using the credentials mechanism, you must include in the request the values from the connector fields.
Last updated