Overview
User management
- Users
- User regulatory status
- User e-money
User verification
- User data format
- KYC documents
- UBO declarations
Wallets
- User wallets
- Client wallets
Cards
- Card registrations
- Cards
- Metadata
- Card validations
Card pay-ins
- Direct card pay-ins
- Recurring card pay-ins
- Preauthorizations
- Deposit preauthorizations
- Web card pay-ins
Banking pay-ins
- Bank wires
- Virtual IBAN
- Direct debits
- Web direct debits
APM pay-ins
- Apple Pay
- Bancontact
- BLIK
- Giropay
- Google Pay
- iDEAL
- Klarna
- MB WAY
- Multibanco
- Payconiq
- PayPal
- Satispay
- Swish
- TWINT
Transfers
- Transfers
Refunds
- Refunds
Disputes
- Disputes
- Dispute documents
- Repudiations
- Dispute settlement
Payouts
- Bank accounts
- Payouts
FX conversions
- Conversion rates
- Quotes
- Conversions
Transactions
- Transactions
Helpers
- API responses
- Country authorizations
- Webhooks
- Events
- Reports
Platform account
- Client
- Dashboard permissions
View a Recurring PayIn Registration
<?php
require_once 'vendor/autoload.php';
use MangoPay\MangoPayApi;
use MangoPay\Libraries\ResponseException as MGPResponseException;
use MangoPay\Libraries\Exception as MGPException;
$api = new MangoPayApi();
$api->Config->ClientId = 'your-client-id';
$api->Config->ClientPassword = 'your-api-key';
$api->Config->TemporaryFolder = 'tmp/';
try {
$recurringRegistrationId = "recpayinreg_m_01J2EA0TAVQPNY4JGGF1J7RD97";
$response = $api->PayIns->GetRecurringRegistration($recurringRegistrationId);
print_r($response);
} catch(MGPResponseException $e) {
print_r($e);
} catch(MGPException $e) {
print_r($e);
}
{
"Id": "recpayinreg_m_01JJP2KS2A47A0P7S7CEBQPHT9",
"Status": "IN_PROGRESS",
"ResultCode": null,
"ResultMessage": null,
"CurrentState": {
"PayinsLinked": 2,
"CumulatedDebitedAmount": {
"Currency": "EUR",
"Amount": 20000
},
"CumulatedFeesAmount": {
"Currency": "EUR",
"Amount": 1000
},
"LastPayinId": "payin_m_01JJP59QGFVTMF9Y6YP0K3DXR0"
},
"RecurringType": "CUSTOM",
"TotalAmount": null,
"CycleNumber": null,
"AuthorId": "user_m_01JHX34N3Y9BCQP7KR9QWWETDQ",
"CardId": "card_m_UsklnOoXBWyyqhsN",
"CreditedUserId": "user_m_01JHX34N3Y9BCQP7KR9QWWETDQ",
"CreditedWalletId": "wlt_m_01JJ70WZ9JRAZ9GE0DA36Q84NQ",
"Billing": {
"FirstName": "Alex",
"LastName": "Smith",
"Address": {
"AddressLine1": "6 rue de la Cité",
"AddressLine2": "Appartement 3",
"City": "Paris",
"Region": "île-de-France",
"PostalCode": "75003",
"Country": "FR"
}
},
"Shipping": {
"FirstName": "Alex",
"LastName": "Smith",
"Address": {
"AddressLine1": "6 rue de la Cité",
"AddressLine2": "Appartement 3",
"City": "Paris",
"Region": "île-de-France",
"PostalCode": "75003",
"Country": "FR"
}
},
"EndDate": null,
"Frequency": "Monthly",
"FixedNextAmount": true,
"FractionedPayment": false,
"FreeCycles": 0,
"FirstTransactionDebitedFunds": {
"Currency": "EUR",
"Amount": 10000
},
"FirstTransactionFees": {
"Currency": "EUR",
"Amount": 500
},
"NextTransactionDebitedFunds": null,
"NextTransactionFees": null,
"Migration": false,
"PaymentType": "CARD_DIRECT"
}
Query parameters
The unique identifier of the recurring pay-in registration.
Responses
The unique identifier of the object.
Returned values: CREATED, AUTHENTICATION_NEEDED, IN_PROGRESS, ENDED
The status of the recurring registration:
CREATED– The recurring registration was created, but no recurring pay-in has yet been made.AUTHENTICATION_NEEDED– The latest recurring pay-in linked to the registration object was refused. The registration object can still be used, but you need to execute a new customer-initiated transaction (CIT) for the end user to reauthenticate.IN_PROGRESS– The recurring registration object is in use and the subsequent corresponding recurring pay-ins can be made.ENDED– The recurrence ended: the registration can no longer be modified nor reused.
The code indicating the result of the operation. This information is mostly used to handle errors or for filtering purposes.
The explanation of the result code.
Information about the recurring pay-ins related to the registration object.
Note: If the LastPayinId references a transaction older than 13 months, it may have been archived.
The number of recurring pay-ins already made for the registration object.
The sum of the DebitedFunds amounts of the recurring pay-ins made for the registration.
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 debited funds.
An amount of money in the smallest sub-division of the currency (e.g., EUR 12.60 would be represented as 1260 whereas JPY 12 would be represented as just 12).
The sum of the Fees amounts of the recurring pay-ins made for the registration.
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 fees.
An amount of money in the smallest sub-division of the currency (e.g., EUR 12.60 would be represented as 1260 whereas JPY 12 would be represented as just 12).
The unique identifier of the last recurring pay-in made for the registration.
Returned values: CLASSIC_SUBSCRIPTION, FRACTIONED_PAYMENT, CUSTOM
The type of recurrence, which can be one of the following:
CLASSIC_SUBSCRIPTION– For fixed-amount subscriptions. TheAmountof each pay-in and the subscription’sEndDateare known, and these values cannot be modified during the recurrence.FRACTIONED_PAYMENT– For payments in 3 or 4 times. TheAmountof each pay-in and the registration’sEndDateare known, and these values cannot be modified during the recurrence.CUSTOM– For recurring registrations where theAmountandEndDateare unknown.
The total amount in the registration.
This value is automatically calculated based on the EndDate, FixedNextAmount, and Frequency parameters (if defined).
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 funds.
An amount of money in the smallest sub-division of the currency (e.g., EUR 12.60 would be represented as 1260 whereas JPY 12 would be represented as just 12).
The number of cycles in the registration (and therefore the number of payments).
This value is automatically calculated based on the EndDate, FixedNextAmount, and Frequency parameters (if defined).
The unique identifier of the user at the source of the transaction.
The unique identifier of the Card object, obtained during the card registration process.
Default value: The unique identifier of the owner of the credited wallet.
The unique identifier of the user whose wallet is credited.
The unique identifier of the credited wallet.
Default value: FirstName, LastName, and Address information of the Shipping object if any, otherwise the user (author).
Information about the end user billing address. If left empty, the default values will be automatically taken into account.
The first name of the user.
Max. length: 100 characters
The last name of the user.
Information about the billing address.
Max. length: 255 characters
The first line of the address.
Max. length: 255 characters
The second line of the address.
Max. length: 255 characters
The city of the address.
Max. length: 255 characters
The region of the address. This field is optional except if the Country is US, CA, or MX.
Max. length: 255 characters
The postal code of the address. The postal code can contain the following characters: alphanumeric, dashes, and spaces.
Format: Two-letter country code (ISO 3166-1 alpha-2 format)
The country of the address.
Default value: FirstName, LastName, and Address information of the Billing object, if supplied, otherwise of the user (author).
Information about the end user’s shipping address. If left empty, the default values will be automatically taken into account.
The first name of the user.
Max. length: 100 characters
The last name of the user.
Information about the shipping address.
Max. length: 255 characters
The first line of the address.
Max. length: 255 characters
The second line of the address.
Max. length: 255 characters
The city of the address.
Max. length: 255 characters
The region of the address. This field is optional except if the Country is US, CA, or MX.
Max. length: 255 characters
The postal code of the address. The postal code can contain the following characters: alphanumeric, dashes, and spaces.
Format: Two-letter country code (ISO 3166-1 alpha-2 format)
The country of the address.
The date and time at which the recurring pay-ins will end. This value has no impact on the recurring registration Status.
Caution: If the EndDate is left unspecified, please bear in mind that one could be defined by default and be displayed to your end users (not taken into account in the payment recurrence).
Returned values: Daily, Weekly, TwiceAMonth, Monthly, Bimonthly, Quarterly, Semiannual, Annual, Biannual
The frequency at which the recurring pay-ins will occur:
Daily– 1 transaction per day.Weekly– 1 transaction every 7 days.TwiceAMonth– 2 transactions per month.Monthly– 1 transaction per month.Bimonthly– 1 transaction every 2 months.Quarterly– 1 transaction every 3 months.Semiannual– 1 transaction every 6 months.Annual– 1 transaction per year.Biannual– 1 transaction every 2 years.
Whether or not the recurring pay-ins’ debited amounts remain the same for all the pay-ins linked to the recurring registration object.
Whether or not the recurring pay-ins are being made to split a payment in several installments.
The number of initial consecutive pay-ins where there will be no debited funds nor fees.
This value cannot exceed the CycleNumber value (for recurring objects with an EndDate, FixedNextAmount, and Frequency).
Note: When creating a recurring pay-in (MIT) for a pay-in subject to a free cycle, the DebitedFunds and Fees parameters should be ignored. Otherwise, the pay-in will fail with the corresponding error returned.
The amount of the first recurring pay-in.
This value can be different from the NextTransactionDebitedFunds
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 debited funds.
An amount of money in the smallest sub-division of the currency (e.g., EUR 12.60 would be represented as 1260 whereas JPY 12 would be represented as just 12).
The fees of the first recurring pay-in.
This amount can be different from the NextTransactionDebitedFunds.
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 fees.
An amount of money in the smallest sub-division of the currency (e.g., EUR 12.60 would be represented as 1260 whereas JPY 12 would be represented as just 12).
The amount of the subsequent recurring pay-ins.
If this field is empty and either FixedNextAmount or FractionedPayment are true, the subsequent amount will be the same as FirstTransactionDebitedFunds amount.
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 debited funds.
An amount of money in the smallest sub-division of the currency (e.g., EUR 12.60 would be represented as 1260 whereas JPY 12 would be represented as just 12).
The fees of the subsequent recurring pay-ins.
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 fees.
An amount of money in the smallest sub-division of the currency (e.g., EUR 12.60 would be represented as 1260 whereas JPY 12 would be represented as just 12).
Whether or not to attempt the first recurring pay-in as a merchant-initiated transaction (MIT).
Caution: Migration is no longer supported. You can only use objects with Migration set to false. When Mangopay decommissions this parameter (date communicated by email), the false value will be forced on all objects, including existing ones. Before decommissioning, you need to re-create the object; after decommissioning, you can re-authenticate the same object.
The need to re-authenticate may be indicated by the Status changing to AUTHENTICATION_NEEDED or by errors on the pay-in request, for example: non-existent card account (008008), soft decline (101305), expired card (101105), or stolen card (008003).
Returned values: CARD_DIRECT, PAYPAL
Default value: CARD_DIRECT
The type of recurring pay-in registration (which must correspond to the pay-ins requested against it).
{
"Id": "recpayinreg_m_01JJP2KS2A47A0P7S7CEBQPHT9",
"Status": "IN_PROGRESS",
"ResultCode": null,
"ResultMessage": null,
"CurrentState": {
"PayinsLinked": 2,
"CumulatedDebitedAmount": {
"Currency": "EUR",
"Amount": 20000
},
"CumulatedFeesAmount": {
"Currency": "EUR",
"Amount": 1000
},
"LastPayinId": "payin_m_01JJP59QGFVTMF9Y6YP0K3DXR0"
},
"RecurringType": "CUSTOM",
"TotalAmount": null,
"CycleNumber": null,
"AuthorId": "user_m_01JHX34N3Y9BCQP7KR9QWWETDQ",
"CardId": "card_m_UsklnOoXBWyyqhsN",
"CreditedUserId": "user_m_01JHX34N3Y9BCQP7KR9QWWETDQ",
"CreditedWalletId": "wlt_m_01JJ70WZ9JRAZ9GE0DA36Q84NQ",
"Billing": {
"FirstName": "Alex",
"LastName": "Smith",
"Address": {
"AddressLine1": "6 rue de la Cité",
"AddressLine2": "Appartement 3",
"City": "Paris",
"Region": "île-de-France",
"PostalCode": "75003",
"Country": "FR"
}
},
"Shipping": {
"FirstName": "Alex",
"LastName": "Smith",
"Address": {
"AddressLine1": "6 rue de la Cité",
"AddressLine2": "Appartement 3",
"City": "Paris",
"Region": "île-de-France",
"PostalCode": "75003",
"Country": "FR"
}
},
"EndDate": null,
"Frequency": "Monthly",
"FixedNextAmount": true,
"FractionedPayment": false,
"FreeCycles": 0,
"FirstTransactionDebitedFunds": {
"Currency": "EUR",
"Amount": 10000
},
"FirstTransactionFees": {
"Currency": "EUR",
"Amount": 500
},
"NextTransactionDebitedFunds": null,
"NextTransactionFees": null,
"Migration": false,
"PaymentType": "CARD_DIRECT"
}
<?php
require_once 'vendor/autoload.php';
use MangoPay\MangoPayApi;
use MangoPay\Libraries\ResponseException as MGPResponseException;
use MangoPay\Libraries\Exception as MGPException;
$api = new MangoPayApi();
$api->Config->ClientId = 'your-client-id';
$api->Config->ClientPassword = 'your-api-key';
$api->Config->TemporaryFolder = 'tmp/';
try {
$recurringRegistrationId = "recpayinreg_m_01J2EA0TAVQPNY4JGGF1J7RD97";
$response = $api->PayIns->GetRecurringRegistration($recurringRegistrationId);
print_r($response);
} catch(MGPResponseException $e) {
print_r($e);
} catch(MGPException $e) {
print_r($e);
}
Was this page helpful?
<?php
require_once 'vendor/autoload.php';
use MangoPay\MangoPayApi;
use MangoPay\Libraries\ResponseException as MGPResponseException;
use MangoPay\Libraries\Exception as MGPException;
$api = new MangoPayApi();
$api->Config->ClientId = 'your-client-id';
$api->Config->ClientPassword = 'your-api-key';
$api->Config->TemporaryFolder = 'tmp/';
try {
$recurringRegistrationId = "recpayinreg_m_01J2EA0TAVQPNY4JGGF1J7RD97";
$response = $api->PayIns->GetRecurringRegistration($recurringRegistrationId);
print_r($response);
} catch(MGPResponseException $e) {
print_r($e);
} catch(MGPException $e) {
print_r($e);
}
{
"Id": "recpayinreg_m_01JJP2KS2A47A0P7S7CEBQPHT9",
"Status": "IN_PROGRESS",
"ResultCode": null,
"ResultMessage": null,
"CurrentState": {
"PayinsLinked": 2,
"CumulatedDebitedAmount": {
"Currency": "EUR",
"Amount": 20000
},
"CumulatedFeesAmount": {
"Currency": "EUR",
"Amount": 1000
},
"LastPayinId": "payin_m_01JJP59QGFVTMF9Y6YP0K3DXR0"
},
"RecurringType": "CUSTOM",
"TotalAmount": null,
"CycleNumber": null,
"AuthorId": "user_m_01JHX34N3Y9BCQP7KR9QWWETDQ",
"CardId": "card_m_UsklnOoXBWyyqhsN",
"CreditedUserId": "user_m_01JHX34N3Y9BCQP7KR9QWWETDQ",
"CreditedWalletId": "wlt_m_01JJ70WZ9JRAZ9GE0DA36Q84NQ",
"Billing": {
"FirstName": "Alex",
"LastName": "Smith",
"Address": {
"AddressLine1": "6 rue de la Cité",
"AddressLine2": "Appartement 3",
"City": "Paris",
"Region": "île-de-France",
"PostalCode": "75003",
"Country": "FR"
}
},
"Shipping": {
"FirstName": "Alex",
"LastName": "Smith",
"Address": {
"AddressLine1": "6 rue de la Cité",
"AddressLine2": "Appartement 3",
"City": "Paris",
"Region": "île-de-France",
"PostalCode": "75003",
"Country": "FR"
}
},
"EndDate": null,
"Frequency": "Monthly",
"FixedNextAmount": true,
"FractionedPayment": false,
"FreeCycles": 0,
"FirstTransactionDebitedFunds": {
"Currency": "EUR",
"Amount": 10000
},
"FirstTransactionFees": {
"Currency": "EUR",
"Amount": 500
},
"NextTransactionDebitedFunds": null,
"NextTransactionFees": null,
"Migration": false,
"PaymentType": "CARD_DIRECT"
}