Skip to main content
GET
https://sandbox-api.caurisflux.com/api/v1
/
payouts
/
reference
/
purposes
Motifs de transfert
curl --request GET \
  --url https://sandbox-api.caurisflux.com/api/v1/payouts/reference/purposes \
  --header 'X-API-Key: <api-key>'
Récupère les motifs de paiement disponibles pour un corridor spécifique.
Le motif (purpose) est requis pour les payouts internationaux.
Cet endpoint ne nécessite pas d’authentification.

​
Paramètres de requête

ParamètreTypeRequisDescription
sourceCountrystringOuiPays source (ISO 2)
destinationCountrystringOuiPays destination (ISO 2)

​
Requête

curl "https://sandbox-api.caurisflux.com/api/v1/payouts/reference/purposes?sourceCountry=SN&destinationCountry=FR"

​
Réponse

{
  "purposes": [
    {
      "code": "SALARY",
      "label": "Salaire",
      "description": "Paiement de salaire ou rémunération"
    },
    {
      "code": "INVOICE",
      "label": "Facture",
      "description": "Paiement de facture fournisseur"
    },
    {
      "code": "SERVICES",
      "label": "Services",
      "description": "Paiement pour services rendus"
    },
    {
      "code": "GOODS",
      "label": "Marchandises",
      "description": "Achat de marchandises"
    },
    {
      "code": "FAMILY_SUPPORT",
      "label": "Aide familiale",
      "description": "Transfert d'argent à la famille"
    },
    {
      "code": "EDUCATION",
      "label": "Éducation",
      "description": "Frais de scolarité ou formation"
    },
    {
      "code": "OTHER",
      "label": "Autre",
      "description": "Autre motif"
    }
  ]
}

​
Champs de réponse

ChampTypeDescription
codestringCode à utiliser dans le payout
labelstringLibellé affiché
descriptionstringDescription du motif

​
Utilisation

Utilisez le code dans le champ international.purpose lors de la création d’un payout international : 
{
  "international": {
    "destinationCountry": "FR",
    "destinationCurrency": "EUR",
    "purpose": "SALARY"
  }
}