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.
Informations utiles :
Notre API est accessible depuis les URLs suivantes :
- api_url : https://pay.oxlin.io/v1/
- auth_url : https://pay.oxlin.io/token
Retrouvez la documentation de référence API via ce lien.
Ajouter un IBAN
Ajoutez un IBAN en liste blanche permet d’autoriser cet IBAN à être utilisé dans le produit Payments lors de la création d’ordre de virement :
- En mode bénéficiaire : Renseigner l’IBAN bénéficiaire des fonds.
- En mode payeur : Renseigner l’IBAN débiteur.
Si l’IBAN n’est pas préalablement enregistré en liste blanche, une erreur sera affichée lors de la création de l’ordre de virement.
Ajouter un IBAN en liste blanche en Sandbox
L’environnement de Sandbox est un environnement qui permet de simuler des virements sans effectuer de requêtes réelles vers les banques.
Pour cette raison, en mode Sandbox il est seulement possible d’utiliser des IBANs préenregistrés.
Ainsi en mode Sandbox, il n'est pas nécessaire d’ajouter d’IBAN en liste blanche. Veuillez directement utiliser les IBANs préenregistrés dans vos demandes de virement.
Cependant, il est possible de simuler l’ajout d’IBAN en Sandbox, pour cela veuillez utiliser les valeurs des IBANs préenregistrés :
IBAN 1, MY SANDBOX COMPANY (Société Générale)
- Type : Entreprise
- Nom de l’entreprise : MY SANDBOX COMPANY
- SIREN ou SIRET : 99999999999999
- Pays : France
- Titulaire du compte : MY SANDBOX COMPANY
- IBAN : FR8530003000307599775722N09
IBAN 2, E-Sofa (Crédit Agricole)
- Type : Entreprise
- Nom de l’entreprise : E-Sofa
- SIREN ou SIRET : 88888888888888
- Pays : France
- Titulaire du compte : E-Sofa
- IBAN : FR7611306000001212121212134
IBAN 3, E-Immo (LCL)
- Type : Entreprise
- Nom de l’entreprise : E-Immo
- SIREN ou SIRET : 77777777777777
- Pays : France
- Titulaire du compte : E-Immo
- IBAN : FR7630002268693434343434390
Simulez l’ajout d’un IBAN en Sandbox via une requête POST /authorized_accounts.
Voici l’exemple de l’ajout de l’IBAN “MY SANDBOX COMPANY”:
Base Url : POST https://pay.oxlin.io/v1/authorized_accounts
Requête:
curl --request POST --location 'https://pay.oxlin.io/v1/authorized_accounts' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer xxxxx \
--data '{
"identification": {
"schema": "SEPA",
"iban": "FR8530003000307599775722N09",
"name": "MY SANDBOX COMPANY"
},
"entity": {
"type": "COMPANY",
"company_name" : "MY SANDBOX COMPANY",
"country": "FR",
"national_identification": "99999999999999"
}
}'
Réponse :
{
"id": "99999999-ffff-9999-ffff-999999999999",
"service_level": "FULL",
"identification": {
"schema": "SEPA",
"iban": "FR8530003000307599775722N09",
"name": "MY SANDBOX COMPANY"
},
"entity": {
"type": "COMPANY",
"national_identification": "99999999999999",
"company_name": "MY SANDBOX COMPANY",
"country": "FR"
}
}
Ajouter un IBAN en liste blanche en production
Cette opération est à réaliser qu'une seule fois pour chaque nouvel IBAN qui doit être ajouté en liste blanche. Une fois l’IBAN enregistré, il peut être utilisé librement dans les ordres de virement.
Autorisez un IBAN en liste blanche via une requête POST /authorized_accounts.
Veuillez renseigner l’IBAN ainsi que les informations associées, telles qu’elles sont déclarées auprès de l’établissement bancaire.
Note: Si les informations déclarées pour l’IBAN ne correspondent pas à celles enregistrées auprès de la banque, le paiement risque d'être rejeté.
Deux entités sont disponibles pour déclarer le titulaire d’un IBAN :
- NATURAL PERSON : Pour les personnes physiques et entreprises individuelles.
- COMPANY : Pour les sociétés
Note: Pour une Entreprise Individuelle, veuillez utiliser l’entité “NATURAL PERSON” (personne physique) et déclarez l’entrepreneur.
Le champ “name” de la section identification doit respecter le format suivant : ^[a-zA-Z0-9 ,-]{1,140}$ (les accents ne sont pas acceptés).
Base Url : POST https://pay.oxlin.io/v1/authorized_accounts
Exemple requête “NATURAL PERSON”:
curl --request POST --location 'https://pay.oxlin.io/v1/authorized_accounts' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer xxxxx \
--data '{
"identification": {
"schema": "SEPA",
"iban": "FR8530003000307599775722M09",
"name": "nom titulaire iban"
},
"entity": {
"type": "NATURAL_PERSON",
"firstname": "prénom",
"surname": "nom",
"birth_date": "1970/01/01",
"birth_city": "Paris",
"birth_country": "fr"
}
}'
Exemple requête “COMPANY”:
curl --request POST --location 'https://pay.oxlin.io/v1/authorized_accounts' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer xxxxx \
--data '{
"identification": {
"schema": "SEPA",
"iban": "FR8530003000307599775722P09",
"name": "nom societe titulaire"
},
"entity": {
"type": "COMPANY",
"company_name" : "nom société",
"country": "FR",
"national_identification": "99999999999999"
}
}'
Retrouvez la documentation de référence API sur le POST /authorized_accounts via ce lien.
Modification d'un IBAN
La modification d'un Iban n'est pas possible, pour cela, il faudra supprimer et en créer un à nouveau.
La suppression se fait depuis une requête DELETE /authorized_accounts suivi de l'ID de l'Iban concerné.
Exemple requête :
curl --location --request DELETE 'https://pay.oxlin.io/v1//authorized_accounts/b3xxxxa1-3xxd-4xx0-9xx6-08xxxxx04eed' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer xxxx' \
--data ''
Afin de récupérer l'ID de l'Iban concerné, vous pouvez faire une requête GET /authorized_accounts
Exemple de requête :
curl --location --request GET 'https://pay.oxlin.io/v1/authorized_accounts' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer xxxx'
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