API Reference Copy section link Copied!
Welcome to the API Reference page.
We are currently setting up our Github account, in the meantime, you can:
- Click here to access the solution's swagger
- Click here to access the Authentication swagger
/token Copy section link
Ask for a token
Request
Submit a token request.
grant_type
to be valued by 'client_credentials'
scope
to be valued by 'openid'
Response
Token successful
accessToken
The bearer access token. To consume API Agorapay Ressource, the marketplace should send the access_token directly in the Authorization request header.
scope
APIM scope.
id_token
The marketplace token. To consume API Agorapay Ressource, the marketplace should send the access_token directly in the Authorization request header.
token_type
Token type.
expires_in
The token validity periods (3600 seconds max).
curl 'https://API_URL/token' \ -H 'Authorization: Bearer <your_access_token>' \ -H 'id_token: <your_id_token>' \
-d 'grant_type=client_credentials' \
-d 'scope=openid'
{
"access_token": "74800866-1dda-35fa-b017-2351b76255b",
"scope": "am_application_scope openid",
"id_token": "eyJ4NXQiOiJNVFptT1daaU1HSTBZVGxpWVRaaE5UWXdOR0kxT0dGbE9UTTVPR1ZpWldZME0yWmlPV1ZtWVEiLCJraWQiOiJNVFptT1daaU1HSTBZVGxpWVRaaE5UWXdOR0kxT0dGbE9UTTVPR1ZpWldZME0yWmlPV1ZtWVEiLCJhbGciOiJSUzI1NiJ9.eyJhdF9oYXNoIjoieW40VF9aOTM3S09iWWxGOTlVTVdCUSIsImFjciI6InVybjptYWNlOmluY29tbW9uOmlhcDpzaWx2ZXIiLCJhdWQiOlsibVZKTEs4T21ab2dKRnRuWG1mZjlTQ0lKUVp3YSJdLCJhenAiOiJtVkpMSzhPbVpvZ0pGdG5YbWZmOVNDSUpRWndhIiwiaXNzIjoiaHR0cHM6XC9cL2hvbS1pcy5jYS1jZWRpY2FtLmZyOjk0NDRcL29hdXRoMlwvdG9rZW4iLCJleHAiOjE2MzQxMzcxMzEsImlhdCI6MTYzNDEzMzUzMX0.Xovs8vGs4H59f0F4NZb7DEuYiE37pb09HdowUax3ZU7PSUxde3Tis6kEIAjcHBg9Inee8mt9Lq2dbHvamNsGoYso1v6FWVrkPP2jjVTUm7kuh8xKslkfdUIuZGqtEoHsdF--qEFnlaiSR8iR8nLD0_T6unHNWWO8kXO4Y8vbbx2R0OGh5dElqxXYvsWtqBFe32Ds4XjJcmeeAlCj86oBXTlVxqwXEHsk8qSKXci2VJHhfgQBfzvU3xek7TRq9vbwIU1Dmja2XM6Q6a4l4nbF6D9Jb9I1XtEfr7I2_4ubvMAHOGRkicsNJfn0-DFehEbCC0Fqx8CyoblkNLP2bTQsa",
"token_type": "Bearer",
"expires_in": 3600
}
/payin/adjustPayment Copy section link
Adjust the amount of the payment/ change the breakdown of the payment
Before the cashing of the operation, change the payment amount and/or the breakdown
If it's only a change in the breakdown, set the adjustAmount to the same of the transactionAmount
Request
All request data are embedded in a json structure in the body
The request to change the amount or submit a new breakdown list
breakdownList
List of breakdown
amount
amount information
value
The value of the amount in decimal with max 2 digits after separator.
Only digits and dot are authorized.
currency
the currency iso code of the amount with 3 characters
sellerAccountNumber
Account number of the merchant or marketplace.
label
Label for the breakdown. Maximum 30 characters
commission
Commission information
amount
Amout of the commission in the currency of the order with two decimal maximum
account
Commission accountNumber
metaData
JSON data for the marketplace. This data is not used by payment systems.
adjustAmount
Amount to ajust. Must be absent for payment type card.
Mandatory if the amount is different than the initial payment.
value
The value of the amount in decimal with max 2 digits after separator.
Only digits and dot are authorized.
currency
the currency iso code of the amount with 3 characters
orderId
Order id obtained in order creation
transactionId
Id of the payment transaction.
Response
Before the cashing of the operation, change the payment amount and/or the breakdown If it's only a change in the breakdown, set the adjustAmount to the same of the transactionAmount
New amount and/ord breakdown successfully submitted
Adjust amount or breakdown list response
resultCode
API operation result. This code is 0 in case of success.
If resultCode is not 0, the operation fails.
In this case, a resultCodeMessage describe the reason of failure.
resultCodeMessage can be absent if no reason is provided for the resultCode.
resultCodeMessage
The failure description. The message can be used to understand
the failure reason. It must be transmitted to support for diagnostic.
curl 'https://API_URL/mkp/v1/payin/adjustPayment' \ -H 'Authorization: Bearer <your_access_token>' \ -H 'id_token: <your_id_token>' \ -H 'Content-Type: application/json' \ --data-raw \
{
"orderId": "1354657",
"adjustAmount": {
"value": "100",
"currency": "EUR"
},
"breakdownList": [
{
"label": "bdl1",
"transactionRef": "ref1",
"sellerAccountNumber": "1300600000EUR01006110",
"amount": {
"value": "35",
"currency": "EUR"
}
},
{
"label": "bdl2",
"transactionRef": "ref2",
"sellerAccountNumber": "1300600000EUR01007110",
"amount": {
"value": "65",
"currency": "EUR"
}
}
]
}
{
"resultCode": "0"
}
/payin/cancel Copy section link
Cancel a Transaction/Order
Cancel a payment transaction or all the payment transactions of an order
Request
The minimal set of properties required to perform a cancel
orderId
Order id obtained when the payment was made and the order was created.
transactionId
Id of the payment transaction.
metaData
JSON data for the marketplace. This data is not used by payment systems.
Response
Cancel a payment transaction or all the payment transactions of an order
Cancelation Done
Cancel response
resultCode
resultCode of the processing
API operation result. This code is 0 in case of success.
If resultCode is not 0, the operation fails.
In this case, a resultCodeMessage describe the reason of failure.
resultCodeMessage can be absent if no reason is provided for the resultCode.
orderStatus
Status of an order. the following status can be provided:
- created: The order is created
- pendingpayment: Payment in progress
- complete: Payment is completed
- partialcomplete: Payment is completed but all order amount is not payed
- canceled: The order is canceled
transactionList
List of transaction for the order
paymentMethodId
id of the payment Method used for the transaction
List of transaction for the order
id
List of transaction for the order
status
List of transaction for the order
amount
amount of the transaction
List of transaction for the order
value
The value of the amount in decimal with max 2 digits after separator.
Only digits and dot are authorized.
currency
the currency iso code of the amount with 3 characters
type
List of transaction for the order
resultCodeMessage
The failure description. The message can be used to understand
the failure reason. It must be transmitted to support for diagnostic.
curl 'https://API_URL/mkp/v1/payin/cancel' \ -H 'Authorization: Bearer <your_access_token>' \ -H 'id_token: <your_id_token>' \ -H 'Content-Type: application/json' \ --data-raw \
{
"orderId": "432156",
"transactionId": "123456789"
}
{
"resultCode": "0",
"orderStatus": "complete",
"transactionList": [
{
"id": "123123123",
"status": "completed",
"amount": {
"value": "100",
"currency": "EUR"
},
"paymentMethodId": "002"
}
]
}
/payin/capture Copy section link
Capture an already authorized operation
Capture a payment transaction or all the capturable payment transactions of an order
Request
The minimal set of properties required to perform a capture
orderId
Order id obtained in order creation
transactionAmount
Capture amount
amount information
value
The value of the amount in decimal with max 2 digits after separator.
Only digits and dot are authorized.
currency
the currency iso code of the amount with 3 characters
metaData
JSON data for the marketplace. This data is not used by payment systems.
breakdownList
amount
amount information
value
The value of the amount in decimal with max 2 digits after separator.
Only digits and dot are authorized.
currency
the currency iso code of the amount with 3 characters
sellerAccountNumber
Account number of the merchant or marketplace.
label
Label for the breakdown. Maximum 30 characters
commission
Commission information
amount
Amout of the commission in the currency of the order with two decimal maximum
account
Commission accountNumber
transactionId
Id of the payment transaction.
Response
Capture a payment transaction or all the capturable payment transactions of an order
Capture Done
capture response
resultCode
resultCode of the processing
API operation result. This code is 0 in case of success.
If resultCode is not 0, the operation fails.
In this case, a resultCodeMessage describe the reason of failure.
resultCodeMessage can be absent if no reason is provided for the resultCode.
orderStatus
Status of an order. the following status can be provided:
- created: The order is created
- pendingpayment: Payment in progress
- complete: Payment is completed
- partialcomplete: Payment is completed but all order amount is not payed
- canceled: The order is canceled
transactionList
List of transaction for the order
paymentMethodId
id of the payment Method used for the transaction
List of transaction for the order
id
List of transaction for the order
status
List of transaction for the order
amount
amount of the transaction
List of transaction for the order
value
The value of the amount in decimal with max 2 digits after separator.
Only digits and dot are authorized.
currency
the currency iso code of the amount with 3 characters
type
List of transaction for the order
resultCodeMessage
The failure description. The message can be used to understand
the failure reason. It must be transmitted to support for diagnostic.
orderId
Order id obtained in order creation
curl 'https://API_URL/mkp/v1/payin/capture' \ -H 'Authorization: Bearer <your_access_token>' \ -H 'id_token: <your_id_token>' \ -H 'Content-Type: application/json' \ --data-raw \
{
"orderId": "3343121",
"transactionId": "1707621",
"transactionAmount": {
"value": "1000.20",
"currency": "EUR"
},
"breakdownList": [
{
"label": "bdl1",
"sellerAccountNumber": "1300600000EUR01006110",
"amount": {
"value": "1000",
"currency": "EUR"
},
"commission": {
"amount": "1.01",
"account": "1300600000EUR01004110"
}
},
{
"label": "bdl2",
"sellerAccountNumber": "1300600000EUR01007110",
"amount": {
"value": "0.20",
"currency": "EUR"
}
}
]
}
{
"resultCode": "0",
"orderId": "3343121",
"orderStatus": "partial_complete",
"transactionList": [
{
"id": "1707621",
"type": "7",
"paymentMethodId": "36",
"status": "completed",
"amount": {
"value": "1103.28",
"currency": "EUR"
}
},
{
"id": "1707721",
"type": "1",
"paymentMethodId": "36",
"status": "completed",
"amount": {
"value": "1000.20",
"currency": "EUR"
}
}
]
}
/payin/mandate Copy section link
This API is used to get mandate signed file
Request
Get signed mandate file
transactionId
Must be a transaction for SDD. Must be provided if reference is not present.
reference
Mandate reference (UMR). Must be provided if transationId is not present
Response
Get SDD mandate signed file
Get mandate response
resultCode
API operation result. This code is 0 in case of success.
If resultCode is not 0, the operation fails.
In this case, a resultCodeMessage describe the reason of failure.
resultCodeMessage can be absent if no reason is provided for the resultCode.
resultCodeMessage
The failure description. The message can be used to understand
the failure reason. It must be transmitted to support for diagnostic.
transactionId
Id of the payment transaction.
reference
Mandate reference
signedFileContent
PDF file base64 encoded
curl --get 'https://API_URL/mkp/v1/payin/mandate' \ -H 'Authorization: Bearer <your_access_token>' \ -H 'id_token: <your_id_token>' \
-d 'transactionId=165231523612'
curl --get 'https://API_URL/mkp/v1/payin/mandate' \ -H 'Authorization: Bearer <your_access_token>' \ -H 'id_token: <your_id_token>' \
-d 'reference=2020110907201100Y0H1102'
{
"resultCode": "0",
"reference": "202111191439350V8211102",
"transactionId": "165231523612",
"signedFileContent": "DHGZHGDFUDjkk..."
}
/payin/orderDetails Copy section link
Get details for a payment
Request
Send back all the data of an order and its transactions
orderId
id of the order.
Response
Order retrieved successfully
Details of an order
orderAmount
amount of the order
amount information
value
The value of the amount in decimal with max 2 digits after separator.
Only digits and dot are authorized.
amount information
currency
the currency iso code of the amount with 3 characters
amount information
orderRemainingAmount
remaining amount of the order if not completed
amount information
value
The value of the amount in decimal with max 2 digits after separator.
Only digits and dot are authorized.
amount information
currency
the currency iso code of the amount with 3 characters
amount information
orderId
Order identifier
Order id obtained in order creation
resultCode
API operation result. This code is 0 in case of success.
If resultCode is not 0, the operation fails.
In this case, a resultCodeMessage describe the reason of failure.
resultCodeMessage can be absent if no reason is provided for the resultCode.
resultCodeMessage
The failure description. The message can be used to understand
the failure reason. It must be transmitted to support for diagnostic.
orderStatus
Status of an order. the following status can be provided:
- created: The order is created
- pendingpayment: Payment in progress
- complete: Payment is completed
- partialcomplete: Payment is completed but all order amount is not payed
- canceled: The order is canceled
transactionList
List of transaction for the order
paymentMethodId
id of the payment Method used for the transaction
List of transaction for the order
id
List of transaction for the order
status
List of transaction for the order
amount
amount of the transaction
List of transaction for the order
value
The value of the amount in decimal with max 2 digits after separator.
Only digits and dot are authorized.
currency
the currency iso code of the amount with 3 characters
type
List of transaction for the order
curl --get 'https://API_URL/mkp/v1/payin/orderDetails' \ -H 'Authorization: Bearer <your_access_token>' \ -H 'id_token: <your_id_token>' \
-d 'orderId=25465265'
{
"resultCode": "0",
"orderId": "26527635",
"orderStatus": "pending_payment",
"orderAmount": {
"value": "1000",
"currency": "EUR"
},
"orderRemainingAmount": {
"value": "500.87",
"currency": "EUR"
},
"transactionList": [
{
"id": "123123123",
"status": "completed",
"amount": {
"value": "500.87",
"currency": "EUR"
},
"paymentMethodId": "002"
}
]
}
/payin/payment Copy section link
Submit a payment with payment method
When your shopper choose a payment method, this call submit the choice and any data if already given.
The return can be final, (transaction completed) or ask to authentification details, or redirect the shopper to PSP or 3DS pages.
Request
All request data are embedded in a json structure in the body
Payment request.
if orderId is not provided, the following fields are mandatory :
- orderReference
- orderCountryCode
- payer
if orderId is present, it must be obtain from previous call to paymentMethods
transPaymentMethod
the payment Method choosen by the shopper
Payment method information
id
id (string) : ID of the type of payment method.
This id must be provided to identify the payment method.
The list of payment method IDs is provided when your AgoraPay account is created.
orderId
Order id obtained in order creation
orderReference
Mandatory if orderId is not present
Marketplace reference for this order. Characters authorized are: a to z, A to Z, 0 to 9 and - / . + : and space
orderCountryCode
Mandatory if orderId is not present
The ISO country code in 3 characters format
breakdownList
List of breakdown for this payment
amount
amount information
value
The value of the amount in decimal with max 2 digits after separator.
Only digits and dot are authorized.
currency
the currency iso code of the amount with 3 characters
sellerAccountNumber
Account number of the merchant or marketplace.
label
Label for the breakdown. Maximum 30 characters
commission
Commission information
amount
Amout of the commission in the currency of the order with two decimal maximum
account
Commission accountNumber
alias
If the shopper use an alias
Alias identification to used
id
Identifier for the alias
metaData
JSON data for the marketplace. This data is not used by payment systems.
payer
Mandatory if orderId is not present
Payer's details
IPAddress
IP address of the customer. IPv4 and IPv6 formats are accepted.
reference
reference of the customer from the marketplace
userAgent
The browser information used to request the payment
language
The default language of the browser.
The first two characters are used to identify the language code.
Must be in upper case.
Only french is supported at this time.
details
Payment details information For some payment methods, additional details are needed.
firstName
lastName
address
Road name and number
city
postalCode
country
Country in 3 letters ISO format
iban
state
gender
phoneNumber
sequence
For payment method with mandate, the sequence is
- FRST for first use of recurrent mandate
- RCUR for use of recurrent mandate
- FNAL for last use of recurrent mandate
- OOFF for a mandate used only one time
reference
Mandate reference in case of a SDD payment.
transactionId of the initial payment in case of a card recurring payment.
socialReason
Compagny name
address2
Additional address
capture
Capture indicator. Set to "0" for authorization only (default value 1 - transaction captured))
transactionAmount
Amount for this transaction
amount information
value
The value of the amount in decimal with max 2 digits after separator.
Only digits and dot are authorized.
currency
the currency iso code of the amount with 3 characters
urlRedirect
Url where the customer must be redirected at the end of the payment with the partner. This URL is completed by /success, /error or /cancel according to the partner response status. When the customer will be redirected to the marketPlace at the end of the partner payment process, the paymentDetails function must be called to terminate payment with the data transmitted by the partner. For development purpose, you can use http://127.0.0.1 (localhost is not supported)
registerAlias
When set to "1" or "Y", an alias will be registered when the payment will be completed, if possible. If not present or equal to "0" or "N", no alias is registered.
reason
Operation label transmitted in payment system. Maximum length of 140 characters.
endToEndId
Use to identify transaction in SEPA transfer. Autorized characters are alpha numeric, - and /. Characters / and space are authorized but not in first and last position. Also, two // are not allowed.
cart
Cart detail for 3DSV2. Mandatory in API v2.
totalQuantity
number of article in cart
operationDate
Date of the operation. The format must be YYYYMMDD
cbChallenge
Challenge negotiation for card payment. 01: No preference 02: No challenge required 03: Desired challenge 04: Required challenge
paymentOptions
Payment options
Response
When your shopper choose a payment method, this call submit the choice and any data if already given. The return can be final, (transaction completed) or ask to authentification details, or redirect the shopper to PSP or 3DS pages.
Payment processing success
Payment response
orderId
Order id obtained in order creation
orderStatus
Status of an order. the following status can be provided:
- created: The order is created
- pendingpayment: Payment in progress
- complete: Payment is completed
- partialcomplete: Payment is completed but all order amount is not payed
- canceled: The order is canceled
transactionId
Id of the payment transaction.
transactionStatus
Status of a transaction. The following value may be provided:
- created: The transaction is just created. No payment is already made.
- in_progress: Payment is in progress
- accepted: Payment is accepted
- completed: Payment confirmation is received
- canceled: Payment is canceled
- refused: Payment is refused
- abandonned: Payment is not performed
- refund: Transction is refunded
resultCode
API operation result. This code is 0 in case of success.
If resultCode is not 0, the operation fails.
In this case, a resultCodeMessage describe the reason of failure.
resultCodeMessage can be absent if no reason is provided for the resultCode.
virtualIban
Iban to make payment to for SCT or SWIFT method
redirectUrl
Url to redirect the customer to continue the payment flow with an external partner.
The marketplace must redirect its customer to this url to continue the payment process
reference
Mandate reference
resultCodeMessage
The failure description. The message can be used to understand
the failure reason. It must be transmitted to support for diagnostic.
redirectInd
1 if user must be redirect to the redirectUrl site
curl 'https://API_URL/mkp/v1/payin/payment' \ -H 'Authorization: Bearer <your_access_token>' \ -H 'id_token: <your_id_token>' \ -H 'Content-Type: application/json' \ --data-raw \
{
"orderId": "2987721",
"transactionAmount": {
"value": "70.10",
"currency": "EUR"
},
"transPaymentMethod": {
"id": "4"
},
"endToEndId": "Test",
"breakdownList": [
{
"label": "bdl1",
"transactionRef": "ref1",
"sellerAccountNumber": "1300600000EUR01006110",
"amount": {
"value": "70",
"currency": "EUR"
}
},
{
"label": "bdl2",
"transactionRef": "ref2",
"sellerAccountNumber": "1300600000EUR01007110",
"amount": {
"value": "0.10",
"currency": "EUR"
}
}
]
}
{
"resultCode": "0",
"orderId": "3343021",
"orderStatus": "pending_payment",
"transactionId": "1707521",
"transactionStatus": "in_progress",
"virtualIban": "FR7618206004320000127591154"
}
/payin/paymentDetails Copy section link
Submit additionnal Payment Details
The call send the last mandatory data to finalize the payment
Request
All request data are embedded in a json structure in the body
Payment details request
metaData
JSON data for the marketplace. This data is not used by payment systems.
orderId
Order id obtained in order creation
paymentData
Specific data for a payment method
Response
The call send the last mandatory data to finalize the payment
Payment transaction processed successfully
Payment details response
orderId
Present if success (resultCode=0)
Order id obtained in order creation
orderStatus
Status of an order. the following status can be provided:
- created: The order is created
- pendingpayment: Payment in progress
- complete: Payment is completed
- partialcomplete: Payment is completed but all order amount is not payed
- canceled: The order is canceled
resultCode
API operation result. This code is 0 in case of success.
If resultCode is not 0, the operation fails.
In this case, a resultCodeMessage describe the reason of failure.
resultCodeMessage can be absent if no reason is provided for the resultCode.
resultCodeMessage
The failure description. The message can be used to understand
the failure reason. It must be transmitted to support for diagnostic.
transactionId
Id of the payment transaction.
transactionStatus
Status of a transaction. The following value may be provided:
- created: The transaction is just created. No payment is already made.
- in_progress: Payment is in progress
- accepted: Payment is accepted
- completed: Payment confirmation is received
- canceled: Payment is canceled
- refused: Payment is refused
- abandonned: Payment is not performed
- refund: Transction is refunded
reference
Mandate reference
curl 'https://API_URL/mkp/v1/payin/paymentDetails' \ -H 'Authorization: Bearer <your_access_token>' \ -H 'id_token: <your_id_token>' \ -H 'Content-Type: application/json' \ --data-raw \
{
"orderId": "123456789",
"paymentData": "AMT=110328&CMD=1705821&AUTH=XXXXXX&USER=0&BRAND=CB&EXPIRY=2301&RESULT=00000&SAFE3DS=N&BIN=401200&CARD=12&U3DS=U&TIME=08%3A38%3A04&DATE=26032021&NUM=60078063&TRANS=33938398&ACCOUNT=CMDLpSqLLDS++2301++---&COUNTRY=FRA&SIGN=3Fu2QJJ%2F6iz%2F%2F5tjDkWf6AHEz8SASvfsOPn32lPYdgJ%2BF8oOeobUHz65tr%2B%2BBjsvxGrmzh7UQHjEyLura9eU8%2FvTGKRgKda%2Bz6xTZ9YpmA7MlxPNc0AofnHXoReumb%2B7%2BwvYpKZ46AjZQ8nICaZbgRrSD3Sq3yVpCZa1T9Pw3TM%3D"
}
{
"resultCode": "0",
"orderId": "123456789",
"orderStatus": "complete",
"transactionId": "123123",
"transactionStatus": "completed"
}
/payin/paymentIframe Copy section link
Post your payment details and get an authent Code to initiate a payment Frame
When your shopper is ready to pay, submit your order/payment by this request and get an Authent Code.
Then save the orderId and open an iframe for the shopper with the authentCode.
Request
All request data are embedded in a json structure in the body
Payment with iFrame request
orderReference
The order reference of the requester
Marketplace reference for this order. Characters authorized are: a to z, A to Z, 0 to 9 and - / . + : and space
orderCountryCode
country iso code of the order
The ISO country code in 3 characters format
amount
amount of the order
amount information
value
The value of the amount in decimal with max 2 digits after separator.
Only digits and dot are authorized.
currency
the currency iso code of the amount with 3 characters
breakdownList
breakdown list
amount
amount information
value
The value of the amount in decimal with max 2 digits after separator.
Only digits and dot are authorized.
currency
the currency iso code of the amount with 3 characters
sellerAccountNumber
Account number of the merchant or marketplace.
label
Label for the breakdown. Maximum 30 characters
commission
Commission information
amount
Amout of the commission in the currency of the order with two decimal maximum
account
Commission accountNumber
payer
customer details for iframe
payer information
reference
Reference of the customer from the marketplace, which must be equal to the initial reference
language
The default language of the browser.
The first two characters are used to identify the language code.
Must be in upper case.
Only french is supported at this time.
capture
Capture indicator. Set to "0" for authorization only (default value 1 - transaction captured))
metaData
JSON data for the marketplace. This data is not used by payment systems.
recurrent
recurrent indicator "1" for recurrent payment "0" or absent if not a recurrent payment
endToEndId
Use to identify transaction in SEPA transfer. Autorized characters are alpha numeric, - and /. Characters / and space are authorized but not in first and last position. Also, two // are not allowed.
paymentMethodId
Identifier of the payment method. If given, the end-user will be redirected to the corresponding payment method iFrame. If not given, the end-user will be redirected to the payment method selection iFrame.
urlRedirect
Url where the customer must be redirected at the end of the payment with the partner. This URL is completed by /success, /error or /cancel according to the partner response status. When the customer will be redirected to the marketPlace at the end of the partner payment process, the paymentDetails function must be called to terminate payment with the data transmitted by the partner. For development purpose, you can use http://127.0.0.1 (localhost is not supported)
cart
Cart detail for 3DSV2. Mandatory in API v2.
totalQuantity
number of article in cart
paymentAccount
cbChallenge
Challenge negotiation for card payment. 01: No preference 02: No challenge required 03: Desired challenge 04: Required challenge
details
Payment details information For some payment methods, additional details are needed.
firstName
lastName
address
Road name and number
city
postalCode
country
Country in 3 letters ISO format
iban
state
gender
phoneNumber
sequence
For payment method with mandate, the sequence is
- FRST for first use of recurrent mandate
- RCUR for use of recurrent mandate
- FNAL for last use of recurrent mandate
- OOFF for a mandate used only one time
reference
Mandate reference in case of a SDD payment.
transactionId of the initial payment in case of a card recurring payment.
socialReason
Compagny name
address2
Additional address
page
Type of page to display. - iframe: integrated in marketplace site (default) - full: full page
paymentOptions
Payment options
reason
Operation label transmitted in payment system. Maximum length of 140 characters.
Response
When your shopper is ready to pay, submit your order/payment by this request and get an Authent Code. Then save the orderId and open an iframe for the shopper with the authentCode.
Start payment with iframe response
Payment with iFrame response
resultCode
API operation result. This code is 0 in case of success.
If resultCode is not 0, the operation fails.
In this case, a resultCodeMessage describe the reason of failure.
resultCodeMessage can be absent if no reason is provided for the resultCode.
orderId
Reference of the order, to be use in every next request
Order id obtained in order creation
resultCodeMessage
The failure description. The message can be used to understand
the failure reason. It must be transmitted to support for diagnostic.
authenticationCode
Authentification Code to use to open user iframe
Site
Site name or number
url
Url to connect iframe to.
curl 'https://API_URL/mkp/v1/payin/paymentIframe' \ -H 'Authorization: Bearer <your_access_token>' \ -H 'id_token: <your_id_token>' \ -H 'Content-Type: application/json' \ --data-raw \
{
"orderReference": "ref0102636",
"orderCountryCode": "FRA",
"amount": {
"value": "12.45",
"currency": "EUR"
},
"payer": {
"reference": "customer1"
},
"breakdownList": [
{
"label": "ref1",
"sellerAccountNumber": "1300600000EUR60002411",
"amount": {
"value": "12.00",
"currency": "EUR"
}
},
{
"label": "ref2",
"sellerAccountNumber": "1300600000EUR60002411",
"amount": {
"value": "0.45",
"currency": "EUR"
}
}
],
"capture": "1",
"metaData": {
"metaData": "sample data"
},
"urlRedirect": "https://monsite.com/paymentEnd"
}
{
"resultCode": "0",
"orderId": "249021",
"authentificationCode": "db1a03ec-c6f5-565e-06ba-0df30507738c",
"url": "https://frontal.paymentsite.com?code=db1a03ec-c6f5-565e-06ba-0df30507738&site=1",
"site": "1"
}
/payin/paymentMethods Copy section link
Request a payment
When your shopper is ready to pay, submit an order and get a list of the available payment methods and alias. The list is based on the shopper country and the order amount and currency.
This is the first call to use when going on a payment operation.
The next call should be /payment
Request
All request data are embedded in a json structure in the body
Payement methods request
orderReference
Marketplace reference for this order. Characters authorized are: a to z, A to Z, 0 to 9 and - / . + : and space
orderCountryCode
The ISO country code in 3 characters format
amount
amount of the order
amount information
value
The value of the amount in decimal with max 2 digits after separator.
Only digits and dot are authorized.
currency
the currency iso code of the amount with 3 characters
payer
Payer's details
IPAddress
IP address of the customer. IPv4 and IPv6 formats are accepted.
reference
reference of the customer from the marketplace
userAgent
The browser information used to request the payment
language
The default language of the browser.
The first two characters are used to identify the language code.
Must be in upper case.
Only french is supported at this time.
metaData
Response
When your shopper is ready to pay, submit an order and get a list of the available payment methods and alias. The list is based on the shopper country and the order amount and currency. This is the first call to use when going on a payment operation. The next call should be /payment
Order created/retrieved, Available Payment Methods selected
Payment methods response
resultCode
API operation result. This code is 0 in case of success.
If resultCode is not 0, the operation fails.
In this case, a resultCodeMessage describe the reason of failure.
resultCodeMessage can be absent if no reason is provided for the resultCode.
paymentMethodList
list of available payment methods
aliasList
if alias exist for the customer and the payment Method
list of available payment methods
id
expirationDate
format MMYY
maskedPan
Hidden card number or IBAN
label
label of the alias
brand
Card brand (CB, VISA, MASTERCARD) or bank code for IBAN
bankCode
id
list of available payment methods
label
label of the payment Method
list of available payment methods
type
list of available payment methods
orderId
reference of the order, to be use in every next request
Order id obtained in order creation
resultCodeMessage
The failure description. The message can be used to understand
the failure reason. It must be transmitted to support for diagnostic.
curl 'https://API_URL/mkp/v1/payin/paymentMethods' \ -H 'Authorization: Bearer <your_access_token>' \ -H 'id_token: <your_id_token>' \ -H 'Content-Type: application/json' \ --data-raw \
{
"paymentAccount": "1300600000EUR01004110",
"orderReference": "ORDREF20210203180537394",
"orderCountryCode": "FRA",
"amount": {
"value": "70",
"currency": "EUR"
},
"payer": {
"language": "FR",
"reference": "CREF_20210203180537464",
"IPAddress": "192.168.0.1"
}
}
{
"resultCode": "0",
"paymentMethodList": [
{
"id": "1",
"label": "SCT transfer",
"type": "2"
},
{
"id": "2",
"label": "card payment",
"type": "4",
"aliasList": [
{
"id": "001",
"label": "carte xxx",
"expirationDate": "202505",
"maskedPan": "123456xxxxxx1234"
}
]
}
]
}
/payin/refund Copy section link
Refund an operation
Refund a payment transaction or all the refundable payment transactions of an order
Request
Refund request
orderId
Id of the order
Order id obtained in order creation
transactionAmount
Amount to refund
amount information
value
The value of the amount in decimal with max 2 digits after separator.
Only digits and dot are authorized.
currency
the currency iso code of the amount with 3 characters
transactionId
Id of the payment transaction.
metaData
JSON data for the marketplace. This data is not used by payment systems.
reason
The refund reason
Operation label transmitted in payment system. Maximum length of 140 characters.
breakdownList
amount
amount information
value
The value of the amount in decimal with max 2 digits after separator.
Only digits and dot are authorized.
currency
the currency iso code of the amount with 3 characters
sellerAccountNumber
Account number of the merchant or marketplace.
label
Label for the breakdown. Maximum 30 characters
commission
Commission information
amount
Amout of the commission in the currency of the order with two decimal maximum
account
Commission accountNumber
orderReference
Marketplace reference for this order, which must be equal to the initial reference. Characters authorized are: a to z, A to Z, 0 to 9 and - / . + : and space
Marketplace reference for this order. Characters authorized are: a to z, A to Z, 0 to 9 and - / . + : and space
payer
payer information
reference
Reference of the customer from the marketplace, which must be equal to the initial reference
language
The default language of the browser.
The first two characters are used to identify the language code.
Must be in upper case.
Only french is supported at this time.
Response
Refund a payment transaction or all the refundable payment transactions of an order
Refund Done
Refund response
orderStatus
Status of an order. the following status can be provided:
- created: The order is created
- pendingpayment: Payment in progress
- complete: Payment is completed
- partialcomplete: Payment is completed but all order amount is not payed
- canceled: The order is canceled
transactionList
paymentMethodId
id of the payment Method used for the transaction
id
status
amount
amount of the transaction
value
The value of the amount in decimal with max 2 digits after separator.
Only digits and dot are authorized.
currency
the currency iso code of the amount with 3 characters
type
resultCode
API operation result. This code is 0 in case of success.
If resultCode is not 0, the operation fails.
In this case, a resultCodeMessage describe the reason of failure.
resultCodeMessage can be absent if no reason is provided for the resultCode.
resultCodeMessage
The failure description. The message can be used to understand
the failure reason. It must be transmitted to support for diagnostic.
orderId
Order id obtained in order creation
curl 'https://API_URL/mkp/v1/payin/refund' \ -H 'Authorization: Bearer <your_access_token>' \ -H 'id_token: <your_id_token>' \ -H 'Content-Type: application/json' \ --data-raw \
{
"orderId": "14326513",
"transactionId": "123456789",
"transactionAmount": {
"value": "100",
"currency": "EUR"
},
"payer": {
"reference": "customer_1363"
},
"breakdownList": [
{
"label": "bdl1",
"sellerAccountNumber": "1300600000EUR01006110",
"amount": {
"value": "98.20",
"currency": "EUR"
},
"commission": {
"amount": "0.23",
"account": "1300600000EUR01004110"
}
},
{
"label": "bdl2",
"sellerAccountNumber": "1300600000EUR01004110",
"amount": {
"value": "1.80",
"currency": "EUR"
}
}
]
}
{
"resultCode": "0",
"orderId": "14326513",
"transactionId": "123456789",
"transactionList": [
{
"id": "123123123",
"status": "completed",
"amount": {
"value": "100",
"currency": "EUR"
},
"paymentMethodId": "002"
},
{
"id": "123123124",
"status": "refund",
"amount": {
"value": "100",
"currency": "EUR"
},
"paymentMethodId": "002"
}
]
}
/payin/ticket Copy section link
This API is used to get ticket in JSON or in PDF format
Request
This API is used to get ticket in JSON or in PDF format
transactionId
Id of the transaction. Must be a card transaction.
format
Ticket format : J JSON, P : PDF
type
Ticket type : C client, M : merchant
message
Message to set in the bottom of the ticket.
Response
Get card payment ticket
Get card payment ticket
getTicket Response. If format is P, only fields resultCode, transactionId and fileContent are present
resultCode
API operation result. This code is 0 in case of success.
If resultCode is not 0, the operation fails.
In this case, a resultCodeMessage describe the reason of failure.
resultCodeMessage can be absent if no reason is provided for the resultCode.
resultCodeMessage
The failure description. The message can be used to understand
the failure reason. It must be transmitted to support for diagnostic.
transactionId
Id of the payment transaction.
name
brand
maskedPan
Hidden card number
transactionStatus
Status of a transaction. The following value may be provided:
- created: The transaction is just created. No payment is already made.
- in_progress: Payment is in progress
- accepted: Payment is accepted
- completed: Payment confirmation is received
- canceled: Payment is canceled
- refused: Payment is refused
- abandonned: Payment is not performed
- refund: Transction is refunded
operationDate
Date of the operation.
The format must be YYYYMMDD
operationTime
Operation time in HH:MM:SS format
safe
Y if 3DS is verified
type
1: DEBIT, 2: CREDIT
authNumber
transNumber
Transaction number in PSP
amount
Purchase amount
amount information
value
The value of the amount in decimal with max 2 digits after separator.
Only digits and dot are authorized.
amount information
currency
the currency iso code of the amount with 3 characters
amount information
mode
PROD or TEST
fileContent
PDF file content base64 encoded, if format is P
contract
Payment partner contract number
curl --get 'https://API_URL/mkp/v1/payin/ticket' \ -H 'Authorization: Bearer <your_access_token>' \ -H 'id_token: <your_id_token>' \
-d 'transactionId=234352' \
-d 'format=J' \
-d 'type=M' \
-d 'message=Message to display in the bottom of the PDF ticket'
{
"resultCode": "0",
"transactionId": "2851621",
"name": "marketPlace A",
"brand": "CB",
"maskedPan": "111122*************44",
"transactionStatus": "10",
"operationDate": "20211118",
"operationTime": "14:31:00",
"safe": "N",
"type": "DEBIT",
"authNumber": "1762763",
"transNumber": "35430234",
"contract": "1111119",
"amount": {
"value": "1103.28",
"currency": "EUR"
},
"mode": "TEST"
}
{
"resultCode": "0",
"transactionId": "2851621",
"fileContent": "AHGDFHGHSGFHG..."
}
/operations/list Copy section link
get operations matching a set of criterias
Retrieve operation from criteria
Request
All request data are embedded in a json structure in the body
Criteria to list operation
pagination
Number of lines in reporting. Limited to 50.
startDate
Begin date of operation reporting in YYYYMMDD format
endDate
ended Date of operation Reporting in YYYYMMDD format
maxAmount
minAmount
offset
Start response line. Set to 0 when not indicated
orderReference
Order reference. Characters authorized are: a to z, A to Z, 0 to 9 and - / . + : _ and space
currency
Currency code in 3 characters ISO format
transactionId
Id of the payment transaction.
paymentMethodKey
Key identifier of the payment method type id - SDD: Sepa Direct Debit - SCT: Sepa Credit Transfer - CARD: Payment with card - SDD B2B: Sepa Direct Debit for B2B - PISP: PISP - INT: Internal Transfer - SCT INST: Sepa Credit Transfert Instant
sellerAccountNumber
Account number of the merchant or marketplace.
parentAccountNumber
A string representing the account number.
Response
Retrieve operation from criteria
To have the list of operation from a Marketplace
List of operation matching the request
resultCode
API operation result. This code is 0 in case of success.
If resultCode is not 0, the operation fails.
In this case, a resultCodeMessage describe the reason of failure.
resultCodeMessage can be absent if no reason is provided for the resultCode.
operationList
List of operation matching the request
amount
Amount of the operation
List of operation matching the request
value
The value of the amount in decimal with max 2 digits after separator.
Only digits and dot are authorized.
currency
the currency iso code of the amount with 3 characters
date
operation Date
List of operation matching the request
side
List of operation matching the request
type
type of the operation
List of operation matching the request
status
status of the operation
List of operation matching the request
breakdownList
List of breakdown
List of operation matching the request
amount
amount of the breakdown
sellerAccountNumber
label
Label for the breakdown
metaData
List of operation matching the request
transactionId
List of operation matching the request
creationDateTime
ISO 8601 format (ex: 20210325T082300+01:00)
List of operation matching the request
accountNumber
List of operation matching the request
cashedCumulAmount
Amount already cached
List of operation matching the request
orderReference
List of operation matching the request
accountCurrencyCode
List of operation matching the request
operationLabel
List of operation matching the request
relatedMsgStatusLabel
Status explanation
List of operation matching the request
thirdPartyName
List of operation matching the request
accountType
List of operation matching the request
accountCptNumber
List of operation matching the request
accountCptTypeLabel
List of operation matching the request
accountCptCurrencyCode
List of operation matching the request
thirdPartyCptName
List of operation matching the request
resultCodeMessage
The failure description. The message can be used to understand
the failure reason. It must be transmitted to support for diagnostic.
lineCount
Total number of lines
curl 'https://API_URL/mkp/v1/operations/list' \ -H 'Authorization: Bearer <your_access_token>' \ -H 'id_token: <your_id_token>' \ -H 'Content-Type: application/json' \ --data-raw \
{
"pagination": "50",
"startDate": "20230601",
"endDate": "20230630",
"currency": "EUR",
"maxAmount": "200",
"minAmount": "1",
"offset": "1"
}
{
"resultCode": "0",
"operationList": [
{
"transactionId": "55811",
"reference": "20201021141554038",
"status": "waiting",
"type": "Payment",
"side": "PAYIN",
"date": "20201021",
"amount": {
"value": "200",
"currency": "EUR"
},
"paymentMethodKey": "SCT",
"bic": "AGRIFRPP777",
"virtualIban": "FR7618206004320000115041197",
"label": "Order 3478374 SCT",
"breakdownList": [
{
"label": "bdl1",
"sellerAccountNumber": "1300600000EUR01006110",
"amount": {
"value": "35",
"currency": "EUR"
}
},
{
"label": "bdl2",
"sellerAccountNumber": "1300600000EUR01007110",
"amount": {
"value": "35",
"currency": "EUR"
}
}
]
}
]
}
/paymentAccount Copy section link
get Account Details
Request
Get account details
accountNumber
identifier of the account to get details.
Response
Account Details retrieved
Get account information response
account
Account information
number
Number of the account
Account information
name
Thirdparty name
Account information
status
Account information
currency
Account information
type
Account type
Account information
payoutAuto
1 if payout auto activated
Account information
floorLimit
Minimum amount for payout auto
Account information
balance
Account balance
Account information
availableBalance
Avalibale balance is the balance minus the floor limit.
Set to 0 if result is negative
Account information
resultCode
API operation result. This code is 0 in case of success.
If resultCode is not 0, the operation fails.
In this case, a resultCodeMessage describe the reason of failure.
resultCodeMessage can be absent if no reason is provided for the resultCode.
resultCodeMessage
The failure description. The message can be used to understand
the failure reason. It must be transmitted to support for diagnostic.
curl --get 'https://API_URL/mkp/v1/paymentAccount' \ -H 'Authorization: Bearer <your_access_token>' \ -H 'id_token: <your_id_token>' \
-d 'accountNumber=1300600000EUR01006110'
{
"resultCode": "0",
"account": {
"number": "1300600000EUR01006110",
"name": "marketPlace A",
"reference": "ref123",
"currency": "EUR",
"status": "activated",
"type": "principal",
"payoutAuto": "1",
"floorLimit": "100.00",
"balance": "528045.91",
"availableBalance": "527945.91"
}
}
/paymentAccount/credit Copy section link
Credit account
Credit payment account
Request
Data in input of paymentAccount credit request
accountNumber
A string representing the account number.
amount
Recharge amount
currency
Currency code in 3 characters ISO format
paymentMethodKey
Key identifier of the payment method type id. The following method are available: - SCT: Sepa Credit Transfer
Response
Credit payment account
Account credit response
Payment account credit response
resultCode
API operation result. This code is 0 in case of success.
If resultCode is not 0, the operation fails.
In this case, a resultCodeMessage describe the reason of failure.
resultCodeMessage can be absent if no reason is provided for the resultCode.
resultCodeMessage
The failure description. The message can be used to understand
the failure reason. It must be transmitted to support for diagnostic.
transactionId
Id of the payment transaction.
virtualIban
Iban to make payment to for SCT or SWIFT method
curl 'https://API_URL/mkp/v1/paymentAccount/credit' \ -H 'Authorization: Bearer <your_access_token>' \ -H 'id_token: <your_id_token>' \ -H 'Content-Type: application/json' \ --data-raw \
{
"accountNumber": "1300600000EUR01005110",
"amount": "500.23",
"currency": "EUR",
"paymentMethodKey": "SCT"
}
{
"resultCode": "0",
"transactionId": "1289521",
"virtualIban": "FR7618206004320000115091152"
}
/paymentAccount/disableIBAN Beta Copy section link
Disable current or pending payment method
Disable current or pending payment method
Request
Disable IBAN request.
One of requestId or paymentMethodAlias is required
requestId
Current payment method, or pending payment method
paymentMethodAlias
Alias identifying a previously registered payment method.
Response
Disable current or pending payment method
Disable IBAN response
Disable IBAN response
resultCode
API operation result. This code is 0 in case of success.
If resultCode is not 0, the operation fails.
In this case, a resultCodeMessage describe the reason of failure.
resultCodeMessage can be absent if no reason is provided for the resultCode.
resultCodeMessage
The failure description. The message can be used to understand
the failure reason. It must be transmitted to support for diagnostic.
curl 'https://API_URL/mkp/v1/paymentAccount/disableIBAN' \ -H 'Authorization: Bearer <your_access_token>' \ -H 'id_token: <your_id_token>' \ -H 'Content-Type: application/json' \ --data-raw \
{
"requestId": "CAPS202111260V3SH1"
}
{
"resultCode": "0"
}
/paymentAccount/list Copy section link
Get list of account with serach criteria
Retrieve the accounts according to the search criteria
Request
Account list request. Criteria to find account
accountNumber
A string representing the account number.
currency
Currency code in 3 characters ISO format
accountStatus
Account status code in one char length A: Activated D: Deactivated R: Registered S: Suspended
sellerReference
Account reference
pagination
Number of line in reporting. Limited to 99. Default value 50.
offset
Start response line. Set to 0 when not indicated
Response
Retrieve the accounts according to the search criteria
Response contains account list
Account list response
resultCode
API operation result. This code is 0 in case of success.
If resultCode is not 0, the operation fails.
In this case, a resultCodeMessage describe the reason of failure.
resultCodeMessage can be absent if no reason is provided for the resultCode.
resultCodeMessage
The failure description. The message can be used to understand
the failure reason. It must be transmitted to support for diagnostic.
lineCount
Total number of lines
accountList
List of accounts
number
Number of the account
List of accounts
name
Thirdparty name
List of accounts
status
List of accounts
currency
List of accounts
type
Account type
List of accounts
payoutAuto
1 if payout auto activated
List of accounts
floorLimit
Minimum amount for payout auto
List of accounts
reference
Account reference
List of accounts
curl 'https://API_URL/mkp/v1/paymentAccount/list' \ -H 'Authorization: Bearer <your_access_token>' \ -H 'id_token: <your_id_token>' \ -H 'Content-Type: application/json' \ --data-raw \
{
"accountNumber": "1300600000EUR01005110",
"currency": "EUR",
"accountStatus": "A"
}
{
"resultCode": "0",
"lineCount": "2",
"accountList": [
{
"number": "1300600000EUR01004110",
"reference": "",
"currency": "EUR",
"status": "activated",
"floorLimit": "100.00",
"payoutAuto": "Y",
"name": "marketPlace A",
"type": "principal"
},
{
"number": "1300600000EUR010024110",
"reference": "",
"currency": "EUR",
"status": "activated",
"floorLimit": "5.00",
"payoutAuto": "N",
"name": "marketPlace A",
"type": "principal"
}
]
}
/paymentAccount/payoutAuto Copy section link
Activate or deactivate automatic payout
the API allows you to configure the automatic payout
Request
Payout auto request
accountNumber
A string representing the account number.
amount
Recharge amount
frequency
0: deactivate 1: once a day 2: once a week 3: once a month 10: Automatic on threshold
dayOfWeek
Selected day of the week. Between 0 and 6 If frequency is set to 2, dayOfWeek is a mandatory field. 0: Sunday 1: Monday 2: Tuesday 3: Wednesday 4: Thursday 5: Friday 6: Saturday
dayOfMonth
Selected day of the month. Between 1 and 31. If frequency is set to 3, dayOfMonth is a mandatory field
paymentMethodAlias
Alias identifying a previously registered payment method.
Response
the API allows you to configure the automatic payout
Automatic payout response
Payout auto response
resultCode
API operation result. This code is 0 in case of success.
If resultCode is not 0, the operation fails.
In this case, a resultCodeMessage describe the reason of failure.
resultCodeMessage can be absent if no reason is provided for the resultCode.
resultCodeMessage
The failure description. The message can be used to understand
the failure reason. It must be transmitted to support for diagnostic.
curl 'https://API_URL/mkp/v1/paymentAccount/payoutAuto' \ -H 'Authorization: Bearer <your_access_token>' \ -H 'id_token: <your_id_token>' \ -H 'Content-Type: application/json' \ --data-raw \
{
"accountNumber": "1300600000EUR01005110",
"amount": "200.00",
"frequency": "2",
"dayOfWeek": "1",
"paymentMethodAlias": "PM2021011300GLR1100"
}
{
"resultCode": "0"
}
/paymentAccount/setFloorLimit Beta Copy section link
Modifiy account floor limit
This function start the process to change IBAN.
In response a requestID is provided to identify the change process.
After validation in tyhe BO, the proprietary of the account will received an email with a link to validate this request.
Request
Set account floor limit request
accountNumber
A string representing the account number.
amount
Floor limit amount
amount information
value
The value of the amount in decimal with max 2 digits after separator.
Only digits and dot are authorized.
currency
the currency iso code of the amount with 3 characters
Response
This function start the process to change IBAN. In response a requestID is provided to identify the change process. After validation in tyhe BO, the proprietary of the account will received an email with a link to validate this request.
Start change IBAN process
Change account floor limit
Set account floor limit response
resultCode
API operation result. This code is 0 in case of success.
If resultCode is not 0, the operation fails.
In this case, a resultCodeMessage describe the reason of failure.
resultCodeMessage can be absent if no reason is provided for the resultCode.
resultCodeMessage
The failure description. The message can be used to understand
the failure reason. It must be transmitted to support for diagnostic.
curl 'https://API_URL/mkp/v1/paymentAccount/setFloorLimit' \ -H 'Authorization: Bearer <your_access_token>' \ -H 'id_token: <your_id_token>' \ -H 'Content-Type: application/json' \ --data-raw \
{
"accountNumber": "1300600000EUR01006110",
"amount": {
"value": "100.00",
"currency": "EUR"
}
}
{
"resultCode": "0"
}
/paymentAccount/setIBAN Beta Copy section link
Create a new payment method
This function start the process to change IBAN.
In response a requestID is provided to identify the change process.
After validation in tyhe BO, the proprietary of the account will received an email with a link to validate this request.
Request
Start the change IBAN process request
Upload must be done in multipart/form-data mime type.
One part must be a valid JSON with required fields in content-disposition named 'json'.
Second part must be the file base64 encoded in content-disposition named 'file'.
fileExt is defined in content-type of file part.
accountNumber
A string representing the account number.
firstName
The first name of the IBAN account's owner
lastName
The last name of the IBAN account's owner
socialReason
The name of the IBAN account's owner if compagny
address
The road name and number of the IBAN account's owner
city
The city of the IBAN account's owner
postalCode
The postal code of the IBAN account's owner
country
The country code (in 3 letter format) of the IBAN account's owner
iban
The new IBAN
currency
Currency code in 3 characters ISO format
paymentMethodAlias
Current payment method alias to update. If not provided a new payment method is added.
paymentMethodKey
Type of payment method - SCT - SCT INST
Response
This function start the process to change IBAN. In response a requestID is provided to identify the change process. After validation in tyhe BO, the proprietary of the account will received an email with a link to validate this request.
Start change IBAN process
Start change iban process response
Start change IBAN process response
resultCode
API operation result. This code is 0 in case of success.
If resultCode is not 0, the operation fails.
In this case, a resultCodeMessage describe the reason of failure.
resultCodeMessage can be absent if no reason is provided for the resultCode.
resultCodeMessage
The failure description. The message can be used to understand
the failure reason. It must be transmitted to support for diagnostic.
requestId
ID to identify processing request
paymentMathodAlias
Alias identifying a previously registered payment method.
curl 'https://API_URL/mkp/v1/paymentAccount/setIBAN' \ -H 'Authorization: Bearer <your_access_token>' \ -H 'id_token: <your_id_token>' \ -H 'Content-Type: multipart/form-data'; boundary=-------=BOUNDARY' \ --data-binary \
-------=BOUNDARY \ Content-Disposition: form-data;
name='json'
Content-Type: application/json;
charset=UTF-8
{'accountNumber': '1300600000EUR01006110',
'firstName': 'Pierre',
'lastName': 'Tramo',
'address': '3 rue de la paix',
'city': 'Paris',
'postalCode': '75008',
'country': 'FRA',
'iban': 'FR3730003000402582679694W42',
'currency': 'EUR'
}
-------=BOUNDARY \ Content-Disposition: form-data;
name='file';
file='document.jpg'
Content-Type: image/png
Content-Transfer-Encoding: base64
JVBERi0xLjMKJcTl8uXrp/...
{
"resultCode": "0",
"requestId": "CAPS202111260V3SH1",
"paymentMethodAlias": "PM202111260V3ST1100"
}
/payout/create Copy section link
Submit a payout from accountNumber to the bank account associated to this account number.
From accountNumber to the bank account associated to this account number.
Request
Payout request
endToEndId
end to end identifier
Use to identify transaction in SEPA transfer. Autorized characters are alpha numeric, - and /. Characters / and space are authorized but not in first and last position. Also, two // are not allowed.
payoutAmount
amount and currency of the payout
amount information
value
The value of the amount in decimal with max 2 digits after separator.
Only digits and dot are authorized.
currency
the currency iso code of the amount with 3 characters
paymentMethodAlias
Alias identifying a previously registered payment method.
accountNumber
Account Number invloved in payout
A string representing the account number.
commission
Commission information
amount
Amout of the commission in the currency of the order with two decimal maximum
account
Commission accountNumber
metaData
User metaData in Json or string format
JSON data for the marketplace. This data is not used by payment systems.
reason
Operation label transmitted in payment system. Maximum length of 140 characters.
Response
From accountNumber to the bank account associated to this account number.
Payout successful
Payout response
resultCode
API operation result. This code is 0 in case of success.
If resultCode is not 0, the operation fails.
In this case, a resultCodeMessage describe the reason of failure.
resultCodeMessage can be absent if no reason is provided for the resultCode.
resultCodeMessage
The failure description. The message can be used to understand
the failure reason. It must be transmitted to support for diagnostic.
transactionId
Id of the payment transaction.
transactionStatus
Status of a transaction. The following value may be provided:
- created: The transaction is just created. No payment is already made.
- in_progress: Payment is in progress
- accepted: Payment is accepted
- completed: Payment confirmation is received
- canceled: Payment is canceled
- refused: Payment is refused
- abandonned: Payment is not performed
- refund: Transction is refunded
curl 'https://API_URL/mkp/v1/payout/create' \ -H 'Authorization: Bearer <your_access_token>' \ -H 'id_token: <your_id_token>' \ -H 'Content-Type: application/json' \ --data-raw \
{
"accountNumber": "1300600000EUR01006110",
"reason": "test",
"endToEndId": "ETEID-20210203142803584",
"paymentMethodAlias": "PM2021011300GLR1100",
"metaData": {
"Metadata3": "donn\u00e9e3",
"Metadata4": "donnee4"
},
"payoutAmount": {
"value": "200",
"currency": "EUR"
},
"commission": {
"amount": "1.00",
"account": "1300600000EUR60002411"
}
}
{
"resultCode": "0",
"transactionId": "1289921"
}
/transfer/create Copy section link
Ask for a transfer between two accounts
Submit a transfer from one account (accountNumber) to another (accountCtpNumber)
Request
Transfer Resquest
accountCptNumber
Account number to credit
A string representing the account number.
transferAmount
the Amount to transfer
amount information
value
The value of the amount in decimal with max 2 digits after separator.
Only digits and dot are authorized.
currency
the currency iso code of the amount with 3 characters
accountNumber
Account Number to debit
A string representing the account number.
orderRef
operation reference of the transfer
Marketplace reference for this order. Characters authorized are: a to z, A to Z, 0 to 9 and - / . + : and space
metaData
JSON data for the marketplace. This data is not used by payment systems.
reason
Operation label transmitted in payment system. Maximum length of 140 characters.
Response
Submit a transfer from one account (accountNumber) to another (accountCtpNumber)
transfer done successfully
resultCode
API operation result. This code is 0 in case of success.
If resultCode is not 0, the operation fails.
In this case, a resultCodeMessage describe the reason of failure.
resultCodeMessage can be absent if no reason is provided for the resultCode.
resultCodeMessage
The failure description. The message can be used to understand
the failure reason. It must be transmitted to support for diagnostic.
transactionId
Id of the payment transaction.
curl 'https://API_URL/mkp/v1/transfer/create' \ -H 'Authorization: Bearer <your_access_token>' \ -H 'id_token: <your_id_token>' \ -H 'Content-Type: application/json' \ --data-raw \
{
"accountNumber": "1300600000EUR01004110",
"accountCptNumber": "1300600000EUR01006110",
"orderRef": "20210203142044",
"reason": "test",
"transferAmount": {
"value": "10.01",
"currency": "EUR"
}
}
{
"resultCode": "0",
"transactionId": "1287521"
}
/accountHolder/register Beta Copy section link
Start registering new account holder
Start registering new account holder
Request
Start register new account holder request
socialReason
Holder name
companyName
Commercial name
currency
Currency code in 3 characters ISO format
country
The ISO country code in 3 characters format
legalForm
registrationNumber
Identification number for entity. For example, SIRET for France
masterAddress
Register address information
address
Number and road name
city
postalCode
country
The ISO country code in 3 characters format
commercialAddress
Same as master address if not provided
Register address information
address
Number and road name
city
postalCode
country
The ISO country code in 3 characters format
turnover
Current or last year turnover in account currency code unit
regulatedSociety
Y or N
physicalPersons
At least one person must be provided with CP role
gender
Person gender M or F
firstName
lastName
phoneNumber
roles
List of role
birthDate
Date of birth in YYYYMMAA format
account
Register account information
country
The ISO country code in 3 characters format
currency
Currency code in 3 characters ISO format
iban
International Bank Account Number
floorLimit
Floor limit in currency unit
owner
Account owner information
gender
firstName
lastName
socialReason
address
city
postalCode
country
Response
Start registering new account holder
Successful response to accountHolder registration
Start register new account holder response
resultCode
API operation result. This code is 0 in case of success.
If resultCode is not 0, the operation fails.
In this case, a resultCodeMessage describe the reason of failure.
resultCodeMessage can be absent if no reason is provided for the resultCode.
resultCodeMessage
The failure description. The message can be used to understand
the failure reason. It must be transmitted to support for diagnostic.
requestId
Id used for futher update function call
accountNumber
A string representing the account number.
paymentMethodAlias
Alias identifying a previously registered payment method.
requirements
id
Requirement identification number
label
Requirement description
code
Requirement code identification
fileExt
Type of form file provided (JPEG, JPG, PNG, PDF, DOC)
fileContent
Content of the form document base64 encoded
fileType
Type of document (BANKID, COMPANYREG, ...)
mandatory
Y or N. May be absent if N
physicalPersons
firstName
lastName
id
Registration identification number
requirements
List of document to provide or provided
id
Requirement identification number
label
Requirement description
code
Requirement code identification
fileExt
Type of form file provided (JPEG, JPG, PNG, PDF, DOC)
fileContent
Content of the form document base64 encoded
fileType
Type of document (BANKID, COMPANYREG, ...)
mandatory
Y or N. May be absent if N
curl 'https://API_URL/mkp/v1/accountHolder/register' \ -H 'Authorization: Bearer <your_access_token>' \ -H 'id_token: <your_id_token>' \ -H 'Content-Type: application/json' \ --data-raw \
{
"socialReason": "My compagny",
"companyName": "The compagny",
"country": "FRA",
"legalForm": "SAS",
"registrationNumber": "4252378780001",
"masterAddress": {
"address": "Rue d'ici",
"city": "Ville",
"postalCode": "75000",
"country": "FRA"
},
"turnover": "456789.00",
"currency": "EUR",
"regulatedSociety": "N",
"physicalPersons\"": {
"gender": "M",
"firstName": "John",
"lastName": "Smith",
"email": "js@mycompagny.com",
"birthDate": "19750116",
"phoneNumber": "336123456789",
"roles": [
{
"role": "BE"
},
{
"role": "CP"
}
]
},
"account": {
"country": "FRA",
"currency": "EUR",
"iban": "FR7611808009101234567890147",
"floorLimit": "230.00"
}
}
{
"resultCode": "0",
"requestId": "CAPS202111260V3SA1",
"accountNumber": "1300600000EUR1270489911",
"paymentMethodAlias": "PM202111260V3FG1100",
"requirements": [
{
"id": "145511",
"label": "Convention de compte",
"code": "ACCOUNT_AGR",
"mandatory": "Y",
"fileType": "Account agreement"
},
{
"id": "145611",
"label": "Justificatif bancaire",
"code": "BANK_ID",
"mandatory": "Y",
"fileType": "Professional RIB on behalf of the individual"
},
{
"id": "145611",
"label": "Justificatif bancaire",
"mandatory": "Y",
"fileType": "Professional RIB on behalf of the legal entity"
},
{
"id": "145711",
"label\"": "Justificatif economique",
"mandatory": "Y",
"fileType": "BATICA Certificate of Deposit or Register Extract"
},
{
"id": "145811",
"label": "Justificatif d'enregistement",
"mandatory": "Y",
"fileType": "Company Kbis extract less than 3 months old"
},
{
"id": "145811",
"label": "Justificatif d'enregistement",
"mandatory": "Y",
"fileType": "Copy of the articles of association"
},
{
"id": "145811",
"label": "Justificatif d'enregistement",
"mandatory": "Y",
"fileType": "AG PV"
},
{
"id": "145911",
"label": "Questionnaire PAYS",
"mandatory": "N",
"fileType": "Country questionnaire"
}
],
"physicalPersons": [
{
"id": "270490011",
"firstName": "Jhon",
"lastName": "Smith",
"requirements": [
{
"id\"": "146011",
"label\"": "Justificatif d'identite",
"mandatory\"": "Y",
"fileType\"": "Passeport"
},
{
"id\"": "146011",
"label\"": "Justificatif d'identite",
"mandatory\"": "Y",
"fileType\"": "Id card"
},
{
"id\"": "146011",
"label\"": "Justificatif d'identite",
"mandatory\"": "Y",
"fileType\"": "Residence permit"
},
{
"id\"": "146011",
"label\"": "Justificatif d'identite",
"mandatory\"": "Y",
"fileType\"": "Company Kbis extract less than 3 months old"
},
{
"id\"": "146011",
"label\"": "Justificatif d'identite",
"mandatory\"": "Y",
"fileType\"": "Front-side ID card"
},
{
"id\"": "146011",
"label\"": "Justificatif d'identite",
"mandatory\"": "Y",
"fileType\"": "Back ID card"
}
]
}
]
}
/accountHolder/registrationDetails Beta Copy section link
Get registration information and status
Request
Get registration details
requestId
Registration request identifier
Response
registration information response
Start register new account holder response
resultCode
API operation result. This code is 0 in case of success.
If resultCode is not 0, the operation fails.
In this case, a resultCodeMessage describe the reason of failure.
resultCodeMessage can be absent if no reason is provided for the resultCode.
resultCodeMessage
The failure description. The message can be used to understand
the failure reason. It must be transmitted to support for diagnostic.
requestId
Id used for futher update function call
accountNumber
A string representing the account number.
paymentMethodAlias
Alias identifying a previously registered payment method.
requirements
id
Requirement identification number
label
Requirement description
code
Requirement code identification
fileExt
Type of form file provided (JPEG, JPG, PNG, PDF, DOC)
fileContent
Content of the form document base64 encoded
fileType
Type of document (BANKID, COMPANYREG, ...)
mandatory
Y or N. May be absent if N
physicalPersons
firstName
lastName
id
Registration identification number
requirements
List of document to provide or provided
id
Requirement identification number
label
Requirement description
code
Requirement code identification
fileExt
Type of form file provided (JPEG, JPG, PNG, PDF, DOC)
fileContent
Content of the form document base64 encoded
fileType
Type of document (BANKID, COMPANYREG, ...)
mandatory
Y or N. May be absent if N
curl --get 'https://API_URL/mkp/v1/accountHolder/registrationDetails' \ -H 'Authorization: Bearer <your_access_token>' \ -H 'id_token: <your_id_token>' \
-d 'requestId=2176372'
{
"resultCode": "0",
"requestId": "CAPS202111260V3L61",
"status": "To validate",
"requirements": [
{
"mandatory": "Y",
"status": "Missing",
"id": "140811",
"label": "Convention de compte",
"documents": [
{
"fileType": "Account agreement",
"validated": "N"
}
]
},
{
"mandatory": "Y",
"status": "Missing",
"id": "140911",
"label": "Justificatif bancaire",
"documents": [
{
"fileType": "Professional RIB on behalf of the individual",
"validated": "N"
},
{
"fileType": "Professional RIB on behalf of the legal entity",
"validated": "N"
}
]
},
{
"mandatory": "Y",
"status": "Missing",
"id": "141011",
"label": "Justificatif economique",
"documents": [
{
"fileType": "BATICA Certificate of Deposit or Register Extract",
"validated": "N"
}
]
},
{
"mandatory": "Y",
"status": "Missing",
"id": "141111",
"label": "Justificatif d'enregistement",
"documents": [
{
"fileType": "Company Kbis extract less than 3 months old",
"validated": "N"
},
{
"fileType": "Copy of the articles of association",
"validated": "N"
},
{
"fileType": "AG PV",
"validated": "N"
}
]
},
{
"mandatory": "N",
"status": "Missing",
"id": "141211",
"label": "Questionnaire PAYS",
"documents": [
{
"fileType": "Country questionnaire,",
"validated": "N"
}
]
}
],
"physicalPersons": [
{
"id": "270486711",
"firstName": "John",
"lastName": "Smith",
"requirements": [
{
"id": "141311",
"label": "Justificatif d'identite",
"mandatory": "Y",
"status": "Missing",
"documents": [
{
"fileType": "Passeport",
"validated": "N"
},
{
"fileType": "Id card",
"validated": "N"
},
{
"fileType": "Residence permit",
"validated": "N"
},
{
"fileType": "Company Kbis extract less than 3 months old",
"validated": "N"
},
{
"fileType": "Front-side ID card",
"validated": "N"
},
{
"fileType": "Back ID card",
"validated": "N"
}
]
}
]
}
]
}
/accountHolder/unregister Beta Copy section link
Unregister pending account holder registration
Unregister pending account holder registration
Request
Unregister pending holder registration request
requestId
ID to identify processing request
Response
Unregister pending account holder registration
Result response
Unregister pending holder registration response
resultCode
API operation result. This code is 0 in case of success.
If resultCode is not 0, the operation fails.
In this case, a resultCodeMessage describe the reason of failure.
resultCodeMessage can be absent if no reason is provided for the resultCode.
resultCodeMessage
The failure description. The message can be used to understand
the failure reason. It must be transmitted to support for diagnostic.
curl 'https://API_URL/mkp/v1/accountHolder/unregister' \ -H 'Authorization: Bearer <your_access_token>' \ -H 'id_token: <your_id_token>' \ -H 'Content-Type: application/json' \ --data-raw \
{
"requestId": "CAPS202111260V3SA1"
}
{
"resultCode": "0"
}
/accountHolder/update Beta Copy section link
Update registered account holder
Update account holder registration
Request
Update holder registration request
socialReason
Holder name
companyName
Commercial name
country
The ISO country code in 3 characters format
masterAddress
Register address information
address
Number and road name
city
postalCode
country
The ISO country code in 3 characters format
commercialAddress
Same as master address if not provided
Register address information
address
Number and road name
city
postalCode
country
The ISO country code in 3 characters format
turnover
Current or last year turnover in account currency code unit
regulatedSociety
Y or N
physicalPersons
At least one person must be provided with CP role
id
Previous ID provided in register response of physical person to update.
If absent, a new person is added.
gender
Person gender M or F
firstName
lastName
phoneNumber
roles
List of role
birthDate
Date of birth in YYYYMMAA format
account
Register account information
country
The ISO country code in 3 characters format
currency
Currency code in 3 characters ISO format
iban
International Bank Account Number
floorLimit
Floor limit in currency unit
owner
Account owner information
gender
firstName
lastName
socialReason
address
city
postalCode
country
currency
Required if turnover provided
Currency code in 3 characters ISO format
requestId
ID to identify processing request
Response
Update account holder registration
Update register response
update holder registration response
resultCode
API operation result. This code is 0 in case of success.
If resultCode is not 0, the operation fails.
In this case, a resultCodeMessage describe the reason of failure.
resultCodeMessage can be absent if no reason is provided for the resultCode.
resultCodeMessage
The failure description. The message can be used to understand
the failure reason. It must be transmitted to support for diagnostic.
requestId
Id used for futher update function call
accountNumber
A string representing the account number.
paymentMethodAlias
Alias identifying a previously registered payment method.
requirements
id
Requirement identification number
label
Requirement description
code
Requirement code identification
fileExt
Type of form file provided (JPEG, JPG, PNG, PDF, DOC)
fileContent
Content of the form document base64 encoded
fileType
Type of document (BANKID, COMPANYREG, ...)
mandatory
Y or N. May be absent if N
physicalPersons
firstName
lastName
id
Registration identification number
requirements
List of document to provide or provided
id
Requirement identification number
label
Requirement description
code
Requirement code identification
fileExt
Type of form file provided (JPEG, JPG, PNG, PDF, DOC)
fileContent
Content of the form document base64 encoded
fileType
Type of document (BANKID, COMPANYREG, ...)
mandatory
Y or N. May be absent if N
curl 'https://API_URL/mkp/v1/accountHolder/update' \ -H 'Authorization: Bearer <your_access_token>' \ -H 'id_token: <your_id_token>' \ -H 'Content-Type: application/json' \ --data-raw \
{
"requestId": "CAPS202111260V3SA1",
"socialReason": "My compagny",
"companyName": "The compagny",
"country": "FRA",
"registrationNumber": "4252378780001",
"masterAddress": {
"address": "Rue d'ici",
"city": "Ville",
"postalCode": "75000",
"country": "FRA"
},
"turnover": "456789.00",
"currency": "EUR",
"regulatedSociety": "N",
"physicalPersons\"": {
"id": "270490011",
"gender": "M",
"firstName": "John",
"lastName": "Dhoe",
"email": "js@mycompagny.com",
"birthDate": "19750116",
"phoneNumber": "336123456789",
"roles": [
{
"role": "BE"
},
{
"role": "CP"
}
]
},
"account": {
"country": "FRA",
"currency": "EUR",
"iban": "FR7611808009101234567890147",
"floorLimit": "230.00"
}
}
{
"resultCode": "0",
"requestId": "CAPS202111260V3SA1",
"accountNumber": "1300600000EUR1270489911",
"paymentMethodAlias": "PM202111260V3FG1100",
"requirements": [
{
"id": "145511",
"label": "Convention de compte",
"mandatory": "Y",
"fileType": "Account agreement"
},
{
"id": "145611",
"label": "Justificatif bancaire",
"mandatory": "Y",
"fileType": "Professional RIB on behalf of the individual"
},
{
"id": "145611",
"label": "Justificatif bancaire",
"mandatory": "Y",
"fileType": "Professional RIB on behalf of the legal entity"
},
{
"id": "145711",
"label\"": "Justificatif economique",
"mandatory": "Y",
"fileType": "BATICA Certificate of Deposit or Register Extract"
},
{
"id": "145811",
"label": "Justificatif d'enregistement",
"mandatory": "Y",
"fileType": "Company Kbis extract less than 3 months old"
},
{
"id": "145811",
"label": "Justificatif d'enregistement",
"mandatory": "Y",
"fileType": "Copy of the articles of association"
},
{
"id": "145811",
"label": "Justificatif d'enregistement",
"mandatory": "Y",
"fileType": "AG PV"
},
{
"id": "145911",
"label": "Questionnaire PAYS",
"mandatory": "N",
"fileType": "Country questionnaire"
}
],
"physicalPersons": [
{
"id": "270490011",
"firstName": "Jhon",
"lastName": "Dhoe",
"requirements": [
{
"id\"": "146011",
"label\"": "Justificatif d'identite",
"mandatory\"": "Y",
"fileType\"": "Passeport"
},
{
"id\"": "146011",
"label\"": "Justificatif d'identite",
"mandatory\"": "Y",
"fileType\"": "Id card"
},
{
"id\"": "146011",
"label\"": "Justificatif d'identite",
"mandatory\"": "Y",
"fileType\"": "Residence permit"
},
{
"id\"": "146011",
"label\"": "Justificatif d'identite",
"mandatory\"": "Y",
"fileType\"": "Company Kbis extract less than 3 months old"
},
{
"id\"": "146011",
"label\"": "Justificatif d'identite",
"mandatory\"": "Y",
"fileType\"": "Front-side ID card"
},
{
"id\"": "146011",
"label\"": "Justificatif d'identite",
"mandatory\"": "Y",
"fileType\"": "Back ID card"
}
]
}
]
}
/accountHolder/uploadDocument Beta Copy section link
Upload required documents to register an account holder
Upload document in registration process
Request
Upload holder registration request
requirements
id
Requirement identification number
fileExt
Type of file provided (JPEG, PNG, PDF, DOC, XLS, XLSX)
This type is defined in content-type header of file part in multipart request.
- image/jpeg: JPEG
- image/png: PNG
- application/pdf: PDF
- application/msword: DOC
- application/vnd.ms-excel: XLS
- application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: XLSX
fileContent
Content of the document base64 encoded.
File is provided in file part of multipart request.
fileType
File type allowed based on requirement code. The following value are allowed :
INDIVIDUALINDIFICATION
- PASSPORT: Passeport
- IDCARDFRONTBACK: Identity document
- IDCARDFRONT: Identity document
- IDCARDBACK: Identity document
- PERMANENTRES: Permanent residence permit
BUSINESSIDENTIFICATION
- COMPANYREG: Proof of registration
NONPROFITIDENTICIATION
- NONPROFITREG: Proof of existence of the association
- NONPROFITOJ: JOAFE publication
BUSINESSARTICLES
- COMPANYART: Final status
NONPROFITDIRECTORS
- REPORTGENASS: Minutes of last general assembly
BUSINESSUBO
- UBOREG: Register of beneficial owners filed with the registry
LEGALEXISTENCE
- SIRENEREG: INSEE file less than 3 months old
- RECEIPTAPP: Receipt of prefecture
- SIRENENOT: Notice of situation
REGISTRATIONPROOF
- INDIVIDUALREG: Registration with the Trade and Companies Register or Trades and Crafts Register
ADDRESSPROOF
- PROPERTYTAX: Property tax less than a year old
- HOUSINGTAX: Housing tax less than a year old
- INVOICE: Energy or telephony supplier bill (less than 3 months old)
COOPERATIVEAPPROUVAL
- COOPAPP: Approval of the High Council of the agricultural cooperative (if agricultural cooperative)
SUBSCRIPTIONPROOF
- PROOFREG: Proof of registration for SCs and SCPs
BUSINESSIDENTIFICATIONWORLD
- COMPANYREGWORLD: Extract from the commercial register (original + translation)
- COMPANYCERWORLD: Certificate of legal validity of the company (original + translation)
BUSINESSARTICLESWORLD
- COMPANYARTWORLD: Definitive statutes or equivalent (original + translation)
BUSINESSUBOWORLD
- UBOREGWORLD: Beneficial ownership declaration form (original + translation)
BANKID
- BANKID: Bank Account Proof
OTHERDOC
- OTHERDOC: Additional supporting documents
ACCOUNTAGR
- ACCOUNTAGR: Account Agreement
QUESTIONNAIRE
- QUESTIONNAIRE: Country Questionnaire (FR)
SYNDICATEIDENTIFICATION
- SYNDID: Condominium summary sheet
REPORTGENERALSYNDICATE
- REPORTGEN_SYND PV: Minutes of the last Ordinary General Meeting of the condominium
requestId
ID to identify processing request
Response
Upload document in registration process
Upload document response
Upload holder registration response
resultCode
API operation result. This code is 0 in case of success.
If resultCode is not 0, the operation fails.
In this case, a resultCodeMessage describe the reason of failure.
resultCodeMessage can be absent if no reason is provided for the resultCode.
resultCodeMessage
The failure description. The message can be used to understand
the failure reason. It must be transmitted to support for diagnostic.
requestId
Id used for futher update function call
requirements
id
Requirement identification number
label
Requirement description
code
Requirement code identification
fileExt
Type of form file provided (JPEG, JPG, PNG, PDF, DOC)
fileContent
Content of the form document base64 encoded
fileType
Type of document (BANKID, COMPANYREG, ...)
mandatory
Y or N. May be absent if N
physicalPersons
firstName
lastName
id
Registration identification number
requirements
List of document to provide or provided
id
Requirement identification number
label
Requirement description
code
Requirement code identification
fileExt
Type of form file provided (JPEG, JPG, PNG, PDF, DOC)
fileContent
Content of the form document base64 encoded
fileType
Type of document (BANKID, COMPANYREG, ...)
mandatory
Y or N. May be absent if N
curl 'https://API_URL/mkp/v1/accountHolder/uploadDocument' \ -H 'Authorization: Bearer <your_access_token>' \ -H 'id_token: <your_id_token>' \ -H 'Content-Type: application/json' \ --data-raw \
{
"requestId": "CAPS202111260V3SA1",
"requirements": [
{
"id": "146011",
"fileType": "IDCARD_FRONT_BACK"
}
]
}
{
"resultCode": "0",
"requestId": "CAPS202111260V3SA1",
"requirements": [
{
"id": "145511",
"label": "Convention de compte",
"mandatory": "Y",
"fileType": "Account agreement"
},
{
"id": "145611",
"label": "Justificatif bancaire",
"mandatory": "Y",
"fileType": "Professional RIB on behalf of the individual"
},
{
"id": "145611",
"label": "Justificatif bancaire",
"mandatory": "Y",
"fileType": "Professional RIB on behalf of the legal entity"
},
{
"id": "145711",
"label\"": "Justificatif economique",
"mandatory": "Y",
"fileType": "BATICA Certificate of Deposit or Register Extract"
},
{
"id": "145811",
"label": "Justificatif d'enregistement",
"mandatory": "Y",
"fileType": "Company Kbis extract less than 3 months old"
},
{
"id": "145811",
"label": "Justificatif d'enregistement",
"mandatory": "Y",
"fileType": "Copy of the articles of association"
},
{
"id": "145811",
"label": "Justificatif d'enregistement",
"mandatory": "Y",
"fileType": "AG PV"
},
{
"id": "145911",
"label": "Questionnaire PAYS",
"mandatory": "N",
"fileType": "Country questionnaire"
}
],
"physicalPersons": [
{
"id": "270490011",
"firstName": "Jhon",
"lastName": "Dhoe"
}
]
}
/mandate/create Beta Copy section link
Generate SEPA Direct Debit mandate
Generate a SEPA Direct debit mandate B2C or B2B, do not generate any transactions
Request
Generate a new direct debit mandate without payment
transPaymentMethod
the payment method choosen
Payment method information
id
id (string) : ID of the type of payment method.
This id must be provided to identify the payment method.
The list of payment method IDs is provided when your AgoraPay account is created.
payer
reference used for payment reconciliation
Payer's details
IPAddress
IP address of the customer. IPv4 and IPv6 formats are accepted.
reference
reference of the customer from the marketplace
userAgent
The browser information used to request the payment
language
The default language of the browser.
The first two characters are used to identify the language code.
Must be in upper case.
Only french is supported at this time.
details
Payment details information For some payment methods, additional details are needed.
firstName
lastName
address
Road name and number
city
postalCode
country
Country in 3 letters ISO format
iban
state
gender
phoneNumber
sequence
For payment method with mandate, the sequence is
- FRST for first use of recurrent mandate
- RCUR for use of recurrent mandate
- FNAL for last use of recurrent mandate
- OOFF for a mandate used only one time
reference
Mandate reference in case of a SDD payment.
transactionId of the initial payment in case of a card recurring payment.
socialReason
Compagny name
address2
Additional address
urlRedirect
Url where the customer must be redirected at the end of the payment with the partner. This URL is completed by /success, /error or /cancel according to the partner response status. When the customer will be redirected to the marketPlace at the end of the partner payment process, the paymentDetails function must be called to terminate payment with the data transmitted by the partner. For development purpose, you can use http://127.0.0.1 (localhost is not supported)
Response
Generate a SEPA Direct debit mandate B2C or B2B, do not generate any transactions
SEPA Direct Debit mandate generated
New debit mandate generation response
resultCode
API operation result. This code is 0 in case of success.
If resultCode is not 0, the operation fails.
In this case, a resultCodeMessage describe the reason of failure.
resultCodeMessage can be absent if no reason is provided for the resultCode.
resultCodeMessage
The failure description. The message can be used to understand
the failure reason. It must be transmitted to support for diagnostic.
reference
Mandate reference
redirectUrl
Url to redirect the customer to continue the payment flow with an external partner.
The marketplace must redirect its customer to this url to continue the payment process
redirectInd
1 if user must be redirect to the redirectUrl site
curl 'https://API_URL/mkp/v1/mandate/create' \ -H 'Authorization: Bearer <your_access_token>' \ -H 'id_token: <your_id_token>' \ -H 'Content-Type: application/json' \ --data-raw \
{
"transPaymentMethod": {
"id": "20"
},
"payer": {
"reference": "customer1"
},
"details": {
"socialReason": "My compagny",
"email": "js@mycompagny.com",
"address": "Rue d'ici",
"postalCode": "75000",
"city": "Ville",
"country": "FRA",
"iban": "FR7611808009101234567890147",
"sequence": "RCUR"
}
}
{
"resultCode": "0",
"reference": "2020110907201100Y0H1102"
}
{
"resultCode": "0",
"redirectUrl": "https://r7espace-souscription3.fr/souscription_ca/signInit.do?idsrq=19027400000054dp9qgtccutu3vj6k9vq09abj&instance=node1",
"redirectInd": "1",
"reference": "202304131551580U0PF1101"
}