L'API Payments permet d’intégrer facilement une solution de paiement sécurisée par virement simplifié (instantané ou classique) directement dans vos applications métiers. Utilisez notre API pour fluidifier et sécuriser votre parcours client, tout en facilitant le suivi de vos paiements.
Dans cet article, vous trouverez des informations pour découvrir les fonctionnalités de notre API Payments.
Pourquoi utiliser un alias ?
Vous pouvez utiliser des alias lorsque vous ne souhaitez pas que les IBANs de vos bénéficiaires ou payeurs apparaissent dans les requêtes et réponses de l’API Payments. A la place l’alias sera utilisé, pour cela vous devez créer un alias qui fera référence à un IBAN.
Gérer les alias
Vous pouvez créer, modifier, consulter et supprimer vos alias depuis l’API Payments ou le Dashboard Payments.
Retrouvez la documentation de référence API sur les alias via ce lien.
Créer un alias via API
L’alias peut être utilisé en tant que référence bénéficiaire ou payeur.
Créez un alias via une requête POST /alias et obtenez en réponse l’id faisant référence à l’alias créé.
Base Url : POST https://pay.oxlin.io/v1/alias
Exemple requête :
curl --request POST --location 'https://pay.oxlin.io/v1/alias \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer xxxxx \
--data '{
"user_reference": "fake-iban-company-ref",
"label": "fake iban company",
"account": {
"schema": "SEPA",
"iban": "FR8530003000307599775722P09"
}
}'
Exemple réponse :
{
"id": "5d093479-751e-40cc-84e8-e33caa4dd176",
"user_reference": "fake-iban-company-ref",
"label": "fake iban company",
"account": {
"schema": "SEPA",
"iban": "FR8530003000307599775722P09"
}
}
Si vous utilisez la licence Oxlin et que vous souhaitez utiliser l’alias comme référence à un bénéficiaire :
La création de l’IBAN bénéficiaire doit absolument être réalisée avant la création de l’alias. Lors de la création de l’alias, le nom du titulaire de compte (champ label) et l’IBAN doivent être identiques à ceux renseignés pour le bénéficiaire correspondant.
Créer un ordre de paiement avec alias via API
Une fois l’alias créé, vous pouvez l’utiliser en tant que bénéficiaire ou payeur dans vos demandes d’ordres de paiement. Pour cela, dans la requête POST /orders utilisez l’id qui a été généré lors de la création de l’alias en remplacement de l’IBAN habituellement utilisé et préciser le schéma “ALIAS”.
Base Url : POST https://pay.oxlin.io/v1/orders
Exemple requête :
curl --request POST --location 'https://pay.oxlin.io/v1/orders' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer xxxxx \
--data-raw '{
"user_reference": "my user ref",
"instant_payment": "USER_CHOICE",
"redirect_url": "https://www.example.com/",
"amount": "10",
"currency": "EUR",
"email": "user@example.com",
"beneficiary":
{
"schema": "ALIAS",
"alias_id": "cf951602-28ee-4b69-8790-78aadc1edbd8"
},
"label": "transaction label"
}'
Retrouvez la documentation de référence API sur le POST /orders via ce lien.
NB : Les alias ne sont pas disponibles lors de la création d’ordre via le Dashboard.
Ces informations ont-elles répondu à votre question ?
Si vous rencontrez des difficultés, n'hésitez pas à contacter notre équipe Support via ce lien.