Skip to main content
POST
/
v2.01
/
{ClientId}
/
cardregistrations
curl -X POST https://api.sandbox.mangopay.com/v2.01/{ClientId}/cardregistrations \
  -H 'Content-Type: application/json' \
  -d '{
    "Tag": null,
    "UserId": "user_m_01J7KACBPAV7XAF8AH9BDCJPRS",
    "CardType": "CB_VISA_MASTERCARD",
    "Currency": "EUR"
}  '

{
    "Id": "cardreg_wt_11ed4694-d244-4bd1-92fb-dc473c99a9d4",
    "Tag": null,
    "CreationDate": 1726239226,
    "UserId": "user_m_01J7KACBPAV7XAF8AH9BDCJPRS",
    "AccessKey": "ehvrHoPE6FpjCCAgmNvg",
    "PreregistrationData": "lhOJ6CFiDJPCXViyHjfcayh92nouB3AAaB5yqiLCBT6yjkLPCptmxsUdfffAc6EE4uj9AuSfmwbdfKN3BMechzUU3Gz8ectEx70TDeupudr",
    "RegistrationData": null,
    "CardId": null,
    "CardType": "CB_VISA_MASTERCARD",
    "CardRegistrationURL": "https://pci.sandbox.mangopay.com/api/mangopay/vault/tokenize/eyJjbGllbnQiOiJhbnRob255aF90ZXN0MSIsInRva2VuIjoiUlBQTVdJR1hrd0ZJSGFacyJ9",
    "ResultCode": null,
    "ResultMessage": null,
    "Currency": "EUR",
    "Status": "CREATED"
}
Read more about the Card Registration object →

​
Body parameters

​
Tag
string
Custom data that can be added to this object.
In the case of the Card Registration, this parameter can be used to facilitate the link between the User object and its equivalent on your platform for instance. This value will be inherited by the Card object Tag parameter and will not be editable.
​
UserId
string
required
The unique identifier of the user the card belongs to.
​
CardType
string
Allowed values: CB_VISA_MASTERCARD, AMEX, MAESTRO, BCMCDefault value: CB_VISA_MASTERCARDThe type of the card. If not supplied, the default value will be taken into account.
​
Currency
string
required
Allowed values: The three-letter ISO 4217 code (EUR, GBP, etc.) of a supported currency (depends on feature, contract, and activation settings).The currency of the card.

​
Responses

​
Id
string
The unique identifier of the Card Registration object.
​
Tag
string
Custom data that can be added to this object.
In the case of the Card Registration, this parameter can be used to facilitate the link between the User object and its equivalent on your platform for instance. This value will be inherited by the Card object Tag parameter and will not be editable.
​
CreationDate
Unix timestamp
The date and time at which the object was created.
​
AccessKey
string
The secure value to use when tokenizing the card via the dedicated endpoint.
​
PreregistrationData
string
The secure value to identify the registration when tokenizing the card via the dedicated endpoint.
​
RegistrationData
string
The string returned by the tokenization server, which must be sent in full as the RegistrationData on the PUT Update a Card Registration endpoint to create the Card object.
​
CardId
string
The unique identifier of the Card object, which is returned after updating the Card Registration object with the RegistrationData.
​
CardType
string
Returned values: CB_VISA_MASTERCARD, AMEX, MAESTRO, BCMCDefault value: CB_VISA_MASTERCARDThe type of the card. If not supplied, the default value will be taken into account.
​
CardRegistrationURL
string
The URL to make the card tokenization call.Caution: This variable URL is specific to each card registration. You must rely on the returned URL in full (host, path, and queries) and not hardcode any part of it.
​
ResultCode
string
The code indicating the result of the operation. This information is mostly used to handle errors or for filtering purposes.
​
ResultMessage
string
The explanation of the result code.
​
Currency
string
Returned values: The three-letter ISO 4217 code (EUR, GBP, etc.) of a supported currency (depends on feature, contract, and activation settings).The currency of the card.
​
Status
string
Returned values: CREATED, VALIDATED, ERRORThe status of the card registration:
  • CREATED – The card registration has been created, but no RegistrationData has been entered yet and the CardId value is null.
  • VALIDATED – The card registration has been successfully updated with the RegistrationData from the tokenization server.
  • ERROR – The card registration couldn’t be updated with the RegistrationData and no CardId was generated. For more information, refer to the ResultCode (105206, 105299) and ResultMessage.
{
    "Id": "cardreg_wt_11ed4694-d244-4bd1-92fb-dc473c99a9d4",
    "Tag": null,
    "CreationDate": 1726239226,
    "UserId": "user_m_01J7KACBPAV7XAF8AH9BDCJPRS",
    "AccessKey": "ehvrHoPE6FpjCCAgmNvg",
    "PreregistrationData": "lhOJ6CFiDJPCXViyHjfcayh92nouB3AAaB5yqiLCBT6yjkLPCptmxsUdfffAc6EE4uj9AuSfmwbdfKN3BMechzUU3Gz8ectEx70TDeupudr",
    "RegistrationData": null,
    "CardId": null,
    "CardType": "CB_VISA_MASTERCARD",
    "CardRegistrationURL": "https://pci.sandbox.mangopay.com/api/mangopay/vault/tokenize/eyJjbGllbnQiOiJhbnRob255aF90ZXN0MSIsInRva2VuIjoiUlBQTVdJR1hrd0ZJSGFacyJ9",
    "ResultCode": null,
    "ResultMessage": null,
    "Currency": "EUR",
    "Status": "CREATED"
}

curl -X POST https://api.sandbox.mangopay.com/v2.01/{ClientId}/cardregistrations \
  -H 'Content-Type: application/json' \
  -d '{
    "Tag": null,
    "UserId": "user_m_01J7KACBPAV7XAF8AH9BDCJPRS",
    "CardType": "CB_VISA_MASTERCARD",
    "Currency": "EUR"
}  '