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
- The PayPal PayIn object
- POSTCreate a PayPal PayIn
- PUTAdd tracking information to a PayPal PayIn
- GETView a PayIn (PayPal)
- POST[Deprecated] Create a PayPal PayIn
- The Recurring PayIn Registration object (PayPal)
- POSTCreate a Recurring PayIn Registration (PayPal)
- PUTUpdate a Recurring PayIn Registration (PayPal)
- GETView a Recurring PayIn Registration (PayPal)
- The Recurring PayPal PayIn object
- POSTCreate a Recurring PayPal PayIn (CIT)
- POSTCreate a Recurring PayPal PayIn (MIT)
- 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 (PayPal)
// GET has no body parameters
{
"Id": "recpayinreg_wt_c1fb7e3f-8204-4427-9251-df886fbb4e42",
"Status": "IN_PROGRESS",
"ResultCode": null,
"ResultMessage": null,
"CurrentState": {
"PayinsLinked": 2,
"CumulatedDebitedAmount": {
"Currency": "EUR",
"Amount": 14500
},
"CumulatedFeesAmount": {
"Currency": "EUR",
"Amount": 1000
},
"LastPayinId": "wt_70621ad8-4ea8-4ea5-9893-b4b5ebb1da17"
},
"RecurringType": "CUSTOM",
"TotalAmount": null,
"CycleNumber": null,
"AuthorId": "user_m_01J9KR16BG7EDC8RNEY2M18EXK",
"CardId": null,
"CreditedUserId": null,
"CreditedWalletId": "wlt_m_01J9KR4A7BH8KVE4PG6DTNS817",
"Billing": {
"FirstName": "Ofelia",
"LastName": "Kilback",
"Address": {
"AddressLine1": "8151 Sipes Turnpike",
"AddressLine2": "Garfield Meadows",
"City": "Paris",
"Region": "Île-de-France",
"PostalCode": "75001",
"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": null,
"FixedNextAmount": false,
"FractionedPayment": false,
"FreeCycles": 0,
"FirstTransactionDebitedFunds": {
"Currency": "EUR",
"Amount": 10000
},
"FirstTransactionFees": {
"Currency": "EUR",
"Amount": 1000
},
"NextTransactionDebitedFunds": null,
"NextTransactionFees": null,
"Migration": false,
"PaymentType": "PAYPAL"
}
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 for PayPal:
CREATED– The recurring registration was created, but no recurring pay-in has yet been made.AUTHENTICATION_NEEDED– A customer-initiated transaction (CIT) has been initiated against the registration but not authenticated. Note that there is no re-authentication process with PayPal: this status is only returned after the CIT is initiated but not yet successful.IN_PROGRESS– The CIT has was successful and subsequent merchant-initiated transactions (MIT) can be requested.ENDED– The registration can no longer be modified nor reused. A new one can be created for the same user.
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: CUSTOM
For PayPal recurring registrations, this value is always CUSTOM.
For PayPal recurring registrations, this value is returned null.
For PayPal recurring registrations, this value is returned null.
The unique identifier of the user at the source of the transaction.
For PayPal recurring registrations, this value is returned null.
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.
Information about the end user’s shipping address.
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.
For PayPal recurring registrations, this value is returned null.
For PayPal recurring registrations, this value is returned null.
For PayPal recurring registrations, this value is ignored if sent and automatically returned false. However, you can specify NextTransactionDebitedFunds and NextTransactionFees to set up a fixed-amount recurrence.
For PayPal recurring registrations, this value is returned null.
For PayPal recurring registrations, this value is returned 0.
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).
For PayPal recurring registrations, this value is returned false.
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_wt_c1fb7e3f-8204-4427-9251-df886fbb4e42",
"Status": "IN_PROGRESS",
"ResultCode": null,
"ResultMessage": null,
"CurrentState": {
"PayinsLinked": 2,
"CumulatedDebitedAmount": {
"Currency": "EUR",
"Amount": 14500
},
"CumulatedFeesAmount": {
"Currency": "EUR",
"Amount": 1000
},
"LastPayinId": "wt_70621ad8-4ea8-4ea5-9893-b4b5ebb1da17"
},
"RecurringType": "CUSTOM",
"TotalAmount": null,
"CycleNumber": null,
"AuthorId": "user_m_01J9KR16BG7EDC8RNEY2M18EXK",
"CardId": null,
"CreditedUserId": null,
"CreditedWalletId": "wlt_m_01J9KR4A7BH8KVE4PG6DTNS817",
"Billing": {
"FirstName": "Ofelia",
"LastName": "Kilback",
"Address": {
"AddressLine1": "8151 Sipes Turnpike",
"AddressLine2": "Garfield Meadows",
"City": "Paris",
"Region": "Île-de-France",
"PostalCode": "75001",
"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": null,
"FixedNextAmount": false,
"FractionedPayment": false,
"FreeCycles": 0,
"FirstTransactionDebitedFunds": {
"Currency": "EUR",
"Amount": 10000
},
"FirstTransactionFees": {
"Currency": "EUR",
"Amount": 1000
},
"NextTransactionDebitedFunds": null,
"NextTransactionFees": null,
"Migration": false,
"PaymentType": "PAYPAL"
}
// GET has no body parameters
Was this page helpful?
// GET has no body parameters
{
"Id": "recpayinreg_wt_c1fb7e3f-8204-4427-9251-df886fbb4e42",
"Status": "IN_PROGRESS",
"ResultCode": null,
"ResultMessage": null,
"CurrentState": {
"PayinsLinked": 2,
"CumulatedDebitedAmount": {
"Currency": "EUR",
"Amount": 14500
},
"CumulatedFeesAmount": {
"Currency": "EUR",
"Amount": 1000
},
"LastPayinId": "wt_70621ad8-4ea8-4ea5-9893-b4b5ebb1da17"
},
"RecurringType": "CUSTOM",
"TotalAmount": null,
"CycleNumber": null,
"AuthorId": "user_m_01J9KR16BG7EDC8RNEY2M18EXK",
"CardId": null,
"CreditedUserId": null,
"CreditedWalletId": "wlt_m_01J9KR4A7BH8KVE4PG6DTNS817",
"Billing": {
"FirstName": "Ofelia",
"LastName": "Kilback",
"Address": {
"AddressLine1": "8151 Sipes Turnpike",
"AddressLine2": "Garfield Meadows",
"City": "Paris",
"Region": "Île-de-France",
"PostalCode": "75001",
"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": null,
"FixedNextAmount": false,
"FractionedPayment": false,
"FreeCycles": 0,
"FirstTransactionDebitedFunds": {
"Currency": "EUR",
"Amount": 10000
},
"FirstTransactionFees": {
"Currency": "EUR",
"Amount": 1000
},
"NextTransactionDebitedFunds": null,
"NextTransactionFees": null,
"Migration": false,
"PaymentType": "PAYPAL"
}