API docs by Redocly

DGCPT PAY API (1.0.0)

Download OpenAPI specification:Download

"DGCPT PAY API : L'ensembles des services de paiements au profit de l'état, ainsi toutes les organisations du service public peuvent utiliser ce service pour effectuer des paiements. L'agrégateur de paiement sert généralement d'intermédiaire entre les services tiers et les prestataires de services de paiement, facilitant les transactions et fournissant divers services liés au traitement des paiements à l'aide d'une plateforme unifiée et permet de ne pas avoir à établir de relations de paiement individuelles avec différentes institutions financières."

PAY API

Dgcpt Paiement API

Récuperer les moyens des paiements de paiement disponibles pour l'organisation

Authorizations:
bearerAuth
header Parameters
X-ORGANISATION-API-KEY
required
string

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "httpCode": 0,
  • "message": "string",
  • "object": {
    },
  • "retourType": "ERROR"
}

Récuperer les moyens des paiements de paiement disponibles

Authorizations:
bearerAuth
header Parameters
X-ORGANISATION-API-KEY
required
string

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "httpCode": 0,
  • "message": "string",
  • "object": {
    },
  • "retourType": "ERROR"
}

Effectuer un paiement au profit d'une organisation

Authorizations:
bearerAuth
header Parameters
X-ORGANISATION-API-KEY
required
string
Request Body schema: application/json
required

payRequest

required
object (DgcptAmountDTO)
object (DgcptPayMetaDataDTO)
natureRecette
required
string
codeOrganisation
required
string
partnerTransactionId
string
object (DgcptPayBankDTO)
object (DgcptPayCallback)
payCaller
string
Enum: "PARTNER" "DGCPT" "ORGANISATION"
Array of objects (DgcptPayDetailsDTO)
object (DgcptPayMobileDTO)
object (DgcptPayOptionDTO)
object (DgcptPayUsagerAssosDTO)
object (DgcptPayUsagerPartDTO)
object (DgcptPayUsagerProDTO)

Responses

Request samples

Content type
application/json
{
  • "dgcptAmount": {
    },
  • "metaData": {
    },
  • "natureRecette": "string",
  • "codeOrganisation": "string",
  • "partnerTransactionId": "string",
  • "payBank": {
    },
  • "payCallback": {
    },
  • "payCaller": "PARTNER",
  • "payDetails": [
    ],
  • "payMobile": {
    },
  • "payOptions": {
    },
  • "usagerAssos": {
    },
  • "usagerPart": {
    },
  • "usagerPro": {
    }
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "httpCode": 0,
  • "message": "string",
  • "object": {
    },
  • "retourType": "ERROR"
}

Récuperer les informations d'une transaction de paiement en fonction de l'identifiant de l'organisation

Authorizations:
bearerAuth
path Parameters
partnerTransactionId
required
string

partnerTransactionId

header Parameters
X-ORGANISATION-API-KEY
required
string

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "httpCode": 0,
  • "message": "string",
  • "object": {
    },
  • "retourType": "ERROR"
}

Récuperer les informations d'une transaction de paiement en fonction de l'identifiant fourni par la DGCPT

Authorizations:
bearerAuth
path Parameters
transactionId
required
string

transactionId

header Parameters
X-ORGANISATION-API-KEY
required
string

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "httpCode": 0,
  • "message": "string",
  • "object": {
    },
  • "retourType": "ERROR"
}

Récuperer les informations de toutes les transactions en fonction des critères de recherche

Authorizations:
bearerAuth
query Parameters
codeNatureRecette
string
count
integer <int32>
endDate
string
externalTransactionId
string
itemCount
integer <int32>
mois
string
Enum: "JANVIER" "FEVRIER" "MARS" "AVRIL" "MAI" "JUIN" "JUILLET" "AOUT" "SEPTEMBRE" "OCTOBRE" "NOVEMBRE" "DECEMBRE"
montantMax
number
montantMin
number
organizationId
string
pageNumber
integer <int32>
pageSize
integer <int32>
startDate
string
transactionStatus
string
transactionType
string
header Parameters
X-ORGANISATION-API-KEY
required
string

Responses

Response samples

Content type
application/json
{
  • "pageInfo": {
    },
  • "resultList": [
    ]
}

IDENTITY MANAGEMENT API

getJwtToken

Obtain a JWT token using basic authentication.

header Parameters
X-ORGANISATION-API-KEY
required
string
X-ORGANISATION-API-SECRET
required
string
Request Body schema: application/x-www-form-urlencoded
required

body

username
required
string
password
required
string
grant_type
required
string

Responses

Response samples

Content type
application/json
{
  • "access_token": "string",
  • "token_type": "string",
  • "expires_in": 0,
  • "refresh_token": "string",
  • "scope": "string"
}

CALLBACK API

Création sa ressource de callback lors d'un paiement non instantané

Authorizations:
bearerAuth
header Parameters
X-ORGANISATION-API-KEY
required
string
Request Body schema: application/json
required

L'objet callback contenant l'url de création d'un calback

endpoint
string
dateCreation
string

Responses

Request samples

Content type
application/json
{
  • "endpoint": "string",
  • "dateCreation": "dd/MM/yyyy HH:mm:ss"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "httpCode": 0,
  • "message": "string",
  • "object": { },
  • "retourType": "ERROR"
}

Modification de sa ressource de callback lors d'un paiement non instantané

Authorizations:
bearerAuth
header Parameters
X-ORGANISATION-API-KEY
required
string
Request Body schema: application/json
required

L'objet callback contenant l'url de création d'un calback

endpoint
string
dateCreation
string

Responses

Request samples

Content type
application/json
{
  • "endpoint": "string",
  • "dateCreation": "dd/MM/yyyy HH:mm:ss"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "httpCode": 0,
  • "message": "string",
  • "object": { },
  • "retourType": "ERROR"
}

HEALTHCHECK API

Vérifie l'état de santé de l'API

Cette méthode retourne un statut indiquant si l'API est opérationnelle.

Responses

Response samples

Content type
application/json
{
  • "status": "OK"
}