Skip to main content
POST
Enrôler une carte bancaire
Cet appel rattache une carte bancaire supplémentaire à un usager existant. Pour le premier instrument d’un nouvel usager, utilisez plutôt l’enrôlement d’usager.

Champs requis selon le type de carte

Quatre champs sont exigés dans tous les cas — refUsager, refContributeurDemandeur, refContributeurEmetteur et typeCarteBancaire. Les autres dépendent du type de carte :
Le schéma OpenAPI marque codeClient, pan, cvv et dateExpiration comme facultatifs, car aucun n’est requis pour tous les types. La combinaison réellement attendue est celle du tableau ci-dessus.

Format des données de carte

Ne journalisez jamais le pan complet ni le cvv, que ce soit côté serveur ou dans les traces de votre application. GIMpay ne retourne d’ailleurs qu’un PAN masqué en lecture, et le cvv est systématiquement nul dans les réponses.

Points de vigilance

Ce sont les deux seules valeurs du contrat GIMgar Sud. Voir le glossaire.Une valeur CREDIT apparaît dans le suivi d’implémentation du SDK Flutter mais ne figure ni dans la spécification technique v1.1, ni dans le schéma OpenAPI servant le playground ci-dessous. Écart non arbitré — ne vous appuyez pas dessus sans confirmation de GIM.
Le contrat ne prévoit pas de champ pour le réseau (schema) : typeCarteBancaire porte le mode de fonctionnement de la carte, pas son réseau d’acceptation.

Réponses

Le corps utile arrive dans body, à l’intérieur de l’enveloppe commune { message, status, body, timestamp }, et contient refInstrumentPaiement ainsi que le PAN sous forme masquée.

Et ensuite ?

Vérifier les droits de la carte

GET /wallets/{referenceWallet}/authorization

Exécuter une opération

Utilisez cette carte comme instrument initiateur.

Authorizations

Authorization
string
header
required

Jeton émis par POST /api/v1/auth/token.

Body

application/json

Champs conditionnels selon typeCarteBancaire : PREPAYEE → seul codeClient est requis (pan, cvv, dateExpiration interdits) ; DEBIT/CREDIT → pan, cvv et dateExpiration sont requis (codeClient interdit).

refContributeurDemandeur
string
required

La référence du contributeur demandeur qui demande l'enrôlement de l'instrument de paiement

refContributeurEmetteur
string
required

La référence du contributeur émetteur de l'instrument de paiement à enrôler

refUsager
string
required

La reference de l'usager

typeCarteBancaire
enum<string>
required
Available options:
DEBIT,
CREDIT,
PREPAYEE
codeClient
string

Requis pour PREPAYEE.

pan
string

13 à 19 chiffres. Requis pour DEBIT/CREDIT.

cvv
string

Requis pour DEBIT/CREDIT.

dateExpiration
string

Requis pour DEBIT/CREDIT.

Pattern: MM/yyyy

Response

Carte enrôlée.

Enveloppe standard de toutes les réponses (sauf auth).

message
string

Message technique décrivant le résultat de l'appel.

status
integer

Code de statut HTTP de la réponse.

timestamp
string<date-time>

Horodatage de la réponse.

body
object