{"openapi":"3.1.0","info":{"title":"API Reference","version":"1.0.0"},"paths":{"/v2.01/oauth/token":{"post":{"operationId":"create_oauth_token","summary":"Create OAuth bearer token","description":"<Note icon=\"fa-regular fa-circle-info\">\n**Note – Access tokens for embedded experiences require specific API key**\n\nBefore calling this endpoint to obtain an access token for embedded experiences (second scenario above), you must obtain a dedicated API key. To do so, contact Mangopay <a href=\"https://hub.mangopay.com/\" target=\"_blank\">via the Dashboard</a>.\n\nOnce you have the dedicated API key, encode it in the usual way by using Base64 to encode your Client ID and dedicated API key separated by a colon (`ClientId`:`ApiKey`). For more information, read the [OAuth 2.0 authentication guide](/api-reference/overview/authentication#oauth-2-0-authentication). \n</Note>\n\nGenerate an OAuth bearer token to authenticate your API calls\n\nThis endpoint allows your to generate a bearer token to authenticate subsequent API calls. There are two scenarios, one of which is handled for you if using the server-side SDKs.\n\nFirstly, this endpoint can be used to generates a bearer token to authenticate **all calls to the Mangopay API** as part of [OAuth 2.0 authentication](/api-reference/overview/authentication). The [server-side SDKs](/api-reference/overview/authentication#sdk-authentication) handle this first authentication scenario for you by generating and refreshing the token before expiry.\n\nSecondly, you can use a specific API key with this endpoint to generate a bearer token that subsequently allows you to generate another access token to initialize a Mangopay embedded experience. Once you have the bearer token, you can call one of two endpoints to obtain an access token:\n- [POST Create an access token for the Recipients embedded experience](/api-reference/overview/authentication/create-access-token-recipient) to obtain a token to run the Recipients frontend experience using Mangopay Elements\n- [POST Create an access token for Checkout SDK](/api-reference/overview/authentication/create-access-token-checkout) to obtain a token to initialize Checkout SDK with PayPal One-Click","tags":["Authentication"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateOAuthBearerTokenResponse"}}}}}}},"/v2.01/oauth/token/embedded/recipient":{"post":{"operationId":"create_access_token_recipient","summary":"Create an access token for the Recipients embedded experience","description":"Generate an access token to run the [Recipients frontend embedded experience](/sdks/elements) using Mangopay Elements\n\nA single access token can be used to service the experience to one user and has a lifespan of 15 minutes. You need to provide the `UserId` of the Natural User or Legal User who will use the frontend session to register a Recipient.","tags":["Authentication"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecipientAccessTokenResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAnAccessTokenForTheRecipientsEmbeddedExperienceRequest"}}}}}},"/v2.01/oauth/token/embedded/checkout":{"post":{"operationId":"create_access_token_checkout","summary":"Create an access token for Checkout SDK features","description":"Generate an access token to initialize the [Checkout SDK](/sdks/checkout/web) to offer PayPal One-Click.\n\nThe access token returned by this endpoint is only required for the following features using Checkout SDK:\n- [PayPal One-Click](/sdks/checkout/web#configuring-paypal-one-click-payments)\n\nYou do not need an access token if using Checkout SDK to service other payment methods or PayPal without PayPal One-Click. \n\nA single access token can be used to service the experience to one user and has a lifespan of 15 minutes. You need to provide the `UserId` of the Natural User or Legal User who will use the Checkout session to make the payment.","tags":["Authentication"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckoutAccessTokenResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAnAccessTokenForCheckoutSdkFeaturesRequest"}}}}}},"/v2.01/{ClientId}/sca/users/natural":{"post":{"operationId":"create_natural_user_sca","summary":"Create a Natural User (SCA)","description":"Register a Natural Payer or Owner (with SCA enrollment)\n\n<Note icon=\"fa-regular fa-circle-info\">\n**Note – SCA triggered for Owners**\n\nIf `UserCategory` is `OWNER`, this endpoint triggers SCA enrollment.\n\nYour platform needs to use the returned `PendingUserAction.RedirectUrl` (and add an encoded `returnUrl` query parameter) to redirect the user so they can enroll. Read more about how to redirect them in the [SCA session](/guides/sca/session) guide.\n\nIn Sandbox, you can bypass SCA by including the word `accept` in the Natural User's `Email` – for example `accept@example.com` or `john.doe+accept@example.com`.\n</Note>\n\n<Note icon=\"fa-regular fa-circle-info\">\n**Note – Country-based restrictions apply to users**\n\nDue to Mangopay's [country restrictions](/guides/users/country-restrictions), it is not possible to use blocked countries as the following:\n- `Nationality`\n- `CountryOfResidence`\n- `Address.Country`\n</Note>","tags":["Users"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NaturalUserSCAResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateANaturalUserSCARequest"}}}}}},"/v2.01/{ClientId}/sca/users/natural/{UserId}":{"put":{"operationId":"update_natural_user_sca","summary":"Update a Natural User (SCA)","description":"Modify details for a Natural Payer or Owner without changing category.\n\n<Warning icon=\"fa-regular fa-triangle-exclamation\">\n**Caution – Modification may trigger SCA re-enrollment**\n\nIf `UserCategory` is `OWNER`, modifying the following values changes `UserStatus` to `PENDING_USER_ACTION` and requires [re-enrollment in SCA](/guides/sca/users#re-enroll-an-enrolled-owner) using the returned `PendingUserAction.RedirectUrl`:\n\n- `Email`\n- `PhoneNumber`\n- `PhoneNumberCountry`\n\nIn Sandbox, you can bypass SCA by including the word `accept` in the Natural User's `Email` – for example `accept@example.com` or `john.doe+accept@example.com`.\n</Warning>\n\n<Warning icon=\"fa-regular fa-triangle-exclamation\">\n**Caution – Modification may cause KYC/B verification downgrade** \n\nIf `KYCLevel` is `REGULAR`, modifying the following values triggers a [verification downgrade](/guides/users/verification/downgrade) to `LIGHT`: \n- `FirstName`\n- `LastName`\n- `Birthday`\n- `Nationality`\n</Warning>\n\n<Note icon=\"fa-regular fa-circle-info\">\n**Note – Country-based restrictions apply to users**\n\nDue to Mangopay's [country restrictions](/guides/users/country-restrictions), it is not possible to use blocked countries as the following:\n- `Nationality`\n- `CountryOfResidence`\n- `Address.Country`\n</Note>","tags":["Users"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"UserId","in":"path","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NaturalUserSCAResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateANaturalUserSCARequest"}}}}}},"/v2.01/{ClientId}/sca/users/natural/{UserId}/category":{"put":{"operationId":"categorize_natural_user","summary":"Categorize a Natural User","description":"Transition a Natural Payer to Owner and enroll them in SCA.\n\nThis endpoint allows you to transition a user whose `UserCategory` is `PAYER` into an `OWNER` by providing the required information and redirecting them on the `PendingUserAction.RedirectUrl` response value to complete SCA enrollment.\n\nOptionally, you can update the `Email` and provide or update the `PhoneNumber` and `PhoneNumberCountry` before SCA redirection.\n\nIf the user's `UserCategory` is already `OWNER`, use the [POST Enroll a User in SCA](/api-reference/users/enroll-user) endpoint to obtain an SCA session link.\n\n[Read more about SCA redirection](/guides/sca/session) **&rarr;**\n\n<Note icon=\"fa-regular fa-circle-info\">\n**Note – Country-based restrictions apply to users**\n\nDue to Mangopay's [country restrictions](/guides/users/country-restrictions), it is not possible to use blocked countries as the following:\n- `Nationality`\n- `CountryOfResidence`\n</Note>","tags":["Users"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"UserId","in":"path","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NaturalUserSCAResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CategorizeANaturalUserRequest"}}}}}},"/v2.01/{ClientId}/sca/users/legal":{"post":{"operationId":"create_legal_user_sca","summary":"Create a Legal User (SCA)","description":"Register a Legal Payer or Owner (with SCA enrollment).\n\n<Note icon=\"fa-regular fa-circle-info\">\n**Note – SCA triggered for Owners**\n\nIf `UserCategory` is `OWNER`, this endpoint triggers SCA enrollment. SCA applies to all `LegalPersonType`.\n\nYour platform needs to use the returned `PendingUserAction.RedirectUrl` (and add an encoded `returnUrl` query parameter) to redirect the user so they can enroll. Read more about how to redirect them in the [SCA session](/guides/sca/session) guide.\n\nIn Sandbox, you can bypass SCA by including the word `accept` in the Legal User's `LegalRepresentative.Email` – for example `accept@example.com` or `john.doe+accept@example.com`.\n</Note>\n\n<Note icon=\"fa-regular fa-circle-info\">\n**Note – Legal representative's email required for Owners**\n\nIf `UserCategory` is `OWNER`, the `LegalRepresentative.Email` address is required.\n\nSCA uses this email address for the individual who will complete SCA to build a [behavioral biometrics profile](/guides/sca/factors#email-confirmation-behavioral-biometrics) and as a backup communication channel. Prior to SCA, it was possible to create a Legal `OWNER` without the `LegalRepresentativeEmail`.\n</Note>\n\n<Note icon=\"fa-regular fa-circle-info\">\n**Note – Country-based restrictions apply to users**\n\nDue to Mangopay's [country restrictions](/guides/users/country-restrictions), it is not possible to use blocked countries as the following:\n- `HeadquartersAddress.Country`\n- `LegalRepresentative.Nationality`\n- `LegalRepresentative.CountryOfResidence`\n- `LegalRepresentativeAddress.Country`\n</Note>","tags":["Users"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LegalUserSCAResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateALegalUserSCARequest"}}}}}},"/v2.01/{ClientId}/sca/users/legal/{UserId}":{"put":{"operationId":"update_legal_user_sca","summary":"Update a Legal User (SCA)","description":"Modify details for a Legal Payer or Owner without changing category.\n\n<Warning icon=\"fa-regular fa-triangle-exclamation\">\n**Caution – Modification may trigger SCA re-enrollment**\n\nIf `UserCategory` is `OWNER`, modifying the following values changes `UserStatus` to `PENDING_USER_ACTION` and requires [re-enrollment in SCA](/guides/sca/users#re-enroll-an-enrolled-owner) using the returned `PendingUserAction.RedirectUrl`:\n\n- `LegalRepresentative.Email`\n- `LegalRepresentative.PhoneNumber`\n- `LegalRepresentative.PhoneNumberCountry`\n\nIn Sandbox, you can bypass SCA by including the word `accept` in the Legal User's `LegalRepresentative.Email` – for example `accept@example.com` or `john.doe+accept@example.com`.\n</Warning>\n\n<Warning icon=\"fa-regular fa-triangle-exclamation\">\n**Caution – Modification may cause KYC/B verification downgrade** \n\nIf `KYCLevel` is `REGULAR`, modifying the following values triggers a [verification downgrade](/guides/users/verification/downgrade) to `LIGHT`: \n- `LegalRepresentative.FirstName`\n- `LegalRepresentative.LastName`\n- `LegalRepresentative.Birthday`\n- `LegalRepresentative.Nationality`\n- `LegalPersonType`\n</Warning>\n\n<Note icon=\"fa-regular fa-circle-info\">\n**Note – Country-based restrictions apply to users**\n\nDue to Mangopay's [country restrictions](/guides/users/country-restrictions), it is not possible to use blocked countries as the following:\n- `HeadquartersAddress.Country`\n- `LegalRepresentative.Nationality`\n- `LegalRepresentative.CountryOfResidence`\n- `LegalRepresentativeAddress.Country`\n</Note>","tags":["Users"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"UserId","in":"path","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LegalUserSCAResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateALegalUserSCARequest"}}}}}},"/v2.01/{ClientId}/sca/users/legal/{UserId}/category":{"put":{"operationId":"categorize_legal_user","summary":"Categorize a Legal User","description":"Transition a Legal Payer to Owner and enroll them in SCA\n\nThis endpoint allows you to transition a user whose `UserCategory` is `PAYER` into an `OWNER` by providing the required information and redirecting them on the `PendingUserAction.RedirectUrl` response value to complete SCA enrollment.\n\nSCA applies to all `LegalPersonType`: `BUSINESS`, `ORGANIZATION`, `PARTNERSHIP`, and `SOLETRADER`. In Sandbox the `RedirectUrl` is returned for all legal user types (see [legal user integration](/guides/sca/users#legal-user-integration) and [SCA triggers in Sandbox](/guides/sca/users#sca-triggers-in-sandbox)).\n\nOptionally, you can update the `LegalRepresentative.Email` (in not already present) and provide or update the `LegalRepresentative.PhoneNumber` and `LegalRepresentative.PhoneNumberCountry` before SCA redirection.\n\nIf the user's `UserCategory` is already `OWNER`, use the [POST Enroll a User in SCA](/api-reference/users/enroll-user) endpoint to obtain an SCA session link.\n\n[Read more about SCA redirection](/guides/sca/session) **&rarr;**\n\n<Note icon=\"fa-regular fa-circle-info\">\n**Note – Country-based restrictions apply to users**\n\nDue to Mangopay's [country restrictions](/guides/users/country-restrictions), it is not possible to use blocked countries as the following:\n- `LegalRepresentative.Nationality`\n- `LegalRepresentative.CountryOfResidence`\n</Note>","tags":["Users"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"UserId","in":"path","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LegalUserSCAResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CategorizeALegalUserRequest"}}}}}},"/v2.01/{ClientId}/sca/users/{UserId}/enrollment":{"post":{"operationId":"enroll_user","summary":"Enroll a User in SCA","description":"Obtain an SCA redirection link to enroll an Owner user.\n\nIf `UserCategory` is `OWNER`, this endpoint allows you to enroll a user in SCA. To enroll `PAYER` users for the first time, use the [PUT Categorize a Natural User](/api-reference/users/categorize-natural-user) or [PUT Categorize a Legal User](/api-reference/users/categorize-legal-user) endpoints.\n\nYour platform needs to retrieve the returned `PendingUserAction.RedirectUrl`, add an encoded `returnUrl` query parameter for them to be returned to after the SCA session, and redirect the user.\n\n[Read more about SCA redirection](/guides/sca/session) **&rarr;**\n\nYou can use this endpoint to obtain a new session `RedirectUrl`. This is useful to: \n- Enroll Owners created without SCA enrollment\n- Retry enrollment if a previous session was unsuccessful or expired (after 10 minutes)\n\nCalling this endpoint creates a new valid session that can be used, even if there is one already in progress for the user. Calling this endpoint also doesn't change the user's `UserStatus`, even if the session expires or is unsuccessful.\n\n<Note icon=\"fa-regular fa-circle-info\">\n**Note – This endpoint doesn't change UserStatus**\n\nCalling this endpoint does **not** change the user's status to `PENDING_USER_ACTION` (it stays as `ACTIVE`) and no `USER_ACCOUNT_VALIDATION_ASKED` webhook notification is sent.\n\nThis ensures that legacy users do not become blocked if they are unable to complete SCA successfully.\n</Note>\n\n<Warning icon=\"fa-regular fa-triangle-exclamation\">\n**Caution – Legal representative's email required**\n\nFor `OWNER` users, the `LegalRepresentative.Email` address is required.\n\nSCA uses this email address to build a [behavioral biometrics profile](/guides/sca/factors#email-confirmation-behavioral-biometrics) and as a backup communication channel.\n\nPrior to SCA, it was possible to create a Legal `OWNER` without the `LegalRepresentativeEmail`, so this data may be missing. Calling this endpoint without this data will return an error.\n</Warning>","tags":["Users"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"UserId","in":"path","description":"The unique identifier of the user.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnrollUserManageProxyConsentResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v2.01/{ClientId}/sca/users/{UserId}/consent":{"post":{"operationId":"manage_proxy_consent","summary":"Manage proxy consent for a User","description":"Allow a user to give or revoke consent for proxy actions. \n\nThis endpoint allows your platform to manage consent given by the end user for [SCA-triggering actions taken under proxy](/guides/sca/proxy-management).\n\nYour platform needs to retrieve the returned `PendingUserAction.RedirectUrl`, add an encoded `returnUrl` query parameter for them to be returned to after the SCA session, and redirect the user (read more about [SCA redirection](/guides/sca/session)).\n\nOn the SCA session link in the response, the user can: \n- Give consent for the first time \n- Give consent to additional actions included by your platform \n- Revoke consent (which your platform must allow at any time)\n\nRead more about [proxy consent for SCA-triggering actions](/guides/sca/proxy-management) **&rarr;**\"","tags":["Users"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"UserId","in":"path","description":"The unique identifier of the user.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnrollUserManageProxyConsentResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v2.01/{ClientId}/sca/users/{UserId}/sca-status":{"get":{"operationId":"view_user_sca_status","summary":"View the SCA status of a User","description":"Retrieve SCA and consent information for a Natural or Legal User.\n\nThis endpoint returns information for an `OWNER` user relating to:\n- Whether or not they are enrolled in SCA – but if they never triggered an SCA enrollment, the endpoint returns a 404\n- Their consent for your platform to take [SCA-triggering actions by proxy](/guides/sca/proxy-management), if activated for your platform","tags":["Users"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"UserId","in":"path","description":"The unique identifier of the user.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ViewTheSCAStatusOfAUserResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v2.01/{ClientId}/sca/users/{UserId}":{"get":{"operationId":"view_user_sca","summary":"View a User (SCA)","description":"Retrieve a Natural or Legal User.\n\nThis endpoint returns the same data as the legacy [GET View a User](/api-reference/users/view-user), including the new `PENDING_USER_ACTION` value for `UserStatus`, with two minor changes: \n- The `PendingUserAction` field, which is always `null` on this endpoint\n- For Legal users, the `LegalRepresentative` object, which contains the data for the legal representative\n\n<Note icon=\"fa-regular fa-circle-info\">\n**Note – `RedirectUrl` not available on this endpoint**\n\nThe `RedirectUrl` is only returned on API calls that trigger SCA. \n\nTo obtain a new session link for an Owner, call the [POST Enroll a User in SCA](/api-reference/users/enroll-user) endpoint.\n</Note>\n\n[Read more](/guides/sca/users#view-and-list-users) **&rarr;**","tags":["Users"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"UserId","in":"path","description":"The unique identifier of the user.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ViewAUserSCAResponse"}}}}}}},"/v2.01/{ClientId}/users":{"get":{"operationId":"list_users","summary":"List all Users","description":"List User objects and key details.\n\nThis endpoint returns key information for each user created by the platform.","tags":["Users"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start value: `1`\n\n**Default value:** `1`\n\nIndicates the index of the page for the pagination.","required":false,"schema":{"type":"integer"}},{"name":"per_page","in":"query","description":"Min. value: `1`; max. value: `100`\n\n**Default value:** `10`\n\nIndicates the number of items returned for each page of the pagination.","required":false,"schema":{"type":"integer"}},{"name":"Sort","in":"query","description":"**Possible values:** `CreationDate:ASC`, `CreationDate:DESC`\n\n**Default value:** `CreationDate:ASC`\n\nIndicates the direction in which to sort the list.","required":false,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListAllUsersResponse"}}}}}}},"/v2.01/{ClientId}/users/natural/{UserId}":{"delete":{"operationId":"close_natural_user","summary":"Close a Natural User","description":"Permanently close a user account so it can no longer be used.\n\nThis endpoint allows your platform to close a Mangopay Account, as per Mangopay's terms and conditions, in the event that the agreement between the user and the platform comes to an end.\n\n<Warning icon=\"fa-regular fa-triangle-exclamation\">\n**Caution – Closure is irreversible**\n\nCalling this endpoint immediately and permanently changes the `UserStatus` to `CLOSED` if the API call is successful. This cannot be undone, even by Mangopay. \n\nYour platform can re-register the user using [POST Create a Natural User (SCA)](/api-reference/users/create-natural-user-sca).\n</Warning>\n\nClosure is only possible if all wallets held by the user are empty. Closure is allowed for both `UserCategory` `OWNER` and `PAYER`.\n\nWhen a User is closed (whether via this endpoint or by Mangopay): \n- The `UserStatus` changes to `CLOSED` (and the `USER_ACCOUNT_CLOSED` [webhook](/webhooks/event-types#account-closure) is sent)\n- The user has inflows and outflows [blocked](/guides/users/blocked-users) (and the relevant [webhooks](/webhooks/event-types#user-regulatory-status) are sent)\n- The user object remains available via the API and Dashboard for historical purposes\n\nClosing a user account does not affect Mangopay's data retention obligations or processes. Personal data associated with the closed account will be retained in accordance with Mangopay's data retention policies.\n\n<Note icon=\"fa-regular fa-circle-info\">\n**Note – Do not overuse OAuth token endpoint if automating calls**\n\nIf you are writing a script to close a set of users, ensure you do not call the OAuth token endpoint before each DELETE call. You must use your authentication for the full duration of its lifetime, as described in the [authentication](/api-reference/overview/authentication#2-use-the-bearer-token-for-its-full-lifetime) guide.\n\nOveruse of the OAuth token endpoint is a security and performance risk and may result in preventative action from Mangopay.\n</Note>","tags":["Users"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"UserId","in":"path","description":"The unique identifier of the user.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content – Closure was successful","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"put":{"operationId":"update_natural_user","summary":"Update a Natural User","description":"<Warning icon=\"fa-regular fa-triangle-exclamation\">\n**Caution - Deprecated endpoint**\n\nThe legacy User endpoints are deprecated. This endpoint will stop working and return an error after **Dec 15, 2025**.\n\nThese endpoints were made redundant by the equivalent SCA-enabled endpoints during the introduction of SCA. \n\nInstead of calling this endpoint to change the `UserCategory` from `PAYER` to `OWNER`, your platform must call [PUT Categorize a Natural User](/api-reference/users/categorize-natural-user). You must also redirect the user on the `PendingUserAction.RedirectUrl` returned so they can [enroll in SCA](/guides/sca/users#transition-a-payer-to-owner).\n\nIf you are not changing the `UserCategory`, then call the [PUT Update a Natural User (SCA)](/api-reference/users/update-natural-user-sca) endpoint instead of this deprecated endpoint. [SCA re-enrollment](/guides/sca/users#re-enroll-an-enrolled-owner) is required if your platform changes the `Email`, `PhoneNumber`, or `PhoneNumberCountry`.\n</Warning>\n\n<Warning icon=\"fa-regular fa-triangle-exclamation\">\n**Caution – Modification may cause KYC/B verification downgrade** \n\nIf `KYCLevel` is `REGULAR`, modifying the following values triggers a [verification downgrade](/guides/users/verification/downgrade) to `LIGHT`: \n- `FirstName`\n- `LastName`\n- `Birthday`\n- `Nationality`\n</Warning>\n\n<Note icon=\"fa-regular fa-circle-info\">\n**Note – Country-based restrictions apply to users**\n\nDue to Mangopay's [country restrictions](/guides/users/country-restrictions), it is not possible to use blocked countries as the following:\n- `Nationality`\n- `CountryOfResidence`\n- `Address.Country`\n</Note>\n\nUpdate a Natural User","tags":["Users"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"UserId","in":"path","description":"The unique identifier of the user.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NaturalUserResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"deprecated":true,"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateANaturalUserRequest"}}}}}},"/v2.01/{ClientId}/users/legal/{UserId}":{"delete":{"operationId":"close_legal_user","summary":"Close a Legal User","description":"Permanently close a user account so it can no longer be used.\n\nThis endpoint allows your platform to close a Mangopay Account, as per Mangopay's terms and conditions, in the event that the agreement between the user and the platform comes to an end.\n\n<Warning icon=\"fa-regular fa-triangle-exclamation\">\n**Caution – Closure is irreversible**\n\nCalling this endpoint immediately and permanently changes the `UserStatus` to `CLOSED` if the API call is successful. This cannot be undone, even by Mangopay. \n\nYour platform can re-register the user using [POST Create a Legal User (SCA)](/api-reference/users/create-legal-user-sca).\n</Warning>\n\nClosure is only possible if all wallets held by the user are empty. Closure is allowed for both `UserCategory` `OWNER` and `PAYER` and for all types of Legal user (Business, Partnership, Organization, Soletrader).\n\nWhen a User is closed (whether via this endpoint or by Mangopay): \n- The `UserStatus` changes to `CLOSED` (and the `USER_ACCOUNT_CLOSED` [webhook](/webhooks/event-types#account-closure) is sent)\n- The user has inflows and outflows [blocked](/guides/users/blocked-users) (and the relevant [webhooks](/webhooks/event-types#user-regulatory-status) are sent)\n- The user object remains available via the API and Dashboard for historical purposes\n\nClosing a user account does not affect Mangopay's data retention obligations or processes. Personal data associated with the closed account will be retained in accordance with Mangopay's data retention policies.\n\n<Note icon=\"fa-regular fa-circle-info\">\n**Note – Do not overuse OAuth token endpoint if automating calls**\n\nIf you are writing a script to close a set of users, ensure you do not call the OAuth token endpoint before each DELETE call. You must use your authentication for the full duration of its lifetime, as described in the [authentication](/api-reference/overview/authentication#2-use-the-bearer-token-for-its-full-lifetime) guide.\n\nOveruse of the OAuth token endpoint is a security and performance risk and may result in preventative action from Mangopay.\n</Note>","tags":["Users"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"UserId","in":"path","description":"The unique identifier of the user.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content – Closure was successful","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"put":{"operationId":"update_legal_user","summary":"Update a Legal User","description":"<Warning icon=\"fa-regular fa-triangle-exclamation\">\n**Caution - Deprecated endpoint**\n\nThe legacy User endpoints are deprecated. This endpoint will stop working and return an error after **Dec 15, 2025**.\n\nThese endpoints were made redundant by the equivalent SCA-enabled endpoints during the introduction of SCA. \n\nInstead of calling this endpoint to change the `UserCategory` from `PAYER` to `OWNER`, your platform must call [PUT Categorize a Legal User](/api-reference/users/categorize-legal-user). You must also redirect the user on the `PendingUserAction.RedirectUrl` returned so they can [enroll in SCA](/guides/sca/users#transition-a-payer-to-owner).\n\nIf you are not changing the `UserCategory`, then call the [PUT Update a Legal User (SCA)](/api-reference/users/update-legal-user-sca) endpoint instead of this deprecated endpoint. [SCA re-enrollment](/guides/sca/users#re-enroll-an-enrolled-owner) is required if your platform changes the `Email`, `PhoneNumber`, or `PhoneNumberCountry`.\n</Warning>\n\n<Warning icon=\"fa-regular fa-triangle-exclamation\">\n**Caution – Modification may cause KYC/B verification downgrade** \n\nIf `KYCLevel` is `REGULAR`, modifying the following values triggers a [verification downgrade](/guides/users/verification/downgrade) to `LIGHT`: \n- `LegalRepresentativeFirstName`\n- `LegalRepresentativeLastName`\n- `LegalRepresentativeBirthday`\n- `LegalRepresentativeNationality`\n- `LegalPersonType`\n</Warning>\n\n<Note icon=\"fa-regular fa-circle-info\">\n**Note – Country-based restrictions apply to users**\n\nDue to Mangopay's [country restrictions](/guides/users/country-restrictions), it is not possible to use blocked countries as the following:\n- `HeadquartersAddress.Country`\n- `LegalRepresentativeNationality`\n- `LegalRepresentativeCountryOfResidence`\n- `LegalRepresentativeAddress.Country`\n</Note>\n\nUpdate a Legal User","tags":["Users"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"UserId","in":"path","description":"The unique identifier of the user.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LegalUserResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"deprecated":true,"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateALegalUserRequest"}}}}}},"/v2.01/{ClientId}/users/natural":{"post":{"operationId":"create_natural_user","summary":"Create a Natural User","description":"<Warning icon=\"fa-regular fa-triangle-exclamation\">\n**Caution - Deprecated endpoint**\n\nThe legacy User endpoints are deprecated. This endpoint will stop working and return an error after **Dec 15, 2025**.\n\nThese endpoints were made redundant by the equivalent SCA-enabled endpoints during the introduction of SCA. \n\nInstead of calling this endpoint for user creation, your platform must call [POST Create a Natural User (SCA)](/api-reference/users/create-natural-user-sca).\n</Warning>\n\n<Note icon=\"fa-regular fa-circle-info\">\n**Note – Country-based restrictions apply to users**\n\nDue to Mangopay's [country restrictions](/guides/users/country-restrictions), it is not possible to use blocked countries as the following:\n- `Nationality`\n- `CountryOfResidence`\n- `Address.Country`\n</Note>\n\nCreate a Natural User","tags":["Users"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NaturalUserResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"deprecated":true,"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateANaturalUserRequest"}}}}}},"/v2.01/{ClientId}/users/legal":{"post":{"operationId":"create_legal_user","summary":"Create a Legal User","description":"<Warning icon=\"fa-regular fa-triangle-exclamation\">\n**Caution - Deprecated endpoint**\n\nThe legacy User endpoints are deprecated. This endpoint will stop working and return an error after **Dec 15, 2025**.\n\nThese endpoints were made redundant by the equivalent SCA-enabled endpoints during the introduction of SCA. \n\nInstead of calling this endpoint for user creation, your platform must call [POST Create a Legal User (SCA)](/api-reference/users/create-legal-user-sca).\n</Warning>\n\n<Note icon=\"fa-regular fa-circle-info\">\n**Note – Country-based restrictions apply to users**\n\nDue to Mangopay's [country restrictions](/guides/users/country-restrictions), it is not possible to use blocked countries as the following:\n- `HeadquartersAddress.Country`\n- `LegalRepresentativeNationality`\n- `LegalRepresentativeCountryOfResidence`\n- `LegalRepresentativeAddress.Country`\n</Note>\n\nCreate a Legal User","tags":["Users"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LegalUserResponse"}}}}},"deprecated":true,"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateALegalUserRequest"}}}}}},"/v2.01/{ClientId}/users/{UserId}":{"get":{"operationId":"view_user","summary":"View a User","description":"<Warning icon=\"fa-regular fa-triangle-exclamation\">\n**Caution - Deprecated endpoint**\n\nThe legacy User endpoints are deprecated. This endpoint will stop working and return an error after **Dec 15, 2025**.\n\nThese endpoints were made redundant by the equivalent SCA-enabled endpoints during the introduction of SCA. \n\nInstead of calling this endpoint to retrieve key details of a user, your platform must call the [GET View a User (SCA)](/api-reference/users/view-user-sca) endpoint.\n</Warning>\n\nView a User","tags":["Users"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"UserId","in":"path","description":"The unique identifier of the user.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ViewAUserResponse"}}}}},"deprecated":true}},"/v2.01/{ClientId}/users/{UserId}/regulatory":{"get":{"operationId":"view_user_regulatory_status","summary":"View a User Regulatory Status","description":"View a User Regulatory Status","tags":["userRegulatoryStatus"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"UserId","in":"path","description":"The unique identifier of the user.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserRegulatoryStatusResponse"}}}}}}},"/v2.01/{ClientId}/users/{UserId}/emoney/{Year}/{Month}":{"get":{"operationId":"view_user_emoney","summary":"View User EMoney","description":"View User EMoney\n\nThe path parameters `Month` and `Year` are optional. If not given, this call returns all the credited and debited e-money since the user was created.","tags":["userEmoney"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"UserId","in":"path","description":"The unique identifier of the user.","required":true,"schema":{"type":"string"}},{"name":"Year","in":"path","description":"The year by which to filter the returned values.","required":true,"schema":{"type":"string"}},{"name":"Month","in":"path","description":"The month by which to filter the returned values.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ViewUserEMoneyResponse"}}}}}}},"/v2.01/{ClientId}/users/{UserId}/identity-verifications":{"post":{"operationId":"create_idv_session","summary":"Create an IDV Session","description":"Initiate a hosted KYC/KYB session and obtain a unique URL for the hosted frontend experience.\n\nBy default, the returned `HostedUrl` must be completed and submitted within 7 days of creation. If the session contains a liveness step and that step has been started (the QR code was generated), the session instead expires 1 hour after the liveness step started.\n\nThe steps presented to the user depend on their [User type](/guides/users/types): [Natural](/guides/users/verification/hosted/natural), [Soletrader](/guides/users/verification/hosted/soletrader), and [Business and Organization](/guides/users/verification/hosted/business) (or [Business - Legacy](/guides/users/verification/hosted/business-legacy) / [Organization - Legacy](/guides/users/verification/hosted/organization-legacy)).\nIf the user already has an IDV Session with a `Status` of `PENDING`, that existing session is returned instead of creating a new one.\n\n[Read more about hosted KYC/KYB](/guides/users/verification/hosted) **&rarr;**","tags":["idvSessions"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"UserId","in":"path","description":"The unique identifier of the user.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAnIDVSessionResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAnIDVSessionRequest"}}}}},"get":{"operationId":"list_idv_sessions_user","summary":"List IDV Sessions for a User","description":"Retrieve key details of all hosted KYC/KYB sessions attempted for a user. To view the full details of a specific session, including checks and verified data, use [GET View an IDV Session](/api-reference/idv-sessions/view-idv-session).\n\n[Read more about hosted KYC/KYB](/guides/users/verification/hosted) **&rarr;**","tags":["idvSessions"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"UserId","in":"path","description":"The unique identifier of the user.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListIDVSessionsForAUserResponse"}}}}}}},"/v2.01/{ClientId}/identity-verifications/{IdvSessionId}":{"get":{"operationId":"view_idv_session","summary":"View an IDV Session","description":"See details of a hosted KYC/KYB session, outcome of checks, and verified data. For a Business User on the multi-session PSC flow, this also returns the `PSCs` array with each declared PSC's own status and hosted link.\n\n[Read more about hosted KYC/KYB](/guides/users/verification/hosted) **&rarr;**","tags":["idvSessions"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"IdvSessionId","in":"path","description":"The unique identifier of the IDV Session.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ViewAnIDVSessionResponse"}}}}}}},"/v2.01/{ClientId}/identity-verifications/{IdvSessionId}/pscs/{PscId}/retry":{"put":{"operationId":"retry_psc_session","summary":"Retry a PSC Session","description":"Retry a PSC Session based on its `Id`. Send an empty body (`{}`) to use the existing details declared for the individual and only retry the liveness check, or else send updated details in the request body.\n\nIf the PSC's `Status` is `PENDING_VALIDATION`, the existing session link is returned. If the PSC's `Status` is `VALIDATED` or `REJECTED`, a new session link is generated. A PSC whose `Status` is `ABANDONED` cannot be retried. To add a missing PSC, contact Mangopay <a href=\"https://hub.mangopay.com/\" target=\"_blank\">via the Dashboard</a>, who will create the new PSC and provide you with a session link.\n\n[Read more about the multi-session PSC flow](/guides/users/verification/hosted/business) **&rarr;**","tags":["idvSessions"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"IdvSessionId","in":"path","description":"The unique identifier of the IDV Session.","required":true,"schema":{"type":"string"}},{"name":"PscId","in":"path","description":"The unique identifier of the PSC.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetryPscSessionResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetryPscSessionRequest"}}}}}},"/v2.01/{ClientId}/users/data-formats/validation":{"post":{"operationId":"validate_user_data_format","summary":"Validate the format of User data","description":"<Warning icon=\"fa-regular fa-triangle-exclamation\">   \n**Caution – Veracity of data checked during verification** \n\nThis endpoint only checks that the format of the data corresponds to that which is expected. Whether or not the data is true and correct for the specific User is checked during the user verification process when documents are submitted.  \n</Warning>\n\nValidate the format of User data\n\nThis endpoint allows you to check that the format of the `CompanyNumber` is correct and retrieve the validation rules applied to it.\n\nThe `CompanyNumber` must be in the correct format for Business Legal Users to be KYC/B verified.","tags":["userDataFormat"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidateTheFormatOfUserDataResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidateTheFormatOfUserDataRequest"}}}}}},"/v2.01/{ClientId}/users/{UserId}/kyc/documents":{"post":{"operationId":"create_kyc_document","summary":"Create a KYC Document","description":"Create a container for files to be submitted\n\n<Warning icon=\"fa-regular fa-triangle-exclamation\">\n**Caution – Legacy endpoints being superseded by the hosted KYC/KYB solution**\n\nMangopay's [hosted KYC/KYB solution](/guides/users/verification/hosted) is becoming mandatory for all platforms (relying on the [IDV Session](/api-reference/idv-sessions/idv-session-object) object). The legacy KYC Document endpoints remain available for the sole purposes of [sending additional documents](/guides/users/verification/hosted#sending-additional-documents), but this use case will also be handled by the hosted solution in future.\n</Warning>\n\nIn Sandbox, you can set the KYC Document `Tag` to `accept` to simulate acceptance of the document after submission. Other values are available to simulate different refusal reasons – [see the guide for details](/guides/users/verification/documents/submission/how-to).","tags":["kycDocuments"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"UserId","in":"path","description":"The unique identifier of the user.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KYCDocumentResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateADisputeDocumentRequest"}}}}},"get":{"operationId":"list_kyc_documents_user","summary":"List KYC Documents for a User","description":"<Warning icon=\"fa-regular fa-triangle-exclamation\">\n**Caution – Legacy endpoints being superseded by the hosted KYC/KYB solution**\n\nMangopay's [hosted KYC/KYB solution](/guides/users/verification/hosted) is becoming mandatory for all platforms (relying on the [IDV Session](/api-reference/idv-sessions/idv-session-object) object). The legacy KYC Document endpoints remain available for the sole purposes of [sending additional documents](/guides/users/verification/hosted#sending-additional-documents), but this use case will also be handled by the hosted solution in future.\n</Warning>","tags":["kycDocuments"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"UserId","in":"path","description":"The unique identifier of the user.","required":true,"schema":{"type":"string"}},{"name":"Status","in":"query","description":"**Allowed values:** `CREATED`, `VALIDATION_ASKED`, `VALIDATED`, `REFUSED`, `OUT_OF_DATE`\n\nThe status of the KYC Document. You can filter on multiple values by separating them with a comma.","required":false,"schema":{"type":"string"}},{"name":"Type","in":"query","description":"**Allowed values:** `IDENTITY_PROOF`, `REGISTRATION_PROOF`, `ARTICLES_OF_ASSOCIATION`, `SHAREHOLDER_DECLARATION`, `ADDRESS_PROOF`\n\nThe type of the KYC Document. You can filter on multiple values by separating them with a comma.","required":false,"schema":{"type":"string"}},{"name":"BeforeDate","in":"query","description":"The date before which the object was created (based on the object's `CreationDate` parameter). You can filter on a specific time range by using both the `AfterDate` and `BeforeDate` query parameters.","required":false,"schema":{"type":"integer"}},{"name":"AfterDate","in":"query","description":"The date after which the object was created (based on the object's `CreationDate` parameter). You can filter on a specific time range by using both the `AfterDate` and `BeforeDate` query parameters.","required":false,"schema":{"type":"integer"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListAllKYCDocumentsResponse"}}}}}}},"/v2.01/{ClientId}/users/{UserId}/kyc/documents/{KycDocumentId}/pages":{"post":{"operationId":"create_kyc_document_page","summary":"Create a KYC Document Page","description":"Upload a file to the KYC Document object\n\n<Warning icon=\"fa-regular fa-triangle-exclamation\">\n**Caution – Legacy endpoints being superseded by the hosted KYC/KYB solution**\n\nMangopay's [hosted KYC/KYB solution](/guides/users/verification/hosted) is becoming mandatory for all platforms (relying on the [IDV Session](/api-reference/idv-sessions/idv-session-object) object). The legacy KYC Document endpoints remain available for the sole purposes of [sending additional documents](/guides/users/verification/hosted#sending-additional-documents), but this use case will also be handled by the hosted solution in future.\n</Warning>\n\nThe KYC Document Page is a file attached to the KYC Document for Mangopay's teams to review.\n\nYou can upload up to 5 files to each KYC Document, and each upload requires a call to this endpoint. Each file can contain as many real-life pages as required.\n\nTo be able to upload a file using this endpoint:\n- The corresponding KYC Document `Status` must be `CREATED`\n- The `File` must be Base64 encoded and abide by the [format and size constraints](/guides/users/verification/documents/submission#file-constraints)\n\n[Read more about the KYC Document object →](/api-reference/kyc-documents/kyc-document-object)","tags":["kycDocuments"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"UserId","in":"path","description":"The unique identifier of the user.","required":true,"schema":{"type":"string"}},{"name":"KycDocumentId","in":"path","description":"The unique identifier of the KYC Document.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/kycDocuments_create_kyc_document_page_Response_200"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UploadAClientLogoRequest"}}}}}},"/v2.01/{ClientId}/users/{UserId}/kyc/documents/{KycDocumentId}":{"put":{"operationId":"submit_kyc_document","summary":"Submit a KYC Document","description":"<Warning icon=\"fa-regular fa-triangle-exclamation\">\n**Caution – Legacy endpoints being superseded by the hosted KYC/KYB solution**\n\nMangopay's [hosted KYC/KYB solution](/guides/users/verification/hosted) is becoming mandatory for all platforms (relying on the [IDV Session](/api-reference/idv-sessions/idv-session-object) object). The legacy KYC Document endpoints remain available for the sole purposes of [sending additional documents](/guides/users/verification/hosted#sending-additional-documents), but this use case will also be handled by the hosted solution in future.\n</Warning>\n\nSubmitting a KYC Document consists in updating the object `Status` from `CREATED` to `VALIDATION_ASKED`.\n\nOnce submitted, Mangopay's teams review the document and validate or reject it. This process takes on average 24 hours (on bank working days).\n\nSet up a hook for the following event types in order to be notified of the outcome:\n- `KYC_SUCCEEDED`\n- `KYC_FAILED`","tags":["kycDocuments"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"UserId","in":"path","description":"The unique identifier of the user.","required":true,"schema":{"type":"string"}},{"name":"KycDocumentId","in":"path","description":"The unique identifier of the KYC Document.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KYCDocumentResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitAKYCDocumentRequest"}}}}}},"/v2.01/{ClientId}/kyc/documents/{KycDocumentId}":{"get":{"operationId":"view_kyc_document","summary":"View a KYC Document","description":"<Warning icon=\"fa-regular fa-triangle-exclamation\">\n**Caution – Legacy endpoints being superseded by the hosted KYC/KYB solution**\n\nMangopay's [hosted KYC/KYB solution](/guides/users/verification/hosted) is becoming mandatory for all platforms (relying on the [IDV Session](/api-reference/idv-sessions/idv-session-object) object). The legacy KYC Document endpoints remain available for the sole purposes of [sending additional documents](/guides/users/verification/hosted#sending-additional-documents), but this use case will also be handled by the hosted solution in future.\n</Warning>","tags":["kycDocuments"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"KycDocumentId","in":"path","description":"The unique identifier of the KYC Document.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KYCDocumentResponse"}}}}}}},"/v2.01/{ClientId}/kyc/documents":{"get":{"operationId":"list_kyc_documents","summary":"List all KYC Documents","description":"<Warning icon=\"fa-regular fa-triangle-exclamation\">\n**Caution – Legacy endpoints being superseded by the hosted KYC/KYB solution**\n\nMangopay's [hosted KYC/KYB solution](/guides/users/verification/hosted) is becoming mandatory for all platforms (relying on the [IDV Session](/api-reference/idv-sessions/idv-session-object) object). The legacy KYC Document endpoints remain available for the sole purposes of [sending additional documents](/guides/users/verification/hosted#sending-additional-documents), but this use case will also be handled by the hosted solution in future.\n</Warning>","tags":["kycDocuments"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"Status","in":"query","description":"**Allowed values:** `CREATED`, `VALIDATION_ASKED`, `VALIDATED`, `REFUSED`, `OUT_OF_DATE`\n\nThe status of the KYC Document. You can filter on multiple values by separating them with a comma.","required":false,"schema":{"type":"string"}},{"name":"Type","in":"query","description":"**Allowed values:** `IDENTITY_PROOF`, `REGISTRATION_PROOF`, `ARTICLES_OF_ASSOCIATION`, `SHAREHOLDER_DECLARATION`, `ADDRESS_PROOF`\n\nThe type of the KYC Document. You can filter on multiple values by separating them with a comma.","required":false,"schema":{"type":"string"}},{"name":"BeforeDate","in":"query","description":"The date before which the object was created (based on the object's `CreationDate` parameter). You can filter on a specific time range by using both the `AfterDate` and `BeforeDate` query parameters.","required":false,"schema":{"type":"integer"}},{"name":"AfterDate","in":"query","description":"The date after which the object was created (based on the object's `CreationDate` parameter). You can filter on a specific time range by using both the `AfterDate` and `BeforeDate` query parameters.","required":false,"schema":{"type":"integer"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListAllKYCDocumentsResponse"}}}}}}},"/v2.01/{ClientId}/users/{UserId}/kyc/ubodeclarations":{"post":{"operationId":"create_ubo_declaration","summary":"Create a UBO Declaration","description":"<Warning icon=\"fa-regular fa-triangle-exclamation\">\n**Caution – Legacy endpoints being superseded by the hosted KYC/KYB solution**\n\nMangopay's [hosted KYC/KYB solution](/guides/users/verification/hosted) is becoming mandatory for all platforms, and allows Legal Users to declare and verify all beneficial owners in the same [IDV Session](/api-reference/idv-sessions/idv-session-object) object.\n\nThe [criteria defining beneficial owners](/guides/glossary#beneficial-owner-ubo) remain the same.\n</Warning>","tags":["uboDeclarations"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"UserId","in":"path","description":"The unique identifier of the user.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UBODeclarationResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"get":{"operationId":"list_ubo_declarations_user","summary":"List UBO Declarations for a User","description":"<Warning icon=\"fa-regular fa-triangle-exclamation\">\n**Caution – Legacy endpoints being superseded by the hosted KYC/KYB solution**\n\nMangopay's [hosted KYC/KYB solution](/guides/users/verification/hosted) is becoming mandatory for all platforms, and allows Legal Users to declare and verify all beneficial owners in the same [IDV Session](/api-reference/idv-sessions/idv-session-object) object.\n\nThe [criteria defining beneficial owners](/guides/glossary#beneficial-owner-ubo) remain the same.\n</Warning>","tags":["uboDeclarations"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"UserId","in":"path","description":"The unique identifier of the user.","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start value: `1`\n\n**Default value:** `1`\n\nIndicates the index of the page for the pagination.","required":false,"schema":{"type":"integer"}},{"name":"per_page","in":"query","description":"Min. value: `1`; max. value: `100`\n\n**Default value:** `10`\n\nIndicates the number of items returned for each page of the pagination.","required":false,"schema":{"type":"integer"}},{"name":"Sort","in":"query","description":"**Possible values:** `CreationDate:ASC`, `CreationDate:DESC`\n\n**Default value:** `CreationDate:ASC`\n\nIndicates the direction in which to sort the list.","required":false,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UBODeclarationResponse"}}}}}}},"/v2.01/{ClientId}/users/{UserId}/kyc/ubodeclarations/{UboDeclarationId}/ubos":{"post":{"operationId":"create_ubo","summary":"Create a UBO","description":"<Warning icon=\"fa-regular fa-triangle-exclamation\">\n**Caution – Legacy endpoints being superseded by the hosted KYC/KYB solution**\n\nMangopay's [hosted KYC/KYB solution](/guides/users/verification/hosted) is becoming mandatory for all platforms, and allows Legal Users to declare and verify all beneficial owners in the same [IDV Session](/api-reference/idv-sessions/idv-session-object) object.\n\nThe [criteria defining beneficial owners](/guides/glossary#beneficial-owner-ubo) remain the same.\n</Warning>\n\nIn Sandbox, you can set the `FirstName` of the first UBO to simulate the outcome (`Status`) of the declaration after submission:\n- `AcceptUBO` for `VALIDATED`\n- `RefusedUBO` for `REFUSED`\n- `IncompleteUBO` for `INCOMPLETE`\n\n[See the guide for more details](/guides/users/verification/beneficial-owners/how-to) **&rarr;**","tags":["uboDeclarations"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"UserId","in":"path","description":"The unique identifier of the user.","required":true,"schema":{"type":"string"}},{"name":"UboDeclarationId","in":"path","description":"The unique identifier of the UBO Declaration.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UBOResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAUBORequest"}}}}}},"/v2.01/{ClientId}/users/{UserId}/kyc/ubodeclarations/{UboDeclarationId}":{"put":{"operationId":"submit_ubo_declaration","summary":"Submit a UBO Declaration","description":"<Warning icon=\"fa-regular fa-triangle-exclamation\">\n**Caution – Legacy endpoints being superseded by the hosted KYC/KYB solution**\n\nMangopay's [hosted KYC/KYB solution](/guides/users/verification/hosted) is becoming mandatory for all platforms, and allows Legal Users to declare and verify all beneficial owners in the same [IDV Session](/api-reference/idv-sessions/idv-session-object) object.\n\nThe [criteria defining beneficial owners](/guides/glossary#beneficial-owner-ubo) remain the same.\n</Warning>\n\nSubmitting a UBO Declaration consists in updating the object `Status` parameter value to `VALIDATION_ASKED`.\n\nFrom there, Mangopay Compliance team will validate, indicate as incomplete, or reject the declaration.","tags":["uboDeclarations"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"UserId","in":"path","description":"The unique identifier of the user.","required":true,"schema":{"type":"string"}},{"name":"UboDeclarationId","in":"path","description":"The unique identifier of the UBO Declaration.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UBODeclarationResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitADisputeDocumentRequest"}}}}}},"/v2.01/{ClientId}/users/{UserId}/kyc/ubodeclarations/{UboDeclarationId}/ubos/{UboId}":{"put":{"operationId":"update_ubo","summary":"Update a UBO","description":"<Warning icon=\"fa-regular fa-triangle-exclamation\">\n**Caution – Legacy endpoints being superseded by the hosted KYC/KYB solution**\n\nMangopay's [hosted KYC/KYB solution](/guides/users/verification/hosted) is becoming mandatory for all platforms, and allows Legal Users to declare and verify all beneficial owners in the same [IDV Session](/api-reference/idv-sessions/idv-session-object) object.\n\nThe [criteria defining beneficial owners](/guides/glossary#beneficial-owner-ubo) remain the same.\n</Warning>","tags":["uboDeclarations"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"UserId","in":"path","required":true,"schema":{"type":"string"}},{"name":"UboDeclarationId","in":"path","description":"The unique identifier of the UBO Declaration.","required":true,"schema":{"type":"string"}},{"name":"UboId","in":"path","description":"The unique identifier of the UBO.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UBOResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAUBORequest"}}}}},"get":{"operationId":"view_ubo","summary":"View a UBO","description":"<Warning icon=\"fa-regular fa-triangle-exclamation\">\n**Caution – Legacy endpoints being superseded by the hosted KYC/KYB solution**\n\nMangopay's [hosted KYC/KYB solution](/guides/users/verification/hosted) is becoming mandatory for all platforms, and allows Legal Users to declare and verify all beneficial owners in the same [IDV Session](/api-reference/idv-sessions/idv-session-object) object.\n\nThe [criteria defining beneficial owners](/guides/glossary#beneficial-owner-ubo) remain the same.\n</Warning>","tags":["uboDeclarations"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"UserId","in":"path","description":"The unique identifier of the user.","required":true,"schema":{"type":"string"}},{"name":"UboDeclarationId","in":"path","description":"The unique identifier of the UBO Declaration.","required":true,"schema":{"type":"string"}},{"name":"UboId","in":"path","description":"The unique identifier of the UBO.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UBOResponse"}}}}}}},"/v2.01/{ClientId}/kyc/ubodeclarations/{UboDeclarationId}":{"get":{"operationId":"view_ubo_declaration","summary":"View a UBO Declaration","description":"View a UBO Declaration\n\n[Read more about the UBO Declaration object →](/api-reference/ubo-declarations/ubo-declaration-object)","tags":["uboDeclarations"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"UboDeclarationId","in":"path","description":"The unique identifier of the UBO Declaration.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UBODeclarationResponse"}}}}}}},"/v2.01/{ClientId}/users/{UserId}/verified-identity":{"get":{"operationId":"view_user_verified_identity","summary":"View a User's Verified Identity","description":"Retrieve the identity information and verification documents validated by Mangopay for a user, based on their `UserId`.\n\nThe payload returned depends on the user's `UserType`, so always branch on this value rather than on the presence of an optional property.\n\nThe endpoint returns a verified identity only if all the following conditions are met:\n- The Underwriting API is activated for the `ClientId`.\n- The user exists for the `ClientId`.\n- The user's KYC/KYB verification is validated.\n\nA user whose verification is not validated returns a 400 error rather than a partial or declared identity.\n\n<Note icon=\"fa-regular fa-circle-info\">\n**Note – Feature activation required**\n\nThis endpoint is available only to platforms for which the Underwriting API is activated, and requires an access token with the `underwriting.user.kyc` read permission. Contact Mangopay to request access.\n</Note>","tags":["verifiedIdentity"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"UserId","in":"path","description":"The unique identifier of the user.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ViewUserVerifiedIdentityResponse"}}}},"400":{"description":"Bad Request\n\nReturned if the `ClientId` or `UserId` is incorrect, or if the user's KYC/KYB verification is not validated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Forbidden\n\nReturned if the access token does not have the `underwriting.user.kyc` permission, or if the Underwriting API is not activated for the platform.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found\n\nReturned if the user cannot be found for the platform, or if the user's verification documents cannot be retrieved.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v2.01/{ClientId}/wallets":{"post":{"operationId":"create_wallet","summary":"Create a Wallet","description":"Create a Mangopay wallet for a Mangoapy User.\n\n<Warning icon=\"fa-regular fa-triangle-exclamation\">   \n**Caution – Currency not updatable** \n\nThe `Currency` of a created wallet cannot be changed.  \n</Warning>","tags":["wallets"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserWalletResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAWalletRequest"}}}}}},"/v2.01/{ClientId}/wallets/{WalletId}":{"put":{"operationId":"update_wallet","summary":"Update a Wallet","description":"Modify a wallet.","tags":["wallets"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"WalletId","in":"path","description":"The unique identifier of the wallet.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserWalletResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAWalletRequest"}}}}},"get":{"operationId":"view_wallet","summary":"View a Wallet","description":"Retrieve a wallet by its `Id`.\n\n<Note icon=\"fa-regular fa-circle-info\">\n**Note – ScaContext default value is USER_PRESENT**\n\nOn this endpoint, the default value for `ScaContext` is `USER_PRESENT`. If the `PendingUserAction.RedirectUrl` value is returned, you need to redirect the user to perform SCA.\n\nWith approval from Mangopay, your platform may be able to use the `USER_NOT_PRESENT` value provided you also have a legal proxy in place with the user and the user's consent to access wallet balances and transactions on their behalf (read more about [proxy management](/guides/sca/proxy-management)).\n</Note>\n\n<Note icon=\"fa-regular fa-circle-info\">\n**Note – SCA triggered by this endpoint**\n\nThis endpoint requires the user to [perform SCA to authenticate](/guides/sca/wallets) the access to their wallet, unless SCA for wallet access was successfully completed in the **last 180 days** (or unless your platform is using a [proxy and user consent](/guides/sca/proxy-management)).\n\nWhen SCA is required, this endpoint returns a **401 - Unauthorized** response (see [errors below](#response.error) for details).\n\nTo let the user complete the SCA session on the Mangopay-hosted webpage, your platform needs to retrieve the `RedirectUrl` from the `WWW-Authenticate` response header, add an encoded `returnUrl` query parameter, and redirect the user. Read more about how to redirect them in the [SCA session](/guides/sca/session) guide.\n\nIn Sandbox, you can bypass SCA by including the word `accept` in the `Email` value of the [Natural User](/api-reference/users/natural-user-object-sca) or the `LegalRepresentative.Email` value of the [Legal User](/api-reference/users/legal-user-object-sca) – for example `accept@example.com` or `john.doe+accept@example.com`.\n</Note>","tags":["wallets"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"WalletId","in":"path","description":"The unique identifier of the wallet.","required":true,"schema":{"type":"string"}},{"name":"ScaContext","in":"query","description":"**Possible values:** `USER_PRESENT`, `USER_NOT_PRESENT`\n\nThe SCA context of the request, which is **required** if the user's `UserCategory` is `OWNER`:\n- `USER_PRESENT` – The user is taking the SCA-triggering action of accessing their wallet. The platform must [redirect the user](/guides/sca/session) using the `PendingUserAction.RedirectUrl` returned so that the user can complete the SCA session (unless exempted because a successful SCA session for wallet access occurred in the last 180 days, so no redirection link was returned).\n- `USER_NOT_PRESENT` – The platform is taking the action under proxy from the user and the user has previously given consent to Mangopay (via the SCA hosted experience) to allow the action. If the user has not given (or has revoked) their consent, then `USER_NOT_PRESENT` returns a 403 error.\n\nRead more about [managing proxy and user consent](/guides/sca/proxy-management) **&rarr;**\n\n**Note:** For existing platforms, the parameter is technically optional if the User is an `OWNER`, and the default value will become `USER_PRESENT` from **Dec 15, 2025** (Dec 1 in Sandbox)","required":false,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserWalletResponse"}}}},"401":{"description":"SCA required to retrieve data because no successful SCA session for wallet access occurred in the last 180 days.\n\nIn this case, the user needs to authenticate the action. \n\nThe 401 response includes a `WWW-Authenticate` header with the `RedirectUrl` value needed.","content":{"application/json":{"schema":{"description":"Any type"}}}}}}},"/v2.01/{ClientId}/users/{UserId}/wallets":{"get":{"operationId":"list_wallets_user","summary":"List Wallets for a User","description":"Retrieve wallets based on `UserId`.\n\n<Note icon=\"fa-regular fa-circle-info\">\n**Note – ScaContext default value is USER_PRESENT**\n\nOn this endpoint, the default value for `ScaContext` is `USER_PRESENT`. If the `PendingUserAction.RedirectUrl` value is returned, you need to redirect the user to perform SCA.\n\nWith approval from Mangopay, your platform may be able to use the `USER_NOT_PRESENT` value provided you also have a legal proxy in place with the user and the user's consent to access wallet balances and transactions on their behalf (read more about [proxy management](/guides/sca/proxy-management)).\n</Note>\n\n<Note icon=\"fa-regular fa-circle-info\">\n**Note – SCA triggered by this endpoint**\n\nThis endpoint requires the user to [perform SCA to authenticate](/guides/sca/wallets) the access to their wallet, unless SCA for wallet access was successfully completed in the last 180 days (or unless your platform is using a [proxy and user consent](/guides/sca/proxy-management)).\n\nWhen SCA is required, this endpoint returns a **401 - Unauthorized** response (see [errors below](#response.error) for details).\n\nTo let the user complete the SCA session on the Mangopay-hosted webpage, your platform needs to retrieve the `RedirectUrl` from the `WWW-Authenticate` response header, add an encoded `returnUrl` query parameter, and redirect the user. Read more about how to redirect them in the [SCA session](/guides/sca/session) guide.\n\nIn Sandbox, you can bypass SCA by including the word `accept` in the `Email` value of the [Natural User](/api-reference/users/natural-user-object-sca) or the `LegalRepresentative.Email` value of the [Legal User](/api-reference/users/legal-user-object-sca) – for example `accept@example.com` or `john.doe+accept@example.com`.\n</Note>","tags":["wallets"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"UserId","in":"path","description":"The unique identifier of the user.","required":true,"schema":{"type":"string"}},{"name":"ScaContext","in":"query","description":"**Possible values:** `USER_PRESENT`, `USER_NOT_PRESENT`\n\nThe SCA context of the request, which is **required** if the user's `UserCategory` is `OWNER`:\n- `USER_PRESENT` – The user is taking the SCA-triggering action of accessing their wallet. The platform must [redirect the user](/guides/sca/session) using the `PendingUserAction.RedirectUrl` returned so that the user can complete the SCA session (unless exempted because a successful SCA session for wallet access occurred in the last 180 days, so no redirection link was returned).\n- `USER_NOT_PRESENT` – The platform is taking the action under proxy from the user and the user has previously given consent to Mangopay (via the SCA hosted experience) to allow the action. If the user has not given (or has revoked) their consent, then `USER_NOT_PRESENT` returns a 403 error.\n\nRead more about [managing proxy and user consent](/guides/sca/proxy-management) **&rarr;**\n\n**Note:** For existing platforms, the parameter is technically optional if the User is an `OWNER`, and the default value will become `USER_PRESENT` from **Dec 15, 2025** (Dec 1 in Sandbox)","required":false,"schema":{"type":"string"}},{"name":"per_page","in":"query","description":"Min. value: `1`; max. value: `100`\n\n**Default value:** `10`\n\nIndicates the number of items returned for each page of the pagination.","required":false,"schema":{"type":"integer"}},{"name":"page","in":"query","description":"Start value: `1`\n\n**Default value:** `1`\n\nIndicates the index of the page for the pagination.","required":false,"schema":{"type":"integer"}},{"name":"Sort","in":"query","description":"**Possible values:** `CreationDate:ASC`, `CreationDate:DESC`\n\n**Default value:** `CreationDate:ASC`\n\nIndicates the direction in which to sort the list.","required":false,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListWalletsForAUserResponse"}}}},"401":{"description":"SCA required to retrieve data because no successful SCA session for wallet access occurred in the last 180 days.\n\nIn this case, the user needs to authenticate the action. \n\nThe 401 response includes a `WWW-Authenticate` header with the `RedirectUrl` value needed.","content":{"application/json":{"schema":{"description":"Any type"}}}}}}},"/v2.01/{ClientId}/clients/wallets/{FundsType}/{Currency}":{"get":{"operationId":"view_client_wallet","summary":"View a Client Wallet","description":"View a Client Wallet","tags":["clientWallets"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"FundsType","in":"path","description":"**Allowed values:** `FEES`, `CREDIT`\n\nThe type of funds in the Client Wallet:\n- `FEES` – Fees Wallet, for fees collected by the platform, specific to the Client Wallet object.\n- `CREDIT` – Repudiation Wallet, for funds for the platform's dispute management, specific to the Client Wallet object.\n\n**Note:** The Fees Wallet and Repudiation Wallet are created automatically by Mangopay for each currency.","required":true,"schema":{"type":"string"}},{"name":"Currency","in":"path","description":"**Allowed values:** The three-letter <a href=\"/api-reference/overview/data-formats\" target=\"_blank\">ISO 4217 code</a> (EUR, GBP, etc.) of a <a href=\"/guides/currencies\" target=\"_blank\">supported currency</a> (depends on feature, contract, and activation settings).\n\nThe currency of the wallet.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientWalletResponse"}}}}}}},"/v2.01/{ClientId}/clients/wallets":{"get":{"operationId":"list_client_wallets","summary":"List all Client Wallets","description":"List all Client Wallets","tags":["clientWallets"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListAllClientWalletsResponse"}}}}}}},"/v2.01/{ClientId}/clients/wallets/{FundsType}":{"get":{"operationId":"list_client_wallets_fundstype","summary":"List Client Wallets by FundsType","description":"List Client Wallets by FundsType","tags":["clientWallets"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"FundsType","in":"path","description":"**Allowed values:** `FEES`, `CREDIT`\n\nThe type of funds in the Client Wallet:\n- `FEES` – Fees Wallet, for fees collected by the platform, specific to the Client Wallet object.\n- `CREDIT` – Repudiation Wallet, for funds for the platform's dispute management, specific to the Client Wallet object.\n\n**Note:** The Fees Wallet and Repudiation Wallet are created automatically by Mangopay for each currency.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListAllClientWalletsResponse"}}}}}}},"/v2.01/{ClientId}/cardregistrations":{"post":{"operationId":"create_card_registration","summary":"Create a Card Registration","description":"Create a Card Registration\n\n[Read more about the Card Registration object →](/api-reference/card-registrations/card-registration-object)","tags":["cardRegistrations"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CardRegistrationResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateACardRegistrationRequest"}}}}}},"/{CardRegistrationUrl}":{"post":{"operationId":"tokenize_card","summary":"Tokenize the card","description":"Send card details to a PCI-DSS-compliant tokenization server without reaching Mangopay's servers.\n\nThe URL to use for this endpoint is returned in the `CardRegistrationURL` parameter on the [POST Create a Card Registration](/api-reference/card-registrations/create-card-registration) endpoint.\n\nThe request must be made using the “application/x-www-form-urlencoded” content type.\n<Note icon=\"fa-regular fa-circle-info\">\n**Note – Do not hardcode the URL**\n\nThe `CardRegistrationURL` is specific to each payment. You must rely on the returned URL in full (host, path, and queries) and not hardcode any part of it.\n</Note>\n\n<Warning icon=\"fa-regular fa-triangle-exclamation\">\n**Caution – Card details must never pass via your server**\n\nFor security reasons, it is strictly forbidden to send the card details to your own server. You must rely on the dedicated PCI-DSS-compliant tokenization server by using the endpoint provided.\n</Warning>","tags":["cardRegistrations"],"parameters":[{"name":"CardRegistrationUrl","in":"path","description":"The variable URL is only documented as a path parameter on this path for documentation reasons. I allows it to be rendered visiablly on the page, and because there are two dynamic server URLs in the spec (so both would be on the / path). The variable URL is the server for this request, and it has a variable host and path and query parameters. You do not need to add anything to it.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The string returned by the tokenization server. \n\nSend this string in full as the `RegistrationData` value on the [PUT Update a Card Registration](/api-reference/card-registrations/update-card-registration) endpoint to create the Card object.","content":{"application/json":{"schema":{"type":"object","properties":{}}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"accessKeyRef":{"type":"string","description":"The `AccessKey` returned by the [POST Create a Card Registration](/api-reference/card-registrations/create-card-registration) call."},"data":{"type":"string","description":"The `PreregistrationData` returned by the [POST Create a Card Registration](/api-reference/card-registrations/create-card-registration) call."},"cardNumber":{"type":"string","description":"The full PAN (card number) of the card."},"cardExpirationDate":{"type":"string","description":"The expiration date of the card in MMYY format, for example: `1229`."},"cardCvx":{"type":"string","description":"The card verification code (CVC) or card verification value (CVV), typically 3 digits found on the back of the card.\n\nAMEX codes are 4 digits and are called card identification (CID) numbers.\n\nFor cards that don't have a CVC, such as Maestro, use `000` or `999`."}},"required":["accessKeyRef","data","cardNumber","cardExpirationDate","cardCvx"]}}}}}},"/v2.01/{ClientId}/cardregistrations/{CardRegistrationId}":{"put":{"operationId":"update_card_registration","summary":"Update a Card Registration","description":"Update a Card Registration\n\nThis call is used to add the string acquired from the tokenization to the Card Registration object in the parameter `RegistrationData`, thereby validating the registration.\n\nAs a result, the Card object is created and the corresponding `CardId` returned.\n\nPlatforms should also send the cardholder's name as it appears on the payment card. The `CardHolderName` parameter is sent on this call but not returned in the response; it is added to the Card object.","tags":["cardRegistrations"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"CardRegistrationId","in":"path","description":"The unique identifier of the Card Registration object.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CardRegistrationResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateACardRegistrationRequest"}}}}},"get":{"operationId":"view_card_registration","summary":"View a Card Registration","description":"View a Card Registration","tags":["cardRegistrations"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"CardRegistrationId","in":"path","description":"The unique identifier of the Card Registration object.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CardRegistrationResponse"}}}}}}},"/v2.01/{ClientId}/cards/{CardId}":{"put":{"operationId":"deactivate_edit_card","summary":"Deactivate or edit a Card","description":"<Warning icon=\"fa-regular fa-triangle-exclamation\">   \n**Warning – Implement card deactivation** \n\nBecause card information cannot be kept without the end user's approval, you should implement a way to deactivate the end user's card systematically when relevant.  \n</Warning>\n\nDeactivate or edit a Card\n\nThis call serves one of two purposes:\n- Setting the card as inactive, and thereby disabling it from being used again. This action is irreversible but doesn't prevent the card being registered again with [POST Create a Card Registration](/api-reference/card-registrations/create-card-registration).\n- Adding the `CardHolderName` to an existing Card object. The `CardHolderName` cannot be modified once added to a Card object. It can also be done during registration with [PUT Update a Card Registration](/api-reference/card-registrations/update-card-registration), in which case attempting to edit it with this endpoint returns an error.","tags":["Cards"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"CardId","in":"path","description":"The unique identifier of the Card object, which is returned after updating the Card Registration object with the `RegistrationData`.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeactivateOrEditACardResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeactivateOrEditACardRequest"}}}}},"get":{"operationId":"view_card","summary":"View a Card","description":"View a Card","tags":["Cards"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"CardId","in":"path","description":"The unique identifier of the Card object, which is returned after updating the Card Registration object with the `RegistrationData`.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ViewACardResponse"}}}}}}},"/v2.01/{ClientId}/users/{UserId}/cards":{"get":{"operationId":"list_cards_user","summary":"List Cards for a User","description":"List Cards for a User","tags":["Cards"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"UserId","in":"path","description":"The unique identifier of the user.","required":true,"schema":{"type":"string"}},{"name":"Active","in":"query","description":"Whether the card is active or not.","required":false,"schema":{"type":"boolean"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListCardsForAFingerprintResponse"}}}}}}},"/v2.01/{ClientId}/cards/fingerprints/{Fingerprint}":{"get":{"operationId":"list_cards_fingerprint","summary":"List Cards for a Fingerprint","description":"Retrieve all Card objects with the same `Fingerprint` value. This can be useful to detect abnormal or fraudulent behavior.","tags":["Cards"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"Fingerprint","in":"path","description":"The unique representation of the card number. This string can be used to track the card behavior while keeping the card information confidential.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListCardsForAFingerprintResponse"}}}}}}},"/v2.01/{ClientId}/payment-methods/metadata":{"post":{"operationId":"lookup_payment_method_metadata","summary":"Look up metadata for a payment method","description":"<Check>\n**Best practice – For BIN lookup, use an 8-digit version if available**\n\nAn 8-digit BIN provides the most detailed and accurate data for card identification and assessment, and is becoming the industry standard. The 6-digit version continues to be used but provides less granular classification that may be ambiguous if 8-digit sub-ranges have been introduced by the issuer.\n\nA transaction's `CardInfo.BIN` property returns the 8-digit BIN if its available. In the Card object, the `Alias` only ever reveals the first 6 digits – the 8-digit version should be preferred. \n</Check>","tags":["paymentMethodMetadata"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LookUpMetadataForAPaymentMethodResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LookUpMetadataForAPaymentMethodRequest"}}}}}},"/v2.01/{ClientId}/cards/{CardId}/validation":{"post":{"operationId":"create_card_validation","summary":"Create a Card Validation","description":"Create a Card Validation","tags":["cardValidations"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"CardId","in":"path","description":"The unique identifier of the Card object, obtained during the card registration process.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CardValidationResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateACardValidationRequest"}}}}}},"/v2.01/{ClientId}/cards/{CardId}/validation/{ValidationId}":{"get":{"operationId":"view_card_validation","summary":"View a Card Validation","description":"View a Card Validation","tags":["cardValidations"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"CardId","in":"path","description":"The unique identifier of the Card object, obtained during the card registration process.","required":true,"schema":{"type":"string"}},{"name":"ValidationId","in":"path","description":"The unique identifier of the Card Validation object.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CardValidationResponse"}}}}}}},"/v2.01/{ClientId}/payins/{PayInId}":{"get":{"operationId":"view_payin","summary":"View a PayIn","description":"<Note icon=\"fa-regular fa-circle-info\">\n**Note – Pay-in data retained for 13 months**\n\nAn API call to retrieve a pay-in whose `CreationDate` is older than 13 months may return 404 Not Found.\n\nFor more information, see the <a href=\"/api-reference/overview/data-availability-periods\">Data availability periods</a> article.\n</Note>\n\nRetrieve any pay-in by its `Id`. The object returned depends on the endpoint that was used to create it. The difference is indicated by the `PaymentType`, `ExecutionType`, and in some cases other properties.","tags":["payins"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"PayInId","in":"path","description":"The unique identifier of the pay-in.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ViewAPayInResponse"}}}}}}},"/v2.01/{ClientId}/payins/card/direct":{"post":{"operationId":"create_direct_card_payin","summary":"Create a Direct Card PayIn","description":"Process a one-time payment with a `CardId`, obtained from the card registration process\n\n[Read more about the Direct Card PayIn object →](/api-reference/direct-card-payins/direct-card-payin-object)","tags":["directCardPayins"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DirectCardPayInResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateADirectCardPayInRequest"}}}}}},"/v2.01/{ClientId}/recurringpayinregistrations":{"post":{"operationId":"create_recurring_payin_registration","summary":"Create a Recurring PayIn Registration","description":"Register a series of recurring payment requests for the following payment methods (indicated by `PaymentType`):\n\n| PaymentType | Requires | Captured using | \n| --- | --- | --- |\n| `CARD_DIRECT` (default) | Tokenized `CardId` obtained from the card registration process. | [Create a Recurring Card PayIn (CIT or MIT)](/api-reference/recurring-card-payins/create-recurring-card-payin) |\n| `APPLEPAY` | Tokenized `PaymentData` object retrieved from the Apple Pay API. | [Create a Recurring Apple Pay PayIn](/api-reference/apple-pay/create-recurring-apple-pay-payin) |\n| `GOOGLE_PAY` | Tokenized `PaymentData` string retrieved from the Google Pay API. | [Create a Recurring Google Pay PayIn](/api-reference/google-pay/create-recurring-google-pay-payin) |\n| `PAYPAL` | No prerequisites. | [Create a Recurring PayPal PayIn (CIT or MIT)](/api-reference/paypal/create-recurring-paypal-payin) |\n\n<Note icon=\"fa-regular fa-circle-info\">\n**Note – Only one registration per user on PayPal**\n\nOn PayPal, only one recurring pay-in registration can be used per `UserId`. You can [end a user's existing registration](/api-reference/recurring-payin-registrations/update-recurring-payin-registration) object to create a new one with the same user.\n\nThis restriction does not apply to other payment methods.\n</Note>","tags":["recurringPayinRegistrations"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecurringPayInRegistrationResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateARecurringPayInRegistrationRequest"}}}}}},"/v2.01/{ClientId}/recurringpayinregistrations/{RecurringPayinRegistrationId}":{"put":{"operationId":"update_recurring_payin_registration","summary":"Update a Recurring PayIn Registration","description":"This call can be used to modify parameters in the following scenarios:\n- **Reauthentication** – Update the `CardId` (card) or `PaymentData` (Apple Pay and Google Pay) if re-authentication is necessary (indicated by the `Status` becoming `AUTHENTICATION_NEEDED`). This must be followed by a CIT pay-in request.\n- **User data change** – Update `Billing` or `Shipping` if required\n- **Recurrence ending** – Set the `Status` to `ENDED` if the recurring payments have finished or will no longer be used\n\nThe existing registration's `PaymentType` must match the request variant.","tags":["recurringPayinRegistrations"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"RecurringPayinRegistrationId","in":"path","description":"The unique identifier of the recurring pay-in registration.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecurringPayInRegistrationResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateARecurringPayInRegistrationRequest"}}}}},"get":{"operationId":"view_recurring_payin_registration","summary":"View a Recurring PayIn Registration","description":"View a Recurring PayIn Registration","tags":["recurringPayinRegistrations"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"RecurringPayinRegistrationId","in":"path","description":"The unique identifier of the recurring pay-in registration.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecurringPayInRegistrationResponse"}}}}}}},"/v2.01/{ClientId}/payins/recurring/card/direct":{"post":{"operationId":"create_recurring_card_payin","summary":"Create a Recurring Card PayIn (CIT or MIT)","description":"Request a recurring card pay-in based on a `RecurringPayinRegistrationId` with `PaymentType` `CARD`, obtained from [POST Create a Recurring PayIn Registration](/api-reference/recurring-payin-registrations/create-recurring-payin-registration).\n\nThere are two possible paylods: \n- **CIT** – Customer-initiated transaction when the user is on session, requiring them to authenticate on the `SecureModeRedirectURL` returned.\n- **MIT** – Subsequent merchant-initiated transactions in the absence of the user, based on the initial successful authentication, unless and until re-authentication is required.","tags":["recurringCardPayins"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecurringCardPayInResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/recurringCardPayins_create_recurring_card_payin_Request"}}}}}},"/v2.01/{ClientId}/preauthorizations/card/direct":{"post":{"operationId":"create_preauthorization","summary":"Create a Preauthorization","description":"Create a Preauthorization","tags":["Preauthorizations"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreauthorizationResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAPreauthorizationRequest"}}}}}},"/v2.01/{ClientId}/preauthorizations/{PreauthorizationId}":{"put":{"operationId":"cancel_validate_preauthorization","summary":"Cancel or validate a Preauthorization","description":"<Warning icon=\"fa-regular fa-triangle-exclamation\">   \n**Caution – Canceling or validating a preauthorization is irreversible** \n\nA preauthorization with the `CANCELED` or `VALIDATED` status can't be reused.  \n</Warning>\n\nCancel or validate a Preauthorization\n\nThis call is used to manually close the preauthorization hold period before the `ExpirationDate`, thereby releasing the preauthorized funds.   \n\nThe `PaymentStatus` can be set to:  \n- `CANCELED` when no preauthorized pay-ins have been made to capture funds. Trying to cancel a used preauthorization returns an error.  \n- `VALIDATED` when at least one preauthorized pay-in has been made to capture funds. Trying to validate an unused preauthorization returns an error.","tags":["Preauthorizations"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"PreauthorizationId","in":"path","description":"The unique identifier of the preauthorization.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CancelOrValidateAPreauthorizationResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CancelADepositPreauthorizationRequest"}}}}},"get":{"operationId":"view_preauthorization","summary":"View a Preauthorization","description":"View a Preauthorization","tags":["Preauthorizations"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"PreauthorizationId","in":"path","description":"The unique identifier of the preauthorization.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreauthorizationResponse"}}}}}}},"/v2.01/{ClientId}/cards/{CardId}/preauthorizations":{"get":{"operationId":"list_preauthorizations_card","summary":"List Preauthorizations for a Card","description":"List Preauthorizations for a Card","tags":["Preauthorizations"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"CardId","in":"path","description":"The unique identifier of the Card object, obtained during the card registration process.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListPreauthorizationsForACardResponse"}}}}}}},"/v2.01/{ClientId}/users/{UserId}/preauthorizations":{"get":{"operationId":"list_preauthorizations_user","summary":"List Preauthorizations for a User","description":"List Preauthorizations for a User","tags":["Preauthorizations"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"UserId","in":"path","description":"The unique identifier of the user.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListPreauthorizationsForACardResponse"}}}}}}},"/v2.01/{ClientId}/payins/preauthorized/direct":{"post":{"operationId":"create_preauthorized_payin","summary":"Create a Preauthorized PayIn","description":"Create a Preauthorized PayIn","tags":["Preauthorizations"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreauthorizedPayInResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAPreauthorizedPayInRequest"}}}}}},"/v2.01/{ClientId}/deposit-preauthorizations/card/direct":{"post":{"operationId":"create_card_deposit_preauthorization","summary":"Create a Card Deposit Preauthorization","description":"This endpoint creates a [Deposit Preauthorization](/api-reference/deposit-preauthorizations/deposit-preauthorization-object) with `PaymentType` of `CARD` and returns the `RedirectURL` on which the user can preauthorize the debited funds.\n\nOnce authorized (`Status` becomes `SUCCEEDED`), you can capture the funds using the [POST Create a Deposit Preauthorized PayIn](/api-reference/deposit-preauthorizations/create-deposit-preauthorized-payin) endpoint.\n\n<Note icon=\"fa-regular fa-circle-info\">\n**Note – Disclaimer about terminology**\n\nThe use of the term \"deposit\" in this feature is for convenience only and does not constitute a traditional banking deposit under applicable banking regulations, including the EU Capital Requirements Directive (Directive 2013/36/EU) or the Deposit Guarantee Schemes Directive (Directive 2014/49/EU). Accordingly, these funds are not covered by any statutory deposit protection schemes, and Mangopay does not operate as a licensed banking institution.\n</Note>","tags":["depositPreauthorizations"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CardDepositPreauthorizationResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateACardDepositPreauthorizationRequest"}}}}}},"/v2.01/{ClientId}/deposit-preauthorizations/{DepositId}":{"put":{"operationId":"cancel_deposit_preauthorization","summary":"Cancel a Deposit Preauthorization","description":"This endpoint allows you to cancel a deposit preauthorization (with `PaymentType` of `CARD` or `PAYPAL`) if it is no longer needed, by setting the `PaymentStatus` to `CANCELED`. A canceled deposit preauthorization can't be subsequently captured.\n\n<Note icon=\"fa-regular fa-circle-info\">\n**Note – Disclaimer about terminology**\n\nThe use of the term \"deposit\" in this feature is for convenience only and does not constitute a traditional banking deposit under applicable banking regulations, including the EU Capital Requirements Directive (Directive 2013/36/EU) or the Deposit Guarantee Schemes Directive (Directive 2014/49/EU). Accordingly, these funds are not covered by any statutory deposit protection schemes, and Mangopay does not operate as a licensed banking institution.\n</Note>","tags":["depositPreauthorizations"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"DepositId","in":"path","description":"The unique identifier of the deposit preauthorization.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DepositPreauthorizationResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CancelADepositPreauthorizationRequest"}}}}},"get":{"operationId":"view_deposit_preauthorization","summary":"View a Deposit Preauthorization","description":"This call retrieves a single Deposit Preauthorization, of which there are two types, indicated by `PaymentType`: \n- `CARD` – Created using [POST Create a Card Deposit Preauthorization](/api-reference/deposit-preauthorizations/create-card-deposit-preauthorization)\n- `PAYPAL` – Created using [POST Create a PayPal Deposit Preauthorization](/api-reference/deposit-preauthorizations/create-paypal-deposit-preauthorization)\n\nBoth types can be captured using [POST Create a Deposit Preauthorized PayIn](/api-reference/deposit-preauthorizations/create-deposit-preauthorized-payin).\n\n<Note icon=\"fa-regular fa-circle-info\">\n**Note – Disclaimer about terminology**\n\nThe use of the term \"deposit\" in this feature is for convenience only and does not constitute a traditional banking deposit under applicable banking regulations, including the EU Capital Requirements Directive (Directive 2013/36/EU) or the Deposit Guarantee Schemes Directive (Directive 2014/49/EU). Accordingly, these funds are not covered by any statutory deposit protection schemes, and Mangopay does not operate as a licensed banking institution.\n</Note>","tags":["depositPreauthorizations"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"DepositId","in":"path","description":"The unique identifier of the deposit preauthorization.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DepositPreauthorizationResponse"}}}}}}},"/v2.01/{ClientId}/cards/{CardId}/deposit-preauthorizations":{"get":{"operationId":"list_deposit_preauthorizations_card","summary":"List Deposit Preauthorizations for a Card","description":"<Note icon=\"fa-regular fa-circle-info\">\n**Note – Disclaimer about terminology**\n\nThe use of the term \"deposit\" in this feature is for convenience only and does not constitute a traditional banking deposit under applicable banking regulations, including the EU Capital Requirements Directive (Directive 2013/36/EU) or the Deposit Guarantee Schemes Directive (Directive 2014/49/EU). Accordingly, these funds are not covered by any statutory deposit protection schemes, and Mangopay does not operate as a licensed banking institution.\n</Note>","tags":["depositPreauthorizations"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"CardId","in":"path","required":true,"schema":{"type":"string"}},{"name":"ResultCode","in":"query","description":"The code indicating the result of the operation. You can filter on multiple values by separating them with a comma.","required":false,"schema":{"type":"string"}},{"name":"Status","in":"query","description":"**Allowed values:** `CREATED`, `SUCCEEDED`, `FAILED`\n\nThe status of the transaction. You can filter on multiple values by separating them with a comma.","required":false,"schema":{"type":"string"}},{"name":"PaymentStatus","in":"query","description":"**Allowed values:** `WAITING`, `CANCELED`, `CANCEL_REQUESTED`, `EXPIRED`, `VALIDATED`, `FAILED`\n\nThe payment status of the deposit preauthorization object:\n- `WAITING` – The deposit preauthorization can be used: the preauthorized funds can be captured (if `Status` is `SUCCEEDED`) or the preauthorization can be canceled manually.\n- `CANCELED` – Value to pass to manually cancel the deposit preauthorization before use; indicates that the deposit preauthorization was canceled manually.\n- `CANCEL_REQUESTED` – The cancellation of the deposit preauthorization has been requested but not yet processed.  \n- `EXPIRED` – The hold period on the preauthorized funds has ended without it being used.  \n- `VALIDATED` – Indicates that the preauthorized funds were captured.\n- `FAILED` – The pay-in against the preauthorization has failed, but a retry may be possible.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListDepositPreauthorizationsResponse"}}}}}}},"/v2.01/{ClientId}/users/{UserId}/deposit-preauthorizations":{"get":{"operationId":"list_deposit_preauthorizations_user","summary":"List Deposit Preauthorizations for a User","description":"<Note icon=\"fa-regular fa-circle-info\">\n**Note – Disclaimer about terminology**\n\nThe use of the term \"deposit\" in this feature is for convenience only and does not constitute a traditional banking deposit under applicable banking regulations, including the EU Capital Requirements Directive (Directive 2013/36/EU) or the Deposit Guarantee Schemes Directive (Directive 2014/49/EU). Accordingly, these funds are not covered by any statutory deposit protection schemes, and Mangopay does not operate as a licensed banking institution.\n</Note>","tags":["depositPreauthorizations"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"UserId","in":"path","required":true,"schema":{"type":"string"}},{"name":"ResultCode","in":"query","description":"The code indicating the result of the operation. You can filter on multiple values by separating them with a comma.","required":false,"schema":{"type":"string"}},{"name":"Status","in":"query","description":"**Allowed values:** `CREATED`, `SUCCEEDED`, `FAILED`\n\nThe status of the transaction. You can filter on multiple values by separating them with a comma.","required":false,"schema":{"type":"string"}},{"name":"PaymentStatus","in":"query","description":"**Allowed values:** `WAITING`, `CANCELED`, `CANCEL_REQUESTED`, `EXPIRED`, `VALIDATED`, `FAILED`\n\nThe payment status of the deposit preauthorization object:\n- `WAITING` – The deposit preauthorization can be used: the preauthorized funds can be captured (if `Status` is `SUCCEEDED`) or the preauthorization can be canceled manually.\n- `CANCELED` – Value to pass to manually cancel the deposit preauthorization before use; indicates that the deposit preauthorization was canceled manually.\n- `CANCEL_REQUESTED` – The cancellation of the deposit preauthorization has been requested but not yet processed.  \n- `EXPIRED` – The hold period on the preauthorized funds has ended without it being used.  \n- `VALIDATED` – Indicates that the preauthorized funds were captured.\n- `FAILED` – The pay-in against the preauthorization has failed, but a retry may be possible.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListDepositPreauthorizationsResponse"}}}}}}},"/v2.01/{ClientId}/payins/deposit-preauthorized/direct/full-capture":{"post":{"operationId":"create_deposit_preauthorized_payin","summary":"Create a Deposit Preauthorized PayIn","description":"This endpoint lets you capture funds against a `DepositId` that was preauthorized on a card or a PayPal account. \n\nThe payment method is indicated by the `PaymentType` of the [Deposit Preauthorization](/api-reference/deposit-preauthorizations/cancel-deposit-preauthorization) object: \n- `CARD` – Single capture possible within 29.5 days\n- `PAYPAL` – Single capture recommended within 3 days, but possible up to 29 days (not 29.5)\n\nThe shape of the pay-in object is the same – specific data points for card or PayPal authorizations are available via [GET View a Deposit Preauthorization](/api-reference/deposit-preauthorizations/view-deposit-preauthorization).\n\n<Check icon=\"fa-regular fa-circle-check\">\n**Best practice - For PayPal, capture funds within 3 days**\n\nPayPal recommends that you capture preauthorized funds within 3 days. This is because the success of the capture is subject to risk and the availability of funds on the card (or other funding instrument) that the user has linked to their PayPal account.\n</Check>\n\n<Note icon=\"fa-regular fa-circle-info\">\n**Note – Disclaimer about terminology**\n\nThe use of the term \"deposit\" in this feature is for convenience only and does not constitute a traditional banking deposit under applicable banking regulations, including the EU Capital Requirements Directive (Directive 2013/36/EU) or the Deposit Guarantee Schemes Directive (Directive 2014/49/EU). Accordingly, these funds are not covered by any statutory deposit protection schemes, and Mangopay does not operate as a licensed banking institution.\n</Note>","tags":["depositPreauthorizations"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DepositPreauthorizedPayInResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateADepositPreauthorizedPayInRequest"}}}}}},"/v2.01/{ClientId}/payins/card/web":{"post":{"operationId":"create_web_card_payin","summary":"Create a Web Card PayIn","description":"<Note icon=\"fa-regular fa-circle-info\">\n**Note – Timeout after 15 minutes**\n\nThe hosted payment page session on the `RedirectURL` lasts 15 minutes, at which point the pay-in fails automatically with result code [101109](/errors/codes/101109) if it is not completed by the user.\n</Note>\n\n<Warning icon=\"fa-regular fa-triangle-exclamation\">\n**Caution – TemplateURL customization feature deprecated**\n\nThe `TemplateURL` response parameter is deprecated and must no longer be used to redirect the user. You must redirect the user on the `RedirectURL`.\n\nThe `TemplateURLOptions` body parameter is also deprecated as the feature allowing minor customization of the hosted page is no longer supported.\n</Warning>\n\n[Read more about the Web Card PayIn object →](/api-reference/web-card-payins/web-card-payin-object)\n\n**Note:** The legacy iDEAL integration also uses this endpoint with `CardType` set to `IDEAL`. New integrations of iDEAL should use the <a href=\"/api-reference/ideal/create-ideal-payin\">Create an iDEAL PayIn</a> endpoint.","tags":["webCardPayins"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebCardPayInResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAWebCardPayInRequest"}}}}}},"/v2.01/{ClientId}/payins/card/web/{PayInId}/extended":{"get":{"operationId":"view_card_details_web_card_payin","summary":"View card details for a Web Card PayIn","description":"View card details for a Web Card PayIn","tags":["webCardPayins"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"PayInId","in":"path","description":"The unique identifier of the pay-in.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ViewCardDetailsForAWebCardPayInResponse"}}}}}}},"/v2.01/{ClientId}/payins/bankwire/direct":{"post":{"operationId":"create_bank_wire_payin","summary":"Create a Bank Wire PayIn","description":"<Warning icon=\"fa-regular fa-triangle-exclamation\">\n**Caution – Retrieve the returned bank details dynamically**\n\nIn addition to the `WireReference`, ensure you implement the `BankAccount` object parameter dynamically so the `IBAN`, `BIC`, and other response values appear as returned in for each pay-in.\n\nMangopay may change the underlying bank account without prior notice and mismatched data my lead to delays. See the <a href=\"/guides/payment-methods/banking/bank-wire\">bank wire pay-in</a> guide for more details.\n</Warning>\n\nCreate a Bank Wire PayIn\n\nThis call declares the payment to be made by the end user and returns the `BankAccount` details and `WireReference` they must use.","tags":["bankWirePayins"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BankWirePayInResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateABankWirePayInRequest"}}}}}},"/v2.01/{ClientId}/virtual-accounts/availability":{"get":{"operationId":"view_virtual_account_availabilities","summary":"View Virtual Account availabilities","description":"See your platform's account capabilities per account type and country.\n\nThis endpoint allows you to check which account countries and currencies are available to your platform for Collection and User-Owned accounts (see [guide](/guides/payment-methods/banking/virtual-iban#types) for details).","tags":["virtualAccounts"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ViewVirtualAccountAvailabilitiesResponse"}}}}}}},"/v2.01/{ClientId}/wallets/{WalletId}/virtual-accounts":{"post":{"operationId":"create_virtual_account","summary":"Create a Virtual Account","description":"Set up a virtual IBAN or local account attached to a wallet\n  <Note icon=\"fa-regular fa-circle-info\">\n  **Note – One account purpose per wallet**\n\n  A wallet can only have either `COLLECTION` or `USER_OWNED` virtual accounts attached, but not both. \n\n  It is, however, possible to attach multiple virtual accounts of the same `VirtualAccountPurpose` to a single wallet. \n  </Note>","tags":["virtualAccounts"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"WalletId","in":"path","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VirtualAccountResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAVirtualAccountRequest"}}}}},"get":{"operationId":"list_virtual_accounts_wallet","summary":"List Virtual Accounts for a Wallet","tags":["virtualAccounts"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"WalletId","in":"path","description":"The unique identifier of the wallet.","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start value: `1`\n\n**Default value:** `1`\n\nIndicates the index of the page for the pagination.","required":false,"schema":{"type":"integer"}},{"name":"per_page","in":"query","description":"Min. value: `1`; max. value: `100`\n\n**Default value:** `10`\n\nIndicates the number of items returned for each page of the pagination.","required":false,"schema":{"type":"integer"}},{"name":"Sort","in":"query","description":"**Possible values:** `CreationDate:ASC`, `CreationDate:DESC`\n\n**Default value:** `CreationDate:ASC`\n\nIndicates the direction in which to sort the list.","required":false,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListVirtualAccountsForAWalletResponse"}}}}}}},"/v2.01/{ClientId}/wallets/{WalletId}/virtual-accounts/{VirtualAccountId}":{"put":{"operationId":"deactivate_virtual_account","summary":"Deactivate a Virtual Account","description":"<Warning icon=\"fa-regular fa-triangle-exclamation\">\n**Caution - Deactivating a Virtual Account is irreversible**\n\nOnce the Virtual Account object is deactivated, it is closed and cannot be reopened. \n\nAny funds wired to this IBAN or local account details won't be credited to the corresponding wallet and will be returned to the sender.\n\nIf such cases arise, contact Mangopay <a href=\"https://hub.mangopay.com/\" target=\"_blank\">via the Dashboard</a>.\n</Warning>\n\nClose an account permanently to prevent it being used\n\nThis call serves only to deactivate a virtual account if it is no longer needed. Once deactivated, the account `Status` is `CLOSED`.","tags":["virtualAccounts"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"WalletId","in":"path","description":"The unique identifier of the wallet.","required":true,"schema":{"type":"string"}},{"name":"VirtualAccountId","in":"path","description":"The unique identifier of the Virtual Account or legacy Banking Alias (the legacy `BankingAliasId` value can be used on this endpoint).","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VirtualAccountResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeactivateAVirtualAccountRequest"}}}}},"get":{"operationId":"view_virtual_account","summary":"View a Virtual Account","description":"Fetch a Virtual Account or legacy Banking Alias based on its ID","tags":["virtualAccounts"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"WalletId","in":"path","description":"The unique identifier of the wallet.","required":true,"schema":{"type":"string"}},{"name":"VirtualAccountId","in":"path","description":"The unique identifier of the Virtual Account or legacy Banking Alias (the legacy `BankingAliasId` value can be used on this endpoint).","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VirtualAccountResponse"}}}}}}},"/v2.01/{ClientId}/wallets/{WalletId}/bankingaliases/iban":{"post":{"operationId":"create_iban_banking_alias","summary":"Create an IBAN Banking Alias","description":"<Warning icon=\"fa-regular fa-triangle-exclamation\">\n**Deprecated – Decommissioning planned for 2027**\n\nMangopay plans to decommission the Banking Alias endpoints in 2027. \n\nPlatforms using them should plan to re-integrate using the [Virtual Account](/api-reference/virtual-accounts/virtual-account-object) endpoints. \n\nExisting Banking Alias objects are available via the [GET View a Virtual Account](/api-reference/virtual-accounts/view-virtual-account) endpoint by using the Banking Alias `Id` and `WalletId` as path parameters.\n</Warning>\n\n<Warning icon=\"fa-regular fa-triangle-exclamation\">\n**Caution – Rely on `OwnerName` returned in response**\n\nSince September 15, 2025, Mangopay sets the `OwnerName` value by default based on the criteria [available here](/guides/vop/payins#banking-alias-categorization). \n\nYour platform must rely on the API response value (also available on the GET endpoints) and ensure it is easy to see and copy for the end user in your interfaces.\n</Warning>\n\n<Note icon=\"fa-regular fa-circle-info\">\n**Note - Payee confirmation in the UK** \n\nWhen the user sets up the payee with their bank, Mangopay UK or Mangopay SA is displayed as the account holder name. You should communicate this to them to avoid confusion.\n</Note>\n\nCreate an IBAN Banking Alias","tags":["bankingAliases"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"WalletId","in":"path","description":"The unique identifier of the wallet.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAnIBANBankingAliasResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAnIBANBankingAliasRequest"}}}}}},"/v2.01/{ClientId}/bankingaliases/{BankingAliasId}":{"put":{"operationId":"deactivate_banking_alias","summary":"Deactivate a Banking Alias","description":"<Warning icon=\"fa-regular fa-triangle-exclamation\">\n**Deprecated – Decommissioning planned for 2027**\n\nMangopay plans to decommission the Banking Alias endpoints in 2027. \n\nPlatforms using them should plan to re-integrate using the [Virtual Account](/api-reference/virtual-accounts/virtual-account-object) endpoints. \n\nExisting Banking Alias objects are available via the [GET View a Virtual Account](/api-reference/virtual-accounts/view-virtual-account) endpoint by using the Banking Alias `Id` and `WalletId` as path parameters.\n</Warning>\n\n<Warning icon=\"fa-regular fa-triangle-exclamation\">   \n**Caution – Deactivating a Banking Alias is irreversible** \n\nOnce the Banking Alias object is deactivated, you cannot reactivate it or attach another to the same wallet. \n\nAny funds wired to the banking alias won't be credited to the corresponding wallet.\n\nIf such cases arise, contact Mangopay <a href=\"https://hub.mangopay.com/\" target=\"_blank\">via the Dashboard</a>.\n\n</Warning>\n\nDeactivate a Banking Alias","tags":["bankingAliases"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"BankingAliasId","in":"path","description":"The unique identifier of the banking alias.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeactivateABankingAliasResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeactivateABankingAliasRequest"}}}}},"get":{"operationId":"view_banking_alias","summary":"View a Banking Alias","description":"<Warning icon=\"fa-regular fa-triangle-exclamation\">\n**Deprecated – Decommissioning planned for 2027**\n\nMangopay plans to decommission the Banking Alias endpoints in 2027. \n\nPlatforms using them should plan to re-integrate using the [Virtual Account](/api-reference/virtual-accounts/virtual-account-object) endpoints. \n\nExisting Banking Alias objects are available via the [GET View a Virtual Account](/api-reference/virtual-accounts/view-virtual-account) endpoint by using the Banking Alias `Id` and `WalletId` as path parameters.\n</Warning>\n\n<Note icon=\"fa-regular fa-circle-info\">\n**Note - Payee confirmation in the UK** \n\nWhen the user sets up the payee with their bank, Mangopay UK or Mangopay SA is displayed as the account holder name. You should communicate this to them to avoid confusion.\n</Note>\n\nView a Banking Alias","tags":["bankingAliases"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"BankingAliasId","in":"path","description":"The unique identifier of the banking alias.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ViewABankingAliasResponse"}}}}}}},"/v2.01/{ClientId}/wallets/{WalletId}/bankingaliases":{"get":{"operationId":"view_banking_alias_wallet","summary":"View a Banking Alias for a Wallet","description":"<Warning icon=\"fa-regular fa-triangle-exclamation\">\n**Deprecated – Decommissioning planned for 2027**\n\nMangopay plans to decommission the Banking Alias endpoints in 2027. \n\nPlatforms using them should plan to re-integrate using the [Virtual Account](/api-reference/virtual-accounts/virtual-account-object) endpoints. \n\nExisting Banking Alias objects are available via the [GET View a Virtual Account](/api-reference/virtual-accounts/view-virtual-account) endpoint by using the Banking Alias `Id` and `WalletId` as path parameters.\n</Warning>\n\n<Note icon=\"fa-regular fa-circle-info\">\n**Note - Payee confirmation in the UK** \n\nWhen the user sets up the payee with their bank, Mangopay UK or Mangopay SA is displayed as the account holder name. You should communicate this to them to avoid confusion.\n</Note>\n\nView a Banking Alias for a Wallet","tags":["bankingAliases"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"WalletId","in":"path","description":"The unique identifier of the wallet.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ViewABankingAliasForAWalletResponse"}}}}}}},"/v2.01/{ClientId}/payment-methods/openbanking/metadata/supported-banks":{"get":{"operationId":"view_supported_banks_pay_by_bank","summary":"View supported banks for Pay by Bank","description":"Retrieve supported banks to present to a user for Pay by Bank pay-ins\n\nThis endpoint allows you to retrieve a paginated list of banks that you can present to the user for selection during their Pay by Bank checkout experience. Once they have selected their bank, and optionally the scheme, submit the data of their selection to the [POST Create a Pay by Bank PayIn](/api-reference/pay-by-bank/create-pay-by-bank-payin) endpoint. [Read the guide](/guides/payment-methods/banking/pay-by-bank) **&rarr;**","tags":["payByBank"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"CountryCodes","in":"query","description":"**Allowed values:** `AT`, `DE`, `DK`, `EE`, `ES`, `FI`, `FR`, `GB`, `IE`, `IT`, `LV`, `LT`, `NL`, `NO`, `PL`, `PT`\n\nThe countries for which to return supported banks. You can combine query values in a comma-separated list.","required":false,"schema":{"type":"string"}},{"name":"per_page","in":"query","description":"Min. value: `1`; max. value: `100`\n\n**Default value:** `10`\n\nThe number of `Banks` objects returned for each page of the pagination.\n\nOn this endpoint, the pagination refers to the number of `Banks` objects, regardless of whether they span multiple `Countries` objects.","required":false,"schema":{"type":"integer"}},{"name":"page","in":"query","description":"Start value: `1`\n\n**Default value:** `1`\n\nIndicates the index of the page for the pagination.","required":false,"schema":{"type":"integer"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ViewSupportedBanksForPayByBankResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v2.01/{ClientId}/payins/payment-methods/openbanking":{"post":{"operationId":"create_pay_by_bank_payin","summary":"Create a Pay by Bank PayIn","description":"Initiate a Pay by Bank pay-in request.\n\n<Note icon=\"fa-regular fa-circle-info\">\n**Note – Session timeout 9 minutes**\n\nThe Pay by Bank session lasts for 9 minutes, at which point the pay-in fails automatically if no action has been taken by the user.\n</Note>\n\nRelated: [test data](/testing/payment-methods#pay-by-bank), [guide](/guides/payment-methods/banking/pay-by-bank)","tags":["payByBank"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayByBankPayInResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAPayByBankPayInRequest"}}}}}},"/v2.01/{ClientId}/mandates/directdebit/web":{"post":{"operationId":"create_mandate","summary":"Create a Mandate","description":"<Note icon=\"fa-regular fa-circle-info\">\n**Note – Mandate expires after 1 hour**\n\nIf not confirmed within 1 hour of the `CreationDate`, the Mandate expires with the error <a href=\"/errors/codes/001807\">001807</a> and a new one must be created.\n</Note>\n\nCreate a Mandate\n\nFor SDD, if the `BankAccountId` is a Danish or Swedish IBAN (starting `DK` or `SE`), this endpoint returns a 400 error because they are not currently supported (see [IBAN compatibility](/guides/payment-methods/banking/direct-debit#iban-compatibility)).","tags":["Mandates"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MandateResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAMandateRequest"}}}}}},"/v2.01/{ClientId}/mandates/{MandateId}/cancel":{"put":{"operationId":"cancel_mandate","summary":"Cancel a Mandate","description":"<Warning icon=\"fa-regular fa-triangle-exclamation\">   \n**Warning – Call requires `Content-Length` adjustment** \n\nFor this call to succeed, you need to define the header `Content-Length` to `0`.  \n</Warning>\n\n<Note icon=\"fa-regular fa-circle-info\">\n**Note – Mandate must be `ACTIVE` or `SUBMITTED`**\n\nA mandate can only be canceled if its `Status` is `ACTIVE` or `SUBMITTED`. Once canceled, its status changes to `FAILED`.\n</Note>\n\nCancel a Mandate","tags":["Mandates"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"MandateId","in":"path","description":"The unique identifier of the mandate.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MandateResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v2.01/{ClientId}/mandates/{MandateId}":{"get":{"operationId":"view_mandate","summary":"View a Mandate","description":"View a Mandate","tags":["Mandates"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"MandateId","in":"path","description":"The unique identifier of the mandate.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MandateResponse"}}}}}}},"/v2.01/{ClientId}/mandates":{"get":{"operationId":"list_mandates","summary":"List all Mandates","description":"List all Mandates","tags":["Mandates"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"BeforeDate","in":"query","description":"The date before which the object was created (based on the object's `CreationDate` parameter). You can filter on a specific time range by using both the `AfterDate` and `BeforeDate` query parameters.","required":false,"schema":{"type":"integer"}},{"name":"AfterDate","in":"query","description":"The date after which the object was created (based on the object's `CreationDate` parameter). You can filter on a specific time range by using both the `AfterDate` and `BeforeDate` query parameters.","required":false,"schema":{"type":"integer"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListAllMandatesResponse"}}}}}}},"/v2.01/{ClientId}/users/{UserId}/mandates":{"get":{"operationId":"list_mandates_user","summary":"List Mandates for a User","description":"List Mandates for a User","tags":["Mandates"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"UserId","in":"path","description":"The unique identifier of the user.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListAllMandatesResponse"}}}}}}},"/v2.01/{ClientId}/users/{UserId}/bankaccounts/{BankAccountId}/mandates":{"get":{"operationId":"list_mandates_bank_account","summary":"List Mandates for a Bank Account","description":"List Mandates for a Bank Account","tags":["Mandates"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"UserId","in":"path","description":"The unique identifier of the user.","required":true,"schema":{"type":"string"}},{"name":"BankAccountId","in":"path","description":"The unique identifier of the bank account.\n\n**Warning:** The corresponding Bank Account must belong to the BACS network (GB-type Bank Account) or SEPA network (IBAN-type Bank Account).","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListAllMandatesResponse"}}}}}}},"/v2.01/{ClientId}/payins/directdebit/direct":{"post":{"operationId":"create_direct_debit_payin","summary":"Create a Direct Debit PayIn","description":"Create a Direct Debit PayIn","tags":["directDebitPayins"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DirectDebitPayInResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateADirectDebitPayInRequest"}}}}}},"/v2.01/{ClientId}/payins/directdebit/web":{"post":{"operationId":"create_web_direct_debit_payin","summary":"Create a Web Direct-Debit PayIn","description":"<Warning icon=\"fa-regular fa-triangle-exclamation\">\n**Warning – Deprecated endpoint**\n\nThis endpoint is deprecated and will be removed. Both payment methods available via this endpoint, Sofort and Giropay, are no longer available.\n</Warning>\n\n<Warning icon=\"fa-regular fa-triangle-exclamation\">\n**Warning – Giropay no longer available after June 30, 2024**\n\nGiropay's operator Paydirekt has decided to cease the payment method's services at the end of June, without providing a direct alternative. This decision by Paydirekt impacts the entire industry and is beyond our control.\n\nEffective July 1, 2024: \n- Pay-ins will fail with the <a href=\"/errors/codes/101101\">101101</a> error\n- Refunds will be possible for one year \n\nThis change affects both the <a href=\"/api-reference/giropay\">new</a> integration and this legacy one.\n\nOur team is ready to assist you with your integration of alternatives like <a href=\"/guides/payment-methods/klarna\">Klarna</a>, <a href=\"/guides/payment-methods/paypal\">PayPal</a>, or <a href=\"/guides/payment-methods/banking/virtual-iban\">virtual IBANs</a> for the German market. Please reach out <a href=\"https://hub.mangopay.com/\" target=\"_blank\">via the Dashboard</a>. \n</Warning>\n\n<Warning icon=\"fa-regular fa-triangle-exclamation\">\n**Caution – Sofort no longer available after June 1, 2024** \n\nThese endpoints are the legacy integration of Sofort with Mangopay (`DirectDebitType` is `SOFORT`).  \n\nAs of June 1, 2024, the Sofort payment method was no longer available with Mangopay. Klarna acquired deprecated the Sofort brand and technical solution.\n\nPlatforms looking for Sofort are invited to integrate [Klarna](/guides/payment-methods/klarna).\n</Warning>","tags":["webDirectDebitPayins"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeprecatedWebDirectDebitPayInResponse"}}}}},"deprecated":true,"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeprecatedCreateAWebDirectDebitPayInRequest"}}}}}},"/v2.01/{ClientId}/payins/applepay/direct":{"post":{"operationId":"create_apple_pay_payin","summary":"Create an Apple Pay PayIn","description":"Create an Apple Pay PayIn","tags":["applePay"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplePayPayInResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAnApplePayPayInRequest"}}}}}},"/v2.01/{ClientId}/payins/payment-methods/applepay/recurring":{"post":{"operationId":"create_recurring_apple_pay_payin","summary":"Create a Recurring Apple Pay PayIn (CIT or MIT)","description":"Request a recurring Apple Pay pay-in based on a `RecurringPayinRegistrationId` with `PaymentType` `APPLEPAY`, obtained from [POST Create a Recurring PayIn Registration](/api-reference/recurring-payin-registrations/create-recurring-payin-registration).\n\nThere are two possible paylods: \n- **CIT** – Customer-initiated transaction when the user is on session. With Apple Pay, authentication is handled by the user's device (iPhone or Mac) so there is no need for redirection.\n- **MIT** – Subsequent merchant-initiated transactions in the absence of the user, based on the initial successful authentication, unless and until re-authentication is required.\n\nRead more about [Apple Pay recurring payments](/guides/payment-methods/apple-pay#recurring-payments) **&rarr;**","tags":["recurringApplePayPayins"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecurringApplePayPayInResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/recurringApplePayPayins_create_recurring_apple_pay_payin_Request"}}}}}},"/v2.01/{ClientId}/payins/payment-methods/bancontact":{"post":{"operationId":"create_bancontact_payin","summary":"Create a Bancontact PayIn","description":"<Note icon=\"fa-regular fa-circle-info\"> \n**Note – Timeout after 1 hour** \n\nThe Bancontact payment session lasts for 1 hour, at which point the pay-in fails automatically if no action has been taken by the user.\n</Note>\n\nCreate a Bancontact PayIn","tags":["Bancontact"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BancontactPayInResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateABancontactPayInRequest"}}}}}},"/v2.01/{ClientId}/payins/payment-methods/bizum":{"post":{"operationId":"create_bizum_payin","summary":"Create a Bizum PayIn","description":"<Note icon=\"fa-regular fa-circle-info\">\n**Note – Timeout after 5 minutes** \n\nThe payment session lasts for 5 minutes for both the phone and redirect flows, at which point the pay-in fails automatically if no action has been taken by the user.  \n</Note>\n\nCreate a Bizum PayIn\n\nThere are two [Bizum](/guides/payment-methods/bizum) flows, depending on the payload sent to this endpoint: \n- **Phone** – If `Phone` is sent, the `ReturnURL` is ignored and `RedirectURL` is not returned because no redirection is necessary: the user receives a push notification from the Bizum app asking them to authenticate. In Sandbox, the `RedirectURL` is returned in all cases, because it is the only way to complete the transaction (see [testing](/testing/payment-methods#bizum)). \n- **Redirect** – If `Phone` is not sent, then `ReturnURL` is required and you must redirect the user to the `RedirectURL` in the response so they can enter their phone number themselves.","tags":["Bizum"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BizumPayInResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateABizumPayInRequest"}}}}}},"/v2.01/{ClientId}/payins/payment-methods/blik":{"post":{"operationId":"create_blik_payin","summary":"Create a BLIK PayIn","description":"<Note icon=\"fa-regular fa-circle-info\"> \n**Note – Timeout after 55 seconds** \n\nThe payment session lasts for 55 seconds, at which point the pay-in fails automatically if no action has been taken by the user.  \n</Note>\n\n<Note icon=\"fa-regular fa-circle-info\"> \n**Note – Minimum amount in Production** \n\nIn Production, the minimum accepted amount for BLIK is 0.01 PLN (`1`).  \n</Note>","tags":["Blik"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BLIKPayInResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/blik_create_blik_payin_Request"}}}}}},"/v2.01/{ClientId}/payins/payment-methods/giropay":{"post":{"operationId":"create_giropay_payin","summary":"Create a Giropay PayIn","description":"<Warning icon=\"fa-regular fa-triangle-exclamation\">\n**Warning – Giropay no longer available after June 30, 2024**\n\nGiropay's operator Paydirekt has decided to cease the payment method's services at the end of June, without providing a direct alternative. This decision by Paydirekt impacts the entire industry and is beyond our control.\n\nEffective July 1, 2024: \n- Pay-ins will fail with the <a href=\"/errors/codes/101101\">101101</a> error\n- Refunds will be possible for one year \n\nThis change affects both the <a href=\"/api-reference/giropay\">new</a> and <a href=\"/api-reference/web-direct-debit-payins\">legacy</a> integrations.\n\nOur team is ready to assist you with your integration of alternatives like <a href=\"/guides/payment-methods/klarna\">Klarna</a>, <a href=\"/guides/payment-methods/paypal\">PayPal</a>, or <a href=\"/guides/payment-methods/banking/virtual-iban\">virtual IBANs</a> for the German market. Please reach out <a href=\"https://hub.mangopay.com/\" target=\"_blank\">via the Dashboard</a>. \n</Warning>\n\n<Note icon=\"fa-regular fa-circle-info\"> \n**Note – Timeout after 1 hour** \n\nThe payment session lasts for 1 hour, at which point the pay-in fails automatically if no action has been taken by the user.  \n</Note>\n\n<Note icon=\"fa-regular fa-circle-info\"> \n**Note – Minimum amount** \n\nThe minimum accepted amount for Giropay pay-ins is €1.00 (`100`).   \nIn Production, pay-ins lower than this amount will fail.  \n</Note>","tags":["Giropay"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeprecatedGiropayPayInResponse"}}}}},"deprecated":true,"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeprecatedCreateAGiropayPayInRequest"}}}}}},"/v2.01/{ClientId}/payins/payment-methods/googlepay":{"post":{"operationId":"create_google_pay_payin","summary":"Create a Google Pay PayIn","description":"Create a Google Pay PayIn","tags":["googlePay"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GooglePayPayInResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAGooglePayPayInRequest"}}}}}},"/v2.01/{ClientId}/payins/payment-methods/googlepay/recurring":{"post":{"operationId":"create_recurring_google_pay_payin","summary":"Create a Recurring Google Pay PayIn (CIT or MIT)","description":"Request a recurring Google Pay pay-in based on a `RecurringPayinRegistrationId` with `PaymentType` `GOOGLE_PAY`, obtained from [POST Create a Recurring PayIn Registration](/api-reference/recurring-payin-registrations/create-recurring-payin-registration).\n\nThere are two possible paylods: \n- **CIT** – Customer-initiated transaction when the user is on session, which may require them to authenticate on the `SecureModeRedirectURL` returned (unless authentication was handled by Google Pay).\n- **MIT** – Subsequent merchant-initiated transactions in the absence of the user, based on the initial successful authentication, unless and until re-authentication is required.\n\nRead more about [Google Pay recurring payments](/guides/payment-methods/google-pay#recurring-payments) **&rarr;**","tags":["recurringGooglePayPayins"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecurringGooglePayPayInResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/recurringGooglePayPayins_create_recurring_google_pay_payin_Request"}}}}}},"/v2.01/{ClientId}/payins/payment-methods/ideal":{"post":{"operationId":"create_ideal_payin","summary":"Create an iDEAL PayIn","description":"<Note icon=\"fa-regular fa-circle-info\"> \n**Note – Timeout after 30 minutes** \n\nThe iDEAL payment session lasts for 30 minutes, at which point the pay-in fails automatically if no action has been taken by the user.  \n</Note>\n\nCreate an iDEAL PayIn","tags":["iDEAL"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IDEALPayInResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAnIDEALPayInRequest"}}}}}},"/v2.01/{ClientId}/payins/payment-methods/klarna":{"post":{"operationId":"create_klarna_payin","summary":"Create a Klarna PayIn","description":"<Note icon=\"fa-regular fa-circle-info\"> \n**Note – Timeout after 3 hours** \n\nThe Klarna payment session lasts 3 hours, at which point the pay-in fails automatically (result code [101109](/errors/codes/101109)) if no action has been taken by the user.\n</Note>\n\n<Note icon=\"fa-regular fa-circle-info\"> \n**Note – Minimum amount in Production** \n\nIn Production, the minimum accepted `DebitedFunds` amount for Klarna is `1` (regardless of currency).  \n</Note>\n\nCreate a Klarna PayIn","tags":["Klarna"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlarnaPayInResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAKlarnaPayInRequest"}}}}}},"/v2.01/{ClientId}/payins/payment-methods/mbway":{"post":{"operationId":"create_mb_way_payin","summary":"Create an MB WAY PayIn","description":"<Note icon=\"fa-regular fa-circle-info\"> \n**Note – Timeout after 4 minutes** \n\nThe payment session lasts for 4 minutes, at which point the pay-in fails automatically if no action has been taken by the user.  \n</Note>\n\n<Warning icon=\"fa-regular fa-triangle-exclamation\">   \n**Caution – No phone number validation** \n\nIf the phone number provided is of an accepted format but not valid or not attributed to the corresponding MB WAY user, then the pay-in is created but will fail because the user will not receive a push notification from the MB WAY app.  \n</Warning>\n\nCreate an MB WAY PayIn","tags":["mbWay"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MBWAYPayInResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAnMBWAYPayInRequest"}}}}}},"/v2.01/{ClientId}/payins/payment-methods/multibanco":{"post":{"operationId":"create_multibanco_payin","summary":"Create a Multibanco PayIn","description":"<Note icon=\"fa-regular fa-circle-info\"> \n**Note – Timeout after 7 days** \n\nThe payment session lasts for 7 days, at which point the pay-in fails automatically if no action has been taken by the user.  \n</Note>´","tags":["Multibanco"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MultibancoPayInResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAMultibancoPayInRequest"}}}}}},"/v2.01/{ClientId}/payins/payment-methods/payconiq":{"post":{"operationId":"create_payconiq_payin","summary":"Create a Payconiq PayIn","description":"<Warning icon=\"fa-regular fa-triangle-exclamation\">\n**Deprecated – Payconiq discontinued from Dec 4, 2025**\n\nFollowing its acquisition by the European Payments Initiative (EPI), the Payconiq brand and services are being phased out (<a href=\"https://www.payconiq.be/en/payconiq-evolves\" target=\"_blank\">read more</a> on Payconiq's website).\n\nThe timeline is as follows: \n\n- Dec 4, 2025 - [Payconiq pay-ins](/api-reference/payconiq/create-payconiq-payin) attempted after **12:00 noon CET** will fail\n- Dec 31, 2025 - Final day for processing [pay-in refunds](/api-reference/refunds/create-refund-payin)\n- Jan 1, 2026 - Refunds possible using payouts ([see guide](/guides/payment-methods/payconiq#refunds-from-jan-1,-2026))\n\nPlatforms using Payconiq are invited to integrate [Bancontact](https://www.notion.so/guides/payment-methods/bancontact), which allows users to continue paying with their Payconiq by Bancontact mobile app via the `DeepLinkURL`.\n</Warning>\n\n<Note icon=\"fa-regular fa-circle-info\"> \n**Note – Timeout after 1 hour** \n\nThe Payconiq payment session lasts for 1 hour, at which point the pay-in fails automatically if no action has been taken by the user.\n</Note>\n\nCreate a Payconiq PayIn","tags":["Payconiq"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayconiqPayInResponse"}}}}},"deprecated":true,"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAPayconiqPayInRequest"}}}}}},"/v2.01/{ClientId}/payins/payment-methods/paypal/data-collection":{"post":{"operationId":"submit_data_paypal_payin","summary":"Submit data for a PayPal PayIn","description":"Provide transaction data to PayPal prior to initiating a pay-in ([read guide](/guides/payment-methods/paypal#submit-pre-transaction-risk-data)).\n\n<Note icon=\"fa-regular fa-circle-info\">\n**Note – Data to submit depends on industry**\n\nThe request body parameters described below are required for all marketplace businesses.\n\nAdditional data points are required for platforms operating in the following industries:\n- Events and ticketing\n- Online travel agents:\n  - Car rentals\n  - Hotels\n  - Transportation\n  - Travel packages\n- Retail and groceries\n- Cruise lines\n- Buy online, pick up in store (BOPIS)\n- Crypto\n\nBefore integrating this endpoint, platforms operating in the verticals above need to contact Mangopay <a href=\"https://hub.mangopay.com/\" target=\"_blank\">via the Dashboard</a>.\n</Note>\n\nThe `DataCollectionId` returned in the response must be sent on the associated pay-in call for both one-time and recurring payments: \n- [POST Create a PayPal PayIn](/api-reference/paypal/create-paypal-payin)\n- [POST Create a Recurring PayPal PayIn](/api-reference/paypal/create-recurring-paypal-payin) with the CIT payload\n- [POST Create a Recurring PayPal PayIn](/api-reference/paypal/create-recurring-paypal-payin) with the MIT payload\n\nEach PayPal pay-in or preauth requires a new `DataCollectionId`. The property is not returned on the pay-in endpoints.","tags":["PayPal"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitDataForAPayPalPayInResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitDataForAPayPalPayInRequest"}}}}}},"/v2.01/{ClientId}/payins/payment-methods/paypal/data-collection/{DataCollectionId}":{"get":{"operationId":"view_data_paypal_payin","summary":"View data submitted for a PayPal PayIn","description":"Retrieve pre-transaction data submitted previously.","tags":["PayPal"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"DataCollectionId","in":"path","description":"The unique identifier of the Data Collection object, returned after sending the requested data to the [POST Submit data for a PayPal PayIn](/api-reference/paypal/submit-data-paypal-payin) endpoint.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ViewDataSubmittedForAPayPalPayInResponse"}}}}}}},"/v2.01/{ClientId}/payins/payment-methods/paypal":{"post":{"operationId":"create_paypal_payin","summary":"Create a PayPal PayIn","description":"Create a PayPal PayIn","tags":["PayPal"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayPalPayInResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAPayPalPayInRequest"}}}}}},"/v2.01/{ClientId}/payins/paypal/web":{"post":{"operationId":"create_paypal_payin_web","summary":"Create a PayPal PayIn","description":"<Warning icon=\"fa-regular fa-triangle-exclamation\">\n**Caution – Deprecated legacy integration**\n\nThis endpoint is the legacy integration of PayPal with Mangopay. If you are integrating PayPal for the first time, use the new [POST Create a PayPal PayIn](/api-reference/paypal/create-paypal-payin) endpoint.\n\nExisting legacy integrations continue to be supported, but any integration enhancements are only developed on the new endpoint. \n\nPlatforms are strongly encouraged to move to the new integration to benefit from additional features, including:\n- [Recurring payment flows](/guides/payment-methods/paypal#recurring-payments)\n- Support for [tracking information](/guides/payment-methods/paypal#tracking-information) to sync evidence of shipped goods\n- Additional API payload data such as shipping preference, platform references, and PayPal user information\n</Warning>","tags":["PayPal"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeprecatedPayPalPayInResponse"}}}}},"deprecated":true,"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeprecatedCreateAPayPalPayInRequest"}}}}}},"/v2.01/{ClientId}/payins/payment-methods/paypal/recurring":{"post":{"operationId":"create_recurring_paypal_payin","summary":"Create a Recurring PayPal PayIn (CIT or MIT)","description":"Request a recurring PayPal pay-in based on a `RecurringPayinRegistrationId` with `PaymentType` `PAYPAL`, obtained from [POST Create a Recurring PayIn Registration](/api-reference/recurring-payin-registrations/create-recurring-payin-registration).\n\nThere are two possible paylods: \n- **CIT** – Customer-initiated transaction when the user is on session, requiring them to authenticate via PayPal on the `RedirectURL` returned.\n- **MIT** – Subsequent merchant-initiated transactions in the absence of the user, based on the initial successful authentication.\n\nRead the guide to [PayPal recurring payments](/guides/payment-methods/paypal#recurring-payments) **&rarr;**","tags":["PayPal"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecurringPayPalPayInResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/paypal_create_recurring_paypal_payin_Request"}}}}}},"/v2.01/{ClientId}/deposit-preauthorizations/payment-methods/paypal":{"post":{"operationId":"create_paypal_deposit_preauthorization","summary":"Create a PayPal Deposit Preauthorization","description":"This endpoint creates a [Deposit Preauthorization](/api-reference/deposit-preauthorizations/deposit-preauthorization-object) with `PaymentType` of `PAYPAL` and returns the PayPal `RedirectURL` on which the user can preauthorize the debited funds.\n\nOnce authorized (`Status` becomes `SUCCEEDED`), you can capture the funds using the [POST Create a Deposit Preauthorized PayIn](/api-reference/deposit-preauthorizations/create-deposit-preauthorized-payin) endpoint.\n\n<Check icon=\"fa-regular fa-circle-check\">\n**Best practice - Capture funds within 3 days**\n\nPayPal recommends that you capture preauthorized funds within 3 days (using [POST Create a Deposit Preauthorized PayIn](/api-reference/deposit-preauthorizations/create-deposit-preauthorized-payin)). This is because the success of the capture is subject to risk and the availability of funds on the card (or other funding instrument) that the user has linked to their PayPal account. \n</Check>\n\n<Note icon=\"fa-regular fa-circle-info\">\n**Note – Disclaimer about terminology**\n\nThe use of the term \"deposit\" in this feature is for convenience only and does not constitute a traditional banking deposit under applicable banking regulations, including the EU Capital Requirements Directive (Directive 2013/36/EU) or the Deposit Guarantee Schemes Directive (Directive 2014/49/EU). Accordingly, these funds are not covered by any statutory deposit protection schemes, and Mangopay does not operate as a licensed banking institution.\n</Note>","tags":["PayPal"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayPalDepositPreauthorizationResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAPayPalPreauthorizationRequest"}}}}}},"/v2.01/{ClientId}/payins/{PayInId}/trackings":{"put":{"operationId":"add_tracking_paypal_payin","summary":"Add tracking information to a PayPal PayIn","description":"<Warning icon=\"fa-regular fa-triangle-exclamation\">   \n**Caution – Tracking information cannot be edited** \n\nYou can't modify the `TrackingNumber`, `Carrier`, or `NotifyBuyer` once added.  \nYou can only send a unique tracking number once.   \n</Warning>\n\nAdd tracking information to a PayPal PayIn\n\nYou can use this call to add the tracking number and carrier for `LineItems` shipments, on both one-time and recurring PayPal pay-ins.\n\nThere is no link between the line items and the tracking numbers.   \n\nIf adding multiple tracking numbers for the same transaction, it is recommended to set `NotifyBuyer` to `true` on only one of them.","tags":["PayPal"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"PayInId","in":"path","description":"The unique identifier of the pay-in.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddTrackingInformationToAPayPalPayInResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddTrackingInformationToAPayPalPayInRequest"}}}}}},"/v2.01/{ClientId}/payins/payment-methods/satispay":{"post":{"operationId":"create_satispay_payin","summary":"Create a Satispay PayIn","description":"<Note icon=\"fa-regular fa-circle-info\"> \n**Note – Timeout after 30 minutes** \n\nThe payment session lasts for 30 minutes, at which point the pay-in fails automatically if no action has been taken by the user.  \n</Note>\n\nCreate a Satispay PayIn","tags":["Satispay"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SatispayPayInResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateASatispayPayInRequest"}}}}}},"/v2.01/{ClientId}/payins/payment-methods/swish":{"post":{"operationId":"create_swish_payin","summary":"Create a Swish PayIn","description":"<Note icon=\"fa-regular fa-circle-info\"> \n**Note – Session timeout** \n\nThe Swish payment session lasts for 3 minutes, at which point the pay-in fails automatically if no action has been taken by the user.\n</Note>\n\n<Note icon=\"fa-regular fa-circle-info\"> \n**Note – Minimum amount 0.01 SEK** \n\nOn Swish pay-ins, the minimum amount is 0.01 SEK (`DebitedFunds.Amount` value `1`).\n</Note>\n\nCreate a Swish PayIn","tags":["Swish"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SwishPayInResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateASwishPayInRequest"}}}}}},"/v2.01/{ClientId}/payins/payment-methods/twint":{"post":{"operationId":"create_twint_payin","summary":"Create a TWINT PayIn","description":"<Note icon=\"fa-regular fa-circle-info\"> \n**Note – Session timeout** \n\nThe TWINT session times out after:\n- 15 minutes for the hosted webpage\n- 3 minutes once the user scans the QR code\n</Note>\n\n<Note icon=\"fa-regular fa-circle-info\"> \n**Note – Minimum amount 0.01 CHF** \n\nOn TWINT pay-ins, the minimum amount is 0.01 CHF (`DebitedFunds.Amount` value `1`).\n</Note>\n\nCreate a TWINT PayIn","tags":["TWINT"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TwintPayInResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateATwintPayInRequest"}}}}}},"/v2.01/{ClientId}/transfers":{"post":{"operationId":"create_transfer","summary":"Create a Transfer","description":"<Note icon=\"fa-regular fa-circle-info\">\n**Note – ScaContext default value is USER_PRESENT**\n\nOn this endpoint, the default value for `ScaContext` is `USER_PRESENT`. If the `PendingUserAction.RedirectUrl` value is returned, you need to redirect the user to perform SCA.\n\nWith approval from Mangopay, your platform may be able to use the `USER_NOT_PRESENT` value provided you also have a legal proxy in place with the user and the user's consent to initiate transfers on their behalf (read more about [proxy management](/guides/sca/proxy-management)).\n</Note>\n\n<Note icon=\"fa-regular fa-circle-info\">\n**Note – SCA may be triggered by this endpoint**\n\nWhen a user with `UserCategory` `OWNER` initiates a transfer to another `OWNER` they are required to [authenticate the transfer with SCA](/guides/sca/transfers), unless Mangopay applies a [low-amount or low-risk exemption](/guides/sca#exemptions-available-to-mangopay) to the transfer (or unless your platform is using a [proxy and user consent](/guides/sca/proxy-management)).\n\nTo let the user complete the SCA session on the Mangopay-hosted webpage, your platform needs to retrieve the returned `PendingUserAction.RedirectUrl`, add an encoded `returnUrl` query parameter, and redirect the user. Read more about how to redirect them in the [SCA session](/guides/sca/session) guide.\n\nIn Sandbox, you can bypass SCA by including the word `accept` in the `Email` value of the [Natural User](/api-reference/users/natural-user-object-sca) or the `LegalRepresentative.Email` value of the [Legal User](/api-reference/users/legal-user-object-sca) – for example `accept@example.com` or `john.doe+accept@example.com`.\n</Note>\n\nCreate a Transfer","tags":["Transfers"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateATransferResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateATransferRequest"}}}}}},"/v2.01/{ClientId}/transfers/{TransferId}":{"get":{"operationId":"view_transfer","summary":"View a Transfer","description":"<Note icon=\"fa-regular fa-circle-info\">\n**Note – Transfer data retained for 13 months**\n\nAn API call to retrieve a transfer whose `CreationDate` is older than 13 months may return 404 Not Found.\n\nFor more information, see the <a href=\"/api-reference/overview/data-availability-periods\">Data availability periods</a> article.\n</Note>\n\nView a Transfer","tags":["Transfers"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"TransferId","in":"path","description":"The unique identifier of the transfer.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ViewATransferResponse"}}}}}}},"/v2.01/{ClientId}/payins/{PayInId}/refunds":{"post":{"operationId":"create_refund_payin","summary":"Create a Refund for a PayIn","description":"The pay-in refund is a request to reimburse a pay-in and is supported for most payment methods. You can make partial refunds by providing a debited funds `Amount` value lower than the initial transaction amount.\n\n<Note icon=\"fa-regular fa-circle-info\">\n  **Note – Conditions for pay-in refund**\n\n  * The amount value is 1 or above, regardless of the currency.\n  * The initial transaction status is `SUCCEEDED`.\n  * The initial transaction hasn't been disputed.\n  * The initial transaction was made within the time window specified for the [payment method](/guides/payment-methods).\n</Note>\n\n[Read more about pay-in refunds](/guides/refunds#pay-in-refunds) **&rarr;**","tags":["Refunds"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"PayInId","in":"path","description":"The unique identifier of the pay-in.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayInRefundResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateARefundForAPayInRequest"}}}}},"get":{"operationId":"list_refunds_payin","summary":"List Refunds for a PayIn","description":"List Refunds for a PayIn","tags":["Refunds"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"PayInId","in":"path","description":"The unique identifier of the pay-in.","required":true,"schema":{"type":"string"}},{"name":"Status","in":"query","description":"**Allowed values:** `CREATED`, `SUCCEEDED`, `FAILED`\n\nThe status of the transaction. You can filter on multiple values by separating them with a comma.","required":false,"schema":{"type":"string"}},{"name":"ResultCode","in":"query","description":"The code indicating the result of the operation. You can filter on multiple values by separating them with a comma.","required":false,"schema":{"type":"string"}},{"name":"BeforeDate","in":"query","description":"The date before which the transaction was created (based on the transaction's `CreationDate` parameter). You can filter on a specific time range by using both the `AfterDate` and `BeforeDate` query parameters.","required":false,"schema":{"type":"integer"}},{"name":"AfterDate","in":"query","description":"The date after which the transaction was created (based on the transaction's `CreationDate` parameter). You can filter on a specific time range by using both the `AfterDate` and `BeforeDate` query parameters.","required":false,"schema":{"type":"integer"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListRefundsForAPayInResponse"}}}}}}},"/v2.01/{ClientId}/transfers/{TransferId}/refunds":{"post":{"operationId":"create_refund_transfer","summary":"Create a Refund for a Transfer","description":"You can do a partial refund by providing a debited funds `Amount` value lower than the initial transaction amount. The debited funds amount must be 1 or more, if it is included.\n\n[Read more about transfer refunds](/guides/refunds#transfer-refunds) **&rarr;**","tags":["Refunds"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"TransferId","in":"path","description":"The unique identifier of the transfer.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransferRefundResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateARefundForATransferRequest"}}}}},"get":{"operationId":"list_refunds_transfer","summary":"List Refunds for a Transfer","description":"List Refunds for a Transfer","tags":["Refunds"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"TransferId","in":"path","description":"The unique identifier of the transfer.","required":true,"schema":{"type":"string"}},{"name":"Status","in":"query","description":"**Allowed values:** `CREATED`, `SUCCEEDED`, `FAILED`\n\nThe status of the transaction. You can filter on multiple values by separating them with a comma.","required":false,"schema":{"type":"string"}},{"name":"ResultCode","in":"query","description":"The code indicating the result of the operation. You can filter on multiple values by separating them with a comma.","required":false,"schema":{"type":"string"}},{"name":"BeforeDate","in":"query","description":"The date before which the transaction was created (based on the transaction's `CreationDate` parameter). You can filter on a specific time range by using both the `AfterDate` and `BeforeDate` query parameters.","required":false,"schema":{"type":"integer"}},{"name":"AfterDate","in":"query","description":"The date after which the transaction was created (based on the transaction's `CreationDate` parameter). You can filter on a specific time range by using both the `AfterDate` and `BeforeDate` query parameters.","required":false,"schema":{"type":"integer"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListRefundsForATransferResponse"}}}}}}},"/v2.01/{ClientId}/refunds/{RefundId}":{"get":{"operationId":"view_refund","summary":"View a Refund","description":"<Note icon=\"fa-regular fa-circle-info\">\n**Note – Refund data retained for 13 months**\n\nThe API retains all transaction objects for 13 months from `CreationDate`. This applies to refunds and the initial transaction linked to a refund.\n\nA call to retrieve the initial transaction of a refund, based on the refund's `InitialTransactionId`, may return a 404 Not Found if it occurred more than 13 months ago.\n\nFor more information, see the <a href=\"/api-reference/overview/data-availability-periods\">Data availability periods</a> article.\n</Note>","tags":["Refunds"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"RefundId","in":"path","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ViewARefundResponse"}}}}}}},"/v2.01/{ClientId}/payouts/{PayoutId}/refunds":{"get":{"operationId":"list_refunds_payout","summary":"List Refunds for a Payout","description":"List Refunds for a Payout\n\nThis call returns the refund for a payout, which is known as a **payout return** or return of funds.\n\nA payout return is only generated by Mangopay. For more information, see the [payout returns](/guides/payouts/rejects-returns) guide.","tags":["Refunds"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"PayoutId","in":"path","description":"The unique identifier of the payout.","required":true,"schema":{"type":"string"}},{"name":"Status","in":"query","description":"**Allowed values:** `CREATED`, `SUCCEEDED`, `FAILED`\n\nThe status of the transaction. You can filter on multiple values by separating them with a comma.","required":false,"schema":{"type":"string"}},{"name":"ResultCode","in":"query","description":"The code indicating the result of the operation. You can filter on multiple values by separating them with a comma.","required":false,"schema":{"type":"string"}},{"name":"BeforeDate","in":"query","description":"The date before which the transaction was created (based on the transaction's `CreationDate` parameter). You can filter on a specific time range by using both the `AfterDate` and `BeforeDate` query parameters.","required":false,"schema":{"type":"integer"}},{"name":"AfterDate","in":"query","description":"The date after which the transaction was created (based on the transaction's `CreationDate` parameter). You can filter on a specific time range by using both the `AfterDate` and `BeforeDate` query parameters.","required":false,"schema":{"type":"integer"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListRefundsForAPayoutResponse"}}}}}}},"/v2.01/{ClientId}/repudiations/{RepudiationId}/refunds":{"get":{"operationId":"list_refunds_repudiation","summary":"List Refunds for a Repudiation","description":"List Refunds for a Repudiation\n\nRepudiations are refunded when a dispute is won.","tags":["Refunds"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"RepudiationId","in":"path","description":"The unique identifier of the repudiation.","required":true,"schema":{"type":"string"}},{"name":"Status","in":"query","description":"**Allowed values:** `CREATED`, `SUCCEEDED`, `FAILED`\n\nThe status of the transaction. You can filter on multiple values by separating them with a comma.","required":false,"schema":{"type":"string"}},{"name":"ResultCode","in":"query","description":"The code indicating the result of the operation. You can filter on multiple values by separating them with a comma.","required":false,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListRefundsForARepudiationResponse"}}}}}}},"/v2.01/{ClientId}/disputes/{DisputeId}":{"get":{"operationId":"view_dispute","summary":"View a Dispute","description":"View a Dispute","tags":["Disputes"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"DisputeId","in":"path","description":"The unique identifier of the dispute.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DisputeResponse"}}}}}},"put":{"operationId":"update_dispute","summary":"Update a Dispute","description":"Update a Dispute","tags":["Disputes"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"DisputeId","in":"path","description":"The unique identifier of the dispute.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DisputeResponse"}}}}}}},"/v2.01/{ClientId}/disputes/{DisputeId}/submit":{"put":{"operationId":"submit_dispute","summary":"Submit a Dispute","description":"Submit a Dispute\n\nThis call is used both for the initial submission of the dispute and any resubmission made afterwards (in case more documents are required for instance).","tags":["Disputes"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"DisputeId","in":"path","description":"The unique identifier of the dispute.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DisputeResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitADisputeRequest"}}}}}},"/v2.01/{ClientId}/disputes/{DisputeId}/close":{"put":{"operationId":"close_dispute","summary":"Close a Dispute","description":"<Note icon=\"fa-regular fa-circle-info\"> \n**Note – Empty body required** \n\nFor the call to be successful, you need to pass an empty body.  \n</Note>\n\nClose a Dispute","tags":["Disputes"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"DisputeId","in":"path","description":"The unique identifier of the dispute.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DisputeResponse"}}}}}}},"/v2.01/{ClientId}/disputes":{"get":{"operationId":"list_disputes","summary":"List all Disputes","description":"List all Disputes","tags":["Disputes"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"BeforeDate","in":"query","description":"The date before which the object was created (based on the object's `CreationDate` parameter). You can filter on a specific time range by using both the `AfterDate` and `BeforeDate` query parameters.","required":false,"schema":{"type":"integer"}},{"name":"AfterDate","in":"query","description":"The date after which the object was created (based on the object's `CreationDate` parameter). You can filter on a specific time range by using both the `AfterDate` and `BeforeDate` query parameters.","required":false,"schema":{"type":"integer"}},{"name":"Status","in":"query","description":"**Allowed values:** `CREATED`, `PENDING_CLIENT_ACTION`, `SUBMITTED`, `PENDING_BANK_ACTION`, `CLOSED`, `REOPENED_PENDING_CLIENT_ACTION`\n\nThe status of the Dispute. You can filter on multiple values by separating them with a comma.","required":false,"schema":{"type":"string"}},{"name":"DisputeType","in":"query","description":"**Allowed values:** `CONTESTABLE`, `NOT_CONTESTABLE`, `RETRIEVAL`\n\nThe type of the Dispute. You can filter on multiple values by separating them with a comma.","required":false,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListAllDisputesResponse"}}}}}}},"/v2.01/{ClientId}/disputes/pendingsettlement":{"get":{"operationId":"list_disputes_settlement","summary":"List Disputes pending settlement","description":"List Disputes pending settlement\n\nThis call lists all the disputes for which you need to make a settlement transfer.","tags":["Disputes"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListAllDisputesResponse"}}}}}}},"/v2.01/{ClientId}/payins/{PayInId}/disputes":{"get":{"operationId":"list_disputes_payin","summary":"List Disputes for a PayIn","description":"List Disputes for a PayIn","tags":["Disputes"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"PayInId","in":"path","description":"The unique identifier of the pay-in.","required":true,"schema":{"type":"string"}},{"name":"BeforeDate","in":"query","description":"The date before which the object was created (based on the object's `CreationDate` parameter). You can filter on a specific time range by using both the `AfterDate` and `BeforeDate` query parameters.","required":false,"schema":{"type":"integer"}},{"name":"AfterDate","in":"query","description":"The date after which the object was created (based on the object's `CreationDate` parameter). You can filter on a specific time range by using both the `AfterDate` and `BeforeDate` query parameters.","required":false,"schema":{"type":"integer"}},{"name":"Status","in":"query","description":"**Allowed values:** `CREATED`, `PENDING_CLIENT_ACTION`, `SUBMITTED`, `PENDING_BANK_ACTION`, `CLOSED`, `REOPENED_PENDING_CLIENT_ACTION`\n\nThe status of the Dispute. You can filter on multiple values by separating them with a comma.","required":false,"schema":{"type":"string"}},{"name":"DisputeType","in":"query","description":"**Allowed values:** `CONTESTABLE`, `NOT_CONTESTABLE`, `RETRIEVAL`\n\nThe type of the Dispute. You can filter on multiple values by separating them with a comma.","required":false,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListAllDisputesResponse"}}}}}}},"/v2.01/{ClientId}/users/{UserId}/disputes":{"get":{"operationId":"list_disputes_user","summary":"List Disputes for a User","description":"List Disputes for a User","tags":["Disputes"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"UserId","in":"path","description":"The unique identifier of the user.","required":true,"schema":{"type":"string"}},{"name":"BeforeDate","in":"query","description":"The date before which the object was created (based on the object's `CreationDate` parameter). You can filter on a specific time range by using both the `AfterDate` and `BeforeDate` query parameters.","required":false,"schema":{"type":"integer"}},{"name":"AfterDate","in":"query","description":"The date after which the object was created (based on the object's `CreationDate` parameter). You can filter on a specific time range by using both the `AfterDate` and `BeforeDate` query parameters.","required":false,"schema":{"type":"integer"}},{"name":"Status","in":"query","description":"**Allowed values:** `CREATED`, `PENDING_CLIENT_ACTION`, `SUBMITTED`, `PENDING_BANK_ACTION`, `CLOSED`, `REOPENED_PENDING_CLIENT_ACTION`\n\nThe status of the Dispute. You can filter on multiple values by separating them with a comma.","required":false,"schema":{"type":"string"}},{"name":"DisputeType","in":"query","description":"**Allowed values:** `CONTESTABLE`, `NOT_CONTESTABLE`, `RETRIEVAL`\n\nThe type of the Dispute. You can filter on multiple values by separating them with a comma.","required":false,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListAllDisputesResponse"}}}}}}},"/v2.01/{ClientId}/wallets/{WalletId}/disputes":{"get":{"operationId":"list_disputes_wallet","summary":"List Disputes for a Wallet","description":"List Disputes for a Wallet","tags":["Disputes"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"WalletId","in":"path","description":"The unique identifier of the wallet.","required":true,"schema":{"type":"string"}},{"name":"BeforeDate","in":"query","description":"The date before which the object was created (based on the object's `CreationDate` parameter). You can filter on a specific time range by using both the `AfterDate` and `BeforeDate` query parameters.","required":false,"schema":{"type":"integer"}},{"name":"AfterDate","in":"query","description":"The date after which the object was created (based on the object's `CreationDate` parameter). You can filter on a specific time range by using both the `AfterDate` and `BeforeDate` query parameters.","required":false,"schema":{"type":"integer"}},{"name":"Status","in":"query","description":"**Allowed values:** `CREATED`, `PENDING_CLIENT_ACTION`, `SUBMITTED`, `PENDING_BANK_ACTION`, `CLOSED`, `REOPENED_PENDING_CLIENT_ACTION`\n\nThe status of the Dispute. You can filter on multiple values by separating them with a comma.","required":false,"schema":{"type":"string"}},{"name":"DisputeType","in":"query","description":"**Allowed values:** `CONTESTABLE`, `NOT_CONTESTABLE`, `RETRIEVAL`\n\nThe type of the Dispute. You can filter on multiple values by separating them with a comma.","required":false,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListAllDisputesResponse"}}}}}}},"/v2.01/{ClientId}/disputes/{DisputeId}/documents":{"post":{"operationId":"create_dispute_document","summary":"Create a Dispute Document","description":"Create a Dispute Document","tags":["disputeDocuments"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"DisputeId","in":"path","description":"The unique identifier of the dispute.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DisputeDocumentResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateADisputeDocumentRequest"}}}}},"get":{"operationId":"list_documents_dispute","summary":"List Documents for a Dispute","description":"List Documents for a Dispute","tags":["disputeDocuments"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"DisputeId","in":"path","description":"The unique identifier of the dispute.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListAllDisputeDocumentsResponse"}}}}}}},"/v2.01/{ClientId}/dispute-documents/{DisputeDocumentId}":{"get":{"operationId":"view_dispute_document","summary":"View a Dispute Document","description":"View a Dispute Document","tags":["disputeDocuments"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"DisputeDocumentId","in":"path","description":"The unique identifier of the dispute document.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DisputeDocumentResponse"}}}}}}},"/v2.01/{ClientId}/disputes/{DisputeId}/documents/{DisputeDocumentId}":{"put":{"operationId":"submit_dispute_document","summary":"Submit a Dispute Document","description":"Submit a Dispute Document","tags":["disputeDocuments"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"DisputeId","in":"path","description":"The unique identifier of the dispute.","required":true,"schema":{"type":"string"}},{"name":"DisputeDocumentId","in":"path","description":"The unique identifier of the dispute document.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DisputeDocumentResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitADisputeDocumentRequest"}}}}}},"/v2.01/{ClientId}/dispute-documents":{"get":{"operationId":"list_dispute_documents","summary":"List all Dispute Documents","description":"List all Dispute Documents","tags":["disputeDocuments"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"BeforeDate","in":"query","description":"The date before which the object was created (based on the object's `CreationDate` parameter). You can filter on a specific time range by using both the `AfterDate` and `BeforeDate` query parameters.","required":false,"schema":{"type":"integer"}},{"name":"AfterDate","in":"query","description":"The date after which the object was created (based on the object's `CreationDate` parameter). You can filter on a specific time range by using both the `AfterDate` and `BeforeDate` query parameters.","required":false,"schema":{"type":"integer"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListAllDisputeDocumentsResponse"}}}}}}},"/v2.01/{ClientId}/disputes/{DisputeId}/documents/{DisputeDocumentId}/pages":{"post":{"operationId":"create_dispute_document_page","summary":"Create a Dispute Document Page","description":"Create a file attached to the Dispute Document for Mangopay's team to review. You can have as many Dispute Document Pages as there are actual pages of the document you send.\n\nIn order to be able to create a document page:  \n- The corresponding Dispute Document `Status` must be `CREATED`  \n- The `File` must be a base64 encoded file and have a maximum size of 10MB","tags":["disputeDocuments"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"DisputeId","in":"path","description":"The unique identifier of the dispute.","required":true,"schema":{"type":"string"}},{"name":"DisputeDocumentId","in":"path","description":"The unique identifier of the dispute document.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/disputeDocuments_create_dispute_document_page_Response_200"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UploadAClientLogoRequest"}}}}}},"/v2.01/{ClientId}/dispute-documents/{DisputeDocumentId}/consult":{"post":{"operationId":"create_weblink_to_view_dispute_document_pages","summary":"Create a weblink to view the Pages of a Dispute Document","description":"Create a weblink to view the Pages of a Dispute Document\n\nThis call returns one link per document page in order to consult them. These links are available for 10 minutes.","tags":["disputeDocuments"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"DisputeDocumentId","in":"path","description":"The unique identifier of the dispute document.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DisputeDocumentWeblinkResponse"}}}}}}},"/v2.01/{ClientId}/repudiations/{RepudiationId}":{"get":{"operationId":"view_repudiation","summary":"View a Repudiation","description":"View a Repudiation","tags":["Repudiations"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"RepudiationId","in":"path","description":"The unique identifier of the repudiation.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RepudiationResponse"}}}}}}},"/v2.01/{ClientId}/repudiations/{RepudiationId}/settlementtransfer":{"post":{"operationId":"create_settlement_transfer","summary":"Create a Settlement Transfer","description":"Create a Settlement Transfer","tags":["disputeSettlement"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"RepudiationId","in":"path","description":"The unique identifier of the repudiation.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SettlementTransferResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateASettlementTransferRequest"}}}}}},"/v2.01/{ClientId}/settlements/{SettlementId}":{"get":{"operationId":"view_settlement_transfer","summary":"View a Settlement Transfer","description":"<Note icon=\"fa-regular fa-circle-info\">\n**Note – Settlement transfer data retained for 13 months**\n\nAn API call to retrieve a settlement transfer whose `CreationDate` is older than 13 months may return 404 Not Found.\n\nFor more information, see the <a href=\"/api-reference/overview/data-availability-periods\">Data availability periods</a> article.\n</Note>\n\nView a Settlement Transfer","tags":["disputeSettlement"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"SettlementId","in":"path","description":"The unique identifier of the settlement transfer.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SettlementTransferResponse"}}}}}}},"/v2.01/{ClientId}/clients/payins/bankwire/direct":{"post":{"operationId":"create_bank_wire_payin_to_repudiation_wallet","summary":"Create a Bank Wire PayIn to the Repudiation Wallet","description":"<Warning icon=\"fa-regular fa-triangle-exclamation\">   \n**Warning – Ensure you use the correct reference and bank account** \n\nThe direct bank wire relies on independent action from the platform. You must use the `WireReference` and wire the funds to the bank account identified by the `IBAN` and `BIC`.  \nOtherwise, the crediting of your Repudiation Wallet may be delayed or unsuccessful.  \n</Warning>\n\nCreate a Bank Wire PayIn to the Repudiation Wallet\n\nThis endpoint allows the platform to make a Direct Bank Wire PayIn, instead of a Settlement Transfer, to their Repudiation Wallet in order to settle the negative balance due to a `LOST` dispute.  \n\nThe object expires 1 month after creation if no funds are received.","tags":["disputeSettlement"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateABankWirePayInToTheRepudiationWalletResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateABankWirePayInToTheRepudiationWalletRequest"}}}}}},"/v2.01/{ClientId}/recipients/schema":{"get":{"operationId":"view_recipient_schema","summary":"View the schema for a Recipient","description":"Fetch the data requirements for a given currency, payout method type, and recipient type","tags":["Recipients"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"PayoutMethodType","in":"query","description":"**Allowed values:** `LocalBankTransfer`, `InternationalBankTransfer`\n\nThe payout method.","required":true,"schema":{"type":"string"}},{"name":"Currency","in":"query","description":"**Allowed values:** The three-letter <a href=\"/api-reference/overview/data-formats\" target=\"_blank\">ISO 4217 code</a> of a <a href=\"/guides/currencies\" target=\"_blank\">supported currency</a>: `AED`, `AUD`, `CAD`, `CHF`, `CNH`, `CZK`, `DKK`, `EUR`, `GBP`, `HKD`, `HUF`, `ILS`, `JPY`, `MXN`, `NOK`, `NZD`, `PLN`, `RON`, `SAR`, `SEK`, `SGD`, `TRY`, `USD`, `ZAR`\n\nThe currency of the recipient.","required":true,"schema":{"type":"string"}},{"name":"Country","in":"query","description":"Format: Two-letter country code ([ISO 3166-1 alpha-2 format](/api-reference/overview/data-formats))\n\nThe destination country of the payout method.","required":true,"schema":{"type":"string"}},{"name":"RecipientType","in":"query","description":"**Allowed values:** `Individual`, `Business`\n\nThe recipient type:\n- `Individual` – An account held by a natural person\n- `Business` – An account held by a legal entity","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ViewTheSchemaForARecipientResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v2.01/{ClientId}/users/{UserId}/recipients/validate":{"post":{"operationId":"validate_recipient_data","summary":"Validate data for a Recipient","description":"Check that the user's Recipient data is valid before creation\n\nA 200 HTTP response code indicates the request is valid against the schema. No response body is returned.","tags":["Recipients"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"UserId","in":"path","description":"The unique identifier of the user.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/recipients_validate_recipient_data_Response_200"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidateDataForARecipientRequest"}}}}}},"/v2.01/{ClientId}/users/{UserId}/recipients":{"post":{"operationId":"create_recipient","summary":"Create a Recipient","description":"Register a bank account for local or international payouts.\n\n<Warning icon=\"fa-regular fa-triangle-exclamation\">\n**Caution – Fetch schema and validate data before creation**\n\nBefore using this endpoint to register a Recipient for a user, for the given currency, payout method, and recipient type combination, always: \n- Fetch the schema dynamically using [GET View the schema for a Recipient](/api-reference/recipients/view-recipient-schema)\n- Check that the user's data is valid using [POST Validate data for a Recipient](/api-reference/recipients/validate-recipient-data)\n</Warning>\n\n<Note icon=\"fa-regular fa-circle-info\">\n**Note – SCA triggered by this endpoint**\n\nRegistering a bank account as a Recipient always requires the user to [authenticate using SCA](/guides/sca/recipients) on a Mangopay-hosted webpage, unless your platform is using a [proxy and user consent](/guides/sca/proxy-management).\n\nTo let the user complete the SCA session, your platform needs to retrieve the returned `PendingUserAction.RedirectUrl`, add an encoded `returnUrl` query parameter, and redirect the user. Read more about how to redirect them in the [SCA session](/guides/sca/session) guide.\n\nIf SCA is not successfully completed, the Recipient `Status` becomes `CANCELED` and you need to create a new Recipient to try again. \n\nIn Sandbox, you can bypass SCA by including the word `accept` in the `Email` value of the [Natural User](/api-reference/users/natural-user-object-sca) or the `LegalRepresentative.Email` value of the [Legal User](/api-reference/users/legal-user-object-sca) – for example `accept@example.com` or `john.doe+accept@example.com`.\n\n</Note>\n\nRecipient creation is asynchronous, meaning that this endpoint returns the `Status` as `PENDING` regardless of whether SCA is required (when `RecipientScope` is `PAYOUT`) or not. In all cases, your integration should rely on the `RECIPIENT_ACTIVE` [webhook](/webhooks/event-types#recipients) to know when the recipient is `ACTIVE`.\n\nVerification of Payee (VOP) impacts SEPA local schemes, which means Recipients with `Currency` value `EUR` and `PayoutMethodType` value `LocalBankTransfer`. [Read more](/guides/vop/recipients-payouts) **&rarr;**","tags":["Recipients"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"UserId","in":"path","description":"The unique identifier of the user.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecipientResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateARecipientRequest"}}}}},"get":{"operationId":"list_recipients_user","summary":"List Recipients for a User","description":"<Note icon=\"fa-regular fa-circle-info\">\n**Note – Endpoint returns filtered list by default**\n\nBy default, this endpoint returns only recipients with the `RecipientScope` value of `PAYOUT`. Specify `ALL` to retrieve both `PAYIN` and `PAYOUT` recipients, or `PAYIN` to retrieve only pay-in recipients.\n\nBy default, results are sorted by `CreationDate` in descending order.\n</Note>\n\nList recipients created for a UserId","tags":["Recipients"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"UserId","in":"path","description":"The unique identifier of the user.","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start value: `1`\n\n**Default value:** `1`\n\nIndicates the index of the page for the pagination.","required":false,"schema":{"type":"integer"}},{"name":"per_page","in":"query","description":"Min. value: `1`; max. value: `100`\n\n**Default value:** `10`\n\nIndicates the number of items returned for each page of the pagination.","required":false,"schema":{"type":"integer"}},{"name":"Sort","in":"query","description":"**Possible values:** `CreationDate:ASC`, `CreationDate:DESC`\n\n**Default value:** `CreationDate:DESC`\n\nIndicates the direction in which to sort the list.","required":false,"schema":{"type":"string"}},{"name":"RecipientScope","in":"query","description":"**Possible values:** `ALL`, `PAYOUT`, `PAYIN`\n\n**Default value:** `PAYOUT`\n\nBy default, this endpoint returns only recipients with the `RecipientScope` value of `PAYOUT`.\n\nSpecify `ALL` to retrieve both `PAYIN` and `PAYOUT` recipients, or `PAYIN` to retrieve only pay-in recipients.\n\nRead more about [recipient scopes in the guide](/guides/sca/recipients#recipient-scopes).","required":false,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListRecipientsForAUserResponse"}}}}}}},"/v2.01/{ClientId}/recipients/{RecipientId}":{"put":{"operationId":"deactivate_recipient","summary":"Deactivate a Recipient","description":"Permanently disable a Recipient","tags":["Recipients"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"RecipientId","in":"path","description":"The unique identifier of the Recipient or legacy Bank Account (the legacy `BankAccountId` value can be used on this endpoint).","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeactivateARecipientResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeactivateARecipientRequest"}}}}},"get":{"operationId":"view_recipient","summary":"View a Recipient","description":"Fetch a Recipient or legacy Bank Account based on its ID\n\nVerification of Payee (VOP) impacts SEPA local schemes, which means Recipients with `Currency` value `EUR` and `PayoutMethodType` value `LocalBankTransfer`. [Read more](/guides/vop/recipients-payouts) **&rarr;**","tags":["Recipients"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"RecipientId","in":"path","description":"The unique identifier of the Recipient or legacy Bank Account (the legacy `BankAccountId` value can be used on this endpoint).","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecipientResponse"}}}}}}},"/v2.01/{ClientId}/recipients/payout-methods":{"get":{"operationId":"view_payout_methods","summary":"View payout methods","description":"See payout methods available to your platform by currency and country","tags":["Recipients"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"Currency","in":"query","description":"**Possible values:** `AED`, `AUD`, `CAD`, `CHF`, `CNH`, `CZK`, `DKK`, `EUR`, `GBP`, `HKD`, `HUF`, `ILS`, `JPY`, `MXN`, `NOK`, `NZD`, `PLN`, `RON`, `SAR`, `SEK`, `SGD`, `TRY`, `USD`, `ZAR`\n\nThe currency of the payout method.","required":true,"schema":{"type":"string"}},{"name":"Country","in":"query","description":"Format: Two-letter country code ([ISO 3166-1 alpha-2 format](/api-reference/overview/data-formats))\n\nThe destination country of the payout method.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ViewPayoutMethodsResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v2.01/{ClientId}/users/{UserId}/bankaccounts/iban":{"post":{"operationId":"create_iban_bank_account","summary":"Create an IBAN Bank Account","description":"<Warning icon=\"fa-regular fa-triangle-exclamation\">\n**Caution - Payouts refused to Bank Accounts created after April 30, 2026**\n\nBank Account objects created after April 30, 2026, will not be usable for payouts. External accounts must be registered using the [Recipient endpoints](/api-reference/recipients/recipient-object) and authenticated using SCA.\n\nPayouts to Bank Accounts created after May 1, 2026, will fail with the `ResultCode` [121018](/errors/codes/121018). To resolve this, register the external account using [POST Create a Recipient](/api-reference/recipients/create-recipient) and retry the payout.\n</Warning>\n\n<Note icon=\"fa-regular fa-circle-info\">\n**Note – Replaced by Recipients feature**\n\nThe Bank Account object and endpoints have been replaced by the Recipients feature, which all platforms should integrate instead.\n\nLegacy active Bank Accounts (`Active` is `true`) have been migrated to the new feature and their data is retrievable via the [GET View a Recipient](/api-reference/recipients/view-recipient) endpoint using the same `BankAccountId`. Read more about [legacy bank account migration](/guides/payouts#migration-of-legacy-bank-accounts).\n</Note>\n\n<Note icon=\"fa-regular fa-circle-info\"> \n**Note – Only for countries that use IBAN** \n\nOnly use the IBAN type for accounts registered in countries that use IBAN and aren't GB, US, or CA (for which you should use the dedicated type).   \n</Note>\n\nCreate an IBAN Bank Account","tags":["bankAccounts"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"UserId","in":"path","description":"The unique identifier of the User (natural or legal) who owns the bank account.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IBANBankAccountResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAnIBANBankAccountRequest"}}}}}},"/v2.01/{ClientId}/users/{UserId}/bankaccounts/us":{"post":{"operationId":"create_us_bank_account","summary":"Create a US Bank Account","description":"<Warning icon=\"fa-regular fa-triangle-exclamation\">\n**Caution - Payouts refused to Bank Accounts created after April 30, 2026**\n\nBank Account objects created after April 30, 2026, will not be usable for payouts. External accounts must be registered using the [Recipient endpoints](/api-reference/recipients/recipient-object) and authenticated using SCA.\n\nPayouts to Bank Accounts created after May 1, 2026, will fail with the `ResultCode` [121018](/errors/codes/121018). To resolve this, register the external account using [POST Create a Recipient](/api-reference/recipients/create-recipient) and retry the payout.\n</Warning>\n\n<Note icon=\"fa-regular fa-circle-info\">\n**Note – Replaced by Recipients feature**\n\nThe Bank Account object and endpoints have been replaced by the Recipients feature, which all platforms should integrate instead.\n\nLegacy active Bank Accounts (`Active` is `true`) have been migrated to the new feature and their data is retrievable via the [GET View a Recipient](/api-reference/recipients/view-recipient) endpoint using the same `BankAccountId`. Read more about [legacy bank account migration](/guides/payouts#migration-of-legacy-bank-accounts).\n</Note>\n\nCreate a US Bank Account","tags":["bankAccounts"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"UserId","in":"path","description":"The unique identifier of the User (natural or legal) who owns the bank account.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAUSBankAccountResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAUSBankAccountRequest"}}}}}},"/v2.01/{ClientId}/users/{UserId}/bankaccounts/ca":{"post":{"operationId":"create_ca_bank_account","summary":"Create a CA Bank Account","description":"<Warning icon=\"fa-regular fa-triangle-exclamation\">\n**Caution - Payouts refused to Bank Accounts created after April 30, 2026**\n\nBank Account objects created after April 30, 2026, will not be usable for payouts. External accounts must be registered using the [Recipient endpoints](/api-reference/recipients/recipient-object) and authenticated using SCA.\n\nPayouts to Bank Accounts created after May 1, 2026, will fail with the `ResultCode` [121018](/errors/codes/121018). To resolve this, register the external account using [POST Create a Recipient](/api-reference/recipients/create-recipient) and retry the payout.\n</Warning>\n\n<Note icon=\"fa-regular fa-circle-info\">\n**Note – Replaced by Recipients feature**\n\nThe Bank Account object and endpoints have been replaced by the Recipients feature, which all platforms should integrate instead.\n\nLegacy active Bank Accounts (`Active` is `true`) have been migrated to the new feature and their data is retrievable via the [GET View a Recipient](/api-reference/recipients/view-recipient) endpoint using the same `BankAccountId`. Read more about [legacy bank account migration](/guides/payouts#migration-of-legacy-bank-accounts).\n</Note>\n\nCreate a CA Bank Account","tags":["bankAccounts"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"UserId","in":"path","description":"The unique identifier of the User (natural or legal) who owns the bank account.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateACABankAccountResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateACABankAccountRequest"}}}}}},"/v2.01/{ClientId}/users/{UserId}/bankaccounts/gb":{"post":{"operationId":"create_gb_bank_account","summary":"Create a GB Bank Account","description":"<Warning icon=\"fa-regular fa-triangle-exclamation\">\n**Caution - Payouts refused to Bank Accounts created after April 30, 2026**\n\nBank Account objects created after April 30, 2026, will not be usable for payouts. External accounts must be registered using the [Recipient endpoints](/api-reference/recipients/recipient-object) and authenticated using SCA.\n\nPayouts to Bank Accounts created after May 1, 2026, will fail with the `ResultCode` [121018](/errors/codes/121018). To resolve this, register the external account using [POST Create a Recipient](/api-reference/recipients/create-recipient) and retry the payout.\n</Warning>\n\n<Note icon=\"fa-regular fa-circle-info\">\n**Note – Replaced by Recipients feature**\n\nThe Bank Account object and endpoints have been replaced by the Recipients feature, which all platforms should integrate instead.\n\nLegacy active Bank Accounts (`Active` is `true`) have been migrated to the new feature and their data is retrievable via the [GET View a Recipient](/api-reference/recipients/view-recipient) endpoint using the same `BankAccountId`. Read more about [legacy bank account migration](/guides/payouts#migration-of-legacy-bank-accounts).\n</Note>\n\nCreate a GB Bank Account","tags":["bankAccounts"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"UserId","in":"path","description":"The unique identifier of the User (natural or legal) who owns the bank account.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAGBBankAccountResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAGBBankAccountRequest"}}}}}},"/v2.01/{ClientId}/users/{UserId}/bankaccounts/other":{"post":{"operationId":"create_other_bank_account","summary":"Create an OTHER Bank Account","description":"<Warning icon=\"fa-regular fa-triangle-exclamation\">\n**Caution - Payouts refused to Bank Accounts created after April 30, 2026**\n\nBank Account objects created after April 30, 2026, will not be usable for payouts. External accounts must be registered using the [Recipient endpoints](/api-reference/recipients/recipient-object) and authenticated using SCA.\n\nPayouts to Bank Accounts created after May 1, 2026, will fail with the `ResultCode` [121018](/errors/codes/121018). To resolve this, register the external account using [POST Create a Recipient](/api-reference/recipients/create-recipient) and retry the payout.\n</Warning>\n\n<Note icon=\"fa-regular fa-circle-info\">\n**Note – Replaced by Recipients feature**\n\nThe Bank Account object and endpoints have been replaced by the Recipients feature, which all platforms should integrate instead.\n\nLegacy active Bank Accounts (`Active` is `true`) have been migrated to the new feature and their data is retrievable via the [GET View a Recipient](/api-reference/recipients/view-recipient) endpoint using the same `BankAccountId`. Read more about [legacy bank account migration](/guides/payouts#migration-of-legacy-bank-accounts).\n</Note>\n\n<Note icon=\"fa-regular fa-circle-info\"> \n**Note – Only for countries that don't use IBAN** \n\nOnly use the OTHER type if the account is registered in a country that doesn't use IBAN and isn't GB, US, or CA (for which you should use the dedicated type).  \n</Note>\n\n<Note icon=\"fa-regular fa-circle-info\"> \n**Note – Additional information may be required** \n\nOTHER-type bank accounts may require additional information depending on the country. Additional precisions per country (if applicable), are given below.  \n\nFor accounts registered in:   \n* Australia – Provide the BIC in the `BIC` field. In the `IBAN` field, combine the 6-digit Bank State Branch (BSB) number and the account number.\n</Note>\n\nCreate an OTHER Bank Account","tags":["bankAccounts"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"UserId","in":"path","description":"The unique identifier of the User (natural or legal) who owns the bank account.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAnOTHERBankAccountResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAnOTHERBankAccountRequest"}}}}}},"/v2.01/{ClientId}/users/{UserId}/bankaccounts/{BankAccountId}":{"put":{"operationId":"deactivate_bank_account","summary":"Deactivate a Bank Account","description":"<Warning icon=\"fa-regular fa-triangle-exclamation\">\n**Caution - Payouts refused to Bank Accounts created after April 30, 2026**\n\nBank Account objects created after April 30, 2026, will not be usable for payouts. External accounts must be registered using the [Recipient endpoints](/api-reference/recipients/recipient-object) and authenticated using SCA.\n\nPayouts to Bank Accounts created after May 1, 2026, will fail with the `ResultCode` [121018](/errors/codes/121018). To resolve this, register the external account using [POST Create a Recipient](/api-reference/recipients/create-recipient) and retry the payout.\n</Warning>\n\n<Note icon=\"fa-regular fa-circle-info\">\n**Note – Replaced by Recipients feature**\n\nThe Bank Account object and endpoints have been replaced by the Recipients feature, which all platforms should integrate instead.\n\nLegacy active Bank Accounts (`Active` is `true`) have been migrated to the new feature and their data is retrievable via the [GET View a Recipient](/api-reference/recipients/view-recipient) endpoint using the same `BankAccountId`. Read more about [legacy bank account migration](/guides/payouts#migration-of-legacy-bank-accounts).\n</Note>\n\nDeactivate a Bank Account","tags":["bankAccounts"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"UserId","in":"path","description":"The unique identifier of the User (natural or legal) who owns the bank account.","required":true,"schema":{"type":"string"}},{"name":"BankAccountId","in":"path","description":"The unique identifier of the bank account.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IBANBankAccountResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeactivateABankingAliasRequest"}}}}},"get":{"operationId":"view_bank_account","summary":"View a Bank Account","description":"<Warning icon=\"fa-regular fa-triangle-exclamation\">\n**Caution - Payouts refused to Bank Accounts created after April 30, 2026**\n\nBank Account objects created after April 30, 2026, will not be usable for payouts. External accounts must be registered using the [Recipient endpoints](/api-reference/recipients/recipient-object) and authenticated using SCA.\n\nPayouts to Bank Accounts created after May 1, 2026, will fail with the `ResultCode` [121018](/errors/codes/121018). To resolve this, register the external account using [POST Create a Recipient](/api-reference/recipients/create-recipient) and retry the payout.\n</Warning>\n\n<Note icon=\"fa-regular fa-circle-info\">\n**Note – Replaced by Recipients feature**\n\nThe Bank Account object and endpoints have been replaced by the Recipients feature, which all platforms should integrate instead.\n\nLegacy active Bank Accounts (`Active` is `true`) have been migrated to the new feature and their data is retrievable via the [GET View a Recipient](/api-reference/recipients/view-recipient) endpoint using the same `BankAccountId`. Read more about [legacy bank account migration](/guides/payouts#migration-of-legacy-bank-accounts).\n</Note>\n\nView a Bank Account","tags":["bankAccounts"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"UserId","in":"path","required":true,"schema":{"type":"string"}},{"name":"BankAccountId","in":"path","description":"The unique identifier of the bank account.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ViewABankAccountResponse"}}}}}}},"/v2.01/{ClientId}/users/{UserId}/bankaccounts":{"get":{"operationId":"list_bank_accounts_user","summary":"List Bank Accounts for a User","description":"<Warning icon=\"fa-regular fa-triangle-exclamation\">\n**Caution - Payouts refused to Bank Accounts created after April 30, 2026**\n\nBank Account objects created after April 30, 2026, will not be usable for payouts. External accounts must be registered using the [Recipient endpoints](/api-reference/recipients/recipient-object) and authenticated using SCA.\n\nPayouts to Bank Accounts created after May 1, 2026, will fail with the `ResultCode` [121018](/errors/codes/121018). To resolve this, register the external account using [POST Create a Recipient](/api-reference/recipients/create-recipient) and retry the payout.\n</Warning>\n\n<Note icon=\"fa-regular fa-circle-info\">\n**Note – Replaced by Recipients feature**\n\nThe Bank Account object and endpoints have been replaced by the Recipients feature, which all platforms should integrate instead.\n\nLegacy active Bank Accounts (`Active` is `true`) have been migrated to the new feature and their data is retrievable via the [GET View a Recipient](/api-reference/recipients/view-recipient) endpoint using the same `BankAccountId`. Read more about [legacy bank account migration](/guides/payouts#migration-of-legacy-bank-accounts).\n</Note>\n\n<Note icon=\"fa-regular fa-circle-info\"> \n**Note** \n\nThe returned parameters may vary depending on the encountered bank account types.  \n</Note>\n\nList Bank Accounts for a User","tags":["bankAccounts"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"UserId","in":"path","description":"The unique identifier of the User (natural or legal) who owns the bank account.","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start value: `1`\n\n**Default value:** `1`\n\nIndicates the index of the page for the pagination.","required":false,"schema":{"type":"integer"}},{"name":"per_page","in":"query","description":"Min. value: `1`; max. value: `100`\n\n**Default value:** `10`\n\nIndicates the number of items returned for each page of the pagination.","required":false,"schema":{"type":"integer"}},{"name":"Sort","in":"query","description":"**Possible values:** `CreationDate:ASC`, `CreationDate:DESC`\n\n**Default value:** `CreationDate:ASC`\n\nIndicates the direction in which to sort the list.","required":false,"schema":{"type":"string"}},{"name":"Active","in":"query","description":"Whether or not the Bank Account is active. Mangopay automatically sets this parameter to `false` if the bank account is closed or does not exist anymore.","required":true,"schema":{"type":"boolean"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListBankAccountsForAUserResponse"}}}}}}},"/v2.01/{ClientId}/payouts/bankwire":{"post":{"operationId":"create_payout","summary":"Create a Payout","description":"Initiate a payout request from a user's wallet to a Recipient\n\n<Note icon=\"fa-regular fa-circle-info\">\n**Note – Local Recipients can only receive local currencies**\n\nAttempting a payout to a newly created local Recipient (with the `PayoutMethodType` of `LocalBankTransfer`) in a non-local currency may return an HTTP 400 error because the Recipient's Country doesn't correspond to the currency sent (for example, a USD payout sent to local SEPA Recipient).\n\nTo receive non-local currencies, create a new Recipient with `PayoutMethodType` of `InternationalBankTransfer` and retry the payout. Mangopay automatically optimizes the payout route, so if a local currency is sent to an international Recipient, the domestic rail is used.\n\nRead more about [how Mangopay routes funds](/guides/payouts#how-mangopay-routes-funds) **→**\n</Note>\n\n<Note icon=\"fa-regular fa-circle-info\">\n**Note – `PayoutModeRequested` property only relevant for EUR**\n\nThe `PayoutModeRequested` property is only relevant for EUR payouts, where the value determines which of the SEPA schemes (SCT, SCT Inst, or T2) is used.\n\nFor other currencies, Mangopay automatically uses the relevant local scheme (e.g. FPS for GBP) if the Recipient's destination country corresponds, or otherwise uses SWIFT. [Read more](/guides/payouts#how-mangopay-routes-funds) **&rarr;**\n</Note>\n\nIf your platform offers User-Owned Accounts (Virtual Account or Banking Alias) to your end users, Verification of Payee (VOP) may impact their payouts. There is no impact for platforms not offering User-Owned Accounts. [Read more](/guides/vop) **&rarr;**","tags":["Payouts"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePayoutResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAPayoutRequest"}}}}}},"/v2.01/{ClientId}/payouts/bankwire/{PayoutId}":{"get":{"operationId":"view_payout_check_mode_applied","summary":"View a Payout and check mode applied","description":"Retrieve the full details of a payout request. First-time integrators should used this endpoint.\n\nIn addition to the data returned by the legacy [GET View a Payout](/api-reference/payouts/view-payout) endpoint, this endpoint also returns information about:\n- `ModeApplied` – Relevant for platforms using [SEPA Inst](/guides/payouts/integration#initiate-an-sct-inst-payout) or [RTGS for SEPA T2](/guides/payouts#real-time-gross-settlement-rtgs)\n- `ModeRequested` and `FallbackReason` – Additionally relevant for platforms using [SEPA Inst](/guides/payouts/integration#initiate-an-sct-inst-payout)\n- `ChargeBearer` – Relevant for platforms using [OUR fee allocation](/guides/payouts#fees-for-international-payouts) on SWIFT non-domestic payouts\n\n<Note icon=\"fa-regular fa-circle-info\">\n**Note – Payout data retained for 13 months**\n\nAn API call to retrieve a payout whose `CreationDate` is older than 13 months may return 404 Not Found.\n\nFor more information, see the <a href=\"/api-reference/overview/data-availability-periods\">Data availability periods</a> article.\n</Note>","tags":["Payouts"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"PayoutId","in":"path","description":"The unique identifier of the payout.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayoutWithModeAppliedResponse"}}}}}}},"/v2.01/{ClientId}/payouts/{PayoutId}":{"get":{"operationId":"view_payout","summary":"View a Payout","description":"This endpoint returns basic information about a payout request, without some feature-specific details. Platforms integrating for the first time should use the [GET View a Payout and check mode applied](/api-reference/payouts/view-payout-check-mode-applied) endpoint.\n\n<Note icon=\"fa-regular fa-circle-info\">\n**Note – Payout data retained for 13 months**\n\nAn API call to retrieve a payout whose `CreationDate` is older than 13 months may return 404 Not Found.\n\nFor more information, see the <a href=\"/api-reference/overview/data-availability-periods\">Data availability periods</a> article.\n</Note>","tags":["Payouts"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"PayoutId","in":"path","description":"The unique identifier of the payout.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayoutWithoutModeAppliedResponse"}}}}}}},"/v2.01/{ClientId}/payouts/reachability":{"post":{"operationId":"check_instant_payout_eligibility","summary":"Check Instant Payout eligibility","description":"Check whether the destination bank is reachable for SCT Inst payouts.\n\n<Note icon=\"fa-regular fa-circle-info\">\n**Note – Endpoint only available for SCT Inst payouts in EUR**\n\nYou can only use this endpoint to check payouts where:\n- The currency is `EUR`\n- The `PayoutModeRequested` is `INSTANT_PAYMENT`\n\nAll other currencies return the [130001](/errors/codes/130001) `UnreachableReason.Code`.\n</Note>","tags":["Payouts"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InstantPayoutEligibilityResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckInstantPayoutEligibilityRequest"}}}}}},"/v2.01/{ClientId}/conversions/rate/{DebitedCurrency}/{CreditedCurrency}":{"get":{"operationId":"view_conversion_rate","summary":"View an indicative Conversion Rate","description":"<Note icon=\"fa-regular fa-circle-info\"> \n**Note – Rate is not guaranteed** \n\nThe rate returned by the API is indicative of the rate offered by Mangopay, but it is not a guaranteed rate. For quoted conversions, the rate is guaranteed by the quote. For instant conversions, the rate is displayed in the response.\n</Note>\n\nView an indicative Conversion Rate\n\nLearn more about FX **&rarr;**","tags":["conversionRates"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"DebitedCurrency","in":"path","description":"**Allowed values:** The three-letter <a href=\"/api-reference/overview/data-formats\" target=\"_blank\">ISO 4217 code</a> (EUR, GBP, etc.) of a <a href=\"/guides/currencies\" target=\"_blank\">supported currency</a> (depends on feature, contract, and activation settings).\n\nThe sell currency (the currency of the debited wallet during a conversion).","required":true,"schema":{"type":"string"}},{"name":"CreditedCurrency","in":"path","description":"**Allowed values:** The three-letter <a href=\"/api-reference/overview/data-formats\" target=\"_blank\">ISO 4217 code</a> (EUR, GBP, etc.) of a <a href=\"/guides/currencies\" target=\"_blank\">supported currency</a> (depends on feature, contract, and activation settings).\n\nThe buy currency (the currency of the credited wallet during a conversion).","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ViewAnIndicativeConversionRateResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v2.01/{ClientId}/conversions/quote":{"post":{"operationId":"create_quote","summary":"Create a Quote","description":"This call guarantees a conversion rate for a quoted conversion.\n\nIf the quote is for a client wallet conversion then the quote:\n- Can't include `Fees` – the conversion attempt will return a 400 error if its `QuoteId` includes fees\n- Shouldn't include `UserMargin` – the conversion attempt will not be blocked but `UserMargin` is disregarded – in the `ConversionRateResponse` (the user's `FinalRate` is the same as the platform's `ClientRate`)","tags":["Quotes"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAQuoteResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAQuoteRequest"}}}}}},"/v2.01/{ClientId}/conversions/quote/{QuoteId}":{"get":{"operationId":"view_quote","summary":"View a Quote","description":"View a Quote","tags":["Quotes"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"QuoteId","in":"path","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ViewAQuoteResponse"}}}}}}},"/v2.01/{ClientId}/conversions/quoted-conversion":{"post":{"operationId":"create_quoted_conversion_user_wallets","summary":"Create a Quoted Conversion between user Wallets","description":"This call triggers a conversion at the rate defined in its quote. The debited funds (sell currency), credited funds (buy currency), and amounts are defined in the quote.\n\nEach quoted conversion requires a dedicated [Quote](/api-reference/quotes/quote-object) object, linked in the `QuoteId`.","tags":["Conversions"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAQuotedConversionBetweenUserWalletsResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAQuotedConversionBetweenUserWalletsRequest"}}}}}},"/v2.01/{ClientId}/conversions/instant-conversion":{"post":{"operationId":"create_instant_conversion_user_wallets","summary":"Create an Instant Conversion between user Wallets","description":"This call triggers an immediate conversion at the market rate, of the debited funds to the credited wallet at the market rate. A quote is not required for an instant conversion.","tags":["Conversions"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAnInstantConversionBetweenUserWalletsResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAnInstantConversionBetweenUserWalletsRequest"}}}}}},"/v2.01/{ClientId}/clients/conversions/quoted-conversion":{"post":{"operationId":"create_quoted_conversion_client_wallets","summary":"Create a Quoted Conversion between Client Wallets","description":"This call triggers a conversion at the rate defined in its quote. The debited funds (sell currency), credited funds (buy currency), and amounts are defined in the quote. The [Client Wallets](/api-reference/client-wallets/client-wallet-object) to debit and credit are defined in the conversion.\n\nEach quoted conversion requires a dedicated [Quote](/api-reference/quotes/quote-object) object, linked in the `QuoteId`.\n\nQuoted conversions between client wallets: \n- Can't include `Fees` – the conversion attempt will return a 400 error if its `QuoteId` includes fees\n- Shouldn't include `UserMargin` – the conversion attempt will not be blocked, but `UserMargin` is disregarded – in the `ConversionRateResponse` (the user's `FinalRate` is the same as the platform's `ClientRate`).","tags":["Conversions"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QuotedConversionClientWalletsResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAQuotedConversionBetweenClientWalletsRequest"}}}}}},"/v2.01/{ClientId}/clients/conversions/instant-conversion":{"post":{"operationId":"create_instant_conversion_client_wallets","summary":"Create an Instant Conversion between Client Wallets","description":"This call triggers an immediate conversion at the market rate, of the debited funds to the credited wallet at the market rate. A quote is not required for an instant conversion.\n\nFor conversions between Client Wallets, the `Fees` cannot be specified.","tags":["Conversions"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InstantConversionClientWalletsResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAnInstantConversionBetweenClientWalletsRequest"}}}}}},"/v2.01/{ClientId}/conversions/{ConversionId}":{"get":{"operationId":"view_conversion","summary":"View a Conversion","description":"<Note icon=\"fa-regular fa-circle-info\"> \n**Note – Conversion data retained for 13 months**\n\nAn API call to retrieve a conversion whose `CreationDate` is older than 13 months may return 404 Not Found.\n\nFor more information, see the <a href=\"/api-reference/overview/data-availability-periods\">Data availability periods</a> article.\n</Note>\n\nView a Conversion\n\nAll conversions returned by this endpoint contain the `QuoteId` parameter. For instant conversions, it is `null`.","tags":["Conversions"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"ConversionId","in":"path","description":"The unique identifier of the conversion.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConversionResponse"}}}}}}},"/v2.01/{ClientId}/users/{UserId}/transactions":{"get":{"operationId":"list_transactions_user","summary":"List Transactions for a User","description":"This call returns transactions with the same `AuthorId`.\n\n<Note icon=\"fa-regular fa-circle-info\">\n**Note – ScaContext default value is USER_PRESENT**\n\nOn this endpoint, the default value for `ScaContext` is `USER_PRESENT`. If the `PendingUserAction.RedirectUrl` value is returned, you need to redirect the user to perform SCA.\n\nWith approval from Mangopay, your platform may be able to use the `USER_NOT_PRESENT` value provided you also have a legal proxy in place with the user and the user's consent to access wallet balances and transactions on their behalf (read more about [proxy management](/guides/sca/proxy-management)).\n</Note>\n\n<Note icon=\"fa-regular fa-circle-info\">\n**Note – SCA triggered by this endpoint**\n\nThis endpoint requires the user to [perform SCA to authenticate](/guides/sca/wallets) the access to their wallet, unless SCA for wallet access was successfully completed in the last 180 days (or unless your platform is using a [proxy and user consent](/guides/sca/proxy-management)).\n\nWhen SCA is required, this endpoint returns a **401 - Unauthorized** response (see [errors below](#response.error) for details).\n\nTo let the user complete the SCA session on the Mangopay-hosted webpage, your platform needs to retrieve the `RedirectUrl` from the `WWW-Authenticate` response header, add an encoded `returnUrl` query parameter, and redirect the user. Read more about how to redirect them in the [SCA session](/guides/sca/session) guide.\n\nIn Sandbox, you can bypass SCA by including the word `accept` in the `Email` value of the [Natural User](/api-reference/users/natural-user-object-sca) or the `LegalRepresentative.Email` value of the [Legal User](/api-reference/users/legal-user-object-sca) – for example `accept@example.com` or `john.doe+accept@example.com`.\n</Note>","tags":["Transactions"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"UserId","in":"path","description":"The unique identifier of the user.","required":true,"schema":{"type":"string"}},{"name":"ScaContext","in":"query","description":"**Possible values:** `USER_PRESENT`, `USER_NOT_PRESENT`\n\nThe SCA context of the request, which is **required** if the user's `UserCategory` is `OWNER`:\n- `USER_PRESENT` – The user is taking the SCA-triggering action of accessing their wallet. The platform must [redirect the user](/guides/sca/session) using the `PendingUserAction.RedirectUrl` returned so that the user can complete the SCA session (unless exempted because a successful SCA session for wallet access occurred in the last 180 days, so no redirection link was returned).\n- `USER_NOT_PRESENT` – The platform is taking the action under proxy from the user and the user has previously given consent to Mangopay (via the SCA hosted experience) to allow the action. If the user has not given (or has revoked) their consent, then `USER_NOT_PRESENT` returns a 403 error.\n\nRead more about [managing proxy and user consent](/guides/sca/proxy-management) **&rarr;**\n\n**Note:** For existing platforms, the parameter is technically optional if the User is an `OWNER`, and the default value will become `USER_PRESENT` from **Dec 15, 2025** (Dec 1 in Sandbox)","required":false,"schema":{"type":"string"}},{"name":"Sort","in":"query","description":"**Possible values:** `CreationDate:ASC`, `CreationDate:DESC`\n\n**Default value:** `CreationDate:ASC`\n\nIndicates the direction in which to sort the list.","required":false,"schema":{"type":"string"}},{"name":"per_page","in":"query","description":"Min. value: `1`; max. value: `100`\n\n**Default value:** `10`\n\nIndicates the number of items returned for each page of the pagination.","required":false,"schema":{"type":"integer"}},{"name":"page","in":"query","description":"Start value: `1`\n\n**Default value:** `1`\n\nIndicates the index of the page for the pagination.","required":false,"schema":{"type":"integer"}},{"name":"Status","in":"query","description":"**Allowed values:** `CREATED`, `SUCCEEDED`, `FAILED`\n\nThe status of the transaction. You can filter on multiple values by separating them with a comma.","required":false,"schema":{"type":"string"}},{"name":"ResultCode","in":"query","description":"The code indicating the result of the operation. You can filter on multiple values by separating them with a comma.","required":false,"schema":{"type":"string"}},{"name":"BeforeDate","in":"query","description":"The date before which the transaction was created (based on the transaction's `CreationDate` parameter). You can filter on a specific time range by using both the `AfterDate` and `BeforeDate` query parameters.","required":false,"schema":{"type":"integer"}},{"name":"AfterDate","in":"query","description":"The date after which the transaction was created (based on the transaction's `CreationDate` parameter). You can filter on a specific time range by using both the `AfterDate` and `BeforeDate` query parameters.","required":false,"schema":{"type":"integer"}},{"name":"Type","in":"query","description":"**Allowed values:** `PAYIN`, `TRANSFER`, `CONVERSION`, `PAYOUT`\n\nThe type of the transaction. You can filter on multiple values by separating them with a comma.","required":false,"schema":{"type":"string"}},{"name":"Nature","in":"query","description":"**Allowed values:** `REGULAR`, `REPUDIATION`, `REFUND`, `SETTLEMENT`\n\nThe nature of the transaction, providing more information about the context in which the transaction occurred.","required":false,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListTransactionsResponse"}}}},"401":{"description":"SCA required to retrieve data because no successful SCA session for wallet access occurred in the last 180 days.\n\nIn this case, the user needs to authenticate the action. \n\nThe 401 response includes a `WWW-Authenticate` header with the `RedirectUrl` value needed.","content":{"application/json":{"schema":{"description":"Any type"}}}}}}},"/v2.01/{ClientId}/wallets/{WalletId}/transactions":{"get":{"operationId":"list_transactions_wallet","summary":"List Transactions for a Wallet","description":"Retrieve the transactions (pay-in, transfers, conversions, and payouts) of a given wallet.\n\n<Note icon=\"fa-regular fa-circle-info\">\n**Note – ScaContext default value is USER_PRESENT**\n\nOn this endpoint, the default value for `ScaContext` is `USER_PRESENT`. If the `PendingUserAction.RedirectUrl` value is returned, you need to redirect the user to perform SCA.\n\nWith approval from Mangopay, your platform may be able to use the `USER_NOT_PRESENT` value provided you also have a legal proxy in place with the user and the user's consent to access wallet balances and transactions on their behalf (read more about [proxy management](/guides/sca/proxy-management)).\n</Note>\n\n<Note icon=\"fa-regular fa-circle-info\">\n**Note – SCA triggered by this endpoint**\n\nThis endpoint requires the user to [perform SCA to authenticate](/guides/sca/wallets) the access to their wallet, unless SCA for wallet access was successfully completed in the last 180 days (or unless your platform is using a [proxy and user consent](/guides/sca/proxy-management)).\n\nWhen SCA is required, this endpoint returns a **401 - Unauthorized** response (see [errors below](#response.error) for details).\n\nTo let the user complete the SCA session on the Mangopay-hosted webpage, your platform needs to retrieve the `RedirectUrl` from the `WWW-Authenticate` response header, add an encoded `returnUrl` query parameter, and redirect the user. Read more about how to redirect them in the [SCA session](/guides/sca/session) guide.\n\nIn Sandbox, you can bypass SCA by including the word `accept` in the `Email` value of the [Natural User](/api-reference/users/natural-user-object-sca) or the `LegalRepresentative.Email` value of the [Legal User](/api-reference/users/legal-user-object-sca) – for example `accept@example.com` or `john.doe+accept@example.com`.\n</Note>","tags":["Transactions"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"WalletId","in":"path","description":"The unique identifier of the wallet.","required":true,"schema":{"type":"string"}},{"name":"ScaContext","in":"query","description":"**Possible values:** `USER_PRESENT`, `USER_NOT_PRESENT`\n\nThe SCA context of the request, which is **required** if the user's `UserCategory` is `OWNER`:\n- `USER_PRESENT` – The user is taking the SCA-triggering action of accessing their wallet. The platform must [redirect the user](/guides/sca/session) using the `PendingUserAction.RedirectUrl` returned so that the user can complete the SCA session (unless exempted because a successful SCA session for wallet access occurred in the last 180 days, so no redirection link was returned).\n- `USER_NOT_PRESENT` – The platform is taking the action under proxy from the user and the user has previously given consent to Mangopay (via the SCA hosted experience) to allow the action. If the user has not given (or has revoked) their consent, then `USER_NOT_PRESENT` returns a 403 error.\n\nRead more about [managing proxy and user consent](/guides/sca/proxy-management) **&rarr;**\n\n**Note:** For existing platforms, the parameter is technically optional if the User is an `OWNER`, and the default value will become `USER_PRESENT` from **Dec 15, 2025** (Dec 1 in Sandbox)","required":false,"schema":{"type":"string"}},{"name":"Sort","in":"query","description":"**Possible values:** `CreationDate:ASC`, `CreationDate:DESC`\n\n**Default value:** `CreationDate:ASC`\n\nIndicates the direction in which to sort the list.","required":false,"schema":{"type":"string"}},{"name":"per_page","in":"query","description":"Min. value: `1`; max. value: `100`\n\n**Default value:** `10`\n\nIndicates the number of items returned for each page of the pagination.","required":false,"schema":{"type":"integer"}},{"name":"page","in":"query","description":"Start value: `1`\n\n**Default value:** `1`\n\nIndicates the index of the page for the pagination.","required":false,"schema":{"type":"integer"}},{"name":"Status","in":"query","description":"**Allowed values:** `CREATED`, `SUCCEEDED`, `FAILED`\n\nThe status of the transaction. You can filter on multiple values by separating them with a comma.","required":false,"schema":{"type":"string"}},{"name":"ResultCode","in":"query","description":"The code indicating the result of the operation. You can filter on multiple values by separating them with a comma.","required":false,"schema":{"type":"string"}},{"name":"BeforeDate","in":"query","description":"The date before which the transaction was created (based on the transaction's `CreationDate` parameter). You can filter on a specific time range by using both the `AfterDate` and `BeforeDate` query parameters.","required":false,"schema":{"type":"integer"}},{"name":"AfterDate","in":"query","description":"The date after which the transaction was created (based on the transaction's `CreationDate` parameter). You can filter on a specific time range by using both the `AfterDate` and `BeforeDate` query parameters.","required":false,"schema":{"type":"integer"}},{"name":"Type","in":"query","description":"**Allowed values:** `PAYIN`, `TRANSFER`, `CONVERSION`, `PAYOUT`\n\nThe type of the transaction. You can filter on multiple values by separating them with a comma.","required":false,"schema":{"type":"string"}},{"name":"Nature","in":"query","description":"**Allowed values:** `REGULAR`, `REPUDIATION`, `REFUND`, `SETTLEMENT`\n\nThe nature of the transaction, providing more information about the context in which the transaction occurred.","required":false,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListTransactionsResponse"}}}},"401":{"description":"SCA required to retrieve data because no successful SCA session for wallet access occurred in the last 180 days.\n\nIn this case, the user needs to authenticate the action. \n\nThe 401 response includes a `WWW-Authenticate` header with the `RedirectUrl` value needed.","content":{"application/json":{"schema":{"description":"Any type"}}}}}}},"/v2.01/{ClientId}/clients/wallets/{FundsType}/{Currency}/transactions":{"get":{"operationId":"list_transactions_client_wallet","summary":"List Transactions for a Client Wallet","description":"List Transactions for a Client Wallet\n\nThis call returns all the transactions targeting or emitted from a Client Wallet, for example:\n- Fees payouts made from the Fees Wallet (`FEES_CCY`)\n- Repudiations and settlements made from or to the Repudiation Wallet (`CREDIT_CCY`)\n- Conversions between Client Wallets","tags":["Transactions"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"FundsType","in":"path","description":"**Allowed values:** `FEES`, `CREDIT`\n\nThe type of funds in the Client Wallet:\n- `FEES` – Fees Wallet, for fees collected by the platform, specific to the Client Wallet object.\n- `CREDIT` – Repudiation Wallet, for funds for the platform's dispute management, specific to the Client Wallet object.\n\n**Note:** The Fees Wallet and Repudiation Wallet are created automatically by Mangopay for each currency.","required":true,"schema":{"type":"string"}},{"name":"Currency","in":"path","description":"**Allowed values:** The three-letter <a href=\"/api-reference/overview/data-formats\" target=\"_blank\">ISO 4217 code</a> (EUR, GBP, etc.) of a <a href=\"/guides/currencies\" target=\"_blank\">supported currency</a> (depends on feature, contract, and activation settings).\n\nThe currency of the wallet.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListTransactionsResponse"}}}}}}},"/v2.01/{ClientId}/cards/{CardId}/transactions":{"get":{"operationId":"list_transactions_card","summary":"List Transactions for a Card","description":"List Transactions for a Card\n\nThis call returns all the transactions of a given card.","tags":["Transactions"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"CardId","in":"path","description":"The unique identifier of the Card object, obtained during the card registration process.","required":true,"schema":{"type":"string"}},{"name":"Status","in":"query","description":"**Allowed values:** `CREATED`, `SUCCEEDED`, `FAILED`\n\nThe status of the transaction. You can filter on multiple values by separating them with a comma.","required":false,"schema":{"type":"string"}},{"name":"ResultCode","in":"query","description":"The code indicating the result of the operation. You can filter on multiple values by separating them with a comma.","required":false,"schema":{"type":"string"}},{"name":"BeforeDate","in":"query","description":"The date before which the transaction was created (based on the transaction's `CreationDate` parameter). You can filter on a specific time range by using both the `AfterDate` and `BeforeDate` query parameters.","required":false,"schema":{"type":"integer"}},{"name":"AfterDate","in":"query","description":"The date after which the transaction was created (based on the transaction's `CreationDate` parameter). You can filter on a specific time range by using both the `AfterDate` and `BeforeDate` query parameters.","required":false,"schema":{"type":"integer"}},{"name":"Type","in":"query","description":"**Allowed values:** `PAYIN`, `TRANSFER`, `CONVERSION`, `PAYOUT`\n\nThe type of the transaction. You can filter on multiple values by separating them with a comma.","required":false,"schema":{"type":"string"}},{"name":"Nature","in":"query","description":"**Allowed values:** `REGULAR`, `REPUDIATION`, `REFUND`, `SETTLEMENT`\n\nThe nature of the transaction, providing more information about the context in which the transaction occurred.","required":false,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListTransactionsResponse"}}}}}}},"/v2.01/{ClientId}/cards/fingerprints/{Fingerprint}/transactions":{"get":{"operationId":"list_transactions_card_fingerprint","summary":"List Transactions for a Card Fingerprint","description":"<Note icon=\"fa-regular fa-circle-info\">\n**Note – Web card pay-ins not returned**\n\nThis endpoint doesn't return transactions processed via the <a href=\"/api-reference/web-card-payins/create-web-card-payin\">web card pay-in</a> endpoint.\n</Note>\n\nList Transactions for a Card Fingerprint\n\nThis call returns all the transactions made with cards with the same `Fingerprint` value.","tags":["Transactions"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"Fingerprint","in":"path","description":"The unique representation of the card number. This string can be used to track the card behavior while keeping the card information confidential.","required":true,"schema":{"type":"string"}},{"name":"Status","in":"query","description":"**Allowed values:** `CREATED`, `SUCCEEDED`, `FAILED`\n\nThe status of the transaction. You can filter on multiple values by separating them with a comma.","required":false,"schema":{"type":"string"}},{"name":"ResultCode","in":"query","description":"The code indicating the result of the operation. You can filter on multiple values by separating them with a comma.","required":false,"schema":{"type":"string"}},{"name":"BeforeDate","in":"query","description":"The date before which the transaction was created (based on the transaction's `CreationDate` parameter). You can filter on a specific time range by using both the `AfterDate` and `BeforeDate` query parameters.","required":false,"schema":{"type":"integer"}},{"name":"AfterDate","in":"query","description":"The date after which the transaction was created (based on the transaction's `CreationDate` parameter). You can filter on a specific time range by using both the `AfterDate` and `BeforeDate` query parameters.","required":false,"schema":{"type":"integer"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListTransactionsResponse"}}}}}}},"/v2.01/{ClientId}/preauthorizations/{PreauthorizationId}/transactions":{"get":{"operationId":"list_transactions_preauthorization","summary":"List Transactions for a Preauthorization","description":"List Transactions for a Preauthorization\n\nThis call returns all preauthorized pay-ins made against a given preauthorization, whether they were successful or not.","tags":["Transactions"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"PreauthorizationId","in":"path","description":"The unique identifier of the preauthorization.","required":true,"schema":{"type":"string"}},{"name":"Status","in":"query","description":"**Allowed values:** `CREATED`, `SUCCEEDED`, `FAILED`\n\nThe status of the transaction. You can filter on multiple values by separating them with a comma.","required":false,"schema":{"type":"string"}},{"name":"ResultCode","in":"query","description":"The code indicating the result of the operation. You can filter on multiple values by separating them with a comma.","required":false,"schema":{"type":"string"}},{"name":"BeforeDate","in":"query","description":"The date before which the transaction was created (based on the transaction's `CreationDate` parameter). You can filter on a specific time range by using both the `AfterDate` and `BeforeDate` query parameters.","required":false,"schema":{"type":"integer"}},{"name":"AfterDate","in":"query","description":"The date after which the transaction was created (based on the transaction's `CreationDate` parameter). You can filter on a specific time range by using both the `AfterDate` and `BeforeDate` query parameters.","required":false,"schema":{"type":"integer"}},{"name":"Type","in":"query","description":"**Allowed values:** `PAYIN`, `TRANSFER`, `CONVERSION`, `PAYOUT`\n\nThe type of the transaction. You can filter on multiple values by separating them with a comma.","required":false,"schema":{"type":"string"}},{"name":"Nature","in":"query","description":"**Allowed values:** `REGULAR`, `REPUDIATION`, `REFUND`, `SETTLEMENT`\n\nThe nature of the transaction, providing more information about the context in which the transaction occurred.","required":false,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListTransactionsResponse"}}}}}}},"/v2.01/{ClientId}/deposit-preauthorizations/{DepositId}/transactions":{"get":{"operationId":"list_transactions_deposit_preauthorization","summary":"List Transactions for a Deposit Preauthorization","description":"This call returns all preauthorized pay-ins, both captures and complements, made against a given deposit preauthorization, whether they were successful or not.\n\n<Note icon=\"fa-regular fa-circle-info\">\n**Note – Disclaimer about terminology**\n\nThe use of the term \"deposit\" in this feature is for convenience only and does not constitute a traditional banking deposit under applicable banking regulations, including the EU Capital Requirements Directive (Directive 2013/36/EU) or the Deposit Guarantee Schemes Directive (Directive 2014/49/EU). Accordingly, these funds are not covered by any statutory deposit protection schemes, and Mangopay does not operate as a licensed banking institution.\n</Note>","tags":["Transactions"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"DepositId","in":"path","description":"The unique identifier of the deposit preauthorization.","required":true,"schema":{"type":"string"}},{"name":"Status","in":"query","description":"**Allowed values:** `CREATED`, `SUCCEEDED`, `FAILED`\n\nThe status of the transaction. You can filter on multiple values by separating them with a comma.","required":false,"schema":{"type":"string"}},{"name":"ResultCode","in":"query","description":"The code indicating the result of the operation. You can filter on multiple values by separating them with a comma.","required":false,"schema":{"type":"string"}},{"name":"BeforeDate","in":"query","description":"The date before which the transaction was created (based on the transaction's `CreationDate` parameter). You can filter on a specific time range by using both the `AfterDate` and `BeforeDate` query parameters.","required":false,"schema":{"type":"integer"}},{"name":"AfterDate","in":"query","description":"The date after which the transaction was created (based on the transaction's `CreationDate` parameter). You can filter on a specific time range by using both the `AfterDate` and `BeforeDate` query parameters.","required":false,"schema":{"type":"integer"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListTransactionsResponse"}}}}}}},"/v2.01/{ClientId}/bankaccounts/{BankAccountId}/transactions":{"get":{"operationId":"list_transactions_bank_account","summary":"List Transactions for a Bank Account","description":"List Transactions for a Bank Account\n\nThis call returns all the transactions of a given bank account, whether the bank account is the source (pay-in) or the target (payout) of the transaction.","tags":["Transactions"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"BankAccountId","in":"path","description":"The unique identifier of the bank account.","required":true,"schema":{"type":"string"}},{"name":"Status","in":"query","description":"**Allowed values:** `CREATED`, `SUCCEEDED`, `FAILED`\n\nThe status of the transaction. You can filter on multiple values by separating them with a comma.","required":false,"schema":{"type":"string"}},{"name":"ResultCode","in":"query","description":"The code indicating the result of the operation. You can filter on multiple values by separating them with a comma.","required":false,"schema":{"type":"string"}},{"name":"BeforeDate","in":"query","description":"The date before which the transaction was created (based on the transaction's `CreationDate` parameter). You can filter on a specific time range by using both the `AfterDate` and `BeforeDate` query parameters.","required":false,"schema":{"type":"integer"}},{"name":"AfterDate","in":"query","description":"The date after which the transaction was created (based on the transaction's `CreationDate` parameter). You can filter on a specific time range by using both the `AfterDate` and `BeforeDate` query parameters.","required":false,"schema":{"type":"integer"}},{"name":"Type","in":"query","description":"**Allowed values:** `PAYIN`, `TRANSFER`, `CONVERSION`, `PAYOUT`\n\nThe type of the transaction. You can filter on multiple values by separating them with a comma.","required":false,"schema":{"type":"string"}},{"name":"Nature","in":"query","description":"**Allowed values:** `REGULAR`, `REPUDIATION`, `REFUND`, `SETTLEMENT`\n\nThe nature of the transaction, providing more information about the context in which the transaction occurred.","required":false,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListTransactionsResponse"}}}}}}},"/v2.01/{ClientId}/mandates/{MandateId}/transactions":{"get":{"operationId":"list_transactions_mandate","summary":"List Transactions for a Mandate","description":"List Transactions for a Mandate\n\nThis call returns direct-debit pay-ins made against a given mandate.","tags":["Transactions"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"MandateId","in":"path","description":"The unique identifier of the mandate.","required":true,"schema":{"type":"string"}},{"name":"Status","in":"query","description":"**Allowed values:** `CREATED`, `SUCCEEDED`, `FAILED`\n\nThe status of the transaction. You can filter on multiple values by separating them with a comma.","required":false,"schema":{"type":"string"}},{"name":"ResultCode","in":"query","description":"The code indicating the result of the operation. You can filter on multiple values by separating them with a comma.","required":false,"schema":{"type":"string"}},{"name":"BeforeDate","in":"query","description":"The date before which the transaction was created (based on the transaction's `CreationDate` parameter). You can filter on a specific time range by using both the `AfterDate` and `BeforeDate` query parameters.","required":false,"schema":{"type":"integer"}},{"name":"AfterDate","in":"query","description":"The date after which the transaction was created (based on the transaction's `CreationDate` parameter). You can filter on a specific time range by using both the `AfterDate` and `BeforeDate` query parameters.","required":false,"schema":{"type":"integer"}},{"name":"Type","in":"query","description":"**Allowed values:** `PAYIN`, `TRANSFER`, `CONVERSION`, `PAYOUT`\n\nThe type of the transaction. You can filter on multiple values by separating them with a comma.","required":false,"schema":{"type":"string"}},{"name":"Nature","in":"query","description":"**Allowed values:** `REGULAR`, `REPUDIATION`, `REFUND`, `SETTLEMENT`\n\nThe nature of the transaction, providing more information about the context in which the transaction occurred.","required":false,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListTransactionsResponse"}}}}}}},"/v2.01/{ClientId}/disputes/{DisputeId}/transactions":{"get":{"operationId":"list_transactions_dispute","summary":"List Transactions for a Dispute","description":"List Transactions for a Dispute\n\nThis call returns the transactions following the creation of a given dispute, in other words, the repudiation transfer, and the settlement (if any).","tags":["Transactions"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"DisputeId","in":"path","description":"The unique identifier of the dispute.","required":true,"schema":{"type":"string"}},{"name":"Status","in":"query","description":"**Allowed values:** `CREATED`, `SUCCEEDED`, `FAILED`\n\nThe status of the transaction. You can filter on multiple values by separating them with a comma.","required":false,"schema":{"type":"string"}},{"name":"ResultCode","in":"query","description":"The code indicating the result of the operation. You can filter on multiple values by separating them with a comma.","required":false,"schema":{"type":"string"}},{"name":"BeforeDate","in":"query","description":"The date before which the transaction was created (based on the transaction's `CreationDate` parameter). You can filter on a specific time range by using both the `AfterDate` and `BeforeDate` query parameters.","required":false,"schema":{"type":"integer"}},{"name":"AfterDate","in":"query","description":"The date after which the transaction was created (based on the transaction's `CreationDate` parameter). You can filter on a specific time range by using both the `AfterDate` and `BeforeDate` query parameters.","required":false,"schema":{"type":"integer"}},{"name":"Type","in":"query","description":"**Allowed values:** `PAYIN`, `TRANSFER`, `CONVERSION`, `PAYOUT`\n\nThe type of the transaction. You can filter on multiple values by separating them with a comma.","required":false,"schema":{"type":"string"}},{"name":"Nature","in":"query","description":"**Allowed values:** `REGULAR`, `REPUDIATION`, `REFUND`, `SETTLEMENT`\n\nThe nature of the transaction, providing more information about the context in which the transaction occurred.","required":false,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListTransactionsResponse"}}}}}}},"/v3.0/{ClientId}/payins/intents/external-providers":{"get":{"operationId":"list_intent_external_providers","summary":"List Intent external providers","description":"Retrieve the list of third-party PSP names supported as `ExternalData.ExternalProviderName` values on the [Intent object](/api-reference/intents/create-intent).","tags":["Intents"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListIntentExternalProvidersResponse"}}}}}}},"/v3.0/{ClientId}/payins/intents":{"post":{"operationId":"create_intent","summary":"Create an Intent","description":"Declare a transaction authorization processed by a third-party PSP\n\nThis endpoint allows you to declare a payment authorized by a third-party PSP. Once `AUTHORIZED` (as shown by the `Status` in the response), the Intent's `LineItems` can be:\n- Captured using [POST Create an Intent Capture](/api-reference/intents/create-intent-capture)\n- Canceled using [POST Cancel an Intent](/api-reference/intents/cancel-intent)\n\nIn a mixed-basket flow, you can also use this endpoint to add `LineItems` to an existing Intent by sending the same `ExternalData.ExternalProviderReference` as the existing Intent.\n\nIn a hybrid flow, where the `ExternalProviderName` is `Mangopay`, you can define the `LineItems.SplitOriginWalletId` in the Intent, otherwise it must be defined on [POST Create an Intent Split](/api-reference/intents/create-intent-split).","tags":["Intents"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntentResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAnIntentRequest"}}}}},"get":{"operationId":"list_intents","summary":"List all Intents","description":"Retrieve a paginated list of Intents, with optional filters for provider, currency, date range, and status.","tags":["Intents"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"BeforeDate","in":"query","description":"The date before which the object was created (based on the object's `CreationDate` parameter). You can filter on a specific time range by using both the `AfterDate` and `BeforeDate` query parameters.","required":false,"schema":{"type":"integer"}},{"name":"AfterDate","in":"query","description":"The date after which the object was created (based on the object's `CreationDate` parameter). You can filter on a specific time range by using both the `AfterDate` and `BeforeDate` query parameters.","required":false,"schema":{"type":"integer"}},{"name":"Status","in":"query","description":"**Allowed values:** `AUTHORIZED`, `CAPTURED`, `PARTIALLY_CAPTURED`, `REFUNDED`, `REFUND_REVERSED`, `DISPUTED`, `DISPUTED_WON`, `DISPUTED_LOST`, `DEFENDED`, `CANCELLED`\n\nThe status of the Intent. You can filter on multiple values by separating them with a comma.","required":false,"schema":{"type":"string"}},{"name":"ExternalProviderName","in":"query","description":"The third-party PSP name to filter by.","required":false,"schema":{"type":"string"}},{"name":"Currency","in":"query","description":"The three-letter <a href=\"/api-reference/overview/data-formats\" target=\"_blank\">ISO 4217 code</a> of the currency to filter by.","required":false,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start value: `1`\n\n**Default value:** `1`\n\nIndicates the index of the page for the pagination.","required":false,"schema":{"type":"integer"}},{"name":"per_page","in":"query","description":"Min. value: `1`; max. value: `100`\n\n**Default value:** `10`\n\nIndicates the number of items returned for each page of the pagination.","required":false,"schema":{"type":"integer"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListAllIntentsResponse"}}}}}}},"/v3.0/{ClientId}/payins/intents/{IntentId}/cancel":{"post":{"operationId":"cancel_intent","summary":"Cancel an Intent","description":"Cancel all or part of an authorized Intent\n\nYou can use this endpoint to cancel all or part of an Intent **before** it has been captured. You can only call this endpoint if the Intent has the `Status` of `AUTHORIZED`. You cannot cancel an Intent if it has been captured in part (`PARTIALLY_CAPTURED`) or full (`CAPTURED`).","tags":["Intents"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"IntentId","in":"path","description":"The unique identifier of the Intent.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CancelAnIntentResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CancelAnIntentRequest"}}}}}},"/v3.0/{ClientId}/payins/intents/{IntentId}/captures":{"post":{"operationId":"create_intent_capture","summary":"Create an Intent Capture","description":"Declare the full or partial capture of an authorization processed by a third-party PSP\n\nYou can use this endpoint in three capture scenarios requiring three difference request bodies.","tags":["Intents"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"IntentId","in":"path","description":"The unique identifier of the Intent.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntentCaptureResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAnIntentCaptureRequest"}}}}}},"/v3.0/{ClientId}/payins/intents/{IntentId}/refunds":{"post":{"operationId":"create_intent_refund","summary":"Create an Intent Refund","description":"Declare the full or partial refund of a payment processed by a third-party PSP, represented by an Intent Refund. ","tags":["Intents"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"IntentId","in":"path","description":"The unique identifier of the Intent.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntentRefundResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAnIntentRefundRequest"}}}}}},"/v3.0/{ClientId}/payins/intents/{IntentId}/refunds/{RefundId}/reverse":{"post":{"operationId":"reverse_intent_refund","summary":"Reverse an Intent Refund","description":"Declare the reversal of a refund processed by a third-party PSP\n\nThis endpoint allows you to reverse an Intent Refund in full or in part if the refund processed by the third-party PSP was not successful and the funds were returned to the platform.\n\nThis endpoint effectively changes the Intent Refund `Status` to `REFUND_REVERSED` and re-calculates the `RefundedAmount` of the `LineItem`.\n\nYou can only reverse the same amount that was refunded.","tags":["Intents"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"IntentId","in":"path","description":"The unique identifier of the Intent.","required":true,"schema":{"type":"string"}},{"name":"RefundId","in":"path","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntentRefundResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAnIntentRefundRequest"}}}}}},"/v3.0/{ClientId}/payins/intents/{IntentId}/capture/{CaptureId}/disputes":{"post":{"operationId":"create_intent_dispute","summary":"Create an Intent Dispute","description":"Declare the full or partial dispute of a payment processed by a third-party PSP, represented by an Intent Dispute.","tags":["Intents"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"IntentId","in":"path","description":"The unique identifier of the Intent.","required":true,"schema":{"type":"string"}},{"name":"CaptureId","in":"path","description":"The unique identifier of the Capture being disputed.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntentDisputeResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAnIntentDisputeRequest"}}}}}},"/v3.0/{ClientId}/payins/intents/{IntentId}/capture/{CaptureId}/disputes/{DisputeId}/decision":{"put":{"operationId":"update_intent_dispute","summary":"Update an Intent Dispute","description":"Track the outcome of a dispute processed by a third-party PSP.\n\nThis endpoint allows you to track the outcome of an Intent Dispute by sending the `Decision` value. In the Intent object, the decision is reflected in the `Disputes.Status` value","tags":["Intents"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"IntentId","in":"path","description":"The unique identifier of the Intent.","required":true,"schema":{"type":"string"}},{"name":"CaptureId","in":"path","description":"The unique identifier of the Capture being disputed.","required":true,"schema":{"type":"string"}},{"name":"DisputeId","in":"path","description":"The unique identifier of the Intent Dispute.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAnIntentDisputeResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAnIntentDisputeRequest"}}}}}},"/v3.0/{ClientId}/payins/intents/{IntentId}":{"get":{"operationId":"view_intent","summary":"View an Intent","description":"Retrieve the declaration of a transaction processed by a third-party PSP","tags":["Intents"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"IntentId","in":"path","description":"The unique identifier of the Intent.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ViewAnIntentResponse"}}}}}}},"/v3.0/{ClientId}/payins/intents/{IntentId}/splits":{"post":{"operationId":"create_intent_split","summary":"Create an Intent Split","description":"Create a transfer to the wallet of the seller of an Intent line item.\n\nOnce the Intent is `PARTIALLY_CAPTURED` or `CAPTURED`, you can create Splits to set up the transfers to the seller wallet(s).","tags":["Intents"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"IntentId","in":"path","description":"The unique identifier of the Intent.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntentSplitsResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAnIntentSplitRequest"}}}}}},"/v3.0/{ClientId}/payins/intents/{IntentId}/splits/{SplitId}":{"put":{"operationId":"update_intent_split","summary":"Update an Intent Split","description":"<Note icon=\"fa-regular fa-circle-info\">\n**Note – Split Status values that allow modification**\n\nTo modify a split, its `Status` must be: \n- `CREATED`\n- `PENDING_FUNDS_RECEPTION`\n- `AVAILABLE`\n- `FAILED `\n</Note>\n\nModify a Split before execution.","tags":["Intents"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"IntentId","in":"path","description":"The unique identifier of the Intent.","required":true,"schema":{"type":"string"}},{"name":"SplitId","in":"path","description":"The unique identifier of the Split.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntentSplitsResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAnIntentSplitRequest"}}}}},"get":{"operationId":"view_intent_split","summary":"View an Intent Split","description":"Retrieve details of a Split of an Intent.","tags":["Intents"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"IntentId","in":"path","required":true,"schema":{"type":"string"}},{"name":"SplitId","in":"path","description":"The unique identifier of the Split.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntentSplitResponse"}}}}}}},"/v3.0/{ClientId}/payins/intents/{IntentId}/splits/{SplitId}/execute":{"post":{"operationId":"execute_intent_split","summary":"Execute an Intent Split","description":"Release the funds of a Split to the wallet of the seller of the Intent line item.\n\nOnce the Intent funds have been settled (in a Settlement) and the funds have been received on the platform's technical wallet, the Split status becomes `AVAILABLE`, meaning you can use this endpoint to execute the transfer of funds to the Seller's wallet.","tags":["Intents"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"IntentId","in":"path","description":"The unique identifier of the Intent.","required":true,"schema":{"type":"string"}},{"name":"SplitId","in":"path","description":"The unique identifier of the Split.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntentSplitResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v3.0/{ClientId}/payins/intents/{IntentId}/splits/{SplitId}/reverse":{"post":{"operationId":"reverse_intent_split","summary":"Reverse an Intent Split","description":"Cancel an unexecuted Split\n\nReversing a Split effectively cancels it, and can only be done when it has the `Status` of `AVAILABLE` or `REJECTED`.","tags":["Intents"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"IntentId","in":"path","description":"The unique identifier of the Intent.","required":true,"schema":{"type":"string"}},{"name":"SplitId","in":"path","description":"The unique identifier of the Split.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntentSplitResponse"}}}}}}},"/v3.0/{ClientId}/payins/intents/splits":{"get":{"operationId":"list_intent_splits","summary":"List all Intent Splits","description":"Retrieve a paginated list of splits across all intents, with optional filters for provider, currency, date range, and status.","tags":["Intents"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"BeforeDate","in":"query","description":"The date before which the object was created (based on the object's `CreationDate` parameter). You can filter on a specific time range by using both the `AfterDate` and `BeforeDate` query parameters.","required":false,"schema":{"type":"integer"}},{"name":"AfterDate","in":"query","description":"The date after which the object was created (based on the object's `CreationDate` parameter). You can filter on a specific time range by using both the `AfterDate` and `BeforeDate` query parameters.","required":false,"schema":{"type":"integer"}},{"name":"Status","in":"query","description":"**Allowed values:** `CREATED`, `PENDING_FUNDS_RECEPTION`, `AVAILABLE`, `PENDING`, `COMPLETED`, `REJECTED`, `FAILED`, `REVERSED`, `REFUND_SPLIT_PENDING`, `REFUND_SPLIT_REJECTED`, `REFUND_SPLIT_COMPLETED`\n\nThe status of the Split. You can filter on multiple values by separating them with a comma.","required":false,"schema":{"type":"string"}},{"name":"ExternalProviderName","in":"query","description":"The third-party PSP name of the parent intent to filter by.","required":false,"schema":{"type":"string"}},{"name":"Currency","in":"query","description":"The three-letter <a href=\"/api-reference/overview/data-formats\" target=\"_blank\">ISO 4217 code</a> of the currency to filter by.","required":false,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start value: `1`\n\n**Default value:** `1`\n\nIndicates the index of the page for the pagination.","required":false,"schema":{"type":"integer"}},{"name":"per_page","in":"query","description":"Min. value: `1`; max. value: `100`\n\n**Default value:** `10`\n\nIndicates the number of items returned for each page of the pagination.","required":false,"schema":{"type":"integer"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListAllSplitsResponse"}}}}}}},"/v3.0/{ClientId}/payins/intents/settlements":{"post":{"operationId":"create_settlement","summary":"Create a Settlement and generate a secure URL for file upload","description":"Generate a pre-signed URL to which you can upload your Mangopay-format settlement file\n\nThis endpoint returns a unique temporary pre-signed URL, `SettlementFileUploadUrl`, that you can use to upload your Mangopay-format settlement file (see [PUT Upload a settlement file to the secure URL](/api-reference/settlements/upload-settlement-file)).","tags":["Settlements"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SettlementFileUploadResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateASettlementAndGenerateASecureURLForFileUploadRequest"}}}}},"get":{"operationId":"list_settlements","summary":"List all Settlements","description":"Retrieve a paginated list of settlements, with optional filters for provider, currency, date range, and status.","tags":["Settlements"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"BeforeDate","in":"query","description":"The date before which the object was created (based on the object's `CreationDate` parameter). You can filter on a specific time range by using both the `AfterDate` and `BeforeDate` query parameters.","required":false,"schema":{"type":"integer"}},{"name":"AfterDate","in":"query","description":"The date after which the object was created (based on the object's `CreationDate` parameter). You can filter on a specific time range by using both the `AfterDate` and `BeforeDate` query parameters.","required":false,"schema":{"type":"integer"}},{"name":"Status","in":"query","description":"**Allowed values:** `PENDING_UPLOAD`, `UPLOADED`, `CREATED`, `UNMATCHED`, `PARTIALLY_MATCHED`, `PENDING_FUNDS_RECEPTION`, `INSUFFICIENT_FUNDS`, `RECONCILED`, `FAILED`, `CANCELLED`\n\nThe status of the Settlement. You can filter on multiple values by separating them with a comma.","required":false,"schema":{"type":"string"}},{"name":"ExternalProviderName","in":"query","description":"The third-party PSP name to filter by.","required":false,"schema":{"type":"string"}},{"name":"Currency","in":"query","description":"The three-letter <a href=\"/api-reference/overview/data-formats\" target=\"_blank\">ISO 4217 code</a> of the currency to filter by.","required":false,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start value: `1`\n\n**Default value:** `1`\n\nIndicates the index of the page for the pagination.","required":false,"schema":{"type":"integer"}},{"name":"per_page","in":"query","description":"Min. value: `1`; max. value: `100`\n\n**Default value:** `10`\n\nIndicates the number of items returned for each page of the pagination.","required":false,"schema":{"type":"integer"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListAllSettlementsResponse"}}}}}}},"/{SettlementFileUploadUrl}":{"put":{"operationId":"upload_settlement_file","summary":"Upload a settlement file to the secure URL","description":"To send your CSV settlement file to Mangopay, use the `SettlementFileUploadUrl` value dynamically returned by [POST Create a Settlement and generate upload URL](/api-reference/settlements/create-settlement) endpoint.\n\n<Warning icon=\"fa-regular fa-triangle-exclamation\">\n**Caution – Use settlement file example as template**\n\nYou must follow the [specifications provided here](/api-reference/settlements/settlement-file).\n\nUse this <Download src=\"./Example_Mangopay_Settlement_File.csv\">Example_Mangopay_Settlement_File.csv</Download>, which contains the correct column and row labels and example data for 3 transactions. Remove the example data lines before generating your own file.\n</Warning>\n\nYou need to send one file per currency, as soon as it becomes available. Read more about [providing settlement files to Mangopay](/guides/echo#send-settlement-files-to-mangopay).\n\nWhen calling the pre-signed `SettlementFileUploadUrl`:\n\n* Ensure you integrate the full URL (host, path, queries) dynamically as it is unique to each file upload attempt\n* Don't include the Authorization header, as the URL is already authenticated in the query strings\n* Set the `Content-Type` header to `text/csv` and send the file as a raw binary stream using `data-binary`\n\nNote that the `FileName` used by Mangopay is the one you sent on the [POST Create a Settlement and generate upload URL](/api-reference/settlements/create-settlement) endpoint (with a timestamp automatically appended); the name of the file on your system is only relevant for the `data-binary` stream in this call.\n","tags":["Settlements"],"parameters":[{"name":"SettlementFileUploadUrl","in":"path","description":"The variable URL is only documented as a path parameter on this path for documentation reasons. I allows it to be rendered visiablly on the page, and because there are two dynamic server URLs in the spec (so both would be on the / path). The variable URL is the server for this request, and it has a variable host and path and query parameters. You do not need to add anything to it.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"No response body. A 200 response indicates that the file was uploaded successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/settlements_upload_settlement_file_Response_200"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"string","format":"binary"}}}}}},"/v3.0/{ClientId}/payins/intents/settlements/{SettlementId}":{"put":{"operationId":"update_settlement","summary":"Update a Settlement and generate a new upload URL","description":"Generate a new pre-signed URL to replace the file of an existing Settlement\n\nYou can use this endpoint to generate a new `SettlementFileUploadUrl` for an existing Settlement object (with `SettlementId`).\n\nThis is necessary if a file you uploaded previously is not parsed or reconciled successfully.","tags":["Settlements"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"SettlementId","in":"path","description":"The unique identifier of the Settlement object.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SettlementFileUploadResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateASettlementAndGenerateASecureURLForFileUploadRequest"}}}}},"get":{"operationId":"view_settlement","summary":"View a Settlement","description":"Retrieve the settlement data generated from file upload","tags":["Settlements"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"SettlementId","in":"path","description":"The unique identifier of the Settlement object.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SettlementResponse"}}}}}}},"/v3.0/{ClientId}/payins/intents/settlements/{SettlementId}/cancel":{"post":{"operationId":"cancel_settlement","summary":"Cancel a Settlement","description":"Disregard a settlement file and stop it being processed","tags":["Settlements"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"SettlementId","in":"path","description":"The unique identifier of the Settlement object.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SettlementResponse"}}}}}}},"/v3.0/{ClientId}/payins/intents/settlements/{SettlementId}/validations":{"get":{"operationId":"view_settlement_validations","summary":"View validation errors for a Settlement","description":"Retrieve information about failed or partially matched settlements.\n\nIf your Settlement's `Status` is `PARTIALLY_MATCHED` or `FAILED`, this endpoint returns information about the errors in your CSV file's footer or transaction lines.","tags":["Settlements"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"SettlementId","in":"path","description":"The unique identifier of the Settlement object.","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start value: `1`\n\n**Default value:** `1`\n\nIndicates the index of the page for the pagination.","required":false,"schema":{"type":"integer"}},{"name":"per_page","in":"query","description":"Min. value: `1`; max. value: `100`\n\n**Default value:** `10`\n\nIndicates the number of items returned for each page of the pagination.","required":false,"schema":{"type":"integer"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ViewValidationErrorsForASettlementResponse"}}}}}}},"/v2.01/{ClientId}/responses/{IdempotencyKey}":{"get":{"operationId":"view_api_response","summary":"View an API Response","description":"View an API Response\n\nThis call returns an API response based on the corresponding idempotency key, within 24 hours of the initial call.","tags":["apiResponses"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"IdempotencyKey","in":"path","description":"A unique string generated by the platform.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ViewAnApiResponse"}}}}}}},"/v2.01/countries/{CountryCode}/authorizations":{"get":{"operationId":"view_authorizations_country","summary":"View Authorizations for a country","description":"View Authorizations for a country\n\nThis call returns the restrictions for a specific country.","tags":["countryAuthorizations"],"parameters":[{"name":"CountryCode","in":"path","description":"Format: Two-letter country code ([ISO 3166-1 alpha-2 format](/api-reference/overview/data-formats))\n\nThe code of the country.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CountryAuthorizationsResponse"}}}}}}},"/v2.01/countries/authorizations":{"get":{"operationId":"list_authorizations_countries","summary":"List Authorizations for all countries","description":"List Authorizations for all countries\n\nThis call returns the restrictions of all countries.","tags":["countryAuthorizations"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListAuthorizationsForAllCountriesResponse"}}}}}}},"/v2.01/{ClientId}/hooks":{"post":{"operationId":"create_hook","summary":"Create a Hook","description":"<Warning icon=\"fa-regular fa-triangle-exclamation\">\n**Caution – Setting email for consecutive failures after April 2026**\n\nIn Production, if your platform had `VALID` Hook objects before April 2, 2026, then Mangopay automatically populates the `Email` property on new Hooks with the previously used global address **unless and until** you set it proactively using this endpoint.\n\nIf you send the `Email` on a POST or PUT request, other new Hooks created without the `Email` do not populate the `Email` automatically and do not emit alerts in case of consecutive failed notifications or if the Hook becomes `INVALID`.\n\nPlatforms integrating after April 2, 2026 **must** proactively set the `Email` to receive alerts.\n\n[Read more about this change](/webhooks#transition-from-default-email-april-2026) **&rarr;**\n</Warning>","tags":["Webhooks"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HookResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAHookRequest"}}}}},"get":{"operationId":"list_hooks","summary":"List all Hooks","description":"List all Hooks\n\nThis call returns all the Hooks that have been created for the platform. It includes both enabled and disabled hooks.","tags":["Webhooks"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListAllHooksResponse"}}}}}}},"/v2.01/{ClientId}/hooks/{HookId}":{"put":{"operationId":"update_hook","summary":"Update a Hook","description":"<Warning icon=\"fa-regular fa-triangle-exclamation\">\n**Caution – Setting email for consecutive failures after April 2026**\n\nIn Production, if your platform had `VALID` Hook objects before April 2, 2026, then Mangopay automatically populates the `Email` property with the previously used global address **unless and until** you set it proactively using this endpoint. \n\nIf you send the `Email` on a POST or PUT request, other new Hooks created without the `Email` do not populate the `Email` automatically and do not emit alerts in case of consecutive failed notifications or if the Hook becomes `INVALID`.\n\nPlatforms integrating after April 2, 2026 **must** proactively set the `Email` to receive alerts.\n\n[Read more about this change](/webhooks#transition-from-default-email-april-2026) **&rarr;**\n</Warning>","tags":["Webhooks"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"HookId","in":"path","description":"The unique identifier of the hook.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HookResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAHookRequest"}}}}},"get":{"operationId":"view_hook","summary":"View a Hook","description":"View a Hook","tags":["Webhooks"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"HookId","in":"path","description":"The unique identifier of the hook.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HookResponse"}}}}}}},"/v2.01/{ClientId}/events":{"get":{"operationId":"list_events","summary":"List all Events","description":"<Note icon=\"fa-regular fa-circle-info\"> \n**Note** \n\nEvents are returned up to 45 days after they occur. Any request attempting to access an event older than 45 days will result in an HTTP 400 - error.  \n</Note>\n\nList all Events","tags":["Events"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"EventType","in":"query","description":"**Allowed values:** An `EventType` listed in the <a href=\"/webhooks/event-types\">event types list</a>\n\nThe type of the event.","required":true,"schema":{"type":"string"}},{"name":"BeforeDate","in":"query","description":"The date before which the event was created (based on the event's `CreationDate` parameter). You can filter on a specific time range by using both the `AfterDate` and `BeforeDate` query parameters.","required":false,"schema":{"type":"integer"}},{"name":"AfterDate","in":"query","description":"The date after which the event was created (based on the event's `CreationDate` parameter). You can filter on a specific time range by using both the `AfterDate` and `BeforeDate` query parameters.","required":false,"schema":{"type":"integer"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListAllEventsResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v2.01/{ClientId}/reporting/reports":{"post":{"operationId":"create_report","summary":"Create a Report","description":"Generate a reporting service report\n\nThis endpoint generates a report from Mangopay's Reporting Service, which is replacing the legacy report types (read the [guide](/reports)). \n\nThere are 2 reports (indicated by `ReportType`) that may be useful to all platforms: `USER_WALLET_TRANSACTIONS` and `COLLECTED_FEES`. \n\nThere are 4 `ReportType` that are designed to support platforms using [Echo](/guides/echo), Mangopay solution for integrations working with third-party PSPs: `ECHO_INTENT`, `ECHO_INTENT_ACTION`, `ECHO_SETTLEMENT`, `ECHO_SPLIT`.\n\nEach `ReportType` has different available `Columns` and `Filters`.\n\n<Note icon=\"fa-regular fa-circle-info\"> \n**Note – Report expires after 31 days** \n\nA Reporting Service report expires after 31 days, at which point it can no longer be downloaded. On expiry, the report's `Status` becomes `EXPIRED` and the `DownloadURL` becomes `null`.\n\nYou can generate a new report with the same filters and dates.\n</Note>","tags":["Reporting"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAReportResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAReportRequest"}}}}},"get":{"operationId":"list_reports","summary":"List all Reports","description":"List key data of Reporting Service reports","tags":["Reporting"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"Status","in":"query","description":"**Possible values:** `PENDING`, `GENERATING`, `GENERATED`, `EXPIRED`, `FAILED`\n\nThe status of the report:\n- `PENDING` – The report generation request was accepted but is not yet being processed.\n- `GENERATING` – The report is being generated.\n- `GENERATED` – The report is ready for download at the `DownloadURL`\n- `EXPIRED` – The report has expired and is no longer available for download.\n- `FAILED` – Report generation was not successful.","required":false,"schema":{"type":"string"}},{"name":"BeforeDate","in":"query","description":"The date before which the report was created (based on the report's `CreationDate` parameter). You can filter on a specific time range by using both the `AfterDate` and `BeforeDate` query parameters.","required":false,"schema":{"type":"integer"}},{"name":"AfterDate","in":"query","description":"The date after which the report was created (based on the report's `CreationDate` parameter). You can filter on a specific time range by using both the `AfterDate` and `BeforeDate` query parameters.","required":false,"schema":{"type":"integer"}},{"name":"per_page","in":"query","description":"Min. value: `1`; max. value: `100`\n\n**Default value:** `10`\n\nIndicates the number of items returned for each page of the pagination.","required":false,"schema":{"type":"integer"}},{"name":"page","in":"query","description":"Start value: `1`\n\n**Default value:** `1`\n\nIndicates the index of the page for the pagination.","required":false,"schema":{"type":"integer"}},{"name":"Sort","in":"query","description":"**Possible values:** `CreationDate:ASC`, `CreationDate:DESC`\n\n**Default value:** `CreationDate:ASC`\n\nIndicates the direction in which to sort the list.","required":false,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListAllReportsResponse"}}}}}}},"/v2.01/{ClientId}/reporting/reports/{ReportingId}":{"get":{"operationId":"view_report","summary":"View a Report","description":"Retrieve a report from the Reporting Service","tags":["Reporting"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"ReportingId","in":"path","description":"The unique identifier of the Reporting Service report.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReportResponse"}}}}}}},"/v2.01/{ClientId}/reports/transactions":{"post":{"operationId":"create_transactions_report","summary":"Create a Transactions Report","description":"<Note icon=\"fa-regular fa-circle-info\"> \n**Note – Report expiration date** \n\nA report expires after 24 hours (i.e., you can no longer download it after this period). You can still generate a new report with the same filters and information easily.  \n</Note>\n\n<Note icon=\"fa-regular fa-circle-info\"> \n**Note – `BeforeDate` value restriction** \n\nTo ensure that data provided on each report are up-to-date, the `BeforeDate` parameter cannot be greater than the report creation date minus 5 minutes. \nIf it is, `BeforeDate` will be automatically set according to this constraint.  \n</Note>\n\nGenerate a legacy Transactions Report","tags":["Reports"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateATransactionsReportResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateATransactionsReportRequest"}}}}}},"/v2.01/{ClientId}/reports/wallets":{"post":{"operationId":"create_wallets_report","summary":"Create a Wallets Report","description":"<Note icon=\"fa-regular fa-circle-info\"> \n**Note – Report expiration date** \n\nA report expires after 24 hours (i.e., you can no longer download it after this delay). You can still generate a new report with the same filters and information easily.  \n</Note>\n\nGenerate a legacy Wallets Report","tags":["Reports"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAWalletsReportResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAWalletsReportRequest"}}}}}},"/v2.01/{ClientId}/reports/{ReportId}":{"get":{"operationId":"view_report_legacy","summary":"View a Report","description":"Retrieve a legacy report","tags":["Reports"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"ReportId","in":"path","description":"The unique identifier of the legacy report.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReportResponseLegacy"}}}}}}},"/v2.01/{ClientId}/reports":{"get":{"operationId":"list_reports_legacy","summary":"List all Reports","description":"List all legacy reports","tags":["Reports"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"BeforeDate","in":"query","description":"The date before which the report was created (based on the report's `CreationDate` parameter). You can filter on a specific time range by using both the `AfterDate` and `BeforeDate` query parameters.","required":false,"schema":{"type":"integer"}},{"name":"AfterDate","in":"query","description":"The date after which the report was created (based on the report's `CreationDate` parameter). You can filter on a specific time range by using both the `AfterDate` and `BeforeDate` query parameters.","required":false,"schema":{"type":"integer"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListAllReportsResponseLegacy"}}}}}}},"/v2.01/{ClientId}/clients":{"put":{"operationId":"update_client","summary":"Update a Client","description":"Modify certain information registered with Mangopay for your platform, notably:\n- `PrimaryThemeColour` and `PrimaryButtonColour`, which you can use to customize the appearance of Mangopay's hosted SCA - [read more](/guides/sca/factors#customization) **&rarr;**\n","tags":["Client"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAClientResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAClientRequest"}}}}},"get":{"operationId":"view_client","summary":"View a Client","description":"Retrieve details about your platform registered with Mangopay","tags":["Client"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientResponse"}}}}}}},"/v2.01/{ClientId}/clients/logo":{"put":{"operationId":"upload_client_logo","summary":"Upload a Client logo","description":"Upload your platform's logo or wordmark as a Base64-encoded file.\n\nYour logo is used in the following hosted webpages: \n- SCA ([read more](/guides/sca/factors#customization))\n- Hosted payment page ([read more](/api-reference/web-card-payins/web-card-payin-object))\n- Direct debit mandate confirmation page ([read more](/guides/payment-methods/banking/direct-debit))\n\nFile recommendations: \n- **Format:** PNG or JPG\n- **Orientation:** landscape\n- **Size:** 240px min. height","tags":["Client"],"parameters":[{"name":"ClientId","in":"path","description":"Platform's API account identifier, associated with the API key.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/client_upload_client_logo_Response_200"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UploadAClientLogoRequest"}}}}}}},"servers":[{"url":"https://api.sandbox.mangopay.com","description":"Sandbox"},{"url":"https://api.mangopay.com","description":"Production"},{"url":"https://api-mtls.sandbox.mangopay.com","description":"mTLS Sandbox"},{"url":"https://api-mtls.mangopay.com","description":"mTLS Production"},{"url":"%7BCardRegistrationUrl%7D","description":"The full dynamic URL returned by the Create a Card Registration call, including host, path, and query parameters. \n"},{"url":"%7BSettlementFileUploadUrl%7D","description":"The unique URL returned by the [POST Create a Settlement and secure URL](/api-reference/settlements/create-settlement) endpoint.\n\n**Note:** Use the full dynamic URL including the host, path, and all query parameters. The URL is already authenticated, so this call does not require an Authorization header.\n"}],"components":{"schemas":{"CreateOAuthBearerTokenResponse":{"type":"object","properties":{"access_token":{"type":"string","description":"The access token to use in the Authorization header of your subsequent API call."},"token_type":{"type":"string","description":"**Returned values:** `Bearer`\n\nThe type of the token."},"expires_in":{"type":"integer","description":"The number of seconds until the token expires."}},"title":"CreateOAuthBearerTokenResponse"},"CreateAnAccessTokenForTheRecipientsEmbeddedExperienceRequestClaims":{"type":"object","properties":{"userId":{"type":"string","description":"Unique identifier of the Natural User or Legal User using the Recipient frontend experience to register a bank account."}},"required":["userId"],"description":"Claims for the access token request.","title":"CreateAnAccessTokenForTheRecipientsEmbeddedExperienceRequestClaims"},"CreateAnAccessTokenForTheRecipientsEmbeddedExperienceRequest":{"type":"object","properties":{"clientId":{"type":"string","description":"Your Mangopay Client ID."},"claims":{"$ref":"#/components/schemas/CreateAnAccessTokenForTheRecipientsEmbeddedExperienceRequestClaims","description":"Claims for the access token request."}},"required":["clientId","claims"],"title":"CreateAnAccessTokenForTheRecipientsEmbeddedExperienceRequest"},"RecipientAccessTokenResponse":{"type":"object","properties":{"access_token":{"type":"string","description":"The value to use as the `clientToken` when initializing Mangopay Elements for the [Recipients embedded experience](/sdks/elements)."},"token_type":{"type":"string","description":"**Returned values:** `Bearer`\n\nThe type of the token."},"expires_in":{"type":"integer","description":"The number of seconds until the token expires."},"scope":{"type":"string","description":"**Returned values:** `bankaccounts:r bankaccounts:w`\n\nThe API permission scopes of the token, in this case to read and write bank account data."}},"title":"RecipientAccessTokenResponse"},"CreateAnAccessTokenForCheckoutSdkFeaturesRequestClaims":{"type":"object","properties":{"userId":{"type":"string","description":"Unique identifier of the Natural User or Legal User using the Checkout SDK session to make a payment."}},"required":["userId"],"description":"Claims for the access token request.","title":"CreateAnAccessTokenForCheckoutSdkFeaturesRequestClaims"},"CreateAnAccessTokenForCheckoutSdkFeaturesRequest":{"type":"object","properties":{"clientId":{"type":"string","description":"Your Mangopay Client ID."},"claims":{"$ref":"#/components/schemas/CreateAnAccessTokenForCheckoutSdkFeaturesRequestClaims","description":"Claims for the access token request."}},"required":["clientId","claims"],"title":"CreateAnAccessTokenForCheckoutSdkFeaturesRequest"},"CheckoutAccessTokenResponse":{"type":"object","properties":{"access_token":{"type":"string","description":"The access token value to use as the `clientToken` value when initializing Checkout SDK."},"token_type":{"type":"string","description":"**Returned values:** `Bearer`\n\nThe type of the token."},"expires_in":{"type":"integer","description":"The number of seconds until the token expires."},"scope":{"type":"string","description":"**Returned values:** `checkout.session:r checkout.session:w`\n\nThe API permission scopes of the token, in this case to read and write a Checkout session."}},"title":"CheckoutAccessTokenResponse"},"Tag":{"type":"string","description":"Max. length: 255 characters\n\nCustom data that you can add to this object.","title":"Tag"},"Address_SubPropsRequired":{"type":"object","properties":{"AddressLine1":{"type":"string","description":"The first line of the address."},"AddressLine2":{"type":"string","description":"The second line of the address."},"City":{"type":"string","description":"The city of the address."},"Region":{"type":"string","description":"Required if `Country` is US, CA, or MX. The region of the address."},"PostalCode":{"type":"string","description":"The postal code of the address. The postal code can contain the following characters: alphanumeric, dashes, and spaces."},"Country":{"type":"string","description":"Format: Two-letter country code ([ISO 3166-1 alpha-2 format](/api-reference/overview/data-formats))\n\nThe country of the address."}},"required":["AddressLine1","City","PostalCode","Country"],"description":"The postal address.","title":"Address_SubPropsRequired"},"CreateNaturalPayerSCARequest":{"type":"object","properties":{"FirstName":{"type":"string","description":"Min. length: 1; max. length: 100\n\nThe first name of the individual."},"LastName":{"type":"string","description":"Min. length: 1; max. length: 100\n\nThe last name of the individual."},"Tag":{"$ref":"#/components/schemas/Tag"},"Email":{"type":"string","description":"Format: A valid email address\n\nThe individual's email address."},"PhoneNumber":{"type":"string","description":"Format: International E.164 standard (preceded by plus sign and country code) or local format\n\nThe individual's phone number. The local format (recommended) requires `PhoneNumberCountry` to ensure correct formatting.\n\nIf present, the phone number forms part of card transaction data that is passed to issuers to improve authentication rates.\n\nFor users with `UserCategory` `OWNER` , the phone number is used to pre-populate the SCA session for them to confirm and receive an SMS OTP. If the individual modifies the phone number during the session, this data is not updated in the API."},"PhoneNumberCountry":{"type":"string","description":"Format: Two-letter country code ([ISO 3166-1 alpha-2 format](/api-reference/overview/data-formats))\n\nRequired if the `PhoneNumber` is provided in local format (recommended), to render the value in the E.164 standard."},"Address":{"$ref":"#/components/schemas/Address_SubPropsRequired"},"TermsAndConditionsAccepted":{"type":"boolean","description":"Whether the user has accepted Mangopay's terms and conditions (as defined by your contract, see the [T&Cs guide](/guides/users/terms) for details).\n\nMust be `true` if `UserCategory` is `OWNER`."},"UserCategory":{"type":"string","description":"**Allowed values:** `PAYER`\n\nThe [category](/guides/users/categories) of the user:\n- `PAYER` – User who can only make pay-ins to their wallets and transfers to other wallets (as well as refunds for pay-ins and transfers).\n- `OWNER` – User who can also receive transfers to their wallets. Owners are able to request [KYC verification](/guides/users/verification), which if successful gives them the `KYCLevel` of `REGULAR` and the ability to request payouts."}},"required":["FirstName","LastName","Email","TermsAndConditionsAccepted","UserCategory"],"description":"Request body for creating a Natural User with `UserCategory` `PAYER`.","title":"CreateNaturalPayerSCARequest"},"CreateNaturalOwnerSCARequest":{"type":"object","properties":{"FirstName":{"type":"string","description":"Min. length: 1; max. length: 100\n\nThe first name of the individual."},"LastName":{"type":"string","description":"Min. length: 1; max. length: 100\n\nThe last name of the individual."},"Tag":{"$ref":"#/components/schemas/Tag"},"Email":{"type":"string","description":"Format: A valid email address\n\nThe individual's email address."},"PhoneNumber":{"type":"string","description":"Format: International E.164 standard (preceded by plus sign and country code) or local format\n\nThe individual's phone number. The local format (recommended) requires `PhoneNumberCountry` to ensure correct formatting.\n\nIf present, the phone number forms part of card transaction data that is passed to issuers to improve authentication rates.\n\nFor users with `UserCategory` `OWNER` , the phone number is used to pre-populate the SCA session for them to confirm and receive an SMS OTP. If the individual modifies the phone number during the session, this data is not updated in the API."},"PhoneNumberCountry":{"type":"string","description":"Format: Two-letter country code ([ISO 3166-1 alpha-2 format](/api-reference/overview/data-formats))\n\nRequired if the `PhoneNumber` is provided in local format (recommended), to render the value in the E.164 standard."},"Address":{"$ref":"#/components/schemas/Address_SubPropsRequired"},"TermsAndConditionsAccepted":{"type":"boolean","description":"Whether the user has accepted Mangopay's terms and conditions (as defined by your contract, see the [T&Cs guide](/guides/users/terms) for details).\n\nMust be `true` if `UserCategory` is `OWNER`."},"UserCategory":{"type":"string","description":"**Allowed values:** `OWNER`\n\nThe [category](/guides/users/categories) of the user:\n- `PAYER` – User who can only make pay-ins to their wallets and transfers to other wallets (as well as refunds for pay-ins and transfers).\n- `OWNER` – User who can also receive transfers to their wallets. Owners are able to request [KYC verification](/guides/users/verification), which if successful gives them the `KYCLevel` of `REGULAR` and the ability to request payouts."},"Birthday":{"type":"integer","description":"Required if `UserCategory` is `OWNER`. \n\nThe date of birth of the individual. \n\n**Note:** This is a Unix timestamp in UTC. Ensure you convert your timezone to UTC to avoid midnight being interpreted as the day before."},"Nationality":{"type":"string","description":"Format: Two-letter country code ([ISO 3166-1 alpha-2 format](/api-reference/overview/data-formats)) \n\nRequired if `UserCategory` is `OWNER`. The nationality of the individual."},"CountryOfResidence":{"type":"string","description":"Format: Two-letter country code ([ISO 3166-1 alpha-2 format](/api-reference/overview/data-formats)) \n\nRequired if `UserCategory` is `OWNER`. The country of residence of the individual."},"Occupation":{"type":"string","description":"The occupation of the individual."},"IncomeRange":{"type":"integer","description":"**Allowed values:** `1`, `2`, `3`, `4`, `5`, `6`, `null`.\n\nThe bracket indicating the income of the individual. The brackets are:\n- 1: < 18K\n- 2: 18K - 30K\n- 3: 30K - 50K\n- 4: 50K - 80K\n- 5: 80K - 120K\n- 6: > 120K"},"ScaContext":{"type":"string","description":"**Possible values:** `USER_PRESENT`, `USER_NOT_PRESENT`\n\n**Default value:** `USER_PRESENT`\n\nThe SCA context of the request, which is **required** if the `OWNER` value is being assigned for `UserCategory`:\n- `USER_PRESENT` – The user is on session during `OWNER` account creation and can enroll in SCA at the same time. The platform must [redirect the user](/guides/sca/session) using the `PendingUserAction.RedirectUrl` returned so that the user can complete the SCA session.\n- `USER_NOT_PRESENT` – The platform has explicit permission from Mangopay to create the `OWNER` user account without simultaneous SCA enrollment (see [asynchronous SCA enrollment](/guides/sca/proxy-management#user-account-creation)).\n\n**Note:** On User endpoints, `ScaContext` is not returned in the API response as it does not form part of the User data – it's only related to the action being performed on the user."}},"required":["FirstName","LastName","Email","TermsAndConditionsAccepted","UserCategory","Birthday","Nationality","CountryOfResidence","ScaContext"],"description":"Request body for creating a Natural User with `UserCategory` `OWNER`.\n\nOwners must provide additional data, accept Mangopay's T&Cs, and enroll in SCA via the `PendingUserAction.RedirectUrl` returned.","title":"CreateNaturalOwnerSCARequest"},"CreateANaturalUserSCARequest":{"oneOf":[{"$ref":"#/components/schemas/CreateNaturalPayerSCARequest"},{"$ref":"#/components/schemas/CreateNaturalOwnerSCARequest"}],"title":"CreateANaturalUserSCARequest"},"Address":{"type":"object","properties":{"AddressLine1":{"type":"string","description":"The first line of the address."},"AddressLine2":{"type":"string","description":"The second line of the address."},"City":{"type":"string","description":"The city of the address."},"Region":{"type":"string","description":"Required if `Country` is US, CA, or MX. The region of the address."},"PostalCode":{"type":"string","description":"The postal code of the address. The postal code can contain the following characters: alphanumeric, dashes, and spaces."},"Country":{"type":"string","description":"Format: Two-letter country code ([ISO 3166-1 alpha-2 format](/api-reference/overview/data-formats))\n\nThe country of the address."}},"description":"The postal address.","title":"Address"},"NaturalUserScaResponsePendingUserAction":{"type":"object","properties":{"RedirectUrl":{"type":"string","description":"The URL to which to redirect the user to perform strong customer authentication (SCA) via a Mangopay-hosted webpage. This value is a variable and should not be hardcoded.\n\nThe SCA session link expires 10 minutes after it's generated.\n\n**Caution:** Before redirecting the user on this URL, you must add the query parameter `ReturnUrl`  with the percent-encoded URL to which you want the SCA session to return the user after authentication (whether successful or not).\n\nFor more details, see [How to redirect a user for an SCA session](/guides/sca/session#how-to-redirect-a-user-for-sca)."}},"description":"Object containing the `RedirectUrl` needed for SCA redirection if triggered by the API call (otherwise returned `null`).","title":"NaturalUserScaResponsePendingUserAction"},"Id":{"type":"string","description":"Max length: 128 characters (see [data formats](/api-reference/overview/data-formats) for details)\n\nThe unique identifier of the object.","title":"Id"},"CreationDate":{"type":"integer","description":"Unix timestamp (UTC) of the date and time the object was created.","title":"CreationDate"},"NaturalUserSCAResponse":{"type":"object","properties":{"FirstName":{"type":"string","description":"Min. length: 1; max. length: 100\n\nThe first name of the individual."},"LastName":{"type":"string","description":"Min. length: 1; max. length: 100\n\nThe last name of the individual."},"Birthday":{"type":["integer","null"],"description":"Returned `null` if `UserCategory` is `PAYER`.\n\nThe date of birth of the individual.\n\n**Note:** This is a Unix timestamp in UTC. Ensure you convert your timezone to UTC to avoid midnight being interpreted as the day before."},"Nationality":{"type":["string","null"],"description":"Returned `null` if `UserCategory` is `PAYER`.\n\nThe nationality of the individual."},"CountryOfResidence":{"type":["string","null"],"description":"Returned `null` if `UserCategory` is `PAYER`.\n\nThe country of residence of the individual."},"Occupation":{"type":["string","null"],"description":"Max. length: 255 characters\n\nThe occupation of the individual.\n\nReturned `null` if `UserCategory` is `PAYER`."},"IncomeRange":{"type":["integer","null"],"description":"Returned `null` if `UserCategory` is `PAYER`.\n\nThe bracket indicating the income of the individual. The brackets are:\n- 1: < 18K\n- 2: 18K - 30K\n- 3: 30K - 50K\n- 4: 50K - 80K\n- 5: 80K - 120K\n- 6: > 120K"},"ProofOfIdentity":{"type":["string","null"],"description":"The `Id` of the KYC Document whose `Type` is `IDENTITY_PROOF` if validated for the user. If no identity proof is validated, then this value is `null`."},"ProofOfAddress":{"type":["string","null"],"description":"The `Id` of the KYC Document whose `Type` is `ADDRESS_PROOF` if validated for the user. If no address proof is validated, then this value is `null`."},"Capacity":{"type":"string","description":"This is a deprecated parameter."},"PhoneNumber":{"type":["string","null"],"description":"Format: International E.164 standard (preceded by plus sign and country code) or local format\n\nThe individual's phone number. The local format (recommended) requires `PhoneNumberCountry` to ensure correct formatting.\n\nIf present, the phone number forms part of card transaction data that is passed to issuers to improve authentication rates.\n\nFor users with `UserCategory` `OWNER` , the phone number is used to pre-populate the SCA session for them to confirm and receive an SMS OTP. If the individual modifies the phone number during the session, this data is not updated in the API."},"PhoneNumberCountry":{"type":["string","null"],"description":"Format: Two-letter country code ([ISO 3166-1 alpha-2 format](/api-reference/overview/data-formats))\n\nRequired if the `PhoneNumber` is provided in local format (recommended), to render the value in the E.164 standard."},"Address":{"$ref":"#/components/schemas/Address"},"PendingUserAction":{"oneOf":[{"$ref":"#/components/schemas/NaturalUserScaResponsePendingUserAction"},{"type":"null"}],"description":"Object containing the `RedirectUrl` needed for SCA redirection if triggered by the API call (otherwise returned `null`)."},"Id":{"$ref":"#/components/schemas/Id"},"Tag":{"$ref":"#/components/schemas/Tag"},"CreationDate":{"$ref":"#/components/schemas/CreationDate"},"PersonType":{"type":"string","description":"**Returned values:** `NATURAL`, `LEGAL`\n\nThe type of the user:\n- `NATURAL` – Natural users are individuals (natural persons).\n- `LEGAL` – Legal users are legal entities (legal persons) like companies, non-profits, and sole proprietors.\n\nThe `PersonType` is defined by the endpoint used to create the user and can't be modified."},"Email":{"type":"string","description":"Format: A valid email address\n\nThe individual's email address."},"KYCLevel":{"type":"string","description":"**Default value:** `LIGHT`\n\n**Returned values:** `LIGHT`, `REGULAR`\n\nThe verification status of the user set by Mangopay:\n- `LIGHT` – Unverified, assigned by default to all users.\n- `REGULAR` – Verified, meaning the user has successfully completed the verification process and had the necessary documents validated by Mangopay. Only users whose `UserCategory` is `OWNER` can submit verification documents for validation. Only users whose `KYCLevel` is `REGULAR` can request payouts."},"TermsAndConditionsAccepted":{"type":"boolean","description":"Whether the user has accepted Mangopay's terms and conditions (as defined by your contract, see the [T&Cs guide](/guides/users/terms) for details).\n\nMust be `true` if `UserCategory` is `OWNER`."},"TermsAndConditionsAcceptedDate":{"type":["integer","null"],"description":"The date and time at which the `TermsAndConditionsAccepted` value was set to `true`.\n\nReturned `null` if `UserCategory` is `PAYER`."},"UserCategory":{"type":"string","description":"**Possible values:** `PAYER`, `OWNER`, `PLATFORM`\n\nThe [category](/guides/users/categories) of the user:\n- `PAYER` – User who can only make pay-ins to their wallets and transfers to other wallets (as well as refunds for pay-ins and transfers).\n- `OWNER` – User who can also receive transfers to their wallets. Owners are able to request [KYC verification](/guides/users/verification), which if successful gives them the `KYCLevel` of `REGULAR` and the ability to request payouts.\n- `PLATFORM` – Single specific user that represents the platform. The `PLATFORM` value is only assigned by Mangopay and may be used as part of the validated workflow implemented by the platform."},"UserStatus":{"type":"string","description":"**Returned values:** `PENDING_USER_ACTION`, `ACTIVE`, `CLOSED`\n\nThe status of the user:\n\n- `PENDING_USER_ACTION` – The user must enroll in SCA before they can become `ACTIVE`.\n- `ACTIVE` – The user account is active and the user can access Mangopay features.\n- `CLOSED` – The user account is permanently closed. This value is used by Mangopay to close an account following the procedure outlined in the terms and conditions."}},"description":"Response body for a Natural User. The same schema is returned for `PAYER` and `OWNER` users.\n\nIf `UserCategory` is `PAYER`, the following are returned `null`:\n- `Birthday`\n- `Nationality`\n- `CountryOfResidence`\n- `Occupation`\n- `IncomeRange`\n- `TermsAndConditionsAcceptedDate`","title":"NaturalUserSCAResponse"},"Error":{"type":"object","properties":{"Message":{"type":"string","description":"Description of the error."},"Type":{"type":"string","description":"The category of the error.\n"},"Id":{"type":"string","description":"Unique identifier of the error instance, useful when contacting Mangopay for support."},"Date":{"type":"number","format":"double","description":"Unix timestamp (UTC) of the date and time the error was triggered."},"errors":{"type":["object","null"],"additionalProperties":{"type":"string"},"description":"Object containing one or more field-level errors.\n"}},"description":"The error body typically returned by the Mangopay API for any non-2xx HTTP status code.\n","title":"Error"},"UpdateNaturalPayerSCARequest":{"type":"object","properties":{"FirstName":{"type":"string","description":"Min. length: 1; max. length: 100\n\nThe first name of the individual."},"LastName":{"type":"string","description":"Min. length: 1; max. length: 100\n\nThe last name of the individual."},"Tag":{"$ref":"#/components/schemas/Tag"},"Email":{"type":"string","description":"Format: A valid email address\n\nThe individual's email address.\n\n**Caution:** If `UserCategory` is `OWNER`, modifying this value means the user will be required to re-enroll the new value in SCA via the `PendingUserAction.RedirectUrl`. For more details see the [SCA guides](/guides/sca/users)."},"PhoneNumber":{"type":"string","description":"Format: International E.164 standard (preceded by plus sign and country code) or local format\n\nThe individual's phone number. The local format (recommended) requires `PhoneNumberCountry` to ensure correct formatting.\n\nIf present, the phone number forms part of card transaction data that is passed to issuers to improve authentication rates.\n\nFor users with `UserCategory` `OWNER` , the phone number is used to pre-populate the SCA session for them to confirm and receive an SMS OTP. If the individual modifies the phone number during the session, this data is not updated in the API."},"PhoneNumberCountry":{"type":"string","description":"Format: Two-letter country code ([ISO 3166-1 alpha-2 format](/api-reference/overview/data-formats))\n\nRequired if the `PhoneNumber` is provided in local format (recommended), to render the value in the E.164 standard."},"Address":{"$ref":"#/components/schemas/Address_SubPropsRequired"},"TermsAndConditionsAccepted":{"type":"boolean","description":"Whether the user has accepted Mangopay's terms and conditions (as defined by your contract, see the [T&Cs guide](/guides/users/terms) for details).\n\nMust be `true` if `UserCategory` is `OWNER`."},"UserCategory":{"type":"string","description":"**Allowed values:** `PAYER`\n\nThe [category](/guides/users/categories) of the user:\n- `PAYER` – User who can only make pay-ins to their wallets and transfers to other wallets (as well as refunds for pay-ins and transfers).\n- `OWNER` – User who can also receive transfers to their wallets. Owners are able to request [KYC verification](/guides/users/verification), which if successful gives them the `KYCLevel` of `REGULAR` and the ability to request payouts."}},"required":["TermsAndConditionsAccepted","UserCategory"],"description":"Request body for updating a Natural User with `UserCategory` `PAYER`.","title":"UpdateNaturalPayerSCARequest"},"UpdateNaturalOwnerSCARequest":{"type":"object","properties":{"FirstName":{"type":"string","description":"Min. length: 1; max. length: 100\n\nThe first name of the individual."},"LastName":{"type":"string","description":"Min. length: 1; max. length: 100\n\nThe last name of the individual."},"Tag":{"$ref":"#/components/schemas/Tag"},"Email":{"type":"string","description":"Format: A valid email address\n\nThe individual's email address.\n\n**Caution:** If `UserCategory` is `OWNER`, modifying this value means the user will be required to re-enroll the new value in SCA via the `PendingUserAction.RedirectUrl`. For more details see the [SCA guides](/guides/sca/users)."},"PhoneNumber":{"type":"string","description":"Format: International E.164 standard (preceded by plus sign and country code) or local format\n\nThe individual's phone number. The local format (recommended) requires `PhoneNumberCountry` to ensure correct formatting.\n\nIf present, the phone number forms part of card transaction data that is passed to issuers to improve authentication rates.\n\nFor users with `UserCategory` `OWNER` , the phone number is used to pre-populate the SCA session for them to confirm and receive an SMS OTP. If the individual modifies the phone number during the session, this data is not updated in the API."},"PhoneNumberCountry":{"type":"string","description":"Format: Two-letter country code ([ISO 3166-1 alpha-2 format](/api-reference/overview/data-formats))\n\nRequired if the `PhoneNumber` is provided in local format (recommended), to render the value in the E.164 standard."},"Address":{"$ref":"#/components/schemas/Address_SubPropsRequired"},"TermsAndConditionsAccepted":{"type":"boolean","description":"Whether the user has accepted Mangopay's terms and conditions (as defined by your contract, see the [T&Cs guide](/guides/users/terms) for details).\n\nMust be `true` if `UserCategory` is `OWNER`."},"UserCategory":{"type":"string","description":"**Allowed values:** `OWNER`\n\nThe [category](/guides/users/categories) of the user:\n- `PAYER` – User who can only make pay-ins to their wallets and transfers to other wallets (as well as refunds for pay-ins and transfers).\n- `OWNER` – User who can also receive transfers to their wallets. Owners are able to request [KYC verification](/guides/users/verification), which if successful gives them the `KYCLevel` of `REGULAR` and the ability to request payouts."},"Birthday":{"type":"integer","description":"The date of birth of the individual.\n\n**Note:** This is a Unix timestamp in UTC. Ensure you convert your timezone to UTC to avoid midnight being interpreted as the day before."},"Nationality":{"type":"string","description":"Format: Two-letter country code ([ISO 3166-1 alpha-2 format](/api-reference/overview/data-formats))\n\nThe nationality of the individual."},"CountryOfResidence":{"type":"string","description":"Format: Two-letter country code ([ISO 3166-1 alpha-2 format](/api-reference/overview/data-formats))\n\nThe country of residence of the individual."},"Occupation":{"type":"string","description":"Max. length: 255 characters\n\nThe occupation of the individual."},"IncomeRange":{"type":"integer","description":"**Allowed values:** `1`, `2`, `3`, `4`, `5`, `6`, `null`.\n\nThe bracket indicating the income of the individual. The brackets are:\n- 1: < 18K\n- 2: 18K - 30K\n- 3: 30K - 50K\n- 4: 50K - 80K\n- 5: 80K - 120K\n- 6: > 120K"},"ScaContext":{"type":"string","description":"**Possible values:** `USER_PRESENT`, `USER_NOT_PRESENT`\n\n**Default value:** `USER_PRESENT`\n\nThe SCA context of the request, which is **required** if the user's `UserCategory` is `OWNER`:\n- `USER_PRESENT` – The user is taking the SCA-triggering action of updating account information and must re-enroll in SCA. The platform must [redirect the user](/guides/sca/session) using the `PendingUserAction.RedirectUrl` returned so that the user can complete the SCA session.\n- `USER_NOT_PRESENT` – The platform is taking the action under proxy from the user and the user has previously given consent to Mangopay (via the SCA hosted experience) to allow the action. If the user has not given (or has revoked) their consent, then `USER_NOT_PRESENT` returns a 403 error.\n\nRead more about [managing proxy and user consent](/guides/sca/proxy-management) **&rarr;**\n\n**Note:** On User endpoints, `ScaContext` is not returned in the API response as it does not form part of the User data – it's only related to the action being performed on the user."}},"required":["TermsAndConditionsAccepted","UserCategory"],"description":"Request body for updating a Natural User with `UserCategory` `OWNER`.\n\nModifying `Email`, `PhoneNumber` or `PhoneNumberCountry` requires re-enrollment in SCA via the `PendingUserAction.RedirectUrl` returned.","title":"UpdateNaturalOwnerSCARequest"},"UpdateANaturalUserSCARequest":{"oneOf":[{"$ref":"#/components/schemas/UpdateNaturalPayerSCARequest"},{"$ref":"#/components/schemas/UpdateNaturalOwnerSCARequest"}],"title":"UpdateANaturalUserSCARequest"},"CategorizeANaturalUserRequest":{"type":"object","properties":{"UserCategory":{"type":"string","description":"**Allowed values:** `OWNER`\n\nThe new category of the user, which must be `OWNER`."},"TermsAndConditionsAccepted":{"type":"boolean","description":"**Allowed values:** `true`\n\nWhether the user has accepted Mangopay's terms and conditions (as defined by your contract, see the [T&Cs guide](/guides/users/terms) for details)."},"Email":{"type":"string","description":"Format: A valid email address\n\nThe individual's email address."},"Birthday":{"type":"integer","description":"The date of birth of the individual.\n\n**Note:** This is a Unix timestamp in UTC. Ensure you convert your timezone to UTC to avoid midnight being interpreted as the day before."},"Nationality":{"type":"string","description":"Format: Two-letter country code ([ISO 3166-1 alpha-2 format](/api-reference/overview/data-formats))\n\nThe nationality of the individual."},"CountryOfResidence":{"type":"string","description":"Format: Two-letter country code ([ISO 3166-1 alpha-2 format](/api-reference/overview/data-formats))\n\nThe country of residence of the individual."},"PhoneNumber":{"type":"string","description":"Format: International E.164 standard (preceded by plus sign and country code) or local format\n\nThe individual's phone number. The local format (recommended) requires `PhoneNumberCountry` to ensure correct formatting.\n\nIf present, the phone number forms part of card transaction data that is passed to issuers to improve authentication rates.\n\nFor users with `UserCategory` `OWNER` , the phone number is used to pre-populate the SCA session for them to confirm and receive an SMS OTP. If the individual modifies the phone number during the session, this data is not updated in the API."},"PhoneNumberCountry":{"type":"string","description":"Format: Two-letter country code ([ISO 3166-1 alpha-2 format](/api-reference/overview/data-formats))\n\nRequired if the `PhoneNumber` is provided in local format (recommended), to render the value in the E.164 standard."},"ScaContext":{"type":"string","description":"**Possible values:** `USER_PRESENT`, `USER_NOT_PRESENT`\n\n**Default value:** `USER_PRESENT`\n\nThe SCA context of the request, which is **required** if the `OWNER` value is being assigned for `UserCategory`:\n- `USER_PRESENT` – The user is on session during `OWNER` account creation and can enroll in SCA at the same time. The platform must [redirect the user](/guides/sca/session) using the `PendingUserAction.RedirectUrl` returned so that the user can complete the SCA session.\n- `USER_NOT_PRESENT` – The platform has explicit permission from Mangopay to create the `OWNER` user account without simultaneous SCA enrollment.\n\nRead more about [asynchronous SCA enrollment](/guides/sca/proxy-management#user-account-creation) **&rarr;**\n\n**Note:** On User endpoints, `ScaContext` is not returned in the API response as it does not form part of the User data – it's only related to the action being performed on the user."}},"required":["UserCategory","TermsAndConditionsAccepted","Birthday","Nationality","CountryOfResidence"],"title":"CategorizeANaturalUserRequest"},"LegalRepresentative_CreatePayer_Request":{"type":"object","properties":{"FirstName":{"type":"string","description":"Min. length: 1; max. length: 100 \n\nThe first name of the legal representative."},"LastName":{"type":"string","description":"Min. length: 1; max. length: 100 \n\nThe last name of the legal representative."},"PhoneNumber":{"type":"string","description":"Format: International E.164 standard (preceded by plus sign and country code) or local format. \n\nThe legal representative's phone number. The local format (recommended) requires `PhoneNumberCountry` to ensure correct formatting.\n\nIf present, the phone number forms part of card transaction data that is passed to issuers to improve authentication rates."},"PhoneNumberCountry":{"type":"string","description":"Format: Two-letter country code ([ISO 3166-1 alpha-2 format](/api-reference/overview/data-formats)). \n\nRequired if the `PhoneNumber` is provided in local format (recommended), to render the value in the E.164 standard."}},"required":["FirstName","LastName"],"description":"Information about the legal representative declared for a `PAYER` Legal User.","title":"LegalRepresentative_CreatePayer_Request"},"CreateALegalPayerSCARequest":{"type":"object","properties":{"Name":{"type":"string","description":"Max. length: 255 characters\n\nThe registered legal name of the entity. The `Name` value should be the one registered with the relevant national authority."},"LegalPersonType":{"type":"string","description":"**Allowed values:** BUSINESS, PARTNERSHIP, ORGANIZATION, SOLETRADER\n\nThe type of legal user. For information on which `LegalPersonType` to use for a particular local legal structure, see the <a href=\"/guides/users/verification/requirements\" target=\"_blank\">verification requirements</a>.\n\n**Caution:** Modification of the `LegalPersonType` may result in a <a href=\"/guides/users/verification/downgrade\" target=\"_blank\">verification downgrade</a>."},"HeadquartersAddress":{"$ref":"#/components/schemas/Address_SubPropsRequired"},"LegalRepresentativeAddress":{"$ref":"#/components/schemas/Address_SubPropsRequired"},"Tag":{"$ref":"#/components/schemas/Tag"},"Email":{"type":"string","description":"Format: A valid email address\n\nThe email address for the entity."},"TermsAndConditionsAccepted":{"type":"boolean","description":"Whether the user has accepted Mangopay's terms and conditions (as defined by your contract, see the [T&Cs guide](/guides/users/terms) for details).\n\nMust be `true` if `UserCategory` is `OWNER`."},"UserCategory":{"type":"string","description":"**Allowed values:** `PAYER`\n\nThe [category](/guides/users/categories) of the user:\n- `PAYER` – User who can only make pay-ins to their wallets and transfers to other wallets (as well as refunds for pay-ins and transfers).\n- `OWNER` – User who can also receive transfers to their wallets. Owners are able to request [KYC verification](/guides/users/verification), which if successful gives them the `KYCLevel` of `REGULAR` and the ability to request payouts."},"LegalRepresentative":{"$ref":"#/components/schemas/LegalRepresentative_CreatePayer_Request"},"CompanyNumber":{"type":"string","description":"Has no effect if `UserCategory` is `PAYER`."}},"required":["Name","LegalPersonType","Email","TermsAndConditionsAccepted","UserCategory","LegalRepresentative"],"description":"Request body for creating a Legal User with `UserCategory` `PAYER`.","title":"CreateALegalPayerSCARequest"},"LegalRepresentative_CreateOwner_Request":{"type":"object","properties":{"FirstName":{"type":"string","description":"Min. length: 1; max. length: 100 \n\nThe first name of the legal representative."},"LastName":{"type":"string","description":"Min. length: 1; max. length: 100 \n\nThe last name of the legal representative."},"Birthday":{"type":"integer","description":"Required if `UserCategory` is `OWNER`. \n\nThe date of birth of the legal representative. \n\n**Note:** This is a Unix timestamp in UTC. Ensure you convert your timezone to UTC to avoid midnight being interpreted as the day before."},"Nationality":{"type":"string","description":"Format: Two-letter country code ([ISO 3166-1 alpha-2 format](/api-reference/overview/data-formats)). \n\nRequired if `UserCategory` is `OWNER`.\n\nThe nationality of the legal representative."},"CountryOfResidence":{"type":"string","description":"Format: Two-letter country code ([ISO 3166-1 alpha-2 format](/api-reference/overview/data-formats)). \n\nRequired if `UserCategory` is `OWNER`. \n\nThe country of residence of the legal representative."},"Email":{"type":"string","description":"Format: A valid email address\n\nRequired if `UserCategory` is `OWNER`. \n\nThe legal representative's email address. SCA uses this email address to build a [behavioral biometrics profile](/guides/sca/factors#email-confirmation-behavioral-biometrics) and as a backup communication channel."},"PhoneNumber":{"type":"string","description":"Format: International E.164 standard (preceded by plus sign and country code) or local format. \n\nThe legal representative's phone number. The local format (recommended) requires `PhoneNumberCountry` to ensure correct formatting.\n\nIf present, the phone number forms part of card transaction data that is passed to issuers to improve authentication rates.\n\nFor users with `UserCategory` `OWNER` , the phone number is used to pre-populate the SCA session for them to confirm and receive an SMS OTP. If the individual modifies the phone number during the session, this data is not updated in the API."},"PhoneNumberCountry":{"type":"string","description":"Format: Two-letter country code ([ISO 3166-1 alpha-2 format](/api-reference/overview/data-formats)). \n\nRequired if the `PhoneNumber` is provided in local format (recommended), to render the value in the E.164 standard."}},"required":["FirstName","LastName","Birthday","Nationality","CountryOfResidence","Email"],"description":"Information about the legal representative declared for an `OWNER` Legal User.","title":"LegalRepresentative_CreateOwner_Request"},"CreateALegalOwnerSCARequest":{"type":"object","properties":{"Name":{"type":"string","description":"Max. length: 255 characters\n\nThe registered legal name of the entity. The `Name` value should be the one registered with the relevant national authority."},"LegalPersonType":{"type":"string","description":"**Allowed values:** BUSINESS, PARTNERSHIP, ORGANIZATION, SOLETRADER\n\nThe type of legal user. For information on which `LegalPersonType` to use for a particular local legal structure, see the <a href=\"/guides/users/verification/requirements\" target=\"_blank\">verification requirements</a>.\n\n**Caution:** Modification of the `LegalPersonType` may result in a <a href=\"/guides/users/verification/downgrade\" target=\"_blank\">verification downgrade</a>."},"HeadquartersAddress":{"$ref":"#/components/schemas/Address_SubPropsRequired"},"LegalRepresentativeAddress":{"$ref":"#/components/schemas/Address_SubPropsRequired"},"Tag":{"$ref":"#/components/schemas/Tag"},"Email":{"type":"string","description":"Format: A valid email address\n\nThe email address for the entity."},"TermsAndConditionsAccepted":{"type":"boolean","description":"Whether the user has accepted Mangopay's terms and conditions (as defined by your contract, see the [T&Cs guide](/guides/users/terms) for details).\n\nMust be `true` if `UserCategory` is `OWNER`."},"UserCategory":{"type":"string","description":"**Allowed values:** `OWNER`\n\nThe [category](/guides/users/categories) of the user:\n- `PAYER` – User who can only make pay-ins to their wallets and transfers to other wallets (as well as refunds for pay-ins and transfers).\n- `OWNER` – User who can also receive transfers to their wallets. Owners are able to request [KYC verification](/guides/users/verification), which if successful gives them the `KYCLevel` of `REGULAR` and the ability to request payouts."},"LegalRepresentative":{"$ref":"#/components/schemas/LegalRepresentative_CreateOwner_Request"},"CompanyNumber":{"type":"string","description":"Required if `LegalPersonType` is `BUSINESS`.\n\nThe registration number of the entity, assigned by the relevant national authority. For information on the expected format for a specific country, see the [Company number](/guides/users/verification/company-number) guide. To validate the format of a number before submitting documents for verification, use [POST Validate the format of User data](/api-reference/user-data-format/validate-user-data-format)."},"ScaContext":{"type":"string","description":"**Possible values:** `USER_PRESENT`, `USER_NOT_PRESENT`\n\n**Default value:** `USER_PRESENT`\n\nThe SCA context of the request, which is **required** if the `OWNER` value is being assigned for `UserCategory`:\n- `USER_PRESENT` – The user is on session during `OWNER` account creation and can enroll in SCA at the same time. The platform must [redirect the user](/guides/sca/session) using the `PendingUserAction.RedirectUrl` returned so that the user can complete the SCA session.\n- `USER_NOT_PRESENT` – The platform has explicit permission from Mangopay to create the `OWNER` user account without simultaneous SCA enrollment.\n\nRead more about [asynchronous SCA enrollment](/guides/sca/proxy-management#user-account-creation) **&rarr;**\n\n**Note:** On User endpoints, `ScaContext` is not returned in the API response as it does not form part of the User data – it's only related to the action being performed on the user."}},"required":["Name","LegalPersonType","HeadquartersAddress","Email","TermsAndConditionsAccepted","UserCategory","LegalRepresentative","ScaContext"],"description":"Request body for creating a Legal User with `UserCategory` `OWNER`.\n\nOwners must provide additional data, accept Mangopay's T&Cs, and enroll in SCA via the `PendingUserAction.RedirectUrl` returned.","title":"CreateALegalOwnerSCARequest"},"CreateALegalUserSCARequest":{"oneOf":[{"$ref":"#/components/schemas/CreateALegalPayerSCARequest"},{"$ref":"#/components/schemas/CreateALegalOwnerSCARequest"}],"title":"CreateALegalUserSCARequest"},"LegalRepresentative_Response":{"type":"object","properties":{"FirstName":{"type":"string","description":"Min. length: 1; max. length: 100\n\nThe first name of the individual."},"LastName":{"type":"string","description":"Min. length: 1; max. length: 100\n\nThe last name of the individual."},"ProofOfIdentity":{"type":["string","null"],"description":"The `Id` of the KYC Document whose `Type` is `IDENTITY_PROOF` if validated for the user. If no identity proof is validated, then this value is `null`."},"Birthday":{"type":["integer","null"],"description":"Returned `null` if `UserCategory` is `PAYER`.\n\nThe date of birth of the individual.\n\n**Note:** This is a Unix timestamp in UTC. Ensure you convert your timezone to UTC to avoid midnight being interpreted as the day before."},"Nationality":{"type":["string","null"],"description":"Returned `null` if `UserCategory` is `PAYER`.\n\nThe nationality of the individual."},"CountryOfResidence":{"type":["string","null"],"description":"Returned `null` if `UserCategory` is `PAYER`.\n\nThe country of residence of the individual."},"Email":{"type":["string","null"],"description":"Format: A valid email address\n\nRequired if `UserCategory` is `OWNER`. Returned `null` if `UserCategory` is `PAYER`.\n\nThe individual's email address. For `OWNER` users, SCA uses this email address to build a [behavioral biometrics profile](/guides/sca/factors#email-confirmation-behavioral-biometrics) and as a backup communication channel."},"PhoneNumberCountry":{"type":["string","null"],"description":"Format: Two-letter country code ([ISO 3166-1 alpha-2 format](/api-reference/overview/data-formats))\n\nRequired if the `PhoneNumber` is provided in local format (recommended), to render the value in the E.164 standard."},"PhoneNumber":{"type":["string","null"],"description":"Format: International E.164 standard (preceded by plus sign and country code) or local format\n\nThe individual's phone number. The local format (recommended) requires `PhoneNumberCountry` to ensure correct formatting.\n\nIf present, the phone number forms part of card transaction data that is passed to issuers to improve authentication rates.\n\nFor users with `UserCategory` `OWNER` , the phone number is used to pre-populate the SCA session for them to confirm and receive an SMS OTP. If the individual modifies the phone number during the session, this data is not updated in the API."}},"description":"Information about the legal representative declared for the user.","title":"LegalRepresentative_Response"},"LegalUserScaResponsePendingUserAction":{"type":"object","properties":{"RedirectUrl":{"type":"string","description":"The URL to which to redirect the user to perform strong customer authentication (SCA) via a Mangopay-hosted webpage. This value is a variable and should not be hardcoded.\n\nThe SCA session link expires 10 minutes after it's generated.\n\n**Caution:** Before redirecting the user on this URL, you must add the query parameter `ReturnUrl`  with the percent-encoded URL to which you want the SCA session to return the user after authentication (whether successful or not).\n\nFor more details, see [How to redirect a user for an SCA session](/guides/sca/session#how-to-redirect-a-user-for-sca)."}},"description":"Object containing the `RedirectUrl` needed for SCA redirection if triggered by the API call (otherwise returned `null`).","title":"LegalUserScaResponsePendingUserAction"},"LegalUserScaResponseHeadquartersAddress":{"type":"object","properties":{"AddressLine1":{"type":["string","null"],"description":"Max. length: 255 characters\n\nThe first line of the address."},"AddressLine2":{"type":["string","null"],"description":"Max. length: 255 characters\n\nThe second line of the address."},"City":{"type":["string","null"],"description":"Max. length: 255 characters\n\nThe city of the address."},"Region":{"type":["string","null"],"description":"Max. length: 255 characters\n\nThe region of the address. This field is optional except if the `Country` is US, CA, or MX."},"PostalCode":{"type":["string","null"],"description":"Max. length: 255 characters\n\nThe postal code of the address. The postal code can contain the following characters: alphanumeric, dashes, and spaces."},"Country":{"type":["string","null"],"description":"Format: Two-letter country code ([ISO 3166-1 alpha-2 format](/api-reference/overview/data-formats))\n\nThe country of the address."}},"description":"The legally registered address of the entity's administrative center.\nThis object's sub-parameters are `null` if the `UserCategory` is `PAYER`.","title":"LegalUserScaResponseHeadquartersAddress"},"LegalUserScaResponseLegalRepresentativeAddress":{"type":"object","properties":{"AddressLine1":{"type":["string","null"],"description":"Max. length: 255 characters\n\nThe first line of the address."},"AddressLine2":{"type":["string","null"],"description":"Max. length: 255 characters\n\nThe second line of the address."},"City":{"type":["string","null"],"description":"Max. length: 255 characters\n\nThe city of the address."},"Region":{"type":["string","null"],"description":"Max. length: 255 characters\n\nThe region of the address. This field is optional except if the `Country` is US, CA, or MX."},"PostalCode":{"type":["string","null"],"description":"Max. length: 255 characters\n\nThe postal code of the address. The postal code can contain the following characters: alphanumeric, dashes, and spaces."},"Country":{"type":["string","null"],"description":"Format: Two-letter country code ([ISO 3166-1 alpha-2 format](/api-reference/overview/data-formats))\n\nThe country of the address."}},"description":"The address of the entity's legal representative.","title":"LegalUserScaResponseLegalRepresentativeAddress"},"LegalUserSCAResponse":{"type":"object","properties":{"Name":{"type":"string","description":"Max. length: 255 characters\n\nThe registered legal name of the entity. The `Name` value should be the one registered with the relevant national authority."},"LegalPersonType":{"type":"string","description":"**Returned values:** BUSINESS, PARTNERSHIP, ORGANIZATION, SOLETRADER\n\nThe type of legal user. For information on which `LegalPersonType` to use for a particular local legal structure, see the <a href=\"/guides/users/verification/requirements\" target=\"_blank\">verification requirements</a>.\n\n**Caution:** Modification of the `LegalPersonType` may result in a <a href=\"/guides/users/verification/downgrade\" target=\"_blank\">verification downgrade</a>."},"LegalRepresentative":{"$ref":"#/components/schemas/LegalRepresentative_Response"},"ProofOfRegistration":{"type":["string","null"],"description":"The `Id` of the KYC Document whose `Type` is `REGISTRATION_PROOF` if validated for the user. If no registration proof is validated, then this value is `null`."},"ShareholderDeclaration":{"type":["string","null"],"description":"The `Id` of the KYC Document whose `Type` is `SHAREHOLDERS_DECLARATION` if validated for the user. If no Shareholder Declaration is validated, then this value is `null`."},"Statute":{"type":["string","null"],"description":"The `Id` of the KYC Document whose `Type` is `ARTICLES_OF_ASSOCIATION` if validated for the user. If no articles of association document is validated, then this value is `null`."},"CompanyNumber":{"type":["string","null"],"description":"Required if `UserCategory` is `OWNER` and `LegalPersonType` is `BUSINESS`. Returned `null` if `UserCategory` is `PAYER`.\n\nThe registration number of the entity, assigned by the relevant national authority. For information on the expected format for a specific country, see the [Company number](/guides/users/verification/company-number) guide. To validate the format of a number before submitting documents for verification, use [POST Validate the format of User data](/api-reference/user-data-format/validate-user-data-format)."},"PendingUserAction":{"oneOf":[{"$ref":"#/components/schemas/LegalUserScaResponsePendingUserAction"},{"type":"null"}],"description":"Object containing the `RedirectUrl` needed for SCA redirection if triggered by the API call (otherwise returned `null`)."},"HeadquartersAddress":{"$ref":"#/components/schemas/LegalUserScaResponseHeadquartersAddress","description":"The legally registered address of the entity's administrative center.\nThis object's sub-parameters are `null` if the `UserCategory` is `PAYER`."},"LegalRepresentativeAddress":{"$ref":"#/components/schemas/LegalUserScaResponseLegalRepresentativeAddress","description":"The address of the entity's legal representative."},"Id":{"$ref":"#/components/schemas/Id"},"Tag":{"$ref":"#/components/schemas/Tag"},"CreationDate":{"$ref":"#/components/schemas/CreationDate"},"PersonType":{"type":"string","description":"**Returned values:** NATURAL, LEGAL\n\nThe type of the user:\n- `NATURAL` – Natural users are individuals (natural persons).\n- `LEGAL` – Legal users are legal entities (legal persons) like companies, non-profits, and sole proprietors.\n\nThe `PersonType` is defined by the endpoint used to create the user and can't be modified."},"Email":{"type":"string","description":"Format: A valid email address\n\nThe email address for the entity."},"KYCLevel":{"type":"string","description":"**Default value:** `LIGHT`\n\n**Returned values:** `LIGHT`, `REGULAR`\n\nThe verification status of the user set by Mangopay:\n- `LIGHT` – Unverified, assigned by default to all users.\n- `REGULAR` – Verified, meaning the user has successfully completed the verification process and had the necessary documents validated by Mangopay. Only users whose `UserCategory` is `OWNER` can submit verification documents for validation. Only users whose `KYCLevel` is `REGULAR` can request payouts."},"TermsAndConditionsAccepted":{"type":"boolean","description":"Whether the user has accepted Mangopay's terms and conditions (as defined by your contract, see the [T&Cs guide](/guides/users/terms) for details).\n\nMust be `true` if `UserCategory` is `OWNER`."},"TermsAndConditionsAcceptedDate":{"type":["integer","null"],"description":"The date and time at which the `TermsAndConditionsAccepted` value was set to `true`.\n\nReturned `null` if `UserCategory` is `PAYER`."},"UserCategory":{"type":"string","description":"**Possible values:** `PAYER`, `OWNER`, `PLATFORM`\n\nThe [category](/guides/users/categories) of the user:\n- `PAYER` – User who can only make pay-ins to their wallets and transfers to other wallets (as well as refunds for pay-ins and transfers).\n- `OWNER` – User who can also receive transfers to their wallets. Owners are able to request [KYC verification](/guides/users/verification), which if successful gives them the `KYCLevel` of `REGULAR` and the ability to request payouts.\n- `PLATFORM` – Single specific user that represents the platform. The `PLATFORM` value is only assigned by Mangopay and may be used as part of the validated workflow implemented by the platform."},"UserStatus":{"type":"string","description":"**Returned values:** `PENDING_USER_ACTION`, `ACTIVE`, `CLOSED`\n\nThe status of the user:\n\n- `PENDING_USER_ACTION` – The user must enroll in SCA before they can become `ACTIVE`.\n- `ACTIVE` – The user account is active and the user can access Mangopay features.\n- `CLOSED` – The user account is permanently closed. This value is used by Mangopay to close an account following the procedure outlined in the terms and conditions."}},"description":"Response body for a Legal User. The same schema is returned for `PAYER` and `OWNER` users.\n\nIf `UserCategory` is `PAYER`, the following are returned `null`:\n- `LegalRepresentative.Birthday`\n- `LegalRepresentative.Nationality`\n- `LegalRepresentative.CountryOfResidence`\n- `LegalRepresentative.Email`\n- All `HeadquartersAddress` sub-properties\n- `CompanyNumber`\n- `TermsAndConditionsAcceptedDate`","title":"LegalUserSCAResponse"},"LegalRepresentative_UpdatePayer_Request":{"type":"object","properties":{"FirstName":{"type":"string","description":"Min. length: 1; max. length: 100\n\nThe first name of the individual."},"LastName":{"type":"string","description":"Min. length: 1; max. length: 100\n\nThe last name of the individual."},"Email":{"type":"string","description":"Format: A valid email address\n\nThe individual's email address.\n\n**Caution:** If `UserCategory` is `OWNER`, modifying this value means the user will be required to re-enroll the new value in SCA via the `PendingUserAction.RedirectUrl`. For more details see the [SCA guides](/guides/sca/users)."},"PhoneNumber":{"type":"string","description":"Format: International E.164 standard (preceded by plus sign and country code) or local format\n\nThe individual's phone number. The local format (recommended) requires `PhoneNumberCountry` to ensure correct formatting.\n\nIf present, the phone number forms part of card transaction data that is passed to issuers to improve authentication rates.\n\nFor users with `UserCategory` `OWNER` , the phone number is used to pre-populate the SCA session for them to confirm and receive an SMS OTP. If the individual modifies the phone number during the session, this data is not updated in the API."},"PhoneNumberCountry":{"type":"string","description":"Format: Two-letter country code ([ISO 3166-1 alpha-2 format](/api-reference/overview/data-formats))\n\nRequired if the `PhoneNumber` is provided in local format (recommended), to render the value in the E.164 standard."}},"description":"Information about the legal representative declared for the user.","title":"LegalRepresentative_UpdatePayer_Request"},"UpdateLegalPayerSCARequest":{"type":"object","properties":{"Name":{"type":"string","description":"Max. length: 255 characters\n\nThe registered legal name of the entity. The `Name` value should be the one registered with the relevant national authority."},"LegalPersonType":{"type":"string","description":"**Allowed values:** BUSINESS, PARTNERSHIP, ORGANIZATION, SOLETRADER\n\nThe type of legal user. For information on which `LegalPersonType` to use for a particular local legal structure, see the <a href=\"/guides/users/verification/requirements\" target=\"_blank\">verification requirements</a>.\n\n**Caution:** Modification of the `LegalPersonType` may result in a <a href=\"/guides/users/verification/downgrade\" target=\"_blank\">verification downgrade</a>."},"LegalRepresentative":{"$ref":"#/components/schemas/LegalRepresentative_UpdatePayer_Request"},"LegalRepresentativeAddress":{"$ref":"#/components/schemas/Address_SubPropsRequired"},"Tag":{"$ref":"#/components/schemas/Tag"},"Email":{"type":"string","description":"Format: A valid email address\n\nThe email address for the entity."},"TermsAndConditionsAccepted":{"type":"boolean","description":"Whether the user has accepted Mangopay's terms and conditions (as defined by your contract, see the [T&Cs guide](/guides/users/terms) for details).\n\nMust be `true` if `UserCategory` is `OWNER`."},"UserCategory":{"type":"string","description":"**Allowed values:** `PAYER`\n\nThe [category](/guides/users/categories) of the user:\n- `PAYER` – User who can only make pay-ins to their wallets and transfers to other wallets (as well as refunds for pay-ins and transfers).\n- `OWNER` – User who can also receive transfers to their wallets. Owners are able to request [KYC verification](/guides/users/verification), which if successful gives them the `KYCLevel` of `REGULAR` and the ability to request payouts."}},"required":["TermsAndConditionsAccepted","UserCategory"],"description":"Request body for updating a Legal User with `UserCategory` `PAYER`.","title":"UpdateLegalPayerSCARequest"},"LegalRepresentative_UpdateOwner_Request":{"type":"object","properties":{"FirstName":{"type":"string","description":"Min. length: 1; max. length: 100\n\nThe first name of the individual."},"LastName":{"type":"string","description":"Min. length: 1; max. length: 100\n\nThe last name of the individual."},"Email":{"type":"string","description":"Format: A valid email address\n\nThe individual's email address.\n\n**Caution:** If `UserCategory` is `OWNER`, modifying this value means the user will be required to re-enroll the new value in SCA via the `PendingUserAction.RedirectUrl`. For more details see the [SCA guides](/guides/sca/users)."},"PhoneNumber":{"type":"string","description":"Format: International E.164 standard (preceded by plus sign and country code) or local format\n\nThe individual's phone number. The local format (recommended) requires `PhoneNumberCountry` to ensure correct formatting.\n\nIf present, the phone number forms part of card transaction data that is passed to issuers to improve authentication rates.\n\nFor users with `UserCategory` `OWNER` , the phone number is used to pre-populate the SCA session for them to confirm and receive an SMS OTP. If the individual modifies the phone number during the session, this data is not updated in the API."},"PhoneNumberCountry":{"type":"string","description":"Format: Two-letter country code ([ISO 3166-1 alpha-2 format](/api-reference/overview/data-formats))\n\nRequired if the `PhoneNumber` is provided in local format (recommended), to render the value in the E.164 standard."},"Birthday":{"type":"integer","description":"Required if `UserCategory` is `OWNER`. Returned `null` if `UserCategory` is `PAYER`.\n\nThe date of birth of the individual.\n\n**Note:** This is a Unix timestamp in UTC. Ensure you convert your timezone to UTC to avoid midnight being interpreted as the day before."},"Nationality":{"type":"string","description":"Format: Two-letter country code ([ISO 3166-1 alpha-2 format](/api-reference/overview/data-formats))\n\nRequired if `UserCategory` is `OWNER`. Returned `null` if `UserCategory` is `PAYER`.\n\nThe nationality of the individual."},"CountryOfResidence":{"type":"string","description":"Format: Two-letter country code ([ISO 3166-1 alpha-2 format](/api-reference/overview/data-formats))\n\nRequired if `UserCategory` is `OWNER`. Returned `null` if `UserCategory` is `PAYER`.\n\nThe country of residence of the individual."}},"description":"Information about the legal representative declared for the user.","title":"LegalRepresentative_UpdateOwner_Request"},"UpdateLegalOwnerScaRequestHeadquartersAddress":{"type":"object","properties":{"AddressLine1":{"type":"string","description":"Max. length: 255 characters\n\nThe first line of the address."},"AddressLine2":{"type":"string","description":"Max. length: 255 characters\n\nThe second line of the address."},"City":{"type":"string","description":"Max. length: 255 characters\n\nThe city of the address."},"Region":{"type":"string","description":"Max. length: 255 characters\n\nRequired if `Country` is US, CA, or MX.\n\nThe region of the address."},"PostalCode":{"type":"string","description":"Max. length: 255 characters\n\nThe postal code of the address. The postal code can contain the following characters: alphanumeric, dashes, and spaces."},"Country":{"type":"string","description":"The country of the address."}},"required":["AddressLine1","City","PostalCode","Country"],"description":"Required if `UserCategory` is `OWNER`. Child parameters returned `null` if `UserCategory` is `PAYER`.\n\nThe legally registered address of the entity's administrative center.","title":"UpdateLegalOwnerScaRequestHeadquartersAddress"},"UpdateLegalOwnerSCARequest":{"type":"object","properties":{"Name":{"type":"string","description":"Max. length: 255 characters\n\nThe registered legal name of the entity. The `Name` value should be the one registered with the relevant national authority."},"LegalPersonType":{"type":"string","description":"**Allowed values:** BUSINESS, PARTNERSHIP, ORGANIZATION, SOLETRADER\n\nThe type of legal user. For information on which `LegalPersonType` to use for a particular local legal structure, see the <a href=\"/guides/users/verification/requirements\" target=\"_blank\">verification requirements</a>.\n\n**Caution:** Modification of the `LegalPersonType` may result in a <a href=\"/guides/users/verification/downgrade\" target=\"_blank\">verification downgrade</a>."},"LegalRepresentative":{"$ref":"#/components/schemas/LegalRepresentative_UpdateOwner_Request"},"LegalRepresentativeAddress":{"$ref":"#/components/schemas/Address_SubPropsRequired"},"Tag":{"$ref":"#/components/schemas/Tag"},"Email":{"type":"string","description":"Format: A valid email address\n\nThe email address for the entity."},"TermsAndConditionsAccepted":{"type":"boolean","description":"Whether the user has accepted Mangopay's terms and conditions (as defined by your contract, see the [T&Cs guide](/guides/users/terms) for details).\n\nMust be `true` if `UserCategory` is `OWNER`."},"UserCategory":{"type":"string","description":"**Allowed values:** `OWNER`\n\nThe [category](/guides/users/categories) of the user:\n- `PAYER` – User who can only make pay-ins to their wallets and transfers to other wallets (as well as refunds for pay-ins and transfers).\n- `OWNER` – User who can also receive transfers to their wallets. Owners are able to request [KYC verification](/guides/users/verification), which if successful gives them the `KYCLevel` of `REGULAR` and the ability to request payouts."},"CompanyNumber":{"type":"string","description":"Required if `UserCategory` is `OWNER` and `LegalPersonType` is `BUSINESS`. Returned `null` if `UserCategory` is `PAYER`.\n\nThe registration number of the entity, assigned by the relevant national authority. For information on the expected format for a specific country, see the [Company number](/guides/users/verification/company-number) guide. To validate the format of a number before submitting documents for verification, use [POST Validate the format of User data](/api-reference/user-data-format/validate-user-data-format)."},"HeadquartersAddress":{"$ref":"#/components/schemas/UpdateLegalOwnerScaRequestHeadquartersAddress","description":"Required if `UserCategory` is `OWNER`. Child parameters returned `null` if `UserCategory` is `PAYER`.\n\nThe legally registered address of the entity's administrative center."},"ScaContext":{"type":"string","description":"**Possible values:** `USER_PRESENT`, `USER_NOT_PRESENT`\n\n**Default value:** `USER_PRESENT`\n\nThe SCA context of the request, which is **required** if the user's `UserCategory` is `OWNER`:\n\n* `USER_PRESENT` – The user is taking the SCA-triggering action of updating account information and must re-enroll in SCA . The platform must [redirect the user](/guides/sca/session) using the `PendingUserAction.RedirectUrl` returned so that the user can complete the SCA session.\n* `USER_NOT_PRESENT` – The platform is taking the action under proxy from the user and the user has previously given consent to Mangopay (via the SCA hosted experience) to allow the action. If the user has not given (or has revoked) their consent, then `USER_NOT_PRESENT` returns a 403 error.\n\nRead more about [managing proxy and user consent](/guides/sca/proxy-management) **&rarr;**\n\n**Note:** On User endpoints, `ScaContext` is not returned in the API response as it does not form part of the User data – it's only related to the action being performed on the user."}},"required":["TermsAndConditionsAccepted","UserCategory"],"description":"Request body for updating a Legal User with `UserCategory` `OWNER`.\n\nModifying `LegalRepresentative.Email`, `LegalRepresentative.PhoneNumber` or `LegalRepresentative.PhoneNumberCountry` requires re-enrollment in SCA via the `PendingUserAction.RedirectUrl` returned.","title":"UpdateLegalOwnerSCARequest"},"UpdateALegalUserSCARequest":{"oneOf":[{"$ref":"#/components/schemas/UpdateLegalPayerSCARequest"},{"$ref":"#/components/schemas/UpdateLegalOwnerSCARequest"}],"title":"UpdateALegalUserSCARequest"},"LegalRepresentative_Categorize_Request":{"type":"object","properties":{"Birthday":{"type":"integer","description":"The date of birth of the individual.\n\n**Note:** This is a Unix timestamp in UTC. Ensure you convert your timezone to UTC to avoid midnight being interpreted as the day before."},"Nationality":{"type":"string","description":"Format: Two-letter country code ([ISO 3166-1 alpha-2 format](/api-reference/overview/data-formats))\n\nThe nationality of the individual."},"CountryOfResidence":{"type":"string","description":"Format: Two-letter country code ([ISO 3166-1 alpha-2 format](/api-reference/overview/data-formats))\n\nThe country of residence of the individual."},"Email":{"type":"string","description":"Format: A valid email address\n\nThe individual's email address. For `OWNER` users, SCA uses this email address to build a [behavioral biometrics profile](/guides/sca/factors#email-confirmation-behavioral-biometrics) and as a backup communication channel."},"PhoneNumber":{"type":"string","description":"Format: International E.164 standard (preceded by plus sign and country code) or local format\n\nThe individual's phone number. The local format (recommended) requires `PhoneNumberCountry` to ensure correct formatting.\n\nIf present, the phone number forms part of card transaction data that is passed to issuers to improve authentication rates.\n\nFor users with `UserCategory` `OWNER` , the phone number is used to pre-populate the SCA session for them to confirm and receive an SMS OTP. If the individual modifies the phone number during the session, this data is not updated in the API."},"PhoneNumberCountry":{"type":"string","description":"Format: Two-letter country code ([ISO 3166-1 alpha-2 format](/api-reference/overview/data-formats))\n\nRequired if the `PhoneNumber` is provided in local format (recommended), to render the value in the E.164 standard."}},"required":["Birthday","Nationality","CountryOfResidence"],"description":"Information about the legal representative declared for the user.","title":"LegalRepresentative_Categorize_Request"},"CategorizeALegalUserRequest":{"type":"object","properties":{"UserCategory":{"type":"string","description":"**Allowed values:** `OWNER`\n\nThe new category of the user, which must be `OWNER`."},"TermsAndConditionsAccepted":{"type":"boolean","description":"**Allowed values:** `true`\n\nWhether the user has accepted Mangopay's terms and conditions (as defined by your contract, see the [T&Cs guide](/guides/users/terms) for details)."},"LegalRepresentative":{"$ref":"#/components/schemas/LegalRepresentative_Categorize_Request"},"HeadquartersAddress":{"$ref":"#/components/schemas/Address_SubPropsRequired"},"CompanyNumber":{"type":"string","description":"Required if `LegalPersonType` is `BUSINESS`.\n\nThe registration number of the entity, assigned by the relevant national authority. For information on the expected format for a specific country, see the [Company number](/guides/users/verification/company-number) guide. To validate the format of a number before submitting documents for verification, use [POST Validate the format of User data](/api-reference/user-data-format/validate-user-data-format)."},"ScaContext":{"type":"string","description":"**Possible values:** `USER_PRESENT`, `USER_NOT_PRESENT`\n\n**Default value:** `USER_PRESENT`\n\nThe SCA context of the request, which is **required** if the `OWNER` value is being assigned for `UserCategory`:\n- `USER_PRESENT` – The user is on session during `OWNER` account creation and can enroll in SCA at the same time. The platform must [redirect the user](/guides/sca/session) using the `PendingUserAction.RedirectUrl` returned so that the user can complete the SCA session.\n- `USER_NOT_PRESENT` – The platform has explicit permission from Mangopay to create the `OWNER` user account without simultaneous SCA enrollment.\n\nRead more about [asynchronous SCA enrollment](/guides/sca/proxy-management#user-account-creation) **&rarr;**\n\n**Note:** On User endpoints, `ScaContext` is not returned in the API response as it does not form part of the User data – it's only related to the action being performed on the user."}},"required":["UserCategory","TermsAndConditionsAccepted","LegalRepresentative","HeadquartersAddress"],"title":"CategorizeALegalUserRequest"},"PendingUserAction":{"type":"object","properties":{"RedirectUrl":{"type":"string","description":"The URL to which to redirect the user to perform strong customer authentication (SCA) via a Mangopay-hosted webpage. This value is a variable and should not be hardcoded.\n\nThe SCA session link expires 10 minutes after it's generated.\n\n**Caution:** Before redirecting the user on this URL, you must add the query parameter `ReturnUrl`  with the percent-encoded URL to which you want the SCA session to return the user after authentication (whether successful or not).\n\nFor more details, see [How to redirect a user for an SCA session](/guides/sca/session#how-to-redirect-a-user-for-sca)."}},"description":"Object containing the `RedirectUrl` needed for SCA redirection if triggered by the API call (otherwise returned `null`).","title":"PendingUserAction"},"EnrollUserManageProxyConsentResponse":{"type":"object","properties":{"PendingUserAction":{"$ref":"#/components/schemas/PendingUserAction"}},"title":"EnrollUserManageProxyConsentResponse"},"ConsentScope":{"type":"object","properties":{"ContactInformationUpdate":{"type":["string","null"],"description":"The status of the user's consent for your platform to update their SCA contact information on their behalf using:\n- [PUT Update a Natural User (SCA)](/api-reference/users/update-natural-user-sca) to modify the `PhoneNumber`, `PhoneNumberCountry`, or `Email`\n- [PUT Update a Legal User (SCA)](/api-reference/users/update-legal-user-sca) to modify the `PhoneNumber`, `PhoneNumberCountry`, or `Email` of the `LegalRepresentative`\n\n**Possible values:** `ACTIVE`, `INACTIVE`, `null`"},"RecipientRegistration":{"type":["string","null"],"description":"The status of the user's consent for your platform to register an external bank or payment account on their behalf using:\n- [POST Create a Recipient](/api-reference/recipients/create-recipient)\n\n**Possible values:** `ACTIVE`, `INACTIVE`, `null`"},"Transfer":{"type":["string","null"],"description":"The status of the user's consent for your platform to initiate a transfer to another `OWNER` user on their behalf using:\n- [POST Create a Transfer](/api-reference/transfers/create-transfer)\n\n**Possible values:** `ACTIVE`, `INACTIVE`, `null`"},"ViewAccountInformation":{"type":["string","null"],"description":"The status of the user's consent for your platform to retrieve wallet and transaction data on their behalf using:\n- [GET View a Wallet](/api-reference/wallets/view-wallet)\n- [GET List Wallets for a User](/api-reference/wallets/list-wallets-user)\n- [GET List Transactions for a User](/api-reference/transactions/list-transactions-user)\n- [GET List Transactions for a Wallet](/api-reference/transactions/list-transactions-wallet)\n\n**Possible values:** `ACTIVE`, `INACTIVE`, `null`"}},"description":"Whether or not the user has given consent to the [proxy action scope](/guides/sca/proxy-management) via the SCA hosted experience:\n\n- `ACTIVE` - The user has given consent by checking the corresponding checkbox.\n- `INACTIVE` - The user has not yet given consent or has revoked consent.\n- `null` – The corresponding scope does not have proxy management configured for your platform.\n\nIf a scope is `ACTIVE`, your platform can call the relevant endpoint with `ScaContext` set to `USER_NOT_PRESENT` to take the action under proxy.\n\nIf a scope is `INACTIVE`, your platform has two options:\n- Call the relevant endpoint with the user on session to complete SCA by redirecting them using the returned `PendingUserAction.RedirectUrl`.\n- Ask the user to give consent using the `PendingUserAction.RedirectUrl` returned by the [POST Manage proxy consent for a User](/api-reference/users/manage-proxy-consent) endpoint, then re-try the action with `ScaContext` set to `USER_NOT_PRESENT`.","title":"ConsentScope"},"ViewTheSCAStatusOfAUserResponse":{"type":"object","properties":{"UserStatus":{"type":"string","description":"**Returned values:** `PENDING_USER_ACTION`, `ACTIVE`, `CLOSED`\n\nThe status of the user:\n\n- `PENDING_USER_ACTION` – The user must enroll in SCA before they can become `ACTIVE`.\n- `ACTIVE` – The user account is active and the user can access Mangopay features.\n- `CLOSED` – The user account is permanently closed. This value is used by Mangopay to close an account following the procedure outlined in the terms and conditions."},"IsEnrolled":{"type":"boolean","description":"Whether or not the User has been enrolled in SCA. This value is `false` before the User enrolls successfully for the first time. Once enrolled, this value remains `true` during re-enrollment (but the `UserStatus` changes to `PENDING_USER_ACTION`)."},"LastEnrollmentDate":{"type":["string","null"],"description":"The date and time of the last successful SCA enrollment, whether for the first time or a re-enrollment. Not returned if the user has not yet completed enrollment"},"LastConsentCollectionDate":{"type":["string","null"],"description":"The date and time of the last modification to any of the 4 scopes, whether to give or revoke consent."},"ConsentScope":{"$ref":"#/components/schemas/ConsentScope"}},"title":"ViewTheSCAStatusOfAUserResponse"},"ViewAUserSCAResponse":{"oneOf":[{"$ref":"#/components/schemas/NaturalUserSCAResponse"},{"$ref":"#/components/schemas/LegalUserSCAResponse"}],"title":"ViewAUserSCAResponse"},"ListAllUsersResponseItems":{"type":"object","properties":{"Id":{"$ref":"#/components/schemas/Id"},"Tag":{"$ref":"#/components/schemas/Tag"},"CreationDate":{"$ref":"#/components/schemas/CreationDate"},"PersonType":{"type":"string","description":"**Returned values:** NATURAL, LEGAL\n\nThe type of the user:\n- `NATURAL` – Natural users are individuals (natural persons).\n- `LEGAL` – Legal users are legal entities (legal persons) like companies, non-profits, and sole proprietors.\n\nThe `PersonType` is defined by the endpoint used to create the user and can't be modified."},"Email":{"type":"string","description":"The email address of the user."},"KYCLevel":{"type":"string","description":"**Default value:** `LIGHT`\n\n**Returned values:** `LIGHT`, `REGULAR`\n\nThe verification status of the user set by Mangopay:\n- `LIGHT` – Unverified, assigned by default to all users.\n- `REGULAR` – Verified, meaning the user has successfully completed the verification process and had the necessary documents validated by Mangopay. Only users whose `UserCategory` is `OWNER` can submit verification documents for validation. Only users whose `KYCLevel` is `REGULAR` can request payouts."},"TermsAndConditionsAccepted":{"type":"boolean","description":"Whether the user has accepted Mangopay's terms and conditions (as defined by your contract, see the [T&Cs guide](/guides/users/terms) for details).\n\nMust be `true` if `UserCategory` is `OWNER`."},"TermsAndConditionsAcceptedDate":{"type":"integer","description":"Unix timestamp (UTC) of the date and time the `TermsAndConditionsAccepted` value was set to `true`.\n\nReturned `null` if `UserCategory` is `PAYER`."},"UserCategory":{"type":"string","description":"**Possible values:** `PAYER`, `OWNER`, `PLATFORM`\n\nThe [category](/guides/users/categories) of the user:\n- `PAYER` – User who can only make pay-ins to their wallets and transfers to other wallets (as well as refunds for pay-ins and transfers).\n- `OWNER` – User who can also receive transfers to their wallets. Owners are able to request [KYC verification](/guides/users/verification), which if successful gives them the `KYCLevel` of `REGULAR` and the ability to request payouts.\n- `PLATFORM` – Single specific user that represents the platform. The `PLATFORM` value is only assigned by Mangopay and may be used as part of the validated workflow implemented by the platform."},"UserStatus":{"type":"string","description":"**Returned values:** ACTIVE, CLOSED\n\nInternal use only. This field can only be used and updated by Mangopay teams."}},"description":"The key information on the user created by the platform.","title":"ListAllUsersResponseItems"},"ListAllUsersResponse":{"type":"array","items":{"$ref":"#/components/schemas/ListAllUsersResponseItems"},"description":"The list of users created by the platform.","title":"ListAllUsersResponse"},"CreateANaturalUserRequest":{"type":"object","properties":{"UserCategory":{"type":"string","description":"**Allowed values:** `PAYER`, `OWNER`\n\nThe [category](/guides/users/categories) of the user:\n- `PAYER` – User who can only make pay-ins to their wallets and transfers to other wallets (as well as refunds for pay-ins and transfers).\n- `OWNER` – User who can also receive transfers to their wallets. Owners are able to request [KYC verification](/guides/users/verification), which if successful gives them the `KYCLevel` of `REGULAR` and the ability to request payouts."},"TermsAndConditionsAccepted":{"type":"boolean","description":"Whether the user has accepted Mangopay's terms and conditions (as defined by your contract, see the [T&Cs guide](/guides/users/terms) for details).\n\nMust be `true` if `UserCategory` is `OWNER`."},"FirstName":{"type":"string","description":"Min. length: 1; max. length: 100\n\nThe first name of the individual."},"LastName":{"type":"string","description":"Min. length: 1; max. length: 100\n\nThe last name of the individual."},"Email":{"type":"string","description":"Format: A valid email address\n\nThe email address of the user."},"Birthday":{"type":"integer","description":"Required if `UserCategory` is `OWNER`. Returned `null` if `UserCategory` is `PAYER`.\n\nThe date of birth of the individual.\n\n**Note:** This is a Unix timestamp in UTC. Ensure you convert your timezone to UTC to avoid midnight being interpreted as the day before."},"Nationality":{"type":"string","description":"Format: Two-letter country code ([ISO 3166-1 alpha-2 format](/api-reference/overview/data-formats))\n\nRequired if `UserCategory` is `OWNER`. Returned `null` if `UserCategory` is `PAYER`.\n\nThe nationality of the individual."},"CountryOfResidence":{"type":"string","description":"Format: Two-letter country code ([ISO 3166-1 alpha-2 format](/api-reference/overview/data-formats))\n\nRequired if `UserCategory` is `OWNER`. Returned `null` if `UserCategory` is `PAYER`.\n\nThe country of residence of the individual."},"Address":{"$ref":"#/components/schemas/Address_SubPropsRequired"},"Occupation":{"type":"string","description":"Max. length: 255 characters\n\nReturned `null` if `UserCategory` is `PAYER`.\n\nThe occupation of the individual."},"IncomeRange":{"type":"integer","description":"**Allowed values:** `1`, `2`, `3`, `4`, `5`, `6`, `null`\n\nReturned `null` if `UserCategory` is `PAYER`.\n\nThe bracket indicating the income of the individual. The brackets are:\n- 1: < 18K\n- 2: 18K - 30K\n- 3: 30K - 50K\n- 4: 50K - 80K\n- 5: 80K - 120K\n- 6: > 120K"},"Tag":{"$ref":"#/components/schemas/Tag"}},"required":["UserCategory","TermsAndConditionsAccepted","FirstName","LastName","Email"],"title":"CreateANaturalUserRequest"},"NaturalUserResponse":{"type":"object","properties":{"Address":{"$ref":"#/components/schemas/Address"},"FirstName":{"type":"string","description":"Min. length: 1; max. length: 100\n\nThe first name of the individual."},"LastName":{"type":"string","description":"Min. length: 1; max. length: 100\n\nThe last name of the individual."},"Birthday":{"type":"integer","description":"Returned `null` if `UserCategory` is `PAYER`.\n\nThe date of birth of the individual.\n\n**Note:** This is a Unix timestamp in UTC. Ensure you convert your timezone to UTC to avoid midnight being interpreted as the day before."},"Nationality":{"type":"string","description":"Returned `null` if `UserCategory` is `PAYER`.\n\nThe nationality of the individual."},"CountryOfResidence":{"type":"string","description":"Returned `null` if `UserCategory` is `PAYER`.\n\nThe country of residence of the individual."},"Occupation":{"type":"string","description":"Max. length: 255 characters\n\nThe occupation of the individual.\n\nReturned `null` if `UserCategory` is `PAYER`."},"IncomeRange":{"type":"integer","description":"Returned `null` if `UserCategory` is `PAYER`.\n\nThe bracket indicating the income of the individual. The brackets are:\n- 1: < 18K\n- 2: 18K - 30K\n- 3: 30K - 50K\n- 4: 50K - 80K\n- 5: 80K - 120K\n- 6: > 120K"},"ProofOfIdentity":{"type":"string","description":"The `Id` of the KYC Document whose `Type` is `IDENTITY_PROOF` if validated for the user. If no identity proof is validated, then this value is `null`."},"ProofOfAddress":{"type":"string","description":"The `Id` of the KYC Document whose `Type` is `ADDRESS_PROOF` if validated for the user. If no address proof is validated, then this value is `null`."},"Capacity":{"type":"string","description":"This is a deprecated parameter."},"Id":{"$ref":"#/components/schemas/Id"},"Tag":{"$ref":"#/components/schemas/Tag"},"CreationDate":{"$ref":"#/components/schemas/CreationDate"},"PersonType":{"type":"string","description":"**Returned values:** NATURAL, LEGAL\n\nThe type of the user:\n- `NATURAL` – Natural users are individuals (natural persons).\n- `LEGAL` – Legal users are legal entities (legal persons) like companies, non-profits, and sole proprietors.\n\nThe `PersonType` is defined by the endpoint used to create the user and can't be modified."},"Email":{"type":"string","description":"Format: A valid email address\n\nThe email address of the user."},"KYCLevel":{"type":"string","description":"**Default value:** `LIGHT`\n\n**Returned values:** `LIGHT`, `REGULAR`\n\nThe verification status of the user set by Mangopay:\n- `LIGHT` – Unverified, assigned by default to all users.\n- `REGULAR` – Verified, meaning the user has successfully completed the verification process and had the necessary documents validated by Mangopay. Only users whose `UserCategory` is `OWNER` can submit verification documents for validation. Only users whose `KYCLevel` is `REGULAR` can request payouts."},"TermsAndConditionsAccepted":{"type":"boolean","description":"Whether the user has accepted Mangopay's terms and conditions (as defined by your contract, see the [T&Cs guide](/guides/users/terms) for details).\n\nMust be `true` if `UserCategory` is `OWNER`."},"TermsAndConditionsAcceptedDate":{"type":"integer","description":"Unix timestamp (UTC) of the date and time the `TermsAndConditionsAccepted` value was set to `true`.\n\nReturned `null` if `UserCategory` is `PAYER`."},"UserCategory":{"type":"string","description":"**Possible values:** `PAYER`, `OWNER`, `PLATFORM`\n\nThe [category](/guides/users/categories) of the user:\n- `PAYER` – User who can only make pay-ins to their wallets and transfers to other wallets (as well as refunds for pay-ins and transfers).\n- `OWNER` – User who can also receive transfers to their wallets. Owners are able to request [KYC verification](/guides/users/verification), which if successful gives them the `KYCLevel` of `REGULAR` and the ability to request payouts.\n- `PLATFORM` – Single specific user that represents the platform. The `PLATFORM` value is only assigned by Mangopay and may be used as part of the validated workflow implemented by the platform."},"UserStatus":{"type":"string","description":"**Returned values:** ACTIVE, CLOSED\n\nInternal use only. This field can only be used and updated by Mangopay teams."}},"title":"NaturalUserResponse"},"UpdateANaturalUserRequest":{"type":"object","properties":{"UserCategory":{"type":"string","description":"**Allowed values:** `PAYER`, `OWNER`\n\nThe [category](/guides/users/categories) of the user:\n- `PAYER` – User who can only make pay-ins to their wallets and transfers to other wallets (as well as refunds for pay-ins and transfers).\n- `OWNER` – User who can also receive transfers to their wallets. Owners are able to request [KYC verification](/guides/users/verification), which if successful gives them the `KYCLevel` of `REGULAR` and the ability to request payouts."},"TermsAndConditionsAccepted":{"type":"boolean","description":"Whether the user has accepted Mangopay's terms and conditions (as defined by your contract, see the [T&Cs guide](/guides/users/terms) for details).\n\nMust be `true` if `UserCategory` is `OWNER`."},"FirstName":{"type":"string","description":"Min. length: 1; max. length: 100\n\nThe first name of the individual."},"LastName":{"type":"string","description":"Min. length: 1; max. length: 100\n\nThe last name of the individual."},"Email":{"type":"string","description":"Format: A valid email address\n\nThe email address of the user."},"Birthday":{"type":"integer","description":"Required if `UserCategory` is `OWNER`. Returned `null` if `UserCategory` is `PAYER`.\n\nThe date of birth of the individual.\n\n**Note:** This is a Unix timestamp in UTC. Ensure you convert your timezone to UTC to avoid midnight being interpreted as the day before."},"Nationality":{"type":"string","description":"Format: Two-letter country code ([ISO 3166-1 alpha-2 format](/api-reference/overview/data-formats))\n\nRequired if `UserCategory` is `OWNER`. Returned `null` if `UserCategory` is `PAYER`.\n\nThe nationality of the individual."},"CountryOfResidence":{"type":"string","description":"Format: Two-letter country code ([ISO 3166-1 alpha-2 format](/api-reference/overview/data-formats))\n\nRequired if `UserCategory` is `OWNER`. Returned `null` if `UserCategory` is `PAYER`.\n\nThe country of residence of the individual."},"Address":{"$ref":"#/components/schemas/Address_SubPropsRequired"},"Occupation":{"type":"string","description":"Max. length: 255 characters\n\nReturned `null` if `UserCategory` is `PAYER`.\n\nThe occupation of the individual."},"IncomeRange":{"type":"integer","description":"**Allowed values:** `1`, `2`, `3`, `4`, `5`, `6`, `null`\n\nReturned `null` if `UserCategory` is `PAYER`.\n\nThe bracket indicating the income of the individual. The brackets are:\n- 1: < 18K\n- 2: 18K - 30K\n- 3: 30K - 50K\n- 4: 50K - 80K\n- 5: 80K - 120K\n- 6: > 120K"},"Tag":{"$ref":"#/components/schemas/Tag"}},"required":["UserCategory","TermsAndConditionsAccepted"],"title":"UpdateANaturalUserRequest"},"CreateALegalUserRequest":{"type":"object","properties":{"UserCategory":{"type":"string","description":"**Allowed values:** `PAYER`, `OWNER`\n\nThe [category](/guides/users/categories) of the user:\n- `PAYER` – User who can only make pay-ins to their wallets and transfers to other wallets (as well as refunds for pay-ins and transfers).\n- `OWNER` – User who can also receive transfers to their wallets. Owners are able to request [KYC verification](/guides/users/verification), which if successful gives them the `KYCLevel` of `REGULAR` and the ability to request payouts."},"TermsAndConditionsAccepted":{"type":"boolean","description":"Whether the user has accepted Mangopay's terms and conditions (as defined by your contract, see the [T&Cs guide](/guides/users/terms) for details).\n\nMust be `true` if `UserCategory` is `OWNER`."},"LegalPersonType":{"type":"string","description":"**Allowed values:** BUSINESS, PARTNERSHIP, ORGANIZATION, SOLETRADER\n\nThe type of legal user. For information on which `LegalPersonType` to use for a particular local legal structure, see the <a href=\"/guides/users/verification/requirements\" target=\"_blank\">verification requirements</a>.\n\n**Caution:** Modification of the `LegalPersonType` may result in a <a href=\"/guides/users/verification/downgrade\" target=\"_blank\">verification downgrade</a>."},"Name":{"type":"string","description":"Max. length: 255 characters\n\nThe registered legal name of the entity. The `Name` value should be the one registered with the relevant national authority."},"Email":{"type":"string","description":"Format: A valid email address\n\nThe email address for the entity."},"HeadquartersAddress":{"$ref":"#/components/schemas/Address_SubPropsRequired"},"CompanyNumber":{"type":"string","description":"Required if `UserCategory` is `OWNER` and `LegalPersonType` is `BUSINESS`. Returned `null` if `UserCategory` is `PAYER`.\n\nThe registration number of the entity, assigned by the relevant national authority. For information on the expected format for a specific country, see the [Company number](/guides/users/verification/company-number) guide. To validate the format of a number before submitting documents for verification, use [POST Validate the format of User data](/api-reference/user-data-format/validate-user-data-format)."},"LegalRepresentativeFirstName":{"type":"string","description":"_Min length: 1; max. length: 100_\n\nThe first name of the entity's legal representative."},"LegalRepresentativeLastName":{"type":"string","description":"_Min length: 1; max. length: 100_\n\nThe last name of the entity's legal representative."},"LegalRepresentativeEmail":{"type":"string","description":"Format: A valid email address\n\nThe email address of the entity's legal representative. Returned `null` if `UserCategory` is `PAYER`."},"LegalRepresentativeBirthday":{"type":"integer","description":"Required if `UserCategory` is `OWNER`. Returned `null` if `UserCategory` is `PAYER`.\n\nThe date of birth of the entity's legal representative.\n\n**Note:** This is a Unix timestamp in UTC. Ensure you convert your timezone to UTC to avoid midnight being interpreted as the day before."},"LegalRepresentativeNationality":{"type":"string","description":"Format: Two-letter country code ([ISO 3166-1 alpha-2 format](/api-reference/overview/data-formats))\n\nRequired if `UserCategory` is `OWNER`. Returned `null` if `UserCategory` is `PAYER`.\n\nThe nationality of the entity's legal representative."},"LegalRepresentativeCountryOfResidence":{"type":"string","description":"Format: Two-letter country code ([ISO 3166-1 alpha-2 format](/api-reference/overview/data-formats))\n\nRequired if `UserCategory` is `OWNER`. Returned `null` if `UserCategory` is `PAYER`.\n\nThe country of residence of the entity's legal representative."},"LegalRepresentativeAddress":{"$ref":"#/components/schemas/Address_SubPropsRequired"},"Tag":{"$ref":"#/components/schemas/Tag"}},"required":["UserCategory","TermsAndConditionsAccepted","LegalPersonType","Name","Email","LegalRepresentativeFirstName","LegalRepresentativeLastName"],"title":"CreateALegalUserRequest"},"LegalUserResponse":{"type":"object","properties":{"HeadquartersAddress":{"$ref":"#/components/schemas/Address"},"LegalRepresentativeAddress":{"$ref":"#/components/schemas/Address"},"Name":{"type":"string","description":"Max. length: 255 characters\n\nThe registered legal name of the entity. The `Name` value should be the one registered with the relevant national authority."},"LegalPersonType":{"type":"string","description":"**Returned values:** BUSINESS, PARTNERSHIP, ORGANIZATION, SOLETRADER\n\nThe type of legal user. For information on which `LegalPersonType` to use for a particular local legal structure, see the <a href=\"/guides/users/verification/requirements\" target=\"_blank\">verification requirements</a>.\n\n**Caution:** Modification of the `LegalPersonType` may result in a <a href=\"/guides/users/verification/downgrade\" target=\"_blank\">verification downgrade</a>."},"LegalRepresentativeFirstName":{"type":"string","description":"Min. length: 1; max. length: 100\n\nThe first name of the entity's legal representative."},"LegalRepresentativeLastName":{"type":"string","description":"Min. length: 1; max. length: 100\n\nThe last name of the entity's legal representative."},"LegalRepresentativeEmail":{"type":"string","description":"Format: A valid email address\n\nThe email address of the entity's legal representative. Returned `null` if `UserCategory` is `PAYER`."},"LegalRepresentativeBirthday":{"type":"integer","description":"The date of birth of the entity's legal representative.\n\nReturned `null` if `UserCategory` is `PAYER`.\n\n**Note:** This is a Unix timestamp in UTC. Ensure you convert your timezone to UTC to avoid midnight being interpreted as the day before."},"LegalRepresentativeNationality":{"type":"string","description":"Returned `null` if `UserCategory` is `PAYER`.\n\nThe nationality of the entity's legal representative."},"LegalRepresentativeCountryOfResidence":{"type":"string","description":"Returned `null` if `UserCategory` is `PAYER`.\n\nThe country of residence of the entity's legal representative."},"ProofOfRegistration":{"type":"string","description":"The `Id` of the KYC Document whose `Type` is `REGISTRATION_PROOF` if validated for the user. If no registration proof is validated, then this value is `null`."},"ShareholderDeclaration":{"type":"string","description":"The `Id` of the KYC Document whose `Type` is `SHAREHOLDERS_DECLARATION` if validated for the user. If no Shareholder Declaration is validated, then this value is `null`."},"Statute":{"type":"string","description":"The `Id` of the KYC Document whose `Type` is `ARTICLES_OF_ASSOCIATION` if validated for the user. If no articles of association document is validated, then this value is `null`."},"LegalRepresentativeProofOfIdentity":{"type":"string","description":"The `Id` of the KYC Document whose `Type` is `IDENTITY_PROOF` if validated for the user. If no identity proof is validated, then this value is `null`."},"CompanyNumber":{"type":"string","description":"Required if `UserCategory` is `OWNER` and `LegalPersonType` is `BUSINESS`. Returned `null` if `UserCategory` is `PAYER`.\n\nThe registration number of the entity, assigned by the relevant national authority. For information on the expected format for a specific country, see the [Company number](/guides/users/verification/company-number) guide. To validate the format of a number before submitting documents for verification, use [POST Validate the format of User data](/api-reference/user-data-format/validate-user-data-format)."},"Id":{"$ref":"#/components/schemas/Id"},"Tag":{"$ref":"#/components/schemas/Tag"},"CreationDate":{"$ref":"#/components/schemas/CreationDate"},"PersonType":{"type":"string","description":"**Returned values:** NATURAL, LEGAL\n\nThe type of the user:\n- `NATURAL` – Natural users are individuals (natural persons).\n- `LEGAL` – Legal users are legal entities (legal persons) like companies, non-profits, and sole proprietors.\n\nThe `PersonType` is defined by the endpoint used to create the user and can't be modified."},"Email":{"type":"string","description":"Format: A valid email address\n\nThe email address for the entity."},"KYCLevel":{"type":"string","description":"**Default value:** `LIGHT`\n\n**Returned values:** `LIGHT`, `REGULAR`\n\nThe verification status of the user set by Mangopay:\n- `LIGHT` – Unverified, assigned by default to all users.\n- `REGULAR` – Verified, meaning the user has successfully completed the verification process and had the necessary documents validated by Mangopay. Only users whose `UserCategory` is `OWNER` can submit verification documents for validation. Only users whose `KYCLevel` is `REGULAR` can request payouts."},"TermsAndConditionsAccepted":{"type":"boolean","description":"Whether the user has accepted Mangopay's terms and conditions (as defined by your contract, see the [T&Cs guide](/guides/users/terms) for details).\n\nMust be `true` if `UserCategory` is `OWNER`."},"TermsAndConditionsAcceptedDate":{"type":"integer","description":"Unix timestamp (UTC) of the date and time the `TermsAndConditionsAccepted` value was set to `true`.\n\nReturned `null` if `UserCategory` is `PAYER`."},"UserCategory":{"type":"string","description":"**Possible values:** `PAYER`, `OWNER`, `PLATFORM`\n\nThe [category](/guides/users/categories) of the user:\n- `PAYER` – User who can only make pay-ins to their wallets and transfers to other wallets (as well as refunds for pay-ins and transfers).\n- `OWNER` – User who can also receive transfers to their wallets. Owners are able to request [KYC verification](/guides/users/verification), which if successful gives them the `KYCLevel` of `REGULAR` and the ability to request payouts.\n- `PLATFORM` – Single specific user that represents the platform. The `PLATFORM` value is only assigned by Mangopay and may be used as part of the validated workflow implemented by the platform."},"UserStatus":{"type":"string","description":"**Returned values:** ACTIVE, CLOSED\n\nInternal use only. This field can only be used and updated by Mangopay teams."}},"title":"LegalUserResponse"},"UpdateALegalUserRequest":{"type":"object","properties":{"UserCategory":{"type":"string","description":"**Allowed values:** `PAYER`, `OWNER`\n\nThe [category](/guides/users/categories) of the user:\n- `PAYER` – User who can only make pay-ins to their wallets and transfers to other wallets (as well as refunds for pay-ins and transfers).\n- `OWNER` – User who can also receive transfers to their wallets. Owners are able to request [KYC verification](/guides/users/verification), which if successful gives them the `KYCLevel` of `REGULAR` and the ability to request payouts."},"TermsAndConditionsAccepted":{"type":"boolean","description":"Whether the user has accepted Mangopay's terms and conditions (as defined by your contract, see the [T&Cs guide](/guides/users/terms) for details).\n\nMust be `true` if `UserCategory` is `OWNER`."},"LegalPersonType":{"type":"string","description":"**Allowed values:** BUSINESS, PARTNERSHIP, ORGANIZATION, SOLETRADER\n\nThe type of legal user. For information on which `LegalPersonType` to use for a particular local legal structure, see the <a href=\"/guides/users/verification/requirements\" target=\"_blank\">verification requirements</a>.\n\n**Caution:** Modification of the `LegalPersonType` may result in a <a href=\"/guides/users/verification/downgrade\" target=\"_blank\">verification downgrade</a>."},"Name":{"type":"string","description":"Max. length: 255 characters\n\nThe registered legal name of the entity. The `Name` value should be the one registered with the relevant national authority."},"Email":{"type":"string","description":"Format: A valid email address\n\nThe email address for the entity."},"HeadquartersAddress":{"$ref":"#/components/schemas/Address_SubPropsRequired"},"CompanyNumber":{"type":"string","description":"Required if `UserCategory` is `OWNER` and `LegalPersonType` is `BUSINESS`. Returned `null` if `UserCategory` is `PAYER`.\n\nThe registration number of the entity, assigned by the relevant national authority. For information on the expected format for a specific country, see the [Company number](/guides/users/verification/company-number) guide. To validate the format of a number before submitting documents for verification, use [POST Validate the format of User data](/api-reference/user-data-format/validate-user-data-format)."},"LegalRepresentativeAddress":{"$ref":"#/components/schemas/Address_SubPropsRequired"},"LegalRepresentativeFirstName":{"type":"string","description":"_Min length: 1; max. length: 100_\n\nThe first name of the entity's legal representative."},"LegalRepresentativeLastName":{"type":"string","description":"_Min length: 1; max. length: 100_\n\nThe last name of the entity's legal representative."},"LegalRepresentativeEmail":{"type":"string","description":"Format: A valid email address\n\nThe email address of the entity's legal representative. Returned `null` if `UserCategory` is `PAYER`."},"LegalRepresentativeBirthday":{"type":"integer","description":"Required if `UserCategory` is `OWNER`. Returned `null` if `UserCategory` is `PAYER`.\n\nThe date of birth of the entity's legal representative.\n\n**Note:** This is a Unix timestamp in UTC. Ensure you convert your timezone to UTC to avoid midnight being interpreted as the day before."},"LegalRepresentativeNationality":{"type":"string","description":"Format: Two-letter country code ([ISO 3166-1 alpha-2 format](/api-reference/overview/data-formats))\n\nRequired if `UserCategory` is `OWNER`. Returned `null` if `UserCategory` is `PAYER`.\n\nThe nationality of the entity's legal representative."},"LegalRepresentativeCountryOfResidence":{"type":"string","description":"Format: Two-letter country code ([ISO 3166-1 alpha-2 format](/api-reference/overview/data-formats))\n\nRequired if `UserCategory` is `OWNER`. Returned `null` if `UserCategory` is `PAYER`.\n\nThe country of residence of the entity's legal representative."},"Tag":{"$ref":"#/components/schemas/Tag"}},"required":["UserCategory","TermsAndConditionsAccepted"],"title":"UpdateALegalUserRequest"},"ViewAUserResponse":{"type":"object","properties":{"Address":{"$ref":"#/components/schemas/Address"},"FirstName":{"type":"string","description":"Min. length: 1; max. length: 100\n\nThe first name of the individual."},"LastName":{"type":"string","description":"Min. length: 1; max. length: 100\n\nThe last name of the individual."},"Birthday":{"type":"integer","description":"Returned `null` if `UserCategory` is `PAYER`.\n\nThe date of birth of the individual.\n\n**Note:** This is a Unix timestamp in UTC. Ensure you convert your timezone to UTC to avoid midnight being interpreted as the day before."},"Nationality":{"type":"string","description":"Returned `null` if `UserCategory` is `PAYER`.\n\nThe nationality of the individual."},"CountryOfResidence":{"type":"string","description":"Returned `null` if `UserCategory` is `PAYER`.\n\nThe country of residence of the individual."},"Occupation":{"type":"string","description":"Max. length: 255 characters\n\nThe occupation of the individual. Returned `null` if `UserCategory` is `PAYER`."},"IncomeRange":{"type":"integer","description":"Returned `null` if `UserCategory` is `PAYER`.\n\nThe bracket indicating the income of the individual. The brackets are:\n- 1: < 18K\n- 2: 18K - 30K\n- 3: 30K - 50K\n- 4: 50K - 80K\n- 5: 80K - 120K\n- 6: > 120K"},"ProofOfIdentity":{"type":"string","description":"The `Id` of the KYC Document whose `Type` is `IDENTITY_PROOF` if validated for the user. If no identity proof is validated, then this value is `null`."},"ProofOfAddress":{"type":"string","description":"The `Id` of the KYC Document whose `Type` is `ADDRESS_PROOF` if validated for the user. If no address proof is validated, then this value is `null`."},"Capacity":{"type":"string","description":"This is a deprecated parameter."},"Id":{"$ref":"#/components/schemas/Id"},"Tag":{"$ref":"#/components/schemas/Tag"},"CreationDate":{"$ref":"#/components/schemas/CreationDate"},"PersonType":{"type":"string","description":"**Returned values:** NATURAL, LEGAL\n\nThe type of the user:\n- `NATURAL` – Natural users are individuals (natural persons).\n- `LEGAL` – Legal users are legal entities (legal persons) like companies, non-profits, and sole proprietors.\n\nThe `PersonType` is defined by the endpoint used to create the user and can't be modified."},"Email":{"type":"string","description":"The email address for the entity."},"KYCLevel":{"type":"string","description":"**Default value:** `LIGHT`\n\n**Returned values:** `LIGHT`, `REGULAR`\n\nThe verification status of the user set by Mangopay:\n- `LIGHT` – Unverified, assigned by default to all users.\n- `REGULAR` – Verified, meaning the user has successfully completed the verification process and had the necessary documents validated by Mangopay. Only users whose `UserCategory` is `OWNER` can submit verification documents for validation. Only users whose `KYCLevel` is `REGULAR` can request payouts."},"TermsAndConditionsAccepted":{"type":"boolean","description":"Whether the user has accepted Mangopay's terms and conditions (as defined by your contract, see the [T&Cs guide](/guides/users/terms) for details).\n\nMust be `true` if `UserCategory` is `OWNER`."},"TermsAndConditionsAcceptedDate":{"type":"integer","description":"Unix timestamp (UTC) of the date and time the `TermsAndConditionsAccepted` value was set to `true`.\n\nReturned `null` if `UserCategory` is `PAYER`."},"UserCategory":{"type":"string","description":"**Possible values:** `PAYER`, `OWNER`, `PLATFORM`\n\nThe [category](/guides/users/categories) of the user:\n- `PAYER` – User who can only make pay-ins to their wallets and transfers to other wallets (as well as refunds for pay-ins and transfers).\n- `OWNER` – User who can also receive transfers to their wallets. Owners are able to request [KYC verification](/guides/users/verification), which if successful gives them the `KYCLevel` of `REGULAR` and the ability to request payouts.\n- `PLATFORM` – Single specific user that represents the platform. The `PLATFORM` value is only assigned by Mangopay and may be used as part of the validated workflow implemented by the platform."},"UserStatus":{"type":"string","description":"**Returned values:** ACTIVE, CLOSED\n\nInternal use only. This field can only be used and updated by Mangopay teams."},"HeadquartersAddress":{"$ref":"#/components/schemas/Address"},"LegalRepresentativeAddress":{"$ref":"#/components/schemas/Address"},"Name":{"type":"string","description":"Max. length: 255 characters\n\nThe registered legal name of the entity. The `Name` value should be the one registered with the relevant national authority."},"LegalPersonType":{"type":"string","description":"**Returned values:** BUSINESS, PARTNERSHIP, ORGANIZATION, SOLETRADER\n\nThe type of legal user. For information on which `LegalPersonType` to use for a particular local legal structure, see the <a href=\"/guides/users/verification/requirements\" target=\"_blank\">verification requirements</a>.\n\n**Caution:** Modification of the `LegalPersonType` may result in a <a href=\"/guides/users/verification/downgrade\" target=\"_blank\">verification downgrade</a>."},"LegalRepresentativeFirstName":{"type":"string","description":"Min. length: 1; max. length: 100\n\nThe first name of the entity's legal representative."},"LegalRepresentativeLastName":{"type":"string","description":"Min. length: 1; max. length: 100\n\nThe last name of the entity's legal representative."},"LegalRepresentativeEmail":{"type":"string","description":"Format: A valid email address\n\nThe email address of the entity's legal representative. Returned `null` if `UserCategory` is `PAYER`."},"LegalRepresentativeBirthday":{"type":"integer","description":"The date of birth of the entity's legal representative.\n\nReturned `null` if `UserCategory` is `PAYER`.\n\n**Note:** This is a Unix timestamp in UTC. Ensure you convert your timezone to UTC to avoid midnight being interpreted as the day before."},"LegalRepresentativeNationality":{"type":"string","description":"Returned `null` if `UserCategory` is `PAYER`.\n\nThe nationality of the entity's legal representative."},"LegalRepresentativeCountryOfResidence":{"type":"string","description":"Returned `null` if `UserCategory` is `PAYER`.\n\nThe country of residence of the entity's legal representative."},"ProofOfRegistration":{"type":"string","description":"The `Id` of the KYC Document whose `Type` is `REGISTRATION_PROOF` if validated for the user. If no registration proof is validated, then this value is `null`."},"ShareholderDeclaration":{"type":"string","description":"The `Id` of the KYC Document whose `Type` is `SHAREHOLDERS_DECLARATION` if validated for the user. If no Shareholder Declaration is validated, then this value is `null`."},"Statute":{"type":"string","description":"The `Id` of the KYC Document whose `Type` is `ARTICLES_OF_ASSOCIATION` if validated for the user. If no articles of association document is validated, then this value is `null`."},"LegalRepresentativeProofOfIdentity":{"type":"string","description":"The `Id` of the KYC Document whose `Type` is `IDENTITY_PROOF` if validated for the user. If no identity proof is validated, then this value is `null`."},"CompanyNumber":{"type":"string","description":"Required if `UserCategory` is `OWNER` and `LegalPersonType` is `BUSINESS`. Returned `null` if `UserCategory` is `PAYER`.\n\nThe registration number of the entity, assigned by the relevant national authority. For information on the expected format for a specific country, see the [Company number](/guides/users/verification/company-number) guide. To validate the format of a number before submitting documents for verification, use [POST Validate the format of User data](/api-reference/user-data-format/validate-user-data-format)."}},"title":"ViewAUserResponse"},"UserRegulatoryStatusResponseScopeBlocked":{"type":"object","properties":{"Inflows":{"type":"boolean","description":"Whether or not the user is blocked from making pay-ins or sending or receiving transfers."},"Outflows":{"type":"boolean","description":"Whether or not the user is blocked from making payouts or sending or receiving transfers."}},"description":"Information about which payment flows are blocked for the user.","title":"UserRegulatoryStatusResponseScopeBlocked"},"UserRegulatoryStatusResponse":{"type":"object","properties":{"ActionCode":{"type":"string","description":"**Returned values:** One of the action codes available in the [Blocked users](/guides/users/blocked-users) article.\n\nCode indicating the reason for blocking the user, and steps you can take to get them unblocked."},"ScopeBlocked":{"$ref":"#/components/schemas/UserRegulatoryStatusResponseScopeBlocked","description":"Information about which payment flows are blocked for the user."},"Id":{"type":"string","description":"The unique identifier of the user."}},"title":"UserRegulatoryStatusResponse"},"Currency":{"type":"string","description":"**Allowed values:** The three-letter <a href=\"/api-reference/overview/data-formats\" target=\"_blank\">ISO 4217 code</a> (EUR, GBP, etc.) of a <a href=\"/guides/currencies\" target=\"_blank\">supported currency</a> (depends on feature, contract, and activation settings).\n\nThe currency of the amount.","title":"Currency"},"Amount":{"type":"integer","description":"The amount of the currency in its minor unit. For example, EUR 12.60 would be represented as `1260` whereas JPY 12 would be represented as just `12`.","title":"Amount"},"ViewUserEMoneyResponseCreditedEMoney":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the pay-ins and transfers credited to wallets owned by the user.","title":"ViewUserEMoneyResponseCreditedEMoney"},"ViewUserEMoneyResponseDebitedEMoney":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the payouts debited from wallets owned by the user.","title":"ViewUserEMoneyResponseDebitedEMoney"},"ViewUserEMoneyResponse":{"type":"object","properties":{"UserId":{"type":"string","description":"The unique identifier of the user."},"CreditedEMoney":{"$ref":"#/components/schemas/ViewUserEMoneyResponseCreditedEMoney","description":"Information about the pay-ins and transfers credited to wallets owned by the user."},"DebitedEMoney":{"$ref":"#/components/schemas/ViewUserEMoneyResponseDebitedEMoney","description":"Information about the payouts debited from wallets owned by the user."}},"title":"ViewUserEMoneyResponse"},"CreateAnIDVSessionRequest":{"type":"object","properties":{"ReturnUrl":{"type":"string","description":"Max. length: 50\n\nThe URL to which the user is returned after the hosted identity verification session, regardless of the outcome."},"Tag":{"$ref":"#/components/schemas/Tag"}},"required":["ReturnUrl"],"title":"CreateAnIDVSessionRequest"},"IdvSessionStatus":{"type":"string","description":"The status of the overall IDV Session:\n- `PENDING` – Session created. The `HostedUrl` is valid for completion, regardless of whether the user has started or submitted the session.\n- `REVIEW` – One or more automated checks was neither successful nor refused, so the session was sent for manual review by Mangopay's teams. This temporary state is only applicable to Legal users and can transition to `REFUSED` or `VALIDATED`.\n- `VALIDATED` – - The session was validated and the User became KYC/KYB verified (indicated by the User object's `KYCLevel`). When the `Status` changes to `VALIDATED`, the [verified data](/guides/users/verification/hosted/natural#verified-data) in `Checks.Data` is used to replace existing data in the User object.\n- `REFUSED` – The session was refused and the User is not KYC/KYB verified. The `Checks.CheckStatus` shows which checks were `REFUSED` and the `Checks.Reasons` shows the [refused reason types](/guides/users/verification/hosted/refusals) and comment (which is custom text in the case of manual review for Legal users).\n- `EXPIRED` – The IDV Session expired and can no longer be used. By default, this happens 7 days after the `CreationDate`. However, if the IDV Session contains the liveness step and that step has been started (the QR code was generated), the session instead expires 1 hour after the liveness step started. The IDV Session contains the liveness step for Natural users, Soletrader users, and Business/Organization users on the legacy integrated flow. In the multi-session PSC flow, the main IDV Session never contains the liveness step (so it always follows the 7-day rule) – the liveness check is performed in each PSC Session instead, which follows the same 7-day/1-hour rule independently.\n- `OUT_OF_DATE` – The IDV Session is not valid because the user's KYC/KYB verification status was [downgraded](/guides/users/verification/downgrade) by Mangopay.","title":"IdvSessionStatus"},"CreateAnIDVSessionResponse":{"type":"object","properties":{"Id":{"$ref":"#/components/schemas/Id"},"Tag":{"$ref":"#/components/schemas/Tag"},"CreationDate":{"$ref":"#/components/schemas/CreationDate"},"HostedUrl":{"type":"string","description":"The URL to redirect the user to for the hosted identity verification session."},"Status":{"$ref":"#/components/schemas/IdvSessionStatus"},"ReturnUrl":{"type":"string","description":"The URL to which the user is returned after the hosted identity verification session, regardless of the outcome."}},"title":"CreateAnIDVSessionResponse"},"ViewAnIdvSessionResponseChecksItemsReasonsItems":{"type":"object","properties":{"Type":{"type":"string","description":"The type of the reason. For more details, see [refusals](/guides/users/verification/hosted/refusals)."},"Value":{"type":"string","description":"The explanation of the reason. If the refusal was automatic, this is a preset string. For Legal users, if the refusal follows a manual review, this is a custom explanation from the person who conducted the review."}},"title":"ViewAnIdvSessionResponseChecksItemsReasonsItems"},"ViewAnIdvSessionResponseChecksItemsDataItems":{"type":"object","properties":{"Type":{"type":"string","description":"The type of the data.\n\nFor a Natural user:\n\n* `FIRST_NAME`\n* `LAST_NAME`\n* `BIRTHDATE`\n\nFor a Legal user:\n\n* `COMPANY_NAME`\n* `COMPANY_NUMBER`\n* `LEGAL_REPRESENTATIVE_FIRST_NAME`\n* `LEGAL_REPRESENTATIVE_LAST_NAME`\n* `LEGAL_REPRESENTATIVE_BIRTHDATE`"},"Value":{"type":["string","null"],"description":"The value of the data. The value may be `null` or an empty string if data extraction was not possible but the check was still carried out."}},"title":"ViewAnIdvSessionResponseChecksItemsDataItems"},"ViewAnIdvSessionResponseChecksItems":{"type":"object","properties":{"CheckId":{"type":"string","description":"The unique identifier of the verification check."},"Type":{"type":"string","description":"Type of check carried out during the session depending on the user type:\n\n* `IDENTITY_DOCUMENT_VERIFICATION` - Verifies the authenticity of the identity document, the liveness of the selfie, and that the selfie matches the identity document photo.\n* `IDV_AGE_CHECK` - Checks whether the individual on the identity document meets the minimum age requirement for Mangopay users (age 18).\n* `BUSINESS_VERIFICATION` - Looks up the business details entered by the user during the session in the national registry to find a match.\n* `IDV_NAME_MATCH_CHECK` - Checks whether the first name, last name and date of birth of the identity document match the `FirstName`, `LastName`, and `Birthday` of the Natural user object or `LegalRepresentative` of the Legal user object.\n* `BUSINESS_NAME_MATCH` - Checks whether the name on the identity document is present in the name of the registered sole proprietor in the relevant national registry.\n* `BUSINESS_INSIGHTS_MATCH` - Checks whether the name on the identity document matches one of the directors listed in the national registry, and whether the PSC data declared in the session is coherent with the PSC data in the registry.\n* `PSC_ROLE_CHECK` - For Business, Organization, and Partnership Users, ensures the PSC form declares at least one UBO and at least one legal representative (a single PSC can hold both roles). Performed on every session, regardless of the business registry lookup outcome.\n* `PSC_CONSISTENCY_CHECK` - For Business, Organization, and Partnership Users, compares the PSC form against the business registry data and checks that any business-type PSC's ownership structure is adequately documented. Only performed if the business registry lookup found a match.\n\nFor information on which checks are performed for which user type and in which cases, see the dedicated guides: [Natural](/guides/users/verification/hosted/natural), [Soletrader](/guides/users/verification/hosted/soletrader), [Business and Organization](/guides/users/verification/hosted/business)."},"CheckStatus":{"type":"string","description":"**Returned values:** `VALIDATED`, `REFUSED`\n\nThe status of the verification check."},"Reasons":{"type":"array","items":{"$ref":"#/components/schemas/ViewAnIdvSessionResponseChecksItemsReasonsItems"},"description":"The reasons that the check was refused, which may be returned if `CheckStatus` was `REFUSED` (depending on the check type)."},"CreationDate":{"type":"integer","description":"Unix timestamp (UTC) of the date and time the check was created."},"LastUpdate":{"type":"integer","description":"Unix timestamp (UTC) of the date and time the check was last updated."},"Data":{"type":"array","items":{"$ref":"#/components/schemas/ViewAnIdvSessionResponseChecksItemsDataItems"},"description":"The data extracted and verified during the check.\n\nThis array may be empty if no data was extracted or is not applicable for the check."}},"title":"ViewAnIdvSessionResponseChecksItems"},"ViewAnIdvSessionResponsePsCsItemsDataItems":{"type":"object","properties":{"Type":{"type":"string","description":"The type of the data, depending on the `PSC_TYPE` declared in the session.\n\nIndividual:\n- `FIRST_NAME`\n- `LAST_NAME`\n- `PSC_TYPE`\n\nBusiness:\n- `PSC_LEGAL_REPRESENTATIVE_FIRST_NAME`\n- `PSC_LEGAL_REPRESENTATIVE_LAST_NAME`\n- `BUSINESS_PSC_NAME`\n- `PSC_TYPE`"},"Value":{"type":["string","null"],"description":"The value of the data."}},"title":"ViewAnIdvSessionResponsePsCsItemsDataItems"},"ViewAnIdvSessionResponsePsCsItems":{"type":"object","properties":{"Id":{"type":"string","description":"The unique identifier of the PSC."},"Status":{"type":"string","description":"The status of the PSC verification:\n- `PENDING_VALIDATION` – The PSC verification is ongoing.\n- `VALIDATED` – The PSC was validated.\n- `REJECTED` – One or more checks failed, or the PSC did not complete the verification within the allowed timeframe. By default, the PSC Session expires 7 days after the PSC's `CreationDate`, but if the PSC's liveness step has been started (the QR code was generated), it expires 1 hour after the liveness step started instead.\n- `ABANDONED` – The PSC verification was abandoned by Mangopay, for example if it was a duplicate of another declared PSC."},"HostedUrl":{"type":"string","description":"The URL to redirect the PSC to for the hosted verification session."},"CreationDate":{"type":"integer","description":"Unix timestamp (UTC) of the date and time the PSC was created."},"LastUpdate":{"type":"integer","description":"Unix timestamp (UTC) of the date and time the PSC was last updated."},"Data":{"type":"array","items":{"$ref":"#/components/schemas/ViewAnIdvSessionResponsePsCsItemsDataItems"},"description":"The data associated with the PSC."}},"title":"ViewAnIdvSessionResponsePsCsItems"},"ViewAnIDVSessionResponse":{"type":"object","properties":{"Id":{"$ref":"#/components/schemas/Id"},"Tag":{"$ref":"#/components/schemas/Tag"},"HostedUrl":{"type":"string","description":"The URL to redirect the user to for the hosted identity verification session."},"ReturnUrl":{"type":"string","description":"The URL to which the user is returned after the hosted identity verification session, regardless of the outcome."},"Status":{"$ref":"#/components/schemas/IdvSessionStatus"},"UserId":{"type":"string","description":"The unique identifier of the user."},"CreationDate":{"$ref":"#/components/schemas/CreationDate"},"LastUpdate":{"type":"integer","description":"Unix timestamp (UTC) of the date and time the session was last updated."},"Checks":{"type":["array","null"],"items":{"$ref":"#/components/schemas/ViewAnIdvSessionResponseChecksItems"},"description":"The checks performed automatically during the session.\n\nThis array is empty when `Status` is `PENDING` and may contain any number of objects depending on the outcome."},"PSCs":{"type":["array","null"],"items":{"$ref":"#/components/schemas/ViewAnIdvSessionResponsePsCsItems"},"description":"The list of persons of significant control (PSCs) declared during the session.\n\nOnly returned if the multi-session PSC flow is activated for `BUSINESS` and `ORGANIZATION` Legal Users.\n\nThis array is empty or `null` when not applicable."}},"title":"ViewAnIDVSessionResponse"},"ListIDVSessionsForAUserResponse":{"type":"object","properties":{"Id":{"$ref":"#/components/schemas/Id"},"Status":{"$ref":"#/components/schemas/IdvSessionStatus"},"CreationDate":{"$ref":"#/components/schemas/CreationDate"},"LastUpdate":{"type":"integer","description":"Unix timestamp (UTC) of the date and time the session was last updated."}},"title":"ListIDVSessionsForAUserResponse"},"RetryPscSessionRequest":{"type":"object","properties":{"FirstName":{"type":"string","description":"The first name of the PSC."},"LastName":{"type":"string","description":"The last name of the PSC."},"Email":{"type":"string","description":"The email address of the PSC."},"DateOfBirth":{"type":"integer","description":"Unix timestamp (UTC) of the date of birth of the PSC."}},"title":"RetryPscSessionRequest"},"RetryPscSessionResponse":{"type":"object","properties":{"Id":{"type":"string","description":"The unique identifier of the PSC."},"FirstName":{"type":"string","description":"The first name of the PSC."},"LastName":{"type":"string","description":"The last name of the PSC."},"Email":{"type":"string","description":"The email address of the PSC."},"DateOfBirth":{"type":"integer","description":"Unix timestamp (UTC) of the date of birth of the PSC."},"Country":{"type":"string","description":"The country of the PSC (ISO 3166-1 alpha-2 format)."},"Nationality":{"type":"string","description":"The nationality of the PSC (ISO 3166-1 alpha-2 format)."},"PscType":{"type":"string","description":"The type of the PSC:\n- `LEGAL_REP` – The PSC is a legal representative only.\n- `LEGAL_REP_AND_UBO` – The PSC is both a legal representative and a beneficial owner.\n- `UBO` – The PSC is a beneficial owner only."},"Status":{"type":"string","description":"The status of the PSC session:\n- `PENDING_VALIDATION` – The PSC session link has been generated and is awaiting completion.\n- `VALIDATED` – The PSC session was validated.\n- `REJECTED` – One or more checks failed, or the PSC did not complete the verification within the allowed timeframe. By default, the PSC Session expires 7 days after its `CreationDate`, but if the PSC's liveness step has been started (the QR code was generated), it expires 1 hour after the liveness step started instead.\n- `ABANDONED` – The PSC session was abandoned by Mangopay, for example if it was a duplicate of another declared PSC."},"CreationDate":{"$ref":"#/components/schemas/CreationDate"},"ValidationDate":{"type":["integer","null"],"description":"Unix timestamp (UTC) of the date and time the PSC session was validated. Returns `null` if not yet validated."},"HostedUrl":{"type":"string","description":"The URL to redirect the PSC to for the hosted verification session."}},"title":"RetryPscSessionResponse"},"ValidateTheFormatOfUserDataRequestCompanyNumber":{"type":"object","properties":{"CompanyNumber":{"type":"string","description":"The registration number of a legal entity, assigned by the relevant national authority.\n\n**Note:** Any non-alphanumeric characters, like dashes or spaces, are removed before applying the validation rules."},"CountryCode":{"type":"string","description":"Format: Two-letter country code ([ISO 3166-1 alpha-2 format](/api-reference/overview/data-formats))\n\nThe country of the registration of the legal entity, against which the company number format is validated."}},"required":["CompanyNumber","CountryCode"],"description":"Information about the registration number of a legal entity. For details, see the [Company number](/guides/users/verification/company-number) article.","title":"ValidateTheFormatOfUserDataRequestCompanyNumber"},"ValidateTheFormatOfUserDataRequest":{"type":"object","properties":{"CompanyNumber":{"$ref":"#/components/schemas/ValidateTheFormatOfUserDataRequestCompanyNumber","description":"Information about the registration number of a legal entity. For details, see the [Company number](/guides/users/verification/company-number) article."}},"title":"ValidateTheFormatOfUserDataRequest"},"ValidateTheFormatOfUserDataResponseCompanyNumber":{"type":"object","properties":{"CompanyNumber":{"type":"string","description":"The registration number of a legal entity, assigned by the relevant national authority."},"CountryCode":{"type":"string","description":"Format: Two-letter country code ([ISO 3166-1 alpha-2 format](/api-reference/overview/data-formats))\n\nThe country of the registration of the legal entity, against which the company number format is validated."},"IsValid":{"type":"boolean","description":"Whether the format of the company number is valid for the given country."},"ValidationRules":{"type":"array","items":{"type":"string"},"description":"The validation rules applied to the company number format for the given country."}},"description":"Information about the registration number of a legal entity. For details, see the [Company number](/guides/users/verification/company-number) article.","title":"ValidateTheFormatOfUserDataResponseCompanyNumber"},"ValidateTheFormatOfUserDataResponse":{"type":"object","properties":{"CompanyNumber":{"$ref":"#/components/schemas/ValidateTheFormatOfUserDataResponseCompanyNumber","description":"Information about the registration number of a legal entity. For details, see the [Company number](/guides/users/verification/company-number) article."}},"title":"ValidateTheFormatOfUserDataResponse"},"CreateADisputeDocumentRequest":{"type":"object","properties":{"Type":{"type":"string","description":"**Allowed values:** `DELIVERY_PROOF`, `INVOICE`, `REFUND_PROOF`, `USER_CORRESPONDANCE`, `USER_ACCEPTANCE_PROOF`, `PRODUCT_REPLACEMENT_PROOF`, `OTHER`\n\nThe type of the dispute document."},"Tag":{"$ref":"#/components/schemas/Tag"}},"required":["Type"],"title":"CreateADisputeDocumentRequest"},"KYCDocumentResponse":{"type":"object","properties":{"Type":{"type":"string","description":"**Returned values:** `IDENTITY_PROOF`, `REGISTRATION_PROOF`, `ARTICLES_OF_ASSOCIATION`, `SHAREHOLDER_DECLARATION`, `ADDRESS_PROOF`\n\nThe type of the document for the user verification."},"UserId":{"type":"string","description":"The unique identifier of the user."},"Flags":{"type":"array","items":{"type":"string"},"description":"**Returned values:** A code from the <a href=\"/guides/users/verification/documents/submission/refusals\" target=\"_blank\">Flags list</a>.\n\nThe series of codes providing more precision regarding the reason why the identity proof document was refused. You can review the explanations for each code in the <a href=\"/guides/users/verification/documents/submission/refusals\" target=\"_blank\">Flags list</a>."},"Id":{"$ref":"#/components/schemas/Id"},"Tag":{"$ref":"#/components/schemas/Tag"},"CreationDate":{"$ref":"#/components/schemas/CreationDate"},"ProcessedDate":{"type":"integer","description":"Unix timestamp (UTC) of the date and time the document was processed by Mangopay's team."},"Status":{"type":"string","description":"**Returned values:** `CREATED`, `VALIDATION_ASKED`, `VALIDATED`, `REFUSED`, `OUT_OF_DATE`\n\nThe status of the document:\n- `CREATED` – The document container is created and files can be uploaded using the [POST Create a KYC Document Page](/api-reference/kyc-documents/create-kyc-document-page) endpoint before submission.\n- `VALIDATION_ASKED` – The document is submitted to Mangopay for validation.\n- `VALIDATED` – The document is validated by Mangopay's teams.\n- `REFUSED` – The document is rejected by Mangopay's teams and a new KYC Document object needs to be created to resubmit it. You can learn more about the reason why it was refused in the `RefusedReasonType` parameter.\n- `OUT_OF_DATE` – The document is downgraded and a new KYC Document object needs to be created to resubmit it."},"RefusedReasonType":{"type":"string","description":"**Returned values:** DOCUMENT_DO_NOT_MATCH_USER_DATA, DOCUMENT_FALSIFIED, DOCUMENT_HAS_EXPIRED, DOCUMENT_INCOMPLETE, DOCUMENT_MISSING, DOCUMENT_NOT_ACCEPTED, DOCUMENT_UNREADABLE, SPECIFIC_CASE, UNDERAGE_PERSON\n\nReturned `null` unless `Status` is `REFUSED`.\n\nThe reason for the document refusal. See the <a href=\"/guides/users/verification/documents/submission/refusals\">refused reason types</a> for more information depending on the document type."},"RefusedReasonMessage":{"type":"string","description":"Max. length: 255 characters\n\n**Default value:** null Additional information about why the KYC Document was refused, provided by Mangopay's team."}},"title":"KYCDocumentResponse"},"UploadAClientLogoRequest":{"type":"object","properties":{"File":{"type":"string","description":"Format: Base64 encoded file\n\nThe encoded file of the logo to upload."}},"required":["File"],"title":"UploadAClientLogoRequest"},"kycDocuments_create_kyc_document_page_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"kycDocuments_create_kyc_document_page_Response_200"},"SubmitAKYCDocumentRequest":{"type":"object","properties":{"Status":{"type":"string","description":"**Allowed values:** `VALIDATION_ASKED`\n\nThe status of the document:\n- `CREATED` – The document container is created and files can be uploaded using the [POST Create a KYC Document Page](/api-reference/kyc-documents/create-kyc-document-page) endpoint before submission.\n- `VALIDATION_ASKED` – The document is submitted to Mangopay for validation.\n- `VALIDATED` – The document is validated by Mangopay's teams.\n- `REFUSED` – The document is rejected by Mangopay's teams and a new KYC Document object needs to be created to resubmit it. You can learn more about the reason why it was refused in the `RefusedReasonType` parameter.\n- `OUT_OF_DATE` – The document is downgraded and a new KYC Document object needs to be created to resubmit it."}},"required":["Status"],"title":"SubmitAKYCDocumentRequest"},"ListAllKycDocumentsResponseArrayKycDocumentItemsObjectKycDocument":{"type":"object","properties":{"Type":{"type":"string","description":"**Returned values:** `IDENTITY_PROOF`, `REGISTRATION_PROOF`, `ARTICLES_OF_ASSOCIATION`, `SHAREHOLDER_DECLARATION`, `ADDRESS_PROOF`\n\nThe type of the document for the user verification."},"UserId":{"type":"string","description":"The unique identifier of the user."},"Flags":{"type":"array","items":{"type":"string"},"description":"**Returned values:** A code from the <a href=\"/guides/users/verification/documents/submission/refusals\" target=\"_blank\">Flags list</a>.\n\nThe series of codes providing more precision regarding the reason why the identity proof document was refused. You can review the explanations for each code in the <a href=\"/guides/users/verification/documents/submission/refusals\" target=\"_blank\">Flags list</a>."},"Id":{"$ref":"#/components/schemas/Id"},"Tag":{"type":"string","description":"Custom data that you can add to this object. For transactions (pay-in, transfer, payout), you can use this parameter to identify corresponding information regarding the user, transaction, or payment methods on your platform."},"Status":{"type":"string","description":"**Returned values:** `CREATED`, `VALIDATION_ASKED`, `VALIDATED`, `REFUSED`, `OUT_OF_DATE`\n\nThe status of the document:\n- `CREATED` – The document container is created and files can be uploaded using the [POST Create a KYC Document Page](/api-reference/kyc-documents/create-kyc-document-page) endpoint before submission.\n- `VALIDATION_ASKED` – The document is submitted to Mangopay for validation.\n- `VALIDATED` – The document is validated by Mangopay's teams.\n- `REFUSED` – The document is rejected by Mangopay's teams and a new KYC Document object needs to be created to resubmit it. You can learn more about the reason why it was refused in the `RefusedReasonType` parameter.\n- `OUT_OF_DATE` – The document is downgraded and a new KYC Document object needs to be created to resubmit it."},"RefusedReasonType":{"type":"string","description":"**Returned values:** DOCUMENT_DO_NOT_MATCH_USER_DATA, DOCUMENT_FALSIFIED, DOCUMENT_HAS_EXPIRED, DOCUMENT_INCOMPLETE, DOCUMENT_MISSING, DOCUMENT_NOT_ACCEPTED, DOCUMENT_UNREADABLE, SPECIFIC_CASE, UNDERAGE_PERSON\n\nReturned `null` unless `Status` is `REFUSED`.\n\nThe reason for the document refusal. See the <a href=\"/guides/users/verification/documents/submission/refusals\">refused reason types</a> for more information depending on the document type."},"RefusedReasonMessage":{"type":"string","description":"**Default value:** null\n\nAdditional information about why the KYC Document was refused, provided by Mangopay's team."}},"description":"KYC Document created by the platform.","title":"ListAllKycDocumentsResponseArrayKycDocumentItemsObjectKycDocument"},"ListAllKycDocumentsResponseArrayKycDocumentItems":{"type":"object","properties":{"Object (KYCDocument)":{"$ref":"#/components/schemas/ListAllKycDocumentsResponseArrayKycDocumentItemsObjectKycDocument","description":"KYC Document created by the platform."}},"title":"ListAllKycDocumentsResponseArrayKycDocumentItems"},"ListAllKYCDocumentsResponse":{"type":"object","properties":{"Array (KYCDocument)":{"type":"array","items":{"$ref":"#/components/schemas/ListAllKycDocumentsResponseArrayKycDocumentItems"},"description":"The list of KYC documents created by the platform."}},"title":"ListAllKYCDocumentsResponse"},"UboDeclarationResponseUbosItemsObjectUboBirthplace":{"type":"object","properties":{"City":{"type":"string","description":"The city in which the beneficial owner was born."},"Country":{"type":"string","description":"Format: Two-letter country code ([ISO 3166-1 alpha-2 format](/api-reference/overview/data-formats))\n\nThe country in which the beneficial owner was born."}},"description":"Information about the beneficial owner's place of birth.","title":"UboDeclarationResponseUbosItemsObjectUboBirthplace"},"UboDeclarationResponseUbosItemsObjectUbo":{"type":"object","properties":{"Id":{"$ref":"#/components/schemas/Id"},"CreationDate":{"$ref":"#/components/schemas/CreationDate"},"LastName":{"type":"string","description":"The last name of the beneficial owner."},"Nationality":{"type":"string","description":"The nationality of the beneficial owner."},"Address":{"$ref":"#/components/schemas/Address"},"Birthplace":{"$ref":"#/components/schemas/UboDeclarationResponseUbosItemsObjectUboBirthplace","description":"Information about the beneficial owner's place of birth."},"IsActive":{"type":"boolean","description":"Whether or not the UBO is considered in the declaration. To disregard a UBO, this parameter must be set to `false`. This action is irreversible."}},"description":"The UBO object created by the platform.","title":"UboDeclarationResponseUbosItemsObjectUbo"},"UboDeclarationResponseUbosItems":{"type":"object","properties":{"Object (UBO)":{"$ref":"#/components/schemas/UboDeclarationResponseUbosItemsObjectUbo","description":"The UBO object created by the platform."}},"title":"UboDeclarationResponseUbosItems"},"UBODeclarationResponse":{"type":"object","properties":{"Id":{"$ref":"#/components/schemas/Id"},"UserId":{"type":"string","description":"The unique identifier of the user."},"CreationDate":{"$ref":"#/components/schemas/CreationDate"},"ProcessedDate":{"type":"integer","description":"Unix timestamp (UTC) of the date and time the UBO Declaration was processed by Mangopay's team."},"Status":{"type":"string","description":"**Returned values:** `CREATED`, `VALIDATION_ASKED`, `INCOMPLETE`, `VALIDATED`, `REFUSED`\n\nThe status of the declaration:\n- `CREATED` – The UBO Declaration is created, but not submitted yet.\n- `VALIDATION_ASKED` – The UBO Declaration is submitted for validation.\n- `INCOMPLETE` – The UBO Declaration is deemed incomplete by Mangopay teams.\n- `VALIDATED` – The UBO Declaration is validated by Mangopay's team.\n- `REFUSED` – The UBO Declaration is rejected by Mangopay's team. You can learn more about the reasons for refusal in the `Reason` and  `Message` fields."},"Reason":{"type":"string","description":"The reason for which the UBO Declaration was `REFUSED` or considered as `INCOMPLETE`."},"Message":{"type":"string","description":"Additional information about why the UBO Declaration was refused or marked as incomplete, provided by Mangopay's team."},"Ubos":{"type":"array","items":{"$ref":"#/components/schemas/UboDeclarationResponseUbosItems"},"description":"The list of UBOs attached to the UBO Declaration."}},"title":"UBODeclarationResponse"},"CreateAuboRequestBirthplace":{"type":"object","properties":{"City":{"type":"string","description":"The city in which the beneficial owner was born."},"Country":{"type":"string","description":"Format: Two-letter country code ([ISO 3166-1 alpha-2 format](/api-reference/overview/data-formats))\n\nThe country in which the beneficial owner was born."}},"required":["City","Country"],"description":"Information about the beneficial owner's place of birth.","title":"CreateAuboRequestBirthplace"},"CreateAUBORequest":{"type":"object","properties":{"LastName":{"type":"string","description":"Max. length: 100 characters\n\nThe last name of the beneficial owner."},"FirstName":{"type":"string","description":"Max. length: 100 characters\n\nThe first name of the beneficial owner."},"Birthday":{"type":"integer","description":"The date of birth of the beneficial owner.\n\n**Note:** This is a Unix timestamp in UTC. Ensure you convert your timezone to UTC to avoid midnight being interpreted as the day before."},"Nationality":{"type":"string","description":"Format: Two-letter country code ([ISO 3166-1 alpha-2 format](/api-reference/overview/data-formats))\n\nThe nationality of the beneficial owner."},"Address":{"$ref":"#/components/schemas/Address_SubPropsRequired"},"Birthplace":{"$ref":"#/components/schemas/CreateAuboRequestBirthplace","description":"Information about the beneficial owner's place of birth."}},"required":["LastName","FirstName","Birthday","Nationality","Address","Birthplace"],"title":"CreateAUBORequest"},"UboResponseBirthplace":{"type":"object","properties":{"City":{"type":"string","description":"The city in which the beneficial owner was born."},"Country":{"type":"string","description":"Format: Two-letter country code ([ISO 3166-1 alpha-2 format](/api-reference/overview/data-formats))\n\nThe country in which the beneficial owner was born."}},"description":"Information about the beneficial owner's place of birth.","title":"UboResponseBirthplace"},"UBOResponse":{"type":"object","properties":{"Id":{"$ref":"#/components/schemas/Id"},"CreationDate":{"$ref":"#/components/schemas/CreationDate"},"LastName":{"type":"string","description":"Max. length: 100 characters\n\nThe last name of the beneficial owner."},"FirstName":{"type":"string","description":"Max. length: 100 characters\n\nThe first name of the beneficial owner."},"Birthday":{"type":"integer","description":"The date of birth of the beneficial owner.\n\n**Note:** This is a Unix timestamp in UTC. Ensure you convert your timezone to UTC to avoid midnight being interpreted as the day before."},"Nationality":{"type":"string","description":"The nationality of the beneficial owner."},"Address":{"$ref":"#/components/schemas/Address"},"Birthplace":{"$ref":"#/components/schemas/UboResponseBirthplace","description":"Information about the beneficial owner's place of birth."},"IsActive":{"type":"boolean","description":"Whether or not the UBO is considered in the declaration. To disregard a UBO, this parameter must be set to `false`. This action is irreversible."}},"title":"UBOResponse"},"SubmitADisputeDocumentRequest":{"type":"object","properties":{"Status":{"type":"string","description":"**Allowed values:** `VALIDATION_ASKED`\n\nThe status of the dispute document."}},"required":["Status"],"title":"SubmitADisputeDocumentRequest"},"UpdateAuboRequestBirthplace":{"type":"object","properties":{"City":{"type":"string","description":"The city in which the beneficial owner was born."},"Country":{"type":"string","description":"Format: Two-letter country code ([ISO 3166-1 alpha-2 format](/api-reference/overview/data-formats))\n\nThe country in which the beneficial owner was born."}},"required":["City","Country"],"description":"Information about the beneficial owner's place of birth.","title":"UpdateAuboRequestBirthplace"},"UpdateAUBORequest":{"type":"object","properties":{"LastName":{"type":"string","description":"Max. length: 100 characters\n\nThe last name of the beneficial owner."},"FirstName":{"type":"string","description":"Max. length: 100 characters\n\nThe first name of the beneficial owner."},"Birthday":{"type":"integer","description":"The date of birth of the beneficial owner.\n\n**Note:** This is a Unix timestamp in UTC. Ensure you convert your timezone to UTC to avoid midnight being interpreted as the day before."},"Nationality":{"type":"string","description":"Format: Two-letter country code ([ISO 3166-1 alpha-2 format](/api-reference/overview/data-formats))\n\nThe nationality of the beneficial owner."},"Address":{"$ref":"#/components/schemas/Address_SubPropsRequired"},"Birthplace":{"$ref":"#/components/schemas/UpdateAuboRequestBirthplace","description":"Information about the beneficial owner's place of birth."},"IsActive":{"type":"boolean","description":"Whether or not the UBO is considered in the declaration. To disregard a UBO, set this parameter to `false`. This action is irreversible."}},"title":"UpdateAUBORequest"},"VerifiedIdentityAddress":{"type":"object","properties":{"AddressLine1":{"type":["string","null"],"description":"The first line of the address."},"AddressLine2":{"type":["string","null"],"description":"The second line of the address."},"City":{"type":["string","null"],"description":"The city of the address."},"Region":{"type":["string","null"],"description":"The state, region, or province of the address."},"PostalCode":{"type":["string","null"],"description":"The postal code of the address."},"Country":{"type":["string","null"],"description":"Format: Two-letter country code ([ISO 3166-1 alpha-2 format](/api-reference/overview/data-formats))\n\nThe country of the address."}},"description":"The verified postal address.\n\nThis property is omitted from the response if no usable verified address is available.","title":"VerifiedIdentityAddress"},"VerifiedIdentityDocument":{"type":"object","properties":{"DocumentType":{"type":"string","description":"**Example value:** `IDENTITY_PROOF`\n\nThe type of the verification document. Treat this as an extensible value, because further values can be returned."},"Status":{"type":"string","description":"**Example value:** `VALIDATED`\n\nThe status returned for the document. Treat this as an extensible value, because further values can be returned."},"DocumentExpiryDate":{"type":["string","null"],"description":"Format: ISO 8601 date-time (for example, `2030-06-30T00:00:00Z`)\n\nThe expiry date of the document, if applicable."},"DocumentUrls":{"type":"array","items":{"type":"string"},"description":"The signed download URLs of the pages of the document, in page order.\n\nEach URL is generated when the endpoint is called and grants access for a limited validity period only, which is not returned as a separate property. Download the document before the URL expires, and call the endpoint again to obtain a new URL if you need access afterwards.\n\nDo not cache, persist, or share these URLs, and do not use them as document identifiers."}},"description":"A verification document validated by Mangopay.\n\nOnly documents whose expiry date is today or later are returned, along with documents that have no expiry date. Documents are not filtered on `Status`.","title":"VerifiedIdentityDocument"},"NaturalUserVerifiedIdentityResponse":{"type":"object","properties":{"ClientId":{"type":"string","description":"Platform's API account identifier, as sent in the request."},"UserId":{"type":"string","description":"The unique identifier of the user, as sent in the request."},"UserType":{"type":"string","description":"**Returned value:** `NATURAL`\n\nThe type of the user, which determines the payload returned."},"FirstName":{"type":["string","null"],"description":"The verified first name of the user."},"LastName":{"type":["string","null"],"description":"The verified last name of the user."},"BirthdayDate":{"type":["string","null"],"description":"Format: ISO 8601 date-time (for example, `1990-01-01T00:00:00Z`)\n\nThe verified date of birth of the user."},"Nationality":{"type":["string","null"],"description":"Format: Two-letter country code ([ISO 3166-1 alpha-2 format](/api-reference/overview/data-formats))\n\nThe verified nationality of the user."},"CountryOfResidence":{"type":["string","null"],"description":"Format: Two-letter country code ([ISO 3166-1 alpha-2 format](/api-reference/overview/data-formats))\n\nThe verified country of residence of the user."},"Address":{"$ref":"#/components/schemas/VerifiedIdentityAddress"},"Documents":{"type":"array","items":{"$ref":"#/components/schemas/VerifiedIdentityDocument"},"description":"The non-expired verification documents of the user. The array is empty if no document is returned."}},"description":"Response if the user's `UserType` is `NATURAL`.\n\nIdentity properties can be returned `null` even for a user whose KYC/KYB verification is validated, because the data available depends on the verification received for that user.","title":"NaturalUserVerifiedIdentityResponse"},"VerifiedIdentityLegalRepresentative":{"type":"object","properties":{"FirstName":{"type":["string","null"],"description":"The verified first name of the legal representative."},"LastName":{"type":["string","null"],"description":"The verified last name of the legal representative."},"BirthdayDate":{"type":["string","null"],"description":"Format: ISO 8601 date-time (for example, `1985-05-15T00:00:00Z`)\n\nThe verified date of birth of the legal representative."},"Nationality":{"type":["string","null"],"description":"Format: Two-letter country code ([ISO 3166-1 alpha-2 format](/api-reference/overview/data-formats))\n\nThe verified nationality of the legal representative."},"CountryOfResidence":{"type":["string","null"],"description":"Format: Two-letter country code ([ISO 3166-1 alpha-2 format](/api-reference/overview/data-formats))\n\nThe verified country of residence of the legal representative."}},"description":"The verified legal representative of the company.","title":"VerifiedIdentityLegalRepresentative"},"VerifiedIdentityPSC":{"type":"object","properties":{"PscExternalId":{"type":"string","description":"The unique identifier of the PSC."},"PscType":{"type":"string","description":"**Example values:** `DIRECTOR`, `SHAREHOLDER`\n\nThe role or type of the PSC. Treat this as an extensible value, because further values can be returned."},"FirstName":{"type":["string","null"],"description":"The verified first name of the PSC."},"LastName":{"type":["string","null"],"description":"The verified last name of the PSC."},"BirthdayDate":{"type":["string","null"],"description":"Format: ISO 8601 date-time (for example, `1978-09-20T00:00:00Z`)\n\nThe verified date of birth of the PSC."},"Nationality":{"type":["string","null"],"description":"Format: Two-letter country code ([ISO 3166-1 alpha-2 format](/api-reference/overview/data-formats))\n\nThe verified nationality of the PSC."},"CountryOfResidence":{"type":["string","null"],"description":"Format: Two-letter country code ([ISO 3166-1 alpha-2 format](/api-reference/overview/data-formats))\n\nThe verified country of residence of the PSC."},"Documents":{"type":"array","items":{"$ref":"#/components/schemas/VerifiedIdentityDocument"},"description":"The non-expired verification documents of the PSC. The array is empty if no document is returned."}},"description":"The verified person with significant control (PSC) of the company.","title":"VerifiedIdentityPSC"},"LegalUserVerifiedIdentityResponse":{"type":"object","properties":{"ClientId":{"type":"string","description":"Platform's API account identifier, as sent in the request."},"UserId":{"type":"string","description":"The unique identifier of the user, as sent in the request."},"UserType":{"type":"string","description":"**Returned values:** `LEGAL_BUSINESS`, `LEGAL_ORGANIZATION`, `LEGAL_PARTNERSHIP`, `LEGAL_SOLETRADER`\n\nThe type of the user, which determines the payload returned."},"CompanyName":{"type":["string","null"],"description":"The verified name of the company."},"CompanyNumber":{"type":"string","description":"The verified registration number of the company.\n\nThis property is omitted from the response if the company number is unavailable."},"HeadquartersAddress":{"$ref":"#/components/schemas/VerifiedIdentityAddress"},"LegalRepresentatives":{"type":"array","items":{"$ref":"#/components/schemas/VerifiedIdentityLegalRepresentative"},"description":"The verified legal representatives of the company, returned for users verified with [KYC Documents](/api-reference/kyc-documents/kyc-document-object). It represents the legal representative verified in the main verification session, and currently contains zero or one legal representative.\n\nUsers verified with the [hosted KYC/KYB solution](/guides/users/verification/hosted) return their persons with significant control (PSCs) in `Pscs` instead, so do not rely on `LegalRepresentatives` being populated for them."},"Documents":{"type":"array","items":{"$ref":"#/components/schemas/VerifiedIdentityDocument"},"description":"The non-expired documents of the main verification session, which for a Legal User is the legal representative's session. The array is empty if no document is returned."},"Pscs":{"type":"array","items":{"$ref":"#/components/schemas/VerifiedIdentityPSC"},"description":"The verified persons with significant control (PSCs) of the company and their documents, returned for users verified with the [hosted KYC/KYB solution](/guides/users/verification/hosted). The array is empty if no PSC is returned.\n\nDo not use `LegalRepresentatives` as a substitute for the data returned in `Pscs`."}},"description":"Response if the user's `UserType` is `LEGAL_BUSINESS`, `LEGAL_ORGANIZATION`, `LEGAL_PARTNERSHIP`, or `LEGAL_SOLETRADER`.\n\nIdentity properties can be returned `null` even for a user whose KYC/KYB verification is validated, because the data available depends on the verification received for that user.","title":"LegalUserVerifiedIdentityResponse"},"ViewUserVerifiedIdentityResponse":{"oneOf":[{"$ref":"#/components/schemas/NaturalUserVerifiedIdentityResponse"},{"$ref":"#/components/schemas/LegalUserVerifiedIdentityResponse"}],"title":"ViewUserVerifiedIdentityResponse"},"CreateAWalletRequest":{"type":"object","properties":{"Description":{"type":"string","description":"Max. length: 255 characters\n\nThe description of the wallet. It can be a name, the type, or anything else that can help you clearly identify the wallet on the platform (and for your end users)."},"Owners":{"type":"array","items":{"type":"string"},"description":"The unique identifier of the user owning the wallet. \n\n**Note:** Only one owner can be defined; this array accepts only one string."},"Currency":{"type":"string","description":"**Allowed values:** The three-letter <a href=\"/api-reference/overview/data-formats\" target=\"_blank\">ISO 4217 code</a> (EUR, GBP, etc) of a <a href=\"/guides/currencies\" target=\"_blank\">supported currency</a> (depends on feature, contract, and activation settings).\n\nThe currency of the wallet."},"Tag":{"$ref":"#/components/schemas/Tag"}},"required":["Description","Owners","Currency"],"title":"CreateAWalletRequest"},"UserWalletResponseBalance":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"The current balance of the wallet.","title":"UserWalletResponseBalance"},"UserWalletResponse":{"type":"object","properties":{"Description":{"type":"string","description":"Max. length: 255 characters\n\nThe description of the wallet. It can be a name, the type, or anything else that can help you clearly identify the wallet on the platform (and for your end users)."},"Owners":{"type":"array","items":{"type":"string"},"description":"The unique identifier of the user owning the wallet. \n\n**Note:** Only one owner can be defined; this array accepts only one string."},"Id":{"$ref":"#/components/schemas/Id"},"Balance":{"$ref":"#/components/schemas/UserWalletResponseBalance","description":"The current balance of the wallet."},"Currency":{"type":"string","description":"**Allowed values:** The three-letter <a href=\"/api-reference/overview/data-formats\" target=\"_blank\">ISO 4217 code</a> (EUR, GBP, etc.) of a <a href=\"/guides/currencies\" target=\"_blank\">supported currency</a> (depends on feature, contract, and activation settings).\n\nThe currency of the wallet."},"FundsType":{"type":"string","description":"**Returned values:** `DEFAULT`, `FEES`, `CREDIT`\n\nThe type of funds in the wallet:\n- `DEFAULT` – Regular funds for user-owned wallets. Wallets with this `FundsType` cannot have a negative balance.\n- `FEES` – Fees Wallet, for fees collected by the platform, specific to the Client Wallet object.\n- `CREDIT` – Repudiation Wallet, for funds for the platform's dispute management, specific to the Client Wallet object.\n\n**Note:** The Fees Wallet and Repudiation Wallet are created automatically by Mangopay for each currency."},"Tag":{"$ref":"#/components/schemas/Tag"},"CreationDate":{"type":"integer","description":"Unix timestamp (UTC) of the date and time the wallet was created."}},"title":"UserWalletResponse"},"UpdateAWalletRequest":{"type":"object","properties":{"Description":{"type":"string","description":"Max. length: 255 characters\n\nThe description of the wallet. It can be a name, the type, or anything else that can help you clearly identify the wallet on the platform (and for your end users)."},"Tag":{"$ref":"#/components/schemas/Tag"}},"title":"UpdateAWalletRequest"},"ListWalletsForAUserResponseArrayWalletsItemsObjectWalletBalance":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"The current balance of the wallet.","title":"ListWalletsForAUserResponseArrayWalletsItemsObjectWalletBalance"},"ListWalletsForAUserResponseArrayWalletsItemsObjectWallet":{"type":"object","properties":{"Description":{"type":"string","description":"The description of the wallet. It can be a name, the type, or anything else that can help you clearly identify the wallet on the platform (and for your end users)."},"Owners":{"type":"array","items":{"type":"string"},"description":"The unique identifier of the user owning the wallet. \n\n**Note:** Only one owner can be defined; this array accepts only one string."},"Balance":{"$ref":"#/components/schemas/ListWalletsForAUserResponseArrayWalletsItemsObjectWalletBalance","description":"The current balance of the wallet."},"Currency":{"type":"string","description":"**Returned values:** The three-letter <a href=\"/api-reference/overview/data-formats\" target=\"_blank\">ISO 4217 code</a> (EUR, GBP, etc.) of a <a href=\"/guides/currencies\" target=\"_blank\">supported currency</a> (depends on feature, contract, and activation settings).\n\nThe currency of the wallet."},"FundsType":{"type":"string","description":"**Returned values:** `DEFAULT`, `FEES`, `CREDIT`\n\nThe type of funds in the wallet:\n- `DEFAULT` – Regular funds for user-owned wallets. Wallets with this `FundsType` cannot have a negative balance.\n- `FEES` – Fees Wallet, for fees collected by the platform, specific to the Client Wallet object.\n- `CREDIT` – Repudiation Wallet, for funds for the platform's dispute management, specific to the Client Wallet object.\n\n**Note:** The Fees Wallet and Repudiation Wallet are created automatically by Mangopay for each currency."},"Id":{"$ref":"#/components/schemas/Id"},"Tag":{"type":"string","description":"Custom data that you can add to this object. For wallets, you can use this parameter to identify the corresponding end user in your platform."},"CreationDate":{"type":"integer","description":"Unix timestamp (UTC) of the date and time the wallet was created."}},"description":"The Wallet object created by the platform.","title":"ListWalletsForAUserResponseArrayWalletsItemsObjectWallet"},"ListWalletsForAUserResponseArrayWalletsItems":{"type":"object","properties":{"Object (Wallet)":{"$ref":"#/components/schemas/ListWalletsForAUserResponseArrayWalletsItemsObjectWallet","description":"The Wallet object created by the platform."}},"title":"ListWalletsForAUserResponseArrayWalletsItems"},"ListWalletsForAUserResponse":{"type":"object","properties":{"Array (Wallets)":{"type":"array","items":{"$ref":"#/components/schemas/ListWalletsForAUserResponseArrayWalletsItems"},"description":"The list of wallets created by the platform."}},"title":"ListWalletsForAUserResponse"},"ClientWalletResponseBalance":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"The current balance of the wallet.","title":"ClientWalletResponseBalance"},"ClientWalletResponse":{"type":"object","properties":{"Balance":{"$ref":"#/components/schemas/ClientWalletResponseBalance","description":"The current balance of the wallet."},"Currency":{"type":"string","description":"**Allowed values:** The three-letter <a href=\"/api-reference/overview/data-formats\" target=\"_blank\">ISO 4217 code</a> (EUR, GBP, etc.) of a <a href=\"/guides/currencies\" target=\"_blank\">supported currency</a> (depends on feature, contract, and activation settings).\n\nThe currency of the wallet."},"FundsType":{"type":"string","description":"**Returned values:** `DEFAULT`, `FEES`, `CREDIT`\n\nThe type of funds in the wallet:\n- `DEFAULT` – Regular funds for user-owned wallets. Wallets with this `FundsType` cannot have a negative balance.\n- `FEES` – Fees Wallet, for fees collected by the platform, specific to the Client Wallet object.\n- `CREDIT` – Repudiation Wallet, for funds for the platform's dispute management, specific to the Client Wallet object.\n\n**Note:** The Fees Wallet and Repudiation Wallet are created automatically by Mangopay for each currency."},"Id":{"type":"string","description":"The unique identifier of the wallet.\n\nThe `Id` of Client Wallet object has the format `FundsType`_`Currency`, for example: `FEES_EUR`, `CREDIT_GBP`, etc."},"Tag":{"$ref":"#/components/schemas/Tag"},"CreationDate":{"type":"integer","description":"Unix timestamp (UTC) of the date and time the wallet was created."}},"title":"ClientWalletResponse"},"ListAllClientWalletsResponseArrayClientWalletsItemsObjectClientWalletBalance":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"The current balance of the wallet.","title":"ListAllClientWalletsResponseArrayClientWalletsItemsObjectClientWalletBalance"},"ListAllClientWalletsResponseArrayClientWalletsItemsObjectClientWallet":{"type":"object","properties":{"Balance":{"$ref":"#/components/schemas/ListAllClientWalletsResponseArrayClientWalletsItemsObjectClientWalletBalance","description":"The current balance of the wallet."},"Currency":{"type":"string","description":"**Returned values:** The three-letter <a href=\"/api-reference/overview/data-formats\" target=\"_blank\">ISO 4217 code</a> (EUR, GBP, etc.) of a <a href=\"/guides/currencies\" target=\"_blank\">supported currency</a> (depends on feature, contract, and activation settings).\n\nThe currency of the wallet."},"FundsType":{"type":"string","description":"**Returned values:** `DEFAULT`, `FEES`, `CREDIT`\n\nThe type of funds in the wallet:\n- `DEFAULT` – Regular funds for user-owned wallets. Wallets with this `FundsType` cannot have a negative balance.\n- `FEES` – Fees Wallet, for fees collected by the platform, specific to the Client Wallet object.\n- `CREDIT` – Repudiation Wallet, for funds for the platform's dispute management, specific to the Client Wallet object.\n\n**Note:** The Fees Wallet and Repudiation Wallet are created automatically by Mangopay for each currency."},"Id":{"type":"string","description":"The unique identifier of the wallet.\n\nThe `Id` of Client Wallet object has the format `FundsType`_`Currency`, for example: `FEES_EUR`, `CREDIT_GBP`, etc."},"Tag":{"type":"string","description":"Custom data that you can add to this object. For wallets, you can use this parameter to identify the corresponding end user in your platform."},"CreationDate":{"type":"integer","description":"Unix timestamp (UTC) of the date and time the wallet was created."}},"description":"The Client Wallet object created by MANGOPAY.","title":"ListAllClientWalletsResponseArrayClientWalletsItemsObjectClientWallet"},"ListAllClientWalletsResponseArrayClientWalletsItems":{"type":"object","properties":{"Object (Client Wallet)":{"$ref":"#/components/schemas/ListAllClientWalletsResponseArrayClientWalletsItemsObjectClientWallet","description":"The Client Wallet object created by MANGOPAY."}},"title":"ListAllClientWalletsResponseArrayClientWalletsItems"},"ListAllClientWalletsResponse":{"type":"object","properties":{"Array (Client Wallets)":{"type":"array","items":{"$ref":"#/components/schemas/ListAllClientWalletsResponseArrayClientWalletsItems"},"description":"The list of Client Wallets."}},"title":"ListAllClientWalletsResponse"},"CreateACardRegistrationRequest":{"type":"object","properties":{"Tag":{"type":"string","description":"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":{"type":"string","description":"The unique identifier of the user the card belongs to."},"CardType":{"type":"string","description":"**Allowed values:** `CB_VISA_MASTERCARD`, `AMEX`, `MAESTRO`, `BCMC`\n\n**Default value:** `CB_VISA_MASTERCARD`\n\nThe type of the card. If not supplied, the default value will be taken into account."},"Currency":{"type":"string","description":"**Allowed values:** The three-letter <a href=\"/api-reference/overview/data-formats\" target=\"_blank\">ISO 4217 code</a> (EUR, GBP, etc.) of a <a href=\"/guides/currencies\" target=\"_blank\">supported currency</a> (depends on feature, contract, and activation settings).\n\nThe currency of the card."}},"required":["UserId","Currency"],"title":"CreateACardRegistrationRequest"},"ResultCode":{"type":"string","description":"The code indicating the result of the operation. This information is mostly used to <a href=\"/errors/codes\">handle errors</a> or for filtering purposes.","title":"ResultCode"},"ResultMessage":{"type":"string","description":"The explanation of the result code.","title":"ResultMessage"},"CardRegistrationResponse":{"type":"object","properties":{"Id":{"type":"string","description":"The unique identifier of the Card Registration object."},"Tag":{"type":"string","description":"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":{"$ref":"#/components/schemas/CreationDate"},"UserId":{"type":"string","description":"The unique identifier of the user the card belongs to."},"AccessKey":{"type":"string","description":"The secure value to use when tokenizing the card via the dedicated endpoint."},"PreregistrationData":{"type":"string","description":"The secure value to identify the registration when tokenizing the card via the dedicated endpoint."},"RegistrationData":{"type":"string","description":"The string returned by the tokenization server, which must be sent in full as the `RegistrationData` on the <a href=\"/api-reference/card-registrations/update-card-registration\">PUT Update a Card Registration</a> endpoint to create the Card object."},"CardId":{"type":"string","description":"The unique identifier of the Card object, which is returned after updating the Card Registration object with the `RegistrationData`."},"CardType":{"type":"string","description":"**Returned values:** `CB_VISA_MASTERCARD`, `AMEX`, `MAESTRO`, `BCMC`\n\n**Default value:** `CB_VISA_MASTERCARD`\n\nThe type of the card. If not supplied, the default value will be taken into account."},"CardRegistrationURL":{"type":"string","description":"The URL to make the card tokenization call.\n\n**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":{"$ref":"#/components/schemas/ResultCode"},"ResultMessage":{"$ref":"#/components/schemas/ResultMessage"},"Currency":{"type":"string","description":"**Returned values:** The three-letter <a href=\"/api-reference/overview/data-formats\" target=\"_blank\">ISO 4217 code</a> (EUR, GBP, etc.) of a <a href=\"/guides/currencies\" target=\"_blank\">supported currency</a> (depends on feature, contract, and activation settings).\n\nThe currency of the card."},"Status":{"type":"string","description":"**Returned values:** `CREATED`, `VALIDATED`, `ERROR`\n\nThe status of the card registration:\n- `CREATED` – The card registration has been created, but no `RegistrationData` has been entered yet and the `CardId` value is `null`.\n- `VALIDATED` – The card registration has been successfully updated with the `RegistrationData` from the tokenization server.\n- `ERROR` – The card registration couldn't be updated with the `RegistrationData` and no `CardId` was generated. For more information, refer to the `ResultCode` (<a href=\"/errors/codes/105206\">105206</a>, <a href=\"/errors/codes/105299\">105299</a>) and `ResultMessage`."}},"title":"CardRegistrationResponse"},"UpdateACardRegistrationRequest":{"type":"object","properties":{"RegistrationData":{"type":"string","description":"The string returned by the tokenization server on the <a href=\"/api-reference/card-registrations/tokenize-card\">POST Tokenize the card</a> endpoint."},"CardHolderName":{"type":"string","description":"Min. length: 2 characters; max. length: 45 characters passed to card network, 255 accepted by the API\n\nThe cardholder's name shown on the payment card. This value is passed to the card network for use in transaction risk analysis. The value should only contain unmarked alphabetic characters (A-Z, a-z), hyphens (-), apostrophes ('), and spaces. Letters with diacritics (e.g. É, Ü, ẞ), honorifics (e.g. MRS.) and other special characters are not recommended. The `CardHolderName` is not returned in the Card Registration object; it is added to the Card object."}},"required":["RegistrationData"],"title":"UpdateACardRegistrationRequest"},"DeactivateOrEditACardRequest":{"type":"object","properties":{"Active":{"type":"boolean","description":"Whether the card is active or not. Setting this parameter to `false` is irreversible and should be done once the pay-in is successful."},"CardHolderName":{"type":"string","description":"Max. length: 45 characters passed to card network, 255 accepted by the API\n\nThe cardholder's name shown on the payment card. This value is passed to the card network for use in transaction risk analysis. The value should only contain unmarked alphabetic characters (A-Z, a-z), hyphens (-), apostrophes ('), and spaces. Letters with diacritics (e.g. É, Ü, ẞ), honorifics (e.g. MRS.) and other special characters are not recommended (they are transformed before being sent to the card network). The `CardHolderName` is not returned in the Card Registration object; it is added to the Card object."}},"title":"DeactivateOrEditACardRequest"},"Validity":{"type":"string","description":"**Returned values:** `UNKNOWN`, `VALID`, `INVALID`\n\nWhether the card is valid or not.\n- `UNKNOWN` – No payment or card validation has been processed, so the validity of the card remains unknown.\n- `VALID` – The first payment or card validation using the card was processed successfully within 24 hours of the initial card registration.\n- `INVALID` – The first payment or card validation using the card was attempted and failed, or the status of the corresponding card registration was `CREATED` for more than 24 hours.\nOnce a card is set to `INVALID`, it cannot be set back to `VALID`. A new card registration will be necessary to make a payment.","title":"Validity"},"DeactivateOrEditACardResponse":{"type":"object","properties":{"ExpirationDate":{"type":"string","description":"Format: “MMYY”\n\nThe expiration date of the card."},"Alias":{"type":"string","description":"The card number, partially obfuscated."},"CardType":{"type":"string","description":"**Returned values:** `CB_VISA_MASTERCARD`, `AMEX`, `MAESTRO`, `BCMC`\n\n**Default value:** `CB_VISA_MASTERCARD`\n\nThe type of the card. If not supplied, the default value will be taken into account."},"CardProvider":{"type":"string","description":"**Allowed values:** `CB`, `VISA`, `MASTERCARD`, `AMEX`, `MAESTRO`, `BCMC`, `JCB`, `DISCOVER`\n\nThe provider of the card."},"Country":{"type":"string","description":"Format: ISO-3166-1 alpha-3 three-letter country code (e.g., “FRA”)\n\nThe country of the card (which is the same as the country of the issuer)."},"Product":{"type":"string","description":"The product type of the card."},"BankCode":{"type":"string","description":"The name of the card issuing bank."},"Active":{"type":"boolean","description":"Whether the card is active or not. Setting this parameter to `false` is irreversible and should be done once the pay-in is successful."},"Currency":{"type":"string","description":"**Returned values:** The three-letter <a href=\"/api-reference/overview/data-formats\" target=\"_blank\">ISO 4217 code</a> (EUR, GBP, etc.) of a <a href=\"/guides/currencies\" target=\"_blank\">supported currency</a> (depends on feature, contract, and activation settings).\n\nThe currency of the card."},"Validity":{"$ref":"#/components/schemas/Validity"},"UserId":{"type":"string","description":"The unique identifier of the user the card belongs to."},"Id":{"$ref":"#/components/schemas/Id"},"Tag":{"type":"string","description":"Custom data added to this object. In the case of the Card object, the tag value is inherited from the Card Registration object and is not editable."},"Fingerprint":{"type":"string","description":"The unique representation of the card number. This string can be used to track the card behavior while keeping the card information confidential."},"CardHolderName":{"type":"string","description":"Max. length: 45 characters\n\nThe cardholder's name shown on the payment card. This value is passed to the card network for use in transaction risk analysis."}},"title":"DeactivateOrEditACardResponse"},"ViewACardResponse":{"type":"object","properties":{"ExpirationDate":{"type":"string","description":"Format: “MMYY”\n\nThe expiration date of the card."},"Alias":{"type":"string","description":"The card number, partially obfuscated."},"CardType":{"type":"string","description":"**Returned values:** `CB_VISA_MASTERCARD`, `AMEX`, `MAESTRO`, `BCMC`\n\n**Default value:** `CB_VISA_MASTERCARD`\n\nThe type of the card. If not supplied, the default value will be taken into account."},"CardProvider":{"type":"string","description":"**Allowed values:** `CB`, `VISA`, `MASTERCARD`, `AMEX`, `MAESTRO`, `BCMC`, `JCB`, `DISCOVER`\n\nThe provider of the card."},"Country":{"type":"string","description":"Format: ISO-3166-1 alpha-3 three-letter country code (e.g., “FRA”)\n\nThe country of the card (which is the same as the country of the issuer)."},"Product":{"type":"string","description":"The product type of the card."},"BankCode":{"type":"string","description":"The name of the card issuing bank."},"Active":{"type":"boolean","description":"Whether the card is active or not. Setting this parameter to `false` is irreversible and should be done once the pay-in is successful."},"Currency":{"type":"string","description":"**Returned values:** The three-letter <a href=\"/api-reference/overview/data-formats\" target=\"_blank\">ISO 4217 code</a> (EUR, GBP, etc.) of a <a href=\"/guides/currencies\" target=\"_blank\">supported currency</a> (depends on feature, contract, and activation settings).\n\nThe currency of the card."},"Validity":{"$ref":"#/components/schemas/Validity"},"UserId":{"type":"string","description":"The unique identifier of the User (natural or legal) who owns the bank account."},"Id":{"$ref":"#/components/schemas/Id"},"Tag":{"type":"string","description":"Max. length: 255 characters\n\nCustom data that you can add to this object."},"CreationDate":{"$ref":"#/components/schemas/CreationDate"},"Fingerprint":{"type":"string","description":"The unique representation of the card number. This string can be used to track the card behavior while keeping the card information confidential."},"CardHolderName":{"type":"string","description":"Min. length: 2 characters; max. length: 45 characters passed to card network, 255 accepted by the API\n\nThe cardholder's name shown on the payment card. This value is passed to the card network for use in transaction risk analysis.\n\nThe value should only contain unmarked alphabetic characters (A-Z, a-z), hyphens (-), apostrophes ('), and spaces. Letters with diacritics (e.g. É, Ü, ẞ), honorifics (e.g. MRS.) and other special characters are not recommended.\n\nThe `CardHolderName` is not returned in the Card Registration object; it is added to the Card object."}},"title":"ViewACardResponse"},"ListCardsForAFingerprintResponseArrayCardsItemsCard":{"type":"object","properties":{"ExpirationDate":{"type":"string","description":"The expiration date of the card."},"Alias":{"type":"string","description":"The card number, partially obfuscated."},"CardType":{"type":"string","description":"**Returned values:** `CB_VISA_MASTERCARD`, `AMEX`, `MAESTRO`, `BCMC`\n\n**Default value:** `CB_VISA_MASTERCARD`\n\nThe type of the card. If not supplied, the default value will be taken into account."},"CardProvider":{"type":"string","description":"**Allowed values:** `CB`, `VISA`, `MASTERCARD`, `AMEX`, `MAESTRO`, `BCMC`, `JCB`, `DISCOVER`\n\nThe provider of the card."},"Country":{"type":"string","description":"The country of the card (which is the same as the country of the issuer)."},"BankCode":{"type":"string","description":"The name of the card issuing bank."},"Active":{"type":"boolean","description":"Whether the card is active or not. Setting this parameter to `false` is irreversible and should be done once the pay-in is successful."},"Currency":{"type":"string","description":"**Returned values:** The three-letter <a href=\"/api-reference/overview/data-formats\" target=\"_blank\">ISO 4217 code</a> (EUR, GBP, etc.) of a <a href=\"/guides/currencies\" target=\"_blank\">supported currency</a> (depends on feature, contract, and activation settings).\n\nThe currency of the card."},"Validity":{"type":"string","description":"**Returned values:** `UNKNOWN`, `VALID`, `INVALID`\n\nWhether the card is valid or not.\n- `UNKNOWN` – No payment or card validation has been processed, so the validity of the card remains unknown.\n- `VALID` – The first payment or card validation using the card was processed successfully within 24 hours of the initial card registration.\n- `INVALID` – The first payment or card validation using the card was attempted and failed, or the status of the corresponding card registration was `CREATED` for more than 24 hours.\nOnce a card is set to `INVALID`, it cannot be set back to `VALID`. A new card registration will be necessary to make a payment."},"UserId":{"type":"string","description":"The unique identifier of the user the card belongs to."},"Id":{"type":"string","description":"The unique identifier of the Card object."},"Tag":{"type":"string","description":"Custom data added to this object. In the case of the Card object, the tag value is inherited from the Card Registration object and is not editable."},"CreationDate":{"$ref":"#/components/schemas/CreationDate"},"Fingerprint":{"type":"string","description":"The unique representation of the card number. This string can be used to track the card behavior while keeping the card information confidential."}},"description":"The card object created by the platform.","title":"ListCardsForAFingerprintResponseArrayCardsItemsCard"},"ListCardsForAFingerprintResponseArrayCardsItems":{"type":"object","properties":{"Card":{"$ref":"#/components/schemas/ListCardsForAFingerprintResponseArrayCardsItemsCard","description":"The card object created by the platform."}},"title":"ListCardsForAFingerprintResponseArrayCardsItems"},"ListCardsForAFingerprintResponse":{"type":"object","properties":{"Array (Cards)":{"type":"array","items":{"$ref":"#/components/schemas/ListCardsForAFingerprintResponseArrayCardsItems"},"description":"The list of the cards created by the platform."}},"title":"ListCardsForAFingerprintResponse"},"LookUpMetadataForAPaymentMethodRequest":{"type":"object","properties":{"Type":{"type":"string","description":"**Allowed values:** `BIN`, `GOOGLE_PAY`\n\nThe type of metadata."},"Bin":{"type":"string","description":"Format: 6 or 8 digits\n\nRequired if the `Type` is `BIN`. The bank identification number (BIN)."},"Token":{"type":"string","description":"Required if the `Type` is `GOOGLE_PAY`.\n\nThe tokenized payment data provided by the third-party payment method."}},"required":["Type"],"title":"LookUpMetadataForAPaymentMethodRequest"},"LookUpMetadataForAPaymentMethodResponseBinDataItems":{"type":"object","properties":{"CardType":{"type":"string","description":"**Returned values:** `CREDIT`, `DEBIT`, `CHARGE CARD`\n\nThe type of the card."},"CommercialIndicator":{"type":"string","description":"**Returned values:** `PERSONAL`, `COMMERCIAL`\n\nWhether the card is held in a personal or commercial capacity."},"SubType":{"type":"string","description":"The subtype of the card product. Examples include: `CLASSIC`, `GOLD`, `PLATINUM`, `PREPAID`, etc.\n\n**Note:** The possible returned values are numerous and liable to evolve over time."},"Brand":{"type":"string","description":"The card brand. Examples include: `AMERICAN EXPRESS`, `DISCOVER`, `JCB`, `MASTERCARD`, `VISA`, etc.\n\n**Note:** The possible returned values are numerous and liable to evolve over time."}},"title":"LookUpMetadataForAPaymentMethodResponseBinDataItems"},"LookUpMetadataForAPaymentMethodResponse":{"type":"object","properties":{"Type":{"type":"string","description":"The type of metadata."},"Bin":{"type":"string","description":"Format: 6 or 8 digits\n\nThe bank identification number (BIN)."},"IssuerCountryCode":{"type":"string","description":"Format: Two-letter country code ([ISO 3166-1 alpha-2 format](/api-reference/overview/data-formats))\n\nThe country where the card was issued."},"IssuingBank":{"type":"string","description":"The name of the card issuer."},"BinData":{"type":"array","items":{"$ref":"#/components/schemas/LookUpMetadataForAPaymentMethodResponseBinDataItems"},"description":"Additional data about the card based on the BIN. In the case of <a href=\"/guides/payment-methods/card/co-branded\">co-branded card products</a>, two objects are returned."},"TokenFormat":{"type":"string","description":"**Returned values:** `PAN_ONLY`, `CRYPTOGRAM_3DS`\n\nIn the case of Google Pay, the format of the `Token`.\n- `PAN_ONLY` – The card is registered in the Google account and requires 3DS authentication.\n- `CRYPTOGRAM_3DS` – The card is enrolled in the customer's Google Wallet and authentication is handled by the Android device."}},"title":"LookUpMetadataForAPaymentMethodResponse"},"AuthorId":{"type":"string","description":"The unique identifier of the user at the source of the transaction.","title":"AuthorId"},"SecureModeReturnURL":{"type":"string","description":"Max. length: 255 characters\n\nThe URL to which users are automatically returned after 3DS2 if it is triggered (i.e., if the `SecureModeNeeded` parameter is set to `true`).","title":"SecureModeReturnURL"},"IpAddress":{"type":"string","description":"The IP address of the end user initiating the transaction, in IPV4 or IPV6 format.","title":"IpAddress"},"BrowserInfo":{"type":"object","properties":{"AcceptHeader":{"type":"string","description":"The exact content of the HTTP accept headers as sent to the platform from the end user's browser."},"JavaEnabled":{"type":"boolean","description":"Whether or not the end user's browser has the ability to execute Java."},"Language":{"type":"string","description":"Format: Two-letter language code (ISO 639-1 alpha-2) followed by two-letter country code (ISO 3166-1 alpha-2), separated by a hyphen (example: `en-US`; pattern:`^[a-zA-Z]{2}(-[a-zA-Z]{2})?$`)\n\nThe language of the browser."},"ColorDepth":{"type":"integer","description":"The value representing the depth of the screen's color palette for displaying images, in bits per pixel."},"ScreenHeight":{"type":"integer","description":"The height of the screen in pixels."},"ScreenWidth":{"type":"integer","description":"The width of the screen in pixels."},"TimeZoneOffset":{"type":"integer","description":"The difference in minutes between the browser's timezone and UTC."},"UserAgent":{"type":"string","description":"The exact content of the HTTP User-Agent header."},"JavascriptEnabled":{"type":"boolean","description":"Whether or not the end user's browser has the ability to execute JavaScript."}},"required":["AcceptHeader","JavaEnabled","Language","ColorDepth","ScreenHeight","ScreenWidth","TimeZoneOffset","UserAgent","JavascriptEnabled"],"description":"Information about the browser used by the end user (author) to perform the payment.","title":"BrowserInfo"},"PreferredCardNetwork":{"type":"string","description":"**Allowed values:** `VISA`, `MASTERCARD`, `CB`, `MAESTRO`\n\nThe card network to use, as chosen by the cardholder, in case of <a href=\"/guides/payment-methods/card/co-branded\">co-branded cards</a>.","title":"PreferredCardNetwork"},"PaymentCategory":{"type":"string","description":"**Default value:** `ECommerce`\n\n**Allowed values:** `ECommerce`, `TelephoneOrder`\n\nThe channel through which the user provided their card details, used to indicate mail-order and telephone-order (MOTO) payments:\n- `ECommerce` – Payment received online.\n- `TelephoneOrder` – Payment received via mail order or telephone order (MOTO).","title":"PaymentCategory"},"ProfilingAttemptReference":{"type":"string","description":"The unique reference generated for the profiling session, used by the <a href=\"/guides/fraud-prevention\">fraud prevention</a> solution to produce recommendations for the transaction using the profiling data.\n\n**Note:** Parameter not returned by the API. Profiling feature available on request – contact Mangopay <a href=\"https://hub.mangopay.com/\" target=\"_blank\">via the Dashboard</a> for more information.","title":"ProfilingAttemptReference"},"CreateACardValidationRequest":{"type":"object","properties":{"AuthorId":{"$ref":"#/components/schemas/AuthorId"},"SecureModeReturnURL":{"$ref":"#/components/schemas/SecureModeReturnURL"},"IpAddress":{"$ref":"#/components/schemas/IpAddress"},"Tag":{"$ref":"#/components/schemas/Tag"},"BrowserInfo":{"$ref":"#/components/schemas/BrowserInfo"},"PreferredCardNetwork":{"$ref":"#/components/schemas/PreferredCardNetwork"},"PaymentCategory":{"$ref":"#/components/schemas/PaymentCategory"},"SecureMode":{"type":"string","description":"**Allowed values:** `DEFAULT`, `FORCE`, `NO_CHOICE`\n\n**Default value:** `DEFAULT`\n\nThe mode applied for the <a href=\"/guides/payment-methods/card/3ds\">3DS2 protocol</a> for CB, Visa, and Mastercard. The options are:\n- `DEFAULT` – Requests an exemption to strong customer authentication (SCA), and thus a frictionless payment experience, if allowed by your Mangopay contract and accepted by the issuer.\n- `FORCE` – Requests SCA.\n- `NO_CHOICE` – Leaves the choice to the issuer whether to allow for a frictionless payment experience or to enforce SCA.\n\n**Note:** Sending the FORCE value automatically sets the ValidationUsage value to MIT."},"ValidationUsage":{"type":"string","description":"**Default value:** MIT\\\n**Allowed values:** MIT, CIT\n\nIndicates the intended usage of the card:\n\n- CIT – For customer-initiated transactions (CITs), meaning 3DS is less likely to be required on the card validation.\n- MIT – For merchant-initiated transactions (MITs), meaning 3DS is more likely to be required on the card validation.\n\n_Note: The MIT value is returned automatically if the SecureMode value is FORCE, even if CIT is sent._"},"ProfilingAttemptReference":{"$ref":"#/components/schemas/ProfilingAttemptReference"}},"required":["AuthorId","SecureModeReturnURL","IpAddress","BrowserInfo"],"title":"CreateACardValidationRequest"},"TransactionStatus":{"type":"string","description":"**Returned values:** `CREATED`, `SUCCEEDED`, `FAILED`\n\nThe status of the transaction.","title":"TransactionStatus"},"CardInfo":{"type":"object","properties":{"BIN":{"type":"string","description":"The bank identification number (BIN) of the card."},"IssuingBank":{"type":"string","description":"The name of the bank that issued the card."},"IssuerCountryCode":{"type":"string","description":"The country code of the card issuer."},"Type":{"type":"string","description":"The type of card (for example, `CREDIT` or `DEBIT`)."},"SubType":{"type":["string","null"],"description":"The sub-type of the card, if available."},"Brand":{"type":"string","description":"The card brand (for example, `VISA` or `MASTERCARD`)."}},"description":"Information about the card used for the transaction. If the information or data is not available, `null` is returned.","title":"CardInfo"},"AuthenticationResult":{"type":"object","properties":{"AuthenticationType":{"type":["string","null"],"description":"**Returned values:** `CHALLENGE`, `FRICTIONLESS`, `DIRECT_AUTHORIZATION`\n\nThe type of authentication:\n\n- `CHALLENGE` – The issuer requested SCA to be enforced (for example, using 3DS).\n- `FRICTIONLESS` – The transaction was exempted from SCA because an exemption was granted by the issuer.\n- `DIRECT_AUTHORIZATION` – The transaction was sent to the issuer for authorization without any frictionless or challenge (for example, if SCA doesn't apply). A `null` value typically indicates that authentication was not requested (for example, because the request failed before being sent) or a decision was not received.\n\nA `null` value typically indicates that authentication was not requested (for example, because the request failed before being sent) or a decision was not received."}},"description":"Information about the authentication result, based on the request made by Mangopay and the decision of the issuer regarding the type of authentication to be enforced (if applicable).","title":"AuthenticationResult"},"CardValidationResponse":{"type":"object","properties":{"Id":{"$ref":"#/components/schemas/Id"},"AuthorId":{"$ref":"#/components/schemas/AuthorId"},"Status":{"$ref":"#/components/schemas/TransactionStatus"},"SecureModeReturnURL":{"$ref":"#/components/schemas/SecureModeReturnURL"},"SecureModeRedirectURL":{"type":"string","description":"Max. length: 255 characters\n\nThe URL to which to redirect the user to proceed to 3DS2 validation."},"SecureModeNeeded":{"type":"boolean","description":"Whether or not the `SecureMode` was used."},"IpAddress":{"$ref":"#/components/schemas/IpAddress"},"BrowserInfo":{"$ref":"#/components/schemas/BrowserInfo"},"PreferredCardNetwork":{"$ref":"#/components/schemas/PreferredCardNetwork"},"PaymentCategory":{"$ref":"#/components/schemas/PaymentCategory"},"SecureMode":{"type":"string","description":"**Default value:** DEFAULT\\\n**Allowed values:** DEFAULT, FORCE, NO_CHOICE\n\nThe mode applied for the [3DS protocol](/guides/payment-methods/card/3ds) for CB, Visa, and Mastercard. The options are:\n- `DEFAULT` – Requests an exemption to strong customer authentication (SCA), and thus a frictionless payment experience, if allowed by your Mangopay contract and accepted by the issuer.\n- `FORCE` – Requests SCA.\n- `NO_CHOICE` – Leaves the choice to the issuer whether to allow for a frictionless payment experience or to enforce SCA.\n\n_Note: Sending the FORCE value automatically sets the ValidationUsage value to MIT._"},"ValidationUsage":{"type":"string","description":"**Default value:** MIT\\\n**Allowed values:** MIT, CIT\n\nIndicates the intended usage of the card:\n\n- CIT – For customer-initiated transactions (CITs), meaning 3DS is less likely to be required on the card validation.\n- MIT – For merchant-initiated transactions (MITs), meaning 3DS is more likely to be required on the card validation.\n\n_Note: The MIT value is returned automatically if the SecureMode value is FORCE, even if CIT is sent._"},"Validity":{"$ref":"#/components/schemas/Validity"},"CreationDate":{"$ref":"#/components/schemas/CreationDate"},"Type":{"type":"string","description":"**Returned values:** `CARD_VALIDATION`\n\nThe type of the card validation."},"Applied3DSVersion":{"type":"string","description":"**Returned values:** `V1`, `V2_1`\n\nThe 3DS protocol version applied to the transaction."},"ResultCode":{"$ref":"#/components/schemas/ResultCode"},"ResultMessage":{"$ref":"#/components/schemas/ResultMessage"},"Tag":{"$ref":"#/components/schemas/Tag"},"CardInfo":{"$ref":"#/components/schemas/CardInfo"},"AuthenticationResult":{"$ref":"#/components/schemas/AuthenticationResult"}},"title":"CardValidationResponse"},"CreditedUserId":{"type":"string","description":"**Default value:** The unique identifier of the owner of the credited wallet.\n\nThe unique identifier of the user whose wallet is credited.","title":"CreditedUserId"},"FlowDescriptorResponseBeneficiariesItems":{"type":"object","properties":{"UserId":{"type":"string","description":"The unique identifier of the Natural User or Legal User declared as a beneficiary of the pay-in."}},"title":"FlowDescriptorResponseBeneficiariesItems"},"FlowDescriptorResponse":{"type":"object","properties":{"FlowId":{"type":"string","description":"Unique identifier of the payment flow, used by Mangopay for internal purposes."},"Beneficiaries":{"type":["array","null"],"items":{"$ref":"#/components/schemas/FlowDescriptorResponseBeneficiariesItems"},"description":"Max. length: 5 items\n\nThe list of up to 5 Natural or Legal Users declared as beneficiaries of the pay-in, who must all be KYC/KYB verified when the pay-in request is made. The pay-in also fails if the `Beneficiaries` array contains nulled objects or invalid `UserId` values."}},"description":"Information about the Owner beneficiaries targeted by the pay-in and its subsequent transfers, who must all be KYC/KYB verified when the pay-in request is made ([read more](/guides/payin-beneficiaries)).\n\nIf the `FlowDescriptor.Beneficiaries` is sent in the API request, then:\n- The transaction's `CreditedWalletId` holder is disregarded in KYC/KYB checks.\n- **ALL** `UserId` values in the array must be one of:\n  - `OWNER` whose `KYCLevel` is `REGULAR`\n  - `PLATFORM`\n  \nThe pay-in `Status` becomes `FAILED` with `ResultCode` [002951](/errors/codes/002951) if at least one `FlowDescriptor.Beneficiaries.UserId` is:\n- `PAYER`\n- `OWNER` whose `KYCLevel` is `LIGHT`\n\nIf the `FlowDescriptor.Beneficiaries` is not sent in the API request, then the `CreditedWalletId` holder is subject to KYC/KYB checks. This property is optional for backwards compatibility but is recommended for all pay-in flows, even when the `CreditedWalletId` holder is a `PAYER` or the same value as one of the `FlowDescriptor.Beneficiaries`.\n","title":"FlowDescriptorResponse"},"DirectCardPayInResponseDebitedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the debited funds.","title":"DirectCardPayInResponseDebitedFunds"},"DirectCardPayInResponseCreditedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the credited funds (`CreditedFunds` = `DebitedFunds` - `Fees`).","title":"DirectCardPayInResponseCreditedFunds"},"DirectCardPayInResponseFees":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the fees taken by the platform for this transaction (and hence transferred to the Fees Wallet).","title":"DirectCardPayInResponseFees"},"TransactionExecutionDate":{"type":"integer","description":"Unix timestamp (UTC) of the date and time the status changed to `SUCCEEDED`, indicating that the transaction occurred. The statuses `CREATED` and `FAILED` return an `ExecutionDate` of `null`.","title":"TransactionExecutionDate"},"TransactionType":{"type":"string","description":"**Returned values:** `PAYIN`, `TRANSFER`, `CONVERSION`, `PAYOUT`\n\nThe type of the transaction.","title":"TransactionType"},"TransactionNature":{"type":"string","description":"**Returned values:** `REGULAR`, `REPUDIATION`, `REFUND`, `SETTLEMENT`\n\nThe nature of the transaction, providing more information about the context in which the transaction occurred:\n- `REGULAR` – Relative to most of the transactions (pay-ins, payouts, and transfers) in a usual workflow.\n- `REPUDIATION` – Automatic withdrawal of funds from the platform's repudiation wallet as part of the dispute process (when the user has requested a chargeback).\n- `REFUND` – Reimbursement of a transaction to the user (pay-in refund), to a wallet (transfer refund), or of a payout (payout refund, only initiated by Mangopay).\n- `SETTLEMENT` – Transfer made to the repudiation wallet by the platform to settle a lost dispute.","title":"TransactionNature"},"AVSResult":{"type":"object","properties":{"AVSResult":{"type":"string","description":"The result of the Address Verification System check (only available for UK, US, and Canada)."}},"description":"Information regarding security and anti-fraud tools.","title":"AVSResult"},"StatementDescriptor_22":{"type":"string","description":"Max. length: 22 characters; only alphanumeric and spaces\n\nCustom description to appear on the user’s bank statement along with the platform name. Different banks may show more or less information. See the <a href=\"/bank-statements\">Customizing bank statement references</a> article for details.","title":"StatementDescriptor_22"},"Billing_DefaultsShippingUser_Response":{"type":"object","properties":{"FirstName":{"type":"string","description":"The first name of the user."},"LastName":{"type":"string","description":"The last name of the user."},"Address":{"$ref":"#/components/schemas/Address"}},"description":"**Default values:** `FirstName`, `LastName`, and `Address` information of the `Shipping` object if sent, otherwise of the `AuthorId` (if address values present).\n\nInformation about the billing address. ","title":"Billing_DefaultsShippingUser_Response"},"Shipping_DefaultsBillingUser_Response":{"type":"object","properties":{"FirstName":{"type":"string","description":"The first name of the user."},"LastName":{"type":"string","description":"The last name of the user."},"Address":{"$ref":"#/components/schemas/Address_SubPropsRequired"}},"description":"**Default values:** `FirstName`, `LastName`, and `Address` information of the `Billing` object if sent, otherwise of the `AuthorId` (if address values present).\n\nInformation about the shipping address. ","title":"Shipping_DefaultsBillingUser_Response"},"DirectCardPayInResponse":{"type":"object","properties":{"Id":{"$ref":"#/components/schemas/Id"},"Tag":{"$ref":"#/components/schemas/Tag"},"CreationDate":{"$ref":"#/components/schemas/CreationDate"},"AuthorId":{"$ref":"#/components/schemas/AuthorId"},"CreditedUserId":{"$ref":"#/components/schemas/CreditedUserId"},"FlowDescriptor":{"$ref":"#/components/schemas/FlowDescriptorResponse"},"DebitedFunds":{"$ref":"#/components/schemas/DirectCardPayInResponseDebitedFunds","description":"Information about the debited funds."},"CreditedFunds":{"$ref":"#/components/schemas/DirectCardPayInResponseCreditedFunds","description":"Information about the credited funds (`CreditedFunds` = `DebitedFunds` - `Fees`)."},"Fees":{"$ref":"#/components/schemas/DirectCardPayInResponseFees","description":"Information about the fees taken by the platform for this transaction (and hence transferred to the Fees Wallet)."},"Status":{"$ref":"#/components/schemas/TransactionStatus"},"ResultCode":{"$ref":"#/components/schemas/ResultCode"},"ResultMessage":{"$ref":"#/components/schemas/ResultMessage"},"ExecutionDate":{"$ref":"#/components/schemas/TransactionExecutionDate"},"Type":{"$ref":"#/components/schemas/TransactionType"},"Nature":{"$ref":"#/components/schemas/TransactionNature"},"CreditedWalletId":{"type":"string","description":"The unique identifier of the credited wallet."},"DebitedWalletId":{"type":"string","description":"The unique identifier of the debited wallet.\n\nIn the case of a pay-in, this value is always `null` since there is no debited wallet."},"PaymentType":{"type":"string","description":"**Returned values:** `CARD`\n\nThe payment type of the pay-in."},"ExecutionType":{"type":"string","description":"**Returned values:** `DIRECT`\n\nThe execution type of the pay-in."},"SecureMode":{"type":"string","description":"**Returned values:** `DEFAULT`, `FORCE`, `NO_CHOICE`\n\nThe mode applied for the 3DS2 protocol for CB, Visa, and Mastercard. The options are:\n- `DEFAULT` – Requests an exemption to strong customer authentication (SCA), and thus a frictionless payment experience, if allowed by your Mangopay contract and accepted by the issuer.\n- `FORCE` – Requests SCA.\n- `NO_CHOICE` – Leaves the choice to the issuer whether to allow for a frictionless payment experience or to enforce SCA."},"CardId":{"type":"string","description":"The unique identifier of the Card object, obtained during the card registration process."},"SecureModeReturnURL":{"$ref":"#/components/schemas/SecureModeReturnURL"},"SecureModeRedirectURL":{"type":"string","description":"Max. length: 255 characters\n\nThe URL to which to redirect the user to proceed to 3DS2 validation."},"SecureModeNeeded":{"type":"boolean","description":"Whether or not the `SecureMode` was used."},"Culture":{"type":"string","description":"**Returned values:** One of the supported languages in the [ISO 639-1 format](/api-reference/overview/data-formats): DE, EN, ES, FR, IT, NL, PL, PT.\n\nThe language in which the payment page is to be displayed."},"SecurityInfo":{"$ref":"#/components/schemas/AVSResult"},"StatementDescriptor":{"$ref":"#/components/schemas/StatementDescriptor_22"},"BrowserInfo":{"$ref":"#/components/schemas/BrowserInfo"},"IpAddress":{"$ref":"#/components/schemas/IpAddress"},"Billing":{"$ref":"#/components/schemas/Billing_DefaultsShippingUser_Response"},"Shipping":{"$ref":"#/components/schemas/Shipping_DefaultsBillingUser_Response"},"Requested3DSVersion":{"type":"string","description":"**Returned values:** `V1`, `V2_1`\n\nThe 3DS protocol version to be applied to the transaction."},"Applied3DSVersion":{"type":"string","description":"**Returned values:** `V1`, `V2_1`\n\nThe 3DS protocol version applied to the transaction."},"PreferredCardNetwork":{"$ref":"#/components/schemas/PreferredCardNetwork"},"PaymentCategory":{"$ref":"#/components/schemas/PaymentCategory"},"CardInfo":{"$ref":"#/components/schemas/CardInfo"},"AuthenticationResult":{"$ref":"#/components/schemas/AuthenticationResult"}},"description":"A one-time direct card pay-in:\n- `PaymentType` – `CARD`\n- `ExecutionType` – `DIRECT`\n- Object does not include `RecurringPayinRegistrationId`","title":"DirectCardPayInResponse"},"RecurringCardPayInResponseDebitedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the debited funds.","title":"RecurringCardPayInResponseDebitedFunds"},"RecurringCardPayInResponseCreditedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the credited funds (`CreditedFunds` = `DebitedFunds` - `Fees`).","title":"RecurringCardPayInResponseCreditedFunds"},"RecurringCardPayInResponseFees":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the fees taken by the platform for this transaction (and hence transferred to the Fees Wallet).","title":"RecurringCardPayInResponseFees"},"RecurringCardPayInResponse":{"type":"object","properties":{"Id":{"$ref":"#/components/schemas/Id"},"Tag":{"$ref":"#/components/schemas/Tag"},"CreationDate":{"$ref":"#/components/schemas/CreationDate"},"AuthorId":{"$ref":"#/components/schemas/AuthorId"},"DebitedFunds":{"$ref":"#/components/schemas/RecurringCardPayInResponseDebitedFunds","description":"Information about the debited funds."},"CreditedFunds":{"$ref":"#/components/schemas/RecurringCardPayInResponseCreditedFunds","description":"Information about the credited funds (`CreditedFunds` = `DebitedFunds` - `Fees`)."},"Fees":{"$ref":"#/components/schemas/RecurringCardPayInResponseFees","description":"Information about the fees taken by the platform for this transaction (and hence transferred to the Fees Wallet)."},"Status":{"$ref":"#/components/schemas/TransactionStatus"},"ResultCode":{"$ref":"#/components/schemas/ResultCode"},"ResultMessage":{"$ref":"#/components/schemas/ResultMessage"},"ExecutionDate":{"$ref":"#/components/schemas/TransactionExecutionDate"},"Type":{"$ref":"#/components/schemas/TransactionType"},"Nature":{"$ref":"#/components/schemas/TransactionNature"},"CreditedWalletId":{"type":"string","description":"The unique identifier of the credited wallet."},"CreditedUserId":{"$ref":"#/components/schemas/CreditedUserId"},"PaymentType":{"type":"string","description":"**Returned values:** `CARD`\n\nThe payment type of the pay-in."},"ExecutionType":{"type":"string","description":"**Returned values:** `DIRECT`\n\nThe execution type of the pay-in."},"StatementDescriptor":{"$ref":"#/components/schemas/StatementDescriptor_22"},"Billing":{"$ref":"#/components/schemas/Billing_DefaultsShippingUser_Response"},"Shipping":{"$ref":"#/components/schemas/Shipping_DefaultsBillingUser_Response"},"SecureMode":{"type":"string","description":"**Returned values:** `DEFAULT`, `FORCE`, `NO_CHOICE`\n\nThe mode applied for the 3DS2 protocol for CB, Visa, and Mastercard. The options are:\n- `DEFAULT` – Requests an exemption to strong customer authentication (SCA), and thus a frictionless payment experience, if allowed by your Mangopay contract and accepted by the issuer.\n- `FORCE` – Requests SCA.\n- `NO_CHOICE` – Leaves the choice to the issuer whether to allow for a frictionless payment experience or to enforce SCA."},"SecureModeNeeded":{"type":"boolean","description":"Whether or not the `SecureMode` was used."},"SecureModeReturnURL":{"$ref":"#/components/schemas/SecureModeReturnURL"},"SecureModeRedirectURL":{"type":"string","description":"Max. length: 255 characters\n\nThe URL to which to redirect the user to proceed to 3DS2 validation."},"SecurityInfo":{"$ref":"#/components/schemas/AVSResult"},"BrowserInfo":{"$ref":"#/components/schemas/BrowserInfo"},"IpAddress":{"$ref":"#/components/schemas/IpAddress"},"CardId":{"type":"string","description":"The unique identifier of the Card object, obtained during the card registration process."},"CardInfo":{"$ref":"#/components/schemas/CardInfo"},"Requested3DSVersion":{"type":"string","description":"**Returned values:** `V1`, `V2_1`\n\nThe 3DS protocol version to be applied to the transaction."},"Applied3DSVersion":{"type":"string","description":"**Returned values:** `V1`, `V2_1`\n\nThe 3DS protocol version applied to the transaction."},"RecurringPayinRegistrationId":{"type":"string","description":"The unique identifier of the recurring pay-in registration."},"PreferredCardNetwork":{"$ref":"#/components/schemas/PreferredCardNetwork"},"Culture":{"type":"string","description":"**Returned values:** One of the supported languages in the [ISO 639-1 format](/api-reference/overview/data-formats): DE, EN, ES, FR, IT, NL, PL, PT.\n\nThe language in which the payment page is to be displayed."},"DebitedWalletId":{"type":"string","description":"The unique identifier of the debited wallet.\n\nIn the case of a pay-in, this value is always `null` since there is no debited wallet."},"PaymentCategory":{"$ref":"#/components/schemas/PaymentCategory"},"AuthenticationResult":{"$ref":"#/components/schemas/AuthenticationResult"}},"description":"A recurring direct card pay-in:\n- `PaymentType` – `CARD`\n- `ExecutionType` – `DIRECT`\n- Object includes `RecurringPayinRegistrationId`","title":"RecurringCardPayInResponse"},"PreauthorizedPayInResponseDebitedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the debited funds.","title":"PreauthorizedPayInResponseDebitedFunds"},"PreauthorizedPayInResponseCreditedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the credited funds (`CreditedFunds` = `DebitedFunds` - `Fees`).","title":"PreauthorizedPayInResponseCreditedFunds"},"PreauthorizedPayInResponseFees":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the fees taken by the platform for this transaction (and hence transferred to the Fees Wallet).","title":"PreauthorizedPayInResponseFees"},"PreauthorizedPayInResponse":{"type":"object","properties":{"Id":{"$ref":"#/components/schemas/Id"},"Tag":{"$ref":"#/components/schemas/Tag"},"CreationDate":{"$ref":"#/components/schemas/CreationDate"},"ResultCode":{"$ref":"#/components/schemas/ResultCode"},"ResultMessage":{"$ref":"#/components/schemas/ResultMessage"},"AuthorId":{"$ref":"#/components/schemas/AuthorId"},"CreditedUserId":{"$ref":"#/components/schemas/CreditedUserId"},"DebitedFunds":{"$ref":"#/components/schemas/PreauthorizedPayInResponseDebitedFunds","description":"Information about the debited funds."},"CreditedFunds":{"$ref":"#/components/schemas/PreauthorizedPayInResponseCreditedFunds","description":"Information about the credited funds (`CreditedFunds` = `DebitedFunds` - `Fees`)."},"Fees":{"$ref":"#/components/schemas/PreauthorizedPayInResponseFees","description":"Information about the fees taken by the platform for this transaction (and hence transferred to the Fees Wallet)."},"Status":{"$ref":"#/components/schemas/TransactionStatus"},"ExecutionDate":{"$ref":"#/components/schemas/TransactionExecutionDate"},"Type":{"$ref":"#/components/schemas/TransactionType"},"Nature":{"$ref":"#/components/schemas/TransactionNature"},"CreditedWalletId":{"type":"string","description":"The unique identifier of the credited wallet."},"DebitedWalletId":{"type":"string","description":"The unique identifier of the debited wallet.\n\nIn the case of a pay-in, this value is always `null` since there is no debited wallet."},"PaymentType":{"type":"string","description":"**Returned values:** `PREAUTHORIZED`\n\nThe payment type of the pay-in."},"ExecutionType":{"type":"string","description":"**Returned values:** `DIRECT`\n\nThe execution type of the pay-in."},"PreauthorizationId":{"type":"string","description":"The unique identifier of the preauthorization."},"AuthenticationResult":{"$ref":"#/components/schemas/AuthenticationResult"}},"description":"A 7-day preauthorized card pay-in:\n- `PaymentType` – `PREAUTHORIZED`\n- `ExecutionType` – `DIRECT`\n- Object includes `PreauthorizationId`","title":"PreauthorizedPayInResponse"},"DepositPreauthorizedPayInResponseDebitedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the debited funds.","title":"DepositPreauthorizedPayInResponseDebitedFunds"},"DepositPreauthorizedPayInResponseCreditedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the credited funds (`CreditedFunds` = `DebitedFunds` - `Fees`).","title":"DepositPreauthorizedPayInResponseCreditedFunds"},"DepositPreauthorizedPayInResponseFees":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the fees taken by the platform for this transaction (and hence transferred to the Fees Wallet).","title":"DepositPreauthorizedPayInResponseFees"},"StatementDescriptor":{"type":"string","description":"Max. length: 10 characters; only alphanumeric and spaces\n\nCustom description to appear on the user’s bank statement along with the platform name. Different banks may show more or less information. See the <a href=\"/bank-statements\">Customizing bank statement references</a> article for details.","title":"StatementDescriptor"},"DepositPreauthorizedPayInResponse":{"type":"object","properties":{"AuthorId":{"type":"string","description":"**Default values:** The `AuthorId` of the Deposit Preauthorization object.\n\nThe unique identifier of the user at the source of the transaction. On the Deposit Preauthorized PayIn, this parameter returns the same value as the `AuthorId` of the Deposit Preauthorization object, regardless of the value sent."},"CreditedUserId":{"type":"string","description":"**Default value:** The `AuthorId` of the Deposit Preauthorization object.\n\nThe unique identifier of the user whose wallet is credited. On the Deposit Preauthorized PayIn, this parameter returns the same value as the `AuthorId` of the Deposit Preauthorization object, regardless of the value sent."},"CreditedWalletId":{"type":"string","description":"The unique identifier of the credited wallet."},"DepositId":{"type":"string","description":"The unique identifier of the deposit preauthorization."},"Id":{"$ref":"#/components/schemas/Id"},"CreationDate":{"$ref":"#/components/schemas/CreationDate"},"ResultCode":{"$ref":"#/components/schemas/ResultCode"},"ResultMessage":{"$ref":"#/components/schemas/ResultMessage"},"Status":{"$ref":"#/components/schemas/TransactionStatus"},"ExecutionDate":{"$ref":"#/components/schemas/TransactionExecutionDate"},"Type":{"$ref":"#/components/schemas/TransactionType"},"Nature":{"$ref":"#/components/schemas/TransactionNature"},"PaymentType":{"type":"string","description":"**Returned values:** `PREAUTHORIZED`\n\nThe payment type of the pay-in."},"ExecutionType":{"type":"string","description":"**Returned values:** `DIRECT`\n\nThe execution type of the pay-in."},"DebitedFunds":{"$ref":"#/components/schemas/DepositPreauthorizedPayInResponseDebitedFunds","description":"Information about the debited funds."},"CreditedFunds":{"$ref":"#/components/schemas/DepositPreauthorizedPayInResponseCreditedFunds","description":"Information about the credited funds (`CreditedFunds` = `DebitedFunds` - `Fees`)."},"Fees":{"$ref":"#/components/schemas/DepositPreauthorizedPayInResponseFees","description":"Information about the fees taken by the platform for this transaction (and hence transferred to the Fees Wallet)."},"Tag":{"$ref":"#/components/schemas/Tag"},"AuthenticationResult":{"$ref":"#/components/schemas/AuthenticationResult"},"StatementDescriptor":{"$ref":"#/components/schemas/StatementDescriptor"}},"description":"A 29-day deposit preauthorized pay-in:\n- `PaymentType` – `PREAUTHORIZED`\n- `ExecutionType` – `DIRECT`\n- Object includes `DepositId`\n\nThe payment method is determined by the Deposit Preauthorization's `PaymentType`: `CARD_DIRECT` or `PAPAY`.","title":"DepositPreauthorizedPayInResponse"},"WebCardPayInResponseDebitedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the debited funds.","title":"WebCardPayInResponseDebitedFunds"},"WebCardPayInResponseCreditedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the credited funds (`CreditedFunds` = `DebitedFunds` - `Fees`).","title":"WebCardPayInResponseCreditedFunds"},"WebCardPayInResponseFees":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the fees taken by the platform for this transaction (and hence transferred to the Fees Wallet).","title":"WebCardPayInResponseFees"},"ReturnURL_220":{"type":"string","description":"Max. length: 220 characters\n\nThe URL to which the user is returned after the payment, whether the transaction is successful or not.","title":"ReturnURL_220"},"WebCardPayInResponse":{"type":"object","properties":{"Id":{"$ref":"#/components/schemas/Id"},"Tag":{"$ref":"#/components/schemas/Tag"},"CreationDate":{"$ref":"#/components/schemas/CreationDate"},"AuthorId":{"$ref":"#/components/schemas/AuthorId"},"CreditedUserId":{"$ref":"#/components/schemas/CreditedUserId"},"FlowDescriptor":{"$ref":"#/components/schemas/FlowDescriptorResponse"},"DebitedFunds":{"$ref":"#/components/schemas/WebCardPayInResponseDebitedFunds","description":"Information about the debited funds."},"CreditedFunds":{"$ref":"#/components/schemas/WebCardPayInResponseCreditedFunds","description":"Information about the credited funds (`CreditedFunds` = `DebitedFunds` - `Fees`)."},"Fees":{"$ref":"#/components/schemas/WebCardPayInResponseFees","description":"Information about the fees taken by the platform for this transaction (and hence transferred to the Fees Wallet)."},"Status":{"$ref":"#/components/schemas/TransactionStatus"},"ResultCode":{"$ref":"#/components/schemas/ResultCode"},"ResultMessage":{"$ref":"#/components/schemas/ResultMessage"},"ExecutionDate":{"$ref":"#/components/schemas/TransactionExecutionDate"},"Type":{"$ref":"#/components/schemas/TransactionType"},"Nature":{"$ref":"#/components/schemas/TransactionNature"},"CreditedWalletId":{"type":"string","description":"The unique identifier of the credited wallet."},"DebitedWalletId":{"type":"string","description":"The unique identifier of the debited wallet.\n\nIn the case of a pay-in, this value is always `null` since there is no debited wallet."},"PaymentType":{"type":"string","description":"**Returned values:** `CARD`\n\nThe payment type of the pay-in."},"ExecutionType":{"type":"string","description":"**Returned values:** `WEB`\n\nThe execution type of the pay-in."},"RedirectURL":{"type":"string","description":"The URL to which to redirect the user to complete the payment.\n\n**Caution:** This variable URL is specific to each payment. You must rely on the returned URL in full (host, path, and queries) and not hardcode any part of it."},"ReturnURL":{"$ref":"#/components/schemas/ReturnURL_220"},"TemplateURL":{"type":"string","description":"**Caution:** This customization feature is deprecated and must no longer be used. You must redirect on the `RedirectURL` instead.\n\nThe customized URL to which to redirect the user to complete the payment."},"CardType":{"type":"string","description":"**Returned values:** `CB_VISA_MASTERCARD`, `AMEX`, `MAESTRO`, `BCMC`\n\nThe type of the card."},"Culture":{"type":"string","description":"**Returned values:** One of the supported languages in the [ISO 639-1 format](/api-reference/overview/data-formats): CS, DA, DE, EL, EN, ES, FI, FR, HU, IT, NL, NO, PL, PT, SK, SV.\n\nThe language in which the payment page is to be displayed."},"SecureMode":{"type":"string","description":"**Returned values:** `DEFAULT`, `FORCE`, `NO_CHOICE`\n\nThe mode applied for the 3DS2 protocol for CB, Visa, and Mastercard. The options are:\n- `DEFAULT` – Requests an exemption to strong customer authentication (SCA), and thus a frictionless payment experience, if allowed by your Mangopay contract and accepted by the issuer.\n- `FORCE` – Requests SCA.\n- `NO_CHOICE` – Leaves the choice to the issuer whether to allow for a frictionless payment experience or to enforce SCA."},"Billing":{"$ref":"#/components/schemas/Billing_DefaultsShippingUser_Response"},"Shipping":{"$ref":"#/components/schemas/Shipping_DefaultsBillingUser_Response"},"StatementDescriptor":{"$ref":"#/components/schemas/StatementDescriptor_22"},"BankName":{"type":"string","description":"The user's bank, if the `CardType` is `IDEAL`, as defined by the `Bic` parameter sent in the call. This parameter is `null` for other card types or if the BIC was not sent on the legacy iDEAL implementation. See <a href=\"/api-reference/ideal/create-web-card-payin-ideal\">Create a Web Card PayIn (iDEAL)</a> for more information."},"AuthenticationResult":{"$ref":"#/components/schemas/AuthenticationResult"}},"description":"A web card pay-in:\n- `PaymentType` – `CARD`\n- `ExecutionType` – `WEB`","title":"WebCardPayInResponse"},"ApplePayPayInResponseDebitedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the debited funds. The values must match those requested from Apple Pay, because they are encrypted in the `PaymentData`.","title":"ApplePayPayInResponseDebitedFunds"},"ApplePayPayInResponseCreditedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the credited funds (`CreditedFunds` = `DebitedFunds` - `Fees`).","title":"ApplePayPayInResponseCreditedFunds"},"ApplePayPayInResponseFees":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the fees.","title":"ApplePayPayInResponseFees"},"ApplePayPayInResponseBrowserInfo":{"type":"object","properties":{},"description":"Information about the browser used by the end user (author) to perform the payment. On Apple Pay, `null` is returned as 3DS redirection does not apply.","title":"ApplePayPayInResponseBrowserInfo"},"ApplePayPayInResponseBilling":{"type":"object","properties":{},"description":"Information about the end user billing address. On Apple Pay, `null` is returned as 3DS redirection does not apply.","title":"ApplePayPayInResponseBilling"},"ApplePayPayInResponseShipping":{"type":"object","properties":{},"description":"Information about the end user's shipping address. On Apple Pay, `null` is returned as 3DS redirection does not apply.","title":"ApplePayPayInResponseShipping"},"ApplePayPayInResponse":{"type":"object","properties":{"Id":{"$ref":"#/components/schemas/Id"},"Tag":{"$ref":"#/components/schemas/Tag"},"CreationDate":{"$ref":"#/components/schemas/CreationDate"},"AuthorId":{"$ref":"#/components/schemas/AuthorId"},"CreditedUserId":{"$ref":"#/components/schemas/CreditedUserId"},"FlowDescriptor":{"$ref":"#/components/schemas/FlowDescriptorResponse"},"DebitedFunds":{"$ref":"#/components/schemas/ApplePayPayInResponseDebitedFunds","description":"Information about the debited funds. The values must match those requested from Apple Pay, because they are encrypted in the `PaymentData`."},"CreditedFunds":{"$ref":"#/components/schemas/ApplePayPayInResponseCreditedFunds","description":"Information about the credited funds (`CreditedFunds` = `DebitedFunds` - `Fees`)."},"Fees":{"$ref":"#/components/schemas/ApplePayPayInResponseFees","description":"Information about the fees."},"Status":{"$ref":"#/components/schemas/TransactionStatus"},"ResultCode":{"$ref":"#/components/schemas/ResultCode"},"ResultMessage":{"$ref":"#/components/schemas/ResultMessage"},"ExecutionDate":{"$ref":"#/components/schemas/TransactionExecutionDate"},"Type":{"$ref":"#/components/schemas/TransactionType"},"Nature":{"$ref":"#/components/schemas/TransactionNature"},"CreditedWalletId":{"type":"string","description":"The unique identifier of the credited wallet."},"DebitedWalletId":{"type":"string","description":"The unique identifier of the debited wallet.\n\nIn the case of a pay-in, this value is always `null` since there is no debited wallet."},"PaymentType":{"type":"string","description":"**Returned values:** `APPLEPAY`\n\nThe payment type of the pay-in."},"ExecutionType":{"type":"string","description":"**Returned values:** `DIRECT`\n\nThe execution type of the pay-in."},"SecureMode":{"type":"string","description":"The mode applied for the 3DS2 protocol. On Apple Pay, this value is returned `null` as 3DS redirection is not applicable."},"CardId":{"type":"string","description":"For Apple Pay recurring registrations, this value is returned `null`."},"SecureModeReturnURL":{"type":"string","description":"Max. length: 255 characters\n\nThe URL to which users are automatically returned after 3DS2 if it is triggered. On Apple Pay, `null` is returned as 3DS redirection does not apply."},"SecureModeRedirectURL":{"type":"string","description":"Max. length: 255 characters\n\nThe URL to which to redirect the user to proceed to 3DS2 validation. On Apple Pay, `null` is returned as 3DS redirection does not apply."},"SecureModeNeeded":{"type":"boolean","description":"Whether or not the `SecureMode` was used."},"Culture":{"type":"string","description":"The language in which the payment page is to be displayed. On Apple Pay, `null` is returned."},"SecurityInfo":{"$ref":"#/components/schemas/AVSResult"},"StatementDescriptor":{"$ref":"#/components/schemas/StatementDescriptor_22"},"BrowserInfo":{"$ref":"#/components/schemas/ApplePayPayInResponseBrowserInfo","description":"Information about the browser used by the end user (author) to perform the payment. On Apple Pay, `null` is returned as 3DS redirection does not apply."},"IpAddress":{"type":"string","description":"The IP address of the end user initiating the transaction, in IPV4 or IPV6 format. On Apple Pay, `null` is returned as 3DS redirection does not apply."},"Billing":{"$ref":"#/components/schemas/ApplePayPayInResponseBilling","description":"Information about the end user billing address. On Apple Pay, `null` is returned as 3DS redirection does not apply."},"Shipping":{"$ref":"#/components/schemas/ApplePayPayInResponseShipping","description":"Information about the end user's shipping address. On Apple Pay, `null` is returned as 3DS redirection does not apply."},"Requested3DSVersion":{"type":"string","description":"**Returned values:** `V1`, `V2_1`\n\nThe 3DS protocol version to be applied to the transaction."},"Applied3DSVersion":{"type":"string","description":"**Returned values:** `V1`, `V2_1`\n\nThe 3DS protocol version applied to the transaction."},"RecurringPayinRegistrationId":{"type":"string","description":"The unique identifier of the recurring pay-in registration."},"PreferredCardNetwork":{"$ref":"#/components/schemas/PreferredCardNetwork"},"PaymentCategory":{"$ref":"#/components/schemas/PaymentCategory"},"CardInfo":{"$ref":"#/components/schemas/CardInfo"},"AuthenticationResult":{"$ref":"#/components/schemas/AuthenticationResult"}},"description":"A one-time Apple Pay pay-in:\n- `PaymentType` – `APPLEPAY`\n- `ExecutionType` – `DIRECT`\n- Object does not include `RecurringPayinRegistrationId`","title":"ApplePayPayInResponse"},"RecurringApplePayPayInResponseDebitedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the debited funds. The values must match those requested from Apple Pay, because they are encrypted in the `PaymentData`.","title":"RecurringApplePayPayInResponseDebitedFunds"},"RecurringApplePayPayInResponseCreditedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the credited funds (`CreditedFunds` = `DebitedFunds` - `Fees`).","title":"RecurringApplePayPayInResponseCreditedFunds"},"RecurringApplePayPayInResponseFees":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the fees.","title":"RecurringApplePayPayInResponseFees"},"RecurringApplePayPayInResponseBrowserInfo":{"type":"object","properties":{},"description":"Information about the browser used by the end user (author) to perform the payment. On Apple Pay, `null` is returned as 3DS redirection does not apply.","title":"RecurringApplePayPayInResponseBrowserInfo"},"RecurringApplePayPayInResponseBilling":{"type":"object","properties":{},"description":"Information about the end user billing address. On Apple Pay, `null` is returned as 3DS redirection does not apply.","title":"RecurringApplePayPayInResponseBilling"},"RecurringApplePayPayInResponseShipping":{"type":"object","properties":{},"description":"Information about the end user's shipping address. On Apple Pay, `null` is returned as 3DS redirection does not apply.","title":"RecurringApplePayPayInResponseShipping"},"RecurringApplePayPayInResponse":{"type":"object","properties":{"Id":{"$ref":"#/components/schemas/Id"},"Tag":{"$ref":"#/components/schemas/Tag"},"CreationDate":{"$ref":"#/components/schemas/CreationDate"},"AuthorId":{"$ref":"#/components/schemas/AuthorId"},"DebitedFunds":{"$ref":"#/components/schemas/RecurringApplePayPayInResponseDebitedFunds","description":"Information about the debited funds. The values must match those requested from Apple Pay, because they are encrypted in the `PaymentData`."},"CreditedFunds":{"$ref":"#/components/schemas/RecurringApplePayPayInResponseCreditedFunds","description":"Information about the credited funds (`CreditedFunds` = `DebitedFunds` - `Fees`)."},"Fees":{"$ref":"#/components/schemas/RecurringApplePayPayInResponseFees","description":"Information about the fees."},"Status":{"$ref":"#/components/schemas/TransactionStatus"},"ResultCode":{"$ref":"#/components/schemas/ResultCode"},"ResultMessage":{"$ref":"#/components/schemas/ResultMessage"},"ExecutionDate":{"$ref":"#/components/schemas/TransactionExecutionDate"},"Type":{"$ref":"#/components/schemas/TransactionType"},"Nature":{"$ref":"#/components/schemas/TransactionNature"},"CreditedWalletId":{"type":"string","description":"The unique identifier of the credited wallet."},"CreditedUserId":{"$ref":"#/components/schemas/CreditedUserId"},"PaymentType":{"type":"string","description":"**Returned values:** `APPLEPAY`\n\nThe payment type of the pay-in."},"ExecutionType":{"type":"string","description":"**Returned values:** `DIRECT`\n\nThe execution type of the pay-in."},"StatementDescriptor":{"$ref":"#/components/schemas/StatementDescriptor_22"},"DebitedWalletId":{"type":"string","description":"The unique identifier of the debited wallet.\n\nIn the case of a pay-in, this value is always `null` since there is no debited wallet."},"SecurityInfo":{"$ref":"#/components/schemas/AVSResult"},"SecureMode":{"type":"string","description":"The mode applied for the 3DS2 protocol. On Apple Pay, this value is returned `null` as 3DS redirection is not applicable."},"CardId":{"type":"string","description":"For Apple Pay recurring registrations, this value is returned `null`."},"SecureModeReturnURL":{"type":"string","description":"Max. length: 255 characters\n\nThe URL to which users are automatically returned after 3DS2 if it is triggered. On Apple Pay, `null` is returned as 3DS redirection does not apply."},"SecureModeRedirectURL":{"type":"string","description":"Max. length: 255 characters\n\nThe URL to which to redirect the user to proceed to 3DS2 validation. On Apple Pay, `null` is returned as 3DS redirection does not apply."},"SecureModeNeeded":{"type":"boolean","description":"Whether or not the `SecureMode` was used."},"Culture":{"type":"string","description":"The language in which the payment page is to be displayed. On Apple Pay, `null` is returned."},"BrowserInfo":{"$ref":"#/components/schemas/RecurringApplePayPayInResponseBrowserInfo","description":"Information about the browser used by the end user (author) to perform the payment. On Apple Pay, `null` is returned as 3DS redirection does not apply."},"IpAddress":{"type":"string","description":"The IP address of the end user initiating the transaction, in IPV4 or IPV6 format. On Apple Pay, `null` is returned as 3DS redirection does not apply."},"Requested3DSVersion":{"type":"string","description":"**Returned values:** `V1`, `V2_1`\n\nThe 3DS protocol version to be applied to the transaction."},"Applied3DSVersion":{"type":"string","description":"**Returned values:** `V1`, `V2_1`\n\nThe 3DS protocol version applied to the transaction."},"RecurringPayinRegistrationId":{"type":"string","description":"The unique identifier of the recurring pay-in registration."},"PreferredCardNetwork":{"$ref":"#/components/schemas/PreferredCardNetwork"},"PaymentCategory":{"$ref":"#/components/schemas/PaymentCategory"},"CardInfo":{"$ref":"#/components/schemas/CardInfo"},"AuthenticationResult":{"$ref":"#/components/schemas/AuthenticationResult"},"Billing":{"$ref":"#/components/schemas/RecurringApplePayPayInResponseBilling","description":"Information about the end user billing address. On Apple Pay, `null` is returned as 3DS redirection does not apply."},"Shipping":{"$ref":"#/components/schemas/RecurringApplePayPayInResponseShipping","description":"Information about the end user's shipping address. On Apple Pay, `null` is returned as 3DS redirection does not apply."}},"description":"A recurring Apple Pay pay-in:\n- `PaymentType` – `APPLEPAY`\n- `ExecutionType` – `DIRECT`\n- Object includes `RecurringPayinRegistrationId`","title":"RecurringApplePayPayInResponse"},"GooglePayPayInResponseDebitedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the debited funds.","title":"GooglePayPayInResponseDebitedFunds"},"GooglePayPayInResponseCreditedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the credited funds (`CreditedFunds` = `DebitedFunds` - `Fees`).","title":"GooglePayPayInResponseCreditedFunds"},"GooglePayPayInResponseFees":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the fees taken by the platform for this transaction (and hence transferred to the Fees Wallet).","title":"GooglePayPayInResponseFees"},"GooglePayPayInResponse":{"type":"object","properties":{"Id":{"$ref":"#/components/schemas/Id"},"Tag":{"$ref":"#/components/schemas/Tag"},"CreationDate":{"$ref":"#/components/schemas/CreationDate"},"AuthorId":{"$ref":"#/components/schemas/AuthorId"},"FlowDescriptor":{"$ref":"#/components/schemas/FlowDescriptorResponse"},"DebitedFunds":{"$ref":"#/components/schemas/GooglePayPayInResponseDebitedFunds","description":"Information about the debited funds."},"CreditedFunds":{"$ref":"#/components/schemas/GooglePayPayInResponseCreditedFunds","description":"Information about the credited funds (`CreditedFunds` = `DebitedFunds` - `Fees`)."},"Fees":{"$ref":"#/components/schemas/GooglePayPayInResponseFees","description":"Information about the fees taken by the platform for this transaction (and hence transferred to the Fees Wallet)."},"Status":{"$ref":"#/components/schemas/TransactionStatus"},"ResultCode":{"$ref":"#/components/schemas/ResultCode"},"ResultMessage":{"$ref":"#/components/schemas/ResultMessage"},"ExecutionDate":{"$ref":"#/components/schemas/TransactionExecutionDate"},"Type":{"$ref":"#/components/schemas/TransactionType"},"Nature":{"$ref":"#/components/schemas/TransactionNature"},"CreditedWalletId":{"type":"string","description":"The unique identifier of the credited wallet."},"PaymentType":{"type":"string","description":"**Returned values:** `GOOGLE_PAY`\n\nThe payment type of the pay-in."},"ExecutionType":{"type":"string","description":"**Returned values:** `DIRECT`\n\nThe execution type of the pay-in."},"StatementDescriptor":{"$ref":"#/components/schemas/StatementDescriptor_22"},"SecureModeNeeded":{"type":"boolean","description":"Whether or not the `SecureMode` was used."},"Billing":{"$ref":"#/components/schemas/Billing_DefaultsShippingUser_Response"},"Shipping":{"$ref":"#/components/schemas/Shipping_DefaultsBillingUser_Response"},"BrowserInfo":{"$ref":"#/components/schemas/BrowserInfo"},"IpAddress":{"$ref":"#/components/schemas/IpAddress"},"CardInfo":{"$ref":"#/components/schemas/CardInfo"},"AuthenticationResult":{"$ref":"#/components/schemas/AuthenticationResult"}},"description":"A one-time Google Pay pay-in:\n- `PaymentType` – `GOOGLE_PAY`\n- `ExecutionType` – `DIRECT`\n- Object does not include `RecurringPayinRegistrationId`","title":"GooglePayPayInResponse"},"RecurringGooglePayPayInResponseDebitedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the debited funds.","title":"RecurringGooglePayPayInResponseDebitedFunds"},"RecurringGooglePayPayInResponseCreditedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the credited funds (`CreditedFunds` = `DebitedFunds` - `Fees`).","title":"RecurringGooglePayPayInResponseCreditedFunds"},"RecurringGooglePayPayInResponseFees":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the fees taken by the platform for this transaction (and hence transferred to the Fees Wallet).","title":"RecurringGooglePayPayInResponseFees"},"RecurringGooglePayPayInResponse":{"type":"object","properties":{"Id":{"$ref":"#/components/schemas/Id"},"Tag":{"$ref":"#/components/schemas/Tag"},"CreationDate":{"$ref":"#/components/schemas/CreationDate"},"AuthorId":{"$ref":"#/components/schemas/AuthorId"},"DebitedFunds":{"$ref":"#/components/schemas/RecurringGooglePayPayInResponseDebitedFunds","description":"Information about the debited funds."},"CreditedFunds":{"$ref":"#/components/schemas/RecurringGooglePayPayInResponseCreditedFunds","description":"Information about the credited funds (`CreditedFunds` = `DebitedFunds` - `Fees`)."},"Fees":{"$ref":"#/components/schemas/RecurringGooglePayPayInResponseFees","description":"Information about the fees taken by the platform for this transaction (and hence transferred to the Fees Wallet)."},"Status":{"$ref":"#/components/schemas/TransactionStatus"},"ResultCode":{"$ref":"#/components/schemas/ResultCode"},"ResultMessage":{"$ref":"#/components/schemas/ResultMessage"},"ExecutionDate":{"$ref":"#/components/schemas/TransactionExecutionDate"},"Type":{"$ref":"#/components/schemas/TransactionType"},"Nature":{"$ref":"#/components/schemas/TransactionNature"},"CreditedWalletId":{"type":"string","description":"The unique identifier of the credited wallet."},"CreditedUserId":{"$ref":"#/components/schemas/CreditedUserId"},"PaymentType":{"type":"string","description":"**Returned values:** `GOOGLE_PAY`\n\nThe payment type of the pay-in."},"ExecutionType":{"type":"string","description":"**Returned values:** `DIRECT`\n\nThe execution type of the pay-in."},"StatementDescriptor":{"$ref":"#/components/schemas/StatementDescriptor_22"},"SecureMode":{"type":"string","description":"**Returned values:** `DEFAULT`, `FORCE`, `NO_CHOICE`\n\nThe mode applied for the 3DS2 protocol for CB, Visa, and Mastercard. The options are:\n- `DEFAULT` – Requests an exemption to strong customer authentication (SCA), and thus a frictionless payment experience, if allowed by your Mangopay contract and accepted by the issuer.\n- `FORCE` – Requests SCA.\n- `NO_CHOICE` – Leaves the choice to the issuer whether to allow for a frictionless payment experience or to enforce SCA."},"SecureModeNeeded":{"type":"boolean","description":"Whether or not the `SecureMode` was used."},"BrowserInfo":{"$ref":"#/components/schemas/BrowserInfo"},"IpAddress":{"$ref":"#/components/schemas/IpAddress"},"CardInfo":{"$ref":"#/components/schemas/CardInfo"},"AuthenticationResult":{"$ref":"#/components/schemas/AuthenticationResult"},"RecurringPayinRegistrationId":{"type":"string","description":"The unique identifier of the recurring pay-in registration."},"Billing":{"$ref":"#/components/schemas/Billing_DefaultsShippingUser_Response"},"Shipping":{"$ref":"#/components/schemas/Shipping_DefaultsBillingUser_Response"}},"description":"A recurring Google Pay pay-in:\n- `PaymentType` – `GOOGLE_PAY`\n- `ExecutionType` – `DIRECT`\n- Object includes `RecurringPayinRegistrationId`","title":"RecurringGooglePayPayInResponse"},"PayPalPayInResponseDebitedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the debited funds. The amount must be equal to the total of all `UnitAmount` and `TaxAmount` of all `LineItems`.","title":"PayPalPayInResponseDebitedFunds"},"PayPalPayInResponseCreditedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the credited funds (`CreditedFunds` = `DebitedFunds` - `Fees`).","title":"PayPalPayInResponseCreditedFunds"},"PayPalPayInResponseFees":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the fees.","title":"PayPalPayInResponseFees"},"ReturnURL_255":{"type":"string","description":"Max. length: 255 characters\n\nThe URL to which the user is returned after the payment, whether the transaction is successful or not.","title":"ReturnURL_255"},"PayPalPayInResponseShipping":{"type":"object","properties":{"FirstName":{"type":"string","description":"The first name of the user."},"LastName":{"type":"string","description":"The last name of the user."},"Address":{"$ref":"#/components/schemas/Address"}},"description":"Information about the end user's shipping address, managed by `ShippingPreference`.","title":"PayPalPayInResponseShipping"},"PayPalPayInResponseLineItemsItems":{"type":"object","properties":{"Name":{"type":"string","description":"The name of the item."},"Quantity":{"type":"integer","description":"The quantity of the item."},"UnitAmount":{"type":"integer","description":"The cost of the item, excluding tax."},"TaxAmount":{"type":"integer","description":"The tax amount applied to the item."},"Description":{"type":"string","description":"The platform's unique reference for the seller. This value must be consistently used for the given seller. You can use, for example, the Mangopay `UserId` or the seller's business name or first name and last name.\n\n**Caution:** Failure to use a unique seller identifier may result in PayPal restricting your service."},"Category":{"type":"string","description":"**Returned values:** `PHYSICAL_GOODS`, `DIGITAL_GOODS`, `DONATION`\n\nThe category of the item:\n- `PHYSICAL_GOODS` – Tangible items that can be physically shipped and received with proof of delivery upon arrival.\n- `DIGITAL_GOODS` – Products or services that are distributed and consumed via digital platforms or devices.\n- `DONATION` – Voluntary contribution made without any goods or services received in return. Multiple line items can be categorized as `DONATION` within a single transaction, however it is not possible to combine `DONATION` other line item categories within the same transaction."}},"title":"PayPalPayInResponseLineItemsItems"},"PayPalPayInResponseTrackingsItems":{"type":"object","properties":{"TrackingNumber":{"type":"string","description":"The shipment's tracking number provided by the carrier."},"Carrier":{"type":"string","description":"The carrier for the shipment. Use the country-specific version of the carrier if it exists, otherwise use its global version."},"NotifyBuyer":{"type":"boolean","description":"**Default value:** false\n\nIf `true`, sends an email notification to the `PaypalBuyerAccountEmail` containing the `TrackingNumber` and `Carrier`, which allows the end user to track their shipment with the carrier."}},"title":"PayPalPayInResponseTrackingsItems"},"PayPalPayInResponse":{"type":"object","properties":{"Id":{"$ref":"#/components/schemas/Id"},"Tag":{"$ref":"#/components/schemas/Tag"},"CreationDate":{"$ref":"#/components/schemas/CreationDate"},"AuthorId":{"$ref":"#/components/schemas/AuthorId"},"FlowDescriptor":{"$ref":"#/components/schemas/FlowDescriptorResponse"},"DebitedFunds":{"$ref":"#/components/schemas/PayPalPayInResponseDebitedFunds","description":"Information about the debited funds. The amount must be equal to the total of all `UnitAmount` and `TaxAmount` of all `LineItems`."},"CreditedFunds":{"$ref":"#/components/schemas/PayPalPayInResponseCreditedFunds","description":"Information about the credited funds (`CreditedFunds` = `DebitedFunds` - `Fees`)."},"Fees":{"$ref":"#/components/schemas/PayPalPayInResponseFees","description":"Information about the fees."},"Status":{"$ref":"#/components/schemas/TransactionStatus"},"ResultCode":{"$ref":"#/components/schemas/ResultCode"},"ResultMessage":{"$ref":"#/components/schemas/ResultMessage"},"ExecutionDate":{"$ref":"#/components/schemas/TransactionExecutionDate"},"Type":{"$ref":"#/components/schemas/TransactionType"},"Nature":{"$ref":"#/components/schemas/TransactionNature"},"CreditedWalletId":{"type":"string","description":"The unique identifier of the credited wallet."},"PaymentType":{"type":"string","description":"**Returned values:** `PAYPAL`\n\nThe payment type of the pay-in."},"ExecutionType":{"type":"string","description":"**Returned values:** `WEB`\n\nThe execution type of the pay-in."},"ReturnURL":{"$ref":"#/components/schemas/ReturnURL_255"},"RedirectURL":{"type":"string","description":"The URL to which to redirect the user to complete the payment.\n\n**Caution:** This variable URL is specific to each payment. You must rely on the returned URL in full (host, path, and queries) and not hardcode any part of it."},"StatementDescriptor":{"$ref":"#/components/schemas/StatementDescriptor"},"Shipping":{"$ref":"#/components/schemas/PayPalPayInResponseShipping","description":"Information about the end user's shipping address, managed by `ShippingPreference`."},"LineItems":{"type":"array","items":{"$ref":"#/components/schemas/PayPalPayInResponseLineItemsItems"},"description":"Information about the items purchased in the transaction. The total of all line items' `UnitAmount` and `TaxAmount` must equal the `DebitedFunds` amount (negative amounts not allowed)."},"Culture":{"type":"string","description":"**Returned values:** One of the supported languages in the [ISO 639-1 format](/api-reference/overview/data-formats): AT, BR, CA, CH, CN, DE, DK, ES, FR, GB, ID, IL, IT, JK, JP, NL, NO, PL, PT, RU, SE, TH, TR, TW, US.\n\nThe language in which the PayPal payment page is to be displayed."},"ShippingPreference":{"type":"string","description":"**Returned values:** `SET_PROVIDED_ADDRESS`, `GET_FROM_FILE`, `NO_SHIPPING`\n\nInformation about the shipping address behavior on the PayPal payment page:\n- `SET_PROVIDED_ADDRESS` - The `Shipping` parameter becomes required and its values are displayed to the end user, who is not able to modify them.\n- `GET_FROM_FILE` – The `Shipping` parameter is ignored and the end user can choose from registered addresses.\n- `NO_SHIPPING` – No shipping address section is displayed."},"PaypalBuyerAccountEmail":{"type":"string","description":"The email address registered on the PayPal account used to make the payment."},"Reference":{"type":"string","description":"Max. length: 127 characters (truncated after)\n\nThe platform's order reference for the transaction."},"Trackings":{"type":"array","items":{"$ref":"#/components/schemas/PayPalPayInResponseTrackingsItems"},"description":"Shipping information of the `LineItems` added to the pay-in object."},"CancelURL":{"type":"string","description":"The URL to which the user is returned after canceling the payment. If not provided, the Cancel button returns the user to the `RedirectURL`."},"PaypalOrderID":{"type":"string","description":"PayPal's unique identifier for the order."},"BuyerCountry":{"type":"string","description":"The country of the buyer."},"BuyerFirstname":{"type":"string","description":"The first name of the buyer."},"BuyerPhone":{"type":"string","description":"The mobile phone number of the buyer."},"BuyerLastname":{"type":"string","description":"The last name of the buyer."},"PaypalPayerID":{"type":"string","description":"The PayPal identifier of the buyer."}},"description":"A one-time PayPal pay-in:\n- `PaymentType` – `PAYPAL`\n- `ExecutionType` – `WEB`\n- Object does not include `RecurringPayinRegistrationId`","title":"PayPalPayInResponse"},"RecurringPayPalPayInResponseDebitedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the debited funds. The amount must be equal to the total of all `UnitAmount` and `TaxAmount` of all `LineItems`.","title":"RecurringPayPalPayInResponseDebitedFunds"},"RecurringPayPalPayInResponseCreditedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the credited funds (`CreditedFunds` = `DebitedFunds` - `Fees`).","title":"RecurringPayPalPayInResponseCreditedFunds"},"RecurringPayPalPayInResponseFees":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the fees.","title":"RecurringPayPalPayInResponseFees"},"RecurringPayPalPayInResponseShipping":{"type":"object","properties":{"FirstName":{"type":"string","description":"The first name of the user."},"LastName":{"type":"string","description":"The last name of the user."},"Address":{"$ref":"#/components/schemas/Address"}},"description":"Information about the end user's shipping address, managed by `ShippingPreference`.","title":"RecurringPayPalPayInResponseShipping"},"RecurringPayPalPayInResponseLineItemsItems":{"type":"object","properties":{"Name":{"type":"string","description":"The name of the item."},"Quantity":{"type":"integer","description":"The quantity of the item."},"UnitAmount":{"type":"integer","description":"The cost of the item, excluding tax."},"TaxAmount":{"type":"integer","description":"The tax amount applied to the item."},"Description":{"type":"string","description":"The platform's unique reference for the seller. This value must be consistently used for the given seller. You can use, for example, the Mangopay `UserId` or the seller's business name or first name and last name.\n\n**Caution:** Failure to use a unique seller identifier may result in PayPal restricting your service."},"Category":{"type":"string","description":"**Returned values:** `PHYSICAL_GOODS`, `DIGITAL_GOODS`, `DONATION`\n\nThe category of the item:\n- `PHYSICAL_GOODS` – Tangible items that can be physically shipped and received with proof of delivery upon arrival.\n- `DIGITAL_GOODS` – Products or services that are distributed and consumed via digital platforms or devices.\n- `DONATION` – Voluntary contribution made without any goods or services received in return. Multiple line items can be categorized as `DONATION` within a single transaction, however it is not possible to combine `DONATION` other line item categories within the same transaction."}},"title":"RecurringPayPalPayInResponseLineItemsItems"},"RecurringPayPalPayInResponseTrackingsItems":{"type":"object","properties":{"TrackingNumber":{"type":"string","description":"The shipment's tracking number provided by the carrier."},"Carrier":{"type":"string","description":"The carrier for the shipment. Use the country-specific version of the carrier if it exists, otherwise use its global version."},"NotifyBuyer":{"type":"boolean","description":"**Default value:** false\n\nIf `true`, sends an email notification to the `PaypalBuyerAccountEmail` containing the `TrackingNumber` and `Carrier`, which allows the end user to track their shipment with the carrier."}},"title":"RecurringPayPalPayInResponseTrackingsItems"},"RecurringPayPalPayInResponse":{"type":"object","properties":{"Id":{"$ref":"#/components/schemas/Id"},"Tag":{"$ref":"#/components/schemas/Tag"},"CreationDate":{"$ref":"#/components/schemas/CreationDate"},"AuthorId":{"$ref":"#/components/schemas/AuthorId"},"DebitedFunds":{"$ref":"#/components/schemas/RecurringPayPalPayInResponseDebitedFunds","description":"Information about the debited funds. The amount must be equal to the total of all `UnitAmount` and `TaxAmount` of all `LineItems`."},"CreditedFunds":{"$ref":"#/components/schemas/RecurringPayPalPayInResponseCreditedFunds","description":"Information about the credited funds (`CreditedFunds` = `DebitedFunds` - `Fees`)."},"Fees":{"$ref":"#/components/schemas/RecurringPayPalPayInResponseFees","description":"Information about the fees."},"Status":{"$ref":"#/components/schemas/TransactionStatus"},"ResultCode":{"$ref":"#/components/schemas/ResultCode"},"ResultMessage":{"$ref":"#/components/schemas/ResultMessage"},"ExecutionDate":{"$ref":"#/components/schemas/TransactionExecutionDate"},"Type":{"$ref":"#/components/schemas/TransactionType"},"Nature":{"$ref":"#/components/schemas/TransactionNature"},"CreditedWalletId":{"type":"string","description":"The unique identifier of the credited wallet."},"PaymentType":{"type":"string","description":"**Returned values:** `PAYPAL`\n\nThe payment type of the pay-in."},"ExecutionType":{"type":"string","description":"**Returned values:** `DIRECT`\n\nThe execution type of the pay-in."},"ReturnURL":{"$ref":"#/components/schemas/ReturnURL_255"},"RedirectURL":{"type":"string","description":"The URL to which to redirect the user to complete the payment.\n\n**Caution:** This variable URL is specific to each payment. You must rely on the returned URL in full (host, path, and queries) and not hardcode any part of it."},"StatementDescriptor":{"$ref":"#/components/schemas/StatementDescriptor"},"Shipping":{"$ref":"#/components/schemas/RecurringPayPalPayInResponseShipping","description":"Information about the end user's shipping address, managed by `ShippingPreference`."},"LineItems":{"type":"array","items":{"$ref":"#/components/schemas/RecurringPayPalPayInResponseLineItemsItems"},"description":"Information about the items purchased in the transaction. The total of all line items' `UnitAmount` and `TaxAmount` must equal the `DebitedFunds` amount (negative amounts not allowed)."},"Culture":{"type":"string","description":"**Returned values:** One of the supported languages in the [ISO 639-1 format](/api-reference/overview/data-formats): AT, BR, CA, CH, CN, DE, DK, ES, FR, GB, ID, IL, IT, JK, JP, NL, NO, PL, PT, RU, SE, TH, TR, TW, US.\n\nThe language in which the PayPal payment page is to be displayed."},"ShippingPreference":{"type":"string","description":"**Returned values:** `SET_PROVIDED_ADDRESS`, `GET_FROM_FILE`, `NO_SHIPPING`\n\nInformation about the shipping address behavior on the PayPal payment page:\n- `SET_PROVIDED_ADDRESS` - The `Shipping` parameter becomes required and its values are displayed to the end user, who is not able to modify them.\n- `GET_FROM_FILE` – The `Shipping` parameter is ignored and the end user can choose from registered addresses.\n- `NO_SHIPPING` – No shipping address section is displayed."},"PaypalBuyerAccountEmail":{"type":"string","description":"The email address registered on the PayPal account used to make the payment."},"Reference":{"type":"string","description":"Max. length: 127 characters (truncated after)\n\nThe platform's order reference for the transaction."},"Trackings":{"type":"array","items":{"$ref":"#/components/schemas/RecurringPayPalPayInResponseTrackingsItems"},"description":"Shipping information of the `LineItems` added to the pay-in object."},"CancelURL":{"type":"string","description":"The URL to which the user is returned after canceling the payment. If not provided, the Cancel button returns the user to the `RedirectURL`."},"PaypalPayerID":{"type":"string","description":"The PayPal identifier of the buyer."},"BuyerCountry":{"type":"string","description":"The country of the buyer."},"BuyerFirstname":{"type":"string","description":"The first name of the buyer."},"BuyerLastname":{"type":"string","description":"The last name of the buyer."},"BuyerPhone":{"type":"string","description":"The mobile phone number of the buyer."},"PaypalOrderID":{"type":"string","description":"PayPal's unique identifier for the order."},"RecurringPayinRegistrationId":{"type":"string","description":"The unique identifier of the recurring pay-in registration."}},"description":"A recurring PayPal pay-in:\n- `PaymentType` – `PAYPAL`\n- `ExecutionType` – `DIRECT`\n- Object includes `RecurringPayinRegistrationId`","title":"RecurringPayPalPayInResponse"},"BankWirePayInResponseDebitedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the debited funds.\n\nFor a direct bank wire pay-in, the `DebitedFunds` displays placeholder values (currency `XXX` and amount `0`) until the `Status` changes to `SUCCEEDED`.","title":"BankWirePayInResponseDebitedFunds"},"BankWirePayInResponseCreditedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the credited funds (`CreditedFunds` = `DebitedFunds` - `Fees`).\n\nFor a direct bank wire pay-in, the `CreditedFunds` displays placeholder values (currency `XXX` and amount `0`) until the `Status` changes to `SUCCEEDED`.","title":"BankWirePayInResponseCreditedFunds"},"BankWirePayInResponseFees":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the fees taken by the platform for this transaction (and hence transferred to the Fees Wallet).","title":"BankWirePayInResponseFees"},"BankWirePayInResponseDeclaredDebitedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the declared debited funds.","title":"BankWirePayInResponseDeclaredDebitedFunds"},"BankWirePayInResponseDeclaredFees":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the declared fees.","title":"BankWirePayInResponseDeclaredFees"},"BankWirePayInResponseBankAccount":{"type":"object","properties":{"OwnerAddress":{"$ref":"#/components/schemas/Address"},"Type":{"type":"string","description":"**Returned values:** `IBAN`, `US`, `CA`, `GB`, `OTHER`\n\nThe type of the bank account."},"OwnerName":{"type":"string","description":"The full name of the owner of the bank account."},"IBAN":{"type":"string","description":"The IBAN (international bank account number) for the bank account."},"BIC":{"type":"string","description":"The BIC (international identifier of the bank) for the bank account."}},"description":"Information about the bank account to which the bank wire must be made by the end user. **Caution:** Do not hardcode the returned values. Mangopay may change the underlying bank details without prior notice.","title":"BankWirePayInResponseBankAccount"},"BankWirePayInResponseTransactionDetailsItemsReferencesItems":{"type":"object","properties":{"Type":{"type":"string","description":"Max. length: 50 characters\n\nThe type of the reference."},"Value":{"type":"string","description":"Max. length: 100 characters\n\nThe value of the reference."}},"title":"BankWirePayInResponseTransactionDetailsItemsReferencesItems"},"BankWirePayInResponseTransactionDetailsItems":{"type":"object","properties":{"BankTransactionDomainCode":{"type":"string","description":"Max. length: 50 characters\n\nThe bank transaction domain code (e.g. PMNT)."},"BankTransactionDomainFamilyCode":{"type":"string","description":"Max. length: 50 characters\n\nThe bank transaction domain family code (e.g. ICDT)."},"BankTransactionDomainSubFamilyCode":{"type":"string","description":"Max. length: 50 characters\n\nThe domain sub-family code (e.g. ACDT)."},"References":{"type":"array","items":{"$ref":"#/components/schemas/BankWirePayInResponseTransactionDetailsItemsReferencesItems"},"description":"References for the transaction. If multiple references are available, multiple objects are returned."},"DebtorName":{"type":"string","description":"Max. length: 100 characters\n\nThe name of the debtor (i.e. the registered owner of the account that was debited)."},"DebtorAccount":{"type":"string","description":"Max. length: 50 characters\n\nThe account identifier of the debtor (e.g. the account number)."},"DebtorAgent":{"type":"string","description":"Max. length: 50 characters\n\nThe agent of the debtor (e.g. the BIC or bank code)."},"DebtorAddressLine1":{"type":"string","description":"Max. length: 500 characters\n\nThe first line of the debtor's address."},"DebtorAddressLine2":{"type":"string","description":"Max. length: 500 characters\n\nThe second line of the debtor's address."},"DebtorAddressLine3":{"type":"string","description":"Max. length: 500 characters\n\nThe third line of the debtor's address."},"RemittanceInformationLine1":{"type":"string","description":"Max. length: 1,000 characters\n\nRemittance information for the transaction."},"RemittanceInformationLine2":{"type":"string","description":"Max. length: 1,000 characters\n\nRemittance information for the transaction."},"RemittanceInformationLine3":{"type":"string","description":"Max. length: 1,000 characters\n\nRemittance information for the transaction."},"RemittanceInformationLine4":{"type":"string","description":"Max. length: 1,000 characters\n\nRemittance information for the transaction."}},"title":"BankWirePayInResponseTransactionDetailsItems"},"BankWirePayInResponse":{"type":"object","properties":{"Id":{"$ref":"#/components/schemas/Id"},"Tag":{"$ref":"#/components/schemas/Tag"},"CreationDate":{"$ref":"#/components/schemas/CreationDate"},"ResultCode":{"$ref":"#/components/schemas/ResultCode"},"ResultMessage":{"$ref":"#/components/schemas/ResultMessage"},"AuthorId":{"$ref":"#/components/schemas/AuthorId"},"CreditedUserId":{"$ref":"#/components/schemas/CreditedUserId"},"FlowDescriptor":{"$ref":"#/components/schemas/FlowDescriptorResponse"},"DebitedFunds":{"$ref":"#/components/schemas/BankWirePayInResponseDebitedFunds","description":"Information about the debited funds.\n\nFor a direct bank wire pay-in, the `DebitedFunds` displays placeholder values (currency `XXX` and amount `0`) until the `Status` changes to `SUCCEEDED`."},"CreditedFunds":{"$ref":"#/components/schemas/BankWirePayInResponseCreditedFunds","description":"Information about the credited funds (`CreditedFunds` = `DebitedFunds` - `Fees`).\n\nFor a direct bank wire pay-in, the `CreditedFunds` displays placeholder values (currency `XXX` and amount `0`) until the `Status` changes to `SUCCEEDED`."},"Fees":{"$ref":"#/components/schemas/BankWirePayInResponseFees","description":"Information about the fees taken by the platform for this transaction (and hence transferred to the Fees Wallet)."},"Status":{"$ref":"#/components/schemas/TransactionStatus"},"ExecutionDate":{"$ref":"#/components/schemas/TransactionExecutionDate"},"Type":{"$ref":"#/components/schemas/TransactionType"},"Nature":{"$ref":"#/components/schemas/TransactionNature"},"CreditedWalletId":{"type":"string","description":"The unique identifier of the credited wallet."},"DebitedWalletId":{"type":"string","description":"The unique identifier of the debited wallet.\n\nIn the case of a pay-in, this value is always `null` since there is no debited wallet."},"PaymentType":{"type":"string","description":"**Returned values:** `BANK_WIRE`\n\nThe payment type of the pay-in."},"ExecutionType":{"type":"string","description":"**Returned values:** `DIRECT`\n\nThe execution type of the pay-in."},"DeclaredDebitedFunds":{"$ref":"#/components/schemas/BankWirePayInResponseDeclaredDebitedFunds","description":"Information about the declared debited funds."},"DeclaredFees":{"$ref":"#/components/schemas/BankWirePayInResponseDeclaredFees","description":"Information about the declared fees."},"WireReference":{"type":"string","description":"Max. length: 255 characters\n\nThe reference which the end user must provide when making the bank wire. The `WireReference` is used to reconcile the funds that arrive on the bank account with the `DeclaredDebitedFunds` in the Direct Bank Wire PayIn object.\n\n**Caution:** This reference is specific to each payment and must be retrieved dynamically."},"BankAccount":{"$ref":"#/components/schemas/BankWirePayInResponseBankAccount","description":"Information about the bank account to which the bank wire must be made by the end user. **Caution:** Do not hardcode the returned values. Mangopay may change the underlying bank details without prior notice."},"TransactionDetails":{"type":"array","items":{"$ref":"#/components/schemas/BankWirePayInResponseTransactionDetailsItems"},"description":"Max. length: 50 characters\n\nInformation received from banking partners for the transaction, based on the cash management (Camt) messages of ISO 20022.\n\nThis information is only returned when the pay-in `Status` becomes `SUCCEEDED`.\n\nIf data is not available then an empty array, `null`, or nulled fields are returned.\n\nIf multiple wire payments are received for a single pay-in, then multiple objects are returned."}},"description":"A direct bank wire pay-in:\n- `PaymentType` – `BANK_WIRE`\n- `ExecutionType` – `DIRECT`","title":"BankWirePayInResponse"},"ExternalInstructionPayInResponseDebitedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the debited funds.","title":"ExternalInstructionPayInResponseDebitedFunds"},"ExternalInstructionPayInResponseCreditedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the credited funds (`CreditedFunds` = `DebitedFunds` - `Fees`).","title":"ExternalInstructionPayInResponseCreditedFunds"},"ExternalInstructionPayInResponseFees":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the fees taken by the platform for this transaction (and hence transferred to the Fees Wallet).","title":"ExternalInstructionPayInResponseFees"},"ExternalInstructionPayInResponseDebitedBankAccount":{"type":"object","properties":{"Type":{"type":"string","description":"**Returned values:** `IBAN`, `US`, `CA`, `GB`, `OTHER`\n\nThe type of the bank account."},"OwnerName":{"type":"string","description":"Max. length: 255 characters\n\nThe full name of the owner of the bank account. (Format: FirstName LastName)"},"IBAN":{"type":"string","description":"Max. length: 34 characters\n\nThe IBAN (international bank account number) of the bank account.\nIt follows the CCDDBBAN format in which:\n\n- CC represents the country code (ISO 3166-1 alpha 2)\n- DD represents two check digits used by banking systems to avoid simple errors\n- BBAN stands for the Basic Bank Account Number which is up to 30 alphanumeric characters that are country-specific.\n  Note: You will need a valid IBAN (i.e., existing in real life) when testing on a Sandbox account even if no actual payout will be processed."},"BIC":{"type":"string","description":"The BIC (international identifier of the bank) for IBAN or OTHER-type bank accounts.\n\nThe BIC can have one of the two following formats:\n\n- BIC8 – 8-character BIC (AAAABBCC)\n- BIC11 – 11-character BIC (AAAABBCCDDD)\n\nIn which:\n\n- AAAA represents the bank code: 4 characters defining the bank\n- BB represents the country code: 2 characters forming the country ISO code (ISO 3166 format)\n- CC represents the location code: 2 localization characters (alphabetical or numeric) to distinguish banks from the same country\n- DDD represents the branch code: 3 characters used to define the branch of the bank (sometimes replaced with XXX)"},"AccountNumber":{"type":"string","description":"The unique number of the bank account."},"Country":{"type":"string","description":"Format: Two-letter country code ([ISO 3166-1 alpha-2 format](/api-reference/overview/data-formats))\n\nThe country in which the bank account is registered."}},"description":"Information about the debited bank account.\n\n**Note:** This information may only be available for EU IBANs.","title":"ExternalInstructionPayInResponseDebitedBankAccount"},"ExternalInstructionPayInResponse":{"type":"object","properties":{"Id":{"$ref":"#/components/schemas/Id"},"Tag":{"$ref":"#/components/schemas/Tag"},"CreationDate":{"$ref":"#/components/schemas/CreationDate"},"ResultCode":{"$ref":"#/components/schemas/ResultCode"},"ResultMessage":{"$ref":"#/components/schemas/ResultMessage"},"AuthorId":{"$ref":"#/components/schemas/AuthorId"},"CreditedUserId":{"$ref":"#/components/schemas/CreditedUserId"},"DebitedFunds":{"$ref":"#/components/schemas/ExternalInstructionPayInResponseDebitedFunds","description":"Information about the debited funds."},"CreditedFunds":{"$ref":"#/components/schemas/ExternalInstructionPayInResponseCreditedFunds","description":"Information about the credited funds (`CreditedFunds` = `DebitedFunds` - `Fees`)."},"Fees":{"$ref":"#/components/schemas/ExternalInstructionPayInResponseFees","description":"Information about the fees taken by the platform for this transaction (and hence transferred to the Fees Wallet)."},"Status":{"$ref":"#/components/schemas/TransactionStatus"},"ExecutionDate":{"$ref":"#/components/schemas/TransactionExecutionDate"},"Type":{"$ref":"#/components/schemas/TransactionType"},"Nature":{"$ref":"#/components/schemas/TransactionNature"},"CreditedWalletId":{"type":"string","description":"The unique identifier of the credited wallet."},"DebitedWalletId":{"type":"string","description":"The unique identifier of the debited wallet.\n\nIn the case of a pay-in, this value is always `null` since there is no debited wallet."},"PaymentType":{"type":"string","description":"**Returned values:** `BANK_WIRE`\n\nThe payment type of the pay-in."},"ExecutionType":{"type":"string","description":"**Returned values:** `EXTERNAL_INSTRUCTION`\n\nThe execution type of the pay-in."},"WireReference":{"type":"string","description":"The reference of the bank wire received on the virtual IBAN, as provided by the user. If no reference was provided, then this value is `null`."},"BankingAliasId":{"type":"string","description":"The unique identifier of the banking alias."},"DebitedBankAccount":{"$ref":"#/components/schemas/ExternalInstructionPayInResponseDebitedBankAccount","description":"Information about the debited bank account.\n\n**Note:** This information may only be available for EU IBANs."}},"description":"A bank wire pay-in to a Virtual Account (or Banking Alias):\n- `PaymentType` – `BANK_WIRE`\n- `ExecutionType` – `EXTERNAL_INSTRUCTION`","title":"ExternalInstructionPayInResponse"},"PayByBankPayInResponseDebitedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the debited funds.","title":"PayByBankPayInResponseDebitedFunds"},"PayByBankPayInResponseCreditedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the credited funds (`CreditedFunds` = `DebitedFunds` - `Fees`).","title":"PayByBankPayInResponseCreditedFunds"},"PayByBankPayInResponseFees":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the fees.","title":"PayByBankPayInResponseFees"},"PayByBankPayInResponse":{"type":"object","properties":{"Id":{"$ref":"#/components/schemas/Id"},"Tag":{"$ref":"#/components/schemas/Tag"},"CreationDate":{"$ref":"#/components/schemas/CreationDate"},"AuthorId":{"$ref":"#/components/schemas/AuthorId"},"DebitedFunds":{"$ref":"#/components/schemas/PayByBankPayInResponseDebitedFunds","description":"Information about the debited funds."},"CreditedFunds":{"$ref":"#/components/schemas/PayByBankPayInResponseCreditedFunds","description":"Information about the credited funds (`CreditedFunds` = `DebitedFunds` - `Fees`)."},"Fees":{"$ref":"#/components/schemas/PayByBankPayInResponseFees","description":"Information about the fees."},"Status":{"$ref":"#/components/schemas/TransactionStatus"},"ResultCode":{"$ref":"#/components/schemas/ResultCode"},"ResultMessage":{"$ref":"#/components/schemas/ResultMessage"},"ExecutionDate":{"$ref":"#/components/schemas/TransactionExecutionDate"},"Type":{"$ref":"#/components/schemas/TransactionType"},"Nature":{"$ref":"#/components/schemas/TransactionNature"},"CreditedWalletId":{"type":"string","description":"The unique identifier of the credited wallet."},"CreditedUserId":{"$ref":"#/components/schemas/CreditedUserId"},"FlowDescriptor":{"$ref":"#/components/schemas/FlowDescriptorResponse"},"PaymentType":{"type":"string","description":"**Returned values:** `PAY_BY_BANK`\n\nThe payment type of the pay-in."},"ExecutionType":{"type":"string","description":"**Returned values:** `WEB`\n\nThe execution type of the pay-in."},"ReturnURL":{"$ref":"#/components/schemas/ReturnURL_255"},"RedirectURL":{"type":"string","description":"The URL to which to redirect the user to complete the payment.\n\n**Caution:** This variable URL is specific to each payment. You must rely on the returned URL in full (host, path, and queries) and not hardcode any part of it."},"StatementDescriptor":{"$ref":"#/components/schemas/StatementDescriptor"},"Country":{"type":"string","description":"**Allowed values:** `AT`, `DE`, `DK`, `EE`, `ES`, `FI`, `FR`, `GB`, `IE`, `IT`, `LV`, `LT`, `NL`, `NO`, `PL`, `PT`.\n\nThe country of residence of the user."},"BIC":{"type":"string","description":"The BIC of the user's bank account, which is only returned if it was sent.\n\nIf both the `IBAN` and `BIC` are provided, one of the two authentication steps required by certain banks may be avoided."},"IBAN":{"type":"string","description":"The IBAN of the user's bank account, which is only returned if it was sent.\n\nIf both the `IBAN` and `BIC` are provided, one of the two authentication steps required by certain banks may be avoided."},"PaymentFlow":{"type":"string","description":"**Allowed values:** `WEB`, `APP`\n\n**Default value:** `WEB`\n\nThe platform environment of the post-payment flow. The `PaymentFlow` value combines with the `ReturnURL` to manage the redirection behavior after payment:\n- Set the value to `APP` to send the user to your platform's mobile app\n- Set the value to `WEB` to send the user to a web browser\n\nIn both cases you need to provide the relevant `ReturnURL`, whether to your app or website."},"BankName":{"type":"string","description":"**Allowed values:** One of the [supported bank names](/guides/payment-methods/banking/pay-by-bank#banks-and-schemes).\n\nThe name of the bank, which is only returned if it was sent.\n\nIf the `BankName` is provided, the user doesn't have to select their bank when they are redirected."},"Culture":{"type":"string","description":"**Allowed values:** `DA`, `CS`, `DE`, `EN`, `ET`, `ES`, `FI`, `FR`, `IT`, `LT`, `LV`, `NL`, `NO`, `PL`, `PT`, `SV`\n\n**Default value:** `EN`\n\nThe language in which the Tink open banking page is to be displayed."},"Scheme":{"type":"string","description":"**Allowed values:** One of the [supported schemes](/guides/payment-methods/banking/pay-by-bank#banks-and-schemes) for the `Country`.\n\n**Default value:** The [listed instant scheme](/guides/payment-methods/banking/pay-by-bank#banks-and-schemes) for the `Country`. If `Country` is `DK`, there is no default and the `Scheme` must be specified.\n\nThe scheme to use to process the payment. Note that some banks may charge additional fees to the user for instant payment schemes."},"ProcessingStatus":{"type":"string","description":"**Possible values:** `PENDING_SUCCEEDED`\n\nParameter that is only returned once the bank wire has been successfully authenticated and initiated by the user but has not yet been received by Mangopay. When the funds are received, the `Status` changes from `CREATED` to `SUCCEEDED` and the `ProcessingStatus` is no longer returned.\n\nFor non-instant schemes, processing can take up to 72 hours but is typically completed within 2 days."}},"description":"A Pay by Bank pay-in:\n- `PaymentType` – `PAY_BY_BANK`\n- `ExecutionType` – `WEB`","title":"PayByBankPayInResponse"},"BancontactPayInResponseDebitedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the debited funds.","title":"BancontactPayInResponseDebitedFunds"},"BancontactPayInResponseCreditedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the credited funds (`CreditedFunds` = `DebitedFunds` - `Fees`).","title":"BancontactPayInResponseCreditedFunds"},"BancontactPayInResponseFees":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the fees.","title":"BancontactPayInResponseFees"},"BancontactPayInResponse":{"type":"object","properties":{"Id":{"$ref":"#/components/schemas/Id"},"Tag":{"$ref":"#/components/schemas/Tag"},"CreationDate":{"$ref":"#/components/schemas/CreationDate"},"AuthorId":{"$ref":"#/components/schemas/AuthorId"},"DebitedFunds":{"$ref":"#/components/schemas/BancontactPayInResponseDebitedFunds","description":"Information about the debited funds."},"CreditedFunds":{"$ref":"#/components/schemas/BancontactPayInResponseCreditedFunds","description":"Information about the credited funds (`CreditedFunds` = `DebitedFunds` - `Fees`)."},"Fees":{"$ref":"#/components/schemas/BancontactPayInResponseFees","description":"Information about the fees."},"Status":{"$ref":"#/components/schemas/TransactionStatus"},"ResultCode":{"$ref":"#/components/schemas/ResultCode"},"ResultMessage":{"$ref":"#/components/schemas/ResultMessage"},"ExecutionDate":{"$ref":"#/components/schemas/TransactionExecutionDate"},"Type":{"$ref":"#/components/schemas/TransactionType"},"Nature":{"$ref":"#/components/schemas/TransactionNature"},"CreditedWalletId":{"type":"string","description":"The unique identifier of the credited wallet."},"CreditedUserId":{"$ref":"#/components/schemas/CreditedUserId"},"FlowDescriptor":{"$ref":"#/components/schemas/FlowDescriptorResponse"},"PaymentType":{"type":"string","description":"**Returned values:** `BCMC`\n\nThe payment type of the pay-in."},"ExecutionType":{"type":"string","description":"**Returned values:** `WEB`\n\nThe execution type of the pay-in."},"ReturnURL":{"$ref":"#/components/schemas/ReturnURL_255"},"RedirectURL":{"type":"string","description":"The URL to which to redirect the user to complete the payment.\n\n**Caution:** This variable URL is specific to each payment. You must rely on the returned URL in full (host, path, and queries) and not hardcode any part of it."},"StatementDescriptor":{"$ref":"#/components/schemas/StatementDescriptor"},"Recurring":{"type":"boolean","description":"Whether or not the pay-in forms part of a Bancontact recurring payment flow (not yet available)."},"Culture":{"type":"string","description":"**Allowed values:** One of the supported languages in the ISO 639-1 format: DE, EN, FR, NL\n\n**Default value:** FR\n\nThe language in which the Bancontact payment page is to be displayed."},"PaymentFlow":{"type":"string","description":"**Allowed values:** `WEB`, `APP`\n\n**Default value:** `WEB`\n\nThe platform environment of the post-payment flow. The `PaymentFlow` value combines with the `ReturnURL` to manage the redirection behavior after payment:\n- Set the value to `APP` to send the user to your platform's mobile app\n- Set the value to `WEB` to send the user to a web browser\n\nIn both cases you need to provide the relevant `ReturnURL`, whether to your app or website."},"DeepLinkURL":{"type":"string","description":"The mobile URL to which to redirect the user to complete the payment in an app-to-app flow.\n\n**Note:** In Sandbox, this value is a placeholder: the `RedirectURL` must be used to complete the payment using Mangopay's web-based simulator."}},"description":"A Bancontact pay-in:\n- `PaymentType` – `BCMC`\n- `ExecutionType` – `WEB`","title":"BancontactPayInResponse"},"BizumPayInResponseDebitedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the debited funds.","title":"BizumPayInResponseDebitedFunds"},"BizumPayInResponseCreditedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the credited funds (`CreditedFunds` = `DebitedFunds` - `Fees`).","title":"BizumPayInResponseCreditedFunds"},"BizumPayInResponseFees":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the fees.","title":"BizumPayInResponseFees"},"BizumPayInResponse":{"type":"object","properties":{"Id":{"$ref":"#/components/schemas/Id"},"Tag":{"$ref":"#/components/schemas/Tag"},"CreationDate":{"$ref":"#/components/schemas/CreationDate"},"AuthorId":{"$ref":"#/components/schemas/AuthorId"},"DebitedFunds":{"$ref":"#/components/schemas/BizumPayInResponseDebitedFunds","description":"Information about the debited funds."},"CreditedFunds":{"$ref":"#/components/schemas/BizumPayInResponseCreditedFunds","description":"Information about the credited funds (`CreditedFunds` = `DebitedFunds` - `Fees`)."},"Fees":{"$ref":"#/components/schemas/BizumPayInResponseFees","description":"Information about the fees."},"Status":{"$ref":"#/components/schemas/TransactionStatus"},"ResultCode":{"$ref":"#/components/schemas/ResultCode"},"ResultMessage":{"$ref":"#/components/schemas/ResultMessage"},"ExecutionDate":{"$ref":"#/components/schemas/TransactionExecutionDate"},"Type":{"$ref":"#/components/schemas/TransactionType"},"Nature":{"$ref":"#/components/schemas/TransactionNature"},"CreditedWalletId":{"type":"string","description":"The unique identifier of the credited wallet."},"CreditedUserId":{"$ref":"#/components/schemas/CreditedUserId"},"FlowDescriptor":{"$ref":"#/components/schemas/FlowDescriptorResponse"},"PaymentType":{"type":"string","description":"**Returned values:** `BIZUM`\n\nThe payment type of the pay-in."},"ExecutionType":{"type":"string","description":"**Returned values:** `WEB`\n\nThe execution type of the pay-in."},"Phone":{"type":"string","description":"Format: International E.164 standard (preceded by plus sign and country code, `+34` in Spain); pattern: `^(\\\\+?34)?[6-9][0-9]{8}$`\n\nThe phone number of the end user to which the Bizum push notification is sent to authenticate the transaction.\n\nOn Bizum, if the `Phone` parameter is sent, then `RedirectURL` is not returned and `ReturnURL` not required."},"ReturnURL":{"$ref":"#/components/schemas/ReturnURL_255"},"RedirectURL":{"type":"string","description":"The URL to which to redirect the user to complete the payment.\n\n**Caution:** This variable URL is specific to each payment. You must rely on the returned URL in full (host, path, and queries) and not hardcode any part of it."},"StatementDescriptor":{"$ref":"#/components/schemas/StatementDescriptor"}},"description":"A Bizum pay-in:\n- `PaymentType` – `BIZUM`\n- `ExecutionType` – `WEB`","title":"BizumPayInResponse"},"Currency_PLN":{"type":"string","description":"**Allowed values:** `PLN`\n\nThe currency of the amount.","title":"Currency_PLN"},"BlikPayInResponseDebitedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency_PLN"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the debited funds.","title":"BlikPayInResponseDebitedFunds"},"BlikPayInResponseCreditedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency_PLN"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the credited funds (`CreditedFunds` = `DebitedFunds` - `Fees`).","title":"BlikPayInResponseCreditedFunds"},"BlikPayInResponseFees":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency_PLN"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the fees.","title":"BlikPayInResponseFees"},"BlikPayInResponseBrowserInfo":{"type":"object","properties":{"UserAgent":{"type":"string","description":"The exact content of the HTTP User-Agent header."},"JavascriptEnabled":{"type":"boolean","description":"Whether or not the end user's browser has the ability to execute JavaScript."}},"description":"Information about the browser used by the end user (author) to perform the payment.","title":"BlikPayInResponseBrowserInfo"},"BLIKPayInResponse":{"type":"object","properties":{"Id":{"$ref":"#/components/schemas/Id"},"Tag":{"$ref":"#/components/schemas/Tag"},"CreationDate":{"$ref":"#/components/schemas/CreationDate"},"AuthorId":{"$ref":"#/components/schemas/AuthorId"},"FlowDescriptor":{"$ref":"#/components/schemas/FlowDescriptorResponse"},"DebitedFunds":{"$ref":"#/components/schemas/BlikPayInResponseDebitedFunds","description":"Information about the debited funds."},"CreditedFunds":{"$ref":"#/components/schemas/BlikPayInResponseCreditedFunds","description":"Information about the credited funds (`CreditedFunds` = `DebitedFunds` - `Fees`)."},"Fees":{"$ref":"#/components/schemas/BlikPayInResponseFees","description":"Information about the fees."},"Status":{"$ref":"#/components/schemas/TransactionStatus"},"ResultCode":{"$ref":"#/components/schemas/ResultCode"},"ResultMessage":{"$ref":"#/components/schemas/ResultMessage"},"ExecutionDate":{"$ref":"#/components/schemas/TransactionExecutionDate"},"Type":{"$ref":"#/components/schemas/TransactionType"},"Nature":{"$ref":"#/components/schemas/TransactionNature"},"CreditedWalletId":{"type":"string","description":"The unique identifier of the credited wallet."},"PaymentType":{"type":"string","description":"**Returned values:** `BLIK`\n\nThe payment type of the pay-in."},"ExecutionType":{"type":"string","description":"**Returned values:** `WEB`\n\nThe execution type of the pay-in."},"ReturnURL":{"$ref":"#/components/schemas/ReturnURL_255"},"RedirectURL":{"type":"string","description":"The URL to which to redirect the user to complete the payment.\n\n**Caution:** This variable URL is specific to each payment. You must rely on the returned URL in full (host, path, and queries) and not hardcode any part of it."},"StatementDescriptor":{"$ref":"#/components/schemas/StatementDescriptor"},"Code":{"type":["string","null"],"description":"The 6-digit code sent in the request (otherwise returned `null`)."},"BrowserInfo":{"oneOf":[{"$ref":"#/components/schemas/BlikPayInResponseBrowserInfo"},{"type":"null"}],"description":"Information about the browser used by the end user (author) to perform the payment."},"IpAddress":{"type":["string","null"],"description":"The IP address of the end user initiating the transaction, in IPV4 or IPV6 format."}},"description":"A BLIK pay-in:\n- `PaymentType` – `BLIK`\n- `ExecutionType` – `WEB`","title":"BLIKPayInResponse"},"DeprecatedGiropayPayInResponseDebitedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the debited funds.","title":"DeprecatedGiropayPayInResponseDebitedFunds"},"DeprecatedGiropayPayInResponseCreditedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the credited funds (`CreditedFunds` = `DebitedFunds` - `Fees`).","title":"DeprecatedGiropayPayInResponseCreditedFunds"},"DeprecatedGiropayPayInResponseFees":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the fees.","title":"DeprecatedGiropayPayInResponseFees"},"DeprecatedGiropayPayInResponse":{"type":"object","properties":{"Id":{"$ref":"#/components/schemas/Id"},"Tag":{"$ref":"#/components/schemas/Tag"},"CreationDate":{"$ref":"#/components/schemas/CreationDate"},"AuthorId":{"$ref":"#/components/schemas/AuthorId"},"DebitedFunds":{"$ref":"#/components/schemas/DeprecatedGiropayPayInResponseDebitedFunds","description":"Information about the debited funds."},"CreditedFunds":{"$ref":"#/components/schemas/DeprecatedGiropayPayInResponseCreditedFunds","description":"Information about the credited funds (`CreditedFunds` = `DebitedFunds` - `Fees`)."},"Fees":{"$ref":"#/components/schemas/DeprecatedGiropayPayInResponseFees","description":"Information about the fees."},"Status":{"$ref":"#/components/schemas/TransactionStatus"},"ResultCode":{"$ref":"#/components/schemas/ResultCode"},"ResultMessage":{"$ref":"#/components/schemas/ResultMessage"},"ExecutionDate":{"$ref":"#/components/schemas/TransactionExecutionDate"},"Type":{"$ref":"#/components/schemas/TransactionType"},"Nature":{"$ref":"#/components/schemas/TransactionNature"},"CreditedWalletId":{"type":"string","description":"The unique identifier of the credited wallet."},"CreditedUserId":{"$ref":"#/components/schemas/CreditedUserId"},"PaymentType":{"type":"string","description":"**Returned values:** `GIROPAY`\n\nThe payment type of the pay-in."},"ExecutionType":{"type":"string","description":"**Returned values:** `WEB`\n\nThe execution type of the pay-in."},"ReturnURL":{"$ref":"#/components/schemas/ReturnURL_255"},"StatementDescriptor":{"$ref":"#/components/schemas/StatementDescriptor"}},"description":"A Giropay pay-in:\n- `PaymentType` – `GIROPAY`\n- `ExecutionType` – `WEB`","title":"DeprecatedGiropayPayInResponse"},"IdealPayInResponseDebitedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the debited funds.","title":"IdealPayInResponseDebitedFunds"},"IdealPayInResponseCreditedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the credited funds (`CreditedFunds` = `DebitedFunds` - `Fees`).","title":"IdealPayInResponseCreditedFunds"},"IdealPayInResponseFees":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the fees.","title":"IdealPayInResponseFees"},"IDEALPayInResponse":{"type":"object","properties":{"Id":{"$ref":"#/components/schemas/Id"},"Tag":{"$ref":"#/components/schemas/Tag"},"CreationDate":{"$ref":"#/components/schemas/CreationDate"},"AuthorId":{"$ref":"#/components/schemas/AuthorId"},"DebitedFunds":{"$ref":"#/components/schemas/IdealPayInResponseDebitedFunds","description":"Information about the debited funds."},"CreditedFunds":{"$ref":"#/components/schemas/IdealPayInResponseCreditedFunds","description":"Information about the credited funds (`CreditedFunds` = `DebitedFunds` - `Fees`)."},"Fees":{"$ref":"#/components/schemas/IdealPayInResponseFees","description":"Information about the fees."},"Status":{"$ref":"#/components/schemas/TransactionStatus"},"ResultCode":{"$ref":"#/components/schemas/ResultCode"},"ResultMessage":{"$ref":"#/components/schemas/ResultMessage"},"ExecutionDate":{"$ref":"#/components/schemas/TransactionExecutionDate"},"Type":{"$ref":"#/components/schemas/TransactionType"},"Nature":{"$ref":"#/components/schemas/TransactionNature"},"CreditedWalletId":{"type":"string","description":"The unique identifier of the credited wallet."},"CreditedUserId":{"$ref":"#/components/schemas/CreditedUserId"},"FlowDescriptor":{"$ref":"#/components/schemas/FlowDescriptorResponse"},"PaymentType":{"type":"string","description":"**Returned values:** `IDEAL`\n\nThe payment type of the pay-in."},"ExecutionType":{"type":"string","description":"**Returned values:** `WEB`\n\nThe execution type of the pay-in."},"ReturnURL":{"$ref":"#/components/schemas/ReturnURL_255"},"RedirectURL":{"type":"string","description":"The URL to which to redirect the user to complete the payment.\n\n**Caution:** This variable URL is specific to each payment. You must rely on the returned URL in full (host, path, and queries) and not hardcode any part of it."},"StatementDescriptor":{"$ref":"#/components/schemas/StatementDescriptor"},"BankName":{"type":"string","description":"**Returned values:** The <a href=\"/guides/payment-methods/ideal\">bank name</a> corresponding to the `Bic` sent, or `null` if no `Bic` sent.\n\nThe user's bank, as defined by the `Bic` parameter sent in the call."}},"description":"An iDEAL pay-in:\n- `PaymentType` – `IDEAL`\n- `ExecutionType` – `WEB`","title":"IDEALPayInResponse"},"KlarnaPayInResponseDebitedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the debited funds.","title":"KlarnaPayInResponseDebitedFunds"},"KlarnaPayInResponseCreditedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the credited funds (`CreditedFunds` = `DebitedFunds` - `Fees`).","title":"KlarnaPayInResponseCreditedFunds"},"KlarnaPayInResponseFees":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the fees.","title":"KlarnaPayInResponseFees"},"KlarnaPayInResponseLineItemsItems":{"type":"object","properties":{"Name":{"type":"string","description":"The name of the item."},"Quantity":{"type":"integer","description":"The quantity of the item."},"UnitAmount":{"type":"integer","description":"The cost of the item, excluding tax."},"TaxAmount":{"type":"integer","description":"The tax amount applied to the item."},"Sku":{"type":"string","description":"The unique identifier of the line item."},"Category":{"type":"string","description":"Possible values: `DIGITAL_GOODS`, `PHYSICAL_GOODS`, `DISCOUNT`, `SHIPPING_FEE`, `SALES_TAX`, `GIFT_CARD`, `STORE_CREDIT`, `SURCHARGE`\n\nThe category of the item, allowing line items of different types to be distinguished (for example, buyer protection as `DIGITAL_GOODS`)."},"Discount":{"type":"integer","description":"The discount applied to the item."}},"title":"KlarnaPayInResponseLineItemsItems"},"KlarnaPayInResponse":{"type":"object","properties":{"Id":{"$ref":"#/components/schemas/Id"},"Tag":{"$ref":"#/components/schemas/Tag"},"CreationDate":{"$ref":"#/components/schemas/CreationDate"},"AuthorId":{"$ref":"#/components/schemas/AuthorId"},"DebitedFunds":{"$ref":"#/components/schemas/KlarnaPayInResponseDebitedFunds","description":"Information about the debited funds."},"CreditedFunds":{"$ref":"#/components/schemas/KlarnaPayInResponseCreditedFunds","description":"Information about the credited funds (`CreditedFunds` = `DebitedFunds` - `Fees`)."},"Fees":{"$ref":"#/components/schemas/KlarnaPayInResponseFees","description":"Information about the fees."},"Status":{"$ref":"#/components/schemas/TransactionStatus"},"ResultCode":{"$ref":"#/components/schemas/ResultCode"},"ResultMessage":{"$ref":"#/components/schemas/ResultMessage"},"ExecutionDate":{"$ref":"#/components/schemas/TransactionExecutionDate"},"Type":{"$ref":"#/components/schemas/TransactionType"},"Nature":{"$ref":"#/components/schemas/TransactionNature"},"CreditedWalletId":{"type":"string","description":"The unique identifier of the credited wallet."},"CreditedUserId":{"$ref":"#/components/schemas/CreditedUserId"},"FlowDescriptor":{"$ref":"#/components/schemas/FlowDescriptorResponse"},"PaymentType":{"type":"string","description":"**Returned values:** `KLARNA`\n\nThe payment type of the pay-in."},"ExecutionType":{"type":"string","description":"**Returned values:** `WEB`\n\nThe execution type of the pay-in."},"ReturnURL":{"$ref":"#/components/schemas/ReturnURL_255"},"RedirectURL":{"type":"string","description":"The URL to which to redirect the user to complete the payment.\n\n**Caution:** This variable URL is specific to each payment. You must rely on the returned URL in full (host, path, and queries) and not hardcode any part of it."},"StatementDescriptor":{"$ref":"#/components/schemas/StatementDescriptor"},"Billing":{"$ref":"#/components/schemas/Billing_DefaultsShippingUser_Response"},"Shipping":{"$ref":"#/components/schemas/Shipping_DefaultsBillingUser_Response"},"LineItems":{"type":"array","items":{"$ref":"#/components/schemas/KlarnaPayInResponseLineItemsItems"},"description":"Information about the items purchased in the transaction. The pay-in `DebitedFunds.Amount` must equal all `LineItems` objects' ((`UnitAmount` + `TaxAmount`) - `Discount`)."},"Country":{"type":"string","description":"Format: Two-letter country code ([ISO 3166-1 alpha-2 format](/api-reference/overview/data-formats))\n\nThe country of residence of the user."},"Culture":{"type":"string","description":"Format: Two-letter language code ([ISO 639-1 alpha-2](/api-reference/overview/data-formats))\n\nThe language in which the Klarna payment page is to be displayed. The `Culture` must match the `Country` to show the checkout page in the desired language. If not, or if `Culture` is not sent, EN is the language by default."},"Email":{"type":"string","description":"Format: A valid email address\n\nThe user's email address."},"Phone":{"type":"string","description":"Format: International E.164 standard (preceded by plus sign and country code)\n\nThe user's mobile phone number. If the phone matches the user's Klarna account, their checkout experience involves one less step."},"PaymentMethod":{"type":"string","description":"The payment option chosen by the user:\n- Pay Now (Card) – Pay now by card.\n- Pay Now (Direct Bank Transfer) – Pay now by bank wire.\n- Pay Now (Direct Debit) – Pay now by direct debit.\n- Pay Now (Klarna Bank Account) – Pay now from Klarna Bank Account (select regions only, e.g. Germany).\n- Pay in 30 days (by card) – Pay within 30 days by card.\n- Pay in 30 days – Pay within 30 days against an invoice (select regions only, e.g. Germany).\n- Slice it (3 installments) – Pay in 3 installments.\n- Slice it (Financing - X installments) – Pay via financing plan, where X is the number of monthly installments (6, 12, 24, or 36).\n\nThe options available to users depend on their region.\n\n**Note:** This parameter is not returned unless the `Status` is `SUCCEEDED`."},"AdditionalData":{"type":"string","description":"Format: Serialized JSON object\n\nThe extra merchant data required by Klarna for the transaction, as described in the <a href=\"https://mangopay.com/docs/concepts/payments/payment-methods/klarna\" target=\"_blank\">Klarna</a> guide."},"Reference":{"type":"string","description":"The platform's order reference for the transaction."}},"description":"A Klarna pay-in:\n- `PaymentType` – `KLARNA`\n- `ExecutionType` – `WEB`","title":"KlarnaPayInResponse"},"MbwayPayInResponseDebitedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the debited funds.","title":"MbwayPayInResponseDebitedFunds"},"MbwayPayInResponseCreditedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the credited funds (`CreditedFunds` = `DebitedFunds` - `Fees`).","title":"MbwayPayInResponseCreditedFunds"},"MbwayPayInResponseFees":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the fees.","title":"MbwayPayInResponseFees"},"MBWAYPayInResponse":{"type":"object","properties":{"Id":{"$ref":"#/components/schemas/Id"},"Tag":{"$ref":"#/components/schemas/Tag"},"CreationDate":{"$ref":"#/components/schemas/CreationDate"},"AuthorId":{"$ref":"#/components/schemas/AuthorId"},"DebitedFunds":{"$ref":"#/components/schemas/MbwayPayInResponseDebitedFunds","description":"Information about the debited funds."},"CreditedFunds":{"$ref":"#/components/schemas/MbwayPayInResponseCreditedFunds","description":"Information about the credited funds (`CreditedFunds` = `DebitedFunds` - `Fees`)."},"Fees":{"$ref":"#/components/schemas/MbwayPayInResponseFees","description":"Information about the fees."},"Status":{"$ref":"#/components/schemas/TransactionStatus"},"ResultCode":{"$ref":"#/components/schemas/ResultCode"},"ResultMessage":{"$ref":"#/components/schemas/ResultMessage"},"ExecutionDate":{"$ref":"#/components/schemas/TransactionExecutionDate"},"Type":{"$ref":"#/components/schemas/TransactionType"},"Nature":{"$ref":"#/components/schemas/TransactionNature"},"CreditedWalletId":{"type":"string","description":"The unique identifier of the credited wallet."},"CreditedUserId":{"$ref":"#/components/schemas/CreditedUserId"},"FlowDescriptor":{"$ref":"#/components/schemas/FlowDescriptorResponse"},"PaymentType":{"type":"string","description":"**Returned values:** `MBWAY`\n\nThe payment type of the pay-in."},"ExecutionType":{"type":"string","description":"**Returned values:** `WEB`\n\nThe execution type of the pay-in."},"StatementDescriptor":{"$ref":"#/components/schemas/StatementDescriptor"},"Phone":{"type":"string","description":"Format: Country code without plus symbol, followed by hash symbol (#), followed by the number; only numeric characters and hash symbol\n\nThe phone number of the end user to which the MB WAY push notification is sent to authenticate the transaction."}},"description":"An MB WAY pay-in:\n- `PaymentType` – `MBWAY`\n- `ExecutionType` – `WEB`","title":"MBWAYPayInResponse"},"MultibancoPayInResponseDebitedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the debited funds.","title":"MultibancoPayInResponseDebitedFunds"},"MultibancoPayInResponseCreditedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the credited funds (`CreditedFunds` = `DebitedFunds` - `Fees`).","title":"MultibancoPayInResponseCreditedFunds"},"MultibancoPayInResponseFees":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the fees.","title":"MultibancoPayInResponseFees"},"MultibancoPayInResponse":{"type":"object","properties":{"Id":{"$ref":"#/components/schemas/Id"},"Tag":{"$ref":"#/components/schemas/Tag"},"CreationDate":{"$ref":"#/components/schemas/CreationDate"},"AuthorId":{"$ref":"#/components/schemas/AuthorId"},"DebitedFunds":{"$ref":"#/components/schemas/MultibancoPayInResponseDebitedFunds","description":"Information about the debited funds."},"CreditedFunds":{"$ref":"#/components/schemas/MultibancoPayInResponseCreditedFunds","description":"Information about the credited funds (`CreditedFunds` = `DebitedFunds` - `Fees`)."},"Fees":{"$ref":"#/components/schemas/MultibancoPayInResponseFees","description":"Information about the fees."},"Status":{"$ref":"#/components/schemas/TransactionStatus"},"ResultCode":{"$ref":"#/components/schemas/ResultCode"},"ResultMessage":{"$ref":"#/components/schemas/ResultMessage"},"ExecutionDate":{"$ref":"#/components/schemas/TransactionExecutionDate"},"Type":{"$ref":"#/components/schemas/TransactionType"},"Nature":{"$ref":"#/components/schemas/TransactionNature"},"CreditedWalletId":{"type":"string","description":"The unique identifier of the credited wallet."},"CreditedUserId":{"$ref":"#/components/schemas/CreditedUserId"},"FlowDescriptor":{"$ref":"#/components/schemas/FlowDescriptorResponse"},"PaymentType":{"type":"string","description":"**Returned values:** `MULTIBANCO`\n\nThe payment type of the pay-in."},"ExecutionType":{"type":"string","description":"**Returned values:** `WEB`\n\nThe execution type of the pay-in."},"ReturnURL":{"type":"string","description":"Max. length: 255 characters\n\nThe URL to which the user is automatically returned after indicating that they have noted their Multibanco payment reference."},"RedirectURL":{"type":"string","description":"The URL to which to redirect the user to obtain their Multibanco payment reference.\n\n**Caution:** This variable URL is specific to each payment. You must rely on the returned URL in full (host, path, and queries) and not hardcode any part of it."},"StatementDescriptor":{"$ref":"#/components/schemas/StatementDescriptor"}},"description":"A Multibanco pay-in:\n- `PaymentType` – `MULTIBANCO`\n- `ExecutionType` – `WEB`","title":"MultibancoPayInResponse"},"PayconiqPayInResponseDebitedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the debited funds.","title":"PayconiqPayInResponseDebitedFunds"},"PayconiqPayInResponseCreditedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the credited funds (`CreditedFunds` = `DebitedFunds` - `Fees`).","title":"PayconiqPayInResponseCreditedFunds"},"PayconiqPayInResponseFees":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the fees.","title":"PayconiqPayInResponseFees"},"PayconiqPayInResponse":{"type":"object","properties":{"Id":{"$ref":"#/components/schemas/Id"},"Tag":{"$ref":"#/components/schemas/Tag"},"CreationDate":{"$ref":"#/components/schemas/CreationDate"},"AuthorId":{"$ref":"#/components/schemas/AuthorId"},"DebitedFunds":{"$ref":"#/components/schemas/PayconiqPayInResponseDebitedFunds","description":"Information about the debited funds."},"CreditedFunds":{"$ref":"#/components/schemas/PayconiqPayInResponseCreditedFunds","description":"Information about the credited funds (`CreditedFunds` = `DebitedFunds` - `Fees`)."},"Fees":{"$ref":"#/components/schemas/PayconiqPayInResponseFees","description":"Information about the fees."},"Status":{"$ref":"#/components/schemas/TransactionStatus"},"ResultCode":{"$ref":"#/components/schemas/ResultCode"},"ResultMessage":{"$ref":"#/components/schemas/ResultMessage"},"ExecutionDate":{"$ref":"#/components/schemas/TransactionExecutionDate"},"Type":{"$ref":"#/components/schemas/TransactionType"},"Nature":{"$ref":"#/components/schemas/TransactionNature"},"CreditedWalletId":{"type":"string","description":"The unique identifier of the credited wallet."},"CreditedUserId":{"$ref":"#/components/schemas/CreditedUserId"},"FlowDescriptor":{"$ref":"#/components/schemas/FlowDescriptorResponse"},"PaymentType":{"type":"string","description":"**Returned values:** `PAYCONIQ`\n\nThe payment type of the pay-in."},"ExecutionType":{"type":"string","description":"**Returned values:** `WEB`\n\nThe execution type of the pay-in."},"ReturnURL":{"$ref":"#/components/schemas/ReturnURL_255"},"RedirectURL":{"type":"string","description":"The URL to which to redirect the user to complete the payment on a hosted page showing the QR code and Payconiq by Bancontact branding and instructions.\n\n**Note:** In Sandbox, this value redirects to Mangopay's web-based simulator.\n\n**Caution:** This variable URL is specific to each payment. You must rely on the returned URL in full (host, path, and queries) and not hardcode any part of it."},"StatementDescriptor":{"$ref":"#/components/schemas/StatementDescriptor"},"Country":{"type":"string","description":"**Returned values:** BE, LU\n\nThe country of residence of the user."},"DeepLinkURL":{"type":"string","description":"The mobile URL to which to redirect the user to complete the payment in an app-to-app flow.\n\n**Note:** In Sandbox, this value is a placeholder: the `RedirectURL` must be used to complete the payment using Mangopay's web-based simulator."},"QRCodeURL":{"type":"string","description":"The URL of a page containing only the QR code which you can use in your payment experience.\n\nYou can lightly customize the QR code's format, size, and color by adding query parameters to the `QRCodeURL` before redirecting the user. See the <a href=\"/guides/payment-methods/payconiq\">Payconiq guide</a> for details.\n\n**Note:** In Sandbox, this value is a placeholder. The `RedirectURL` must be used to complete the payment using Mangopay's web-based simulator."}},"description":"A Payconiq pay-in:\n- `PaymentType` – `PAYCONIQ`\n- `ExecutionType` – `WEB`","title":"PayconiqPayInResponse"},"SatispayPayInResponseDebitedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the debited funds.","title":"SatispayPayInResponseDebitedFunds"},"SatispayPayInResponseCreditedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the credited funds (`CreditedFunds` = `DebitedFunds` - `Fees`).","title":"SatispayPayInResponseCreditedFunds"},"SatispayPayInResponseFees":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the fees.","title":"SatispayPayInResponseFees"},"SatispayPayInResponse":{"type":"object","properties":{"Id":{"$ref":"#/components/schemas/Id"},"Tag":{"$ref":"#/components/schemas/Tag"},"CreationDate":{"$ref":"#/components/schemas/CreationDate"},"AuthorId":{"$ref":"#/components/schemas/AuthorId"},"DebitedFunds":{"$ref":"#/components/schemas/SatispayPayInResponseDebitedFunds","description":"Information about the debited funds."},"CreditedFunds":{"$ref":"#/components/schemas/SatispayPayInResponseCreditedFunds","description":"Information about the credited funds (`CreditedFunds` = `DebitedFunds` - `Fees`)."},"Fees":{"$ref":"#/components/schemas/SatispayPayInResponseFees","description":"Information about the fees."},"Status":{"$ref":"#/components/schemas/TransactionStatus"},"ResultCode":{"$ref":"#/components/schemas/ResultCode"},"ResultMessage":{"$ref":"#/components/schemas/ResultMessage"},"ExecutionDate":{"$ref":"#/components/schemas/TransactionExecutionDate"},"Type":{"$ref":"#/components/schemas/TransactionType"},"Nature":{"$ref":"#/components/schemas/TransactionNature"},"CreditedWalletId":{"type":"string","description":"The unique identifier of the credited wallet."},"CreditedUserId":{"$ref":"#/components/schemas/CreditedUserId"},"FlowDescriptor":{"$ref":"#/components/schemas/FlowDescriptorResponse"},"PaymentType":{"type":"string","description":"**Returned values:** `SATISPAY`\n\nThe payment type of the pay-in."},"ExecutionType":{"type":"string","description":"**Returned values:** `WEB`\n\nThe execution type of the pay-in."},"ReturnURL":{"$ref":"#/components/schemas/ReturnURL_255"},"StatementDescriptor":{"$ref":"#/components/schemas/StatementDescriptor"},"Country":{"type":"string","description":"Format: Two-letter country code ([ISO 3166-1 alpha-2 format](/api-reference/overview/data-formats))\n\nThe country of residence of the user, which can be those of the EEA plus CH, GB, and TR."}},"description":"A Satispay pay-in:\n- `PaymentType` – `SATISPAY`\n- `ExecutionType` – `WEB`","title":"SatispayPayInResponse"},"Currency_SEK":{"type":"string","description":"**Allowed values:** `SEK`\n\nThe currency of the amount.","title":"Currency_SEK"},"SwishPayInResponseDebitedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency_SEK"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the debited funds.","title":"SwishPayInResponseDebitedFunds"},"SwishPayInResponseCreditedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency_SEK"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the credited funds (`CreditedFunds` = `DebitedFunds` - `Fees`).","title":"SwishPayInResponseCreditedFunds"},"SwishPayInResponseFees":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency_SEK"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the fees.","title":"SwishPayInResponseFees"},"SwishPayInResponse":{"type":"object","properties":{"Id":{"$ref":"#/components/schemas/Id"},"Tag":{"$ref":"#/components/schemas/Tag"},"CreationDate":{"$ref":"#/components/schemas/CreationDate"},"AuthorId":{"$ref":"#/components/schemas/AuthorId"},"DebitedFunds":{"$ref":"#/components/schemas/SwishPayInResponseDebitedFunds","description":"Information about the debited funds."},"CreditedFunds":{"$ref":"#/components/schemas/SwishPayInResponseCreditedFunds","description":"Information about the credited funds (`CreditedFunds` = `DebitedFunds` - `Fees`)."},"Fees":{"$ref":"#/components/schemas/SwishPayInResponseFees","description":"Information about the fees."},"Status":{"$ref":"#/components/schemas/TransactionStatus"},"ResultCode":{"$ref":"#/components/schemas/ResultCode"},"ResultMessage":{"$ref":"#/components/schemas/ResultMessage"},"ExecutionDate":{"$ref":"#/components/schemas/TransactionExecutionDate"},"Type":{"$ref":"#/components/schemas/TransactionType"},"Nature":{"$ref":"#/components/schemas/TransactionNature"},"CreditedWalletId":{"type":"string","description":"The unique identifier of the credited wallet."},"CreditedUserId":{"$ref":"#/components/schemas/CreditedUserId"},"FlowDescriptor":{"$ref":"#/components/schemas/FlowDescriptorResponse"},"PaymentType":{"type":"string","description":"**Returned values:** `SWISH`\n\nThe payment type of the pay-in."},"ExecutionType":{"type":"string","description":"**Returned values:** `WEB`\n\nThe execution type of the pay-in."},"ReturnURL":{"$ref":"#/components/schemas/ReturnURL_255"},"RedirectURL":{"type":"string","description":"The URL to which to redirect the user to complete the payment.\n\n**Caution:** This variable URL is specific to each payment. You must rely on the returned URL in full (host, path, and queries) and not hardcode any part of it."},"DeepLinkURL":{"type":"string","description":"The mobile URL to which to redirect the user to complete the payment in an app-to-app flow.\n\n**Note:** In Sandbox, this parameter is not returned: the `RedirectURL` must be used to complete the payment using Mangopay's web-based simulator."},"QRCodeURL":{"type":"string","description":"The PNG file of the Swish QR code as a Base64-encoded string.\n\n**Note:** In Sandbox, this parameter is not returned. The `RedirectURL` must be used to complete the payment using Mangopay's web-based simulator."},"StatementDescriptor":{"$ref":"#/components/schemas/StatementDescriptor"},"PaymentFlow":{"type":"string","description":"**Allowed values:** `WEB`, `APP`\n\n**Default value:** `WEB`\n\nThe platform environment of the post-payment flow. The `PaymentFlow` value combines with the `ReturnURL` to manage the redirection behavior after payment:\n- Set the value to `APP` to send the user to your platform's mobile app\n- Set the value to `WEB` to send the user to a web browser\n\nIn both cases you need to provide the relevant `ReturnURL`, whether to your app or website."}},"description":"A Swish pay-in:\n- `PaymentType` – `SWISH`\n- `ExecutionType` – `WEB`","title":"SwishPayInResponse"},"Currency_CHF":{"type":"string","description":"**Allowed values:** `CHF`\n\nThe currency of the amount.","title":"Currency_CHF"},"TwintPayInResponseDebitedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency_CHF"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the debited funds.","title":"TwintPayInResponseDebitedFunds"},"TwintPayInResponseCreditedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency_CHF"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the credited funds (`CreditedFunds` = `DebitedFunds` - `Fees`).","title":"TwintPayInResponseCreditedFunds"},"TwintPayInResponseFees":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency_CHF"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the fees taken by the platform for this transaction (and hence transferred to the Fees Wallet).","title":"TwintPayInResponseFees"},"TwintPayInResponse":{"type":"object","properties":{"Id":{"$ref":"#/components/schemas/Id"},"Tag":{"$ref":"#/components/schemas/Tag"},"CreationDate":{"$ref":"#/components/schemas/CreationDate"},"AuthorId":{"$ref":"#/components/schemas/AuthorId"},"CreditedUserId":{"$ref":"#/components/schemas/CreditedUserId"},"FlowDescriptor":{"$ref":"#/components/schemas/FlowDescriptorResponse"},"DebitedFunds":{"$ref":"#/components/schemas/TwintPayInResponseDebitedFunds","description":"Information about the debited funds."},"CreditedFunds":{"$ref":"#/components/schemas/TwintPayInResponseCreditedFunds","description":"Information about the credited funds (`CreditedFunds` = `DebitedFunds` - `Fees`)."},"Fees":{"$ref":"#/components/schemas/TwintPayInResponseFees","description":"Information about the fees taken by the platform for this transaction (and hence transferred to the Fees Wallet)."},"Status":{"$ref":"#/components/schemas/TransactionStatus"},"ResultCode":{"$ref":"#/components/schemas/ResultCode"},"ResultMessage":{"$ref":"#/components/schemas/ResultMessage"},"ExecutionDate":{"$ref":"#/components/schemas/TransactionExecutionDate"},"Type":{"$ref":"#/components/schemas/TransactionType"},"Nature":{"$ref":"#/components/schemas/TransactionNature"},"CreditedWalletId":{"type":"string","description":"The unique identifier of the credited wallet."},"PaymentType":{"type":"string","description":"**Returned values:** `TWINT`\n\nThe payment type of the pay-in."},"ExecutionType":{"type":"string","description":"**Returned values:** `WEB`\n\nThe execution type of the pay-in."},"ReturnURL":{"$ref":"#/components/schemas/ReturnURL_255"},"RedirectURL":{"type":"string","description":"The URL to which to redirect the user to complete the payment.\n\n**Caution:** This variable URL is specific to each payment. You must rely on the returned URL in full (host, path, and queries) and not hardcode any part of it."},"StatementDescriptor":{"$ref":"#/components/schemas/StatementDescriptor"}},"description":"A TWINT pay-in:\n- `PaymentType` – `TWINT`\n- `ExecutionType` – `WEB`","title":"TwintPayInResponse"},"DirectDebitPayInResponseCreditedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the credited funds (`CreditedFunds` = `DebitedFunds` - `Fees`).","title":"DirectDebitPayInResponseCreditedFunds"},"DirectDebitPayInResponseDebitedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the debited funds.","title":"DirectDebitPayInResponseDebitedFunds"},"DirectDebitPayInResponseFees":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the fees.","title":"DirectDebitPayInResponseFees"},"StatementDescriptor_DD":{"type":"string","description":"Max. length: SEPA: 100 characters, BACS: truncated after 10 characters; only alphanumeric and spaces\n\nCustom description to appear on the user's bank statement along with the platform name. \n\nDifferent banks may show more or less information. See the <a href=\"/bank-statements\">Customizing bank statement references</a> article for details. \n\n**Note:** On BACS Direct Debit pay-ins, the length is truncated at 10 alphanumeric characters or spaces, but the technical limit is 100.","title":"StatementDescriptor_DD"},"DirectDebitPayInResponse":{"type":"object","properties":{"Id":{"$ref":"#/components/schemas/Id"},"CreationDate":{"$ref":"#/components/schemas/CreationDate"},"AuthorId":{"$ref":"#/components/schemas/AuthorId"},"CreditedUserId":{"$ref":"#/components/schemas/CreditedUserId"},"FlowDescriptor":{"$ref":"#/components/schemas/FlowDescriptorResponse"},"Status":{"$ref":"#/components/schemas/TransactionStatus"},"ExecutionDate":{"$ref":"#/components/schemas/TransactionExecutionDate"},"ChargeDate":{"type":"integer","description":"The date used to notify the user of the future charge, set at midnight (00:00) on the given day. The user's account is usually debited the following day, but it depends on their bank. For more information on direct debit processing times, see the <a href=\"/guides/payment-methods/banking/direct-debit\">direct debit</a> guide."},"Type":{"$ref":"#/components/schemas/TransactionType"},"Nature":{"$ref":"#/components/schemas/TransactionNature"},"CreditedWalletId":{"type":"string","description":"The unique identifier of the credited wallet."},"DebitedWalletId":{"type":"string","description":"The unique identifier of the debited wallet.\n\nIn the case of a pay-in, this value is always `null` since there is no debited wallet."},"CreditedFunds":{"$ref":"#/components/schemas/DirectDebitPayInResponseCreditedFunds","description":"Information about the credited funds (`CreditedFunds` = `DebitedFunds` - `Fees`)."},"DebitedFunds":{"$ref":"#/components/schemas/DirectDebitPayInResponseDebitedFunds","description":"Information about the debited funds."},"Fees":{"$ref":"#/components/schemas/DirectDebitPayInResponseFees","description":"Information about the fees."},"ResultCode":{"$ref":"#/components/schemas/ResultCode"},"ResultMessage":{"$ref":"#/components/schemas/ResultMessage"},"PaymentType":{"type":"string","description":"**Returned values:** `DIRECT_DEBIT`\n\nThe payment type of the pay-in."},"ExecutionType":{"type":"string","description":"**Returned values:** `DIRECT`\n\nThe execution type of the pay-in."},"Tag":{"$ref":"#/components/schemas/Tag"},"MandateId":{"type":"string","description":"The unique identifier of the mandate."},"StatementDescriptor":{"$ref":"#/components/schemas/StatementDescriptor_DD"}},"description":"A direct debit pay-in:\n- `PaymentType` – `DIRECT_DEBIT`\n- `ExecutionType` – `DIRECT`\n\nThe scheme, SDD or Bacs, is determined by the mandate.","title":"DirectDebitPayInResponse"},"DeprecatedWebDirectDebitPayInResponseDebitedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the debited funds.","title":"DeprecatedWebDirectDebitPayInResponseDebitedFunds"},"DeprecatedWebDirectDebitPayInResponseCreditedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the credited funds (`CreditedFunds` = `DebitedFunds` - `Fees`).","title":"DeprecatedWebDirectDebitPayInResponseCreditedFunds"},"DeprecatedWebDirectDebitPayInResponseFees":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the fees.","title":"DeprecatedWebDirectDebitPayInResponseFees"},"DeprecatedWebDirectDebitPayInResponse":{"type":"object","properties":{"DirectDebitType":{"type":"string","description":"**Returned values:** `GIROPAY`, `SOFORT`\n\nThe type of direct debit."},"Id":{"$ref":"#/components/schemas/Id"},"Tag":{"$ref":"#/components/schemas/Tag"},"CreationDate":{"$ref":"#/components/schemas/CreationDate"},"ResultCode":{"$ref":"#/components/schemas/ResultCode"},"ResultMessage":{"$ref":"#/components/schemas/ResultMessage"},"AuthorId":{"$ref":"#/components/schemas/AuthorId"},"CreditedUserId":{"$ref":"#/components/schemas/CreditedUserId"},"FlowDescriptor":{"$ref":"#/components/schemas/FlowDescriptorResponse"},"DebitedFunds":{"$ref":"#/components/schemas/DeprecatedWebDirectDebitPayInResponseDebitedFunds","description":"Information about the debited funds."},"CreditedFunds":{"$ref":"#/components/schemas/DeprecatedWebDirectDebitPayInResponseCreditedFunds","description":"Information about the credited funds (`CreditedFunds` = `DebitedFunds` - `Fees`)."},"Fees":{"$ref":"#/components/schemas/DeprecatedWebDirectDebitPayInResponseFees","description":"Information about the fees."},"Status":{"$ref":"#/components/schemas/TransactionStatus"},"ExecutionDate":{"$ref":"#/components/schemas/TransactionExecutionDate"},"Type":{"$ref":"#/components/schemas/TransactionType"},"Nature":{"$ref":"#/components/schemas/TransactionNature"},"CreditedWalletId":{"type":"string","description":"The unique identifier of the credited wallet."},"DebitedWalletId":{"type":"string","description":"The unique identifier of the debited wallet.\n\nIn the case of a pay-in, this value is always `null` since there is no debited wallet."},"PaymentType":{"type":"string","description":"**Returned values:** `DIRECT_DEBIT`\n\nThe payment type of the pay-in."},"ExecutionType":{"type":"string","description":"**Returned values:** `WEB`\n\nThe execution type of the pay-in."},"RedirectURL":{"type":"string","description":"The URL to which to redirect the user to complete the payment.\n\n**Caution:** This variable URL is specific to each payment. You must rely on the returned URL in full (host, path, and queries) and not hardcode any part of it."},"ReturnURL":{"$ref":"#/components/schemas/ReturnURL_220"},"TemplateURL":{"type":"string","description":"**Caution:** This customization feature is deprecated and must no longer be used. You must redirect on the `RedirectURL` instead.\n\nThe customized URL to which to redirect the user to complete the payment."},"Culture":{"type":"string","description":"**Returned values:** One of the supported languages in the [ISO 639-1 format](/api-reference/overview/data-formats): CS, DA, DE, EL, EN, ES, FI, FR, HU, IT, NL, NO, PL, PT, SK, SV.\n\nThe language in which the payment page is to be displayed."}},"description":"A web direct debit pay-in:\n- `PaymentType` – `DIRECT_DEBIT`\n- `ExecutionType` – `WEB`","title":"DeprecatedWebDirectDebitPayInResponse"},"ViewAPayInResponse":{"oneOf":[{"$ref":"#/components/schemas/DirectCardPayInResponse"},{"$ref":"#/components/schemas/RecurringCardPayInResponse"},{"$ref":"#/components/schemas/PreauthorizedPayInResponse"},{"$ref":"#/components/schemas/DepositPreauthorizedPayInResponse"},{"$ref":"#/components/schemas/WebCardPayInResponse"},{"$ref":"#/components/schemas/ApplePayPayInResponse"},{"$ref":"#/components/schemas/RecurringApplePayPayInResponse"},{"$ref":"#/components/schemas/GooglePayPayInResponse"},{"$ref":"#/components/schemas/RecurringGooglePayPayInResponse"},{"$ref":"#/components/schemas/PayPalPayInResponse"},{"$ref":"#/components/schemas/RecurringPayPalPayInResponse"},{"$ref":"#/components/schemas/BankWirePayInResponse"},{"$ref":"#/components/schemas/ExternalInstructionPayInResponse"},{"$ref":"#/components/schemas/PayByBankPayInResponse"},{"$ref":"#/components/schemas/BancontactPayInResponse"},{"$ref":"#/components/schemas/BizumPayInResponse"},{"$ref":"#/components/schemas/BLIKPayInResponse"},{"$ref":"#/components/schemas/DeprecatedGiropayPayInResponse"},{"$ref":"#/components/schemas/IDEALPayInResponse"},{"$ref":"#/components/schemas/KlarnaPayInResponse"},{"$ref":"#/components/schemas/MBWAYPayInResponse"},{"$ref":"#/components/schemas/MultibancoPayInResponse"},{"$ref":"#/components/schemas/PayconiqPayInResponse"},{"$ref":"#/components/schemas/SatispayPayInResponse"},{"$ref":"#/components/schemas/SwishPayInResponse"},{"$ref":"#/components/schemas/TwintPayInResponse"},{"$ref":"#/components/schemas/DirectDebitPayInResponse"},{"$ref":"#/components/schemas/DeprecatedWebDirectDebitPayInResponse"}],"title":"ViewAPayInResponse"},"CreateADirectCardPayInRequestDebitedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"required":["Currency","Amount"],"description":"Information about the debited funds.","title":"CreateADirectCardPayInRequestDebitedFunds"},"CreateADirectCardPayInRequestFees":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"required":["Currency","Amount"],"description":"Information about the fees.","title":"CreateADirectCardPayInRequestFees"},"FlowDescriptorRequestBeneficiariesItems":{"type":"object","properties":{"UserId":{"type":"string","description":"The unique identifier of the Natural User or Legal User declared as a beneficiary of the pay-in."}},"title":"FlowDescriptorRequestBeneficiariesItems"},"FlowDescriptorRequest":{"type":"object","properties":{"Beneficiaries":{"type":["array","null"],"items":{"$ref":"#/components/schemas/FlowDescriptorRequestBeneficiariesItems"},"description":"Max. length: 5 items\n\nThe list of up to 5 Natural or Legal Users declared as beneficiaries of the pay-in and its subsequent transfers, who must all be KYC/KYB verified when the pay-in request is made. The pay-in also fails if the `Beneficiaries` array contains nulled objects or invalid `UserId` values."}},"description":"Information about the Owner beneficiaries targeted by the pay-in and its subsequent transfers, who must all be KYC/KYB verified when the pay-in request is made ([read more](/guides/payin-beneficiaries)).\n\nIf the `FlowDescriptor.Beneficiaries` is sent in the API request, then:\n- The transaction's `CreditedWalletId` holder is disregarded in KYC/KYB checks.\n- **ALL** `UserId` values in the array must be one of:\n  - `OWNER` whose `KYCLevel` is `REGULAR`\n  - `PLATFORM`\n  \nThe pay-in `Status` becomes `FAILED` with `ResultCode` [002951](/errors/codes/002951) if at least one `FlowDescriptor.Beneficiaries.UserId` is:\n- `PAYER`\n- `OWNER` whose `KYCLevel` is `LIGHT`\n\nIf the `FlowDescriptor.Beneficiaries` is not sent in the API request, then the `CreditedWalletId` holder is subject to KYC/KYB checks. This property is optional for backwards compatibility but is recommended for all pay-in flows, even when the `CreditedWalletId` holder is a `PAYER` or the same value as one of the `FlowDescriptor.Beneficiaries`. \n","title":"FlowDescriptorRequest"},"Billing_DefaultsShippingUser_Request":{"type":"object","properties":{"FirstName":{"type":"string","description":"The first name of the user."},"LastName":{"type":"string","description":"The last name of the user."},"Address":{"$ref":"#/components/schemas/Address_SubPropsRequired"}},"description":"**Default values:** `FirstName`, `LastName`, and `Address` information of the `Shipping` object if sent, otherwise of the `AuthorId` (if address values present).\n\nInformation about the billing address. ","title":"Billing_DefaultsShippingUser_Request"},"Shipping_DefaultsBillingUser_Request":{"type":"object","properties":{"FirstName":{"type":"string","description":"The first name of the user."},"LastName":{"type":"string","description":"The last name of the user."},"Address":{"$ref":"#/components/schemas/Address_SubPropsRequired"}},"description":"**Default values:** `FirstName`, `LastName`, and `Address` information of the `Billing` object if sent, otherwise of the `AuthorId` (if address values present).\n\nInformation about the shipping address. ","title":"Shipping_DefaultsBillingUser_Request"},"CreateADirectCardPayInRequest":{"type":"object","properties":{"Tag":{"$ref":"#/components/schemas/Tag"},"AuthorId":{"$ref":"#/components/schemas/AuthorId"},"CreditedUserId":{"$ref":"#/components/schemas/CreditedUserId"},"DebitedFunds":{"$ref":"#/components/schemas/CreateADirectCardPayInRequestDebitedFunds","description":"Information about the debited funds."},"Fees":{"$ref":"#/components/schemas/CreateADirectCardPayInRequestFees","description":"Information about the fees."},"CreditedWalletId":{"type":"string","description":"The unique identifier of the credited wallet."},"FlowDescriptor":{"$ref":"#/components/schemas/FlowDescriptorRequest"},"SecureMode":{"type":"string","description":"**Allowed values:** `DEFAULT`, `FORCE`, `NO_CHOICE`\n\n**Default value:** `DEFAULT`\n\nThe mode applied for the 3DS2 protocol for CB, Visa, and Mastercard. The options are:\n- `DEFAULT` – Requests an exemption to strong customer authentication (SCA), and thus a frictionless payment experience, if allowed by your Mangopay contract and accepted by the issuer.\n- `FORCE` – Requests SCA.\n- `NO_CHOICE` – Leaves the choice to the issuer whether to allow for a frictionless payment experience or to enforce SCA."},"CardId":{"type":"string","description":"The unique identifier of the Card object, obtained during the card registration process."},"SecureModeReturnURL":{"$ref":"#/components/schemas/SecureModeReturnURL"},"Culture":{"type":"string","description":"The language in which the payment page is to be displayed. This deprecated parameter defaults to `EN`."},"StatementDescriptor":{"$ref":"#/components/schemas/StatementDescriptor_22"},"BrowserInfo":{"$ref":"#/components/schemas/BrowserInfo"},"IpAddress":{"$ref":"#/components/schemas/IpAddress"},"Billing":{"$ref":"#/components/schemas/Billing_DefaultsShippingUser_Request"},"Shipping":{"$ref":"#/components/schemas/Shipping_DefaultsBillingUser_Request"},"PreferredCardNetwork":{"$ref":"#/components/schemas/PreferredCardNetwork"},"PaymentCategory":{"type":"string","description":"**Default value:** `ECommerce`\n**Allowed values:** `ECommerce`, `TelephoneOrder`\n\nThe channel through which the user provided their card details, used to indicate mail-order and telephone-order (MOTO) payments:\n- `ECommerce` – Payment received online.\n- `TelephoneOrder` – Payment received via mail order or telephone order (MOTO)."},"ProfilingAttemptReference":{"$ref":"#/components/schemas/ProfilingAttemptReference"}},"required":["AuthorId","DebitedFunds","Fees","CreditedWalletId","CardId","SecureModeReturnURL","BrowserInfo","IpAddress"],"title":"CreateADirectCardPayInRequest"},"CreateARecurringPayInRegistrationCardRequestFirstTransactionDebitedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"required":["Currency","Amount"],"description":"The amount of the first recurring pay-in. This value can be different from the `NextTransactionDebitedFunds``.","title":"CreateARecurringPayInRegistrationCardRequestFirstTransactionDebitedFunds"},"CreateARecurringPayInRegistrationCardRequestFirstTransactionFees":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"required":["Currency","Amount"],"description":"The fees of the first recurring pay-in. This amount can be different from the `NextTransactionDebitedFunds`.","title":"CreateARecurringPayInRegistrationCardRequestFirstTransactionFees"},"CreateARecurringPayInRegistrationCardRequestNextTransactionDebitedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"required":["Currency","Amount"],"description":"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.","title":"CreateARecurringPayInRegistrationCardRequestNextTransactionDebitedFunds"},"CreateARecurringPayInRegistrationCardRequestNextTransactionFees":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"required":["Currency","Amount"],"description":"The fees of the subsequent recurring pay-ins.","title":"CreateARecurringPayInRegistrationCardRequestNextTransactionFees"},"CreateARecurringPayInRegistrationCardRequest":{"type":"object","properties":{"AuthorId":{"$ref":"#/components/schemas/AuthorId"},"CreditedWalletId":{"type":"string","description":"The unique identifier of the credited wallet."},"FlowDescriptor":{"$ref":"#/components/schemas/FlowDescriptorRequest"},"FirstTransactionDebitedFunds":{"$ref":"#/components/schemas/CreateARecurringPayInRegistrationCardRequestFirstTransactionDebitedFunds","description":"The amount of the first recurring pay-in. This value can be different from the `NextTransactionDebitedFunds``."},"FirstTransactionFees":{"$ref":"#/components/schemas/CreateARecurringPayInRegistrationCardRequestFirstTransactionFees","description":"The fees of the first recurring pay-in. This amount can be different from the `NextTransactionDebitedFunds`."},"Billing":{"$ref":"#/components/schemas/Billing_DefaultsShippingUser_Request"},"Shipping":{"$ref":"#/components/schemas/Shipping_DefaultsBillingUser_Request"},"NextTransactionDebitedFunds":{"$ref":"#/components/schemas/CreateARecurringPayInRegistrationCardRequestNextTransactionDebitedFunds","description":"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."},"NextTransactionFees":{"$ref":"#/components/schemas/CreateARecurringPayInRegistrationCardRequestNextTransactionFees","description":"The fees of the subsequent recurring pay-ins."},"ProfilingAttemptReference":{"$ref":"#/components/schemas/ProfilingAttemptReference"},"CardId":{"type":"string","description":"The unique identifier of the Card object, obtained during the card registration process."},"EndDate":{"type":"integer","description":"The date and time at which the recurring pay-ins will end. This value has no impact on the recurring registration `Status`.\n\n**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)."},"FixedNextAmount":{"type":"boolean","description":"Whether or not the recurring pay-ins' debited amounts remain the same for all the pay-ins linked to the recurring registration object."},"Frequency":{"type":"string","description":"**Allowed values:** `Daily`, `Weekly`, `TwiceAMonth`, `Monthly`, `Bimonthly`, `Quarterly`, `Semiannual`, `Annual`, `Biannual`\n\nThe frequency at which the recurring pay-ins will occur:\n- `Daily` – 1 transaction per day.\n- `Weekly` – 1 transaction every 7 days.\n- `TwiceAMonth` – 2 transactions per month.\n- `Monthly` – 1 transaction per month.\n- `Bimonthly` – 1 transaction every 2 months.\n- `Quarterly` – 1 transaction every 3 months.\n- `Semiannual` – 1 transaction every 6 months.\n- `Annual` – 1 transaction per year.\n- `Biannual` – 1 transaction every 2 years."},"FractionedPayment":{"type":"boolean","description":"Whether or not the recurring pay-ins are being made to split a payment in several installments."},"FreeCycles":{"type":"integer","description":"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`).\n\n**Note:** When creating a recurring pay-in (CIT or MIT) for a pay-in subject to a free cycle, the `DebitedFunds` and `Fees` parameters cannot be sent."},"Migration":{"type":"boolean","description":"Whether or not to attempt the first recurring pay-in as a merchant-initiated transaction (MIT).\n\n**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.\n\nThe 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 (<a href=\"/errors/codes/008008\">008008</a>), soft decline (<a href=\"/errors/codes/101305\">101305</a>), expired card (<a href=\"/errors/codes/101105\">101105</a>), or stolen card (<a href=\"/errors/codes/008003\">008003</a>)."},"PaymentType":{"type":"string","description":"**Allowed values:** `CARD_DIRECT`\n\n**Default value:** `CARD_DIRECT`\n\nOptional on create. If omitted, defaults to `CARD_DIRECT`.\n\nThe type of recurring pay-in registration (which must correspond to the pay-ins requested against it):\n- `CARD_DIRECT` – Card payments using a tokenized `CardId`."}},"required":["AuthorId","CreditedWalletId","FirstTransactionDebitedFunds","FirstTransactionFees","CardId"],"description":"Request body for card recurring pay-in registrations, using a tokenized `CardId`.","title":"CreateARecurringPayInRegistrationCardRequest"},"CreateARecurringPayInRegistrationApplePayRequestFirstTransactionDebitedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"required":["Currency","Amount"],"description":"The amount of the first recurring pay-in. This value can be different from the `NextTransactionDebitedFunds``.","title":"CreateARecurringPayInRegistrationApplePayRequestFirstTransactionDebitedFunds"},"CreateARecurringPayInRegistrationApplePayRequestFirstTransactionFees":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"required":["Currency","Amount"],"description":"The fees of the first recurring pay-in. This amount can be different from the `NextTransactionDebitedFunds`.","title":"CreateARecurringPayInRegistrationApplePayRequestFirstTransactionFees"},"CreateARecurringPayInRegistrationApplePayRequestNextTransactionDebitedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"required":["Currency","Amount"],"description":"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.","title":"CreateARecurringPayInRegistrationApplePayRequestNextTransactionDebitedFunds"},"CreateARecurringPayInRegistrationApplePayRequestNextTransactionFees":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"required":["Currency","Amount"],"description":"The fees of the subsequent recurring pay-ins.","title":"CreateARecurringPayInRegistrationApplePayRequestNextTransactionFees"},"ApplePayRecurringPaymentData":{"type":"object","properties":{"TokenData":{"type":"string","description":"The encrypted string for the payment request."},"TransactionId":{"type":"string","description":"Apple Pay's unique identifier of the payment."},"Network":{"type":"string","description":"The payment network used for the payment request.\n\n**Returned values:** MasterCard, Visa, cartesBancaires"}},"required":["TokenData","TransactionId","Network"],"description":"The data returned by Apple Pay containing information about the payment.","title":"ApplePayRecurringPaymentData"},"CreateARecurringPayInRegistrationApplePayRequest":{"type":"object","properties":{"AuthorId":{"$ref":"#/components/schemas/AuthorId"},"CreditedWalletId":{"type":"string","description":"The unique identifier of the credited wallet."},"FlowDescriptor":{"$ref":"#/components/schemas/FlowDescriptorRequest"},"FirstTransactionDebitedFunds":{"$ref":"#/components/schemas/CreateARecurringPayInRegistrationApplePayRequestFirstTransactionDebitedFunds","description":"The amount of the first recurring pay-in. This value can be different from the `NextTransactionDebitedFunds``."},"FirstTransactionFees":{"$ref":"#/components/schemas/CreateARecurringPayInRegistrationApplePayRequestFirstTransactionFees","description":"The fees of the first recurring pay-in. This amount can be different from the `NextTransactionDebitedFunds`."},"Billing":{"$ref":"#/components/schemas/Billing_DefaultsShippingUser_Request"},"Shipping":{"$ref":"#/components/schemas/Shipping_DefaultsBillingUser_Request"},"NextTransactionDebitedFunds":{"$ref":"#/components/schemas/CreateARecurringPayInRegistrationApplePayRequestNextTransactionDebitedFunds","description":"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."},"NextTransactionFees":{"$ref":"#/components/schemas/CreateARecurringPayInRegistrationApplePayRequestNextTransactionFees","description":"The fees of the subsequent recurring pay-ins."},"ProfilingAttemptReference":{"$ref":"#/components/schemas/ProfilingAttemptReference"},"PaymentData":{"$ref":"#/components/schemas/ApplePayRecurringPaymentData"},"PaymentType":{"type":"string","description":"**Allowed values:** `APPLEPAY`\n\nThe type of recurring pay-in registration (which must correspond to the pay-ins requested against it):\n- `CARD_DIRECT` – Card payments using a tokenized `CardId`.\n- `APPLEPAY` – Apple Pay payments using the tokenized `PaymentData` object retrieved from the Apple Pay API.\n- `GOOGLE_PAY` – Google Pay payments using the tokenized `PaymentData` string retrieved from the Google Pay API.\n- `PAYPAL` – PayPal payments, redirecting the user to authenticate via PayPal."},"EndDate":{"type":"integer","description":"The date and time at which the recurring pay-ins will end. This value has no impact on the recurring registration `Status`.\n\n**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)."},"FixedNextAmount":{"type":"boolean","description":"Whether or not the recurring pay-ins' debited amounts remain the same for all the pay-ins linked to the recurring registration object."},"Frequency":{"type":"string","description":"**Allowed values:** `Daily`, `Weekly`, `TwiceAMonth`, `Monthly`, `Bimonthly`, `Quarterly`, `Semiannual`, `Annual`, `Biannual`\n\nThe frequency at which the recurring pay-ins will occur:\n- `Daily` – 1 transaction per day.\n- `Weekly` – 1 transaction every 7 days.\n- `TwiceAMonth` – 2 transactions per month.\n- `Monthly` – 1 transaction per month.\n- `Bimonthly` – 1 transaction every 2 months.\n- `Quarterly` – 1 transaction every 3 months.\n- `Semiannual` – 1 transaction every 6 months.\n- `Annual` – 1 transaction per year.\n- `Biannual` – 1 transaction every 2 years."},"FractionedPayment":{"type":"boolean","description":"Whether or not the recurring pay-ins are being made to split a payment in several installments."},"FreeCycles":{"type":"integer","description":"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`).\n\n**Note:** When creating a recurring pay-in (CIT or MIT) for a pay-in subject to a free cycle, the `DebitedFunds` and `Fees` parameters cannot be sent."}},"required":["AuthorId","CreditedWalletId","FirstTransactionDebitedFunds","FirstTransactionFees","PaymentData","PaymentType"],"description":"Request body for Apple Pay recurring pay-in registrations, using the tokenized `PaymentData` object retrieved from the Apple Pay API.","title":"CreateARecurringPayInRegistrationApplePayRequest"},"CreateARecurringPayInRegistrationGooglePayRequestFirstTransactionDebitedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"required":["Currency","Amount"],"description":"The amount of the first recurring pay-in. This value can be different from the `NextTransactionDebitedFunds``.","title":"CreateARecurringPayInRegistrationGooglePayRequestFirstTransactionDebitedFunds"},"CreateARecurringPayInRegistrationGooglePayRequestFirstTransactionFees":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"required":["Currency","Amount"],"description":"The fees of the first recurring pay-in. This amount can be different from the `NextTransactionDebitedFunds`.","title":"CreateARecurringPayInRegistrationGooglePayRequestFirstTransactionFees"},"CreateARecurringPayInRegistrationGooglePayRequestNextTransactionDebitedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"required":["Currency","Amount"],"description":"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.","title":"CreateARecurringPayInRegistrationGooglePayRequestNextTransactionDebitedFunds"},"CreateARecurringPayInRegistrationGooglePayRequestNextTransactionFees":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"required":["Currency","Amount"],"description":"The fees of the subsequent recurring pay-ins.","title":"CreateARecurringPayInRegistrationGooglePayRequestNextTransactionFees"},"CreateARecurringPayInRegistrationGooglePayRequest":{"type":"object","properties":{"AuthorId":{"$ref":"#/components/schemas/AuthorId"},"CreditedWalletId":{"type":"string","description":"The unique identifier of the credited wallet."},"FlowDescriptor":{"$ref":"#/components/schemas/FlowDescriptorRequest"},"FirstTransactionDebitedFunds":{"$ref":"#/components/schemas/CreateARecurringPayInRegistrationGooglePayRequestFirstTransactionDebitedFunds","description":"The amount of the first recurring pay-in. This value can be different from the `NextTransactionDebitedFunds``."},"FirstTransactionFees":{"$ref":"#/components/schemas/CreateARecurringPayInRegistrationGooglePayRequestFirstTransactionFees","description":"The fees of the first recurring pay-in. This amount can be different from the `NextTransactionDebitedFunds`."},"Billing":{"$ref":"#/components/schemas/Billing_DefaultsShippingUser_Request"},"Shipping":{"$ref":"#/components/schemas/Shipping_DefaultsBillingUser_Request"},"NextTransactionDebitedFunds":{"$ref":"#/components/schemas/CreateARecurringPayInRegistrationGooglePayRequestNextTransactionDebitedFunds","description":"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."},"NextTransactionFees":{"$ref":"#/components/schemas/CreateARecurringPayInRegistrationGooglePayRequestNextTransactionFees","description":"The fees of the subsequent recurring pay-ins."},"ProfilingAttemptReference":{"$ref":"#/components/schemas/ProfilingAttemptReference"},"PaymentData":{"type":"string","description":"The data returned by Google Pay containing information about the payment."},"PaymentType":{"type":"string","description":"**Allowed values:** `GOOGLE_PAY`\n\nThe type of recurring pay-in registration (which must correspond to the pay-ins requested against it):\n- `CARD_DIRECT` – Card payments using a tokenized `CardId`.\n- `APPLEPAY` – Apple Pay payments using the tokenized `PaymentData` object retrieved from the Apple Pay API.\n- `GOOGLE_PAY` – Google Pay payments using the tokenized `PaymentData` string retrieved from the Google Pay API.\n- `PAYPAL` – PayPal payments, redirecting the user to authenticate via PayPal."},"EndDate":{"type":"integer","description":"The date and time at which the recurring pay-ins will end. This value has no impact on the recurring registration `Status`.\n\n**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)."},"Frequency":{"type":"string","description":"**Allowed values:** `Daily`, `Weekly`, `TwiceAMonth`, `Monthly`, `Bimonthly`, `Quarterly`, `Semiannual`, `Annual`, `Biannual`\n\nThe frequency at which the recurring pay-ins will occur:\n- `Daily` – 1 transaction per day.\n- `Weekly` – 1 transaction every 7 days.\n- `TwiceAMonth` – 2 transactions per month.\n- `Monthly` – 1 transaction per month.\n- `Bimonthly` – 1 transaction every 2 months.\n- `Quarterly` – 1 transaction every 3 months.\n- `Semiannual` – 1 transaction every 6 months.\n- `Annual` – 1 transaction per year.\n- `Biannual` – 1 transaction every 2 years."},"FixedNextAmount":{"type":"boolean","description":"Whether or not the recurring pay-ins' debited amounts remain the same for all the pay-ins linked to the recurring registration object."},"FractionedPayment":{"type":"boolean","description":"Whether or not the recurring pay-ins are being made to split a payment in several installments."},"FreeCycles":{"type":"integer","description":"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`).\n\n**Note:** When creating a recurring pay-in (CIT or MIT) for a pay-in subject to a free cycle, the `DebitedFunds` and `Fees` parameters cannot be sent."}},"required":["AuthorId","CreditedWalletId","FirstTransactionDebitedFunds","FirstTransactionFees","PaymentData","PaymentType"],"description":"Request body for Google Pay recurring pay-in registrations, using the tokenized `PaymentData` string retrieved from the Google Pay API.","title":"CreateARecurringPayInRegistrationGooglePayRequest"},"CreateARecurringPayInRegistrationPayPalRequestFirstTransactionDebitedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"required":["Currency","Amount"],"description":"The amount of the first recurring pay-in. This value can be different from the `NextTransactionDebitedFunds``.","title":"CreateARecurringPayInRegistrationPayPalRequestFirstTransactionDebitedFunds"},"CreateARecurringPayInRegistrationPayPalRequestFirstTransactionFees":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"required":["Currency","Amount"],"description":"The fees of the first recurring pay-in. This amount can be different from the `NextTransactionDebitedFunds`.","title":"CreateARecurringPayInRegistrationPayPalRequestFirstTransactionFees"},"CreateARecurringPayInRegistrationPayPalRequestNextTransactionDebitedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"required":["Currency","Amount"],"description":"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.","title":"CreateARecurringPayInRegistrationPayPalRequestNextTransactionDebitedFunds"},"CreateARecurringPayInRegistrationPayPalRequestNextTransactionFees":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"required":["Currency","Amount"],"description":"The fees of the subsequent recurring pay-ins.","title":"CreateARecurringPayInRegistrationPayPalRequestNextTransactionFees"},"CreateARecurringPayInRegistrationPayPalRequest":{"type":"object","properties":{"AuthorId":{"$ref":"#/components/schemas/AuthorId"},"CreditedWalletId":{"type":"string","description":"The unique identifier of the credited wallet."},"FlowDescriptor":{"$ref":"#/components/schemas/FlowDescriptorRequest"},"FirstTransactionDebitedFunds":{"$ref":"#/components/schemas/CreateARecurringPayInRegistrationPayPalRequestFirstTransactionDebitedFunds","description":"The amount of the first recurring pay-in. This value can be different from the `NextTransactionDebitedFunds``."},"FirstTransactionFees":{"$ref":"#/components/schemas/CreateARecurringPayInRegistrationPayPalRequestFirstTransactionFees","description":"The fees of the first recurring pay-in. This amount can be different from the `NextTransactionDebitedFunds`."},"Billing":{"$ref":"#/components/schemas/Billing_DefaultsShippingUser_Request"},"Shipping":{"$ref":"#/components/schemas/Shipping_DefaultsBillingUser_Request"},"NextTransactionDebitedFunds":{"$ref":"#/components/schemas/CreateARecurringPayInRegistrationPayPalRequestNextTransactionDebitedFunds","description":"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."},"NextTransactionFees":{"$ref":"#/components/schemas/CreateARecurringPayInRegistrationPayPalRequestNextTransactionFees","description":"The fees of the subsequent recurring pay-ins."},"ProfilingAttemptReference":{"$ref":"#/components/schemas/ProfilingAttemptReference"},"PaymentType":{"type":"string","description":"**Allowed values:** `PAYPAL`\n\nThe type of recurring pay-in registration (which must correspond to the pay-ins requested against it):\n- `CARD_DIRECT` – Card payments using a tokenized `CardId`.\n- `APPLEPAY` – Apple Pay payments using the tokenized `PaymentData` object retrieved from the Apple Pay API.\n- `GOOGLE_PAY` – Google Pay payments using the tokenized `PaymentData` string retrieved from the Google Pay API.\n- `PAYPAL` – PayPal payments, redirecting the user to authenticate via PayPal."}},"required":["AuthorId","CreditedWalletId","FirstTransactionDebitedFunds","FirstTransactionFees","PaymentType"],"description":"Request body for PayPal recurring pay-in registrations, redirecting the user to authenticate via PayPal.\n\nNote that for PayPal:\n- Only one active `PAYPAL` registration object can exist for a user.\n- You can use `NextTransactionDebitedFunds` and `NextTransactionFees` in the registration (and therefore omit them from MIT pay-in requests). The `RecurringType` is always `CUSTOM`, and the `FixedNextAmount` parameter is not supported.\n- The `FreeCycles` property is not supported.","title":"CreateARecurringPayInRegistrationPayPalRequest"},"CreateARecurringPayInRegistrationRequest":{"oneOf":[{"$ref":"#/components/schemas/CreateARecurringPayInRegistrationCardRequest"},{"$ref":"#/components/schemas/CreateARecurringPayInRegistrationApplePayRequest"},{"$ref":"#/components/schemas/CreateARecurringPayInRegistrationGooglePayRequest"},{"$ref":"#/components/schemas/CreateARecurringPayInRegistrationPayPalRequest"}],"title":"CreateARecurringPayInRegistrationRequest"},"RecurringPayInRegistrationCardResponseCurrentStateCumulatedDebitedAmount":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the cumulated debited funds amount.","title":"RecurringPayInRegistrationCardResponseCurrentStateCumulatedDebitedAmount"},"RecurringPayInRegistrationCardResponseCurrentStateCumulatedFeesAmount":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the cumulated fees amount.","title":"RecurringPayInRegistrationCardResponseCurrentStateCumulatedFeesAmount"},"RecurringPayInRegistrationCardResponseCurrentState":{"type":"object","properties":{"PayinsLinked":{"type":"integer","description":"The number of recurring pay-ins already made for the registration object."},"CumulatedDebitedAmount":{"$ref":"#/components/schemas/RecurringPayInRegistrationCardResponseCurrentStateCumulatedDebitedAmount","description":"Information about the cumulated debited funds amount."},"CumulatedFeesAmount":{"$ref":"#/components/schemas/RecurringPayInRegistrationCardResponseCurrentStateCumulatedFeesAmount","description":"Information about the cumulated fees amount."},"LastPayinId":{"type":"string","description":"The unique identifier of the last recurring pay-in made for the registration."}},"description":"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 <a href=\"/api-reference/overview/data-availability-periods\">archived</a>.","title":"RecurringPayInRegistrationCardResponseCurrentState"},"RecurringPayInRegistrationCardResponseTotalAmount":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the total amount.\n\nThis value is automatically calculated based on the `EndDate`, `FixedNextAmount`, and `Frequency` parameters (if defined).","title":"RecurringPayInRegistrationCardResponseTotalAmount"},"RecurringPayInRegistrationCardResponseFirstTransactionDebitedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"The amount of the first recurring pay-in.\n\nThis value can be different from the `NextTransactionDebitedFunds`","title":"RecurringPayInRegistrationCardResponseFirstTransactionDebitedFunds"},"RecurringPayInRegistrationCardResponseFirstTransactionFees":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"The fees of the first recurring pay-in.\n\nThis amount can be different from the `NextTransactionDebitedFunds`.","title":"RecurringPayInRegistrationCardResponseFirstTransactionFees"},"RecurringPayInRegistrationCardResponseNextTransactionDebitedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"The amount of the subsequent recurring pay-ins.\n\nIf this field is empty and either `FixedNextAmount` or `FractionedPayment` are `true`, the subsequent amount will be the same as `FirstTransactionDebitedFunds` amount.","title":"RecurringPayInRegistrationCardResponseNextTransactionDebitedFunds"},"RecurringPayInRegistrationCardResponseNextTransactionFees":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"The fees of the subsequent recurring pay-ins.","title":"RecurringPayInRegistrationCardResponseNextTransactionFees"},"RecurringPayInRegistrationCardResponse":{"type":"object","properties":{"Id":{"$ref":"#/components/schemas/Id"},"Status":{"type":"string","description":"**Returned values:** `CREATED`, `AUTHENTICATION_NEEDED`, `IN_PROGRESS`, `ENDED`\n\nThe status of the recurring registration:\n- `CREATED` – The recurring registration was created, but no recurring pay-in has yet been made.\n- `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.\n- `IN_PROGRESS` – The recurring registration object is in use and the subsequent corresponding recurring pay-ins can be made.\n- `ENDED` – The recurrence ended: the registration can no longer be modified nor reused."},"ResultCode":{"$ref":"#/components/schemas/ResultCode"},"ResultMessage":{"$ref":"#/components/schemas/ResultMessage"},"CurrentState":{"$ref":"#/components/schemas/RecurringPayInRegistrationCardResponseCurrentState","description":"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 <a href=\"/api-reference/overview/data-availability-periods\">archived</a>."},"RecurringType":{"type":"string","description":"**Returned values:** `CLASSIC_SUBSCRIPTION`, `FRACTIONED_PAYMENT`, `CUSTOM`\n\nThe type of recurrence, which can be one of the following:\n- `CLASSIC_SUBSCRIPTION` – For fixed-amount subscriptions. The `Amount` of each pay-in and the subscription's `EndDate` are known, and these values cannot be modified during the recurrence.\n- `FRACTIONED_PAYMENT` – For payments in 3 or 4 times. The `Amount` of each pay-in and the registration's `EndDate` are known, and these values cannot be modified during the recurrence.\n- `CUSTOM` – For recurring registrations where the `Amount` and `EndDate` are unknown."},"TotalAmount":{"$ref":"#/components/schemas/RecurringPayInRegistrationCardResponseTotalAmount","description":"Information about the total amount.\n\nThis value is automatically calculated based on the `EndDate`, `FixedNextAmount`, and `Frequency` parameters (if defined)."},"CycleNumber":{"type":"integer","description":"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)."},"AuthorId":{"$ref":"#/components/schemas/AuthorId"},"CardId":{"type":"string","description":"The unique identifier of the Card object, obtained during the card registration process."},"CreditedUserId":{"$ref":"#/components/schemas/CreditedUserId"},"FlowDescriptor":{"$ref":"#/components/schemas/FlowDescriptorResponse"},"CreditedWalletId":{"type":"string","description":"The unique identifier of the credited wallet."},"Billing":{"$ref":"#/components/schemas/Billing_DefaultsShippingUser_Response"},"Shipping":{"$ref":"#/components/schemas/Shipping_DefaultsBillingUser_Response"},"EndDate":{"type":"integer","description":"Unix timestamp (UTC) of the date and time the recurring pay-ins will end. This value has no impact on the recurring registration `Status`.\n\n**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)."},"Frequency":{"type":"string","description":"**Returned values:** `Daily`, `Weekly`, `TwiceAMonth`, `Monthly`, `Bimonthly`, `Quarterly`, `Semiannual`, `Annual`, `Biannual`\n\nThe frequency at which the recurring pay-ins will occur:\n- `Daily` – 1 transaction per day.\n- `Weekly` – 1 transaction every 7 days.\n- `TwiceAMonth` – 2 transactions per month.\n- `Monthly` – 1 transaction per month.\n- `Bimonthly` – 1 transaction every 2 months.\n- `Quarterly` – 1 transaction every 3 months.\n- `Semiannual` – 1 transaction every 6 months.\n- `Annual` – 1 transaction per year.\n- `Biannual` – 1 transaction every 2 years."},"FixedNextAmount":{"type":"boolean","description":"Whether or not the recurring pay-ins' debited amounts remain the same for all the pay-ins linked to the recurring registration object."},"FractionedPayment":{"type":"boolean","description":"Whether or not the recurring pay-ins are being made to split a payment in several installments."},"FreeCycles":{"type":"integer","description":"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`).\n\n**Note:** When creating a recurring pay-in (CIT or MIT) for a pay-in subject to a free cycle, the `DebitedFunds` and `Fees` parameters cannot be sent."},"FirstTransactionDebitedFunds":{"$ref":"#/components/schemas/RecurringPayInRegistrationCardResponseFirstTransactionDebitedFunds","description":"The amount of the first recurring pay-in.\n\nThis value can be different from the `NextTransactionDebitedFunds`"},"FirstTransactionFees":{"$ref":"#/components/schemas/RecurringPayInRegistrationCardResponseFirstTransactionFees","description":"The fees of the first recurring pay-in.\n\nThis amount can be different from the `NextTransactionDebitedFunds`."},"NextTransactionDebitedFunds":{"$ref":"#/components/schemas/RecurringPayInRegistrationCardResponseNextTransactionDebitedFunds","description":"The amount of the subsequent recurring pay-ins.\n\nIf this field is empty and either `FixedNextAmount` or `FractionedPayment` are `true`, the subsequent amount will be the same as `FirstTransactionDebitedFunds` amount."},"NextTransactionFees":{"$ref":"#/components/schemas/RecurringPayInRegistrationCardResponseNextTransactionFees","description":"The fees of the subsequent recurring pay-ins."},"Migration":{"type":"boolean","description":"Whether or not to attempt the first recurring pay-in as a merchant-initiated transaction (MIT).\n\n**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.\n\nThe 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 (<a href=\"/errors/codes/008008\">008008</a>), soft decline (<a href=\"/errors/codes/101305\">101305</a>), expired card (<a href=\"/errors/codes/101105\">101105</a>), or stolen card (<a href=\"/errors/codes/008003\">008003</a>)."},"PaymentType":{"type":"string","description":"**Returned values:** `CARD_DIRECT`\n\n**Default value:** `CARD_DIRECT`\n\nThe type of recurring pay-in registration (which must correspond to the pay-ins requested against it):\n- `CARD_DIRECT` – Card payments using a tokenized `CardId`.\n- `APPLEPAY` – Apple Pay payments using the tokenized `PaymentData` object retrieved from the Apple Pay API.\n- `GOOGLE_PAY` – Google Pay payments using the tokenized `PaymentData` string retrieved from the Google Pay API.\n- `PAYPAL` – PayPal payments, redirecting the user to authenticate via PayPal."}},"description":"Response object for card recurring pay-in registrations.","title":"RecurringPayInRegistrationCardResponse"},"RecurringPayInRegistrationPayPalResponseCurrentStateCumulatedDebitedAmount":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the cumulated debited funds amount.","title":"RecurringPayInRegistrationPayPalResponseCurrentStateCumulatedDebitedAmount"},"RecurringPayInRegistrationPayPalResponseCurrentStateCumulatedFeesAmount":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the cumulated fees amount.","title":"RecurringPayInRegistrationPayPalResponseCurrentStateCumulatedFeesAmount"},"RecurringPayInRegistrationPayPalResponseCurrentState":{"type":"object","properties":{"PayinsLinked":{"type":"integer","description":"The number of recurring pay-ins already made for the registration object."},"CumulatedDebitedAmount":{"$ref":"#/components/schemas/RecurringPayInRegistrationPayPalResponseCurrentStateCumulatedDebitedAmount","description":"Information about the cumulated debited funds amount."},"CumulatedFeesAmount":{"$ref":"#/components/schemas/RecurringPayInRegistrationPayPalResponseCurrentStateCumulatedFeesAmount","description":"Information about the cumulated fees amount."},"LastPayinId":{"type":"string","description":"The unique identifier of the last recurring pay-in made for the registration."}},"description":"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 <a href=\"/api-reference/overview/data-availability-periods\">archived</a>.","title":"RecurringPayInRegistrationPayPalResponseCurrentState"},"RecurringPayInRegistrationPayPalResponseFirstTransactionDebitedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"The amount of the first recurring pay-in.\n\nThis value can be different from the `NextTransactionDebitedFunds`","title":"RecurringPayInRegistrationPayPalResponseFirstTransactionDebitedFunds"},"RecurringPayInRegistrationPayPalResponseFirstTransactionFees":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"The fees of the first recurring pay-in.\n\nThis amount can be different from the `NextTransactionDebitedFunds`.","title":"RecurringPayInRegistrationPayPalResponseFirstTransactionFees"},"RecurringPayInRegistrationPayPalResponseNextTransactionDebitedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"The amount of the subsequent recurring pay-ins.\n\nIf this field is empty and either `FixedNextAmount` or `FractionedPayment` are `true`, the subsequent amount will be the same as `FirstTransactionDebitedFunds` amount.","title":"RecurringPayInRegistrationPayPalResponseNextTransactionDebitedFunds"},"RecurringPayInRegistrationPayPalResponseNextTransactionFees":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"The fees of the subsequent recurring pay-ins.","title":"RecurringPayInRegistrationPayPalResponseNextTransactionFees"},"RecurringPayInRegistrationPayPalResponse":{"type":"object","properties":{"Id":{"$ref":"#/components/schemas/Id"},"Status":{"type":"string","description":"**Returned values:** `CREATED`, `AUTHENTICATION_NEEDED`, `IN_PROGRESS`, `ENDED` \n\nThe status of the recurring registration for PayPal:\n- `CREATED` – The recurring registration was created, but no recurring pay-in has yet been made.\n- `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.\n- `IN_PROGRESS` – The CIT was successful and subsequent merchant-initiated transactions (MIT) can be requested.\n- `ENDED` – The registration can no longer be modified nor reused. A new one can be created for the same user."},"ResultCode":{"$ref":"#/components/schemas/ResultCode"},"ResultMessage":{"$ref":"#/components/schemas/ResultMessage"},"CurrentState":{"$ref":"#/components/schemas/RecurringPayInRegistrationPayPalResponseCurrentState","description":"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 <a href=\"/api-reference/overview/data-availability-periods\">archived</a>."},"RecurringType":{"type":"string","description":"**Returned values:** `CUSTOM`\n\nFor PayPal recurring registrations, this value is always `CUSTOM`."},"TotalAmount":{"description":"For PayPal recurring registrations, this value is returned `null`."},"CycleNumber":{"description":"For PayPal recurring registrations, this value is returned `null`."},"AuthorId":{"$ref":"#/components/schemas/AuthorId"},"CardId":{"description":"For PayPal recurring registrations, this value is returned `null`."},"CreditedUserId":{"$ref":"#/components/schemas/CreditedUserId"},"FlowDescriptor":{"$ref":"#/components/schemas/FlowDescriptorResponse"},"CreditedWalletId":{"type":"string","description":"The unique identifier of the credited wallet."},"Billing":{"$ref":"#/components/schemas/Billing_DefaultsShippingUser_Response"},"Shipping":{"$ref":"#/components/schemas/Shipping_DefaultsBillingUser_Response"},"EndDate":{"description":"For PayPal recurring registrations, this value is returned `null`."},"Frequency":{"description":"For PayPal recurring registrations, this value is returned `null`."},"FixedNextAmount":{"type":"boolean","description":"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."},"FractionedPayment":{"description":"For PayPal recurring registrations, this value is returned `null`."},"FreeCycles":{"type":"integer","description":"For PayPal recurring registrations, this value is returned `0`."},"FirstTransactionDebitedFunds":{"$ref":"#/components/schemas/RecurringPayInRegistrationPayPalResponseFirstTransactionDebitedFunds","description":"The amount of the first recurring pay-in.\n\nThis value can be different from the `NextTransactionDebitedFunds`"},"FirstTransactionFees":{"$ref":"#/components/schemas/RecurringPayInRegistrationPayPalResponseFirstTransactionFees","description":"The fees of the first recurring pay-in.\n\nThis amount can be different from the `NextTransactionDebitedFunds`."},"NextTransactionDebitedFunds":{"$ref":"#/components/schemas/RecurringPayInRegistrationPayPalResponseNextTransactionDebitedFunds","description":"The amount of the subsequent recurring pay-ins.\n\nIf this field is empty and either `FixedNextAmount` or `FractionedPayment` are `true`, the subsequent amount will be the same as `FirstTransactionDebitedFunds` amount."},"NextTransactionFees":{"$ref":"#/components/schemas/RecurringPayInRegistrationPayPalResponseNextTransactionFees","description":"The fees of the subsequent recurring pay-ins."},"Migration":{"type":"boolean","description":"For PayPal recurring registrations, this value is returned `false`.","deprecated":true},"PaymentType":{"type":"string","description":"**Returned values:** `PAYPAL`\n\nThe type of recurring pay-in registration (which must correspond to the pay-ins requested against it):\n- `CARD_DIRECT` – Card payments using a tokenized `CardId`.\n- `APPLEPAY` – Apple Pay payments using the tokenized `PaymentData` object retrieved from the Apple Pay API.\n- `GOOGLE_PAY` – Google Pay payments using the tokenized `PaymentData` string retrieved from the Google Pay API.\n- `PAYPAL` – PayPal payments, redirecting the user to authenticate via PayPal."}},"description":"Response object for PayPal recurring pay-in registrations.","title":"RecurringPayInRegistrationPayPalResponse"},"RecurringPayInRegistrationApplePayResponseCurrentStateCumulatedDebitedAmount":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"The sum of the DebitedFunds amounts of the recurring pay-ins made for the registration.","title":"RecurringPayInRegistrationApplePayResponseCurrentStateCumulatedDebitedAmount"},"RecurringPayInRegistrationApplePayResponseCurrentStateCumulatedFeesAmount":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"The sum of the Fees amounts of the recurring pay-ins made for the registration.","title":"RecurringPayInRegistrationApplePayResponseCurrentStateCumulatedFeesAmount"},"RecurringPayInRegistrationApplePayResponseCurrentState":{"type":"object","properties":{"PayinsLinked":{"type":"integer","description":"The number of recurring pay-ins already made for the registration object."},"CumulatedDebitedAmount":{"$ref":"#/components/schemas/RecurringPayInRegistrationApplePayResponseCurrentStateCumulatedDebitedAmount","description":"The sum of the DebitedFunds amounts of the recurring pay-ins made for the registration."},"CumulatedFeesAmount":{"$ref":"#/components/schemas/RecurringPayInRegistrationApplePayResponseCurrentStateCumulatedFeesAmount","description":"The sum of the Fees amounts of the recurring pay-ins made for the registration."},"LastPayinId":{"type":"string","description":"The unique identifier of the last recurring pay-in made for the registration."}},"description":"Information about the recurring pay-ins related to the registration object.\n\n**Note:** If the LastPayinId references a transaction older than 13 months, it may have been archived.","title":"RecurringPayInRegistrationApplePayResponseCurrentState"},"RecurringPayInRegistrationApplePayResponseTotalAmount":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"title":"RecurringPayInRegistrationApplePayResponseTotalAmount"},"RecurringPayInRegistrationApplePayResponseFirstTransactionDebitedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"The amount of the first recurring pay-in.","title":"RecurringPayInRegistrationApplePayResponseFirstTransactionDebitedFunds"},"RecurringPayInRegistrationApplePayResponseFirstTransactionFees":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"The fees of the first recurring pay-in.","title":"RecurringPayInRegistrationApplePayResponseFirstTransactionFees"},"RecurringPayInRegistrationApplePayResponseNextTransactionDebitedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"The amount of the subsequent recurring pay-ins.","title":"RecurringPayInRegistrationApplePayResponseNextTransactionDebitedFunds"},"RecurringPayInRegistrationApplePayResponseNextTransactionFees":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"The fees of the subsequent recurring pay-ins.","title":"RecurringPayInRegistrationApplePayResponseNextTransactionFees"},"RecurringPayInRegistrationApplePayResponse":{"type":"object","properties":{"Id":{"$ref":"#/components/schemas/Id"},"Status":{"type":"string","description":"**Returned values:** `CREATED`, `AUTHENTICATION_NEEDED`, `IN_PROGRESS`, `ENDED`\n\nThe status of the recurring registration:\n- `CREATED` – The recurring registration was created, but no recurring pay-in has yet been made.\n- `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.\n- `IN_PROGRESS` – The recurring registration object is in use and the subsequent corresponding recurring pay-ins can be made.\n- `ENDED` – The recurrence ended: the registration can no longer be modified nor reused."},"CurrentState":{"$ref":"#/components/schemas/RecurringPayInRegistrationApplePayResponseCurrentState","description":"Information about the recurring pay-ins related to the registration object.\n\n**Note:** If the LastPayinId references a transaction older than 13 months, it may have been archived."},"RecurringType":{"type":"string"},"TotalAmount":{"$ref":"#/components/schemas/RecurringPayInRegistrationApplePayResponseTotalAmount"},"CycleNumber":{"type":"integer"},"AuthorId":{"$ref":"#/components/schemas/AuthorId"},"CreditedUserId":{"$ref":"#/components/schemas/CreditedUserId"},"FlowDescriptor":{"$ref":"#/components/schemas/FlowDescriptorResponse"},"CreditedWalletId":{"type":"string","description":"The unique identifier of the credited wallet."},"Billing":{"$ref":"#/components/schemas/Billing_DefaultsShippingUser_Response"},"Shipping":{"$ref":"#/components/schemas/Shipping_DefaultsBillingUser_Response"},"EndDate":{"type":"integer","description":"The date and time at which the recurring pay-ins will end. This value has no impact on the recurring registration Status.\n\n**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)."},"Frequency":{"type":"string","description":"**Returned values:** `Daily`, `Weekly`, `TwiceAMonth`, `Monthly`, `Bimonthly`, `Quarterly`, `Semiannual`, `Annual`, `Biannual`\n\nThe frequency at which the recurring pay-ins will occur:\n- `Daily` – 1 transaction per day.\n- `Weekly` – 1 transaction every 7 days.\n- `TwiceAMonth` – 2 transactions per month.\n- `Monthly` – 1 transaction per month.\n- `Bimonthly` – 1 transaction every 2 months.\n- `Quarterly` – 1 transaction every 3 months.\n- `Semiannual` – 1 transaction every 6 months.\n- `Annual` – 1 transaction per year.\n- `Biannual` – 1 transaction every 2 years."},"FixedNextAmount":{"type":"boolean","description":"Whether or not the recurring pay-ins' debited amounts remain the same for all the pay-ins linked to the recurring registration object."},"FractionedPayment":{"type":"boolean","description":"Whether or not the recurring pay-ins are being made to split a payment in several installments."},"FreeCycles":{"type":"integer","description":"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).\n\n**Note:** When creating a recurring pay-in (CIT or MIT) for a pay-in subject to a free cycle, the DebitedFunds and Fees parameters cannot be sent."},"FirstTransactionDebitedFunds":{"$ref":"#/components/schemas/RecurringPayInRegistrationApplePayResponseFirstTransactionDebitedFunds","description":"The amount of the first recurring pay-in."},"FirstTransactionFees":{"$ref":"#/components/schemas/RecurringPayInRegistrationApplePayResponseFirstTransactionFees","description":"The fees of the first recurring pay-in."},"NextTransactionDebitedFunds":{"$ref":"#/components/schemas/RecurringPayInRegistrationApplePayResponseNextTransactionDebitedFunds","description":"The amount of the subsequent recurring pay-ins."},"NextTransactionFees":{"$ref":"#/components/schemas/RecurringPayInRegistrationApplePayResponseNextTransactionFees","description":"The fees of the subsequent recurring pay-ins."},"Migration":{"type":"boolean"},"ProfilingAttemptReference":{"$ref":"#/components/schemas/ProfilingAttemptReference"},"PaymentType":{"type":"string","description":"**Returned values:** `APPLEPAY`\n\nThe type of recurring pay-in registration (which must correspond to the pay-ins requested against it):\n- `CARD_DIRECT` – Card payments using a tokenized `CardId`.\n- `APPLEPAY` – Apple Pay payments using the tokenized `PaymentData` object retrieved from the Apple Pay API.\n- `GOOGLE_PAY` – Google Pay payments using the tokenized `PaymentData` string retrieved from the Google Pay API.\n- `PAYPAL` – PayPal payments, redirecting the user to authenticate via PayPal."},"ResultCode":{"$ref":"#/components/schemas/ResultCode"},"ResultMessage":{"$ref":"#/components/schemas/ResultMessage"},"CardInfo":{"$ref":"#/components/schemas/CardInfo"}},"description":"Response object for Apple Pay recurring pay-in registrations.","title":"RecurringPayInRegistrationApplePayResponse"},"RecurringPayInRegistrationGooglePayResponseCurrentStateCumulatedDebitedAmount":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"The sum of the DebitedFunds amounts of the recurring pay-ins made for the registration.","title":"RecurringPayInRegistrationGooglePayResponseCurrentStateCumulatedDebitedAmount"},"RecurringPayInRegistrationGooglePayResponseCurrentStateCumulatedFeesAmount":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"The sum of the Fees amounts of the recurring pay-ins made for the registration.","title":"RecurringPayInRegistrationGooglePayResponseCurrentStateCumulatedFeesAmount"},"RecurringPayInRegistrationGooglePayResponseCurrentState":{"type":"object","properties":{"PayinsLinked":{"type":"integer","description":"The number of recurring pay-ins already made for the registration object."},"CumulatedDebitedAmount":{"$ref":"#/components/schemas/RecurringPayInRegistrationGooglePayResponseCurrentStateCumulatedDebitedAmount","description":"The sum of the DebitedFunds amounts of the recurring pay-ins made for the registration."},"CumulatedFeesAmount":{"$ref":"#/components/schemas/RecurringPayInRegistrationGooglePayResponseCurrentStateCumulatedFeesAmount","description":"The sum of the Fees amounts of the recurring pay-ins made for the registration."},"LastPayinId":{"type":"string","description":"The unique identifier of the last recurring pay-in made for the registration."}},"description":"Information about the recurring pay-ins related to the registration object.\n\n**Note:** If the LastPayinId references a transaction older than 13 months, it may have been archived.","title":"RecurringPayInRegistrationGooglePayResponseCurrentState"},"RecurringPayInRegistrationGooglePayResponseTotalAmount":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"title":"RecurringPayInRegistrationGooglePayResponseTotalAmount"},"RecurringPayInRegistrationGooglePayResponseFirstTransactionDebitedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"The amount of the first recurring pay-in.","title":"RecurringPayInRegistrationGooglePayResponseFirstTransactionDebitedFunds"},"RecurringPayInRegistrationGooglePayResponseFirstTransactionFees":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"The fees of the first recurring pay-in.","title":"RecurringPayInRegistrationGooglePayResponseFirstTransactionFees"},"RecurringPayInRegistrationGooglePayResponseNextTransactionDebitedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"The amount of the subsequent recurring pay-ins.","title":"RecurringPayInRegistrationGooglePayResponseNextTransactionDebitedFunds"},"RecurringPayInRegistrationGooglePayResponseNextTransactionFees":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"The fees of the subsequent recurring pay-ins.","title":"RecurringPayInRegistrationGooglePayResponseNextTransactionFees"},"RecurringPayInRegistrationGooglePayResponse":{"type":"object","properties":{"Id":{"$ref":"#/components/schemas/Id"},"Status":{"type":"string","description":"**Returned values:** `CREATED`, `AUTHENTICATION_NEEDED`, `IN_PROGRESS`, `ENDED`\n\nThe status of the recurring registration:\n- `CREATED` – The recurring registration was created, but no recurring pay-in has yet been made.\n- `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.\n- `IN_PROGRESS` – The recurring registration object is in use and the subsequent corresponding recurring pay-ins can be made.\n- `ENDED` – The recurrence ended: the registration can no longer be modified nor reused."},"CurrentState":{"$ref":"#/components/schemas/RecurringPayInRegistrationGooglePayResponseCurrentState","description":"Information about the recurring pay-ins related to the registration object.\n\n**Note:** If the LastPayinId references a transaction older than 13 months, it may have been archived."},"RecurringType":{"type":"string"},"TotalAmount":{"$ref":"#/components/schemas/RecurringPayInRegistrationGooglePayResponseTotalAmount"},"CycleNumber":{"type":"integer"},"AuthorId":{"$ref":"#/components/schemas/AuthorId"},"CreditedUserId":{"$ref":"#/components/schemas/CreditedUserId"},"FlowDescriptor":{"$ref":"#/components/schemas/FlowDescriptorResponse"},"CreditedWalletId":{"type":"string","description":"The unique identifier of the credited wallet."},"Billing":{"$ref":"#/components/schemas/Billing_DefaultsShippingUser_Response"},"Shipping":{"$ref":"#/components/schemas/Shipping_DefaultsBillingUser_Response"},"EndDate":{"type":"integer","description":"The date and time at which the recurring pay-ins will end. This value has no impact on the recurring registration Status.\n\n**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)."},"Frequency":{"type":"string","description":"**Returned values:** `Daily`, `Weekly`, `TwiceAMonth`, `Monthly`, `Bimonthly`, `Quarterly`, `Semiannual`, `Annual`, `Biannual`\n\nThe frequency at which the recurring pay-ins will occur:\n- `Daily` – 1 transaction per day.\n- `Weekly` – 1 transaction every 7 days.\n- `TwiceAMonth` – 2 transactions per month.\n- `Monthly` – 1 transaction per month.\n- `Bimonthly` – 1 transaction every 2 months.\n- `Quarterly` – 1 transaction every 3 months.\n- `Semiannual` – 1 transaction every 6 months.\n- `Annual` – 1 transaction per year.\n- `Biannual` – 1 transaction every 2 years."},"FixedNextAmount":{"type":"boolean","description":"Whether or not the recurring pay-ins' debited amounts remain the same for all the pay-ins linked to the recurring registration object."},"FractionedPayment":{"type":"boolean","description":"Whether or not the recurring pay-ins are being made to split a payment in several installments."},"FreeCycles":{"type":"integer","description":"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).\n\n**Note:** When creating a recurring pay-in (CIT or MIT) for a pay-in subject to a free cycle, the DebitedFunds and Fees parameters cannot be sent."},"FirstTransactionDebitedFunds":{"$ref":"#/components/schemas/RecurringPayInRegistrationGooglePayResponseFirstTransactionDebitedFunds","description":"The amount of the first recurring pay-in."},"FirstTransactionFees":{"$ref":"#/components/schemas/RecurringPayInRegistrationGooglePayResponseFirstTransactionFees","description":"The fees of the first recurring pay-in."},"NextTransactionDebitedFunds":{"$ref":"#/components/schemas/RecurringPayInRegistrationGooglePayResponseNextTransactionDebitedFunds","description":"The amount of the subsequent recurring pay-ins."},"NextTransactionFees":{"$ref":"#/components/schemas/RecurringPayInRegistrationGooglePayResponseNextTransactionFees","description":"The fees of the subsequent recurring pay-ins."},"Migration":{"type":"boolean"},"ProfilingAttemptReference":{"$ref":"#/components/schemas/ProfilingAttemptReference"},"PaymentType":{"type":"string","description":"**Returned values:** `GOOGLE_PAY`\n\nThe type of recurring pay-in registration (which must correspond to the pay-ins requested against it):\n- `CARD_DIRECT` – Card payments using a tokenized `CardId`.\n- `APPLEPAY` – Apple Pay payments using the tokenized `PaymentData` object retrieved from the Apple Pay API.\n- `GOOGLE_PAY` – Google Pay payments using the tokenized `PaymentData` string retrieved from the Google Pay API.\n- `PAYPAL` – PayPal payments, redirecting the user to authenticate via PayPal."},"ResultCode":{"$ref":"#/components/schemas/ResultCode"},"ResultMessage":{"$ref":"#/components/schemas/ResultMessage"},"CardInfo":{"$ref":"#/components/schemas/CardInfo"}},"description":"Response object for Google Pay recurring pay-in registrations.","title":"RecurringPayInRegistrationGooglePayResponse"},"RecurringPayInRegistrationResponse":{"oneOf":[{"$ref":"#/components/schemas/RecurringPayInRegistrationCardResponse"},{"$ref":"#/components/schemas/RecurringPayInRegistrationPayPalResponse"},{"$ref":"#/components/schemas/RecurringPayInRegistrationApplePayResponse"},{"$ref":"#/components/schemas/RecurringPayInRegistrationGooglePayResponse"}],"title":"RecurringPayInRegistrationResponse"},"UpdateARecurringPayInRegistrationRequest_Card":{"type":"object","properties":{"Status":{"type":"string","description":"**Allowed values:** `ENDED`\n\nThe status of the recurring registration:\n- `CREATED` – The recurring registration was created, but no recurring pay-in has yet been made.\n- `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.\n- `IN_PROGRESS` – The recurring registration object is in use and the subsequent corresponding recurring pay-ins can be made.\n- `ENDED` – The recurrence ended: the registration can no longer be modified nor reused."},"Shipping":{"$ref":"#/components/schemas/Shipping_DefaultsBillingUser_Request"},"Billing":{"$ref":"#/components/schemas/Billing_DefaultsShippingUser_Request"},"CardId":{"type":"string","description":"The unique identifier of the Card object, obtained during the card registration process."},"PaymentType":{"type":"string","description":"**Allowed values:** `CARD_DIRECT`\n\nThe existing registration's `PaymentType` must match the request variant.\n\nThe type of recurring pay-in registration (which must correspond to the pay-ins requested against it):\n- `CARD_DIRECT` – Card payments using a tokenized `CardId`.\n- `APPLEPAY` – Apple Pay payments using the tokenized `PaymentData` object retrieved from the Apple Pay API.\n- `GOOGLE_PAY` – Google Pay payments using the tokenized `PaymentData` string retrieved from the Google Pay API.\n- `PAYPAL` – PayPal payments, redirecting the user to authenticate via PayPal."}},"description":"Request body for updating a Card recurring pay-in registration (`PaymentType` `CARD_DIRECT`).\n\nThe existing registration's `PaymentType` must match the request variant. Updating the `CardId` requires re-authentication via a new CIT.","title":"UpdateARecurringPayInRegistrationRequest_Card"},"UpdateARecurringPayInRegistrationRequest_ApplePay":{"type":"object","properties":{"Status":{"type":"string","description":"**Allowed values:** `ENDED`\n\nThe status of the recurring registration:\n- `CREATED` – The recurring registration was created, but no recurring pay-in has yet been made.\n- `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.\n- `IN_PROGRESS` – The recurring registration object is in use and the subsequent corresponding recurring pay-ins can be made.\n- `ENDED` – The recurrence ended: the registration can no longer be modified nor reused."},"Shipping":{"$ref":"#/components/schemas/Shipping_DefaultsBillingUser_Request"},"Billing":{"$ref":"#/components/schemas/Billing_DefaultsShippingUser_Request"},"PaymentData":{"$ref":"#/components/schemas/ApplePayRecurringPaymentData"},"PaymentType":{"type":"string","description":"**Allowed values:** `APPLEPAY`\n\nThe existing registration's `PaymentType` must match the request variant.\n\nThe type of recurring pay-in registration (which must correspond to the pay-ins requested against it):\n- `CARD_DIRECT` – Card payments using a tokenized `CardId`.\n- `APPLEPAY` – Apple Pay payments using the tokenized `PaymentData` object retrieved from the Apple Pay API.\n- `GOOGLE_PAY` – Google Pay payments using the tokenized `PaymentData` string retrieved from the Google Pay API.\n- `PAYPAL` – PayPal payments, redirecting the user to authenticate via PayPal."}},"description":"Request body for updating an Apple Pay recurring pay-in registration (`PaymentType` `APPLEPAY`).\n\nThe existing registration's `PaymentType` must match the request variant. Updating the `PaymentData` requires re-authentication via a new CIT.","title":"UpdateARecurringPayInRegistrationRequest_ApplePay"},"UpdateARecurringPayInRegistrationRequest_GooglePay":{"type":"object","properties":{"Status":{"type":"string","description":"**Allowed values:** `ENDED`\n\nThe status of the recurring registration:\n- `CREATED` – The recurring registration was created, but no recurring pay-in has yet been made.\n- `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.\n- `IN_PROGRESS` – The recurring registration object is in use and the subsequent corresponding recurring pay-ins can be made.\n- `ENDED` – The recurrence ended: the registration can no longer be modified nor reused."},"Shipping":{"$ref":"#/components/schemas/Shipping_DefaultsBillingUser_Request"},"Billing":{"$ref":"#/components/schemas/Billing_DefaultsShippingUser_Request"},"PaymentData":{"type":"string","description":"The data returned by Google Pay containing information about the payment."},"PaymentType":{"type":"string","description":"**Allowed values:** `GOOGLE_PAY`\n\nThe existing registration's `PaymentType` must match the request variant.\n\nThe type of recurring pay-in registration (which must correspond to the pay-ins requested against it):\n- `CARD_DIRECT` – Card payments using a tokenized `CardId`.\n- `APPLEPAY` – Apple Pay payments using the tokenized `PaymentData` object retrieved from the Apple Pay API.\n- `GOOGLE_PAY` – Google Pay payments using the tokenized `PaymentData` string retrieved from the Google Pay API.\n- `PAYPAL` – PayPal payments, redirecting the user to authenticate via PayPal."}},"description":"Request body for updating a Google Pay recurring pay-in registration (`PaymentType` `GOOGLE_PAY`).\n\nThe existing registration's `PaymentType` must match the request variant. Updating the `PaymentData` requires re-authentication via a new CIT.","title":"UpdateARecurringPayInRegistrationRequest_GooglePay"},"UpdateARecurringPayInRegistrationRequest_PayPal":{"type":"object","properties":{"Status":{"type":"string","description":"**Allowed values:** `ENDED`\n\nThe status of the recurring registration:\n- `CREATED` – The recurring registration was created, but no recurring pay-in has yet been made.\n- `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.\n- `IN_PROGRESS` – The recurring registration object is in use and the subsequent corresponding recurring pay-ins can be made.\n- `ENDED` – The recurrence ended: the registration can no longer be modified nor reused."},"Shipping":{"$ref":"#/components/schemas/Shipping_DefaultsBillingUser_Request"},"Billing":{"$ref":"#/components/schemas/Billing_DefaultsShippingUser_Request"},"PaymentType":{"type":"string","description":"**Allowed values:** `PAYPAL`\n\nThe existing registration's `PaymentType` must match the request variant.\n\nThe type of recurring pay-in registration (which must correspond to the pay-ins requested against it):\n- `CARD_DIRECT` – Card payments using a tokenized `CardId`.\n- `APPLEPAY` – Apple Pay payments using the tokenized `PaymentData` object retrieved from the Apple Pay API.\n- `GOOGLE_PAY` – Google Pay payments using the tokenized `PaymentData` string retrieved from the Google Pay API.\n- `PAYPAL` – PayPal payments, redirecting the user to authenticate via PayPal."}},"description":"Request body for updating a PayPal recurring pay-in registration (`PaymentType` `PAYPAL`).\n\nThe existing registration's `PaymentType` must match the request variant.","title":"UpdateARecurringPayInRegistrationRequest_PayPal"},"UpdateARecurringPayInRegistrationRequest":{"oneOf":[{"$ref":"#/components/schemas/UpdateARecurringPayInRegistrationRequest_Card"},{"$ref":"#/components/schemas/UpdateARecurringPayInRegistrationRequest_ApplePay"},{"$ref":"#/components/schemas/UpdateARecurringPayInRegistrationRequest_GooglePay"},{"$ref":"#/components/schemas/UpdateARecurringPayInRegistrationRequest_PayPal"}],"title":"UpdateARecurringPayInRegistrationRequest"},"CreateARecurringCardPayInCITRequest":{"type":"object","properties":{"Tag":{"$ref":"#/components/schemas/Tag"},"SecureModeReturnURL":{"$ref":"#/components/schemas/SecureModeReturnURL"},"Culture":{"type":"string","description":"The language in which the payment page is to be displayed. This deprecated parameter defaults to `EN`.","deprecated":true},"StatementDescriptor":{"$ref":"#/components/schemas/StatementDescriptor_22"},"BrowserInfo":{"$ref":"#/components/schemas/BrowserInfo"},"IpAddress":{"$ref":"#/components/schemas/IpAddress"},"RecurringPayinRegistrationId":{"type":"string","description":"The unique identifier of the recurring pay-in registration."},"PreferredCardNetwork":{"$ref":"#/components/schemas/PreferredCardNetwork"},"PaymentCategory":{"$ref":"#/components/schemas/PaymentCategory"}},"required":["SecureModeReturnURL","BrowserInfo","IpAddress","RecurringPayinRegistrationId"],"description":"Request body for a card customer-initiated transcation (CIT).","title":"CreateARecurringCardPayInCITRequest"},"CreateARecurringCardPayInMitRequestDebitedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"required":["Currency","Amount"],"description":"Information about the debited funds. This property overrides the `NextTransactionDebitedFunds` of the Registration, and is **required if** that property is empty.\n\n**Caution:** An amount must be provided in either the Registration's `NextTransactionDebitedFunds` or the pay-in's `DebitedFunds`.","title":"CreateARecurringCardPayInMitRequestDebitedFunds"},"CreateARecurringCardPayInMitRequestFees":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"required":["Currency","Amount"],"description":"Information about the fees. This property overrides the `NextTransactionFees` of the Registration, and is **required if** that property is empty.\n\n**Caution:** An amount must be provided in either the Registration's `NextTransactionFees` or the pay-in's `Fees`.","title":"CreateARecurringCardPayInMitRequestFees"},"CreateARecurringCardPayInMITRequest":{"type":"object","properties":{"Tag":{"$ref":"#/components/schemas/Tag"},"DebitedFunds":{"$ref":"#/components/schemas/CreateARecurringCardPayInMitRequestDebitedFunds","description":"Information about the debited funds. This property overrides the `NextTransactionDebitedFunds` of the Registration, and is **required if** that property is empty.\n\n**Caution:** An amount must be provided in either the Registration's `NextTransactionDebitedFunds` or the pay-in's `DebitedFunds`."},"Fees":{"$ref":"#/components/schemas/CreateARecurringCardPayInMitRequestFees","description":"Information about the fees. This property overrides the `NextTransactionFees` of the Registration, and is **required if** that property is empty.\n\n**Caution:** An amount must be provided in either the Registration's `NextTransactionFees` or the pay-in's `Fees`."},"StatementDescriptor":{"$ref":"#/components/schemas/StatementDescriptor_22"},"RecurringPayinRegistrationId":{"type":"string","description":"The unique identifier of the recurring pay-in registration."},"PaymentCategory":{"$ref":"#/components/schemas/PaymentCategory"}},"required":["RecurringPayinRegistrationId"],"description":"Request body for a card merchant-initiated transaction (MIT).","title":"CreateARecurringCardPayInMITRequest"},"recurringCardPayins_create_recurring_card_payin_Request":{"oneOf":[{"$ref":"#/components/schemas/CreateARecurringCardPayInCITRequest"},{"$ref":"#/components/schemas/CreateARecurringCardPayInMITRequest"}],"title":"recurringCardPayins_create_recurring_card_payin_Request"},"CreateAPreauthorizationRequestDebitedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"required":["Currency","Amount"],"description":"Information about the preauthorized funds.","title":"CreateAPreauthorizationRequestDebitedFunds"},"CreateAPreauthorizationRequest":{"type":"object","properties":{"FlowDescriptor":{"$ref":"#/components/schemas/FlowDescriptorRequest"},"Tag":{"$ref":"#/components/schemas/Tag"},"AuthorId":{"$ref":"#/components/schemas/AuthorId"},"DebitedFunds":{"$ref":"#/components/schemas/CreateAPreauthorizationRequestDebitedFunds","description":"Information about the preauthorized funds."},"SecureMode":{"type":"string","description":"**Allowed values:** `DEFAULT`, `FORCE`, `NO_CHOICE`\n\n**Default value:** `DEFAULT`\n\nThe mode applied for the 3DS2 protocol for CB, Visa, and Mastercard. The options are:\n- `DEFAULT` – Requests an exemption to strong customer authentication (SCA), and thus a frictionless payment experience, if allowed by your Mangopay contract and accepted by the issuer.\n- `FORCE` – Requests SCA.\n- `NO_CHOICE` – Leaves the choice to the issuer whether to allow for a frictionless payment experience or to enforce SCA."},"CardId":{"type":"string","description":"The unique identifier of the Card object, obtained during the card registration process."},"SecureModeReturnURL":{"$ref":"#/components/schemas/SecureModeReturnURL"},"StatementDescriptor":{"$ref":"#/components/schemas/StatementDescriptor_22"},"Culture":{"type":"string","description":"**Allowed values:** One of the supported languages in the [ISO 639-1 format](/api-reference/overview/data-formats): DE, EN, ES, FR, IT, NL, PL, PT.\n\nThe language in which the payment page is to be displayed."},"BrowserInfo":{"$ref":"#/components/schemas/BrowserInfo"},"IpAddress":{"$ref":"#/components/schemas/IpAddress"},"Billing":{"$ref":"#/components/schemas/Billing_DefaultsShippingUser_Request"},"Shipping":{"$ref":"#/components/schemas/Shipping_DefaultsBillingUser_Request"},"PreferredCardNetwork":{"$ref":"#/components/schemas/PreferredCardNetwork"},"PaymentCategory":{"$ref":"#/components/schemas/PaymentCategory"},"ProfilingAttemptReference":{"$ref":"#/components/schemas/ProfilingAttemptReference"}},"required":["AuthorId","DebitedFunds","CardId","SecureModeReturnURL","BrowserInfo","IpAddress"],"title":"CreateAPreauthorizationRequest"},"PreauthorizationResponseDebitedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the preauthorized funds.","title":"PreauthorizationResponseDebitedFunds"},"PreauthorizationResponseRemainingFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the remaining preauthorized funds.","title":"PreauthorizationResponseRemainingFunds"},"AuthorizationStatus":{"type":"string","description":"**Returned values:** `CREATED`, `SUCCEEDED`, `FAILED`\n\nThe status of the authorization.","title":"AuthorizationStatus"},"PreauthorizationResponse":{"type":"object","properties":{"Id":{"type":"string","description":"Max. length: 255 characters\n\nThe unique identifier of the preauthorization."},"Tag":{"$ref":"#/components/schemas/Tag"},"CreationDate":{"$ref":"#/components/schemas/CreationDate"},"AuthorId":{"$ref":"#/components/schemas/AuthorId"},"FlowDescriptor":{"$ref":"#/components/schemas/FlowDescriptorResponse"},"DebitedFunds":{"$ref":"#/components/schemas/PreauthorizationResponseDebitedFunds","description":"Information about the preauthorized funds."},"RemainingFunds":{"$ref":"#/components/schemas/PreauthorizationResponseRemainingFunds","description":"Information about the remaining preauthorized funds."},"AuthorizationDate":{"type":"integer","description":"Unix timestamp (UTC) of the date and time successful authorization occurred. If authorization failed, the value is `null`."},"Status":{"$ref":"#/components/schemas/AuthorizationStatus"},"PaymentStatus":{"type":"string","description":"**Returned values:** `WAITING`, `CANCELED`, `EXPIRED`, `VALIDATED`\n\nThe status of the preauthorization object:\n- `WAITING` – The remaining preauthorized funds can be captured by making one or several preauthorized pay-ins. Pay-ins can only be made against a preauthorization with the `WAITING` status.\n- `CANCELED` – The preauthorization was canceled manually before any preauthorized pay-ins were made, or it was canceled automatically because the authorization failed.\n- `EXPIRED` – The hold period on the preauthorized funds has ended without any preauthorized pay-ins taking place.\n- `VALIDATED` – During the hold period: Indicates that all the preauthorized funds have been captured (`RemainingFunds` is zero) and no more preauthorized pay-ins can be made. After the hold period: Indicates that at least one capture was made during the hold period."},"ExpirationDate":{"type":"integer","description":"Unix timestamp (UTC) of the date and time the hold period ends and the preauthorized funds are released. At the expiration date, the preauthorization's `PaymentStatus` changes to `EXPIRED` if no captures were made or `VALIDATED` if at least one capture was made."},"PayInId":{"type":"string","description":"The unique identifier of the pay-in."},"ResultCode":{"$ref":"#/components/schemas/ResultCode"},"ResultMessage":{"$ref":"#/components/schemas/ResultMessage"},"SecureMode":{"type":"string","description":"**Returned values:** `DEFAULT`, `FORCE`, `NO_CHOICE`\n\nThe mode applied for the 3DS2 protocol for CB, Visa, and Mastercard. The options are:\n- `DEFAULT` – Requests an exemption to strong customer authentication (SCA), and thus a frictionless payment experience, if allowed by your Mangopay contract and accepted by the issuer.\n- `FORCE` – Requests SCA.\n- `NO_CHOICE` – Leaves the choice to the issuer whether to allow for a frictionless payment experience or to enforce SCA."},"CardId":{"type":"string","description":"The unique identifier of the Card object, obtained during the card registration process."},"SecureModeReturnURL":{"$ref":"#/components/schemas/SecureModeReturnURL"},"SecureModeRedirectURL":{"type":"string","description":"Max. length: 255 characters\n\nThe URL to which to redirect the user to proceed to 3DS2 validation."},"SecureModeNeeded":{"type":"boolean","description":"Whether or not the `SecureMode` was used."},"PaymentType":{"type":"string","description":"**Returned values:** `CARD`\n\nThe payment type of the preauthorization."},"ExecutionType":{"type":"string","description":"**Returned values:** `DIRECT`\n\nThe execution type of the preauthorization."},"StatementDescriptor":{"$ref":"#/components/schemas/StatementDescriptor_22"},"Culture":{"type":"string","description":"**Returned values:** One of the supported languages in the [ISO 639-1 format](/api-reference/overview/data-formats): DE, EN, ES, FR, IT, NL, PL, PT.\n\nThe language in which the payment page is to be displayed."},"SecurityInfo":{"$ref":"#/components/schemas/AVSResult"},"MultiCapture":{"type":"boolean","description":"**Default value:** true\n\nWhether multiple captures are activated for the preauthorization."},"BrowserInfo":{"$ref":"#/components/schemas/BrowserInfo"},"IpAddress":{"$ref":"#/components/schemas/IpAddress"},"Billing":{"$ref":"#/components/schemas/Billing_DefaultsShippingUser_Response"},"Shipping":{"$ref":"#/components/schemas/Shipping_DefaultsBillingUser_Response"},"Requested3DSVersion":{"type":"string","description":"**Returned values:** `V1`, `V2_1`\n\nThe 3DS protocol version to be applied to the transaction."},"Applied3DSVersion":{"type":"string","description":"**Returned values:** `V1`, `V2_1`\n\nThe 3DS protocol version applied to the transaction."},"PreferredCardNetwork":{"$ref":"#/components/schemas/PreferredCardNetwork"},"PaymentCategory":{"$ref":"#/components/schemas/PaymentCategory"},"CardInfo":{"$ref":"#/components/schemas/CardInfo"},"AuthenticationResult":{"$ref":"#/components/schemas/AuthenticationResult"}},"title":"PreauthorizationResponse"},"CancelADepositPreauthorizationRequest":{"type":"object","properties":{"PaymentStatus":{"type":"string","description":"**Allowed values:** `CANCELED`\n\nThe payment status of the deposit preauthorization object:\n- `WAITING` – The deposit preauthorization can be used: the preauthorized funds can be captured (if `Status` is `SUCCEEDED`) or the preauthorization can be canceled manually.\n- `CANCELED` – Value to pass to manually cancel the deposit preauthorization before use; indicates that the deposit preauthorization was canceled manually.\n- `CANCEL_REQUESTED` – The cancellation of the deposit preauthorization has been requested but not yet processed.  \n- `EXPIRED` – The hold period on the preauthorized funds has ended without it being used.  \n- `VALIDATED` – Indicates that the preauthorized funds were captured.\n- `FAILED` – The pay-in against the preauthorization has failed, but a retry may be possible."}},"required":["PaymentStatus"],"title":"CancelADepositPreauthorizationRequest"},"CancelOrValidateAPreauthorizationResponseDebitedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the preauthorized funds.","title":"CancelOrValidateAPreauthorizationResponseDebitedFunds"},"CancelOrValidateAPreauthorizationResponseRemainingFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the remaining preauthorized funds.","title":"CancelOrValidateAPreauthorizationResponseRemainingFunds"},"CancelOrValidateAPreauthorizationResponse":{"type":"object","properties":{"Id":{"type":"string","description":"Max. length: 255 characters\n\nThe unique identifier of the preauthorization."},"Tag":{"$ref":"#/components/schemas/Tag"},"CreationDate":{"$ref":"#/components/schemas/CreationDate"},"AuthorId":{"$ref":"#/components/schemas/AuthorId"},"DebitedFunds":{"$ref":"#/components/schemas/CancelOrValidateAPreauthorizationResponseDebitedFunds","description":"Information about the preauthorized funds."},"RemainingFunds":{"$ref":"#/components/schemas/CancelOrValidateAPreauthorizationResponseRemainingFunds","description":"Information about the remaining preauthorized funds."},"AuthorizationDate":{"type":"integer","description":"Unix timestamp (UTC) of the date and time successful authorization occurred. If authorization failed, the value is `null`."},"Status":{"$ref":"#/components/schemas/AuthorizationStatus"},"PaymentStatus":{"type":"string","description":"**Returned values:** `WAITING`, `CANCELED`, `EXPIRED`, `VALIDATED`\n\nThe status of the preauthorization object:\n- `WAITING` – The remaining preauthorized funds can be captured by making one or several preauthorized pay-ins. Pay-ins can only be made against a preauthorization with the `WAITING` status.\n- `CANCELED` – The preauthorization was canceled manually before any preauthorized pay-ins were made, or it was canceled automatically because the authorization failed.\n- `EXPIRED` – The hold period on the preauthorized funds has ended without any preauthorized pay-ins taking place.\n- `VALIDATED` – During the hold period: Indicates that all the preauthorized funds have been captured (`RemainingFunds` is zero) and no more preauthorized pay-ins can be made. After the hold period: Indicates that at least one capture was made during the hold period."},"ExpirationDate":{"type":"integer","description":"Unix timestamp (UTC) of the date and time the hold period ends and the preauthorized funds are released. At the expiration date, the preauthorization's `PaymentStatus` changes to `EXPIRED` if no captures were made or `VALIDATED` if at least one capture was made."},"PayInId":{"type":"string","description":"The unique identifier of the pay-in."},"ResultCode":{"$ref":"#/components/schemas/ResultCode"},"ResultMessage":{"$ref":"#/components/schemas/ResultMessage"},"SecureMode":{"type":"string","description":"**Returned values:** `DEFAULT`, `FORCE`, `NO_CHOICE`\n\nThe mode applied for the 3DS2 protocol for CB, Visa, and Mastercard. The options are:\n- `DEFAULT` – Requests an exemption to strong customer authentication (SCA), and thus a frictionless payment experience, if allowed by your Mangopay contract and accepted by the issuer.\n- `FORCE` – Requests SCA.\n- `NO_CHOICE` – Leaves the choice to the issuer whether to allow for a frictionless payment experience or to enforce SCA."},"CardId":{"type":"string","description":"The unique identifier of the Card object, obtained during the card registration process."},"SecureModeReturnURL":{"$ref":"#/components/schemas/SecureModeReturnURL"},"SecureModeRedirectURL":{"type":"string","description":"Max. length: 255 characters\n\nThe URL to which to redirect the user to proceed to 3DS2 validation."},"SecureModeNeeded":{"type":"boolean","description":"Whether or not the `SecureMode` was used."},"PaymentType":{"type":"string","description":"**Returned values:** `CARD`\n\nThe payment type of the preauthorization."},"ExecutionType":{"type":"string","description":"**Returned values:** `DIRECT`\n\nThe execution type of the preauthorization."},"StatementDescriptor":{"$ref":"#/components/schemas/StatementDescriptor_22"},"Culture":{"type":"string","description":"**Returned values:** One of the supported languages in the [ISO 639-1 format](/api-reference/overview/data-formats): DE, EN, ES, FR, IT, NL, PL, PT.\n\nThe language in which the payment page is to be displayed."},"SecurityInfo":{"$ref":"#/components/schemas/AVSResult"},"MultiCapture":{"type":"boolean","description":"**Default value:** true\n\nWhether multiple captures are activated for the preauthorization."},"BrowserInfo":{"$ref":"#/components/schemas/BrowserInfo"},"IpAddress":{"$ref":"#/components/schemas/IpAddress"},"Billing":{"$ref":"#/components/schemas/Billing_DefaultsShippingUser_Response"},"Shipping":{"$ref":"#/components/schemas/Shipping_DefaultsBillingUser_Response"},"Requested3DSVersion":{"type":"string","description":"**Returned values:** `V1`, `V2_1`\n\nThe 3DS protocol version to be applied to the transaction."},"Applied3DSVersion":{"type":"string","description":"**Returned values:** `V1`, `V2_1`\n\nThe 3DS protocol version applied to the transaction."},"PreferredCardNetwork":{"$ref":"#/components/schemas/PreferredCardNetwork"},"CardInfo":{"$ref":"#/components/schemas/CardInfo"}},"title":"CancelOrValidateAPreauthorizationResponse"},"ListPreauthorizationsForACardResponseArrayPreauthorizationsItemsPreauthorizationDebitedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the preauthorized funds.","title":"ListPreauthorizationsForACardResponseArrayPreauthorizationsItemsPreauthorizationDebitedFunds"},"ListPreauthorizationsForACardResponseArrayPreauthorizationsItemsPreauthorizationRemainingFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the remaining preauthorized funds.","title":"ListPreauthorizationsForACardResponseArrayPreauthorizationsItemsPreauthorizationRemainingFunds"},"ListPreauthorizationsForACardResponseArrayPreauthorizationsItemsPreauthorization":{"type":"object","properties":{"Id":{"type":"string","description":"The unique identifier of the preauthorization."},"Tag":{"type":"string","description":"Custom data that you can add to this object. For preauthorizations, you can use this parameter to identify corresponding information regarding the user or transaction on your platform."},"CreationDate":{"$ref":"#/components/schemas/CreationDate"},"AuthorId":{"type":"string","description":"The unique identifier of the user at the source of the transaction. In a conversion, both the debited and credited wallets are owned by the author."},"DebitedFunds":{"$ref":"#/components/schemas/ListPreauthorizationsForACardResponseArrayPreauthorizationsItemsPreauthorizationDebitedFunds","description":"Information about the preauthorized funds."},"RemainingFunds":{"$ref":"#/components/schemas/ListPreauthorizationsForACardResponseArrayPreauthorizationsItemsPreauthorizationRemainingFunds","description":"Information about the remaining preauthorized funds."},"AuthorizationDate":{"type":"integer","description":"Unix timestamp (UTC) of the date and time successful authorization occurred. If authorization failed, the value is `null`."},"Status":{"$ref":"#/components/schemas/AuthorizationStatus"},"PaymentStatus":{"type":"string","description":"**Returned values:** `WAITING`, `CANCELED`, `CANCEL_REQUESTED`, `EXPIRED`, `VALIDATED`, `FAILED`\n\nThe payment status of the deposit preauthorization object:\n- `WAITING` – The deposit preauthorization can be used: the preauthorized funds can be captured (if `Status` is `SUCCEEDED`) or the preauthorization can be canceled manually.\n- `CANCELED` – Value to pass to manually cancel the deposit preauthorization before use; indicates that the deposit preauthorization was canceled manually.\n- `CANCEL_REQUESTED` – The cancellation of the deposit preauthorization has been requested but not yet processed.\n- `EXPIRED` – The hold period on the preauthorized funds has ended without it being used.\n- `VALIDATED` – Indicates that the preauthorized funds were captured.\n- `FAILED` – The pay-in against the preauthorization has failed, but a retry may be possible."},"ExpirationDate":{"type":"integer","description":"Unix timestamp (UTC) of the date and time the hold period ends and the preauthorized funds are released. At the expiration date, the preauthorization's `PaymentStatus` changes to `EXPIRED` if no captures were made or `VALIDATED` if at least one capture was made."},"PayInId":{"type":"string","description":"The unique identifier of the first preauthorized pay-in made against the preauthorization."},"ResultMessage":{"$ref":"#/components/schemas/ResultMessage"},"SecureMode":{"type":"string","description":"**Returned values:** `DEFAULT`, `FORCE`, `NO_CHOICE`\n\nThe mode applied for the 3DS2 protocol for CB, Visa, and Mastercard. The options are:\n- `DEFAULT` – Requests an exemption to strong customer authentication (SCA), and thus a frictionless payment experience, if allowed by your Mangopay contract and accepted by the issuer.\n- `FORCE` – Requests SCA.\n- `NO_CHOICE` – Leaves the choice to the issuer whether to allow for a frictionless payment experience or to enforce SCA."},"CardId":{"type":"string","description":"The unique identifier of the Card object, which is returned after updating the Card Registration object with the `RegistrationData`."},"SecureModeReturnURL":{"type":"string","description":"The URL to which users are automatically returned after 3DS2 if it is triggered (i.e., if the `SecureModeNeeded` parameter is set to `true`)."},"SecureModeNeeded":{"type":"boolean","description":"Whether or not the `SecureMode` was used."},"PaymentType":{"type":"string","description":"**Returned values:** `CARD`\n\nThe payment type of the preauthorization."},"ExecutionType":{"type":"string","description":"**Returned values:** `DIRECT`\n\nThe execution type of the preauthorization."},"StatementDescriptor":{"type":"string","description":"Custom description to appear on the user's bank statement along with the platform name. Different banks may show more or less information. See the <a href=\"/bank-statements\">Customizing bank statement references</a> article for details."},"Culture":{"type":"string","description":"**Returned values:** One of the supported languages in the [ISO 639-1 format](/api-reference/overview/data-formats): DE, EN, ES, FR, IT, NL, PL, PT.\n\nThe language in which the payment page is to be displayed."},"SecurityInfo":{"$ref":"#/components/schemas/AVSResult"},"MultiCapture":{"type":"boolean","description":"**Default value:** true\n\nWhether multiple captures are activated for the preauthorization."},"BrowserInfo":{"$ref":"#/components/schemas/BrowserInfo"},"Billing":{"$ref":"#/components/schemas/Billing_DefaultsShippingUser_Response"},"Shipping":{"$ref":"#/components/schemas/Shipping_DefaultsBillingUser_Response"},"Requested3DSVersion":{"type":"string","description":"**Returned values:** `V1`, `V2_1`\n\nThe 3DS protocol version to be applied to the transaction."},"Applied3DSVersion":{"type":"string","description":"**Returned values:** `V1`, `V2_1`\n\nThe 3DS protocol version applied to the transaction."},"PreferredCardNetwork":{"type":"string","description":"**Returned values:** `VISA`, `MASTERCARD`, `CB`, `MAESTRO`\n\nThe card network to use, as chosen by the cardholder, in case of <a href=\"/guides/payment-methods/card/co-branded\">co-branded cards</a>."},"CardInfo":{"$ref":"#/components/schemas/CardInfo"}},"description":"The preauthorization created by the platform.","title":"ListPreauthorizationsForACardResponseArrayPreauthorizationsItemsPreauthorization"},"ListPreauthorizationsForACardResponseArrayPreauthorizationsItems":{"type":"object","properties":{"Preauthorization":{"$ref":"#/components/schemas/ListPreauthorizationsForACardResponseArrayPreauthorizationsItemsPreauthorization","description":"The preauthorization created by the platform."}},"title":"ListPreauthorizationsForACardResponseArrayPreauthorizationsItems"},"ListPreauthorizationsForACardResponse":{"type":"object","properties":{"Array (Preauthorizations)":{"type":"array","items":{"$ref":"#/components/schemas/ListPreauthorizationsForACardResponseArrayPreauthorizationsItems"},"description":"The list of preauthorizations created by the platform."}},"title":"ListPreauthorizationsForACardResponse"},"CreateAPreauthorizedPayInRequestDebitedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"required":["Currency","Amount"],"description":"Information about the debited funds.","title":"CreateAPreauthorizedPayInRequestDebitedFunds"},"CreateAPreauthorizedPayInRequestFees":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"required":["Currency","Amount"],"description":"Information about the fees.","title":"CreateAPreauthorizedPayInRequestFees"},"CreateAPreauthorizedPayInRequest":{"type":"object","properties":{"Tag":{"$ref":"#/components/schemas/Tag"},"AuthorId":{"$ref":"#/components/schemas/AuthorId"},"CreditedUserId":{"$ref":"#/components/schemas/CreditedUserId"},"DebitedFunds":{"$ref":"#/components/schemas/CreateAPreauthorizedPayInRequestDebitedFunds","description":"Information about the debited funds."},"Fees":{"$ref":"#/components/schemas/CreateAPreauthorizedPayInRequestFees","description":"Information about the fees."},"CreditedWalletId":{"type":"string","description":"The unique identifier of the credited wallet."},"PreauthorizationId":{"type":"string","description":"The unique identifier of the preauthorization."}},"required":["DebitedFunds","Fees","CreditedWalletId","PreauthorizationId"],"title":"CreateAPreauthorizedPayInRequest"},"CreateACardDepositPreauthorizationRequestDebitedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"required":["Currency","Amount"],"description":"Information about the preauthorized funds.","title":"CreateACardDepositPreauthorizationRequestDebitedFunds"},"CreateACardDepositPreauthorizationRequest":{"type":"object","properties":{"FlowDescriptor":{"$ref":"#/components/schemas/FlowDescriptorRequest"},"AuthorId":{"$ref":"#/components/schemas/AuthorId"},"DebitedFunds":{"$ref":"#/components/schemas/CreateACardDepositPreauthorizationRequestDebitedFunds","description":"Information about the preauthorized funds."},"CardId":{"type":"string","description":"The unique identifier of the Card object, obtained during the card registration process."},"PreferredCardNetwork":{"$ref":"#/components/schemas/PreferredCardNetwork"},"SecureModeReturnURL":{"$ref":"#/components/schemas/SecureModeReturnURL"},"StatementDescriptor":{"$ref":"#/components/schemas/StatementDescriptor_22"},"Culture":{"type":"string","description":"**Allowed values:** One of the supported languages in the [ISO 639-1 format](/api-reference/overview/data-formats): DE, EN, ES, FR, IT, NL, PL, PT.\n\nThe language in which the payment page is to be displayed."},"BrowserInfo":{"$ref":"#/components/schemas/BrowserInfo"},"IpAddress":{"$ref":"#/components/schemas/IpAddress"},"Billing":{"$ref":"#/components/schemas/Billing_DefaultsShippingUser_Request"},"Shipping":{"$ref":"#/components/schemas/Shipping_DefaultsBillingUser_Request"},"Tag":{"$ref":"#/components/schemas/Tag"},"ProfilingAttemptReference":{"$ref":"#/components/schemas/ProfilingAttemptReference"}},"required":["AuthorId","DebitedFunds","CardId","SecureModeReturnURL","BrowserInfo","IpAddress"],"title":"CreateACardDepositPreauthorizationRequest"},"CardDepositPreauthorizationResponseDebitedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the preauthorized funds.","title":"CardDepositPreauthorizationResponseDebitedFunds"},"CardDepositPreauthorizationResponsePayinsLinked":{"type":"object","properties":{"PayinCaptureId":{"type":"string","description":"The unique identifier of the preauthorized pay-in (capture) made against the deposit preauthorization to debit the preauthorized funds."},"PayinComplementId":{"type":"string","description":"This deprecated parameter is always returned `null`."}},"description":"Information about the deposit preauthorized pay-ins made against the deposit preauthorization.","title":"CardDepositPreauthorizationResponsePayinsLinked"},"CardDepositPreauthorizationResponse":{"type":"object","properties":{"Id":{"$ref":"#/components/schemas/Id"},"CreationDate":{"$ref":"#/components/schemas/CreationDate"},"ExpirationDate":{"type":"integer","description":"Unix timestamp (UTC) of the date and time the hold period ends and the preauthorized funds are released. At the expiration date, the deposit preauthorization's `PaymentStatus` changes to `EXPIRED` if no captures were made."},"AuthorizationDate":{"type":"integer","description":"Unix timestamp (UTC) of the date and time successful authorization occurred. If authorization failed, the value is `null`."},"AuthorId":{"$ref":"#/components/schemas/AuthorId"},"FlowDescriptor":{"$ref":"#/components/schemas/FlowDescriptorResponse"},"DebitedFunds":{"$ref":"#/components/schemas/CardDepositPreauthorizationResponseDebitedFunds","description":"Information about the preauthorized funds."},"Status":{"$ref":"#/components/schemas/AuthorizationStatus"},"PaymentStatus":{"type":"string","description":"**Returned values:** `WAITING`, `CANCELED`, `CANCEL_REQUESTED`, `EXPIRED`, `VALIDATED`, `FAILED`\n\nThe payment status of the deposit preauthorization object:\n- `WAITING` – The deposit preauthorization can be used: the preauthorized funds can be captured (if `Status` is `SUCCEEDED`) or the preauthorization can be canceled manually.\n- `CANCELED` – Value to pass to manually cancel the deposit preauthorization before use; indicates that the deposit preauthorization was canceled manually.\n- `CANCEL_REQUESTED` – The cancellation of the deposit preauthorization has been requested but not yet processed.\n- `EXPIRED` – The hold period on the preauthorized funds has ended without it being used.\n- `VALIDATED` – Indicates that the preauthorized funds were captured.\n- `FAILED` – The pay-in against the preauthorization has failed, but a retry may be possible."},"PayinsLinked":{"$ref":"#/components/schemas/CardDepositPreauthorizationResponsePayinsLinked","description":"Information about the deposit preauthorized pay-ins made against the deposit preauthorization."},"ResultCode":{"$ref":"#/components/schemas/ResultCode"},"ResultMessage":{"$ref":"#/components/schemas/ResultMessage"},"PaymentType":{"type":"string","description":"**Returned values:** `CARD`\n\nThe payment type of the preauthorization."},"ExecutionType":{"type":"string","description":"**Returned values:** `DIRECT`\n\nThe execution type of the preauthorization."},"StatementDescriptor":{"$ref":"#/components/schemas/StatementDescriptor_22"},"Culture":{"type":"string","description":"**Returned values:** One of the supported languages in the [ISO 639-1 format](/api-reference/overview/data-formats): DE, EN, ES, FR, IT, NL, PL, PT.\n\nThe language in which the payment page is to be displayed."},"Shipping":{"$ref":"#/components/schemas/Shipping_DefaultsBillingUser_Response"},"Tag":{"$ref":"#/components/schemas/Tag"},"CardId":{"type":"string","description":"The unique identifier of the Card object, obtained during the card registration process."},"PreferredCardNetwork":{"$ref":"#/components/schemas/PreferredCardNetwork"},"SecureModeReturnURL":{"type":"string","description":"Max. length: 255 characters\n\nThe URL to which users are automatically returned after 3DS2 if it is triggered (i.e., if the `SecureModeNeeded` parameter is set to `true`)."},"SecureModeRedirectURL":{"type":"string","description":"Max. length: 255 characters\n\nThe URL to which to redirect the user to proceed to 3DS2 validation."},"SecureModeNeeded":{"type":"boolean","description":"Whether or not the `SecureMode` was used."},"BrowserInfo":{"$ref":"#/components/schemas/BrowserInfo"},"IpAddress":{"$ref":"#/components/schemas/IpAddress"},"Billing":{"$ref":"#/components/schemas/Billing_DefaultsShippingUser_Response"},"Requested3DSVersion":{"type":"string","description":"**Returned values:** `V1`, `V2_1`\n\nThe 3DS protocol version to be applied to the transaction."},"Applied3DSVersion":{"type":"string","description":"**Returned values:** `V1`, `V2_1`\n\nThe 3DS protocol version applied to the transaction."},"CardInfo":{"$ref":"#/components/schemas/CardInfo"},"AuthenticationResult":{"$ref":"#/components/schemas/AuthenticationResult"}},"description":"Response if Deposit Preauthorization's `PaymentType` is `CARD`.","title":"CardDepositPreauthorizationResponse"},"PayPalDepositPreauthorizationResponseDebitedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the preauthorized funds.","title":"PayPalDepositPreauthorizationResponseDebitedFunds"},"PayPalDepositPreauthorizationResponsePayinsLinked":{"type":"object","properties":{"PayinCaptureId":{"type":"string","description":"The unique identifier of the preauthorized pay-in (capture) made against the deposit preauthorization to debit the preauthorized funds."},"PayinComplementId":{"type":"string","description":"This deprecated parameter is always returned `null`."}},"description":"Information about the deposit preauthorized pay-ins made against the deposit preauthorization.","title":"PayPalDepositPreauthorizationResponsePayinsLinked"},"PayPalDepositPreauthorizationResponseTrackingsItems":{"type":"object","properties":{"TrackingNumber":{"type":"string","description":"The shipment's tracking number provided by the carrier."},"Carrier":{"type":"string","description":"The carrier for the shipment. Use the country-specific version of the carrier if it exists, otherwise use its global version."},"NotifyBuyer":{"type":"boolean","description":"**Default value:** false\n\nIf `true`, sends an email notification to the `PaypalBuyerAccountEmail` containing the `TrackingNumber` and `Carrier`, which allows the end user to track their shipment with the carrier."}},"title":"PayPalDepositPreauthorizationResponseTrackingsItems"},"PayPalDepositPreauthorizationResponseLineItemsItems":{"type":"object","properties":{"Name":{"type":"string","description":"The name of the item."},"Quantity":{"type":"integer","description":"The quantity of the item."},"UnitAmount":{"type":"integer","description":"The cost of the item, excluding tax."},"TaxAmount":{"type":"integer","description":"The tax amount applied to the item."},"Description":{"type":"string","description":"The platform's unique reference for the seller. This value must be consistently used for the given seller. You can use, for example, the Mangopay `UserId` or the seller's business name or first name and last name.\n\n**Caution:** Failure to use a unique seller identifier may result in PayPal restricting your service."},"Category":{"type":"string","description":"**Allowed values:** PHYSICAL_GOODS, DIGITAL_GOODS, DONATION\n\nThe category of the item:\n- `PHYSICAL_GOODS` – Tangible items that can be physically shipped and received with proof of delivery upon arrival.\n- `DIGITAL_GOODS` – Products or services that are distributed and consumed via digital platforms or devices.\n- `DONATION` – Voluntary contribution made without any goods or services received in return. Multiple line items can be categorized as `DONATION` within a single transaction, however it is not possible to combine `DONATION` other line item categories within the same transaction."},"Sku":{"type":"string","description":"The SKU or reference for the item on your platform."},"Discount":{"type":"integer","description":"The discount applied to the item, in the smallest currency sub-division."}},"title":"PayPalDepositPreauthorizationResponseLineItemsItems"},"PayPalDepositPreauthorizationResponse":{"type":"object","properties":{"Id":{"$ref":"#/components/schemas/Id"},"CreationDate":{"$ref":"#/components/schemas/CreationDate"},"ExpirationDate":{"type":"integer","description":"Unix timestamp (UTC) of the date and time the hold period ends and the preauthorized funds are released. At the expiration date, the deposit preauthorization's `PaymentStatus` changes to `EXPIRED` if no captures were made."},"AuthorizationDate":{"type":"integer","description":"Unix timestamp (UTC) of the date and time successful authorization occurred. If authorization failed, the value is `null`."},"AuthorId":{"$ref":"#/components/schemas/AuthorId"},"FlowDescriptor":{"$ref":"#/components/schemas/FlowDescriptorResponse"},"DebitedFunds":{"$ref":"#/components/schemas/PayPalDepositPreauthorizationResponseDebitedFunds","description":"Information about the preauthorized funds."},"Status":{"$ref":"#/components/schemas/AuthorizationStatus"},"PaymentStatus":{"type":"string","description":"**Returned values:** `WAITING`, `CANCELED`, `CANCEL_REQUESTED`, `EXPIRED`, `VALIDATED`, `FAILED`\n\nThe payment status of the deposit preauthorization object:\n- `WAITING` – The deposit preauthorization can be used: the preauthorized funds can be captured (if `Status` is `SUCCEEDED`) or the preauthorization can be canceled manually.\n- `CANCELED` – Value to pass to manually cancel the deposit preauthorization before use; indicates that the deposit preauthorization was canceled manually.\n- `CANCEL_REQUESTED` – The cancellation of the deposit preauthorization has been requested but not yet processed.\n- `EXPIRED` – The hold period on the preauthorized funds has ended without it being used.\n- `VALIDATED` – Indicates that the preauthorized funds were captured.\n- `FAILED` – The pay-in against the preauthorization has failed, but a retry may be possible."},"PayinsLinked":{"$ref":"#/components/schemas/PayPalDepositPreauthorizationResponsePayinsLinked","description":"Information about the deposit preauthorized pay-ins made against the deposit preauthorization."},"ResultCode":{"$ref":"#/components/schemas/ResultCode"},"ResultMessage":{"$ref":"#/components/schemas/ResultMessage"},"PaymentType":{"type":"string","description":"**Returned values:** `PAYPAL`\n\nThe payment type of the preauthorization."},"ExecutionType":{"type":"string","description":"**Returned values:** `WEB`\n\nThe execution type of the preauthorization."},"StatementDescriptor":{"$ref":"#/components/schemas/StatementDescriptor"},"Shipping":{"$ref":"#/components/schemas/Shipping_DefaultsBillingUser_Response"},"Tag":{"$ref":"#/components/schemas/Tag"},"ShippingPreference":{"type":"string","description":"**Returned values:** `SET_PROVIDED_ADDRESS`, `GET_FROM_FILE`, `NO_SHIPPING`\n\nInformation about the shipping address behavior on the PayPal payment page:\n- `SET_PROVIDED_ADDRESS` - The `Shipping` parameter becomes required and its values are displayed to the end user, who is not able to modify them.\n- `GET_FROM_FILE` – The `Shipping` parameter is ignored and the end user can choose from registered addresses.\n- `NO_SHIPPING` – No shipping address section is displayed."},"PaypalBuyerAccountEmail":{"type":"string","description":"The email address registered on the PayPal account used to make the payment."},"Reference":{"type":"string","description":"Max. length: 127 characters (truncated after)\n\nThe platform's order reference for the transaction."},"CancelURL":{"type":"string","description":"The URL to which the user is returned after canceling the payment. If not provided, the Cancel button returns the user to the `RedirectURL`."},"PaypalOrderID":{"type":"string","description":"PayPal's unique identifier for the order."},"BuyerCountry":{"type":"string","description":"The country of the buyer."},"BuyerFirstname":{"type":"string","description":"The first name of the buyer."},"BuyerPhone":{"type":"string","description":"The mobile phone number of the buyer."},"BuyerLastname":{"type":"string","description":"The last name of the buyer."},"PaypalPayerID":{"type":"string","description":"The PayPal identifier of the buyer."},"Trackings":{"type":"array","items":{"$ref":"#/components/schemas/PayPalDepositPreauthorizationResponseTrackingsItems"},"description":"Shipping information of the `LineItems` added to the pay-in object."},"LineItems":{"type":"array","items":{"$ref":"#/components/schemas/PayPalDepositPreauthorizationResponseLineItemsItems"},"description":"Information about the items purchased in the transaction. The total of all line items' `UnitAmount` and `TaxAmount` must equal the `DebitedFunds` amount (negative amounts not allowed)."},"Culture":{"type":"string","description":"**Returned values:** One of the supported languages in the [ISO 639-1 format](/api-reference/overview/data-formats): AT, BR, CA, CH, CN, DE, DK, ES, FR, GB, ID, IL, IT, JK, JP, NL, NO, PL, PT, RU, SE, TH, TR, TW, US.\n\nThe language in which the PayPal payment page is to be displayed."},"Billing":{"description":"Returned `null` because the billing address is not applicable to PayPal preauth."},"RedirectURL":{"type":"string","description":"The URL to which to redirect the user to complete the payment.\n\n**Caution:** This variable URL is specific to each payment. You must rely on the returned URL in full (host, path, and queries) and not hardcode any part of it."},"ReturnURL":{"$ref":"#/components/schemas/ReturnURL_255"}},"description":"Response if Deposit Preauthorization's `PaymentType` is `PAYPAL`.","title":"PayPalDepositPreauthorizationResponse"},"DepositPreauthorizationResponse":{"oneOf":[{"$ref":"#/components/schemas/CardDepositPreauthorizationResponse"},{"$ref":"#/components/schemas/PayPalDepositPreauthorizationResponse"}],"title":"DepositPreauthorizationResponse"},"ListDepositPreauthorizationsResponse":{"type":"array","items":{"$ref":"#/components/schemas/DepositPreauthorizationResponse"},"description":"List of deposit preauthorizations created by the platform.","title":"ListDepositPreauthorizationsResponse"},"CreateADepositPreauthorizedPayInRequestDebitedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"required":["Currency","Amount"],"description":"Information about the debited funds.","title":"CreateADepositPreauthorizedPayInRequestDebitedFunds"},"CreateADepositPreauthorizedPayInRequestFees":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"required":["Currency","Amount"],"description":"Information about the fees.","title":"CreateADepositPreauthorizedPayInRequestFees"},"CreateADepositPreauthorizedPayInRequest":{"type":"object","properties":{"AuthorId":{"$ref":"#/components/schemas/AuthorId"},"CreditedWalletId":{"type":"string","description":"The unique identifier of the credited wallet."},"DepositId":{"type":"string","description":"The unique identifier of the deposit preauthorization."},"DebitedFunds":{"$ref":"#/components/schemas/CreateADepositPreauthorizedPayInRequestDebitedFunds","description":"Information about the debited funds."},"Fees":{"$ref":"#/components/schemas/CreateADepositPreauthorizedPayInRequestFees","description":"Information about the fees."},"Tag":{"$ref":"#/components/schemas/Tag"}},"required":["AuthorId","CreditedWalletId","DepositId","DebitedFunds","Fees"],"title":"CreateADepositPreauthorizedPayInRequest"},"CreateAWebCardPayInRequestDebitedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"required":["Currency","Amount"],"description":"Information about the debited funds.","title":"CreateAWebCardPayInRequestDebitedFunds"},"CreateAWebCardPayInRequestFees":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"required":["Currency","Amount"],"description":"Information about the fees.","title":"CreateAWebCardPayInRequestFees"},"CreateAWebCardPayInRequestTemplateUrlOptions":{"type":"object","properties":{"PAYLINEV2":{"type":"string","description":"**Caution:** This customization feature is deprecated and must no longer be used.\n\nThe URL of the corresponding template with the Javascript widget."}},"description":"**Caution:** This customization feature is deprecated and must no longer be used.\n\nThe URL of the SSL page of your customized payment page.","title":"CreateAWebCardPayInRequestTemplateUrlOptions"},"CreateAWebCardPayInRequest":{"type":"object","properties":{"Tag":{"type":"string","description":"Custom data that you can add to this object. For transactions (pay-in, transfer, payout), you can use this parameter to identify corresponding information regarding the user, transaction, or payment methods on your platform."},"AuthorId":{"$ref":"#/components/schemas/AuthorId"},"CreditedUserId":{"$ref":"#/components/schemas/CreditedUserId"},"DebitedFunds":{"$ref":"#/components/schemas/CreateAWebCardPayInRequestDebitedFunds","description":"Information about the debited funds."},"Fees":{"$ref":"#/components/schemas/CreateAWebCardPayInRequestFees","description":"Information about the fees."},"CreditedWalletId":{"type":"string","description":"The unique identifier of the credited wallet."},"FlowDescriptor":{"$ref":"#/components/schemas/FlowDescriptorRequest"},"ReturnURL":{"type":"string","description":"Max length: 220 characters.\n\nThe URL to which the user is returned after the payment, whether the transaction is successful or not."},"TemplateURLOptions":{"$ref":"#/components/schemas/CreateAWebCardPayInRequestTemplateUrlOptions","description":"**Caution:** This customization feature is deprecated and must no longer be used.\n\nThe URL of the SSL page of your customized payment page."},"CardType":{"type":"string","description":"**Allowed values:** `CB_VISA_MASTERCARD`, `AMEX`, `MAESTRO`, `BCMC`.\n\nThe type of the card."},"Culture":{"type":"string","description":"**Allowed values:** One of the supported languages in the [ISO 639-1 format](/api-reference/overview/data-formats): CS, DA, DE, EL, EN, ES, FI, FR, HU, IT, NL, NO, PL, PT, SK, SV.\n\nThe language in which the payment page is to be displayed."},"SecureMode":{"type":"string","description":"**Allowed values:** `DEFAULT`, `FORCE`, `NO_CHOICE`\n\n**Default value:** `DEFAULT`\n\nThe mode applied for the 3DS2 protocol for CB, Visa, and Mastercard. The options are:\n- `DEFAULT` – Requests an exemption to strong customer authentication (SCA), and thus a frictionless payment experience, if allowed by your Mangopay contract and accepted by the issuer.\n- `FORCE` – Requests SCA.\n- `NO_CHOICE` – Leaves the choice to the issuer whether to allow for a frictionless payment experience or to enforce SCA."},"Billing":{"$ref":"#/components/schemas/Billing_DefaultsShippingUser_Request"},"Shipping":{"$ref":"#/components/schemas/Shipping_DefaultsBillingUser_Request"},"StatementDescriptor":{"$ref":"#/components/schemas/StatementDescriptor_22"},"ProfilingAttemptReference":{"$ref":"#/components/schemas/ProfilingAttemptReference"},"Bic":{"type":["string","null"],"description":"**Deprecated.** **Allowed values:** The BIC of a <a href=\"/guides/payment-methods/ideal\">bank supported by iDEAL</a>.\n\nThe bank identifier code (BIC) of the user's bank. If provided, the user is redirected to the bank's interface to log in and authenticate the payment. If not provided, the user is redirected to an intermediary page where they must choose their bank.\n\nThis field was used by legacy iDEAL integrations and is still accepted by the API for backwards compatibility. New integrations should use the dedicated <a href=\"/api-reference/ideal/create-ideal-payin\">Create an iDEAL PayIn</a> endpoint instead.\n\n**Note:** Parameter not returned – the `BankName` is returned instead.","deprecated":true}},"required":["AuthorId","DebitedFunds","Fees","CreditedWalletId","ReturnURL","CardType","Culture"],"title":"CreateAWebCardPayInRequest"},"ViewCardDetailsForAWebCardPayInResponse":{"type":"object","properties":{"Id":{"$ref":"#/components/schemas/Id"},"PaymentType":{"type":"string","description":"**Returned values:** `CARD`\n\nThe payment type of the pay-in."},"ExecutionType":{"type":"string","description":"**Returned values:** `WEB`\n\nThe execution type of the pay-in."},"ExpirationDate":{"type":"string","description":"Format: “MMYY”\n\nThe expiration date of the card."},"Alias":{"type":"string","description":"The card number, partially obfuscated."},"CardType":{"type":"string","description":"**Returned values:** `CB_VISA_MASTERCARD`, `AMEX`, `MAESTRO`, `BCMC`\n\n**Default value:** `CB_VISA_MASTERCARD`\n\nThe type of the card. If not supplied, the default value will be taken into account."},"Country":{"type":"string","description":"Format: ISO-3166-1 alpha-3 three-letter country code (e.g., “FRA”)\n\nThe country of the card (which is the same as the country of the issuer)."},"Fingerprint":{"type":"string","description":"The unique representation of the card number. This string can be used to track the card behavior while keeping the card information confidential."}},"title":"ViewCardDetailsForAWebCardPayInResponse"},"CreateABankWirePayInRequestDeclaredDebitedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"required":["Currency","Amount"],"description":"Information about the declared funds to be wired by the end user to the returned bank account.","title":"CreateABankWirePayInRequestDeclaredDebitedFunds"},"CreateABankWirePayInRequestDeclaredFees":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"required":["Currency","Amount"],"description":"Information about the fees to be taken by the platform for this transaction (and hence transferred to the Fees Wallet).","title":"CreateABankWirePayInRequestDeclaredFees"},"CreateABankWirePayInRequest":{"type":"object","properties":{"Tag":{"$ref":"#/components/schemas/Tag"},"AuthorId":{"$ref":"#/components/schemas/AuthorId"},"CreditedUserId":{"$ref":"#/components/schemas/CreditedUserId"},"CreditedWalletId":{"type":"string","description":"The unique identifier of the credited wallet."},"FlowDescriptor":{"$ref":"#/components/schemas/FlowDescriptorRequest"},"DeclaredDebitedFunds":{"$ref":"#/components/schemas/CreateABankWirePayInRequestDeclaredDebitedFunds","description":"Information about the declared funds to be wired by the end user to the returned bank account."},"DeclaredFees":{"$ref":"#/components/schemas/CreateABankWirePayInRequestDeclaredFees","description":"Information about the fees to be taken by the platform for this transaction (and hence transferred to the Fees Wallet)."},"ProfilingAttemptReference":{"$ref":"#/components/schemas/ProfilingAttemptReference"}},"required":["AuthorId","CreditedWalletId","DeclaredDebitedFunds","DeclaredFees"],"title":"CreateABankWirePayInRequest"},"Country_VirtualAccount_Availability_Response":{"type":"string","description":"**Returned values:** One of the supported countries in two-letter <a href=\"/api-reference/overview/data-formats\">ISO 3166-1</a> format\n\nThe country of the account purpose.","title":"Country_VirtualAccount_Availability_Response"},"Available_VirtualAccount_Availability_Response":{"type":"boolean","description":"Whether or not the account is available for the given country and purpose.","title":"Available_VirtualAccount_Availability_Response"},"Currencies_VirtualAccount_Availability_Response":{"type":"array","items":{"type":"string"},"description":"**Returned values:** One or more currency codes in <a href=\"/api-reference/overview/data-formats\" target=\"_blank\">ISO 4217</a> format (EUR, GBP, etc.)\n\nList of currencies supported by the account.","title":"Currencies_VirtualAccount_Availability_Response"},"VirtualAccountAvailabilityItem":{"type":"object","properties":{"Country":{"$ref":"#/components/schemas/Country_VirtualAccount_Availability_Response"},"Available":{"$ref":"#/components/schemas/Available_VirtualAccount_Availability_Response"},"Currencies":{"$ref":"#/components/schemas/Currencies_VirtualAccount_Availability_Response"}},"title":"VirtualAccountAvailabilityItem"},"ViewVirtualAccountAvailabilitiesResponse":{"type":"object","properties":{"Collection":{"type":"array","items":{"$ref":"#/components/schemas/VirtualAccountAvailabilityItem"},"description":"List of account capabilities for the account purpose and their availability for the platform."},"UserOwned":{"type":"array","items":{"$ref":"#/components/schemas/VirtualAccountAvailabilityItem"},"description":"List of account capabilities for the account purpose and their availability for the platform."}},"title":"ViewVirtualAccountAvailabilitiesResponse"},"Country_VirtualAccount_Request":{"type":"string","description":"**Allowed values:** The two-letter <a href=\"/api-reference/overview/data-formats\">ISO 3166-1</a> country code (LU, FR, GB, etc.) of an <a href=\"/guides/payment-methods/banking/virtual-iban\">available country</a> (depends on contract and activation settings): `AU`, `CA`, `DK`, `DE`, `ES`, `FR`, `GB`, `LI`, `LU`, `US`\n\nThe country of the Virtual Account. The country must correspond to the currency of the wallet. See the <a href=\"/guides/payment-methods/banking/virtual-iban\">virtual account</a> guide for details.","title":"Country_VirtualAccount_Request"},"VirtualAccountPurpose_VirtualAccount_Request":{"type":"string","description":"**Allowed values:** `COLLECTION`, `USER_OWNED`\n\nThe type of the virtual account:\n- `COLLECTION` - Owned by Mangopay and usable by platforms and/or users for the purpose of collecting and reconciling incoming funds paid by users.\n- `USER_OWNED` - Owned by the wallet owner, enabling them to accept and store funds and make payments. Offering User-Owned Accounts requires your platform to sign the [VOP](/guides/vop) contract amendment.\n\nFor more information, see the [virtual account](/guides/payment-methods/banking/virtual-iban) guide.","title":"VirtualAccountPurpose_VirtualAccount_Request"},"CreateAVirtualAccountRequest":{"type":"object","properties":{"Country":{"$ref":"#/components/schemas/Country_VirtualAccount_Request"},"VirtualAccountPurpose":{"$ref":"#/components/schemas/VirtualAccountPurpose_VirtualAccount_Request"},"Tag":{"$ref":"#/components/schemas/Tag"}},"required":["Country","VirtualAccountPurpose"],"title":"CreateAVirtualAccountRequest"},"Tag_VirtualAccount_Response":{"type":["string","null"],"description":"Max. length: 255 characters\n\nCustom data that you can add to this object.","title":"Tag_VirtualAccount_Response"},"WalletId_VirtualAccount_Response":{"type":"string","description":"The unique identifier of the wallet.","title":"WalletId_VirtualAccount_Response"},"VirtualAccountPurpose_VirtualAccount_Response":{"type":"string","description":"**Returned values:** `COLLECTION`, `USER_OWNED`\n\nThe type of the virtual account:\n- `COLLECTION` - Owned by Mangopay and usable by platforms and/or users for the purpose of collecting and reconciling incoming funds paid by users.\n- `USER_OWNED` - Owned by the wallet owner, enabling them to accept and store funds and make payments. Offering User-Owned Accounts requires your platform to sign the [VOP](/guides/vop) contract amendment.\n\nFor more information, see the [virtual account](/guides/payment-methods/banking/virtual-iban) guide.","title":"VirtualAccountPurpose_VirtualAccount_Response"},"Status_VirtualAccount_Response":{"type":"string","description":"**Returned values:** `PENDING`, `ACTIVE`, `BLOCKED`, `CLOSED`, `FAILED`\n\nThe status of the Virtual Account:\n- `PENDING` – The account creation request is being processed and full account details may not yet be returned. Any funds sent to the account are returned (if account details exist). `PENDING` can transition to `ACTIVE` or `FAILED`.\n- `ACTIVE` – The account is active and can receive funds (see note about delayed [UK CoP recognition](#set-up-the-account) for `GB` accounts). `ACTIVE` can transition to `BLOCKED` or `CLOSED`.\n- `BLOCKED` – The account is blocked and is not active. Any funds sent to the account are returned. This temporary status may be used during processes relating to user verification or fraud screening. `BLOCKED` can transition to `ACTIVE` or `CLOSED`.\n- `CLOSED` – The account has been deactivated and is closed. Any funds sent to the account are returned. This is a final state.\n- `FAILED` – The account creation request failed or was rejected. This final state is rare. Any funds sent to the account are returned (if account details exist).\n\nSee the [virtual account](/guides/payment-methods/banking/virtual-iban#status) guide for more details.","title":"Status_VirtualAccount_Response"},"Active_VirtualAccount_Response":{"type":"boolean","description":"Whether or not the Virtual Account is active.","title":"Active_VirtualAccount_Response"},"AccountOwner_VirtualAccount_Response":{"type":"string","description":"The owner of the virtual account.\n\nThe account owner is assigned automatically depending on the `VirtualAccountPurpose`:\n- `COLLECTION` – Owned by Mangopay SA or Mangopay UK Ltd., mentioning the platform's trading name in the format \"MGP `PlatformTradingName`\"\n- `USER_OWNED` – Owned by the owner of the associated wallet: `FirstName` `LastName` for Natural Users; `Name` for Legal Users","title":"AccountOwner_VirtualAccount_Response"},"VirtualAccountCapabilities":{"type":"object","properties":{"LocalPayinAvailable":{"type":"boolean","description":"Whether or not local bank wires can be made to this account."},"InternationalPayinAvailable":{"type":"boolean","description":"Whether or not international bank wires can be made to this account.\n\nReturned `false` if `Country` is `US`, `CA`, or `AU`."},"Currencies":{"type":"array","items":{"type":"string"},"description":"**Returned values:** One or more currency codes in <a href=\"/api-reference/overview/data-formats\" target=\"_blank\">ISO 4217</a> format (EUR, GBP, etc.)\n\nList of currencies supported by the account."}},"description":"Information about the account's payment capabilities.","title":"VirtualAccountCapabilities"},"VirtualAccountAddress":{"type":"object","properties":{"StreetName":{"type":["string","null"],"description":"The building number and street name of the address."},"PostCode":{"type":["string","null"],"description":"The postal code of the address."},"TownName":{"type":["string","null"],"description":"The town or city of the address."},"CountrySubDivision":{"type":["string","null"],"description":"The region, state, or county of the address."},"Country":{"type":["string","null"],"description":"Format: Two-letter country code ([ISO 3166-1 alpha-2 format](/api-reference/overview/data-formats))\n\nThe country of the address."}},"description":"The address associated with the account.","title":"VirtualAccountAddress"},"VirtualAccountAccount_AU":{"type":"object","properties":{"BSBCode":{"type":"string","description":"The 6-digit bank state branch (BSB) code of the AU local account."},"AccountNumber":{"type":"string","description":"The 10-digit account number of the AU local account."}},"description":"Details of the account in local AU format. Returned when `Country` is `AU`.","title":"VirtualAccountAccount_AU"},"VirtualAccountLocalDetails_AU":{"type":"object","properties":{"Address":{"$ref":"#/components/schemas/VirtualAccountAddress"},"Account":{"oneOf":[{"$ref":"#/components/schemas/VirtualAccountAccount_AU"},{"type":"null"}]},"BankName":{"type":["string","null"],"description":"The name of the bank."}},"description":"Local account details for `AU` Virtual Accounts.","title":"VirtualAccountLocalDetails_AU"},"VirtualAccount_AU":{"type":"object","properties":{"Id":{"$ref":"#/components/schemas/Id"},"Tag":{"$ref":"#/components/schemas/Tag_VirtualAccount_Response"},"CreationDate":{"$ref":"#/components/schemas/CreationDate"},"WalletId":{"$ref":"#/components/schemas/WalletId_VirtualAccount_Response"},"VirtualAccountPurpose":{"$ref":"#/components/schemas/VirtualAccountPurpose_VirtualAccount_Response"},"Status":{"$ref":"#/components/schemas/Status_VirtualAccount_Response"},"Active":{"$ref":"#/components/schemas/Active_VirtualAccount_Response"},"AccountOwner":{"$ref":"#/components/schemas/AccountOwner_VirtualAccount_Response"},"Capabilities":{"$ref":"#/components/schemas/VirtualAccountCapabilities"},"ResultCode":{"$ref":"#/components/schemas/ResultCode"},"ResultMessage":{"$ref":"#/components/schemas/ResultMessage"},"Country":{"type":"string","description":"**Returned values:** `AU`\n\nThe two-letter ISO 3166-1 country code of the Virtual Account."},"LocalAccountDetails":{"oneOf":[{"$ref":"#/components/schemas/VirtualAccountLocalDetails_AU"},{"type":"null"}],"description":"The account details in local format, populated if `Capabilities.LocalPayinAvailable` is `true`.\n\n**Caution:** Retrieve both the fields and values of these child objects dynamically to present to the user. The `LocalAccountDetails.Account` object has different properties depending on the virtual account `Country`, and these may change over time as Mangopay's coverage expands."},"InternationalAccountDetails":{"description":"Always `null` for `AU` Virtual Accounts because `Capabilities.InternationalPayinAvailable` is always `false`. The account can only accept domestic wire transfers."}},"description":"Australian Virtual Account with `Country` `AU`.\n\n`LocalAccountDetails.Account` uses the AU-specific format (`BSBCode`, `AccountNumber`).\n\n`InternationalAccountDetails` is always `null` because `Capabilities.InternationalPayinAvailable` is always `false`.","title":"VirtualAccount_AU"},"VirtualAccountAccount_CA":{"type":"object","properties":{"BranchCode":{"type":["string","null"],"description":"The 5-digit branch code or transit number of the CA account."},"InstitutionNumber":{"type":["string","null"],"description":"The 3-digit institution number of the CA account."},"AccountNumber":{"type":["string","null"],"description":"The account number of the account."}},"description":"Details of the account in local CA format. Returned when `Country` is `CA`.","title":"VirtualAccountAccount_CA"},"VirtualAccountLocalDetails_CA":{"type":"object","properties":{"Address":{"$ref":"#/components/schemas/VirtualAccountAddress"},"Account":{"oneOf":[{"$ref":"#/components/schemas/VirtualAccountAccount_CA"},{"type":"null"}]},"BankName":{"type":["string","null"],"description":"The name of the bank."}},"description":"Local account details for `CA` Virtual Accounts.","title":"VirtualAccountLocalDetails_CA"},"VirtualAccount_CA":{"type":"object","properties":{"Id":{"$ref":"#/components/schemas/Id"},"Tag":{"$ref":"#/components/schemas/Tag_VirtualAccount_Response"},"CreationDate":{"$ref":"#/components/schemas/CreationDate"},"WalletId":{"$ref":"#/components/schemas/WalletId_VirtualAccount_Response"},"VirtualAccountPurpose":{"$ref":"#/components/schemas/VirtualAccountPurpose_VirtualAccount_Response"},"Status":{"$ref":"#/components/schemas/Status_VirtualAccount_Response"},"Active":{"$ref":"#/components/schemas/Active_VirtualAccount_Response"},"AccountOwner":{"$ref":"#/components/schemas/AccountOwner_VirtualAccount_Response"},"Capabilities":{"$ref":"#/components/schemas/VirtualAccountCapabilities"},"ResultCode":{"$ref":"#/components/schemas/ResultCode"},"ResultMessage":{"$ref":"#/components/schemas/ResultMessage"},"Country":{"type":"string","description":"**Returned values:** `CA`\n\nThe two-letter ISO 3166-1 country code of the Virtual Account."},"LocalAccountDetails":{"oneOf":[{"$ref":"#/components/schemas/VirtualAccountLocalDetails_CA"},{"type":"null"}],"description":"The account details in local format, populated if `Capabilities.LocalPayinAvailable` is `true`.\n\n**Caution:** Retrieve both the fields and values of these child objects dynamically to present to the user. The `LocalAccountDetails.Account` object has different properties depending on the virtual account `Country`, and these may change over time as Mangopay's coverage expands."},"InternationalAccountDetails":{"description":"Always `null` for `CA` Virtual Accounts because `Capabilities.InternationalPayinAvailable` is always `false`."}},"description":"Canadian Virtual Account with `Country` `CA`.\n\n`LocalAccountDetails.Account` uses the CA-specific format (`BranchCode`, `InstitutionNumber`, `AccountNumber`).\n\n`InternationalAccountDetails` is always `null` because `Capabilities.InternationalPayinAvailable` is always `false`.","title":"VirtualAccount_CA"},"VirtualAccountAccount_IBAN":{"type":"object","properties":{"Iban":{"type":"string","description":"The international bank account number (IBAN) of the account."},"Bic":{"type":"string","description":"The bank identifier code (BIC) of the account."}},"description":"Details of the account in local IBAN format. Returned when `Country` is `DE`, `ES`, `FR`, or `LU`.","title":"VirtualAccountAccount_IBAN"},"VirtualAccountLocalDetails_IBAN":{"type":"object","properties":{"Address":{"$ref":"#/components/schemas/VirtualAccountAddress"},"Account":{"oneOf":[{"$ref":"#/components/schemas/VirtualAccountAccount_IBAN"},{"type":"null"}]},"BankName":{"type":["string","null"],"description":"The name of the bank."}},"description":"Local account details for `DE`, `ES`, `FR`, `LU` Virtual Accounts (IBAN format).","title":"VirtualAccountLocalDetails_IBAN"},"VirtualAccountInternationalAccount":{"type":"object","properties":{"Iban":{"type":"string","description":"The international bank account number (IBAN) of the account."},"Bic":{"type":"string","description":"The bank identifier code (BIC) of the account."}},"description":"Details of the account in international (IBAN) format. Returned `null` if `Country` is `US`, `CA`, or `AU` as `Capabilities.InternationalPayinAvailable` is `false` for these countries.","title":"VirtualAccountInternationalAccount"},"VirtualAccountInternationalDetailsItem":{"type":"object","properties":{"Address":{"$ref":"#/components/schemas/VirtualAccountAddress"},"Account":{"oneOf":[{"$ref":"#/components/schemas/VirtualAccountInternationalAccount"},{"type":"null"}]},"BankName":{"type":["string","null"],"description":"The name of the bank."}},"description":"Item in the `InternationalAccountDetails` array (international IBAN format). Not populated for `US`, `CA`, or `AU` Virtual Accounts.","title":"VirtualAccountInternationalDetailsItem"},"VirtualAccount_DE":{"type":"object","properties":{"Id":{"$ref":"#/components/schemas/Id"},"Tag":{"$ref":"#/components/schemas/Tag_VirtualAccount_Response"},"CreationDate":{"$ref":"#/components/schemas/CreationDate"},"WalletId":{"$ref":"#/components/schemas/WalletId_VirtualAccount_Response"},"VirtualAccountPurpose":{"$ref":"#/components/schemas/VirtualAccountPurpose_VirtualAccount_Response"},"Status":{"$ref":"#/components/schemas/Status_VirtualAccount_Response"},"Active":{"$ref":"#/components/schemas/Active_VirtualAccount_Response"},"AccountOwner":{"$ref":"#/components/schemas/AccountOwner_VirtualAccount_Response"},"Capabilities":{"$ref":"#/components/schemas/VirtualAccountCapabilities"},"ResultCode":{"$ref":"#/components/schemas/ResultCode"},"ResultMessage":{"$ref":"#/components/schemas/ResultMessage"},"Country":{"type":"string","description":"**Returned values:** `DE`\n\nThe two-letter ISO 3166-1 country code of the Virtual Account."},"LocalAccountDetails":{"oneOf":[{"$ref":"#/components/schemas/VirtualAccountLocalDetails_IBAN"},{"type":"null"}],"description":"The account details in local format, populated if `Capabilities.LocalPayinAvailable` is `true`.\n\n**Caution:** Retrieve both the fields and values of these child objects dynamically to present to the user. The `LocalAccountDetails.Account` object has different properties depending on the virtual account `Country`, and these may change over time as Mangopay's coverage expands."},"InternationalAccountDetails":{"type":["array","null"],"items":{"$ref":"#/components/schemas/VirtualAccountInternationalDetailsItem"},"description":"List of the account details in international format, populated if `Capabilities.InternationalPayinAvailable` is `true`.\n\n**Best practice:** Retrieve both the fields and values of these child objects dynamically to present to the user. The `InternationalAccountDetails.Account` object may be `null` depending on the virtual account `Country`."}},"description":"German Virtual Account with `Country` `DE`.\n\n`LocalAccountDetails.Account` uses the IBAN format.\n\n`InternationalAccountDetails` is populated if `Capabilities.InternationalPayinAvailable` is `true`.","title":"VirtualAccount_DE"},"VirtualAccountAccount_DK":{"type":"object","properties":{"BankCode":{"type":"string","description":"The 4-digit bank code of the DK local account."},"AccountNumber":{"type":"string","description":"The 10-digit account number of the DK local account."}},"description":"Details of the account in local DK format. Returned when `Country` is `DK`.","title":"VirtualAccountAccount_DK"},"VirtualAccountLocalDetails_DK":{"type":"object","properties":{"Address":{"$ref":"#/components/schemas/VirtualAccountAddress"},"Account":{"oneOf":[{"$ref":"#/components/schemas/VirtualAccountAccount_DK"},{"type":"null"}]},"BankName":{"type":["string","null"],"description":"The name of the bank."}},"description":"Local account details for `DK` Virtual Accounts.","title":"VirtualAccountLocalDetails_DK"},"VirtualAccount_DK":{"type":"object","properties":{"Id":{"$ref":"#/components/schemas/Id"},"Tag":{"$ref":"#/components/schemas/Tag_VirtualAccount_Response"},"CreationDate":{"$ref":"#/components/schemas/CreationDate"},"WalletId":{"$ref":"#/components/schemas/WalletId_VirtualAccount_Response"},"VirtualAccountPurpose":{"$ref":"#/components/schemas/VirtualAccountPurpose_VirtualAccount_Response"},"Status":{"$ref":"#/components/schemas/Status_VirtualAccount_Response"},"Active":{"$ref":"#/components/schemas/Active_VirtualAccount_Response"},"AccountOwner":{"$ref":"#/components/schemas/AccountOwner_VirtualAccount_Response"},"Capabilities":{"$ref":"#/components/schemas/VirtualAccountCapabilities"},"ResultCode":{"$ref":"#/components/schemas/ResultCode"},"ResultMessage":{"$ref":"#/components/schemas/ResultMessage"},"Country":{"type":"string","description":"**Returned values:** `DK`\n\nThe two-letter ISO 3166-1 country code of the Virtual Account."},"LocalAccountDetails":{"oneOf":[{"$ref":"#/components/schemas/VirtualAccountLocalDetails_DK"},{"type":"null"}],"description":"The account details in local format, populated if `Capabilities.LocalPayinAvailable` is `true`.\n\n**Caution:** Retrieve both the fields and values of these child objects dynamically to present to the user. The `LocalAccountDetails.Account` object has different properties depending on the virtual account `Country`, and these may change over time as Mangopay's coverage expands."},"InternationalAccountDetails":{"type":["array","null"],"items":{"$ref":"#/components/schemas/VirtualAccountInternationalDetailsItem"},"description":"List of the account details in international format, populated if `Capabilities.InternationalPayinAvailable` is `true`.\n\n**Best practice:** Retrieve both the fields and values of these child objects dynamically to present to the user. The `InternationalAccountDetails.Account` object may be `null` depending on the virtual account `Country`."}},"description":"Danish Virtual Account with `Country` `DK`.\n\n`LocalAccountDetails.Account` uses the DK-specific format (`BankCode`, `AccountNumber`).\n\n`InternationalAccountDetails` is populated if `Capabilities.InternationalPayinAvailable` is `true`.","title":"VirtualAccount_DK"},"VirtualAccount_ES":{"type":"object","properties":{"Id":{"$ref":"#/components/schemas/Id"},"Tag":{"$ref":"#/components/schemas/Tag_VirtualAccount_Response"},"CreationDate":{"$ref":"#/components/schemas/CreationDate"},"WalletId":{"$ref":"#/components/schemas/WalletId_VirtualAccount_Response"},"VirtualAccountPurpose":{"$ref":"#/components/schemas/VirtualAccountPurpose_VirtualAccount_Response"},"Status":{"$ref":"#/components/schemas/Status_VirtualAccount_Response"},"Active":{"$ref":"#/components/schemas/Active_VirtualAccount_Response"},"AccountOwner":{"$ref":"#/components/schemas/AccountOwner_VirtualAccount_Response"},"Capabilities":{"$ref":"#/components/schemas/VirtualAccountCapabilities"},"ResultCode":{"$ref":"#/components/schemas/ResultCode"},"ResultMessage":{"$ref":"#/components/schemas/ResultMessage"},"Country":{"type":"string","description":"**Returned values:** `ES`\n\nThe two-letter ISO 3166-1 country code of the Virtual Account."},"LocalAccountDetails":{"oneOf":[{"$ref":"#/components/schemas/VirtualAccountLocalDetails_IBAN"},{"type":"null"}],"description":"The account details in local format, populated if `Capabilities.LocalPayinAvailable` is `true`.\n\n**Caution:** Retrieve both the fields and values of these child objects dynamically to present to the user. The `LocalAccountDetails.Account` object has different properties depending on the virtual account `Country`, and these may change over time as Mangopay's coverage expands."},"InternationalAccountDetails":{"type":["array","null"],"items":{"$ref":"#/components/schemas/VirtualAccountInternationalDetailsItem"},"description":"List of the account details in international format, populated if `Capabilities.InternationalPayinAvailable` is `true`.\n\n**Best practice:** Retrieve both the fields and values of these child objects dynamically to present to the user. The `InternationalAccountDetails.Account` object may be `null` depending on the virtual account `Country`."}},"description":"Spanish Virtual Account with `Country` `ES`.\n\n`LocalAccountDetails.Account` uses the IBAN format.\n\n`InternationalAccountDetails` is populated if `Capabilities.InternationalPayinAvailable` is `true`.","title":"VirtualAccount_ES"},"VirtualAccount_FR":{"type":"object","properties":{"Id":{"$ref":"#/components/schemas/Id"},"Tag":{"$ref":"#/components/schemas/Tag_VirtualAccount_Response"},"CreationDate":{"$ref":"#/components/schemas/CreationDate"},"WalletId":{"$ref":"#/components/schemas/WalletId_VirtualAccount_Response"},"VirtualAccountPurpose":{"$ref":"#/components/schemas/VirtualAccountPurpose_VirtualAccount_Response"},"Status":{"$ref":"#/components/schemas/Status_VirtualAccount_Response"},"Active":{"$ref":"#/components/schemas/Active_VirtualAccount_Response"},"AccountOwner":{"$ref":"#/components/schemas/AccountOwner_VirtualAccount_Response"},"Capabilities":{"$ref":"#/components/schemas/VirtualAccountCapabilities"},"ResultCode":{"$ref":"#/components/schemas/ResultCode"},"ResultMessage":{"$ref":"#/components/schemas/ResultMessage"},"Country":{"type":"string","description":"**Returned values:** `FR`\n\nThe two-letter ISO 3166-1 country code of the Virtual Account."},"LocalAccountDetails":{"oneOf":[{"$ref":"#/components/schemas/VirtualAccountLocalDetails_IBAN"},{"type":"null"}],"description":"The account details in local format, populated if `Capabilities.LocalPayinAvailable` is `true`.\n\n**Caution:** Retrieve both the fields and values of these child objects dynamically to present to the user. The `LocalAccountDetails.Account` object has different properties depending on the virtual account `Country`, and these may change over time as Mangopay's coverage expands."},"InternationalAccountDetails":{"type":["array","null"],"items":{"$ref":"#/components/schemas/VirtualAccountInternationalDetailsItem"},"description":"List of the account details in international format, populated if `Capabilities.InternationalPayinAvailable` is `true`.\n\n**Best practice:** Retrieve both the fields and values of these child objects dynamically to present to the user. The `InternationalAccountDetails.Account` object may be `null` depending on the virtual account `Country`."}},"description":"French Virtual Account with `Country` `FR`.\n\n`LocalAccountDetails.Account` uses the IBAN format.\n\n`InternationalAccountDetails` is populated if `Capabilities.InternationalPayinAvailable` is `true`.","title":"VirtualAccount_FR"},"VirtualAccountAccount_GB":{"type":"object","properties":{"AccountNumber":{"type":"string","description":"The account number of the account."},"SortCode":{"type":"string","description":"The sort code of the account."}},"description":"Details of the account in local GB format. Returned when `Country` is `GB`.","title":"VirtualAccountAccount_GB"},"VirtualAccountLocalDetails_GB":{"type":"object","properties":{"Address":{"$ref":"#/components/schemas/VirtualAccountAddress"},"Account":{"oneOf":[{"$ref":"#/components/schemas/VirtualAccountAccount_GB"},{"type":"null"}]},"BankName":{"type":["string","null"],"description":"The name of the bank."}},"description":"Local account details for `GB` Virtual Accounts.","title":"VirtualAccountLocalDetails_GB"},"VirtualAccount_GB":{"type":"object","properties":{"Id":{"$ref":"#/components/schemas/Id"},"Tag":{"$ref":"#/components/schemas/Tag_VirtualAccount_Response"},"CreationDate":{"$ref":"#/components/schemas/CreationDate"},"WalletId":{"$ref":"#/components/schemas/WalletId_VirtualAccount_Response"},"VirtualAccountPurpose":{"$ref":"#/components/schemas/VirtualAccountPurpose_VirtualAccount_Response"},"Status":{"$ref":"#/components/schemas/Status_VirtualAccount_Response"},"Active":{"$ref":"#/components/schemas/Active_VirtualAccount_Response"},"AccountOwner":{"$ref":"#/components/schemas/AccountOwner_VirtualAccount_Response"},"Capabilities":{"$ref":"#/components/schemas/VirtualAccountCapabilities"},"ResultCode":{"$ref":"#/components/schemas/ResultCode"},"ResultMessage":{"$ref":"#/components/schemas/ResultMessage"},"Country":{"type":"string","description":"**Returned values:** `GB`\n\nThe two-letter ISO 3166-1 country code of the Virtual Account."},"LocalAccountDetails":{"oneOf":[{"$ref":"#/components/schemas/VirtualAccountLocalDetails_GB"},{"type":"null"}],"description":"The account details in local format, populated if `Capabilities.LocalPayinAvailable` is `true`.\n\n**Caution:** Retrieve both the fields and values of these child objects dynamically to present to the user. The `LocalAccountDetails.Account` object has different properties depending on the virtual account `Country`, and these may change over time as Mangopay's coverage expands."},"InternationalAccountDetails":{"type":["array","null"],"items":{"$ref":"#/components/schemas/VirtualAccountInternationalDetailsItem"},"description":"List of the account details in international format, populated if `Capabilities.InternationalPayinAvailable` is `true`.\n\n**Best practice:** Retrieve both the fields and values of these child objects dynamically to present to the user. The `InternationalAccountDetails.Account` object may be `null` depending on the virtual account `Country`."}},"description":"United Kingdom (UK) Virtual Account with `Country` `GB`.\n\n`LocalAccountDetails.Account` uses the GB-specific format (`AccountNumber`, `SortCode`).\n\n`InternationalAccountDetails` is populated if `Capabilities.InternationalPayinAvailable` is `true`.","title":"VirtualAccount_GB"},"VirtualAccountAccount_LI":{"type":"object","properties":{"BCNumber":{"type":"string","description":"The 5-digit bank clearing number of the LI local account."},"AccountNumber":{"type":"string","description":"The 12-digit account number of the LI local account."}},"description":"Details of the account in local LI format. Returned when `Country` is `LI`.","title":"VirtualAccountAccount_LI"},"VirtualAccountLocalDetails_LI":{"type":"object","properties":{"Address":{"$ref":"#/components/schemas/VirtualAccountAddress"},"Account":{"oneOf":[{"$ref":"#/components/schemas/VirtualAccountAccount_LI"},{"type":"null"}]},"BankName":{"type":["string","null"],"description":"The name of the bank."}},"description":"Local account details for `LI` Virtual Accounts.","title":"VirtualAccountLocalDetails_LI"},"VirtualAccountInternationalDetailsItem_LI":{"type":"object","properties":{"Address":{"$ref":"#/components/schemas/VirtualAccountAddress"},"Account":{"oneOf":[{"$ref":"#/components/schemas/VirtualAccountAccount_LI"},{"type":"null"}]},"BankName":{"type":["string","null"],"description":"The name of the bank."}},"description":"Item in the `InternationalAccountDetails` array for `LI` Virtual Accounts. `Account` uses the same format as `LocalAccountDetails.Account`.","title":"VirtualAccountInternationalDetailsItem_LI"},"VirtualAccount_LI":{"type":"object","properties":{"Id":{"$ref":"#/components/schemas/Id"},"Tag":{"$ref":"#/components/schemas/Tag_VirtualAccount_Response"},"CreationDate":{"$ref":"#/components/schemas/CreationDate"},"WalletId":{"$ref":"#/components/schemas/WalletId_VirtualAccount_Response"},"VirtualAccountPurpose":{"$ref":"#/components/schemas/VirtualAccountPurpose_VirtualAccount_Response"},"Status":{"$ref":"#/components/schemas/Status_VirtualAccount_Response"},"Active":{"$ref":"#/components/schemas/Active_VirtualAccount_Response"},"AccountOwner":{"$ref":"#/components/schemas/AccountOwner_VirtualAccount_Response"},"Capabilities":{"$ref":"#/components/schemas/VirtualAccountCapabilities"},"ResultCode":{"$ref":"#/components/schemas/ResultCode"},"ResultMessage":{"$ref":"#/components/schemas/ResultMessage"},"Country":{"type":"string","description":"**Returned values:** `LI`\n\nThe two-letter ISO 3166-1 country code of the Virtual Account."},"LocalAccountDetails":{"oneOf":[{"$ref":"#/components/schemas/VirtualAccountLocalDetails_LI"},{"type":"null"}],"description":"The account details in local format, populated if `Capabilities.LocalPayinAvailable` is `true`.\n\n**Caution:** Retrieve both the fields and values of these child objects dynamically to present to the user. The `LocalAccountDetails.Account` object has different properties depending on the virtual account `Country`, and these may change over time as Mangopay's coverage expands."},"InternationalAccountDetails":{"type":["array","null"],"items":{"$ref":"#/components/schemas/VirtualAccountInternationalDetailsItem_LI"},"description":"List of the account details in international format, populated if `Capabilities.InternationalPayinAvailable` is `true`.\n\n**Best practice:** Retrieve both the fields and values of these child objects dynamically to present to the user. For `LI`, `InternationalAccountDetails.Account` uses the same format as `LocalAccountDetails.Account`."}},"description":"Liechtenstein Virtual Account with `Country` `LI`.\n\n`LocalAccountDetails.Account` uses the LI-specific format (`BCNumber`, `AccountNumber`).\n\n`InternationalAccountDetails` is populated if `Capabilities.InternationalPayinAvailable` is `true`. For `LI`, `InternationalAccountDetails.Account` uses the same format as `LocalAccountDetails.Account`.","title":"VirtualAccount_LI"},"VirtualAccount_LU":{"type":"object","properties":{"Id":{"$ref":"#/components/schemas/Id"},"Tag":{"$ref":"#/components/schemas/Tag_VirtualAccount_Response"},"CreationDate":{"$ref":"#/components/schemas/CreationDate"},"WalletId":{"$ref":"#/components/schemas/WalletId_VirtualAccount_Response"},"VirtualAccountPurpose":{"$ref":"#/components/schemas/VirtualAccountPurpose_VirtualAccount_Response"},"Status":{"$ref":"#/components/schemas/Status_VirtualAccount_Response"},"Active":{"$ref":"#/components/schemas/Active_VirtualAccount_Response"},"AccountOwner":{"$ref":"#/components/schemas/AccountOwner_VirtualAccount_Response"},"Capabilities":{"$ref":"#/components/schemas/VirtualAccountCapabilities"},"ResultCode":{"$ref":"#/components/schemas/ResultCode"},"ResultMessage":{"$ref":"#/components/schemas/ResultMessage"},"Country":{"type":"string","description":"**Returned values:** `LU`\n\nThe two-letter ISO 3166-1 country code of the Virtual Account."},"LocalAccountDetails":{"oneOf":[{"$ref":"#/components/schemas/VirtualAccountLocalDetails_IBAN"},{"type":"null"}],"description":"The account details in local format, populated if `Capabilities.LocalPayinAvailable` is `true`.\n\n**Caution:** Retrieve both the fields and values of these child objects dynamically to present to the user. The `LocalAccountDetails.Account` object has different properties depending on the virtual account `Country`, and these may change over time as Mangopay's coverage expands."},"InternationalAccountDetails":{"type":["array","null"],"items":{"$ref":"#/components/schemas/VirtualAccountInternationalDetailsItem"},"description":"List of the account details in international format, populated if `Capabilities.InternationalPayinAvailable` is `true`.\n\n**Best practice:** Retrieve both the fields and values of these child objects dynamically to present to the user. The `InternationalAccountDetails.Account` object may be `null` depending on the virtual account `Country`."}},"description":"Luxembourg Virtual Account with `Country` `LU`.\n\n`LocalAccountDetails.Account` uses the IBAN format.\n\n`InternationalAccountDetails` is populated if `Capabilities.InternationalPayinAvailable` is `true`.","title":"VirtualAccount_LU"},"VirtualAccountAccount_US":{"type":"object","properties":{"AccountNumber":{"type":["string","null"],"description":"The account number of the account."},"AchNumber":{"type":["string","null"],"description":"The 9-digit ACH routing number of the US account."},"FedWireNumber":{"type":["string","null"],"description":"The 9-digit Fedwire (ABA) number of the US account."},"AccountType":{"type":"string","description":"The account type of the US account, which is always `CHECKING`."}},"description":"Details of the account in local US format. Returned when `Country` is `US`.","title":"VirtualAccountAccount_US"},"VirtualAccountLocalDetails_US":{"type":"object","properties":{"Address":{"$ref":"#/components/schemas/VirtualAccountAddress"},"Account":{"oneOf":[{"$ref":"#/components/schemas/VirtualAccountAccount_US"},{"type":"null"}]},"BankName":{"type":["string","null"],"description":"The name of the bank."}},"description":"Local account details for `US` Virtual Accounts.","title":"VirtualAccountLocalDetails_US"},"VirtualAccount_US":{"type":"object","properties":{"Id":{"$ref":"#/components/schemas/Id"},"Tag":{"$ref":"#/components/schemas/Tag_VirtualAccount_Response"},"CreationDate":{"$ref":"#/components/schemas/CreationDate"},"WalletId":{"$ref":"#/components/schemas/WalletId_VirtualAccount_Response"},"VirtualAccountPurpose":{"$ref":"#/components/schemas/VirtualAccountPurpose_VirtualAccount_Response"},"Status":{"$ref":"#/components/schemas/Status_VirtualAccount_Response"},"Active":{"$ref":"#/components/schemas/Active_VirtualAccount_Response"},"AccountOwner":{"$ref":"#/components/schemas/AccountOwner_VirtualAccount_Response"},"Capabilities":{"$ref":"#/components/schemas/VirtualAccountCapabilities"},"ResultCode":{"$ref":"#/components/schemas/ResultCode"},"ResultMessage":{"$ref":"#/components/schemas/ResultMessage"},"Country":{"type":"string","description":"**Returned values:** `US`\n\nThe two-letter ISO 3166-1 country code of the Virtual Account."},"LocalAccountDetails":{"oneOf":[{"$ref":"#/components/schemas/VirtualAccountLocalDetails_US"},{"type":"null"}],"description":"The account details in local format, populated if `Capabilities.LocalPayinAvailable` is `true`.\n\n**Caution:** Retrieve both the fields and values of these child objects dynamically to present to the user. The `LocalAccountDetails.Account` object has different properties depending on the virtual account `Country`, and these may change over time as Mangopay's coverage expands."},"InternationalAccountDetails":{"description":"Always `null` for `US` Virtual Accounts because `Capabilities.InternationalPayinAvailable` is always `false`."}},"description":"United States Virtual Account with `Country` `US`.\n\n`LocalAccountDetails.Account` uses the US-specific format (`AccountNumber`, `AchNumber`, `FedWireNumber`, `AccountType`).\n\n`InternationalAccountDetails` is always `null` because `Capabilities.InternationalPayinAvailable` is always `false`.","title":"VirtualAccount_US"},"VirtualAccountResponse":{"oneOf":[{"$ref":"#/components/schemas/VirtualAccount_AU"},{"$ref":"#/components/schemas/VirtualAccount_CA"},{"$ref":"#/components/schemas/VirtualAccount_DE"},{"$ref":"#/components/schemas/VirtualAccount_DK"},{"$ref":"#/components/schemas/VirtualAccount_ES"},{"$ref":"#/components/schemas/VirtualAccount_FR"},{"$ref":"#/components/schemas/VirtualAccount_GB"},{"$ref":"#/components/schemas/VirtualAccount_LI"},{"$ref":"#/components/schemas/VirtualAccount_LU"},{"$ref":"#/components/schemas/VirtualAccount_US"}],"title":"VirtualAccountResponse"},"Active_VirtualAccount_Deactivate_Request":{"type":"boolean","description":"Whether or not the Virtual Account is active.\n\n**Caution:** Setting this value to `false` permanently closes the account and is irreversible.","title":"Active_VirtualAccount_Deactivate_Request"},"DeactivateAVirtualAccountRequest":{"type":"object","properties":{"Active":{"$ref":"#/components/schemas/Active_VirtualAccount_Deactivate_Request"}},"title":"DeactivateAVirtualAccountRequest"},"ListVirtualAccountsForAWalletResponseArrayVirtualAccountsItems":{"type":"object","properties":{"Object (Virtual Account)":{"$ref":"#/components/schemas/VirtualAccountResponse"}},"title":"ListVirtualAccountsForAWalletResponseArrayVirtualAccountsItems"},"ListVirtualAccountsForAWalletResponse":{"type":"object","properties":{"Array (Virtual Accounts)":{"type":"array","items":{"$ref":"#/components/schemas/ListVirtualAccountsForAWalletResponseArrayVirtualAccountsItems"},"description":"The list of virtual accounts created by the platform."}},"title":"ListVirtualAccountsForAWalletResponse"},"CreateAnIBANBankingAliasRequest":{"type":"object","properties":{"OwnerName":{"type":"string","description":"The owner of the banking alias, which is set automatically by Mangopay since September 15, 2025 ([read more](/guides/vop/payins#banking-alias-categorization)). If the User owning the attached wallet has `UserCategory` of `OWNER` and the `KYCLevel` of `REGULAR`, then the `OwnerName` is set to the `FirstName` and `LastName` values for a [Natural User](/api-reference/users/natural-user-object-sca) or the `Name` value for a [Legal User](/api-reference/users/legal-user-object-sca). In this case, the `VirtualAccountPurpose` in the API response is `USER_OWNED` . If the User is not KYC verified and an `OWNER`, then the `OwnerName` is set to “MGP `PlatformTradingName`\" in standard cases, or else “Mangopay” for Marketplace Payment Extension (MPE) workflows. In this case, the `VirtualAccountPurpose` in the API response is `COLLECTION`. **Caution:** Your platform must ensure that you use the `OwnerName` returned in the API response."},"Country":{"type":"string","description":"**Allowed values:** DE, DK, ES, FR, GB, LU, PL\n\nThe country of the banking alias. The country must correspond to the currency of the wallet."},"Tag":{"$ref":"#/components/schemas/Tag"}},"required":["OwnerName","Country"],"title":"CreateAnIBANBankingAliasRequest"},"SortCodeAccountNumber":{"type":"object","properties":{"SortCode":{"type":"string","description":"The sort code of the banking alias in local format."},"AccountNumber":{"type":"string","description":"The account number of the banking alias in local format."}},"description":"The banking alias details in local format returned if applicable for the `Country` (e.g. `GB`), otherwise `null`","title":"SortCodeAccountNumber"},"CreateAnIBANBankingAliasResponse":{"type":"object","properties":{"OwnerName":{"type":"string","description":"The owner of the banking alias, which is set automatically by Mangopay since September 15, 2025 ([read more](/guides/vop/payins#banking-alias-categorization)). If the User owning the attached wallet has `UserCategory` of `OWNER` and the `KYCLevel` of `REGULAR`, then the `OwnerName` is set to the `FirstName` and `LastName` values for a [Natural User](/api-reference/users/natural-user-object-sca) or the `Name` value for a [Legal User](/api-reference/users/legal-user-object-sca). In this case, the `VirtualAccountPurpose` in the API response is `USER_OWNED`. If the User is not KYC verified and an `OWNER`, then the `OwnerName` is set to “MGP `PlatformTradingName`\" in standard cases, or else “Mangopay” for Marketplace Payment Extension (MPE) workflows. In this case, the `VirtualAccountPurpose` in the API response is `COLLECTION`. **Caution:** Your platform must ensure that you use the `OwnerName` returned in the API response."},"IBAN":{"type":"string","description":"The IBAN (international bank account number) of the banking alias."},"BIC":{"type":"string","description":"The BIC (international identifier of the bank) for the banking alias."},"CreditedUserId":{"type":"string","description":"The unique identifier of the user whose wallet is credited, in other words, the Owner of the wallet for which the alias is created.\n\n**Note:** Once the banking alias is created, it is not possible to change the `CreditedUserId`."},"Country":{"type":"string","description":"**Returned values:** DE, DK, ES, FR, GB, LU, PL\n\nThe country of the banking alias. The country must correspond to the currency of the wallet."},"Tag":{"$ref":"#/components/schemas/Tag"},"CreationDate":{"$ref":"#/components/schemas/CreationDate"},"Active":{"type":"boolean","description":"Whether or not the banking alias is active.\n\n**Caution:** Setting this value to `false` is irreversible."},"Type":{"type":"string","description":"**Returned values:** `IBAN`, `GB`\n\nThe type of banking alias.\n\nThe `GB` value is only returned if the `Country` is `GB`."},"Id":{"$ref":"#/components/schemas/Id"},"WalletId":{"type":"string","description":"The unique identifier of the wallet."},"LocalAccountDetails":{"$ref":"#/components/schemas/SortCodeAccountNumber"}},"title":"CreateAnIBANBankingAliasResponse"},"DeactivateABankingAliasRequest":{"type":"object","properties":{"Active":{"type":"boolean","description":"Whether or not the banking alias is active.\n\n**Caution:** Setting this value to `false` is irreversible."}},"required":["Active"],"title":"DeactivateABankingAliasRequest"},"DeactivateABankingAliasResponse":{"type":"object","properties":{"OwnerName":{"type":"string","description":"The owner of the banking alias, which is set automatically by Mangopay since September 15, 2025 ([read more](/guides/vop/payins#banking-alias-categorization)). If the User owning the attached wallet has `UserCategory` of `OWNER` and the `KYCLevel` of `REGULAR`, then the `OwnerName` is set to the `FirstName` and `LastName` values for a [Natural User](/api-reference/users/natural-user-object-sca) or the `Name` value for a [Legal User](/api-reference/users/legal-user-object-sca). In this case, the `VirtualAccountPurpose` in the API response is `USER_OWNED`. If the User is not KYC verified and an `OWNER`, then the `OwnerName` is set to “MGP `PlatformTradingName`\" in standard cases, or else “Mangopay” for Marketplace Payment Extension (MPE) workflows. In this case, the `VirtualAccountPurpose` in the API response is `COLLECTION`. **Caution:** Your platform must ensure that you use the `OwnerName` returned in the API response."},"IBAN":{"type":"string","description":"The IBAN (international bank account number) of the banking alias."},"BIC":{"type":"string","description":"The BIC (international identifier of the bank) for the banking alias."},"CreditedUserId":{"type":"string","description":"The unique identifier of the user whose wallet is credited, in other words, the Owner of the wallet for which the alias is created.\n\n**Note:** Once the banking alias is created, it is not possible to change the `CreditedUserId`."},"Country":{"type":"string","description":"**Returned values:** DE, DK, ES, FR, GB, LU, PL\n\nThe country of the banking alias. The country must correspond to the currency of the wallet."},"Tag":{"$ref":"#/components/schemas/Tag"},"CreationDate":{"$ref":"#/components/schemas/CreationDate"},"Active":{"type":"boolean","description":"Whether or not the banking alias is active.\n\n**Caution:** Setting this value to `false` is irreversible."},"Type":{"type":"string","description":"**Returned values:** `IBAN`, `GB`\n\nThe type of banking alias.\n\nThe `GB` value is only returned if the `Country` is `GB`."},"Id":{"$ref":"#/components/schemas/Id"},"WalletId":{"type":"string","description":"The unique identifier of the wallet."}},"title":"DeactivateABankingAliasResponse"},"ViewABankingAliasResponse":{"type":"object","properties":{"OwnerName":{"type":"string","description":"The owner of the banking alias, which is set automatically by Mangopay since September 15, 2025 ([read more](/guides/vop/payins#banking-alias-categorization)). If the User owning the attached wallet has `UserCategory` of `OWNER` and the `KYCLevel` of `REGULAR`, then the `OwnerName` is set to the `FirstName` and `LastName` values for a [Natural User](/api-reference/users/natural-user-object-sca) or the `Name` value for a [Legal User](/api-reference/users/legal-user-object-sca). In this case, the `VirtualAccountPurpose` in the API response is `USER_OWNED`. If the User is not KYC verified and an `OWNER`, then the `OwnerName` is set to “MGP `PlatformTradingName`\" in standard cases, or else “Mangopay” for Marketplace Payment Extension (MPE) workflows. In this case, the `VirtualAccountPurpose` in the API response is `COLLECTION`. **Caution:** Your platform must ensure that you use the `OwnerName` returned in the API response."},"IBAN":{"type":"string","description":"The IBAN (international bank account number) of the banking alias."},"BIC":{"type":"string","description":"The BIC (international identifier of the bank) for the banking alias."},"VirtualAccountPurpose":{"type":"string","description":"**Returned values:** `COLLECTION`, `USER_OWNED`\n\nThe type of the virtual account:\n- `COLLECTION` - Owned by Mangopay and usable by platforms and/or users for the purpose of collecting and reconciling incoming funds paid by users.\n- `USER_OWNED` - Owned by the wallet owner, enabling them to accept and store funds and make payments. Offering User-Owned Accounts requires your platform to sign the [VOP](/guides/vop) contract amendment.\n\nFor more information, see the [virtual account](/guides/payment-methods/banking/virtual-iban) guide."},"CreditedUserId":{"type":"string","description":"The unique identifier of the user whose wallet is credited, in other words, the Owner of the wallet for which the alias is created.\n\n**Note:** Once the banking alias is created, it is not possible to change the `CreditedUserId`."},"Country":{"type":"string","description":"**Returned values:** DE, DK, ES, FR, GB, LU, PL\n\nThe country of the banking alias. The country must correspond to the currency of the wallet."},"Tag":{"$ref":"#/components/schemas/Tag"},"CreationDate":{"$ref":"#/components/schemas/CreationDate"},"Active":{"type":"boolean","description":"Whether or not the banking alias is active.\n\n**Caution:** Setting this value to `false` is irreversible."},"Type":{"type":"string","description":"**Returned values:** `IBAN`, `GB`\n\nThe type of banking alias.\n\nThe `GB` value is only returned if the `Country` is `GB`."},"Id":{"$ref":"#/components/schemas/Id"},"WalletId":{"type":"string","description":"The unique identifier of the wallet."},"LocalAccountDetails":{"$ref":"#/components/schemas/SortCodeAccountNumber"}},"title":"ViewABankingAliasResponse"},"ViewABankingAliasForAWalletResponseArrayBankingAliasItemsObjectBankingAlias":{"type":"object","properties":{"OwnerName":{"type":"string","description":"The owner of the banking alias, which is set automatically by Mangopay since September 15, 2025 ([read more](/guides/vop/payins#banking-alias-categorization)). If the User owning the attached wallet has `UserCategory` of `OWNER` and the `KYCLevel` of `REGULAR`, then the `OwnerName` is set to the `FirstName` and `LastName` values for a [Natural User](/api-reference/users/natural-user-object-sca) or the `Name` value for a [Legal User](/api-reference/users/legal-user-object-sca). In this case, the `VirtualAccountPurpose` in the API response is `USER_OWNED`. If the User is not KYC verified and an `OWNER`, then the `OwnerName` is set to “MGP `PlatformTradingName`\" in standard cases, or else “Mangopay” for Marketplace Payment Extension (MPE) workflows. In this case, the `VirtualAccountPurpose` in the API response is `COLLECTION`. **Caution:** Your platform must ensure that you use the `OwnerName` returned in the API response."},"IBAN":{"type":"string","description":"The IBAN (international bank account number) of the banking alias."},"BIC":{"type":"string","description":"The BIC (international identifier of the bank) for the banking alias."},"VirtualAccountPurpose":{"type":"string","description":"**Returned values:** `COLLECTION`, `USER_OWNED`\n\nThe type of the virtual account:\n- `COLLECTION` - Owned by Mangopay and usable by platforms and/or users for the purpose of collecting and reconciling incoming funds paid by users.\n- `USER_OWNED` - Owned by the wallet owner, enabling them to accept and store funds and make payments. Offering User-Owned Accounts requires your platform to sign the [VOP](/guides/vop) contract amendment.\n\nFor more information, see the [virtual account](/guides/payment-methods/banking/virtual-iban) guide."},"LocalAccountDetails":{"$ref":"#/components/schemas/SortCodeAccountNumber"},"CreditedUserId":{"type":"string","description":"The unique identifier of the user whose wallet is credited, in other words, the Owner of the wallet for which the alias is created.\n\n**Note:** Once the banking alias is created, it is not possible to change the `CreditedUserId`."},"Country":{"type":"string","description":"**Returned values:** DE, DK, ES, FR, GB, LU, PL\n\nThe country of the banking alias. The country must correspond to the currency of the wallet."},"Tag":{"type":"string","description":"Custom data that you can add to this object."},"CreationDate":{"$ref":"#/components/schemas/CreationDate"},"Active":{"type":"boolean","description":"Whether or not the banking alias is active.\n\n**Caution:** Setting this value to `false` is irreversible."},"Type":{"type":"string","description":"**Returned values:** `IBAN`, `GB`\n\nThe type of banking alias.\n\nThe `GB` value is only returned if the `Country` is `GB`."},"Id":{"$ref":"#/components/schemas/Id"},"WalletId":{"type":"string","description":"The unique identifier of the wallet."}},"description":"The Banking Alias object created by the platform.","title":"ViewABankingAliasForAWalletResponseArrayBankingAliasItemsObjectBankingAlias"},"ViewABankingAliasForAWalletResponseArrayBankingAliasItems":{"type":"object","properties":{"Object (Banking Alias)":{"$ref":"#/components/schemas/ViewABankingAliasForAWalletResponseArrayBankingAliasItemsObjectBankingAlias","description":"The Banking Alias object created by the platform."}},"title":"ViewABankingAliasForAWalletResponseArrayBankingAliasItems"},"ViewABankingAliasForAWalletResponse":{"type":"object","properties":{"Array (Banking Alias)":{"type":"array","items":{"$ref":"#/components/schemas/ViewABankingAliasForAWalletResponseArrayBankingAliasItems"},"description":"The list of banking aliases created by the platform."}},"title":"ViewABankingAliasForAWalletResponse"},"ViewSupportedBanksForPayByBankResponseSupportedBanksCountriesItemsBanksItems":{"type":"object","properties":{"BankName":{"type":"string","description":"The bank's `BankName` to identify it in the pay-in request."},"Scheme":{"type":"array","items":{"type":"string"},"description":"List of `Scheme` values supported by the bank, which can be presented to the user for selection before submission in the pay-in request."},"Name":{"type":"string","description":"The bank's display name to show to the user for selection."}},"title":"ViewSupportedBanksForPayByBankResponseSupportedBanksCountriesItemsBanksItems"},"ViewSupportedBanksForPayByBankResponseSupportedBanksCountriesItems":{"type":"object","properties":{"Banks":{"type":"array","items":{"$ref":"#/components/schemas/ViewSupportedBanksForPayByBankResponseSupportedBanksCountriesItemsBanksItems"},"description":"List of paginated banks for the country. Display the list of banks for the user to choose before submitting their selection in the [POST Create a Pay by Bank PayIn](/api-reference/pay-by-bank/create-pay-by-bank-payin) request."},"Country":{"type":"string","description":"The `Country` value for the paginated list of `Banks` objects."}},"title":"ViewSupportedBanksForPayByBankResponseSupportedBanksCountriesItems"},"ViewSupportedBanksForPayByBankResponseSupportedBanks":{"type":"object","properties":{"Countries":{"type":"array","items":{"$ref":"#/components/schemas/ViewSupportedBanksForPayByBankResponseSupportedBanksCountriesItems"},"description":"Array of objects listing the paginated `Banks` per `Country`."}},"description":"The supported banks listed by country.","title":"ViewSupportedBanksForPayByBankResponseSupportedBanks"},"ViewSupportedBanksForPayByBankResponse":{"type":"object","properties":{"SupportedBanks":{"$ref":"#/components/schemas/ViewSupportedBanksForPayByBankResponseSupportedBanks","description":"The supported banks listed by country."}},"title":"ViewSupportedBanksForPayByBankResponse"},"CreateAPayByBankPayInRequestDebitedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"required":["Currency","Amount"],"description":"Information about the debited funds.","title":"CreateAPayByBankPayInRequestDebitedFunds"},"CreateAPayByBankPayInRequestFees":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"required":["Currency","Amount"],"description":"Information about the fees.","title":"CreateAPayByBankPayInRequestFees"},"CreateAPayByBankPayInRequest":{"type":"object","properties":{"Tag":{"$ref":"#/components/schemas/Tag"},"AuthorId":{"$ref":"#/components/schemas/AuthorId"},"DebitedFunds":{"$ref":"#/components/schemas/CreateAPayByBankPayInRequestDebitedFunds","description":"Information about the debited funds."},"Fees":{"$ref":"#/components/schemas/CreateAPayByBankPayInRequestFees","description":"Information about the fees."},"CreditedWalletId":{"type":"string","description":"The unique identifier of the credited wallet."},"FlowDescriptor":{"$ref":"#/components/schemas/FlowDescriptorRequest"},"ReturnURL":{"$ref":"#/components/schemas/ReturnURL_255"},"StatementDescriptor":{"$ref":"#/components/schemas/StatementDescriptor"},"Country":{"type":"string","description":"**Allowed values:** `AT`, `DE`, `DK`, `EE`, `ES`, `FI`, `FR`, `GB`, `IE`, `IT`, `LV`, `LT`, `NL`, `NO`, `PL`, `PT`.\n\nThe country of residence of the user."},"BIC":{"type":"string","description":"The BIC of the user's bank account, which is only returned if it was sent.\n\nIf both the `IBAN` and `BIC` are provided, one of the two authentication steps required by certain banks may be avoided."},"IBAN":{"type":"string","description":"The IBAN of the user's bank account, which is only returned if it was sent.\n\nIf both the `IBAN` and `BIC` are provided, one of the two authentication steps required by certain banks may be avoided."},"PaymentFlow":{"type":"string","description":"**Allowed values:** `WEB`, `APP`\n\n**Default value:** `WEB`\n\nThe platform environment of the post-payment flow. The `PaymentFlow` value combines with the `ReturnURL` to manage the redirection behavior after payment:\n- Set the value to `APP` to send the user to your platform's mobile app\n- Set the value to `WEB` to send the user to a web browser\n\nIn both cases you need to provide the relevant `ReturnURL`, whether to your app or website."},"BankName":{"type":"string","description":"**Allowed values:** One of the [supported bank names](/guides/payment-methods/banking/pay-by-bank#banks-and-schemes).\n\nThe name of the bank, which is only returned if it was sent.\n\nIf the `BankName` is provided, the user doesn't have to select their bank when they are redirected."},"Culture":{"type":"string","description":"**Allowed values:** `DA`, `CS`, `DE`, `EN`, `ET`, `ES`, `FI`, `FR`, `IT`, `LT`, `LV`, `NL`, `NO`, `PL`, `PT`, `SV`\n\n**Default value:** `EN`\n\nThe language in which the Tink open banking page is to be displayed."},"Scheme":{"type":"string","description":"**Allowed values:** One of the [supported schemes](/guides/payment-methods/banking/pay-by-bank#banks-and-schemes) for the `Country`.\n\n**Default value:** The [listed instant scheme](/guides/payment-methods/banking/pay-by-bank#banks-and-schemes) for the `Country`. If `Country` is `DK`, there is no default and the `Scheme` must be specified.\n\nThe scheme to use to process the payment. Note that some banks may charge additional fees to the user for instant payment schemes."}},"required":["AuthorId","DebitedFunds","Fees","CreditedWalletId","ReturnURL","Country"],"title":"CreateAPayByBankPayInRequest"},"CreateAMandateRequest":{"type":"object","properties":{"BankAccountId":{"type":"string","description":"The unique identifier of the bank account.\n\n**Warning:** The <a href=\"/api-reference/bank-accounts/bank-account-object\">Bank Account</a> `Type` must be IBAN for the SEPA scheme and GB for the Bacs scheme."},"Culture":{"type":"string","description":"**Allowed values:** One of the supported languages in the [ISO 639-1 format](/api-reference/overview/data-formats): DE, EN, ES, FR, IT, NL, PL\n\nThe language in which the mandate confirmation page is to be displayed. This value only applies to mandates with the SEPA `Scheme`."},"ReturnURL":{"$ref":"#/components/schemas/ReturnURL_220"},"Tag":{"$ref":"#/components/schemas/Tag"}},"required":["BankAccountId","Culture","ReturnURL"],"title":"CreateAMandateRequest"},"MandateResponse":{"type":"object","properties":{"Scheme":{"type":"string","description":"The scheme of the mandate, which is available once the mandate is submitted. The value can be one of the following:\n- BACS – Covers payments in the UK, in GBP only.\n- SEPA – Covers payments in the EU."},"BankAccountId":{"type":"string","description":"The unique identifier of the bank account.\n\n**Warning:** The <a href=\"/api-reference/bank-accounts/bank-account-object\">Bank Account</a> `Type` must be IBAN for the SEPA scheme and GB for the Bacs scheme."},"BankReference":{"type":"string","description":"The banking reference for the Mandate."},"Culture":{"type":"string","description":"**Returned values:** One of the supported languages in the [ISO 639-1 format](/api-reference/overview/data-formats): DE, EN, ES, FR, IT, NL, PL\n\nThe language in which the mandate confirmation page is to be displayed. This value only applies to mandates with the SEPA `Scheme`."},"DocumentURL":{"type":"string","description":"The URL at which the mandate document can be downloaded."},"ReturnURL":{"$ref":"#/components/schemas/ReturnURL_220"},"RedirectURL":{"type":"string","description":"The URL to which to redirect the user to complete the payment.\n\n**Caution:** This variable URL is specific to each payment. You must rely on the returned URL in full (host, path, and queries) and not hardcode any part of it."},"Id":{"$ref":"#/components/schemas/Id"},"CreationDate":{"$ref":"#/components/schemas/CreationDate"},"Status":{"type":"string","description":"**Returned values:** `CREATED`, `SUBMITTED`, `ACTIVE`, `FAILED`, `EXPIRED`\n\nThe status of the mandate:\n- `CREATED` – The mandate has been generated but not yet confirmed.\n- `SUBMITTED` – The mandate has been confirmed and sent to the user's bank, and can be used to request a direct debit pay-in.\n- `ACTIVE` – The mandate has been accepted by the user's bank or successfully used to process a direct debit direct pay-in. Further pay-ins can be requested.\n- `FAILED` – The mandate has been canceled or otherwise failed, and can no longer be used for payments.\n- `EXPIRED` – No payment has been made against the mandate in the last 24 months. It can no longer be used for payments."},"UserId":{"type":"string","description":"The unique identifier of the User (natural or legal) who owns the bank account."},"ExecutionType":{"type":"string","description":"**Returned values:** `WEB`\n\nThe execution type of the mandate."},"MandateType":{"type":"string","description":"The type of the mandate."},"Tag":{"$ref":"#/components/schemas/Tag"},"ResultCode":{"$ref":"#/components/schemas/ResultCode"},"ResultMessage":{"$ref":"#/components/schemas/ResultMessage"}},"title":"MandateResponse"},"ListAllMandatesResponseArrayMandatesItemsObjectMandate":{"type":"object","properties":{"Id":{"$ref":"#/components/schemas/Id"},"CreationDate":{"$ref":"#/components/schemas/CreationDate"},"Status":{"type":"string","description":"**Returned values:** `CREATED`, `SUBMITTED`, `ACTIVE`, `FAILED`, `EXPIRED`\n\nThe status of the mandate:\n- `CREATED` – The mandate has been generated but not yet confirmed.\n- `SUBMITTED` – The mandate has been confirmed and sent to the user's bank, and can be used to request a direct debit pay-in.\n- `ACTIVE` – The mandate has been accepted by the user's bank or successfully used to process a direct debit direct pay-in. Further pay-ins can be requested.\n- `FAILED` – The mandate has been canceled or otherwise failed, and can no longer be used for payments.\n- `EXPIRED` – No payment has been made against the mandate in the last 24 months. It can no longer be used for payments."},"UserId":{"type":"string","description":"The unique identifier of the User (natural or legal) who owns the bank account."},"ExecutionType":{"type":"string","description":"**Returned values:** `WEB`\n\nThe execution type of the mandate."},"Tag":{"type":"string","description":"Custom data that you can add to this object."},"ResultCode":{"$ref":"#/components/schemas/ResultCode"}},"description":"The mandate created by the platform.","title":"ListAllMandatesResponseArrayMandatesItemsObjectMandate"},"ListAllMandatesResponseArrayMandatesItems":{"type":"object","properties":{"Object (Mandate)":{"$ref":"#/components/schemas/ListAllMandatesResponseArrayMandatesItemsObjectMandate","description":"The mandate created by the platform."}},"title":"ListAllMandatesResponseArrayMandatesItems"},"ListAllMandatesResponse":{"type":"object","properties":{"Array (Mandates)":{"type":"array","items":{"$ref":"#/components/schemas/ListAllMandatesResponseArrayMandatesItems"},"description":"The list of mandates created by the platform."}},"title":"ListAllMandatesResponse"},"CreateADirectDebitPayInRequestDebitedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"required":["Currency","Amount"],"description":"Information about the debited funds.","title":"CreateADirectDebitPayInRequestDebitedFunds"},"CreateADirectDebitPayInRequestFees":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"required":["Currency","Amount"],"description":"Information about the fees.","title":"CreateADirectDebitPayInRequestFees"},"CreateADirectDebitPayInRequest":{"type":"object","properties":{"AuthorId":{"$ref":"#/components/schemas/AuthorId"},"CreditedUserId":{"$ref":"#/components/schemas/CreditedUserId"},"CreditedWalletId":{"type":"string","description":"The unique identifier of the credited wallet."},"FlowDescriptor":{"$ref":"#/components/schemas/FlowDescriptorRequest"},"DebitedFunds":{"$ref":"#/components/schemas/CreateADirectDebitPayInRequestDebitedFunds","description":"Information about the debited funds."},"Fees":{"$ref":"#/components/schemas/CreateADirectDebitPayInRequestFees","description":"Information about the fees."},"Tag":{"$ref":"#/components/schemas/Tag"},"MandateId":{"type":"string","description":"The unique identifier of the mandate."},"StatementDescriptor":{"$ref":"#/components/schemas/StatementDescriptor_DD"},"ProfilingAttemptReference":{"$ref":"#/components/schemas/ProfilingAttemptReference"}},"required":["AuthorId","CreditedWalletId","DebitedFunds","Fees","MandateId"],"title":"CreateADirectDebitPayInRequest"},"DeprecatedCreateAWebDirectDebitPayInRequestDebitedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"required":["Currency","Amount"],"description":"Information about the debited funds.","title":"DeprecatedCreateAWebDirectDebitPayInRequestDebitedFunds"},"DeprecatedCreateAWebDirectDebitPayInRequestFees":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"required":["Currency","Amount"],"description":"Information about the fees.","title":"DeprecatedCreateAWebDirectDebitPayInRequestFees"},"DeprecatedCreateAWebDirectDebitPayInRequestTemplateUrlOptions":{"type":"object","properties":{"PaylineV2":{"type":"string","description":"**Caution:** This customization feature is deprecated and must no longer be used.\n\nThe URL of the corresponding template with the Javascript widget."}},"description":"**Caution:** This customization feature is deprecated and must no longer be used.\n\nThe URL of the SSL page of your customized payment page.","title":"DeprecatedCreateAWebDirectDebitPayInRequestTemplateUrlOptions"},"DeprecatedCreateAWebDirectDebitPayInRequest":{"type":"object","properties":{"DirectDebitType":{"type":"string","description":"**Allowed values:** `GIROPAY`, `SOFORT`\n\nThe type of direct debit."},"Tag":{"$ref":"#/components/schemas/Tag"},"AuthorId":{"$ref":"#/components/schemas/AuthorId"},"CreditedUserId":{"$ref":"#/components/schemas/CreditedUserId"},"DebitedFunds":{"$ref":"#/components/schemas/DeprecatedCreateAWebDirectDebitPayInRequestDebitedFunds","description":"Information about the debited funds."},"Fees":{"$ref":"#/components/schemas/DeprecatedCreateAWebDirectDebitPayInRequestFees","description":"Information about the fees."},"CreditedWalletId":{"type":"string","description":"The unique identifier of the credited wallet."},"FlowDescriptor":{"$ref":"#/components/schemas/FlowDescriptorRequest"},"ReturnURL":{"$ref":"#/components/schemas/ReturnURL_220"},"TemplateURLOptions":{"$ref":"#/components/schemas/DeprecatedCreateAWebDirectDebitPayInRequestTemplateUrlOptions","description":"**Caution:** This customization feature is deprecated and must no longer be used.\n\nThe URL of the SSL page of your customized payment page."},"Culture":{"type":"string","description":"**Allowed values:** One of the supported languages in the [ISO 639-1 format](/api-reference/overview/data-formats): CS, DA, DE, EL, EN, ES, FI, FR, HU, IT, NL, NO, PL, PT, SK, SV.\n\nThe language in which the payment page is to be displayed."},"ProfilingAttemptReference":{"$ref":"#/components/schemas/ProfilingAttemptReference"}},"required":["DirectDebitType","AuthorId","DebitedFunds","Fees","CreditedWalletId","ReturnURL","Culture"],"title":"DeprecatedCreateAWebDirectDebitPayInRequest"},"CreateAnApplePayPayInRequestDebitedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"required":["Currency","Amount"],"description":"Information about the debited funds.","title":"CreateAnApplePayPayInRequestDebitedFunds"},"CreateAnApplePayPayInRequestFees":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"required":["Currency","Amount"],"description":"Information about the fees.","title":"CreateAnApplePayPayInRequestFees"},"CreateAnApplePayPayInRequestPaymentData":{"type":"object","properties":{"transactionId":{"type":"string","description":"Apple Pay's unique identifier of the payment."},"network":{"type":"string","description":"The payment network used for the payment request."},"tokenData":{"type":"string","description":"The encrypted string for the payment request."}},"required":["transactionId","network","tokenData"],"description":"The data returned by Apple Pay containing information about the payment.","title":"CreateAnApplePayPayInRequestPaymentData"},"CreateAnApplePayPayInRequest":{"type":"object","properties":{"Tag":{"$ref":"#/components/schemas/Tag"},"AuthorId":{"$ref":"#/components/schemas/AuthorId"},"CreditedWalletId":{"type":"string","description":"The unique identifier of the credited wallet."},"FlowDescriptor":{"$ref":"#/components/schemas/FlowDescriptorRequest"},"DebitedFunds":{"$ref":"#/components/schemas/CreateAnApplePayPayInRequestDebitedFunds","description":"Information about the debited funds."},"Fees":{"$ref":"#/components/schemas/CreateAnApplePayPayInRequestFees","description":"Information about the fees."},"StatementDescriptor":{"$ref":"#/components/schemas/StatementDescriptor_22"},"PaymentData":{"$ref":"#/components/schemas/CreateAnApplePayPayInRequestPaymentData","description":"The data returned by Apple Pay containing information about the payment."},"ProfilingAttemptReference":{"$ref":"#/components/schemas/ProfilingAttemptReference"}},"required":["AuthorId","CreditedWalletId","DebitedFunds","Fees","PaymentData"],"title":"CreateAnApplePayPayInRequest"},"CreateARecurringApplePayPayInCITRequest":{"type":"object","properties":{"RecurringPayinRegistrationId":{"type":"string","description":"The unique identifier of the recurring pay-in registration."},"Tag":{"$ref":"#/components/schemas/Tag"}},"required":["RecurringPayinRegistrationId"],"description":"Request body for an Apple Pay customer-initiated transaction (CIT).","title":"CreateARecurringApplePayPayInCITRequest"},"CreateARecurringApplePayPayInMitRequestDebitedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"required":["Currency","Amount"],"description":"Information about the debited funds. This property overrides the `NextTransactionDebitedFunds` of the Registration, and is **required if** that property is empty.\n\n**Caution:** An amount must be provided in either the Registration's `NextTransactionDebitedFunds` or the pay-in's `DebitedFunds`.","title":"CreateARecurringApplePayPayInMitRequestDebitedFunds"},"CreateARecurringApplePayPayInMitRequestFees":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"required":["Currency","Amount"],"description":"Information about the fees. This property overrides the `NextTransactionFees` of the Registration, and is **required if** that property is empty.\n\n**Caution:** An amount must be provided in either the Registration's `NextTransactionFees` or the pay-in's `Fees`.","title":"CreateARecurringApplePayPayInMitRequestFees"},"CreateARecurringApplePayPayInMITRequest":{"type":"object","properties":{"Tag":{"$ref":"#/components/schemas/Tag"},"DebitedFunds":{"$ref":"#/components/schemas/CreateARecurringApplePayPayInMitRequestDebitedFunds","description":"Information about the debited funds. This property overrides the `NextTransactionDebitedFunds` of the Registration, and is **required if** that property is empty.\n\n**Caution:** An amount must be provided in either the Registration's `NextTransactionDebitedFunds` or the pay-in's `DebitedFunds`."},"Fees":{"$ref":"#/components/schemas/CreateARecurringApplePayPayInMitRequestFees","description":"Information about the fees. This property overrides the `NextTransactionFees` of the Registration, and is **required if** that property is empty.\n\n**Caution:** An amount must be provided in either the Registration's `NextTransactionFees` or the pay-in's `Fees`."},"StatementDescriptor":{"$ref":"#/components/schemas/StatementDescriptor_22"},"RecurringPayinRegistrationId":{"type":"string","description":"The unique identifier of the recurring pay-in registration."}},"required":["DebitedFunds","RecurringPayinRegistrationId"],"description":"Request body for an Apple Pay merchant-initiated transaction (MIT).","title":"CreateARecurringApplePayPayInMITRequest"},"recurringApplePayPayins_create_recurring_apple_pay_payin_Request":{"oneOf":[{"$ref":"#/components/schemas/CreateARecurringApplePayPayInCITRequest"},{"$ref":"#/components/schemas/CreateARecurringApplePayPayInMITRequest"}],"title":"recurringApplePayPayins_create_recurring_apple_pay_payin_Request"},"CreateABancontactPayInRequestDebitedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"required":["Currency","Amount"],"description":"Information about the debited funds.","title":"CreateABancontactPayInRequestDebitedFunds"},"CreateABancontactPayInRequestFees":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"required":["Currency","Amount"],"description":"Information about the fees.","title":"CreateABancontactPayInRequestFees"},"CreateABancontactPayInRequest":{"type":"object","properties":{"Tag":{"$ref":"#/components/schemas/Tag"},"AuthorId":{"$ref":"#/components/schemas/AuthorId"},"DebitedFunds":{"$ref":"#/components/schemas/CreateABancontactPayInRequestDebitedFunds","description":"Information about the debited funds."},"Fees":{"$ref":"#/components/schemas/CreateABancontactPayInRequestFees","description":"Information about the fees."},"CreditedWalletId":{"type":"string","description":"The unique identifier of the credited wallet."},"FlowDescriptor":{"$ref":"#/components/schemas/FlowDescriptorRequest"},"ReturnURL":{"$ref":"#/components/schemas/ReturnURL_255"},"StatementDescriptor":{"$ref":"#/components/schemas/StatementDescriptor"},"Recurring":{"type":"boolean","description":"Whether or not the pay-in forms part of a Bancontact recurring payment flow (not yet available)."},"Culture":{"type":"string","description":"**Allowed values:** One of the supported languages in the ISO 639-1 format: DE, EN, FR, NL\n\n**Default value:** FR\n\nThe language in which the Bancontact payment page is to be displayed."},"PaymentFlow":{"type":"string","description":"**Allowed values:** `WEB`, `APP`\n\n**Default value:** `WEB`\n\nThe platform environment of the post-payment flow. The `PaymentFlow` value combines with the `ReturnURL` to manage the redirection behavior after payment:\n- Set the value to `APP` to send the user to your platform's mobile app\n- Set the value to `WEB` to send the user to a web browser\n\nIn both cases you need to provide the relevant `ReturnURL`, whether to your app or website."}},"required":["AuthorId","DebitedFunds","Fees","CreditedWalletId","ReturnURL"],"title":"CreateABancontactPayInRequest"},"CreateABizumPayInRequestDebitedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"required":["Currency","Amount"],"description":"Information about the debited funds.","title":"CreateABizumPayInRequestDebitedFunds"},"CreateABizumPayInRequestFees":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"required":["Currency","Amount"],"description":"Information about the fees.","title":"CreateABizumPayInRequestFees"},"CreateABizumPayInRequest":{"type":"object","properties":{"Tag":{"$ref":"#/components/schemas/Tag"},"AuthorId":{"$ref":"#/components/schemas/AuthorId"},"DebitedFunds":{"$ref":"#/components/schemas/CreateABizumPayInRequestDebitedFunds","description":"Information about the debited funds."},"Fees":{"$ref":"#/components/schemas/CreateABizumPayInRequestFees","description":"Information about the fees."},"CreditedWalletId":{"type":"string","description":"The unique identifier of the credited wallet."},"FlowDescriptor":{"$ref":"#/components/schemas/FlowDescriptorRequest"},"StatementDescriptor":{"$ref":"#/components/schemas/StatementDescriptor"},"ReturnURL":{"type":"string","description":"Max. length: 255 characters\n\nThe URL to which the user is returned after the payment, whether the transaction is successful or not. Required if `Phone` is not sent."},"Phone":{"type":"string","description":"Format: International E.164 standard (preceded by plus sign and country code, `+34` in Spain); pattern: `^(\\\\+?34)?[6-9][0-9]{8}$`\n\nThe phone number of the end user to which the Bizum push notification is sent to authenticate the transaction.\n\nIf the `Phone` parameter is sent, then `RedirectURL` is not returned and `ReturnURL` is ignored."},"ProfilingAttemptReference":{"$ref":"#/components/schemas/ProfilingAttemptReference"}},"required":["AuthorId","DebitedFunds","Fees","CreditedWalletId"],"title":"CreateABizumPayInRequest"},"CreateAblikPayInWithCodeRequestDebitedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency_PLN"},"Amount":{"$ref":"#/components/schemas/Amount"}},"required":["Currency","Amount"],"description":"Information about the debited funds.","title":"CreateAblikPayInWithCodeRequestDebitedFunds"},"CreateAblikPayInWithCodeRequestFees":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency_PLN"},"Amount":{"$ref":"#/components/schemas/Amount"}},"required":["Currency","Amount"],"description":"Information about the fees.","title":"CreateAblikPayInWithCodeRequestFees"},"CreateAblikPayInWithCodeRequestBrowserInfo":{"type":"object","properties":{"UserAgent":{"type":"string","description":"The exact content of the HTTP User-Agent header."},"JavascriptEnabled":{"type":"boolean","description":"Whether or not the end user's browser has the ability to execute JavaScript."}},"required":["UserAgent","JavascriptEnabled"],"description":"Information about the browser used by the end user (author) to perform the payment.","title":"CreateAblikPayInWithCodeRequestBrowserInfo"},"CreateABLIKPayInWithCodeRequest":{"type":"object","properties":{"AuthorId":{"$ref":"#/components/schemas/AuthorId"},"Tag":{"$ref":"#/components/schemas/Tag"},"CreditedWalletId":{"type":"string","description":"The unique identifier of the credited wallet."},"FlowDescriptor":{"$ref":"#/components/schemas/FlowDescriptorRequest"},"DebitedFunds":{"$ref":"#/components/schemas/CreateAblikPayInWithCodeRequestDebitedFunds","description":"Information about the debited funds."},"Fees":{"$ref":"#/components/schemas/CreateAblikPayInWithCodeRequestFees","description":"Information about the fees."},"ReturnURL":{"$ref":"#/components/schemas/ReturnURL_255"},"StatementDescriptor":{"$ref":"#/components/schemas/StatementDescriptor"},"Code":{"type":"string","description":"The 6-digit code from the user's banking application."},"BrowserInfo":{"$ref":"#/components/schemas/CreateAblikPayInWithCodeRequestBrowserInfo","description":"Information about the browser used by the end user (author) to perform the payment."},"IpAddress":{"$ref":"#/components/schemas/IpAddress"}},"required":["AuthorId","CreditedWalletId","DebitedFunds","Fees","Code","BrowserInfo","IpAddress"],"description":"BLIK pay-in request body including the code generated by the user in their app.","title":"CreateABLIKPayInWithCodeRequest"},"CreateAblikPayInWithoutCodeRequestDebitedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency_PLN"},"Amount":{"$ref":"#/components/schemas/Amount"}},"required":["Currency","Amount"],"description":"Information about the debited funds.","title":"CreateAblikPayInWithoutCodeRequestDebitedFunds"},"CreateAblikPayInWithoutCodeRequestFees":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency_PLN"},"Amount":{"$ref":"#/components/schemas/Amount"}},"required":["Currency","Amount"],"description":"Information about the fees.","title":"CreateAblikPayInWithoutCodeRequestFees"},"CreateABLIKPayInWithoutCodeRequest":{"type":"object","properties":{"AuthorId":{"$ref":"#/components/schemas/AuthorId"},"Tag":{"$ref":"#/components/schemas/Tag"},"CreditedWalletId":{"type":"string","description":"The unique identifier of the credited wallet."},"FlowDescriptor":{"$ref":"#/components/schemas/FlowDescriptorRequest"},"DebitedFunds":{"$ref":"#/components/schemas/CreateAblikPayInWithoutCodeRequestDebitedFunds","description":"Information about the debited funds."},"Fees":{"$ref":"#/components/schemas/CreateAblikPayInWithoutCodeRequestFees","description":"Information about the fees."},"ReturnURL":{"$ref":"#/components/schemas/ReturnURL_255"},"StatementDescriptor":{"$ref":"#/components/schemas/StatementDescriptor"}},"required":["AuthorId","CreditedWalletId","DebitedFunds","Fees","ReturnURL"],"description":"BLIK pay-in request body if the user has previously saved your platform, relying only on redirection.","title":"CreateABLIKPayInWithoutCodeRequest"},"blik_create_blik_payin_Request":{"oneOf":[{"$ref":"#/components/schemas/CreateABLIKPayInWithCodeRequest"},{"$ref":"#/components/schemas/CreateABLIKPayInWithoutCodeRequest"}],"title":"blik_create_blik_payin_Request"},"DeprecatedCreateAGiropayPayInRequestDebitedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"required":["Currency","Amount"],"description":"Information about the debited funds.","title":"DeprecatedCreateAGiropayPayInRequestDebitedFunds"},"DeprecatedCreateAGiropayPayInRequestFees":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"required":["Currency","Amount"],"description":"Information about the fees.","title":"DeprecatedCreateAGiropayPayInRequestFees"},"DeprecatedCreateAGiropayPayInRequest":{"type":"object","properties":{"AuthorId":{"$ref":"#/components/schemas/AuthorId"},"CreditedWalletId":{"type":"string","description":"The unique identifier of the credited wallet."},"DebitedFunds":{"$ref":"#/components/schemas/DeprecatedCreateAGiropayPayInRequestDebitedFunds","description":"Information about the debited funds."},"Fees":{"$ref":"#/components/schemas/DeprecatedCreateAGiropayPayInRequestFees","description":"Information about the fees."},"ReturnURL":{"$ref":"#/components/schemas/ReturnURL_255"},"Tag":{"$ref":"#/components/schemas/Tag"},"StatementDescriptor":{"$ref":"#/components/schemas/StatementDescriptor"},"ProfilingAttemptReference":{"$ref":"#/components/schemas/ProfilingAttemptReference"}},"required":["AuthorId","CreditedWalletId","DebitedFunds","Fees","ReturnURL"],"title":"DeprecatedCreateAGiropayPayInRequest"},"CreateAGooglePayPayInRequestDebitedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"required":["Currency","Amount"],"description":"Information about the debited funds.","title":"CreateAGooglePayPayInRequestDebitedFunds"},"CreateAGooglePayPayInRequestFees":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the fees.","title":"CreateAGooglePayPayInRequestFees"},"CreateAGooglePayPayInRequest":{"type":"object","properties":{"AuthorId":{"$ref":"#/components/schemas/AuthorId"},"CreditedWalletId":{"type":"string","description":"The unique identifier of the credited wallet."},"FlowDescriptor":{"$ref":"#/components/schemas/FlowDescriptorRequest"},"DebitedFunds":{"$ref":"#/components/schemas/CreateAGooglePayPayInRequestDebitedFunds","description":"Information about the debited funds."},"Fees":{"$ref":"#/components/schemas/CreateAGooglePayPayInRequestFees","description":"Information about the fees."},"StatementDescriptor":{"$ref":"#/components/schemas/StatementDescriptor_22"},"Tag":{"$ref":"#/components/schemas/Tag"},"IpAddress":{"$ref":"#/components/schemas/IpAddress"},"SecureModeReturnURL":{"$ref":"#/components/schemas/SecureModeReturnURL"},"SecureMode":{"type":"string","description":"**Allowed values:** `DEFAULT`, `FORCE`, `NO_CHOICE`\n\n**Default value:** `DEFAULT`\n\nThe mode applied for the 3DS2 protocol for CB, Visa, and Mastercard. The options are:\n- `DEFAULT` – Requests an exemption to strong customer authentication (SCA), and thus a frictionless payment experience, if allowed by your Mangopay contract and accepted by the issuer.\n- `FORCE` – Requests SCA.\n- `NO_CHOICE` – Leaves the choice to the issuer whether to allow for a frictionless payment experience or to enforce SCA.        "},"BrowserInfo":{"$ref":"#/components/schemas/BrowserInfo"},"PaymentData":{"type":"string","description":"The data returned by Google Pay containing information about the payment."},"Billing":{"$ref":"#/components/schemas/Billing_DefaultsShippingUser_Request"},"Shipping":{"$ref":"#/components/schemas/Shipping_DefaultsBillingUser_Request"},"ProfilingAttemptReference":{"$ref":"#/components/schemas/ProfilingAttemptReference"}},"required":["AuthorId","CreditedWalletId","DebitedFunds","Fees","IpAddress","SecureModeReturnURL","BrowserInfo","PaymentData"],"title":"CreateAGooglePayPayInRequest"},"CreateARecurringGooglePayPayInCITRequest":{"type":"object","properties":{"Tag":{"$ref":"#/components/schemas/Tag"},"StatementDescriptor":{"$ref":"#/components/schemas/StatementDescriptor_22"},"SecureModeReturnURL":{"$ref":"#/components/schemas/SecureModeReturnURL"},"IpAddress":{"$ref":"#/components/schemas/IpAddress"},"BrowserInfo":{"$ref":"#/components/schemas/BrowserInfo"},"RecurringPayinRegistrationId":{"type":"string","description":"The unique identifier of the recurring pay-in registration."}},"required":["SecureModeReturnURL","IpAddress","BrowserInfo","RecurringPayinRegistrationId"],"description":"Request body for a Google Pay customer-initiated transaction (CIT).","title":"CreateARecurringGooglePayPayInCITRequest"},"CreateARecurringGooglePayPayInMitRequestDebitedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"required":["Currency","Amount"],"description":"Information about the debited funds. This property overrides the `NextTransactionDebitedFunds` of the Registration, and is **required if** that property is empty.\n\n**Caution:** An amount must be provided in either the Registration's `NextTransactionDebitedFunds` or the pay-in's `DebitedFunds`.","title":"CreateARecurringGooglePayPayInMitRequestDebitedFunds"},"CreateARecurringGooglePayPayInMitRequestFees":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"required":["Currency","Amount"],"description":"Information about the fees. This property overrides the `NextTransactionFees` of the Registration, and is **required if** that property is empty.\n\n**Caution:** An amount must be provided in either the Registration's `NextTransactionFees` or the pay-in's `Fees`.","title":"CreateARecurringGooglePayPayInMitRequestFees"},"CreateARecurringGooglePayPayInMITRequest":{"type":"object","properties":{"Tag":{"$ref":"#/components/schemas/Tag"},"DebitedFunds":{"$ref":"#/components/schemas/CreateARecurringGooglePayPayInMitRequestDebitedFunds","description":"Information about the debited funds. This property overrides the `NextTransactionDebitedFunds` of the Registration, and is **required if** that property is empty.\n\n**Caution:** An amount must be provided in either the Registration's `NextTransactionDebitedFunds` or the pay-in's `DebitedFunds`."},"Fees":{"$ref":"#/components/schemas/CreateARecurringGooglePayPayInMitRequestFees","description":"Information about the fees. This property overrides the `NextTransactionFees` of the Registration, and is **required if** that property is empty.\n\n**Caution:** An amount must be provided in either the Registration's `NextTransactionFees` or the pay-in's `Fees`."},"StatementDescriptor":{"$ref":"#/components/schemas/StatementDescriptor_22"},"RecurringPayinRegistrationId":{"type":"string","description":"The unique identifier of the recurring pay-in registration."}},"required":["RecurringPayinRegistrationId"],"description":"Request body for a Google Pay merchant-initiated transaction (MIT).","title":"CreateARecurringGooglePayPayInMITRequest"},"recurringGooglePayPayins_create_recurring_google_pay_payin_Request":{"oneOf":[{"$ref":"#/components/schemas/CreateARecurringGooglePayPayInCITRequest"},{"$ref":"#/components/schemas/CreateARecurringGooglePayPayInMITRequest"}],"title":"recurringGooglePayPayins_create_recurring_google_pay_payin_Request"},"CreateAnIdealPayInRequestDebitedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"required":["Currency","Amount"],"description":"Information about the debited funds.","title":"CreateAnIdealPayInRequestDebitedFunds"},"CreateAnIdealPayInRequestFees":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"required":["Currency","Amount"],"description":"Information about the fees.","title":"CreateAnIdealPayInRequestFees"},"CreateAnIDEALPayInRequest":{"type":"object","properties":{"AuthorId":{"$ref":"#/components/schemas/AuthorId"},"CreditedWalletId":{"type":"string","description":"The unique identifier of the credited wallet."},"FlowDescriptor":{"$ref":"#/components/schemas/FlowDescriptorRequest"},"DebitedFunds":{"$ref":"#/components/schemas/CreateAnIdealPayInRequestDebitedFunds","description":"Information about the debited funds."},"Fees":{"$ref":"#/components/schemas/CreateAnIdealPayInRequestFees","description":"Information about the fees."},"ReturnURL":{"type":"string","description":"Max. length: 255 characters\n\nThe URL to which the user is automatically returned after completing the payment."},"Tag":{"$ref":"#/components/schemas/Tag"},"StatementDescriptor":{"$ref":"#/components/schemas/StatementDescriptor"},"Bic":{"type":"string","description":"**Allowed values:** The BIC of a <a href=\"/guides/payment-methods/ideal\">bank supported by iDEAL</a>\n\nThe bank identifier code (BIC) of the user's bank. If provided, the user is redirected to the bank's interface to log in and authenticate the payment. If not provided, the user is redirected to an intermediary page where they must choose their bank.\n\n**Note:** Parameter not returned – the `BankName` is returned instead."},"ProfilingAttemptReference":{"$ref":"#/components/schemas/ProfilingAttemptReference"}},"required":["AuthorId","CreditedWalletId","DebitedFunds","Fees","ReturnURL"],"title":"CreateAnIDEALPayInRequest"},"CreateAKlarnaPayInRequestDebitedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"required":["Currency","Amount"],"description":"Information about the debited funds.","title":"CreateAKlarnaPayInRequestDebitedFunds"},"CreateAKlarnaPayInRequestFees":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"required":["Currency","Amount"],"description":"Information about the fees.","title":"CreateAKlarnaPayInRequestFees"},"CreateAKlarnaPayInRequestBilling":{"type":"object","properties":{"FirstName":{"type":"string","description":"The first name of the user."},"LastName":{"type":"string","description":"The last name of the user."},"Address":{"$ref":"#/components/schemas/Address_SubPropsRequired"}},"required":["FirstName","LastName","Address"],"description":"Information about the billing address. \n\nThe `Billing.Address.Country` must be the same as the pay-in's `Country` parameter.","title":"CreateAKlarnaPayInRequestBilling"},"CreateAKlarnaPayInRequestShipping":{"type":"object","properties":{"FirstName":{"type":"string","description":"The first name of the user."},"LastName":{"type":"string","description":"The last name of the user."},"Address":{"$ref":"#/components/schemas/Address_SubPropsRequired"}},"required":["FirstName","LastName","Address"],"description":"Information about the end user's shipping address.\n\nThe shipping address `AddressLine1` must be formatted:\n- FR, UK, US: [Number][StreetName], for example: 33 Cavendish Square\n- Rest of EU: [StreetName][Number], for example: De Ruijterkade 7\n\n**Caution:** Failure to follow this formatting may result in an error.\n\nIf no shipping address is sent, Klarna considers it to be the same as the billing address.","title":"CreateAKlarnaPayInRequestShipping"},"CreateAKlarnaPayInRequestLineItemsItems":{"type":"object","properties":{"Name":{"type":"string","description":"The name of the item."},"Quantity":{"type":"integer","description":"The quantity of the item."},"UnitAmount":{"type":"integer","description":"The cost of the item, excluding tax."},"TaxAmount":{"type":"integer","description":"The tax amount applied to the item."},"Sku":{"type":"string","description":"The unique identifier of the line item."},"Category":{"type":"string","description":"Possible values: `DIGITAL_GOODS`, `PHYSICAL_GOODS`, `DISCOUNT`, `SHIPPING_FEE`, `SALES_TAX`, `GIFT_CARD`, `STORE_CREDIT`, `SURCHARGE`\n\nThe category of the item, allowing line items of different types to be distinguished (for example, buyer protection as `DIGITAL_GOODS`)."},"Discount":{"type":"integer","description":"The discount applied to the item."}},"required":["Name","Quantity","UnitAmount"],"title":"CreateAKlarnaPayInRequestLineItemsItems"},"CreateAKlarnaPayInRequest":{"type":"object","properties":{"Tag":{"$ref":"#/components/schemas/Tag"},"AuthorId":{"$ref":"#/components/schemas/AuthorId"},"DebitedFunds":{"$ref":"#/components/schemas/CreateAKlarnaPayInRequestDebitedFunds","description":"Information about the debited funds."},"Fees":{"$ref":"#/components/schemas/CreateAKlarnaPayInRequestFees","description":"Information about the fees."},"CreditedWalletId":{"type":"string","description":"The unique identifier of the credited wallet."},"FlowDescriptor":{"$ref":"#/components/schemas/FlowDescriptorRequest"},"ReturnURL":{"$ref":"#/components/schemas/ReturnURL_255"},"StatementDescriptor":{"$ref":"#/components/schemas/StatementDescriptor"},"Billing":{"$ref":"#/components/schemas/CreateAKlarnaPayInRequestBilling","description":"Information about the billing address. \n\nThe `Billing.Address.Country` must be the same as the pay-in's `Country` parameter."},"Shipping":{"$ref":"#/components/schemas/CreateAKlarnaPayInRequestShipping","description":"Information about the end user's shipping address.\n\nThe shipping address `AddressLine1` must be formatted:\n- FR, UK, US: [Number][StreetName], for example: 33 Cavendish Square\n- Rest of EU: [StreetName][Number], for example: De Ruijterkade 7\n\n**Caution:** Failure to follow this formatting may result in an error.\n\nIf no shipping address is sent, Klarna considers it to be the same as the billing address."},"LineItems":{"type":"array","items":{"$ref":"#/components/schemas/CreateAKlarnaPayInRequestLineItemsItems"},"description":"Information about the items purchased in the transaction. The pay-in `DebitedFunds.Amount` must equal all `LineItems` objects' ((`UnitAmount` + `TaxAmount`) - `Discount`)."},"Country":{"type":"string","description":"Format: Two-letter country code ([ISO 3166-1 alpha-2 format](/api-reference/overview/data-formats))\n\nThe country of residence of the user."},"Culture":{"type":"string","description":"Format: Two-letter language code ([ISO 639-1 alpha-2](/api-reference/overview/data-formats))\n\nThe language in which the Klarna payment page is to be displayed. The `Culture` must match the `Country` to show the checkout page in the desired language. If not, or if `Culture` is not sent, EN is the language by default."},"Email":{"type":"string","description":"Format: A valid email address\n\nThe user's email address."},"Phone":{"type":"string","description":"Format: International E.164 standard (preceded by plus sign and country code)\n\nThe user's mobile phone number. If the phone matches the user's Klarna account, their checkout experience involves one less step."},"AdditionalData":{"type":"string","description":"Format: Serialized JSON object\n\nThe extra merchant data required by Klarna for the transaction, as described in the <a href=\"https://mangopay.com/docs/concepts/payments/payment-methods/klarna\" target=\"_blank\">Klarna</a> guide."},"Reference":{"type":"string","description":"The platform's order reference for the transaction."},"ProfilingAttemptReference":{"$ref":"#/components/schemas/ProfilingAttemptReference"}},"required":["AuthorId","DebitedFunds","Fees","CreditedWalletId","ReturnURL","Billing","LineItems","Country","Email","Reference"],"title":"CreateAKlarnaPayInRequest"},"CreateAnMbwayPayInRequestDebitedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"required":["Currency","Amount"],"description":"Information about the debited funds.","title":"CreateAnMbwayPayInRequestDebitedFunds"},"CreateAnMbwayPayInRequestFees":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"required":["Currency","Amount"],"description":"Information about the fees.","title":"CreateAnMbwayPayInRequestFees"},"CreateAnMBWAYPayInRequest":{"type":"object","properties":{"Tag":{"$ref":"#/components/schemas/Tag"},"AuthorId":{"$ref":"#/components/schemas/AuthorId"},"DebitedFunds":{"$ref":"#/components/schemas/CreateAnMbwayPayInRequestDebitedFunds","description":"Information about the debited funds."},"Fees":{"$ref":"#/components/schemas/CreateAnMbwayPayInRequestFees","description":"Information about the fees."},"CreditedWalletId":{"type":"string","description":"The unique identifier of the credited wallet."},"FlowDescriptor":{"$ref":"#/components/schemas/FlowDescriptorRequest"},"StatementDescriptor":{"$ref":"#/components/schemas/StatementDescriptor"},"Phone":{"type":"string","description":"Format: Country code without plus symbol, followed by hash symbol (#), followed by the number; only numeric characters and hash symbol\n\nThe phone number of the end user to which the MB WAY push notification is sent to authenticate the transaction."},"ProfilingAttemptReference":{"$ref":"#/components/schemas/ProfilingAttemptReference"}},"required":["AuthorId","DebitedFunds","Fees","CreditedWalletId","Phone"],"title":"CreateAnMBWAYPayInRequest"},"CreateAMultibancoPayInRequestDebitedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"required":["Currency","Amount"],"description":"Information about the debited funds.","title":"CreateAMultibancoPayInRequestDebitedFunds"},"CreateAMultibancoPayInRequestFees":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"required":["Currency","Amount"],"description":"Information about the fees.","title":"CreateAMultibancoPayInRequestFees"},"CreateAMultibancoPayInRequest":{"type":"object","properties":{"AuthorId":{"$ref":"#/components/schemas/AuthorId"},"CreditedWalletId":{"type":"string","description":"The unique identifier of the credited wallet."},"FlowDescriptor":{"$ref":"#/components/schemas/FlowDescriptorRequest"},"DebitedFunds":{"$ref":"#/components/schemas/CreateAMultibancoPayInRequestDebitedFunds","description":"Information about the debited funds."},"Fees":{"$ref":"#/components/schemas/CreateAMultibancoPayInRequestFees","description":"Information about the fees."},"ReturnURL":{"$ref":"#/components/schemas/ReturnURL_255"},"Tag":{"$ref":"#/components/schemas/Tag"},"StatementDescriptor":{"$ref":"#/components/schemas/StatementDescriptor"},"ProfilingAttemptReference":{"$ref":"#/components/schemas/ProfilingAttemptReference"}},"required":["AuthorId","CreditedWalletId","DebitedFunds","Fees","ReturnURL"],"title":"CreateAMultibancoPayInRequest"},"CreateAPayconiqPayInRequestDebitedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"required":["Currency","Amount"],"description":"Information about the debited funds.","title":"CreateAPayconiqPayInRequestDebitedFunds"},"CreateAPayconiqPayInRequestFees":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"required":["Currency","Amount"],"description":"Information about the fees.","title":"CreateAPayconiqPayInRequestFees"},"CreateAPayconiqPayInRequest":{"type":"object","properties":{"Tag":{"$ref":"#/components/schemas/Tag"},"AuthorId":{"$ref":"#/components/schemas/AuthorId"},"DebitedFunds":{"$ref":"#/components/schemas/CreateAPayconiqPayInRequestDebitedFunds","description":"Information about the debited funds."},"Fees":{"$ref":"#/components/schemas/CreateAPayconiqPayInRequestFees","description":"Information about the fees."},"CreditedWalletId":{"type":"string","description":"The unique identifier of the credited wallet."},"FlowDescriptor":{"$ref":"#/components/schemas/FlowDescriptorRequest"},"ReturnURL":{"$ref":"#/components/schemas/ReturnURL_255"},"Country":{"type":"string","description":"**Allowed values:** BE, LU\n\nThe country of residence of the user."},"StatementDescriptor":{"$ref":"#/components/schemas/StatementDescriptor"}},"required":["AuthorId","DebitedFunds","Fees","CreditedWalletId","ReturnURL","Country"],"title":"CreateAPayconiqPayInRequest"},"SubmitDataForAPayPalPayInRequest":{"type":"object","properties":{"sender_account_id":{"type":"string","description":"Format: Alphanumeric; example: `A12345N343`\n\nUnique identifier of the sender/buyer account on the marketplace platform."},"sender_first_name":{"type":"string","description":"Format: Alphanumeric; example: `Jane`\n\nFirst name registered with the sender/buyer's marketplace account."},"sender_last_name":{"type":"string","description":"Format: Alphanumeric; example: `Doe`\n\nLast name registered with the sender/buyer's marketplace account."},"sender_email":{"type":"string","description":"Format: E.123 – Email Address; example: `john@example.com`\n\nEmail address registered with the sender/buyer's marketplace account."},"sender_phone":{"type":"string","description":"Format: E.123 - Telephone Number (national notation); example `(042) 1123 4567`\n\nPhone number (national notation) registered with the sender/buyer's marketplace account."},"sender_country_code":{"type":"string","description":"Format: ISO Alpha-2 Country Code; example: `FR`\n\nCountry code registered with the sender/buyer's marketplace account."},"sender_create_date":{"type":"string","description":"Format: ISO 8601 date format; example: `2012-12-09T19:14:55.277-0:00`\n\nDate of creation of the sender/buyer's account on the marketplace platform."},"sender_signup_ip":{"type":"string","description":"Format: IP (IPv4 / IPv6); example: `10.220.90.20`\n\nIP address that the sender/buyer used to sign up on the marketplace platform."},"sender_popularity_score":{"type":"string","description":"Possible values: `high`, `medium`, `low`; example: `high`\n\nRisk-based scoring on the sender/buyer by the marketplace platform (e.g., social score, identity score, risk score). This score is likely unique for each platform based on marketplace platform's risk platform capabilities."},"receiver_account_id":{"type":"string","description":"Format: Alphanumeric; example: `A12345N343`\n\nUnique identifier of the seller/recipient's account on the marketplace platform."},"receiver_create_date":{"type":"string","description":"Format: ISO 8601 date format; example: `2012-12-09T19:14:55.277-0:00`\n\nDate of creation of the seller/recipient's account on the marketplace platform."},"receiver_email":{"type":"string","description":"Format: E.123 – Email Address; example: `john@example.com`\n\nSeller/recipient's registered email on the marketplace platform."},"receiver_address_country_code":{"type":"string","description":"Format: ISO Alpha-2 Country Code; example: `FR`\n\nSeller/recipient's country code registered on the marketplace platform."},"business_name":{"type":"string","description":"Format: Alphanumeric; example: `Acme Corp.`\n\nBusiness name used by the seller/recipient to register on the marketplace platform."},"recipient_popularity_score":{"type":"string","description":"Possible values: `high`, `medium`, `low`; example: `high`\n\nRisk-based scoring on the seller/recipient by the marketplace platform (e.g., social score, identity score, risk score). This score is likely unique for each platform based on marketplace platform's risk platform capabilities."},"first_interaction_date":{"type":"string","description":"Format: ISO 8601 date format; example: `2012-12-09T 19:14:55.277-0:00`\n\nDate of the first interaction between the sender and receiver on the marketplace platform. Definition of 'interaction' is to be defined by the marketplace platform. Examples are: first transaction attempt between sender and receiver, add friend date between sender and receiver, etc."},"txn_count_total":{"type":"string","description":"Format: Integer; example: `34`\n\nTotal number of transactions the sender/buyer has had to date on the marketplace platform (through PayPal or otherwise)."},"vertical":{"type":"string","description":"Format: Alphanumeric; examples: `household goods`, `shoes`, `clothing`, `tickets`, etc.\n\nTransaction level vertical flag for the seller/receiver's transactions that are in several verticals."},"transaction_is_tangible":{"type":"string","description":"Possible values: `0`, `1`; example: `0`\n\nThe seller/receiver's transaction is for tangible rather than digital goods. If tangible, value = 1. If intangible, value = 0."}},"title":"SubmitDataForAPayPalPayInRequest"},"SubmitDataForAPayPalPayInResponse":{"type":"object","properties":{"DataCollectionId":{"type":"string","description":"The unique identifier of the Data Collection object.\n\nA new `DataCollectionId` is needed for each call to:\n- [POST Create a PayPal PayIn](/api-reference/paypal/create-paypal-payin)\n- [POST Create a Recurring PayPal PayIn](/api-reference/paypal/create-recurring-paypal-payin), with both the CIT and MIT payloads\n- [POST Create a PayPal Deposit Preauthorization](/api-reference/deposit-preauthorizations/create-paypal-deposit-preauthorization)"}},"title":"SubmitDataForAPayPalPayInResponse"},"ViewDataSubmittedForAPayPalPayInResponse":{"type":"object","properties":{"business_name":{"type":"string","description":"Format: Alphanumeric; example: `Acme Corp.`\n\nBusiness name used by the seller/recipient to register on the marketplace platform."},"first_interaction_date":{"type":"string","description":"Format: ISO 8601 date format; example: `2012-12-09T 19:14:55.277-0:00`\n\nDate of the first interaction between the sender and receiver on the marketplace platform. Definition of 'interaction' is to be defined by the marketplace platform. Examples are: first transaction attempt between sender and receiver, add friend date between sender and receiver, etc."},"sender_phone":{"type":"string","description":"Format: E.123 - Telephone Number (national notation); example `(042) 1123 4567`\n\nPhone number (national notation) registered with the sender/buyer's marketplace account."},"receiver_create_date":{"type":"string","description":"Format: ISO 8601 date format; example: `2012-12-09T19:14:55.277-0:00`\n\nDate of creation of the seller/recipient's account on the marketplace platform."},"receiver_address_country_code":{"type":"string","description":"Format: ISO Alpha-2 Country Code; example: `FR`\n\nSeller/recipient's country code registered on the marketplace platform."},"rcs":{"type":"string","description":"The `rcs` returned by PayPal."},"stc":{"type":"string","description":"The `stc` returned by PayPal."},"sender_create_date":{"type":"string","description":"Format: ISO 8601 date format; example: `2012-12-09T19:14:55.277-0:00`\n\nDate of creation of the sender/buyer's account on the marketplace platform."},"transaction_is_tangible":{"type":"string","description":"Possible values: `0`, `1`; example: `0`\n\nThe seller/receiver's transaction is for tangible rather than digital goods. If tangible, value = 1. If intangible, value = 0."},"receiver_email":{"type":"string","description":"Format: E.123 – Email Address; example: `john@example.com`\n\nSeller/recipient's registered email on the marketplace platform."},"vertical":{"type":"string","description":"Format: Alphanumeric; examples: `household goods`, `shoes`, `clothing`, `tickets`, etc.\n\nTransaction level vertical flag for the seller/receiver's transactions that are in several verticals."},"sender_country_code":{"type":"string","description":"Format: ISO Alpha-2 Country Code; example: `FR`\n\nCountry code registered with the sender/buyer's marketplace account."},"txn_count_total":{"type":"string","description":"Format: Integer; example: `34`\n\nTotal number of transactions the sender/buyer has had to date on the marketplace platform (through PayPal or otherwise)."},"sender_signup_ip":{"type":"string","description":"Format: IP (IPv4 / IPv6); example: `10.220.90.20`\n\nIP address that the sender/buyer used to sign up on the marketplace platform."},"rdauuid":{"type":"string","description":"The `rdauuid` returned by PayPal."},"receiver_account_id":{"type":"string","description":"Format: Alphanumeric; example: `A12345N343`\n\nUnique identifier of the seller/recipient's account on the marketplace platform."},"sender_last_name":{"type":"string","description":"Format: Alphanumeric; example: `Doe`\n\nLast name registered with the sender/buyer's marketplace account."},"sender_account_id":{"type":"string","description":"Format: Alphanumeric; example: `A12345N343`\n\nUnique identifier of the sender/buyer account on the marketplace platform."},"api_caller":{"type":"string","description":"The `api_caller` returned by PayPal."},"sender_first_name":{"type":"string","description":"Format: Alphanumeric; example: `Jane`\n\nFirst name registered with the sender/buyer's marketplace account."},"sender_popularity_score":{"type":"string","description":"Possible values: `high`, `medium`, `low`; example: `high`\n\nRisk-based scoring on the sender/buyer by the marketplace platform (e.g., social score, identity score, risk score). This score is likely unique for each platform based on marketplace platform's risk platform capabilities."},"recipient_popularity_score":{"type":"string","description":"Possible values: `high`, `medium`, `low`; example: `high`\n\nRisk-based scoring on the seller/recipient by the marketplace platform (e.g., social score, identity score, risk score). This score is likely unique for each platform based on marketplace platform's risk platform capabilities."},"sender_email":{"type":"string","description":"Format: E.123 – Email Address; example: `john@example.com`\n\nEmail address registered with the sender/buyer's marketplace account."}},"title":"ViewDataSubmittedForAPayPalPayInResponse"},"CreateAPayPalPayInRequestDebitedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"required":["Currency","Amount"],"description":"Information about the debited funds.","title":"CreateAPayPalPayInRequestDebitedFunds"},"CreateAPayPalPayInRequestFees":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"required":["Currency","Amount"],"description":"Information about the fees.","title":"CreateAPayPalPayInRequestFees"},"CreateAPayPalPayInRequestShipping":{"type":"object","properties":{"FirstName":{"type":"string","description":"The first name of the user."},"LastName":{"type":"string","description":"The last name of the user."},"Address":{"$ref":"#/components/schemas/Address_SubPropsRequired"}},"required":["Address"],"description":"Required if `ShippingPreference` is `SET_PROVIDED_ADDRESS`.\n\nInformation about the end user's shipping address, managed by `ShippingPreference`.","title":"CreateAPayPalPayInRequestShipping"},"CreateAPayPalPayInRequestLineItemsItems":{"type":"object","properties":{"Name":{"type":"string","description":"The name of the item."},"Quantity":{"type":"integer","description":"The quantity of the item."},"UnitAmount":{"type":"integer","description":"The cost of the item, excluding tax."},"TaxAmount":{"type":"integer","description":"The tax amount applied to the item."},"Description":{"type":"string","description":"The platform's unique reference for the seller. This value must be consistently used for the given seller. You can use, for example, the Mangopay `UserId` or the seller's business name or first name and last name.\n\n**Caution:** Failure to use a unique seller identifier may result in PayPal restricting your service."},"Category":{"type":"string","description":"**Allowed values:** PHYSICAL_GOODS, DIGITAL_GOODS, DONATION\n\nThe category of the item:\n- `PHYSICAL_GOODS` – Tangible items that can be physically shipped and received with proof of delivery upon arrival.\n- `DIGITAL_GOODS` – Products or services that are distributed and consumed via digital platforms or devices.\n- `DONATION` – Voluntary contribution made without any goods or services received in return. Multiple line items can be categorized as `DONATION` within a single transaction, however it is not possible to combine `DONATION` other line item categories within the same transaction."}},"required":["Name","Quantity","UnitAmount","Description"],"title":"CreateAPayPalPayInRequestLineItemsItems"},"CreateAPayPalPayInRequest":{"type":"object","properties":{"Tag":{"$ref":"#/components/schemas/Tag"},"AuthorId":{"$ref":"#/components/schemas/AuthorId"},"DebitedFunds":{"$ref":"#/components/schemas/CreateAPayPalPayInRequestDebitedFunds","description":"Information about the debited funds."},"Fees":{"$ref":"#/components/schemas/CreateAPayPalPayInRequestFees","description":"Information about the fees."},"CreditedWalletId":{"type":"string","description":"The unique identifier of the credited wallet."},"FlowDescriptor":{"$ref":"#/components/schemas/FlowDescriptorRequest"},"ReturnURL":{"$ref":"#/components/schemas/ReturnURL_255"},"StatementDescriptor":{"$ref":"#/components/schemas/StatementDescriptor"},"Shipping":{"$ref":"#/components/schemas/CreateAPayPalPayInRequestShipping","description":"Required if `ShippingPreference` is `SET_PROVIDED_ADDRESS`.\n\nInformation about the end user's shipping address, managed by `ShippingPreference`."},"LineItems":{"type":"array","items":{"$ref":"#/components/schemas/CreateAPayPalPayInRequestLineItemsItems"},"description":"Information about the items purchased in the transaction. The total of all line items' `UnitAmount` and `TaxAmount` must equal the `DebitedFunds` amount (negative amounts not allowed)."},"Culture":{"type":"string","description":"**Allowed values:** One of the supported languages in the [ISO 639-1 format](/api-reference/overview/data-formats): AT, BR, CA, CH, CN, DE, DK, ES, FR, GB, ID, IL, IT, JK, JP, NL, NO, PL, PT, RU, SE, TH, TR, TW, US.\n\nThe language in which the PayPal payment page is to be displayed."},"ShippingPreference":{"type":"string","description":"**Allowed values:** `SET_PROVIDED_ADDRESS`, `GET_FROM_FILE`, `NO_SHIPPING`\n\nInformation about the shipping address behavior on the PayPal payment page:\n- `SET_PROVIDED_ADDRESS` - The `Shipping` parameter becomes required and its values are displayed to the end user, who is not able to modify them.\n- `GET_FROM_FILE` – The `Shipping` parameter is ignored and the end user can choose from registered addresses.\n- `NO_SHIPPING` – No shipping address section is displayed."},"Reference":{"type":"string","description":"Max. length: 127 characters (truncated after)\n\nThe platform's order reference for the transaction."},"CancelURL":{"type":"string","description":"The URL to which the user is returned after canceling the payment. If not provided, the Cancel button returns the user to the `RedirectURL`."},"ProfilingAttemptReference":{"$ref":"#/components/schemas/ProfilingAttemptReference"},"DataCollectionId":{"type":"string","description":"The unique identifier of the Data Collection object, returned after sending the requested data to the [POST Submit data for a PayPal PayIn](/api-reference/paypal/submit-data-paypal-payin) endpoint."}},"required":["AuthorId","DebitedFunds","Fees","CreditedWalletId","ReturnURL","LineItems"],"title":"CreateAPayPalPayInRequest"},"DeprecatedCreateAPayPalPayInRequestDebitedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"required":["Currency","Amount"],"description":"Information about the debited funds.","title":"DeprecatedCreateAPayPalPayInRequestDebitedFunds"},"DeprecatedCreateAPayPalPayInRequestFees":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"required":["Currency","Amount"],"description":"Information about the fees.","title":"DeprecatedCreateAPayPalPayInRequestFees"},"DeprecatedCreateAPayPalPayInRequestShippingAddress":{"type":"object","properties":{"RecipientName":{"type":"string","description":"The full name of the shipping addressee."},"Address":{"$ref":"#/components/schemas/Address_SubPropsRequired"}},"required":["RecipientName","Address"],"description":"Information about the shipping recipient and address for the transaction. If sent, this information overrides the user's PayPal shipping address. If not sent, the user's PayPal shipping address is used.","title":"DeprecatedCreateAPayPalPayInRequestShippingAddress"},"DeprecatedCreateAPayPalPayInRequest":{"type":"object","properties":{"Tag":{"$ref":"#/components/schemas/Tag"},"AuthorId":{"$ref":"#/components/schemas/AuthorId"},"DebitedFunds":{"$ref":"#/components/schemas/DeprecatedCreateAPayPalPayInRequestDebitedFunds","description":"Information about the debited funds."},"Fees":{"$ref":"#/components/schemas/DeprecatedCreateAPayPalPayInRequestFees","description":"Information about the fees."},"CreditedWalletId":{"type":"string","description":"The unique identifier of the credited wallet."},"ReturnURL":{"$ref":"#/components/schemas/ReturnURL_255"},"Culture":{"type":"string","description":"**Allowed values:** One of the supported languages in the [ISO 639-1 format](/api-reference/overview/data-formats): DE, EN, ES, FR, IT, NL, PL, PT.\n\nThe language in which the payment page is to be displayed."},"ShippingAddress":{"$ref":"#/components/schemas/DeprecatedCreateAPayPalPayInRequestShippingAddress","description":"Information about the shipping recipient and address for the transaction. If sent, this information overrides the user's PayPal shipping address. If not sent, the user's PayPal shipping address is used."},"StatementDescriptor":{"$ref":"#/components/schemas/StatementDescriptor"}},"required":["AuthorId","DebitedFunds","Fees","CreditedWalletId","ReturnURL"],"title":"DeprecatedCreateAPayPalPayInRequest"},"DeprecatedPayPalPayInResponseDebitedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the debited funds.","title":"DeprecatedPayPalPayInResponseDebitedFunds"},"DeprecatedPayPalPayInResponseCreditedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the credited funds (`CreditedFunds` = `DebitedFunds` - `Fees`).","title":"DeprecatedPayPalPayInResponseCreditedFunds"},"DeprecatedPayPalPayInResponseFees":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the fees.","title":"DeprecatedPayPalPayInResponseFees"},"DeprecatedPayPalPayInResponseShippingAddress":{"type":"object","properties":{"RecipientName":{"type":"string","description":"The full name of the shipping addressee."},"Address":{"$ref":"#/components/schemas/Address"}},"description":"Information about the shipping recipient and address for the transaction. If sent, this information overrides the user's PayPal shipping address. If not sent, the user's PayPal shipping address is used.","title":"DeprecatedPayPalPayInResponseShippingAddress"},"DeprecatedPayPalPayInResponse":{"type":"object","properties":{"Id":{"$ref":"#/components/schemas/Id"},"Tag":{"$ref":"#/components/schemas/Tag"},"CreationDate":{"$ref":"#/components/schemas/CreationDate"},"AuthorId":{"$ref":"#/components/schemas/AuthorId"},"CreditedUserId":{"$ref":"#/components/schemas/CreditedUserId"},"DebitedFunds":{"$ref":"#/components/schemas/DeprecatedPayPalPayInResponseDebitedFunds","description":"Information about the debited funds."},"CreditedFunds":{"$ref":"#/components/schemas/DeprecatedPayPalPayInResponseCreditedFunds","description":"Information about the credited funds (`CreditedFunds` = `DebitedFunds` - `Fees`)."},"Fees":{"$ref":"#/components/schemas/DeprecatedPayPalPayInResponseFees","description":"Information about the fees."},"Status":{"$ref":"#/components/schemas/TransactionStatus"},"ResultCode":{"$ref":"#/components/schemas/ResultCode"},"ResultMessage":{"$ref":"#/components/schemas/ResultMessage"},"ExecutionDate":{"$ref":"#/components/schemas/TransactionExecutionDate"},"Type":{"$ref":"#/components/schemas/TransactionType"},"Nature":{"$ref":"#/components/schemas/TransactionNature"},"CreditedWalletId":{"type":"string","description":"The unique identifier of the credited wallet."},"DebitedWalletId":{"type":"string","description":"The unique identifier of the debited wallet."},"PaymentType":{"type":"string","description":"**Returned values:** `PAYPAL`\n\nThe payment type of the pay-in."},"ExecutionType":{"type":"string","description":"**Returned values:** `WEB`\n\nThe execution type of the pay-in."},"RedirectURL":{"type":"string","description":"The URL to which to redirect the user to complete the payment.\n\n**Caution:** This variable URL is specific to each payment. You must rely on the returned URL in full (host, path, and queries) and not hardcode any part of it."},"ReturnURL":{"$ref":"#/components/schemas/ReturnURL_255"},"Culture":{"type":"string","description":"**Returned values:** One of the supported languages in the [ISO 639-1 format](/api-reference/overview/data-formats): DE, EN, ES, FR, IT, NL, PL, PT.\n\nThe language in which the payment page is to be displayed."},"ShippingAddress":{"$ref":"#/components/schemas/DeprecatedPayPalPayInResponseShippingAddress","description":"Information about the shipping recipient and address for the transaction. If sent, this information overrides the user's PayPal shipping address. If not sent, the user's PayPal shipping address is used."},"StatementDescriptor":{"$ref":"#/components/schemas/StatementDescriptor"},"PaypalBuyerAccountEmail":{"type":"string","description":"The email address registered on the PayPal account used to make the payment."}},"title":"DeprecatedPayPalPayInResponse"},"CreateARecurringPayPalPayInCitRequestShipping":{"type":"object","properties":{"FirstName":{"type":"string","description":"The first name of the user."},"LastName":{"type":"string","description":"The last name of the user."},"Address":{"$ref":"#/components/schemas/Address"}},"description":"**Default values:** `Shipping` information of the registration object (if present).\n\nRequired if `ShippingPreference` is `SET_PROVIDED_ADDRESS` and the shipping information is not present in the recurring registration object.\n\nInformation about the end user's shipping address, managed by `ShippingPreference`.","title":"CreateARecurringPayPalPayInCitRequestShipping"},"CreateARecurringPayPalPayInCitRequestLineItemsItems":{"type":"object","properties":{"Name":{"type":"string","description":"The name of the item."},"Quantity":{"type":"integer","description":"The quantity of the item."},"UnitAmount":{"type":"integer","description":"The cost of the item, excluding tax."},"TaxAmount":{"type":"integer","description":"The tax amount applied to the item."},"Description":{"type":"string","description":"The platform's unique reference for the seller. This value must be consistently used for the given seller. You can use, for example, the Mangopay `UserId` or the seller's business name or first name and last name.\n\n**Caution:** Failure to use a unique seller identifier may result in PayPal restricting your service."},"Category":{"type":"string","description":"**Allowed values:** PHYSICAL_GOODS, DIGITAL_GOODS, DONATION\n\nThe category of the item:\n- `PHYSICAL_GOODS` – Tangible items that can be physically shipped and received with proof of delivery upon arrival.\n- `DIGITAL_GOODS` – Products or services that are distributed and consumed via digital platforms or devices.\n- `DONATION` – Voluntary contribution made without any goods or services received in return. Multiple line items can be categorized as `DONATION` within a single transaction, however it is not possible to combine `DONATION` other line item categories within the same transaction."}},"required":["Name","Quantity","UnitAmount","Description"],"title":"CreateARecurringPayPalPayInCitRequestLineItemsItems"},"CreateARecurringPayPalPayInCITRequest":{"type":"object","properties":{"RecurringPayinRegistrationId":{"type":"string","description":"The unique identifier of the recurring pay-in registration."},"Tag":{"$ref":"#/components/schemas/Tag"},"ReturnURL":{"$ref":"#/components/schemas/ReturnURL_255"},"CancelURL":{"type":"string","description":"The URL to which the user is returned after canceling the payment. If not provided, the Cancel button returns the user to the `RedirectURL`."},"StatementDescriptor":{"$ref":"#/components/schemas/StatementDescriptor"},"Shipping":{"$ref":"#/components/schemas/CreateARecurringPayPalPayInCitRequestShipping","description":"**Default values:** `Shipping` information of the registration object (if present).\n\nRequired if `ShippingPreference` is `SET_PROVIDED_ADDRESS` and the shipping information is not present in the recurring registration object.\n\nInformation about the end user's shipping address, managed by `ShippingPreference`."},"LineItems":{"type":"array","items":{"$ref":"#/components/schemas/CreateARecurringPayPalPayInCitRequestLineItemsItems"},"description":"Information about the items purchased in the transaction. The total of all line items' `UnitAmount` and `TaxAmount` must equal the `DebitedFunds` amount (negative amounts not allowed)."},"Culture":{"type":"string","description":"**Allowed values:** One of the supported languages in the [ISO 639-1 format](/api-reference/overview/data-formats): AT, BR, CA, CH, CN, DE, DK, ES, FR, GB, ID, IL, IT, JK, JP, NL, NO, PL, PT, RU, SE, TH, TR, TW, US.\n\nThe language in which the PayPal payment page is to be displayed."},"ShippingPreference":{"type":"string","description":"**Allowed values:** `SET_PROVIDED_ADDRESS`, `GET_FROM_FILE`, `NO_SHIPPING`\n\nInformation about the shipping address behavior on the PayPal payment page:\n- `SET_PROVIDED_ADDRESS` - The `Shipping` parameter becomes required and its values are displayed to the end user, who is not able to modify them.\n- `GET_FROM_FILE` – The `Shipping` parameter is ignored and the end user can choose from registered addresses.\n- `NO_SHIPPING` – No shipping address section is displayed."},"Reference":{"type":"string","description":"Max. length: 127 characters (truncated after)\n\nThe platform's order reference for the transaction."},"DataCollectionId":{"type":"string","description":"The unique identifier of the Data Collection object, returned after sending the requested data to the [POST Submit data for a PayPal PayIn](/api-reference/paypal/submit-data-paypal-payin) endpoint."}},"required":["ReturnURL","LineItems"],"description":"Request body for a PayPal customer-initiated transaction (CIT).","title":"CreateARecurringPayPalPayInCITRequest"},"CreateARecurringPayPalPayInMitRequestDebitedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"required":["Currency","Amount"],"description":"Information about the debited funds. This property overrides the `FirstTransactionDebitedFunds` of the Registration, and is **required if** that property is empty.\n\n**Caution:** An amount must be provided in either the Registration's `FirstTransactionDebitedFunds` or the pay-in's `DebitedFunds`.","title":"CreateARecurringPayPalPayInMitRequestDebitedFunds"},"CreateARecurringPayPalPayInMitRequestFees":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"required":["Currency","Amount"],"description":"Information about the fees. This property overrides the `FirstTransactionFees` of the Registration, and is **required if** that property is empty.\n\n**Caution:** An amount must be provided in either the Registration's `FirstTransactionFees` or the pay-in's `Fees`.","title":"CreateARecurringPayPalPayInMitRequestFees"},"CreateARecurringPayPalPayInMitRequestShipping":{"type":"object","properties":{"FirstName":{"type":"string","description":"The first name of the user."},"LastName":{"type":"string","description":"The last name of the user."},"Address":{"$ref":"#/components/schemas/Address"}},"description":"**Default values:** `Shipping` information of the registration object (if present).\n\nRequired if `ShippingPreference` is `SET_PROVIDED_ADDRESS` and the shipping information is not present in the recurring registration object.\n\nInformation about the end user's shipping address, managed by `ShippingPreference`.","title":"CreateARecurringPayPalPayInMitRequestShipping"},"CreateARecurringPayPalPayInMitRequestLineItemsItems":{"type":"object","properties":{"Name":{"type":"string","description":"The name of the item."},"Quantity":{"type":"integer","description":"The quantity of the item."},"UnitAmount":{"type":"integer","description":"The cost of the item, excluding tax."},"TaxAmount":{"type":"integer","description":"The tax amount applied to the item."},"Description":{"type":"string","description":"The platform's unique reference for the seller. This value must be consistently used for the given seller. You can use, for example, the Mangopay `UserId` or the seller's business name or first name and last name.\n\n**Caution:** Failure to use a unique seller identifier may result in PayPal restricting your service."},"Category":{"type":"string","description":"**Allowed values:** PHYSICAL_GOODS, DIGITAL_GOODS, DONATION\n\nThe category of the item:\n- `PHYSICAL_GOODS` – Tangible items that can be physically shipped and received with proof of delivery upon arrival.\n- `DIGITAL_GOODS` – Products or services that are distributed and consumed via digital platforms or devices.\n- `DONATION` – Voluntary contribution made without any goods or services received in return. Multiple line items can be categorized as `DONATION` within a single transaction, however it is not possible to combine `DONATION` other line item categories within the same transaction."}},"required":["Name","Quantity","UnitAmount","Description"],"title":"CreateARecurringPayPalPayInMitRequestLineItemsItems"},"CreateARecurringPayPalPayInMITRequest":{"type":"object","properties":{"RecurringPayinRegistrationId":{"type":"string","description":"The unique identifier of the recurring pay-in registration."},"DebitedFunds":{"$ref":"#/components/schemas/CreateARecurringPayPalPayInMitRequestDebitedFunds","description":"Information about the debited funds. This property overrides the `FirstTransactionDebitedFunds` of the Registration, and is **required if** that property is empty.\n\n**Caution:** An amount must be provided in either the Registration's `FirstTransactionDebitedFunds` or the pay-in's `DebitedFunds`."},"Fees":{"$ref":"#/components/schemas/CreateARecurringPayPalPayInMitRequestFees","description":"Information about the fees. This property overrides the `FirstTransactionFees` of the Registration, and is **required if** that property is empty.\n\n**Caution:** An amount must be provided in either the Registration's `FirstTransactionFees` or the pay-in's `Fees`."},"Tag":{"$ref":"#/components/schemas/Tag"},"ReturnURL":{"$ref":"#/components/schemas/ReturnURL_255"},"StatementDescriptor":{"$ref":"#/components/schemas/StatementDescriptor"},"Shipping":{"$ref":"#/components/schemas/CreateARecurringPayPalPayInMitRequestShipping","description":"**Default values:** `Shipping` information of the registration object (if present).\n\nRequired if `ShippingPreference` is `SET_PROVIDED_ADDRESS` and the shipping information is not present in the recurring registration object.\n\nInformation about the end user's shipping address, managed by `ShippingPreference`."},"LineItems":{"type":"array","items":{"$ref":"#/components/schemas/CreateARecurringPayPalPayInMitRequestLineItemsItems"},"description":"Information about the items purchased in the transaction. The total of all line items' `UnitAmount` and `TaxAmount` must equal the `DebitedFunds` amount (negative amounts not allowed)."},"Culture":{"type":"string","description":"**Allowed values:** One of the supported languages in the [ISO 639-1 format](/api-reference/overview/data-formats): AT, BR, CA, CH, CN, DE, DK, ES, FR, GB, ID, IL, IT, JK, JP, NL, NO, PL, PT, RU, SE, TH, TR, TW, US.\n\nThe language in which the PayPal payment page is to be displayed."},"ShippingPreference":{"type":"string","description":"**Allowed values:** `SET_PROVIDED_ADDRESS`, `GET_FROM_FILE`, `NO_SHIPPING`\n\nInformation about the shipping address behavior on the PayPal payment page:\n- `SET_PROVIDED_ADDRESS` - The `Shipping` parameter becomes required and its values are displayed to the end user, who is not able to modify them.\n- `GET_FROM_FILE` – The `Shipping` parameter is ignored and the end user can choose from registered addresses.\n- `NO_SHIPPING` – No shipping address section is displayed."},"Reference":{"type":"string","description":"Max. length: 127 characters (truncated after)\n\nThe platform's order reference for the transaction."},"DataCollectionId":{"type":"string","description":"The unique identifier of the Data Collection object, returned after sending the requested data to the [POST Submit data for a PayPal PayIn](/api-reference/paypal/submit-data-paypal-payin) endpoint."}},"required":["ReturnURL","LineItems"],"description":"Request body for a PayPal merchant-initiated transaction (MIT).","title":"CreateARecurringPayPalPayInMITRequest"},"paypal_create_recurring_paypal_payin_Request":{"oneOf":[{"$ref":"#/components/schemas/CreateARecurringPayPalPayInCITRequest"},{"$ref":"#/components/schemas/CreateARecurringPayPalPayInMITRequest"}],"title":"paypal_create_recurring_paypal_payin_Request"},"CreateAPayPalPreauthorizationRequestDebitedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"required":["Currency","Amount"],"description":"Information about the preauthorized funds.","title":"CreateAPayPalPreauthorizationRequestDebitedFunds"},"CreateAPayPalPreauthorizationRequestShipping":{"type":"object","properties":{"FirstName":{"type":"string","description":"The first name of the user."},"LastName":{"type":"string","description":"The last name of the user."},"Address":{"$ref":"#/components/schemas/Address_SubPropsRequired"}},"required":["Address"],"description":"Required if `ShippingPreference` is `SET_PROVIDED_ADDRESS`.\n\nInformation about the end user's shipping address, managed by `ShippingPreference`.","title":"CreateAPayPalPreauthorizationRequestShipping"},"CreateAPayPalPreauthorizationRequestLineItemsItems":{"type":"object","properties":{"Name":{"type":"string","description":"The name of the item."},"Quantity":{"type":"integer","description":"The quantity of the item."},"UnitAmount":{"type":"integer","description":"The cost of the item, excluding tax."},"TaxAmount":{"type":"integer","description":"The tax amount applied to the item."},"Description":{"type":"string","description":"The platform's unique reference for the seller. This value must be consistently used for the given seller. You can use, for example, the Mangopay `UserId` or the seller's business name or first name and last name.\n\n**Caution:** Failure to use a unique seller identifier may result in PayPal restricting your service."},"Category":{"type":"string","description":"**Allowed values:** PHYSICAL_GOODS, DIGITAL_GOODS, DONATION\n\nThe category of the item:\n- `PHYSICAL_GOODS` – Tangible items that can be physically shipped and received with proof of delivery upon arrival.\n- `DIGITAL_GOODS` – Products or services that are distributed and consumed via digital platforms or devices.\n- `DONATION` – Voluntary contribution made without any goods or services received in return. Multiple line items can be categorized as `DONATION` within a single transaction, however it is not possible to combine `DONATION` other line item categories within the same transaction."}},"required":["Name","Quantity","UnitAmount","Description"],"title":"CreateAPayPalPreauthorizationRequestLineItemsItems"},"CreateAPayPalPreauthorizationRequest":{"type":"object","properties":{"FlowDescriptor":{"$ref":"#/components/schemas/FlowDescriptorRequest"},"Tag":{"$ref":"#/components/schemas/Tag"},"AuthorId":{"$ref":"#/components/schemas/AuthorId"},"DebitedFunds":{"$ref":"#/components/schemas/CreateAPayPalPreauthorizationRequestDebitedFunds","description":"Information about the preauthorized funds."},"ReturnURL":{"$ref":"#/components/schemas/ReturnURL_255"},"CancelURL":{"type":"string","description":"The URL to which the user is returned after canceling the payment. If not provided, the Cancel button returns the user to the `RedirectURL`."},"DataCollectionId":{"type":"string","description":"The unique identifier of the Data Collection object, returned after sending the requested data to the [POST Submit data for a PayPal PayIn](/api-reference/paypal/submit-data-paypal-payin) endpoint."},"ShippingPreference":{"type":"string","description":"**Allowed values:** `SET_PROVIDED_ADDRESS`, `GET_FROM_FILE`, `NO_SHIPPING`\n\nInformation about the shipping address behavior on the PayPal payment page:\n- `SET_PROVIDED_ADDRESS` - The `Shipping` parameter becomes required and its values are displayed to the end user, who is not able to modify them.\n- `GET_FROM_FILE` – The `Shipping` parameter is ignored and the end user can choose from registered addresses.\n- `NO_SHIPPING` – No shipping address section is displayed."},"Shipping":{"$ref":"#/components/schemas/CreateAPayPalPreauthorizationRequestShipping","description":"Required if `ShippingPreference` is `SET_PROVIDED_ADDRESS`.\n\nInformation about the end user's shipping address, managed by `ShippingPreference`."},"LineItems":{"type":"array","items":{"$ref":"#/components/schemas/CreateAPayPalPreauthorizationRequestLineItemsItems"},"description":"Information about the items purchased in the transaction. The total of all line items' `UnitAmount` and `TaxAmount` must equal the `DebitedFunds` amount (negative amounts not allowed)."},"Reference":{"type":"string","description":"Max. length: 127 characters (truncated after)\n\nThe platform's order reference for the transaction."},"StatementDescriptor":{"$ref":"#/components/schemas/StatementDescriptor"},"Culture":{"type":"string","description":"**Allowed values:** One of the supported languages in the [ISO 639-1 format](/api-reference/overview/data-formats): AT, BR, CA, CH, CN, DE, DK, ES, FR, GB, ID, IL, IT, JK, JP, NL, NO, PL, PT, RU, SE, TH, TR, TW, US.\n\nThe language in which the PayPal payment page is to be displayed."},"ProfilingAttemptReference":{"$ref":"#/components/schemas/ProfilingAttemptReference"}},"required":["AuthorId","DebitedFunds","ReturnURL","LineItems"],"title":"CreateAPayPalPreauthorizationRequest"},"AddTrackingInformationToAPayPalPayInRequest":{"type":"object","properties":{"TrackingNumber":{"type":"string","description":"The shipment's tracking number provided by the carrier."},"Carrier":{"type":"string","description":"The carrier for the shipment. Use the country-specific version of the carrier if it exists, otherwise use its global version."},"NotifyBuyer":{"type":"boolean","description":"**Default value:** false\n\nIf `true`, sends an email notification to the `PaypalBuyerAccountEmail` containing the `TrackingNumber` and `Carrier`, which allows the end user to track their shipment with the carrier."}},"required":["TrackingNumber","Carrier"],"title":"AddTrackingInformationToAPayPalPayInRequest"},"AddTrackingInformationToAPayPalPayInResponseDebitedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the debited funds.","title":"AddTrackingInformationToAPayPalPayInResponseDebitedFunds"},"AddTrackingInformationToAPayPalPayInResponseCreditedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the credited funds (`CreditedFunds` = `DebitedFunds` - `Fees`).","title":"AddTrackingInformationToAPayPalPayInResponseCreditedFunds"},"AddTrackingInformationToAPayPalPayInResponseFees":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the fees.","title":"AddTrackingInformationToAPayPalPayInResponseFees"},"AddTrackingInformationToAPayPalPayInResponseShipping":{"type":"object","properties":{"FirstName":{"type":"string","description":"The first name of the user."},"LastName":{"type":"string","description":"The last name of the user."},"Address":{"$ref":"#/components/schemas/Address"}},"description":"Required if `ShippingPreference` is `SET_PROVIDED_ADDRESS`.\n\nInformation about the end user's shipping address, managed by `ShippingPreference`.","title":"AddTrackingInformationToAPayPalPayInResponseShipping"},"AddTrackingInformationToAPayPalPayInResponseLineItemsItems":{"type":"object","properties":{"Name":{"type":"string","description":"The name of the item."},"Quantity":{"type":"integer","description":"The quantity of the item."},"UnitAmount":{"type":"integer","description":"The cost of the item, excluding tax."},"TaxAmount":{"type":"integer","description":"The tax amount applied to the item."},"Description":{"type":"string","description":"The platform's unique reference for the seller. This value must be consistently used for the given seller. You can use, for example, the Mangopay `UserId` or the seller's business name or first name and last name.\n\n**Caution:** Failure to use a unique seller identifier may result in PayPal restricting your service."},"Category":{"type":"string","description":"**Allowed values:** PHYSICAL_GOODS, DIGITAL_GOODS, DONATION\n\nThe category of the item:\n- `PHYSICAL_GOODS` – Tangible items that can be physically shipped and received with proof of delivery upon arrival.\n- `DIGITAL_GOODS` – Products or services that are distributed and consumed via digital platforms or devices.\n- `DONATION` – Voluntary contribution made without any goods or services received in return. Multiple line items can be categorized as `DONATION` within a single transaction, however it is not possible to combine `DONATION` other line item categories within the same transaction."}},"title":"AddTrackingInformationToAPayPalPayInResponseLineItemsItems"},"AddTrackingInformationToAPayPalPayInResponseTrackingsItems":{"type":"object","properties":{"TrackingNumber":{"type":"string","description":"The shipment's tracking number provided by the carrier."},"Carrier":{"type":"string","description":"The carrier for the shipment. Use the country-specific version of the carrier if it exists, otherwise use its global version."},"NotifyBuyer":{"type":"boolean","description":"**Default value:** false\n\nIf `true`, sends an email notification to the `PaypalBuyerAccountEmail` containing the `TrackingNumber` and `Carrier`, which allows the end user to track their shipment with the carrier."}},"title":"AddTrackingInformationToAPayPalPayInResponseTrackingsItems"},"AddTrackingInformationToAPayPalPayInResponse":{"type":"object","properties":{"Id":{"$ref":"#/components/schemas/Id"},"Tag":{"$ref":"#/components/schemas/Tag"},"CreationDate":{"$ref":"#/components/schemas/CreationDate"},"AuthorId":{"$ref":"#/components/schemas/AuthorId"},"DebitedFunds":{"$ref":"#/components/schemas/AddTrackingInformationToAPayPalPayInResponseDebitedFunds","description":"Information about the debited funds."},"CreditedFunds":{"$ref":"#/components/schemas/AddTrackingInformationToAPayPalPayInResponseCreditedFunds","description":"Information about the credited funds (`CreditedFunds` = `DebitedFunds` - `Fees`)."},"Fees":{"$ref":"#/components/schemas/AddTrackingInformationToAPayPalPayInResponseFees","description":"Information about the fees."},"Status":{"$ref":"#/components/schemas/TransactionStatus"},"ResultCode":{"$ref":"#/components/schemas/ResultCode"},"ResultMessage":{"$ref":"#/components/schemas/ResultMessage"},"ExecutionDate":{"$ref":"#/components/schemas/TransactionExecutionDate"},"Type":{"$ref":"#/components/schemas/TransactionType"},"Nature":{"$ref":"#/components/schemas/TransactionNature"},"CreditedWalletId":{"type":"string","description":"The unique identifier of the credited wallet."},"CreditedUserId":{"$ref":"#/components/schemas/CreditedUserId"},"PaymentType":{"type":"string","description":"**Returned values:** `PAYPAL`\n\nThe payment type of the pay-in."},"ExecutionType":{"type":"string","description":"**Returned values:** `WEB`\n\nThe execution type of the pay-in."},"ReturnURL":{"$ref":"#/components/schemas/ReturnURL_255"},"RedirectURL":{"type":"string","description":"The URL to which to redirect the user to complete the payment.\n\n**Caution:** This variable URL is specific to each payment. You must rely on the returned URL in full (host, path, and queries) and not hardcode any part of it."},"StatementDescriptor":{"$ref":"#/components/schemas/StatementDescriptor"},"Shipping":{"$ref":"#/components/schemas/AddTrackingInformationToAPayPalPayInResponseShipping","description":"Required if `ShippingPreference` is `SET_PROVIDED_ADDRESS`.\n\nInformation about the end user's shipping address, managed by `ShippingPreference`."},"LineItems":{"type":"array","items":{"$ref":"#/components/schemas/AddTrackingInformationToAPayPalPayInResponseLineItemsItems"},"description":"Information about the items purchased in the transaction. The total of all line items' `UnitAmount` and `TaxAmount` must equal the `DebitedFunds` amount (negative amounts not allowed)."},"Culture":{"type":"string","description":"**Returned values:** One of the supported languages in the [ISO 639-1 format](/api-reference/overview/data-formats): AT, BR, CA, CH, CN, DE, DK, ES, FR, GB, ID, IL, IT, JK, JP, NL, NO, PL, PT, RU, SE, TH, TR, TW, US.\n\nThe language in which the PayPal payment page is to be displayed."},"ShippingPreference":{"type":"string","description":"**Returned values:** `SET_PROVIDED_ADDRESS`, `GET_FROM_FILE`, `NO_SHIPPING`\n\nInformation about the shipping address behavior on the PayPal payment page:\n- `SET_PROVIDED_ADDRESS` - The `Shipping` parameter becomes required and its values are displayed to the end user, who is not able to modify them.\n- `GET_FROM_FILE` – The `Shipping` parameter is ignored and the end user can choose from registered addresses.\n- `NO_SHIPPING` – No shipping address section is displayed."},"PaypalBuyerAccountEmail":{"type":"string","description":"The email address registered on the PayPal account used to make the payment."},"Reference":{"type":"string","description":"Max. length: 127 characters (truncated after)\n\nThe platform's order reference for the transaction."},"Trackings":{"type":"array","items":{"$ref":"#/components/schemas/AddTrackingInformationToAPayPalPayInResponseTrackingsItems"},"description":"Shipping information of the `LineItems` added to the pay-in object."},"CancelURL":{"type":"string","description":"The URL to which the user is returned after canceling the payment. If not provided, the Cancel button returns the user to the `RedirectURL`."},"PaypalOrderID":{"type":"string","description":"PayPal's unique identifier for the order."},"BuyerCountry":{"type":"string","description":"The country of the buyer."},"BuyerFirstname":{"type":"string","description":"The first name of the buyer."},"BuyerPhone":{"type":"string","description":"The mobile phone number of the buyer."},"BuyerLastname":{"type":"string","description":"The last name of the buyer."},"PaypalPayerID":{"type":"string","description":"The PayPal identifier of the buyer."}},"title":"AddTrackingInformationToAPayPalPayInResponse"},"CreateASatispayPayInRequestDebitedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"required":["Currency","Amount"],"description":"Information about the debited funds.","title":"CreateASatispayPayInRequestDebitedFunds"},"CreateASatispayPayInRequestFees":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"required":["Currency","Amount"],"description":"Information about the fees.","title":"CreateASatispayPayInRequestFees"},"CreateASatispayPayInRequest":{"type":"object","properties":{"AuthorId":{"$ref":"#/components/schemas/AuthorId"},"CreditedWalletId":{"type":"string","description":"The unique identifier of the credited wallet."},"FlowDescriptor":{"$ref":"#/components/schemas/FlowDescriptorRequest"},"DebitedFunds":{"$ref":"#/components/schemas/CreateASatispayPayInRequestDebitedFunds","description":"Information about the debited funds."},"Fees":{"$ref":"#/components/schemas/CreateASatispayPayInRequestFees","description":"Information about the fees."},"ReturnURL":{"$ref":"#/components/schemas/ReturnURL_255"},"Tag":{"$ref":"#/components/schemas/Tag"},"StatementDescriptor":{"$ref":"#/components/schemas/StatementDescriptor"},"Country":{"type":"string","description":"Format: Two-letter country code ([ISO 3166-1 alpha-2 format](/api-reference/overview/data-formats))\n\nThe country of residence of the user, which can be those of the EEA plus CH, GB, and TR."},"ProfilingAttemptReference":{"$ref":"#/components/schemas/ProfilingAttemptReference"}},"required":["AuthorId","CreditedWalletId","DebitedFunds","Fees","ReturnURL","Country"],"title":"CreateASatispayPayInRequest"},"CreateASwishPayInRequestDebitedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency_SEK"},"Amount":{"$ref":"#/components/schemas/Amount"}},"required":["Currency","Amount"],"description":"Information about the debited funds.","title":"CreateASwishPayInRequestDebitedFunds"},"CreateASwishPayInRequestFees":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency_SEK"},"Amount":{"$ref":"#/components/schemas/Amount"}},"required":["Currency","Amount"],"description":"Information about the fees.","title":"CreateASwishPayInRequestFees"},"CreateASwishPayInRequest":{"type":"object","properties":{"Tag":{"$ref":"#/components/schemas/Tag"},"AuthorId":{"$ref":"#/components/schemas/AuthorId"},"DebitedFunds":{"$ref":"#/components/schemas/CreateASwishPayInRequestDebitedFunds","description":"Information about the debited funds."},"Fees":{"$ref":"#/components/schemas/CreateASwishPayInRequestFees","description":"Information about the fees."},"CreditedWalletId":{"type":"string","description":"The unique identifier of the credited wallet."},"FlowDescriptor":{"$ref":"#/components/schemas/FlowDescriptorRequest"},"ReturnURL":{"$ref":"#/components/schemas/ReturnURL_255"},"StatementDescriptor":{"$ref":"#/components/schemas/StatementDescriptor"},"PaymentFlow":{"type":"string","description":"**Allowed values:** `WEB`, `APP`\n\n**Default value:** `WEB`\n\nThe platform environment of the post-payment flow. The `PaymentFlow` value combines with the `ReturnURL` to manage the redirection behavior after payment:\n- Set the value to `APP` to send the user to your platform's mobile app\n- Set the value to `WEB` to send the user to a web browser\n\nIn both cases you need to provide the relevant `ReturnURL`, whether to your app or website."}},"required":["AuthorId","DebitedFunds","Fees","CreditedWalletId","ReturnURL"],"title":"CreateASwishPayInRequest"},"CreateATwintPayInRequestDebitedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency_CHF"},"Amount":{"$ref":"#/components/schemas/Amount"}},"required":["Currency","Amount"],"description":"Information about the debited funds.","title":"CreateATwintPayInRequestDebitedFunds"},"CreateATwintPayInRequestFees":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency_CHF"},"Amount":{"$ref":"#/components/schemas/Amount"}},"required":["Currency","Amount"],"description":"Information about the fees.","title":"CreateATwintPayInRequestFees"},"CreateATwintPayInRequest":{"type":"object","properties":{"Tag":{"$ref":"#/components/schemas/Tag"},"AuthorId":{"$ref":"#/components/schemas/AuthorId"},"DebitedFunds":{"$ref":"#/components/schemas/CreateATwintPayInRequestDebitedFunds","description":"Information about the debited funds."},"Fees":{"$ref":"#/components/schemas/CreateATwintPayInRequestFees","description":"Information about the fees."},"CreditedWalletId":{"type":"string","description":"The unique identifier of the credited wallet."},"FlowDescriptor":{"$ref":"#/components/schemas/FlowDescriptorRequest"},"ReturnURL":{"$ref":"#/components/schemas/ReturnURL_255"},"StatementDescriptor":{"$ref":"#/components/schemas/StatementDescriptor"}},"required":["AuthorId","DebitedFunds","Fees","CreditedWalletId","ReturnURL"],"title":"CreateATwintPayInRequest"},"CreateATransferRequestDebitedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"required":["Currency","Amount"],"description":"Information about the debited funds.","title":"CreateATransferRequestDebitedFunds"},"CreateATransferRequestFees":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"required":["Currency","Amount"],"description":"Information about the fees.","title":"CreateATransferRequestFees"},"CreateATransferRequest":{"type":"object","properties":{"ScaContext":{"type":"string","description":"**Possible values:** `USER_PRESENT`, `USER_NOT_PRESENT`\n\nThe SCA context of the request, which is **required** if the debited wallet owner's `UserCategory` is `OWNER`:\n- `USER_PRESENT` – The user is taking the SCA-triggering action of initiating a transfer. The platform must [redirect the user](/guides/sca/session) using the `PendingUserAction.RedirectUrl` returned so that the user can complete the SCA session (unless Mangopay applied an exemption for low-amount and low-risk transfers, so no redirection link was returned).\n- `USER_NOT_PRESENT` – The platform is taking the action under proxy from the user and the user has previously given consent to Mangopay (via the SCA hosted experience) to allow the action. If the user has not given (or has revoked) their consent, then `USER_NOT_PRESENT` returns a 403 error.\n\nRead more about [managing proxy and user consent](/guides/sca/proxy-management) **&rarr;**\n\n**Note:** For existing platforms, the parameter is technically optional if the debited wallet owner's `UserCategory` is `OWNER`, and the default value will become `USER_PRESENT` from **Dec 15, 2025** (Dec 1 in Sandbox)"},"AuthorId":{"$ref":"#/components/schemas/AuthorId"},"DebitedFunds":{"$ref":"#/components/schemas/CreateATransferRequestDebitedFunds","description":"Information about the debited funds."},"Fees":{"$ref":"#/components/schemas/CreateATransferRequestFees","description":"Information about the fees."},"CreditedWalletId":{"type":"string","description":"The unique identifier of the credited wallet."},"DebitedWalletId":{"type":"string","description":"The unique identifier of the debited wallet."},"Tag":{"$ref":"#/components/schemas/Tag"}},"required":["AuthorId","DebitedFunds","Fees","CreditedWalletId","DebitedWalletId"],"title":"CreateATransferRequest"},"CreateATransferResponseDebitedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the debited funds.","title":"CreateATransferResponseDebitedFunds"},"CreateATransferResponseCreditedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the credited funds (`CreditedFunds` = `DebitedFunds` - `Fees`).","title":"CreateATransferResponseCreditedFunds"},"CreateATransferResponseFees":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the fees.","title":"CreateATransferResponseFees"},"CreateATransferResponse":{"type":"object","properties":{"ScaContext":{"type":"string","description":"**Possible values:** `USER_PRESENT`, `USER_NOT_PRESENT`\n\nThe SCA context of the request, which is **required** if the debited wallet owner's `UserCategory` is `OWNER`:\n- `USER_PRESENT` – The user is taking the SCA-triggering action of initiating a transfer. The platform must [redirect the user](/guides/sca/session) using the `PendingUserAction.RedirectUrl` returned so that the user can complete the SCA session (unless Mangopay applied an exemption for low-amount and low-risk transfers, so no redirection link was returned).\n- `USER_NOT_PRESENT` – The platform is taking the action under proxy from the user and the user has previously given consent to Mangopay (via the SCA hosted experience) to allow the action. If the user has not given (or has revoked) their consent, then `USER_NOT_PRESENT` returns a 403 error.\n\nRead more about [managing proxy and user consent](/guides/sca/proxy-management) **&rarr;**\n\n**Note:** For existing platforms, the parameter is technically optional if the debited wallet owner's `UserCategory` is `OWNER`, and the default value will become `USER_PRESENT` from **Dec 15, 2025** (Dec 1 in Sandbox)"},"Id":{"$ref":"#/components/schemas/Id"},"Tag":{"$ref":"#/components/schemas/Tag"},"CreationDate":{"$ref":"#/components/schemas/CreationDate"},"AuthorId":{"$ref":"#/components/schemas/AuthorId"},"CreditedUserId":{"$ref":"#/components/schemas/CreditedUserId"},"DebitedFunds":{"$ref":"#/components/schemas/CreateATransferResponseDebitedFunds","description":"Information about the debited funds."},"CreditedFunds":{"$ref":"#/components/schemas/CreateATransferResponseCreditedFunds","description":"Information about the credited funds (`CreditedFunds` = `DebitedFunds` - `Fees`)."},"Fees":{"$ref":"#/components/schemas/CreateATransferResponseFees","description":"Information about the fees."},"Status":{"$ref":"#/components/schemas/TransactionStatus"},"ResultCode":{"$ref":"#/components/schemas/ResultCode"},"ResultMessage":{"$ref":"#/components/schemas/ResultMessage"},"ExecutionDate":{"$ref":"#/components/schemas/TransactionExecutionDate"},"Type":{"$ref":"#/components/schemas/TransactionType"},"Nature":{"$ref":"#/components/schemas/TransactionNature"},"DebitedWalletId":{"type":"string","description":"The unique identifier of the debited wallet."},"CreditedWalletId":{"type":"string","description":"The unique identifier of the credited wallet."},"PendingUserAction":{"$ref":"#/components/schemas/PendingUserAction"}},"title":"CreateATransferResponse"},"ViewATransferResponseDebitedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the debited funds.","title":"ViewATransferResponseDebitedFunds"},"ViewATransferResponseCreditedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the credited funds (`CreditedFunds` = `DebitedFunds` - `Fees`).","title":"ViewATransferResponseCreditedFunds"},"ViewATransferResponseFees":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the fees.","title":"ViewATransferResponseFees"},"ViewATransferResponse":{"type":"object","properties":{"ScaContext":{"type":"string","description":"**Possible values:** `USER_PRESENT`, `USER_NOT_PRESENT`\n\nThe SCA context of the request, which is **required** if the debited wallet owner's `UserCategory` is `OWNER`:\n- `USER_PRESENT` – The user is taking the SCA-triggering action of initiating a transfer. The platform must [redirect the user](/guides/sca/session) using the `PendingUserAction.RedirectUrl` returned so that the user can complete the SCA session (unless Mangopay applied an exemption for low-amount and low-risk transfers, so no redirection link was returned).\n- `USER_NOT_PRESENT` – The platform is taking the action under proxy from the user and the user has previously given consent to Mangopay (via the SCA hosted experience) to allow the action. If the user has not given (or has revoked) their consent, then `USER_NOT_PRESENT` returns a 403 error.\n\nRead more about [managing proxy and user consent](/guides/sca/proxy-management) **&rarr;**\n\n**Note:** For existing platforms, the parameter is technically optional if the debited wallet owner's `UserCategory` is `OWNER`, and the default value will become `USER_PRESENT` from **Dec 15, 2025** (Dec 1 in Sandbox)"},"Id":{"$ref":"#/components/schemas/Id"},"Tag":{"$ref":"#/components/schemas/Tag"},"CreationDate":{"$ref":"#/components/schemas/CreationDate"},"AuthorId":{"$ref":"#/components/schemas/AuthorId"},"CreditedUserId":{"$ref":"#/components/schemas/CreditedUserId"},"DebitedFunds":{"$ref":"#/components/schemas/ViewATransferResponseDebitedFunds","description":"Information about the debited funds."},"CreditedFunds":{"$ref":"#/components/schemas/ViewATransferResponseCreditedFunds","description":"Information about the credited funds (`CreditedFunds` = `DebitedFunds` - `Fees`)."},"Fees":{"$ref":"#/components/schemas/ViewATransferResponseFees","description":"Information about the fees."},"Status":{"$ref":"#/components/schemas/TransactionStatus"},"ResultCode":{"$ref":"#/components/schemas/ResultCode"},"ResultMessage":{"$ref":"#/components/schemas/ResultMessage"},"ExecutionDate":{"$ref":"#/components/schemas/TransactionExecutionDate"},"Type":{"$ref":"#/components/schemas/TransactionType"},"Nature":{"$ref":"#/components/schemas/TransactionNature"},"DebitedWalletId":{"type":"string","description":"The unique identifier of the debited wallet."},"CreditedWalletId":{"type":"string","description":"The unique identifier of the credited wallet."}},"title":"ViewATransferResponse"},"CreateARefundForAPayInRequestDebitedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"required":["Currency","Amount"],"description":"**Default value:** The amount and currency values of the `DebitedFunds` of the initial transaction.\n\nRequired if the `Fees` property is sent.\n\nInformation about the debited funds. The refund `DebitedFunds.Amount`:\n\n- Takes by default the amount and currency of the initial transaction.\n- Must be set manually to perform a partial refund.\n- Cannot exceed the initial transaction `CreditedFunds.Amount` when set manually. This also applies to the sum of debited funds when making multiple partial refunds.","title":"CreateARefundForAPayInRequestDebitedFunds"},"CreateARefundForAPayInRequestFees":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"required":["Currency","Amount"],"description":"**Default value:** The currency and amount (preceded by a minus sign) of the `Fees` of the initial transaction.\n\nRequired if the `DebitedFunds` property is sent.\n\nInformation about the fees. The refund `Fees.Amount`:\n- Must be preceded by a minus sign (-) to refund the fees, otherwise a positive value takes more fees.\n- Takes by default (when not set) the `Fees.Amount` of the initial transaction (preceded by a minus sign).\n- Cannot exceed the initial transaction `Fees.Amount`. This alsoapplies to the sum of amounts when making multiple partial refunds.","title":"CreateARefundForAPayInRequestFees"},"CreateARefundForAPayInRequest":{"type":"object","properties":{"Tag":{"$ref":"#/components/schemas/Tag"},"AuthorId":{"type":"string","description":"The unique identifier of the user at the source of the initial transaction."},"DebitedFunds":{"$ref":"#/components/schemas/CreateARefundForAPayInRequestDebitedFunds","description":"**Default value:** The amount and currency values of the `DebitedFunds` of the initial transaction.\n\nRequired if the `Fees` property is sent.\n\nInformation about the debited funds. The refund `DebitedFunds.Amount`:\n\n- Takes by default the amount and currency of the initial transaction.\n- Must be set manually to perform a partial refund.\n- Cannot exceed the initial transaction `CreditedFunds.Amount` when set manually. This also applies to the sum of debited funds when making multiple partial refunds."},"Fees":{"$ref":"#/components/schemas/CreateARefundForAPayInRequestFees","description":"**Default value:** The currency and amount (preceded by a minus sign) of the `Fees` of the initial transaction.\n\nRequired if the `DebitedFunds` property is sent.\n\nInformation about the fees. The refund `Fees.Amount`:\n- Must be preceded by a minus sign (-) to refund the fees, otherwise a positive value takes more fees.\n- Takes by default (when not set) the `Fees.Amount` of the initial transaction (preceded by a minus sign).\n- Cannot exceed the initial transaction `Fees.Amount`. This alsoapplies to the sum of amounts when making multiple partial refunds."},"StatementDescriptor":{"type":"string","description":"Max. length: 10 characters; only alphanumeric and spaces\n\nCustom description to appear on the user's bank statement along with the platform name. On refunds, the `StatementDescriptor` is only available when refunding SEPA and BACS [direct debit pay-ins](/api-reference/direct-debit-payins/create-direct-debit-payin) (no other payment methods nor transfers).\n\nDifferent banks may show more or less information. See the <a href=\"/bank-statements\">Customizing bank statement references</a> article for details. "}},"required":["AuthorId"],"title":"CreateARefundForAPayInRequest"},"PayInRefundResponseDebitedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"**Default value:** The amount and currency values of the `DebitedFunds` of the initial transaction.\n\nRequired if the `Fees` property is sent.\n\nInformation about the debited funds. The refund `DebitedFunds.Amount`:\n\n- Takes by default the amount and currency of the initial transaction.\n- Must be set manually to perform a partial refund.\n- Cannot exceed the initial transaction `CreditedFunds.Amount` when set manually. This also applies to the sum of debited funds when making multiple partial refunds.","title":"PayInRefundResponseDebitedFunds"},"PayInRefundResponseCreditedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the credited funds (`CreditedFunds` = `DebitedFunds` - `Fees`).","title":"PayInRefundResponseCreditedFunds"},"PayInRefundResponseFees":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"**Default value:** The currency and amount (preceded by a minus sign) of the `Fees` of the initial transaction.\n\nRequired if the `DebitedFunds` property is sent.\n\nInformation about the fees. The refund `Fees.Amount`:\n- Must be preceded by a minus sign (-) to refund the fees, otherwise a positive value takes more fees.\n- Takes by default (when not set) the `Fees.Amount` of the initial transaction (preceded by a minus sign).\n- Cannot exceed the initial transaction `Fees.Amount`. This alsoapplies to the sum of amounts when making multiple partial refunds.","title":"PayInRefundResponseFees"},"PayInRefundResponseRefundReason":{"type":"object","properties":{"RefundReasonMessage":{"type":"string","description":"Message explaining the reason for the refusal."},"RefundReasonType":{"type":"string","description":"**Returned values:** `INITIALIZED_BY_CLIENT`, `BANKACCOUNT_INCORRECT`, `OWNER_DO_NOT_MATCH_BANKACCOUNT`, `BANKACCOUNT_HAS_BEEN_CLOSED`, `WITHDRAWAL_IMPOSSIBLE_ON_SAVINGS_ACCOUNTS`, `OTHER`\n\nThe type of reason for the refund."}},"description":"Information about the reasons for the refund.","title":"PayInRefundResponseRefundReason"},"PayInRefundResponse":{"type":"object","properties":{"Id":{"$ref":"#/components/schemas/Id"},"Tag":{"$ref":"#/components/schemas/Tag"},"CreationDate":{"$ref":"#/components/schemas/CreationDate"},"AuthorId":{"type":"string","description":"The unique identifier of the user at the source of the initial transaction."},"CreditedUserId":{"$ref":"#/components/schemas/CreditedUserId"},"DebitedFunds":{"$ref":"#/components/schemas/PayInRefundResponseDebitedFunds","description":"**Default value:** The amount and currency values of the `DebitedFunds` of the initial transaction.\n\nRequired if the `Fees` property is sent.\n\nInformation about the debited funds. The refund `DebitedFunds.Amount`:\n\n- Takes by default the amount and currency of the initial transaction.\n- Must be set manually to perform a partial refund.\n- Cannot exceed the initial transaction `CreditedFunds.Amount` when set manually. This also applies to the sum of debited funds when making multiple partial refunds."},"CreditedFunds":{"$ref":"#/components/schemas/PayInRefundResponseCreditedFunds","description":"Information about the credited funds (`CreditedFunds` = `DebitedFunds` - `Fees`)."},"Fees":{"$ref":"#/components/schemas/PayInRefundResponseFees","description":"**Default value:** The currency and amount (preceded by a minus sign) of the `Fees` of the initial transaction.\n\nRequired if the `DebitedFunds` property is sent.\n\nInformation about the fees. The refund `Fees.Amount`:\n- Must be preceded by a minus sign (-) to refund the fees, otherwise a positive value takes more fees.\n- Takes by default (when not set) the `Fees.Amount` of the initial transaction (preceded by a minus sign).\n- Cannot exceed the initial transaction `Fees.Amount`. This alsoapplies to the sum of amounts when making multiple partial refunds."},"Status":{"$ref":"#/components/schemas/TransactionStatus"},"ResultCode":{"$ref":"#/components/schemas/ResultCode"},"ResultMessage":{"$ref":"#/components/schemas/ResultMessage"},"ExecutionDate":{"$ref":"#/components/schemas/TransactionExecutionDate"},"Type":{"$ref":"#/components/schemas/TransactionType"},"Nature":{"$ref":"#/components/schemas/TransactionNature"},"InitialTransactionId":{"type":"string","description":"The unique identifier of the initial transaction being refunded."},"InitialTransactionType":{"type":"string","description":"**Returned values:** `PAYIN`, `TRANSFER`, `PAYOUT`\n\nThe type of the initial transaction being refunded."},"InitialTransactionNature":{"type":"string","description":"**Returned values:** `REGULAR`, `REPUDIATION`, `REFUND`, `SETTLEMENT`\n\nThe nature of the initial transaction being refunded, providing more information about the context in which the transaction occurred:\n- REGULAR – Relative to most of the transactions (pay-ins, payouts, and transfers) in a usual workflow.\n- REPUDIATION – Automatic withdrawal of funds from the platform's repudiation wallet as part of the dispute process (when the user requested a chargeback).\n- REFUND – Reimbursement of a transaction to the user (pay-in refund), to a wallet (transfer refund), or of a payout (payout refund, only initiated by Mangopay).\n- SETTLEMENT – Transfer made to the repudiation wallet by the platform to settle the credit from a repudiation following a lost dispute."},"DebitedWalletId":{"type":"string","description":"The unique identifier of the debited wallet."},"CreditedWalletId":{"type":"string","description":"The unique identifier of the credited wallet."},"RefundReason":{"$ref":"#/components/schemas/PayInRefundResponseRefundReason","description":"Information about the reasons for the refund."},"StatementDescriptor":{"type":"string","description":"Max. length: 10 characters; only alphanumeric and spaces\n\nCustom description to appear on the user's bank statement along with the platform name. On refunds, the `StatementDescriptor` is only available when refunding SEPA and BACS [direct debit pay-ins](/api-reference/direct-debit-payins/create-direct-debit-payin) (no other payment methods nor transfers).\n\nDifferent banks may show more or less information. See the <a href=\"/bank-statements\">Customizing bank statement references</a> article for details. "}},"title":"PayInRefundResponse"},"CreateARefundForATransferRequestDebitedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"required":["Currency","Amount"],"description":"Information about the debited funds.","title":"CreateARefundForATransferRequestDebitedFunds"},"CreateARefundForATransferRequestFees":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"required":["Currency","Amount"],"description":"Information about the fees.","title":"CreateARefundForATransferRequestFees"},"CreateARefundForATransferRequest":{"type":"object","properties":{"Tag":{"$ref":"#/components/schemas/Tag"},"AuthorId":{"type":"string","description":"The unique identifier of the user at the source of the initial transaction."},"DebitedFunds":{"$ref":"#/components/schemas/CreateARefundForATransferRequestDebitedFunds","description":"Information about the debited funds."},"Fees":{"$ref":"#/components/schemas/CreateARefundForATransferRequestFees","description":"Information about the fees."}},"required":["AuthorId"],"title":"CreateARefundForATransferRequest"},"TransferRefundResponseDebitedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the debited funds.","title":"TransferRefundResponseDebitedFunds"},"TransferRefundResponseCreditedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the credited funds (`CreditedFunds` = `DebitedFunds` - `Fees`).","title":"TransferRefundResponseCreditedFunds"},"TransferRefundResponseFees":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the fees.","title":"TransferRefundResponseFees"},"TransferRefundResponseRefundReason":{"type":"object","properties":{"RefundReasonMessage":{"type":"string","description":"Message explaining the reason for the refusal."},"RefundReasonType":{"type":"string","description":"**Returned values:** `INITIALIZED_BY_CLIENT`, `BANKACCOUNT_INCORRECT`, `OWNER_DO_NOT_MATCH_BANKACCOUNT`, `BANKACCOUNT_HAS_BEEN_CLOSED`, `WITHDRAWAL_IMPOSSIBLE_ON_SAVINGS_ACCOUNTS`, `OTHER`\n\nThe type of reason for the refund."}},"description":"Information about the reasons for the refund.","title":"TransferRefundResponseRefundReason"},"TransferRefundResponse":{"type":"object","properties":{"Id":{"$ref":"#/components/schemas/Id"},"Tag":{"$ref":"#/components/schemas/Tag"},"CreationDate":{"$ref":"#/components/schemas/CreationDate"},"AuthorId":{"type":"string","description":"The unique identifier of the user at the source of the initial transaction."},"CreditedUserId":{"$ref":"#/components/schemas/CreditedUserId"},"DebitedFunds":{"$ref":"#/components/schemas/TransferRefundResponseDebitedFunds","description":"Information about the debited funds."},"CreditedFunds":{"$ref":"#/components/schemas/TransferRefundResponseCreditedFunds","description":"Information about the credited funds (`CreditedFunds` = `DebitedFunds` - `Fees`)."},"Fees":{"$ref":"#/components/schemas/TransferRefundResponseFees","description":"Information about the fees."},"Status":{"$ref":"#/components/schemas/TransactionStatus"},"ResultCode":{"$ref":"#/components/schemas/ResultCode"},"ResultMessage":{"$ref":"#/components/schemas/ResultMessage"},"ExecutionDate":{"$ref":"#/components/schemas/TransactionExecutionDate"},"Type":{"$ref":"#/components/schemas/TransactionType"},"Nature":{"$ref":"#/components/schemas/TransactionNature"},"InitialTransactionId":{"type":"string","description":"The unique identifier of the initial transaction being refunded."},"InitialTransactionType":{"type":"string","description":"**Returned values:** `PAYIN`, `TRANSFER`, `PAYOUT`\n\nThe type of the initial transaction being refunded."},"InitialTransactionNature":{"type":"string","description":"**Returned values:** `REGULAR`, `REPUDIATION`, `REFUND`, `SETTLEMENT`\n\nThe nature of the initial transaction being refunded, providing more information about the context in which the transaction occurred:\n- REGULAR – Relative to most of the transactions (pay-ins, payouts, and transfers) in a usual workflow.\n- REPUDIATION – Automatic withdrawal of funds from the platform's repudiation wallet as part of the dispute process (when the user requested a chargeback).\n- REFUND – Reimbursement of a transaction to the user (pay-in refund), to a wallet (transfer refund), or of a payout (payout refund, only initiated by Mangopay).\n- SETTLEMENT – Transfer made to the repudiation wallet by the platform to settle the credit from a repudiation following a lost dispute."},"DebitedWalletId":{"type":"string","description":"The unique identifier of the debited wallet."},"CreditedWalletId":{"type":"string","description":"The unique identifier of the credited wallet."},"RefundReason":{"$ref":"#/components/schemas/TransferRefundResponseRefundReason","description":"Information about the reasons for the refund."}},"title":"TransferRefundResponse"},"PayoutRefundResponseDebitedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the debited funds.","title":"PayoutRefundResponseDebitedFunds"},"PayoutRefundResponseCreditedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the credited funds (`CreditedFunds` = `DebitedFunds` - `Fees`).","title":"PayoutRefundResponseCreditedFunds"},"PayoutRefundResponseFees":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the fees.","title":"PayoutRefundResponseFees"},"PayoutRefundResponseRefundReason":{"type":"object","properties":{"RefundReasonMessage":{"type":"string","description":"Message explaining the reason for the refusal (for example, a bank return code)."},"RefundReasonType":{"type":"string","description":"**Returned values:** `INITIALIZED_BY_CLIENT`, `BANKACCOUNT_INCORRECT`, `OWNER_DO_NOT_MATCH_BANKACCOUNT`, `BANKACCOUNT_HAS_BEEN_CLOSED`, `WITHDRAWAL_IMPOSSIBLE_ON_SAVINGS_ACCOUNTS`, `OTHER`\n\nThe type of reason for the payout return."}},"description":"Information about the reasons for the payout return.","title":"PayoutRefundResponseRefundReason"},"PayoutRefundResponse":{"type":"object","properties":{"Id":{"$ref":"#/components/schemas/Id"},"Tag":{"$ref":"#/components/schemas/Tag"},"CreationDate":{"$ref":"#/components/schemas/CreationDate"},"AuthorId":{"type":"string","description":"The unique identifier of the user at the source of the initial transaction."},"CreditedUserId":{"$ref":"#/components/schemas/CreditedUserId"},"DebitedFunds":{"$ref":"#/components/schemas/PayoutRefundResponseDebitedFunds","description":"Information about the debited funds."},"CreditedFunds":{"$ref":"#/components/schemas/PayoutRefundResponseCreditedFunds","description":"Information about the credited funds (`CreditedFunds` = `DebitedFunds` - `Fees`)."},"Fees":{"$ref":"#/components/schemas/PayoutRefundResponseFees","description":"Information about the fees."},"Status":{"$ref":"#/components/schemas/TransactionStatus"},"ResultCode":{"$ref":"#/components/schemas/ResultCode"},"ResultMessage":{"$ref":"#/components/schemas/ResultMessage"},"ExecutionDate":{"$ref":"#/components/schemas/TransactionExecutionDate"},"Type":{"type":"string","description":"**Returned values:** `PAYIN`\n\nThe type of the transaction. Payout returns are recorded as pay-ins crediting the wallet from which the payout was sent."},"Nature":{"$ref":"#/components/schemas/TransactionNature"},"InitialTransactionId":{"type":"string","description":"The unique identifier of the initial payout being refunded."},"InitialTransactionType":{"type":"string","description":"**Returned values:** `PAYOUT`\n\nThe type of the initial transaction being refunded."},"InitialTransactionNature":{"type":"string","description":"**Returned values:** `REGULAR`\n\nThe nature of the initial transaction being refunded."},"DebitedWalletId":{"type":"string","description":"The unique identifier of the debited wallet. Not returned for payout returns."},"CreditedWalletId":{"type":"string","description":"The unique identifier of the wallet re-credited with the returned funds."},"RefundReason":{"$ref":"#/components/schemas/PayoutRefundResponseRefundReason","description":"Information about the reasons for the payout return."},"StatementDescriptor":{"type":"string","description":"Max. length: 10 characters; only alphanumeric and spaces\n\nCustom description to appear on the user's bank statement along with the platform name. Different banks may show more or less information. See the <a href=\"/bank-statements\">Customizing bank statement references</a> article for details.\n\n**Note:** On refunds, the `StatementDescriptor` is only available for SEPA and BACS [direct debit pay-ins](/api-reference/direct-debit-payins/create-direct-debit-payin) (no other payment methods nor transfers)."}},"description":"A payout return — a refund of a payout, initiated automatically by Mangopay when funds cannot be delivered to the recipient bank account.","title":"PayoutRefundResponse"},"RepudiationRefundResponseDebitedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the debited funds.","title":"RepudiationRefundResponseDebitedFunds"},"RepudiationRefundResponseCreditedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the credited funds (`CreditedFunds` = `DebitedFunds` - `Fees`).","title":"RepudiationRefundResponseCreditedFunds"},"RepudiationRefundResponseFees":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the fees.","title":"RepudiationRefundResponseFees"},"RepudiationRefundResponseRefundReason":{"type":"object","properties":{"RefundReasonMessage":{"type":"string","description":"Message explaining the reason for the refund."},"RefundReasonType":{"type":"string","description":"**Returned values:** `INITIALIZED_BY_CLIENT`, `BANKACCOUNT_INCORRECT`, `OWNER_DO_NOT_MATCH_BANKACCOUNT`, `BANKACCOUNT_HAS_BEEN_CLOSED`, `WITHDRAWAL_IMPOSSIBLE_ON_SAVINGS_ACCOUNTS`, `OTHER`\n\nThe type of reason for the refund."}},"description":"Information about the reasons for the repudiation return.","title":"RepudiationRefundResponseRefundReason"},"RepudiationRefundResponse":{"type":"object","properties":{"Id":{"$ref":"#/components/schemas/Id"},"Tag":{"$ref":"#/components/schemas/Tag"},"CreationDate":{"$ref":"#/components/schemas/CreationDate"},"AuthorId":{"type":"string","description":"The unique identifier of the user at the source of the initial transaction."},"CreditedUserId":{"$ref":"#/components/schemas/CreditedUserId"},"DebitedFunds":{"$ref":"#/components/schemas/RepudiationRefundResponseDebitedFunds","description":"Information about the debited funds."},"CreditedFunds":{"$ref":"#/components/schemas/RepudiationRefundResponseCreditedFunds","description":"Information about the credited funds (`CreditedFunds` = `DebitedFunds` - `Fees`)."},"Fees":{"$ref":"#/components/schemas/RepudiationRefundResponseFees","description":"Information about the fees."},"Status":{"$ref":"#/components/schemas/TransactionStatus"},"ResultCode":{"$ref":"#/components/schemas/ResultCode"},"ResultMessage":{"$ref":"#/components/schemas/ResultMessage"},"ExecutionDate":{"$ref":"#/components/schemas/TransactionExecutionDate"},"Type":{"type":"string","description":"**Returned values:** `PAYIN`\n\nThe type of the transaction. Repudiation returns are recorded as pay-ins crediting the Repudiation Wallet."},"Nature":{"$ref":"#/components/schemas/TransactionNature"},"InitialTransactionId":{"type":"string","description":"The unique identifier of the initial repudiation being refunded."},"InitialTransactionType":{"type":"string","description":"**Returned values:** `PAYOUT`\n\nThe type of the initial transaction being refunded."},"InitialTransactionNature":{"type":"string","description":"**Returned values:** `REPUDIATION`\n\nThe nature of the initial transaction being refunded."},"DebitedWalletId":{"type":"string","description":"The unique identifier of the debited wallet. Not returned for repudiation returns."},"CreditedWalletId":{"type":"string","description":"The unique identifier of the Repudiation Wallet re-credited with the returned funds (for example, `CREDIT_EUR`)."},"RefundReason":{"$ref":"#/components/schemas/RepudiationRefundResponseRefundReason","description":"Information about the reasons for the repudiation return."},"StatementDescriptor":{"type":"string","description":"Max. length: 10 characters; only alphanumeric and spaces\n\nCustom description to appear on the user's bank statement along with the platform name. Different banks may show more or less information. See the <a href=\"/bank-statements\">Customizing bank statement references</a> article for details.\n\n**Note:** On refunds, the `StatementDescriptor` is only available for SEPA and BACS [direct debit pay-ins](/api-reference/direct-debit-payins/create-direct-debit-payin) (no other payment methods nor transfers)."}},"description":"A repudiation return — a refund created automatically by Mangopay when a dispute is won in favor of the platform, re-crediting the Repudiation Wallet.","title":"RepudiationRefundResponse"},"ViewARefundResponse":{"oneOf":[{"$ref":"#/components/schemas/PayInRefundResponse"},{"$ref":"#/components/schemas/TransferRefundResponse"},{"$ref":"#/components/schemas/PayoutRefundResponse"},{"$ref":"#/components/schemas/RepudiationRefundResponse"}],"title":"ViewARefundResponse"},"ListRefundsForAPayInResponseArrayRefundsItems":{"type":"object","properties":{"Object (Refund)":{"$ref":"#/components/schemas/PayInRefundResponse"}},"title":"ListRefundsForAPayInResponseArrayRefundsItems"},"ListRefundsForAPayInResponse":{"type":"object","properties":{"Array (Refunds)":{"type":"array","items":{"$ref":"#/components/schemas/ListRefundsForAPayInResponseArrayRefundsItems"},"description":"The list of refunds created by the platform."}},"title":"ListRefundsForAPayInResponse"},"ListRefundsForATransferResponseArrayRefundsItems":{"type":"object","properties":{"Object (Refund)":{"$ref":"#/components/schemas/TransferRefundResponse"}},"title":"ListRefundsForATransferResponseArrayRefundsItems"},"ListRefundsForATransferResponse":{"type":"object","properties":{"Array (Refunds)":{"type":"array","items":{"$ref":"#/components/schemas/ListRefundsForATransferResponseArrayRefundsItems"},"description":"The list of refunds created by the platform."}},"title":"ListRefundsForATransferResponse"},"ListRefundsForAPayoutResponseArrayRefundsItems":{"type":"object","properties":{"Object (Refund)":{"$ref":"#/components/schemas/PayoutRefundResponse"}},"title":"ListRefundsForAPayoutResponseArrayRefundsItems"},"ListRefundsForAPayoutResponse":{"type":"object","properties":{"Array (Refunds)":{"type":"array","items":{"$ref":"#/components/schemas/ListRefundsForAPayoutResponseArrayRefundsItems"},"description":"The list of payout refunds created for the platform."}},"title":"ListRefundsForAPayoutResponse"},"ListRefundsForARepudiationResponseArrayRefundsItems":{"type":"object","properties":{"Object (Refund)":{"$ref":"#/components/schemas/RepudiationRefundResponse"}},"title":"ListRefundsForARepudiationResponseArrayRefundsItems"},"ListRefundsForARepudiationResponse":{"type":"object","properties":{"Array (Refunds)":{"type":"array","items":{"$ref":"#/components/schemas/ListRefundsForARepudiationResponseArrayRefundsItems"},"description":"The list of refunds created by the platform."}},"title":"ListRefundsForARepudiationResponse"},"DisputeResponseDisputedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the amount the disputed funds.\n\nThis amount can be lower than the initial transaction amount.","title":"DisputeResponseDisputedFunds"},"DisputeResponseContestedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the contested funds, in other words, the amount that you wish to contest.\n\nThis amount can be lower than the disputed funds amount.","title":"DisputeResponseContestedFunds"},"DisputeResponseDisputeReason":{"type":"object","properties":{"DisputeReasonType":{"type":"string","description":"The reason for the dispute."},"DisputeReasonMessage":{"type":"string","description":"Additional information about the reason for the dispute sent by Mangopay teams."}},"description":"Information about the reasons for the dispute.","title":"DisputeResponseDisputeReason"},"DisputeResponse":{"type":"object","properties":{"InitialTransactionId":{"type":"string","description":"The unique identifier of the initial pay-in being disputed."},"InitialTransactionType":{"type":"string","description":"**Returned values:** `PAYIN`\n\nThe type of the initial transaction being disputed."},"InitialTransactionNature":{"type":"string","description":"**Returned values:** `REGULAR`\n\nThe nature of the initial transaction being disputed."},"DisputeType":{"type":"string","description":"**Returned values:** `CONTESTABLE`, `NOT_CONTESTABLE`, `RETRIEVAL`\n\nThe type of dispute:\n- `CONTESTABLE` – Dispute for which the chargeback can be contested by providing proof (i.e., Dispute Documents) justifying the original transaction.\n- `NOT_CONTESTABLE` – Dispute that is automatically closed after its creation, without any action possible for the platform.\n- `RETRIEVAL` – Dispute that is actually a chargeback warning issued by the bank. The platform is required to provide documents, but no funds will be taken from the Repudiation Wallet."},"ContestDeadlineDate":{"type":"integer","description":"The date and time until which the platform can contest the dispute (i.e., the `Status` is set to `SUBMITTED`). This date is defined by the issuing bank of the initial transaction and may usually vary between 7 to 18 days. Once the deadline passes, the dispute `Status` is automatically set to `CLOSED`."},"DisputedFunds":{"$ref":"#/components/schemas/DisputeResponseDisputedFunds","description":"Information about the amount the disputed funds.\n\nThis amount can be lower than the initial transaction amount."},"ContestedFunds":{"$ref":"#/components/schemas/DisputeResponseContestedFunds","description":"Information about the contested funds, in other words, the amount that you wish to contest.\n\nThis amount can be lower than the disputed funds amount."},"Status":{"type":"string","description":"**Returned values:** `CREATED`, `PENDING_CLIENT_ACTION`, `SUBMITTED`, `PENDING_BANK_ACTION`, `REOPENED_PENDING_CLIENT_ACTION`, `CLOSED`\n\nThe status of the dispute:\n- `CREATED` – The dispute is created.\n- `PENDING_CLIENT_ACTION` – The dispute was not closed automatically upon its creation, it now requires some actions from the platform (either submission after providing the relevant proofs or closing).\n- `SUBMITTED` – The dispute is submitted by the platform for the Mangopay team to review the documents.\n- `PENDING_BANK_ACTION` – Mangopay accepted the documents and passed them on to the bank for them to review the dispute contestation. They will either reject or accept the contestation, or require further documents.\n- `REOPENED_PENDING_CLIENT_ACTION` – Mangopay didn't accept the documents and requires more information or documents before sending the documents to the bank.\n- `CLOSED` – The dispute is closed."},"StatusMessage":{"type":"string","description":"Additional information about the dispute `Status` communicated by Mangopay teams."},"DisputeReason":{"$ref":"#/components/schemas/DisputeResponseDisputeReason","description":"Information about the reasons for the dispute."},"ResultCode":{"type":"string","description":"**Returned values:** `LOST`, `WON`, `VOID`\n\nThe result of the dispute for the platform, which can be:\n- `LOST` – The platform lost the dispute and must settle its debt to Mangopay with a Settlement Transfer.\n- `WON` – The platform won the dispute, the disputed funds will be credited back to the Repudiation Wallet.\n- `VOID` – The dispute has been canceled."},"ResultMessage":{"$ref":"#/components/schemas/ResultMessage"},"Id":{"$ref":"#/components/schemas/Id"},"Tag":{"$ref":"#/components/schemas/Tag"},"CreationDate":{"$ref":"#/components/schemas/CreationDate"},"ClosedDate":{"type":"integer","description":"The date and time the dispute was closed (i.e., its `Status` is set to `CLOSED`).\n\n**Note:** This value will be `null` for any Dispute closed before February 16th, 2023."},"RepudiationId":{"type":"string","description":"The unique identifier of the repudiation."}},"title":"DisputeResponse"},"SubmitADisputeRequestContestedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"required":["Currency","Amount"],"description":"Information about the debited funds.","title":"SubmitADisputeRequestContestedFunds"},"SubmitADisputeRequest":{"type":"object","properties":{"ContestedFunds":{"$ref":"#/components/schemas/SubmitADisputeRequestContestedFunds","description":"Information about the debited funds."}},"required":["ContestedFunds"],"title":"SubmitADisputeRequest"},"ListAllDisputesResponseArrayDisputesItemsObjectDisputeDisputedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the amount the disputed funds.\n\nThis amount can be lower than the initial transaction amount.","title":"ListAllDisputesResponseArrayDisputesItemsObjectDisputeDisputedFunds"},"ListAllDisputesResponseArrayDisputesItemsObjectDisputeContestedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the contested funds, in other words, the amount that you wish to contest.\n\nThis amount can be lower than the disputed funds amount.","title":"ListAllDisputesResponseArrayDisputesItemsObjectDisputeContestedFunds"},"ListAllDisputesResponseArrayDisputesItemsObjectDisputeDisputeReason":{"type":"object","properties":{"DisputeReasonType":{"type":"string","description":"The reason for the dispute."},"DisputeReasonMessage":{"type":"string","description":"Additional information about the reason for the dispute sent by Mangopay teams."}},"description":"Information about the reasons for the dispute.","title":"ListAllDisputesResponseArrayDisputesItemsObjectDisputeDisputeReason"},"ListAllDisputesResponseArrayDisputesItemsObjectDispute":{"type":"object","properties":{"InitialTransactionId":{"type":"string","description":"The unique identifier of the initial pay-in being disputed."},"InitialTransactionType":{"type":"string","description":"**Returned values:** `PAYIN`\n\nThe type of the initial transaction being disputed."},"InitialTransactionNature":{"type":"string","description":"**Returned values:** `REGULAR`, `REPUDIATION`, `REFUND`, `SETTLEMENT`\n\nThe nature of the initial transaction being refunded, providing more information about the context in which the transaction occurred:\n- REGULAR – Relative to most of the transactions (pay-ins, payouts, and transfers) in a usual workflow.\n- REPUDIATION – Automatic withdrawal of funds from the platform's repudiation wallet as part of the dispute process (when the user requested a chargeback).\n- REFUND – Reimbursement of a transaction to the user (pay-in refund), to a wallet (transfer refund), or of a payout (payout refund, only initiated by Mangopay).\n- SETTLEMENT – Transfer made to the repudiation wallet by the platform to settle the credit from a repudiation following a lost dispute."},"DisputeType":{"type":"string","description":"**Returned values:** `CONTESTABLE`, `NOT_CONTESTABLE`, `RETRIEVAL`\n\nThe type of dispute:\n- `CONTESTABLE` – Dispute for which the chargeback can be contested by providing proof (i.e., Dispute Documents) justifying the original transaction.\n- `NOT_CONTESTABLE` – Dispute that is automatically closed after its creation, without any action possible for the platform.\n- `RETRIEVAL` – Dispute that is actually a chargeback warning issued by the bank. The platform is required to provide documents, but no funds will be taken from the Repudiation Wallet."},"ContestDeadlineDate":{"type":"integer","description":"The date and time until which the platform can contest the dispute (i.e., the `Status` is set to `SUBMITTED`). This date is defined by the issuing bank of the initial transaction and may usually vary between 7 to 18 days. Once the deadline passes, the dispute `Status` is automatically set to `CLOSED`."},"DisputedFunds":{"$ref":"#/components/schemas/ListAllDisputesResponseArrayDisputesItemsObjectDisputeDisputedFunds","description":"Information about the amount the disputed funds.\n\nThis amount can be lower than the initial transaction amount."},"ContestedFunds":{"$ref":"#/components/schemas/ListAllDisputesResponseArrayDisputesItemsObjectDisputeContestedFunds","description":"Information about the contested funds, in other words, the amount that you wish to contest.\n\nThis amount can be lower than the disputed funds amount."},"Status":{"type":"string","description":"**Returned values:** `CREATED`, `PENDING_CLIENT_ACTION`, `SUBMITTED`, `PENDING_BANK_ACTION`, `REOPENED_PENDING_CLIENT_ACTION`, `CLOSED`\n\nThe status of the dispute:\n- `CREATED` – The dispute is created.\n- `PENDING_CLIENT_ACTION` – The dispute was not closed automatically upon its creation, it now requires some actions from the platform (either submission after providing the relevant proofs or closing).\n- `SUBMITTED` – The dispute is submitted by the platform for the Mangopay team to review the documents.\n- `PENDING_BANK_ACTION` – Mangopay accepted the documents and passed them on to the bank for them to review the dispute contestation. They will either reject or accept the contestation, or require further documents.\n- `REOPENED_PENDING_CLIENT_ACTION` – Mangopay didn't accept the documents and requires more information or documents before sending the documents to the bank.\n- `CLOSED` – The dispute is closed."},"StatusMessage":{"type":"string","description":"Additional information about the dispute `Status` communicated by Mangopay teams."},"DisputeReason":{"$ref":"#/components/schemas/ListAllDisputesResponseArrayDisputesItemsObjectDisputeDisputeReason","description":"Information about the reasons for the dispute."},"ResultCode":{"type":"string","description":"**Returned values:** `LOST`, `WON`, `VOID`\n\nThe result of the dispute for the platform, which can be:\n- `LOST` – The platform lost the dispute and must settle its debt to Mangopay with a Settlement Transfer.\n- `WON` – The platform won the dispute, the disputed funds will be credited back to the Repudiation Wallet.\n- `VOID` – The dispute has been canceled."},"ResultMessage":{"$ref":"#/components/schemas/ResultMessage"},"Id":{"$ref":"#/components/schemas/Id"},"Tag":{"type":"string","description":"Custom data that you can add to this object."},"CreationDate":{"$ref":"#/components/schemas/CreationDate"},"ClosedDate":{"type":"integer","description":"The date and time the dispute was closed (i.e., its `Status` is set to `CLOSED`).\n\n**Note:** This value will be `null` for any Dispute closed before February 16th, 2023."},"RepudiationId":{"type":"string","description":"The unique identifier of the repudiation."}},"description":"The dispute automatically created by Mangopay.","title":"ListAllDisputesResponseArrayDisputesItemsObjectDispute"},"ListAllDisputesResponseArrayDisputesItems":{"type":"object","properties":{"Object (Dispute)":{"$ref":"#/components/schemas/ListAllDisputesResponseArrayDisputesItemsObjectDispute","description":"The dispute automatically created by Mangopay."}},"title":"ListAllDisputesResponseArrayDisputesItems"},"ListAllDisputesResponse":{"type":"object","properties":{"Array (Disputes)":{"type":"array","items":{"$ref":"#/components/schemas/ListAllDisputesResponseArrayDisputesItems"},"description":"The list of disputes automatically created by Mangopay."}},"title":"ListAllDisputesResponse"},"DisputeDocumentResponse":{"type":"object","properties":{"DisputeId":{"type":"string","description":"The unique identifier of the dispute."},"Type":{"type":"string","description":"**Returned values:** `DELIVERY_PROOF`, `INVOICE`, `REFUND_PROOF`, `USER_CORRESPONDANCE`, `USER_ACCEPTANCE_PROOF`, `PRODUCT_REPLACEMENT_PROOF`, `OTHER`\n\nThe type of the dispute document."},"Id":{"$ref":"#/components/schemas/Id"},"Tag":{"$ref":"#/components/schemas/Tag"},"CreationDate":{"$ref":"#/components/schemas/CreationDate"},"ProcessedDate":{"type":"integer","description":"Unix timestamp (UTC) of the date and time the document was processed by Mangopay's team."},"Status":{"type":"string","description":"**Returned values:** `CREATED`, `VALIDATION_ASKED`, `VALIDATED`, `REFUSED`, `OUT_OF_DATE`\n\nThe status of the dispute document."},"RefusedReasonType":{"type":"string","description":"**Returned values:** DOCUMENT_DO_NOT_MATCH_USER_DATA, DOCUMENT_FALSIFIED, DOCUMENT_HAS_EXPIRED, DOCUMENT_INCOMPLETE, DOCUMENT_MISSING, DOCUMENT_NOT_ACCEPTED, DOCUMENT_UNREADABLE, SPECIFIC_CASE, UNDERAGE_PERSON\n\nThe reason for the dispute document refusal. See the <inline-code>RefusedReasonMessage</inline-code> for more information."},"RefusedReasonMessage":{"type":"string","description":"Max. length: 255 characters\n\n**Default value:** null Additional information about why the dispute document was refused, provided by Mangopay's team."}},"title":"DisputeDocumentResponse"},"ListAllDisputeDocumentsResponseArrayDisputeDocumentsItemsObjectDisputeDocument":{"type":"object","properties":{"DisputeId":{"type":"string","description":"The unique identifier of the dispute."},"Type":{"type":"string","description":"**Returned values:** `DELIVERY_PROOF`, `INVOICE`, `REFUND_PROOF`, `USER_CORRESPONDANCE`, `USER_ACCEPTANCE_PROOF`, `PRODUCT_REPLACEMENT_PROOF`, `OTHER`\n\nThe type of the dispute document."},"Id":{"$ref":"#/components/schemas/Id"},"Tag":{"type":"string","description":"Custom data that you can add to this object."},"CreationDate":{"$ref":"#/components/schemas/CreationDate"},"ProcessedDate":{"type":"integer","description":"Unix timestamp (UTC) of the date and time the document was processed by Mangopay's team."},"Status":{"type":"string","description":"**Returned values:** `CREATED`, `VALIDATION_ASKED`, `VALIDATED`, `REFUSED`, `OUT_OF_DATE`\n\nThe status of the dispute document."},"RefusedReasonType":{"type":"string","description":"**Returned values:** DOCUMENT_DO_NOT_MATCH_USER_DATA, DOCUMENT_FALSIFIED, DOCUMENT_HAS_EXPIRED, DOCUMENT_INCOMPLETE, DOCUMENT_MISSING, DOCUMENT_NOT_ACCEPTED, DOCUMENT_UNREADABLE, SPECIFIC_CASE, UNDERAGE_PERSON\n\nThe reason for the dispute document refusal. See the <inline-code>RefusedReasonMessage</inline-code> for more information."},"RefusedReasonMessage":{"type":"string","description":"**Default value:** null\n\nAdditional information about why the KYC Document was refused, provided by Mangopay's team."}},"description":"The dispute document created by the platform.","title":"ListAllDisputeDocumentsResponseArrayDisputeDocumentsItemsObjectDisputeDocument"},"ListAllDisputeDocumentsResponseArrayDisputeDocumentsItems":{"type":"object","properties":{"Object (Dispute document)":{"$ref":"#/components/schemas/ListAllDisputeDocumentsResponseArrayDisputeDocumentsItemsObjectDisputeDocument","description":"The dispute document created by the platform."}},"title":"ListAllDisputeDocumentsResponseArrayDisputeDocumentsItems"},"ListAllDisputeDocumentsResponse":{"type":"object","properties":{"Array (Dispute documents)":{"type":"array","items":{"$ref":"#/components/schemas/ListAllDisputeDocumentsResponseArrayDisputeDocumentsItems"},"description":"The list of dispute documents created by the platform."}},"title":"ListAllDisputeDocumentsResponse"},"disputeDocuments_create_dispute_document_page_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"disputeDocuments_create_dispute_document_page_Response_200"},"DisputeDocumentWeblinkResponseArrayDisputeDocumentPagesItemsObjectPage":{"type":"object","properties":{},"description":"The dispute document page created by the platform.","title":"DisputeDocumentWeblinkResponseArrayDisputeDocumentPagesItemsObjectPage"},"DisputeDocumentWeblinkResponseArrayDisputeDocumentPagesItems":{"type":"object","properties":{"Object (Page)":{"$ref":"#/components/schemas/DisputeDocumentWeblinkResponseArrayDisputeDocumentPagesItemsObjectPage","description":"The dispute document page created by the platform."}},"title":"DisputeDocumentWeblinkResponseArrayDisputeDocumentPagesItems"},"DisputeDocumentWeblinkResponse":{"type":"object","properties":{"Array (Dispute Document Pages)":{"type":"array","items":{"$ref":"#/components/schemas/DisputeDocumentWeblinkResponseArrayDisputeDocumentPagesItems"},"description":"The list of Dispute Document Pages created by the platform."}},"title":"DisputeDocumentWeblinkResponse"},"RepudiationResponseCreditedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the credited funds (`CreditedFunds` = `DebitedFunds` - `Fees`).","title":"RepudiationResponseCreditedFunds"},"RepudiationResponseDebitedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the debited funds.","title":"RepudiationResponseDebitedFunds"},"RepudiationResponseFees":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the fees.","title":"RepudiationResponseFees"},"RepudiationResponse":{"type":"object","properties":{"AuthorId":{"type":"string","description":"The unique identifier of the user at the source of the initial transaction."},"CreditedUserId":{"type":"string","description":"The unique identifier of the user whose wallet is credited. In the specific case of the Payout object, this value is always `null` since there is no credited wallet."},"CreditedFunds":{"$ref":"#/components/schemas/RepudiationResponseCreditedFunds","description":"Information about the credited funds (`CreditedFunds` = `DebitedFunds` - `Fees`)."},"Status":{"$ref":"#/components/schemas/TransactionStatus"},"ExecutionDate":{"$ref":"#/components/schemas/TransactionExecutionDate"},"Type":{"$ref":"#/components/schemas/TransactionType"},"Nature":{"$ref":"#/components/schemas/TransactionNature"},"CreditedWalletId":{"type":"string","description":"The unique identifier of the credited wallet. In the specific case of the Payout object, this value is always `null` since there is no credited wallet."},"DebitedFunds":{"$ref":"#/components/schemas/RepudiationResponseDebitedFunds","description":"Information about the debited funds."},"Fees":{"$ref":"#/components/schemas/RepudiationResponseFees","description":"Information about the fees."},"ResultCode":{"$ref":"#/components/schemas/ResultCode"},"ResultMessage":{"$ref":"#/components/schemas/ResultMessage"},"Id":{"$ref":"#/components/schemas/Id"},"Tag":{"$ref":"#/components/schemas/Tag"},"CreationDate":{"$ref":"#/components/schemas/CreationDate"},"InitialTransactionId":{"type":"string","description":"The unique identifier of the initial transaction being refunded."},"InitialTransactionType":{"type":"string","description":"**Returned values:** `PAYIN`, `TRANSFER`, `PAYOUT`\n\nThe type of the initial transaction being refunded."},"InitialTransactionNature":{"type":"string","description":"**Returned values:** `REGULAR`, `REPUDIATION`, `REFUND`, `SETTLEMENT`\n\nThe nature of the initial transaction being refunded, providing more information about the context in which the transaction occurred:\n- REGULAR – Relative to most of the transactions (pay-ins, payouts, and transfers) in a usual workflow.\n- REPUDIATION – Automatic withdrawal of funds from the platform's repudiation wallet as part of the dispute process (when the user requested a chargeback).\n- REFUND – Reimbursement of a transaction to the user (pay-in refund), to a wallet (transfer refund), or of a payout (payout refund, only initiated by Mangopay).\n- SETTLEMENT – Transfer made to the repudiation wallet by the platform to settle the credit from a repudiation following a lost dispute."}},"title":"RepudiationResponse"},"CreateASettlementTransferRequestDebitedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"required":["Currency","Amount"],"description":"Information about the debited funds. Please note that:\n\n- The `Currency` must be identical to that of the initial transaction.\n- The `Amount` cannot exceed the initial's transaction minus the fees.","title":"CreateASettlementTransferRequestDebitedFunds"},"CreateASettlementTransferRequestFees":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"required":["Currency","Amount"],"description":"Information about the fees. Please note that:\n\n- The `Currency` must be identical to that of the initial transaction.\n- The `Amount` cannot exceed the initial's transaction.","title":"CreateASettlementTransferRequestFees"},"CreateASettlementTransferRequest":{"type":"object","properties":{"AuthorId":{"$ref":"#/components/schemas/AuthorId"},"DebitedFunds":{"$ref":"#/components/schemas/CreateASettlementTransferRequestDebitedFunds","description":"Information about the debited funds. Please note that:\n\n- The `Currency` must be identical to that of the initial transaction.\n- The `Amount` cannot exceed the initial's transaction minus the fees."},"Fees":{"$ref":"#/components/schemas/CreateASettlementTransferRequestFees","description":"Information about the fees. Please note that:\n\n- The `Currency` must be identical to that of the initial transaction.\n- The `Amount` cannot exceed the initial's transaction."}},"required":["AuthorId","DebitedFunds","Fees"],"title":"CreateASettlementTransferRequest"},"SettlementTransferResponseDebitedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the debited funds. Please note that:\n\n- The `Currency` must be identical to that of the initial transaction.\n- The `Amount` cannot exceed the initial's transaction minus the fees.","title":"SettlementTransferResponseDebitedFunds"},"SettlementTransferResponseFees":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the fees. Please note that:\n\n- The `Currency` must be identical to that of the initial transaction.\n- The `Amount` cannot exceed the initial's transaction.","title":"SettlementTransferResponseFees"},"SettlementTransferResponseCreditedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the credited funds (`CreditedFunds` = `DebitedFunds` - `Fees`).","title":"SettlementTransferResponseCreditedFunds"},"SettlementTransferResponse":{"type":"object","properties":{"Id":{"$ref":"#/components/schemas/Id"},"Tag":{"$ref":"#/components/schemas/Tag"},"CreationDate":{"$ref":"#/components/schemas/CreationDate"},"ResultCode":{"$ref":"#/components/schemas/ResultCode"},"ResultMessage":{"$ref":"#/components/schemas/ResultMessage"},"DebitedFunds":{"$ref":"#/components/schemas/SettlementTransferResponseDebitedFunds","description":"Information about the debited funds. Please note that:\n\n- The `Currency` must be identical to that of the initial transaction.\n- The `Amount` cannot exceed the initial's transaction minus the fees."},"Fees":{"$ref":"#/components/schemas/SettlementTransferResponseFees","description":"Information about the fees. Please note that:\n\n- The `Currency` must be identical to that of the initial transaction.\n- The `Amount` cannot exceed the initial's transaction."},"AuthorId":{"$ref":"#/components/schemas/AuthorId"},"CreditedUserId":{"$ref":"#/components/schemas/CreditedUserId"},"CreditedFunds":{"$ref":"#/components/schemas/SettlementTransferResponseCreditedFunds","description":"Information about the credited funds (`CreditedFunds` = `DebitedFunds` - `Fees`)."},"Status":{"$ref":"#/components/schemas/TransactionStatus"},"ExecutionDate":{"$ref":"#/components/schemas/TransactionExecutionDate"},"Type":{"$ref":"#/components/schemas/TransactionType"},"Nature":{"$ref":"#/components/schemas/TransactionNature"},"CreditedWalletId":{"type":"string","description":"The unique identifier of the credited wallet."},"DebitedWalletId":{"type":"string","description":"The unique identifier of the debited wallet."},"RepudiationId":{"type":"string","description":"The unique identifier of the repudiation."}},"title":"SettlementTransferResponse"},"CreateABankWirePayInToTheRepudiationWalletRequestDeclaredDebitedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"required":["Currency","Amount"],"description":"Information about the declared funds to be wired by the platform to the returned bank account.","title":"CreateABankWirePayInToTheRepudiationWalletRequestDeclaredDebitedFunds"},"CreateABankWirePayInToTheRepudiationWalletRequest":{"type":"object","properties":{"CreditedWalletId":{"type":"string","description":"The unique identifier of the credited wallet. In the case of the direct bank wire to the Repudiation Wallet, this value has the format `CREDIT_CCY` where `CCY` is the currency of the Client Wallet to be credited (e.g., `CREDIT_EUR`)."},"DeclaredDebitedFunds":{"$ref":"#/components/schemas/CreateABankWirePayInToTheRepudiationWalletRequestDeclaredDebitedFunds","description":"Information about the declared funds to be wired by the platform to the returned bank account."}},"required":["CreditedWalletId","DeclaredDebitedFunds"],"title":"CreateABankWirePayInToTheRepudiationWalletRequest"},"CreateABankWirePayInToTheRepudiationWalletResponseDebitedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the debited funds.","title":"CreateABankWirePayInToTheRepudiationWalletResponseDebitedFunds"},"CreateABankWirePayInToTheRepudiationWalletResponseCreditedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the credited funds (`CreditedFunds` = `DebitedFunds` - `Fees`).","title":"CreateABankWirePayInToTheRepudiationWalletResponseCreditedFunds"},"CreateABankWirePayInToTheRepudiationWalletResponseFees":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the fees.","title":"CreateABankWirePayInToTheRepudiationWalletResponseFees"},"CreateABankWirePayInToTheRepudiationWalletResponseDeclaredDebitedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the declared debited funds.","title":"CreateABankWirePayInToTheRepudiationWalletResponseDeclaredDebitedFunds"},"CreateABankWirePayInToTheRepudiationWalletResponseDeclaredFees":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the declared fees.","title":"CreateABankWirePayInToTheRepudiationWalletResponseDeclaredFees"},"CreateABankWirePayInToTheRepudiationWalletResponseBankAccount":{"type":"object","properties":{"OwnerAddress":{"$ref":"#/components/schemas/Address"},"Type":{"type":"string","description":"**Returned values:** `IBAN`, `US`, `CA`, `GB`, `OTHER`\n\nThe type of the bank account."},"OwnerName":{"type":"string","description":"The full name of the owner of the bank account."},"IBAN":{"type":"string","description":"The IBAN (international bank account number) for the bank account."},"BIC":{"type":"string","description":"The BIC (international identifier of the bank) for the bank account."}},"description":"Information about the bank account to which the bank wire must be made by the end user. **Caution:** Do not hardcode the returned values. Mangopay may change the underlying bank details without prior notice.","title":"CreateABankWirePayInToTheRepudiationWalletResponseBankAccount"},"CreateABankWirePayInToTheRepudiationWalletResponse":{"type":"object","properties":{"Id":{"$ref":"#/components/schemas/Id"},"Tag":{"$ref":"#/components/schemas/Tag"},"CreationDate":{"$ref":"#/components/schemas/CreationDate"},"ResultCode":{"$ref":"#/components/schemas/ResultCode"},"ResultMessage":{"$ref":"#/components/schemas/ResultMessage"},"AuthorId":{"type":"string","description":"The unique identifier of the user at the source of the transaction. In the case of the direct bank wire to the Repudiation Wallet, the `AuthorId` is automatically set to the platform's `ClientId`."},"CreditedUserId":{"type":"string","description":"The unique identifier of the user whose wallet is credited. In the case of the direct bank wire to the Repudiation Wallet, the `CreditedUserId` is automatically set to the platform's `ClientId`."},"DebitedFunds":{"$ref":"#/components/schemas/CreateABankWirePayInToTheRepudiationWalletResponseDebitedFunds","description":"Information about the debited funds."},"CreditedFunds":{"$ref":"#/components/schemas/CreateABankWirePayInToTheRepudiationWalletResponseCreditedFunds","description":"Information about the credited funds (`CreditedFunds` = `DebitedFunds` - `Fees`)."},"Fees":{"$ref":"#/components/schemas/CreateABankWirePayInToTheRepudiationWalletResponseFees","description":"Information about the fees."},"Status":{"$ref":"#/components/schemas/TransactionStatus"},"ExecutionDate":{"$ref":"#/components/schemas/TransactionExecutionDate"},"Type":{"$ref":"#/components/schemas/TransactionType"},"Nature":{"$ref":"#/components/schemas/TransactionNature"},"CreditedWalletId":{"type":"string","description":"The unique identifier of the credited wallet. In the case of the direct bank wire to the Repudiation Wallet, this value has the format `CREDIT_CCY` where `CCY` is the currency of the Client Wallet to be credited (e.g., `CREDIT_EUR`)."},"DebitedWalletId":{"type":"string","description":"The unique identifier of the debited wallet.\n\nIn the case of a pay-in, this value is always `null` since there is no debited wallet."},"PaymentType":{"type":"string","description":"**Returned values:** `BANK_WIRE`\n\nThe payment type of the pay-in."},"ExecutionType":{"type":"string","description":"**Returned values:** `DIRECT`\n\nThe execution type of the pay-in."},"DeclaredDebitedFunds":{"$ref":"#/components/schemas/CreateABankWirePayInToTheRepudiationWalletResponseDeclaredDebitedFunds","description":"Information about the declared debited funds."},"DeclaredFees":{"$ref":"#/components/schemas/CreateABankWirePayInToTheRepudiationWalletResponseDeclaredFees","description":"Information about the declared fees."},"WireReference":{"type":"string","description":"Max. length: 255 characters\n\nThe reference which the end user must provide when making the bank wire. The `WireReference` is used to reconcile the funds that arrive on the bank account with the `DeclaredDebitedFunds` in the Direct Bank Wire PayIn object. **Caution:** This reference is specific to each payment and must be retrieved dynamically."},"BankAccount":{"$ref":"#/components/schemas/CreateABankWirePayInToTheRepudiationWalletResponseBankAccount","description":"Information about the bank account to which the bank wire must be made by the end user. **Caution:** Do not hardcode the returned values. Mangopay may change the underlying bank details without prior notice."}},"title":"CreateABankWirePayInToTheRepudiationWalletResponse"},"DataFormatField":{"type":"object","properties":{"Required":{"type":"boolean","description":"Whether the field is required or not."},"MaxLength":{"type":"integer","description":"The maximum length of the string."},"Pattern":{"type":"string","description":"The regex describing the accepted value of the string."},"Label":{"type":"string","description":"A label that platforms can use when displaying or requesting the field to the end user."},"EndUserDisplay":{"type":"string","description":"**Possible values:** `Show`, `Hide`\n\nRecommendation on whether to show or hide the field (and `Label`) to the end user."}},"description":"Field metadata returned by [GET View the schema for a Recipient](/api-reference/recipients/view-recipient-schema).","title":"DataFormatField"},"DataFormatField_AllowedValues":{"type":"object","properties":{"AllowedValues":{"type":"array","items":{"type":"string"},"description":"The allowed values of the string."},"Required":{"type":"boolean","description":"Whether the field is required or not."},"MaxLength":{"type":"integer","description":"The maximum length of the string."},"MinLength":{"type":"integer","description":"The minimum length of the string."},"Pattern":{"type":"string","description":"The regex describing the accepted value of the string."},"Label":{"type":"string","description":"A label that platforms can use when displaying or requesting the field to the end user."},"EndUserDisplay":{"type":"string","description":"**Possible values:** `Show`, `Hide`\n\nRecommendation on whether to show or hide the field (and `Label`) to the end user."}},"description":"Field metadata returned by [GET View the schema for a Recipient](/api-reference/recipients/view-recipient-schema), including allowed values.","title":"DataFormatField_AllowedValues"},"Address_Recipient_Schema":{"type":"object","properties":{"AddressLine1":{"$ref":"#/components/schemas/DataFormatField"},"AddressLine2":{"$ref":"#/components/schemas/DataFormatField"},"City":{"$ref":"#/components/schemas/DataFormatField"},"Country":{"$ref":"#/components/schemas/DataFormatField"},"Region":{"$ref":"#/components/schemas/DataFormatField"},"PostalCode":{"$ref":"#/components/schemas/DataFormatField"}},"description":"The schema of the `Address` object.","title":"Address_Recipient_Schema"},"ViewTheSchemaForARecipientResponseIndividualRecipient":{"type":"object","properties":{"FirstName":{"$ref":"#/components/schemas/DataFormatField"},"LastName":{"$ref":"#/components/schemas/DataFormatField"},"Address":{"$ref":"#/components/schemas/Address_Recipient_Schema"}},"description":"The schema of the `IndividualRecipient` property.","title":"ViewTheSchemaForARecipientResponseIndividualRecipient"},"ViewTheSchemaForARecipientResponseBusinessRecipient":{"type":"object","properties":{"BusinessName":{"$ref":"#/components/schemas/DataFormatField"},"Address":{"$ref":"#/components/schemas/Address_Recipient_Schema"}},"description":"The schema of the `BusinessRecipient` property.","title":"ViewTheSchemaForARecipientResponseBusinessRecipient"},"FieldMetadata":{"type":"object","properties":{"Required":{"type":"boolean","description":"Whether the field is required or not."},"MaxLength":{"type":"integer","description":"The maximum length of the string."},"MinLength":{"type":"integer","description":"The minimum length of the string."},"Pattern":{"type":"string","description":"The regex describing the accepted value of the string."},"Label":{"type":"string","description":"A label that platforms can use when displaying or requesting the field to the end user."},"EndUserDisplay":{"type":"string","description":"**Possible values:** `Show`, `Hide`\n\nRecommendation on whether to show or hide the field (and `Label`) to the end user."}},"description":"Field metadata returned by [GET View the schema for a Recipient](/api-reference/recipients/view-recipient-schema), including length constraints.","title":"FieldMetadata"},"InternationalBankTransfer_RecipientSchema":{"type":"object","properties":{"AccountNumber":{"$ref":"#/components/schemas/FieldMetadata"},"BIC":{"$ref":"#/components/schemas/FieldMetadata"}},"description":"The schema of the `InternationalBankTransfer` property.","title":"InternationalBankTransfer_RecipientSchema"},"ViewTheSchemaForARecipientResponseLocalBankTransferOneOf0Cad":{"type":"object","properties":{"AccountNumber":{"$ref":"#/components/schemas/FieldMetadata"},"InstitutionNumber":{"$ref":"#/components/schemas/FieldMetadata"},"BranchCode":{"$ref":"#/components/schemas/FieldMetadata"},"BankName":{"$ref":"#/components/schemas/FieldMetadata"}},"description":"The schema of the `CAD` property.","title":"ViewTheSchemaForARecipientResponseLocalBankTransferOneOf0Cad"},"ViewTheSchemaForARecipientResponseLocalBankTransfer0":{"type":"object","properties":{"CAD":{"$ref":"#/components/schemas/ViewTheSchemaForARecipientResponseLocalBankTransferOneOf0Cad","description":"The schema of the `CAD` property."}},"required":["CAD"],"title":"ViewTheSchemaForARecipientResponseLocalBankTransfer0"},"ViewTheSchemaForARecipientResponseLocalBankTransferOneOf1Chf":{"type":"object","properties":{"IBAN":{"$ref":"#/components/schemas/FieldMetadata"}},"description":"The schema of the `CHF` property.","title":"ViewTheSchemaForARecipientResponseLocalBankTransferOneOf1Chf"},"ViewTheSchemaForARecipientResponseLocalBankTransfer1":{"type":"object","properties":{"CHF":{"$ref":"#/components/schemas/ViewTheSchemaForARecipientResponseLocalBankTransferOneOf1Chf","description":"The schema of the `CHF` property."}},"required":["CHF"],"title":"ViewTheSchemaForARecipientResponseLocalBankTransfer1"},"ViewTheSchemaForARecipientResponseLocalBankTransferOneOf2Czk":{"type":"object","properties":{"IBAN":{"$ref":"#/components/schemas/FieldMetadata"}},"description":"The schema of the `CZK` property.","title":"ViewTheSchemaForARecipientResponseLocalBankTransferOneOf2Czk"},"ViewTheSchemaForARecipientResponseLocalBankTransfer2":{"type":"object","properties":{"CZK":{"$ref":"#/components/schemas/ViewTheSchemaForARecipientResponseLocalBankTransferOneOf2Czk","description":"The schema of the `CZK` property."}},"required":["CZK"],"title":"ViewTheSchemaForARecipientResponseLocalBankTransfer2"},"ViewTheSchemaForARecipientResponseLocalBankTransferOneOf3Dkk":{"type":"object","properties":{"IBAN":{"$ref":"#/components/schemas/FieldMetadata"}},"description":"The schema of the `DKK` property.","title":"ViewTheSchemaForARecipientResponseLocalBankTransferOneOf3Dkk"},"ViewTheSchemaForARecipientResponseLocalBankTransfer3":{"type":"object","properties":{"DKK":{"$ref":"#/components/schemas/ViewTheSchemaForARecipientResponseLocalBankTransferOneOf3Dkk","description":"The schema of the `DKK` property."}},"required":["DKK"],"title":"ViewTheSchemaForARecipientResponseLocalBankTransfer3"},"ViewTheSchemaForARecipientResponseLocalBankTransferOneOf4Eur":{"type":"object","properties":{"IBAN":{"$ref":"#/components/schemas/FieldMetadata"}},"description":"The schema of the `EUR` property.","title":"ViewTheSchemaForARecipientResponseLocalBankTransferOneOf4Eur"},"ViewTheSchemaForARecipientResponseLocalBankTransfer4":{"type":"object","properties":{"EUR":{"$ref":"#/components/schemas/ViewTheSchemaForARecipientResponseLocalBankTransferOneOf4Eur","description":"The schema of the `EUR` property."}},"required":["EUR"],"title":"ViewTheSchemaForARecipientResponseLocalBankTransfer4"},"ViewTheSchemaForARecipientResponseLocalBankTransferOneOf5Gbp":{"type":"object","properties":{"AccountNumber":{"$ref":"#/components/schemas/FieldMetadata"},"SortCode":{"$ref":"#/components/schemas/FieldMetadata"}},"description":"The schema of the `GBP` property.","title":"ViewTheSchemaForARecipientResponseLocalBankTransferOneOf5Gbp"},"ViewTheSchemaForARecipientResponseLocalBankTransfer5":{"type":"object","properties":{"GBP":{"$ref":"#/components/schemas/ViewTheSchemaForARecipientResponseLocalBankTransferOneOf5Gbp","description":"The schema of the `GBP` property."}},"required":["GBP"],"title":"ViewTheSchemaForARecipientResponseLocalBankTransfer5"},"ViewTheSchemaForARecipientResponseLocalBankTransferOneOf6Huf":{"type":"object","properties":{"IBAN":{"$ref":"#/components/schemas/FieldMetadata"}},"description":"The schema of the `HUF` property.","title":"ViewTheSchemaForARecipientResponseLocalBankTransferOneOf6Huf"},"ViewTheSchemaForARecipientResponseLocalBankTransfer6":{"type":"object","properties":{"HUF":{"$ref":"#/components/schemas/ViewTheSchemaForARecipientResponseLocalBankTransferOneOf6Huf","description":"The schema of the `HUF` property."}},"required":["HUF"],"title":"ViewTheSchemaForARecipientResponseLocalBankTransfer6"},"ViewTheSchemaForARecipientResponseLocalBankTransferOneOf7Nok":{"type":"object","properties":{"IBAN":{"$ref":"#/components/schemas/FieldMetadata"}},"description":"The schema of the `NOK` property.","title":"ViewTheSchemaForARecipientResponseLocalBankTransferOneOf7Nok"},"ViewTheSchemaForARecipientResponseLocalBankTransfer7":{"type":"object","properties":{"NOK":{"$ref":"#/components/schemas/ViewTheSchemaForARecipientResponseLocalBankTransferOneOf7Nok","description":"The schema of the `NOK` property."}},"required":["NOK"],"title":"ViewTheSchemaForARecipientResponseLocalBankTransfer7"},"ViewTheSchemaForARecipientResponseLocalBankTransferOneOf8Pln":{"type":"object","properties":{"IBAN":{"$ref":"#/components/schemas/FieldMetadata"}},"description":"The schema of the `PLN` property.","title":"ViewTheSchemaForARecipientResponseLocalBankTransferOneOf8Pln"},"ViewTheSchemaForARecipientResponseLocalBankTransfer8":{"type":"object","properties":{"PLN":{"$ref":"#/components/schemas/ViewTheSchemaForARecipientResponseLocalBankTransferOneOf8Pln","description":"The schema of the `PLN` property."}},"required":["PLN"],"title":"ViewTheSchemaForARecipientResponseLocalBankTransfer8"},"ViewTheSchemaForARecipientResponseLocalBankTransferOneOf9Ron":{"type":"object","properties":{"IBAN":{"$ref":"#/components/schemas/FieldMetadata"}},"description":"The schema of the `RON` property.","title":"ViewTheSchemaForARecipientResponseLocalBankTransferOneOf9Ron"},"ViewTheSchemaForARecipientResponseLocalBankTransfer9":{"type":"object","properties":{"RON":{"$ref":"#/components/schemas/ViewTheSchemaForARecipientResponseLocalBankTransferOneOf9Ron","description":"The schema of the `RON` property."}},"required":["RON"],"title":"ViewTheSchemaForARecipientResponseLocalBankTransfer9"},"ViewTheSchemaForARecipientResponseLocalBankTransferOneOf10Sek":{"type":"object","properties":{"IBAN":{"$ref":"#/components/schemas/FieldMetadata"}},"description":"The schema of the `SEK` property.","title":"ViewTheSchemaForARecipientResponseLocalBankTransferOneOf10Sek"},"ViewTheSchemaForARecipientResponseLocalBankTransfer10":{"type":"object","properties":{"SEK":{"$ref":"#/components/schemas/ViewTheSchemaForARecipientResponseLocalBankTransferOneOf10Sek","description":"The schema of the `SEK` property."}},"required":["SEK"],"title":"ViewTheSchemaForARecipientResponseLocalBankTransfer10"},"ViewTheSchemaForARecipientResponseLocalBankTransferOneOf11Usd":{"type":"object","properties":{"AccountNumber":{"$ref":"#/components/schemas/FieldMetadata"},"ABA":{"$ref":"#/components/schemas/FieldMetadata"},"FFC":{"$ref":"#/components/schemas/FieldMetadata"}},"description":"The schema of the `USD` property.","title":"ViewTheSchemaForARecipientResponseLocalBankTransferOneOf11Usd"},"ViewTheSchemaForARecipientResponseLocalBankTransfer11":{"type":"object","properties":{"USD":{"$ref":"#/components/schemas/ViewTheSchemaForARecipientResponseLocalBankTransferOneOf11Usd","description":"The schema of the `USD` property."}},"required":["USD"],"title":"ViewTheSchemaForARecipientResponseLocalBankTransfer11"},"ViewTheSchemaForARecipientResponseLocalBankTransfer":{"oneOf":[{"$ref":"#/components/schemas/ViewTheSchemaForARecipientResponseLocalBankTransfer0"},{"$ref":"#/components/schemas/ViewTheSchemaForARecipientResponseLocalBankTransfer1"},{"$ref":"#/components/schemas/ViewTheSchemaForARecipientResponseLocalBankTransfer2"},{"$ref":"#/components/schemas/ViewTheSchemaForARecipientResponseLocalBankTransfer3"},{"$ref":"#/components/schemas/ViewTheSchemaForARecipientResponseLocalBankTransfer4"},{"$ref":"#/components/schemas/ViewTheSchemaForARecipientResponseLocalBankTransfer5"},{"$ref":"#/components/schemas/ViewTheSchemaForARecipientResponseLocalBankTransfer6"},{"$ref":"#/components/schemas/ViewTheSchemaForARecipientResponseLocalBankTransfer7"},{"$ref":"#/components/schemas/ViewTheSchemaForARecipientResponseLocalBankTransfer8"},{"$ref":"#/components/schemas/ViewTheSchemaForARecipientResponseLocalBankTransfer9"},{"$ref":"#/components/schemas/ViewTheSchemaForARecipientResponseLocalBankTransfer10"},{"$ref":"#/components/schemas/ViewTheSchemaForARecipientResponseLocalBankTransfer11"}],"description":"The schema of the `LocalBankTransfer` property.","title":"ViewTheSchemaForARecipientResponseLocalBankTransfer"},"ViewTheSchemaForARecipientResponse":{"type":"object","properties":{"DisplayName":{"$ref":"#/components/schemas/DataFormatField"},"Currency":{"$ref":"#/components/schemas/DataFormatField_AllowedValues"},"Country":{"$ref":"#/components/schemas/DataFormatField_AllowedValues"},"RecipientType":{"$ref":"#/components/schemas/DataFormatField_AllowedValues"},"PayoutMethodType":{"$ref":"#/components/schemas/DataFormatField_AllowedValues"},"Tag":{"$ref":"#/components/schemas/DataFormatField"},"RecipientScope":{"$ref":"#/components/schemas/DataFormatField_AllowedValues"},"IndividualRecipient":{"$ref":"#/components/schemas/ViewTheSchemaForARecipientResponseIndividualRecipient","description":"The schema of the `IndividualRecipient` property."},"BusinessRecipient":{"$ref":"#/components/schemas/ViewTheSchemaForARecipientResponseBusinessRecipient","description":"The schema of the `BusinessRecipient` property."},"InternationalBankTransfer":{"$ref":"#/components/schemas/InternationalBankTransfer_RecipientSchema"},"LocalBankTransfer":{"$ref":"#/components/schemas/ViewTheSchemaForARecipientResponseLocalBankTransfer","description":"The schema of the `LocalBankTransfer` property."}},"title":"ViewTheSchemaForARecipientResponse"},"DisplayName_Recipient_Request":{"type":"string","description":"Length: 1–50; cannot contain: `&,'/` (pattern:`^(?!.*[&,'/]).{1,50}$`)\n\nA user-friendly name to identify the account. This value cannot be changed once the recipient is created.","title":"DisplayName_Recipient_Request"},"Currency_Recipient":{"type":"string","description":"**Possible values:** `AED`, `AUD`, `CAD`, `CHF`, `CNH`, `CZK`, `DKK`, `EUR`, `GBP`, `HKD`, `HUF`, `ILS`, `JPY`, `MXN`, `NOK`, `NZD`, `PLN`, `RON`, `SAR`, `SEK`, `SGD`, `TRY`, `USD`, `ZAR`\n\nThe currency of the recipient.","title":"Currency_Recipient"},"Country_Recipient":{"type":"string","description":"Format: Two-letter country code ([ISO 3166-1 alpha-2 format](/api-reference/overview/data-formats))\n\nThe destination country of the payout method.","title":"Country_Recipient"},"RecipientScope_Recipient_Request":{"type":"string","description":"**Possible values:** `PAYIN`, `PAYOUT`\n\n**Default value:** `PAYOUT`\n\nThe scope of the recipient:\n- `PAYOUT` – Usable for payouts and in pay-in use cases. A `PAYOUT` recipient can only be created by a user with the `UserCategory` `OWNER` and requires SCA. You need to use the returned `PendingUserAction.RedirectUrl` value, adding your encoded `returnUrl` as a query parameter, to redirect the user to the [hosted SCA session](/guides/sca/session) so they can complete the necessary steps.\n- `PAYIN` - Not usable for payouts but only usable for pay-in use cases, such as direct debit and refunds using payouts. A `PAYIN` recipient can be created by a user with the `UserCategory` `PAYER` or `OWNER`, and does not require SCA.","title":"RecipientScope_Recipient_Request"},"Tag_Recipient":{"type":["string","null"],"description":"Max. length: 255 (pattern: `^.{0,255}$`)\n\nCustom data that you can add to this object. This value cannot be changed once the recipient is created.","title":"Tag_Recipient"},"Address_Recipient_Request":{"type":"object","properties":{"AddressLine1":{"type":"string","description":"Length: 1–255; cannot contain: `()/` (Pattern: `^(?!.*[()/]).{1,255}$`)\n\nThe first line of the address."},"AddressLine2":{"type":"string","description":"Length: 1–255; cannot contain: `()/` (Pattern: `^(?!.*[()/]).{1,255}$`)\n\nThe second line of the address."},"City":{"type":"string","description":"Length: 1-80; cannot contain: `&,.:_'` (pattern: `^(?!.*[&,.:_]).{1,80}$`)\n\nThe city of the address."},"Region":{"type":"string","description":"Length: 1–10; cannot contain: `&,.:_'-/` (pattern: `^(?!.*[&,.:_/]).{1,50}$`)\n\nRequired for `Country` values: `MX`, `US`, `CA`\n\nThe region of the address."},"PostalCode":{"type":"string","description":"Length: 1–10; cannot contain: `()&,.:_'/` (pattern: `^(?!.*[()&,.:_'/]).{1,10}$`)\n\n\nThe postal code of the address."},"Country":{"type":"string","description":"Format: Two-letter country code ([ISO 3166-1 alpha-2 format](/api-reference/overview/data-formats))\n\nThe country of the address."}},"required":["AddressLine1","City","PostalCode","Country"],"description":"Information about the address.","title":"Address_Recipient_Request"},"IndividualRecipient_Request":{"type":"object","properties":{"FirstName":{"type":"string","description":"Length: 1–255; cannot contain: `()&,.:_/` (Pattern: `^(?!.*[()&,.:_/]).{1,255}$`)\n\nThe first name of the individual account holder."},"LastName":{"type":"string","description":"Length: 1–255; cannot contain: `()&,.:_/` (Pattern: `^(?!.*[()&,.:_/]).{1,255}$`)\n\nThe last name of the individual account holder."},"Address":{"$ref":"#/components/schemas/Address_Recipient_Request"}},"required":["FirstName","LastName","Address"],"description":"The account holder if the `RecipientType` is `Individual`.\n\nOnly one of `IndividualRecipient` or `BusinessRecipient` is required.","title":"IndividualRecipient_Request"},"InternationalBankTransfer_Request":{"type":"object","properties":{"AccountNumber":{"type":"string","description":"Format: The format returned by the [schema](/api-reference/recipients/view-recipient-schema) endpoint depending on the `Currency` and `Country`.\n\nThe account number of the account. For IBAN countries, the `AccountNumber` format is the local IBAN one. For other countries, the format depends on the `Country` and should be retrieved from the [GET View the schema for a Recipient](/api-reference/recipients/view-recipient-schema) endpoint."},"BIC":{"type":"string","description":"Format: The format returned by the [schema](/api-reference/recipients/view-recipient-schema) endpoint depending on the `Currency` and `Country`.\n\nThe BIC of the account. For countries that don't use IBAN, the `BIC` is required. For countries that use IBAN, this field is ignored because the BIC is generated automatically from the IBAN and returned in the response."}},"required":["AccountNumber"],"description":"The account details if `PayoutMethodType` is `InternationalBankTransfer`.\n\nOnly one of `InternationalBankTransfer` or `LocalBankTransfer` is required.\n\nThe `InternationalBankTransfer` depends on the `Currency` and `Country`.","title":"InternationalBankTransfer_Request"},"ValidateInternationalIndividualRecipientRequest":{"type":"object","properties":{"DisplayName":{"$ref":"#/components/schemas/DisplayName_Recipient_Request"},"Currency":{"$ref":"#/components/schemas/Currency_Recipient"},"Country":{"$ref":"#/components/schemas/Country_Recipient"},"RecipientScope":{"$ref":"#/components/schemas/RecipientScope_Recipient_Request"},"Tag":{"$ref":"#/components/schemas/Tag_Recipient"},"PayoutMethodType":{"type":"string","description":"**Allowed values:** `InternationalBankTransfer`\n\nThe payout method of the recipient:\n- `InternationalBankTransfer` – The account can receive non-local currencies via SWIFT or else uses local rails for local currencies by default.\n- `LocalBankTransfer` – The account can **only** receive the corresponding local `Currency` for the `Country` (e.g. `EUR` to a SEPA country, `GBP` to a UK account, `PLN` to a Polish IBAN, etc.)"},"RecipientType":{"type":"string","description":"**Allowed values:** `Individual`\n\nThe recipient type:\n- `Individual` – An account held by a natural person, requiring the `IndividualRecipient` property.\n- `Business` – An account held by a legal entity, requiring the `BusinessRecipient` property."},"IndividualRecipient":{"$ref":"#/components/schemas/IndividualRecipient_Request"},"InternationalBankTransfer":{"$ref":"#/components/schemas/InternationalBankTransfer_Request"}},"required":["DisplayName","Currency","Country","PayoutMethodType","RecipientType","IndividualRecipient","InternationalBankTransfer"],"description":"Request body for creating a Recipient where `PayoutMethodType` is `InternationalBankTransfer` and `RecipientType` is `Individual`.","title":"ValidateInternationalIndividualRecipientRequest"},"BusinessRecipient_Request":{"type":"object","properties":{"BusinessName":{"type":"string","description":"Length: 1–255; cannot contain: `(),.:/` (Pattern: `^(?!.*[(),.:/]).{1,255}$`)\n\nThe name of the business account holder."},"Address":{"$ref":"#/components/schemas/Address_Recipient_Request"}},"required":["BusinessName","Address"],"description":"The account holder if the `RecipientType` is `Business`.\n\nOnly one of `IndividualRecipient` or `BusinessRecipient` is required.","title":"BusinessRecipient_Request"},"ValidateInternationalBusinessRecipientRequest":{"type":"object","properties":{"DisplayName":{"$ref":"#/components/schemas/DisplayName_Recipient_Request"},"Currency":{"$ref":"#/components/schemas/Currency_Recipient"},"Country":{"$ref":"#/components/schemas/Country_Recipient"},"RecipientScope":{"$ref":"#/components/schemas/RecipientScope_Recipient_Request"},"Tag":{"$ref":"#/components/schemas/Tag_Recipient"},"PayoutMethodType":{"type":"string","description":"**Allowed values:** `InternationalBankTransfer`\n\nThe payout method of the recipient:\n- `InternationalBankTransfer` – The account can receive non-local currencies via SWIFT or else uses local rails for local currencies by default.\n- `LocalBankTransfer` – The account can **only** receive the corresponding local `Currency` for the `Country` (e.g. `EUR` to a SEPA country, `GBP` to a UK account, `PLN` to a Polish IBAN, etc.)"},"RecipientType":{"type":"string","description":"**Allowed values:** `Business`\n\nThe recipient type:\n- `Individual` – An account held by a natural person, requiring the `IndividualRecipient` property.\n- `Business` – An account held by a legal entity, requiring the `BusinessRecipient` property."},"BusinessRecipient":{"$ref":"#/components/schemas/BusinessRecipient_Request"},"InternationalBankTransfer":{"$ref":"#/components/schemas/InternationalBankTransfer_Request"}},"required":["DisplayName","Currency","Country","PayoutMethodType","RecipientType","BusinessRecipient","InternationalBankTransfer"],"description":"Request body for creating a Recipient where `PayoutMethodType` is `InternationalBankTransfer` and `RecipientType` is `Business`.","title":"ValidateInternationalBusinessRecipientRequest"},"LocalBankTransfer_CAD_Request":{"type":"object","properties":{"AccountNumber":{"type":"string","description":"Format: 7–35 digits (pattern: `^\\d{7,35}$`).\n\nThe account number of the Canadian account."},"InstitutionNumber":{"type":"string","description":"Format: 3 digits (pattern: `^\\d{3}$`).\n\nThe institution number of the Canadian account."},"BranchCode":{"type":"string","description":"Format: 5 digits (pattern: `^\\d{5}$`).\n\nThe branch code of the Canadian account."},"BankName":{"type":"string","description":"Length: 1–50.\n\nThe bank name of the Canadian account."}},"required":["AccountNumber","InstitutionNumber","BranchCode","BankName"],"description":"Local bank transfer details for `Currency` value `CAD`.","title":"LocalBankTransfer_CAD_Request"},"LocalBankTransfer_IBAN_Request":{"type":"object","properties":{"IBAN":{"type":"string","description":"Format: A valid IBAN (pattern: `^[a-zA-Z]{2}\\d{2}\\s*(\\w{4}\\s*){2,7}\\w{1,4}\\s*$`).\n\nThe IBAN of the account."}},"required":["IBAN"],"description":"Local bank transfer details for IBAN-based currencies (`CHF`, `CZK`, `DKK`, `EUR`, `HUF`, `NOK`, `PLN`, `RON`, `SEK`).","title":"LocalBankTransfer_IBAN_Request"},"LocalBankTransfer_GBP_Request":{"type":"object","properties":{"AccountNumber":{"type":"string","description":"Format: 8 digits (pattern: `^\\d{8}$`).\n\nThe account number of the UK account."},"SortCode":{"type":"string","description":"Format: 6 digits (pattern: `^\\d{6}$`).\n\nThe sort code of the UK account."}},"required":["AccountNumber","SortCode"],"description":"Local bank transfer details for `Currency` value `GBP`.","title":"LocalBankTransfer_GBP_Request"},"LocalBankTransfer_USD_Request":{"type":"object","properties":{"AccountNumber":{"type":"string","description":"Format: 8–12 alphanumeric characters (pattern: `^[0-9a-zA-Z]{8,12}$`).\n\nThe account number of the US account."},"ABA":{"type":"string","description":"Format: 9 digits (pattern: `^\\d{9}$`).\n\nThe ABA routing number of the US account."},"FFC":{"type":"string","description":"Format: 8-12 digits then `FFC` then a space then a string of characters up to 140 total length (pattern: `^(?=.{0,140}$)[0-9]{8,12}/FFC [0-9a-zA-Z/\\-?:().,'+ ]+$`).\n\nFFC transfer information for the US account."}},"required":["AccountNumber","ABA"],"description":"Local bank transfer details for `Currency` value `USD`.","title":"LocalBankTransfer_USD_Request"},"LocalBankTransfer_Request":{"type":"object","properties":{"CAD":{"$ref":"#/components/schemas/LocalBankTransfer_CAD_Request"},"CHF":{"$ref":"#/components/schemas/LocalBankTransfer_IBAN_Request"},"CZK":{"$ref":"#/components/schemas/LocalBankTransfer_IBAN_Request"},"DKK":{"$ref":"#/components/schemas/LocalBankTransfer_IBAN_Request"},"EUR":{"$ref":"#/components/schemas/LocalBankTransfer_IBAN_Request"},"GBP":{"$ref":"#/components/schemas/LocalBankTransfer_GBP_Request"},"HUF":{"$ref":"#/components/schemas/LocalBankTransfer_IBAN_Request"},"NOK":{"$ref":"#/components/schemas/LocalBankTransfer_IBAN_Request"},"PLN":{"$ref":"#/components/schemas/LocalBankTransfer_IBAN_Request"},"RON":{"$ref":"#/components/schemas/LocalBankTransfer_IBAN_Request"},"SEK":{"$ref":"#/components/schemas/LocalBankTransfer_IBAN_Request"},"USD":{"$ref":"#/components/schemas/LocalBankTransfer_USD_Request"}},"description":"The account details if `PayoutMethodType` is `LocalBankTransfer`, depending on the `Currency`. Exactly one currency property must be set, matching the request `Currency` value.","title":"LocalBankTransfer_Request"},"ValidateLocalIndividualRecipientRequest":{"type":"object","properties":{"DisplayName":{"$ref":"#/components/schemas/DisplayName_Recipient_Request"},"Currency":{"$ref":"#/components/schemas/Currency_Recipient"},"Country":{"$ref":"#/components/schemas/Country_Recipient"},"RecipientScope":{"$ref":"#/components/schemas/RecipientScope_Recipient_Request"},"Tag":{"$ref":"#/components/schemas/Tag_Recipient"},"PayoutMethodType":{"type":"string","description":"**Allowed values:** `LocalBankTransfer`\n\nThe payout method of the recipient:\n- `InternationalBankTransfer` – The account can receive non-local currencies via SWIFT or else uses local rails for local currencies by default.\n- `LocalBankTransfer` – The account can **only** receive the corresponding local `Currency` for the `Country` (e.g. `EUR` to a SEPA country, `GBP` to a UK account, `PLN` to a Polish IBAN, etc.)"},"RecipientType":{"type":"string","description":"**Allowed values:** `Individual`\n\nThe recipient type:\n- `Individual` – An account held by a natural person, requiring the `IndividualRecipient` property.\n- `Business` – An account held by a legal entity, requiring the `BusinessRecipient` property."},"IndividualRecipient":{"$ref":"#/components/schemas/IndividualRecipient_Request"},"LocalBankTransfer":{"$ref":"#/components/schemas/LocalBankTransfer_Request"}},"required":["DisplayName","Currency","Country","PayoutMethodType","RecipientType","IndividualRecipient","LocalBankTransfer"],"description":"Request body for creating a Recipient where `PayoutMethodType` is `LocalBankTransfer` and `RecipientType` is `Individual`.","title":"ValidateLocalIndividualRecipientRequest"},"ValidateLocalBusinessRecipientRequest":{"type":"object","properties":{"DisplayName":{"$ref":"#/components/schemas/DisplayName_Recipient_Request"},"Currency":{"$ref":"#/components/schemas/Currency_Recipient"},"Country":{"$ref":"#/components/schemas/Country_Recipient"},"RecipientScope":{"$ref":"#/components/schemas/RecipientScope_Recipient_Request"},"Tag":{"$ref":"#/components/schemas/Tag_Recipient"},"PayoutMethodType":{"type":"string","description":"**Allowed values:** `LocalBankTransfer`\n\nThe payout method of the recipient:\n- `InternationalBankTransfer` – The account can receive non-local currencies via SWIFT or else uses local rails for local currencies by default.\n- `LocalBankTransfer` – The account can **only** receive the corresponding local `Currency` for the `Country` (e.g. `EUR` to a SEPA country, `GBP` to a UK account, `PLN` to a Polish IBAN, etc.)"},"RecipientType":{"type":"string","description":"**Allowed values:** `Business`\n\nThe recipient type:\n- `Individual` – An account held by a natural person, requiring the `IndividualRecipient` property.\n- `Business` – An account held by a legal entity, requiring the `BusinessRecipient` property."},"BusinessRecipient":{"$ref":"#/components/schemas/BusinessRecipient_Request"},"LocalBankTransfer":{"$ref":"#/components/schemas/LocalBankTransfer_Request"}},"required":["DisplayName","Currency","Country","PayoutMethodType","RecipientType","BusinessRecipient","LocalBankTransfer"],"description":"Request body for creating a Recipient where `PayoutMethodType` is `LocalBankTransfer` and `RecipientType` is `Business`.","title":"ValidateLocalBusinessRecipientRequest"},"ValidateDataForARecipientRequest":{"oneOf":[{"$ref":"#/components/schemas/ValidateInternationalIndividualRecipientRequest"},{"$ref":"#/components/schemas/ValidateInternationalBusinessRecipientRequest"},{"$ref":"#/components/schemas/ValidateLocalIndividualRecipientRequest"},{"$ref":"#/components/schemas/ValidateLocalBusinessRecipientRequest"}],"title":"ValidateDataForARecipientRequest"},"recipients_validate_recipient_data_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"recipients_validate_recipient_data_Response_200"},"ScaContext_Recipient_Request":{"type":"string","description":"**Possible values:** `USER_PRESENT`, `USER_NOT_PRESENT`\n\n**Default value:** `USER_PRESENT`\n\nThe SCA context of the request, which is **required** if the user's `UserCategory` is `OWNER`:\n- `USER_PRESENT` – The user is taking the SCA-triggering action of registering an external account as a Recipient. The platform must [redirect the user](/guides/sca/session) using the `PendingUserAction.RedirectUrl` returned so that the user can complete the SCA session.\n- `USER_NOT_PRESENT` – The platform is taking the action under proxy from the user and the user has previously given consent to Mangopay (via the SCA hosted experience) to allow the action. If the user has not given (or has revoked) their consent, then `USER_NOT_PRESENT` returns a 403 error.\n\nRead more about [managing proxy and user consent](/guides/sca/proxy-management) **&rarr;**","title":"ScaContext_Recipient_Request"},"CreateInternationalIndividualRecipientRequest":{"type":"object","properties":{"DisplayName":{"$ref":"#/components/schemas/DisplayName_Recipient_Request"},"Currency":{"$ref":"#/components/schemas/Currency_Recipient"},"Country":{"$ref":"#/components/schemas/Country_Recipient"},"RecipientScope":{"$ref":"#/components/schemas/RecipientScope_Recipient_Request"},"Tag":{"$ref":"#/components/schemas/Tag_Recipient"},"ScaContext":{"$ref":"#/components/schemas/ScaContext_Recipient_Request"},"PayoutMethodType":{"type":"string","description":"**Allowed values:** `InternationalBankTransfer`\n\nThe payout method of the recipient:\n- `InternationalBankTransfer` – The account can receive non-local currencies via SWIFT or else uses local rails for local currencies by default.\n- `LocalBankTransfer` – The account can **only** receive the corresponding local `Currency` for the `Country` (e.g. `EUR` to a SEPA country, `GBP` to a UK account, `PLN` to a Polish IBAN, etc.)"},"RecipientType":{"type":"string","description":"**Allowed values:** `Individual`\n\nThe recipient type:\n- `Individual` – An account held by a natural person, requiring the `IndividualRecipient` property.\n- `Business` – An account held by a legal entity, requiring the `BusinessRecipient` property."},"IndividualRecipient":{"$ref":"#/components/schemas/IndividualRecipient_Request"},"InternationalBankTransfer":{"$ref":"#/components/schemas/InternationalBankTransfer_Request"}},"required":["DisplayName","Currency","Country","PayoutMethodType","RecipientType","IndividualRecipient","InternationalBankTransfer"],"description":"Request body for creating a Recipient where `PayoutMethodType` is `InternationalBankTransfer` and `RecipientType` is `Individual`.","title":"CreateInternationalIndividualRecipientRequest"},"CreateInternationalBusinessRecipientRequest":{"type":"object","properties":{"DisplayName":{"$ref":"#/components/schemas/DisplayName_Recipient_Request"},"Currency":{"$ref":"#/components/schemas/Currency_Recipient"},"Country":{"$ref":"#/components/schemas/Country_Recipient"},"RecipientScope":{"$ref":"#/components/schemas/RecipientScope_Recipient_Request"},"Tag":{"$ref":"#/components/schemas/Tag_Recipient"},"ScaContext":{"$ref":"#/components/schemas/ScaContext_Recipient_Request"},"PayoutMethodType":{"type":"string","description":"**Allowed values:** `InternationalBankTransfer`\n\nThe payout method of the recipient:\n- `InternationalBankTransfer` – The account can receive non-local currencies via SWIFT or else uses local rails for local currencies by default.\n- `LocalBankTransfer` – The account can **only** receive the corresponding local `Currency` for the `Country` (e.g. `EUR` to a SEPA country, `GBP` to a UK account, `PLN` to a Polish IBAN, etc.)"},"RecipientType":{"type":"string","description":"**Allowed values:** `Business`\n\nThe recipient type:\n- `Individual` – An account held by a natural person, requiring the `IndividualRecipient` property.\n- `Business` – An account held by a legal entity, requiring the `BusinessRecipient` property."},"BusinessRecipient":{"$ref":"#/components/schemas/BusinessRecipient_Request"},"InternationalBankTransfer":{"$ref":"#/components/schemas/InternationalBankTransfer_Request"}},"required":["DisplayName","Currency","Country","PayoutMethodType","RecipientType","BusinessRecipient","InternationalBankTransfer"],"description":"Request body for creating a Recipient where `PayoutMethodType` is `InternationalBankTransfer` and `RecipientType` is `Business`.","title":"CreateInternationalBusinessRecipientRequest"},"CreateLocalIndividualRecipientRequest":{"type":"object","properties":{"DisplayName":{"$ref":"#/components/schemas/DisplayName_Recipient_Request"},"Currency":{"$ref":"#/components/schemas/Currency_Recipient"},"Country":{"$ref":"#/components/schemas/Country_Recipient"},"RecipientScope":{"$ref":"#/components/schemas/RecipientScope_Recipient_Request"},"Tag":{"$ref":"#/components/schemas/Tag_Recipient"},"ScaContext":{"$ref":"#/components/schemas/ScaContext_Recipient_Request"},"PayoutMethodType":{"type":"string","description":"**Allowed values:** `LocalBankTransfer`\n\nThe payout method of the recipient:\n- `InternationalBankTransfer` – The account can receive non-local currencies via SWIFT or else uses local rails for local currencies by default.\n- `LocalBankTransfer` – The account can **only** receive the corresponding local `Currency` for the `Country` (e.g. `EUR` to a SEPA country, `GBP` to a UK account, `PLN` to a Polish IBAN, etc.)"},"RecipientType":{"type":"string","description":"**Allowed values:** `Individual`\n\nThe recipient type:\n- `Individual` – An account held by a natural person, requiring the `IndividualRecipient` property.\n- `Business` – An account held by a legal entity, requiring the `BusinessRecipient` property."},"IndividualRecipient":{"$ref":"#/components/schemas/IndividualRecipient_Request"},"LocalBankTransfer":{"$ref":"#/components/schemas/LocalBankTransfer_Request"}},"required":["DisplayName","Currency","Country","PayoutMethodType","RecipientType","IndividualRecipient","LocalBankTransfer"],"description":"Request body for creating a Recipient where `PayoutMethodType` is `LocalBankTransfer` and `RecipientType` is `Individual`.","title":"CreateLocalIndividualRecipientRequest"},"CreateLocalBusinessRecipientRequest":{"type":"object","properties":{"DisplayName":{"$ref":"#/components/schemas/DisplayName_Recipient_Request"},"Currency":{"$ref":"#/components/schemas/Currency_Recipient"},"Country":{"$ref":"#/components/schemas/Country_Recipient"},"RecipientScope":{"$ref":"#/components/schemas/RecipientScope_Recipient_Request"},"Tag":{"$ref":"#/components/schemas/Tag_Recipient"},"ScaContext":{"$ref":"#/components/schemas/ScaContext_Recipient_Request"},"PayoutMethodType":{"type":"string","description":"**Allowed values:** `LocalBankTransfer`\n\nThe payout method of the recipient:\n- `InternationalBankTransfer` – The account can receive non-local currencies via SWIFT or else uses local rails for local currencies by default.\n- `LocalBankTransfer` – The account can **only** receive the corresponding local `Currency` for the `Country` (e.g. `EUR` to a SEPA country, `GBP` to a UK account, `PLN` to a Polish IBAN, etc.)"},"RecipientType":{"type":"string","description":"**Allowed values:** `Business`\n\nThe recipient type:\n- `Individual` – An account held by a natural person, requiring the `IndividualRecipient` property.\n- `Business` – An account held by a legal entity, requiring the `BusinessRecipient` property."},"BusinessRecipient":{"$ref":"#/components/schemas/BusinessRecipient_Request"},"LocalBankTransfer":{"$ref":"#/components/schemas/LocalBankTransfer_Request"}},"required":["DisplayName","Currency","Country","PayoutMethodType","RecipientType","BusinessRecipient","LocalBankTransfer"],"description":"Request body for creating a Recipient where `PayoutMethodType` is `LocalBankTransfer` and `RecipientType` is `Business`.","title":"CreateLocalBusinessRecipientRequest"},"CreateARecipientRequest":{"oneOf":[{"$ref":"#/components/schemas/CreateInternationalIndividualRecipientRequest"},{"$ref":"#/components/schemas/CreateInternationalBusinessRecipientRequest"},{"$ref":"#/components/schemas/CreateLocalIndividualRecipientRequest"},{"$ref":"#/components/schemas/CreateLocalBusinessRecipientRequest"}],"title":"CreateARecipientRequest"},"Status_Recipient_Response":{"type":"string","description":"**Returned values:** `PENDING`, `CANCELED`, `ACTIVE`, `DEACTIVATED`\n\nThe status of the recipient:\n- `PENDING` – For `PAYOUT` scope recipients, the user must complete SCA before the recipient can become `ACTIVE`. For `PAYIN` scope recipients, the recipient creation is in progress.\n- `CANCELED` – SCA was not successfully completed and the recipient creation request was canceled. To retry, create another recipient to retrieve another `PendingUserAction.RedirectUrl`. The `CANCELED` status does not apply if `RecipientScope` is `PAYIN`.\n- `ACTIVE` – Recipient creation was successful (including SCA if `RecipientScope` is `PAYOUT`) and the recipient is ready to be used for payouts.\n- `DEACTIVATED` – The recipient has been permanently deactivated and can no longer be used.","title":"Status_Recipient_Response"},"DisplayName_Recipient_Response":{"type":["string","null"],"description":"Length: 1–50; cannot contain: `&,'/` (pattern:`^(?!.*[&,'/]).{1,50}$`)\n\nA user-friendly name to identify the account. This value cannot be changed once the recipient is created.","title":"DisplayName_Recipient_Response"},"RecipientScope_Recipient_Response":{"type":"string","description":"**Returned values:** `PAYIN`, `PAYOUT`\n\nThe scope of the recipient:\n- `PAYOUT` – Usable for payouts and in pay-in use cases. A `PAYOUT` recipient can only be created by a user with the `UserCategory` `OWNER` and requires SCA.\n- `PAYIN` - Not usable for payouts but only usable for pay-in use cases, such as direct debit and refunds using payouts. A `PAYIN` recipient can be created by a user with the `UserCategory` `PAYER` or `OWNER`, and does not require SCA.\n\nBoth `PAYIN` and `PAYOUT` scopes can be created for either `InternationalBankTransfer` or `LocalBankTransfer`, and for either `IndividualRecipient` or `BusinessRecipient`, and for any `Currency`.","title":"RecipientScope_Recipient_Response"},"ScaContext_Recipient_Response":{"type":"string","description":"**Returned values:** `USER_PRESENT`, `USER_NOT_PRESENT`\n\nThe SCA context provided in the create request. Returned in the create response and when viewing the recipient if a `ScaContext` value was sent when the recipient was registered. Omitted otherwise.","title":"ScaContext_Recipient_Response"},"RecipientVerificationId":{"type":["string","null"],"description":"The unique identifier of the VOP check. This value may be `null` if the check could not be performed.","title":"RecipientVerificationId"},"RecipientVerificationCheck":{"type":["string","null"],"description":"**Possible values:** `MATCH`, `CLOSE_MATCH`, `NO_MATCH`, `MATCH_NOT_POSSIBLE`\n\nThe result of the VOP check:\n- `MATCH` – The account is valid and the account name matches the IBAN.\n- `CLOSE_MATCH` – The account is valid but the name doesn't match exactly.\n- `NO_MATCH` – This account likely belongs to a different owner.\n- `MATCH_NOT_POSSIBLE` – The check could not be completed.","title":"RecipientVerificationCheck"},"RecipientVerificationMessage":{"type":["string","null"],"description":"A human-readable message describing the result of the `RecipientVerificationCheck`:\n- If `MATCH`, then `Account name fully matches account identifier.`\n- If `CLOSE_MATCH`, then `Account name partially matches account identifier. Name returned by check: {Name}. Payment made to this account may not reach its intended counterparty.`\n- If `NO_MATCH`, then `Account name does not matches account identifier. Payment made to this account may not reach its intended counterparty.`\n- If `MATCH_NOT_POSSIBLE`, then `Account name does not matches account identifier. Payment made to this account may not reach its intended counterparty.`","title":"RecipientVerificationMessage"},"RecipientVerificationPayeeSuggestedName":{"type":["string","null"],"description":"The name returned by the check in case of a `CLOSE_MATCH` result, which can be used to re-register the Recipient. This property is not returned on the check performed on a Payout request, even if the result is `CLOSE_MATCH`.","title":"RecipientVerificationPayeeSuggestedName"},"RecipientVerificationOfPayee":{"type":"object","properties":{"RecipientVerificationId":{"$ref":"#/components/schemas/RecipientVerificationId"},"RecipientVerificationCheck":{"$ref":"#/components/schemas/RecipientVerificationCheck"},"RecipientVerificationMessage":{"$ref":"#/components/schemas/RecipientVerificationMessage"},"RecipientVerificationPayeeSuggestedName":{"$ref":"#/components/schemas/RecipientVerificationPayeeSuggestedName"}},"description":"Information about the [Verification of Payee (VOP)](/guides/vop) check\nperformed on the Recipient. Because VOP only applies to SEPA local\nschemes, this object is returned `null` if the Recipient's `Currency`\nis not `EUR` or its `PayoutMethodType` is not `LocalBankTransfer`.","title":"RecipientVerificationOfPayee"},"Address_Recipient":{"type":"object","properties":{"AddressLine1":{"type":"string","description":"Length: 1–255; cannot contain: `()/` (Pattern: `^(?!.*[()/]).{1,255}$`)\n\nThe first line of the address."},"AddressLine2":{"type":["string","null"],"description":"Length: 1–255; cannot contain: `()/` (Pattern: `^(?!.*[()/]).{1,255}$`)\n\nThe second line of the address. Parameter only returned if sent."},"City":{"type":"string","description":"Length: 1-80; cannot contain: `&,.:_'` (pattern: `^(?!.*[&,.:_]).{1,80}$`)\n\nThe city of the address."},"Region":{"type":["string","null"],"description":"Length: 1–10; cannot contain: `&,.:_'-/` (pattern: `^(?!.*[&,.:_/]).{1,50}$`)\n\nThe region of the address. Parameter only returned if sent."},"PostalCode":{"type":"string","description":"Length: 1–10; cannot contain: `()&,.:_'/` (pattern: `^(?!.*[()&,.:_'/]).{1,10}$`)\n\nThe postal code of the address."},"Country":{"type":"string","description":"Format: Two-letter country code ([ISO 3166-1 alpha-2 format](/api-reference/overview/data-formats))\n\nThe country of the address."}},"description":"Information about the address.","title":"Address_Recipient"},"IndividualRecipient_Response":{"type":"object","properties":{"FirstName":{"type":"string","description":"Length: 1–255; cannot contain: `()&,.:_/` (Pattern: `^(?!.*[()&,.:_/]).{1,255}$`)\n\nThe first name of the individual account holder."},"LastName":{"type":"string","description":"Length: 1–255; cannot contain: `()&,.:_/` (Pattern: `^(?!.*[()&,.:_/]).{1,255}$`)\n\nThe last name of the individual account holder."},"Address":{"$ref":"#/components/schemas/Address_Recipient"}},"description":"The account holder if the `RecipientType` is `Individual`.","title":"IndividualRecipient_Response"},"InternationalBankTransfer_Response":{"type":"object","properties":{"AccountNumber":{"type":"string","description":"The account number of the account."},"BIC":{"type":"string","description":"The BIC of the account. For IBAN countries, the returned `BIC` is generated from the IBAN."}},"description":"The account details if `PayoutMethodType` is `InternationalBankTransfer`.","title":"InternationalBankTransfer_Response"},"CreateInternationalIndividualRecipientResponse":{"type":"object","properties":{"Id":{"$ref":"#/components/schemas/Id"},"Status":{"$ref":"#/components/schemas/Status_Recipient_Response"},"CreationDate":{"$ref":"#/components/schemas/CreationDate"},"DisplayName":{"$ref":"#/components/schemas/DisplayName_Recipient_Response"},"Currency":{"$ref":"#/components/schemas/Currency_Recipient"},"Country":{"$ref":"#/components/schemas/Country_Recipient"},"UserId":{"type":"string","description":"The unique identifier of the user."},"RecipientScope":{"$ref":"#/components/schemas/RecipientScope_Recipient_Response"},"Tag":{"$ref":"#/components/schemas/Tag_Recipient"},"ScaContext":{"$ref":"#/components/schemas/ScaContext_Recipient_Response"},"RecipientVerificationOfPayee":{"oneOf":[{"$ref":"#/components/schemas/RecipientVerificationOfPayee"},{"type":"null"}],"description":"Information about the [Verification of Payee (VOP)](/guides/vop) check performed on the Recipient. Because VOP only applies to SEPA local schemes, this object is returned `null` if the Recipient's `Currency` is not `EUR` or its `PayoutMethodType` is not `LocalBankTransfer`."},"PayoutMethodType":{"type":"string","description":"**Returned values:** `InternationalBankTransfer`\n\nThe payout method of the recipient:\n- `LocalBankTransfer` – The account can **only** receive the corresponding local `Currency` for the `Country` via the [domestic payment rail](/guides/payouts#payout-rails) (e.g. `EUR` via a SEPA local scheme to a SEPA country, `GBP` via FPS to a `GB` account, `USD` via ACH to a `US` account, etc). Payouts in non-local currencies return an error.\n- `InternationalBankTransfer` – The account can receive both non-local currencies via SWIFT and also local currency via domestic rails."},"RecipientType":{"type":"string","description":"**Returned values:** `Individual`\n\nThe recipient type:\n- `Individual` – An account held by a natural person, requiring the `IndividualRecipient` property.\n- `Business` – An account held by a legal entity, requiring the `BusinessRecipient` property."},"IndividualRecipient":{"$ref":"#/components/schemas/IndividualRecipient_Response"},"InternationalBankTransfer":{"$ref":"#/components/schemas/InternationalBankTransfer_Response"},"PendingUserAction":{"oneOf":[{"$ref":"#/components/schemas/PendingUserAction"},{"type":"null"}],"description":"SCA redirect information returned when registering an `OWNER` Recipient on creation. Returned `null` for `PAYIN`-scope recipients that don't trigger SCA. Omitted when viewing a recipient."}},"description":"Response body for a Recipient where `PayoutMethodType` is `InternationalBankTransfer` and `RecipientType` is `Individual`.","title":"CreateInternationalIndividualRecipientResponse"},"BusinessRecipient_Response":{"type":"object","properties":{"BusinessName":{"type":"string","description":"Length: 1–255; cannot contain: `(),.:/` (Pattern: `^(?!.*[(),.:/]).{1,255}$`)\n\nThe name of the business account holder."},"Address":{"$ref":"#/components/schemas/Address_Recipient"}},"description":"The account holder if the `RecipientType` is `Business`.","title":"BusinessRecipient_Response"},"CreateInternationalBusinessRecipientResponse":{"type":"object","properties":{"Id":{"$ref":"#/components/schemas/Id"},"Status":{"$ref":"#/components/schemas/Status_Recipient_Response"},"CreationDate":{"$ref":"#/components/schemas/CreationDate"},"DisplayName":{"$ref":"#/components/schemas/DisplayName_Recipient_Response"},"Currency":{"$ref":"#/components/schemas/Currency_Recipient"},"Country":{"$ref":"#/components/schemas/Country_Recipient"},"UserId":{"type":"string","description":"The unique identifier of the user."},"RecipientScope":{"$ref":"#/components/schemas/RecipientScope_Recipient_Response"},"Tag":{"$ref":"#/components/schemas/Tag_Recipient"},"ScaContext":{"$ref":"#/components/schemas/ScaContext_Recipient_Response"},"RecipientVerificationOfPayee":{"oneOf":[{"$ref":"#/components/schemas/RecipientVerificationOfPayee"},{"type":"null"}],"description":"Information about the [Verification of Payee (VOP)](/guides/vop) check performed on the Recipient. Because VOP only applies to SEPA local schemes, this object is returned `null` if the Recipient's `Currency` is not `EUR` or its `PayoutMethodType` is not `LocalBankTransfer`."},"PayoutMethodType":{"type":"string","description":"**Returned values:** `InternationalBankTransfer`\n\nThe payout method of the recipient:\n- `LocalBankTransfer` – The account can **only** receive the corresponding local `Currency` for the `Country` via the [domestic payment rail](/guides/payouts#payout-rails) (e.g. `EUR` via a SEPA local scheme to a SEPA country, `GBP` via FPS to a `GB` account, `USD` via ACH to a `US` account, etc). Payouts in non-local currencies return an error.\n- `InternationalBankTransfer` – The account can receive both non-local currencies via SWIFT and also local currency via domestic rails."},"RecipientType":{"type":"string","description":"**Returned values:** `Business`\n\nThe recipient type:\n- `Individual` – An account held by a natural person, requiring the `IndividualRecipient` property.\n- `Business` – An account held by a legal entity, requiring the `BusinessRecipient` property."},"BusinessRecipient":{"$ref":"#/components/schemas/BusinessRecipient_Response"},"InternationalBankTransfer":{"$ref":"#/components/schemas/InternationalBankTransfer_Response"},"PendingUserAction":{"oneOf":[{"$ref":"#/components/schemas/PendingUserAction"},{"type":"null"}],"description":"SCA redirect information returned when registering an `OWNER` Recipient on creation. Returned `null` for `PAYIN`-scope recipients that don't trigger SCA. Omitted when viewing a recipient."}},"description":"Response body for a Recipient where `PayoutMethodType` is\n`InternationalBankTransfer` and `RecipientType` is `Business`.","title":"CreateInternationalBusinessRecipientResponse"},"LocalBankTransfer_CAD":{"type":"object","properties":{"AccountNumber":{"type":"string","description":"Format: 7–35 digits (pattern: `^\\d{7,35}$`).\n\nThe account number of the Canadian account."},"InstitutionNumber":{"type":"string","description":"Format: 3 digits (pattern: `^\\d{3}$`).\n\nThe institution number of the Canadian account."},"BranchCode":{"type":"string","description":"Format: 5 digits (pattern: `^\\d{5}$`).\n\nThe branch code of the Canadian account."},"BankName":{"type":"string","description":"Length: 1–50.\n\nThe bank name of the Canadian account."}},"description":"Local bank transfer details for `Currency` value `CAD`.","title":"LocalBankTransfer_CAD"},"LocalBankTransfer_IBAN":{"type":"object","properties":{"IBAN":{"type":"string","description":"Format: A valid IBAN (pattern: `^[a-zA-Z]{2}\\d{2}\\s*(\\w{4}\\s*){2,7}\\w{1,4}\\s*$`).\n\nThe IBAN of the account."},"BIC":{"type":"string","description":"The BIC of the account. For IBAN countries, the returned `BIC` is generated from the IBAN."}},"description":"Local bank transfer details for IBAN-based currencies (`CHF`, `CZK`, `DKK`, `EUR`, `HUF`, `NOK`, `PLN`, `RON`, `SEK`).","title":"LocalBankTransfer_IBAN"},"LocalBankTransfer_GBP":{"type":"object","properties":{"AccountNumber":{"type":"string","description":"Format: 8 digits (pattern: `^\\d{8}$`).\n\nThe account number of the UK account."},"SortCode":{"type":"string","description":"Format: 6 digits (pattern: `^\\d{6}$`).\n\nThe sort code of the UK account."}},"description":"Local bank transfer details for `Currency` value `GBP`.","title":"LocalBankTransfer_GBP"},"LocalBankTransfer_USD":{"type":"object","properties":{"AccountNumber":{"type":"string","description":"Format: 8–12 alphanumeric characters (pattern: `^[0-9a-zA-Z]{8,12}$`).\n\nThe account number of the US account."},"ABA":{"type":"string","description":"Format: 9 digits (pattern: `^\\d{9}$`).\n\nThe ABA routing number of the US account."},"FFC":{"type":"string","description":"Format: 8-12 digits then `FFC` then a space then a string of characters up to 140 total length (pattern: `^(?=.{0,140}$)[0-9]{8,12}/FFC [0-9a-zA-Z/\\-?:().,'+ ]+$`).\n\nFFC transfer information for the US account."}},"description":"Local bank transfer details for `Currency` value `USD`.","title":"LocalBankTransfer_USD"},"LocalBankTransferDetails":{"type":"object","properties":{"CAD":{"$ref":"#/components/schemas/LocalBankTransfer_CAD"},"CHF":{"$ref":"#/components/schemas/LocalBankTransfer_IBAN"},"CZK":{"$ref":"#/components/schemas/LocalBankTransfer_IBAN"},"DKK":{"$ref":"#/components/schemas/LocalBankTransfer_IBAN"},"EUR":{"$ref":"#/components/schemas/LocalBankTransfer_IBAN"},"GBP":{"$ref":"#/components/schemas/LocalBankTransfer_GBP"},"HUF":{"$ref":"#/components/schemas/LocalBankTransfer_IBAN"},"NOK":{"$ref":"#/components/schemas/LocalBankTransfer_IBAN"},"PLN":{"$ref":"#/components/schemas/LocalBankTransfer_IBAN"},"RON":{"$ref":"#/components/schemas/LocalBankTransfer_IBAN"},"SEK":{"$ref":"#/components/schemas/LocalBankTransfer_IBAN"},"USD":{"$ref":"#/components/schemas/LocalBankTransfer_USD"}},"description":"The account details if `PayoutMethodType` is `LocalBankTransfer`, depending on the `Currency`. One of:","title":"LocalBankTransferDetails"},"CreateLocalIndividualRecipientResponse":{"type":"object","properties":{"Id":{"$ref":"#/components/schemas/Id"},"Status":{"$ref":"#/components/schemas/Status_Recipient_Response"},"CreationDate":{"$ref":"#/components/schemas/CreationDate"},"DisplayName":{"$ref":"#/components/schemas/DisplayName_Recipient_Response"},"Currency":{"$ref":"#/components/schemas/Currency_Recipient"},"Country":{"$ref":"#/components/schemas/Country_Recipient"},"UserId":{"type":"string","description":"The unique identifier of the user."},"RecipientScope":{"$ref":"#/components/schemas/RecipientScope_Recipient_Response"},"Tag":{"$ref":"#/components/schemas/Tag_Recipient"},"ScaContext":{"$ref":"#/components/schemas/ScaContext_Recipient_Response"},"RecipientVerificationOfPayee":{"oneOf":[{"$ref":"#/components/schemas/RecipientVerificationOfPayee"},{"type":"null"}],"description":"Information about the [Verification of Payee (VOP)](/guides/vop) check performed on the Recipient. Because VOP only applies to SEPA local schemes, this object is returned `null` if the Recipient's `Currency` is not `EUR` or its `PayoutMethodType` is not `LocalBankTransfer`."},"PayoutMethodType":{"type":"string","description":"**Returned values:** `LocalBankTransfer`\n\nThe payout method of the recipient:\n- `LocalBankTransfer` – The account can **only** receive the corresponding local `Currency` for the `Country` via the [domestic payment rail](/guides/payouts#payout-rails) (e.g. `EUR` via a SEPA local scheme to a SEPA country, `GBP` via FPS to a `GB` account, `USD` via ACH to a `US` account, etc). Payouts in non-local currencies return an error.\n- `InternationalBankTransfer` – The account can receive both non-local currencies via SWIFT and also local currency via domestic rails."},"RecipientType":{"type":"string","description":"**Returned values:** `Individual`\n\nThe recipient type:\n- `Individual` – An account held by a natural person, requiring the `IndividualRecipient` property.\n- `Business` – An account held by a legal entity, requiring the `BusinessRecipient` property."},"IndividualRecipient":{"$ref":"#/components/schemas/IndividualRecipient_Response"},"LocalBankTransfer":{"$ref":"#/components/schemas/LocalBankTransferDetails"},"PendingUserAction":{"oneOf":[{"$ref":"#/components/schemas/PendingUserAction"},{"type":"null"}],"description":"SCA redirect information returned when registering an `OWNER` Recipient on creation. Returned `null` for `PAYIN`-scope recipients that don't trigger SCA. Omitted when viewing a recipient."}},"description":"Response body for a Recipient where `PayoutMethodType` is `LocalBankTransfer` and `RecipientType` is `Individual`.","title":"CreateLocalIndividualRecipientResponse"},"CreateLocalBusinessRecipientResponse":{"type":"object","properties":{"Id":{"$ref":"#/components/schemas/Id"},"Status":{"$ref":"#/components/schemas/Status_Recipient_Response"},"CreationDate":{"$ref":"#/components/schemas/CreationDate"},"DisplayName":{"$ref":"#/components/schemas/DisplayName_Recipient_Response"},"Currency":{"$ref":"#/components/schemas/Currency_Recipient"},"Country":{"$ref":"#/components/schemas/Country_Recipient"},"UserId":{"type":"string","description":"The unique identifier of the user."},"RecipientScope":{"$ref":"#/components/schemas/RecipientScope_Recipient_Response"},"Tag":{"$ref":"#/components/schemas/Tag_Recipient"},"ScaContext":{"$ref":"#/components/schemas/ScaContext_Recipient_Response"},"RecipientVerificationOfPayee":{"oneOf":[{"$ref":"#/components/schemas/RecipientVerificationOfPayee"},{"type":"null"}],"description":"Information about the [Verification of Payee (VOP)](/guides/vop) check performed on the Recipient. Because VOP only applies to SEPA local schemes, this object is returned `null` if the Recipient's `Currency` is not `EUR` or its `PayoutMethodType` is not `LocalBankTransfer`."},"PayoutMethodType":{"type":"string","description":"**Returned values:** `LocalBankTransfer`\n\nThe payout method of the recipient:\n- `LocalBankTransfer` – The account can **only** receive the corresponding local `Currency` for the `Country` via the [domestic payment rail](/guides/payouts#payout-rails) (e.g. `EUR` via a SEPA local scheme to a SEPA country, `GBP` via FPS to a `GB` account, `USD` via ACH to a `US` account, etc). Payouts in non-local currencies return an error.\n- `InternationalBankTransfer` – The account can receive both non-local currencies via SWIFT and also local currency via domestic rails."},"RecipientType":{"type":"string","description":"**Returned values:** `Business`\n\nThe recipient type:\n- `Individual` – An account held by a natural person, requiring the `IndividualRecipient` property.\n- `Business` – An account held by a legal entity, requiring the `BusinessRecipient` property."},"BusinessRecipient":{"$ref":"#/components/schemas/BusinessRecipient_Response"},"LocalBankTransfer":{"$ref":"#/components/schemas/LocalBankTransferDetails"},"PendingUserAction":{"oneOf":[{"$ref":"#/components/schemas/PendingUserAction"},{"type":"null"}],"description":"SCA redirect information returned when registering an `OWNER` Recipient on creation. Returned `null` for `PAYIN`-scope recipients that don't trigger SCA. Omitted when viewing a recipient."}},"description":"Response body for a Recipient where `PayoutMethodType` is `LocalBankTransfer` and `RecipientType` is `Business`.","title":"CreateLocalBusinessRecipientResponse"},"RecipientResponse":{"oneOf":[{"$ref":"#/components/schemas/CreateInternationalIndividualRecipientResponse"},{"$ref":"#/components/schemas/CreateInternationalBusinessRecipientResponse"},{"$ref":"#/components/schemas/CreateLocalIndividualRecipientResponse"},{"$ref":"#/components/schemas/CreateLocalBusinessRecipientResponse"}],"title":"RecipientResponse"},"DeactivateARecipientRequest":{"type":"object","properties":{"Status":{"type":"string","description":"**Allowed values:** `DEACTIVATED`\n\nThe status of the recipient:\n- `DEACTIVATED` – Value to send to permanently disable the recipient so it can no longer be used. The Recipient must be `ACTIVE` to be deactivated."}},"required":["Status"],"title":"DeactivateARecipientRequest"},"PayoutMethodType_Recipient_Response":{"type":"string","description":"**Returned values:** `InternationalBankTransfer`, `LocalBankTransfer`\n\nThe payout method of the recipient:\n- `LocalBankTransfer` – The account can **only** receive the corresponding local `Currency` for the `Country` via the [domestic payment rail](/guides/payouts#payout-rails) (e.g. `EUR` via a SEPA local scheme to a SEPA country, `GBP` via FPS to a `GB` account, `USD` via ACH to a `US` account, etc). Payouts in non-local currencies return an error.\n- `InternationalBankTransfer` – The account can receive both non-local currencies via SWIFT and also local currency via domestic rails.","title":"PayoutMethodType_Recipient_Response"},"RecipientType_Recipient_Response":{"type":"string","description":"**Returned values:** `Individual`, `Business`\n\nThe recipient type:\n- `Individual` – An account held by a natural person, requiring the `IndividualRecipient` property.\n- `Business` – An account held by a legal entity, requiring the `BusinessRecipient` property.","title":"RecipientType_Recipient_Response"},"DeactivateARecipientResponse":{"type":"object","properties":{"Id":{"$ref":"#/components/schemas/Id"},"Status":{"$ref":"#/components/schemas/Status_Recipient_Response"},"CreationDate":{"$ref":"#/components/schemas/CreationDate"},"DisplayName":{"$ref":"#/components/schemas/DisplayName_Recipient_Response"},"PayoutMethodType":{"$ref":"#/components/schemas/PayoutMethodType_Recipient_Response"},"RecipientType":{"$ref":"#/components/schemas/RecipientType_Recipient_Response"},"Currency":{"$ref":"#/components/schemas/Currency_Recipient"},"Country":{"$ref":"#/components/schemas/Country_Recipient"},"UserId":{"type":"string","description":"The unique identifier of the user."},"RecipientScope":{"$ref":"#/components/schemas/RecipientScope_Recipient_Response"},"Tag":{"$ref":"#/components/schemas/Tag_Recipient"},"ScaContext":{"$ref":"#/components/schemas/ScaContext_Recipient_Response"},"IndividualRecipient":{"$ref":"#/components/schemas/IndividualRecipient_Response"},"BusinessRecipient":{"$ref":"#/components/schemas/BusinessRecipient_Response"},"InternationalBankTransfer":{"$ref":"#/components/schemas/InternationalBankTransfer_Response"},"LocalBankTransfer":{"$ref":"#/components/schemas/LocalBankTransferDetails"},"PendingUserAction":{"oneOf":[{"$ref":"#/components/schemas/PendingUserAction"},{"type":"null"}],"description":"Object containing the `RedirectUrl` needed for SCA redirection if triggered by the API call (otherwise returned `null`)."}},"title":"DeactivateARecipientResponse"},"RecipientListItem":{"type":"object","properties":{"Id":{"$ref":"#/components/schemas/Id"},"CreationDate":{"$ref":"#/components/schemas/CreationDate"},"DisplayName":{"$ref":"#/components/schemas/DisplayName_Recipient_Response"},"PayoutMethodType":{"$ref":"#/components/schemas/PayoutMethodType_Recipient_Response"},"RecipientType":{"$ref":"#/components/schemas/RecipientType_Recipient_Response"},"Currency":{"$ref":"#/components/schemas/Currency_Recipient"},"Country":{"$ref":"#/components/schemas/Country_Recipient"},"UserId":{"type":"string","description":"The unique identifier of the user."},"Status":{"$ref":"#/components/schemas/Status_Recipient_Response"},"RecipientScope":{"$ref":"#/components/schemas/RecipientScope_Recipient_Response"}},"title":"RecipientListItem"},"ListRecipientsForAUserResponse":{"type":"array","items":{"$ref":"#/components/schemas/RecipientListItem"},"title":"ListRecipientsForAUserResponse"},"ViewPayoutMethodsResponse":{"type":"object","properties":{"AvailablePayoutMethods":{"type":"array","items":{"type":"string"},"description":"**Possible values:** `LocalBankTransfer`, `InternationalBankTransfer`\n\nThe payout methods available for the currency and country combination."}},"title":"ViewPayoutMethodsResponse"},"Address_PlatformHeadquarters":{"type":"object","properties":{"AddressLine1":{"type":"string","description":"The first line of the address."},"AddressLine2":{"type":"string","description":"The second line of the address."},"City":{"type":"string","description":"The city of the address."},"Region":{"type":"string","description":"Required if `Country` is US, CA, or MX. The region of the address."},"PostalCode":{"type":"string","description":"Required if `HeadquarterAddress` is sent.\n\nThe postal code of the address. The postal code can contain the following characters: alphanumeric, dashes, and spaces."},"Country":{"type":"string","description":"Format: Two-letter country code ([ISO 3166-1 alpha-2 format](/api-reference/overview/data-formats))\n\nThe country of the address."}},"required":["AddressLine1","City","PostalCode","Country"],"description":"The address of the platform operator's headquarters. This parameter must be provided for the platform's payouts to be processed.","title":"Address_PlatformHeadquarters"},"CreateAnIBANBankAccountRequest":{"type":"object","properties":{"OwnerAddress":{"$ref":"#/components/schemas/Address_PlatformHeadquarters"},"IBAN":{"type":"string","description":"Max. length: 34 characters\n\nThe IBAN (international bank account number) of the bank account. It follows the CCDDBBAN format in which: - CC represents the country code (ISO 3166-1 alpha 2) - DD represents two check digits used by banking systems to avoid simple errors - BBAN stands for the Basic Bank Account Number which is up to 30 alphanumeric characters that are country-specific. Note: You will need a valid IBAN (i.e., existing in real life) when testing on a Sandbox account even if no actual payout will be processed."},"BIC":{"type":"string","description":"The BIC (international identifier of the bank) for IBAN or OTHER-type bank accounts.\n\nThe BIC can have one of the two following formats:\n- BIC8 – 8-character BIC (AAAABBCC)\n- BIC11 – 11-character BIC (AAAABBCCDDD)\n\nIn which:\n- AAAA represents the bank code: 4 characters defining the bank\n- BB represents the country code: 2 characters forming the country ISO code (ISO 3166 format)\n- CC represents the location code: 2 localization characters (alphabetical or numeric) to distinguish banks from the same country\n- DDD represents the branch code: 3 characters used to define the branch of the bank (sometimes replaced with XXX)\n\n**Note:** On IBAN-type bank accounts, the full 11-character version (not using XXX) may be required for the BIC to be accepted as valid. Alternatively, this optional field can be omitted."},"OwnerName":{"type":"string","description":"Max. length: 255 characters\n\nThe full name of the owner of the bank account. (Format: FirstName LastName)"},"Tag":{"$ref":"#/components/schemas/Tag"}},"required":["OwnerAddress","IBAN","OwnerName"],"title":"CreateAnIBANBankAccountRequest"},"IBANBankAccountResponse":{"type":"object","properties":{"OwnerAddress":{"$ref":"#/components/schemas/Address"},"IBAN":{"type":"string","description":"Max. length: 34 characters\n\nThe IBAN (international bank account number) of the bank account. It follows the CCDDBBAN format in which: - CC represents the country code (ISO 3166-1 alpha 2) - DD represents two check digits used by banking systems to avoid simple errors - BBAN stands for the Basic Bank Account Number which is up to 30 alphanumeric characters that are country-specific. Note: You will need a valid IBAN (i.e., existing in real life) when testing on a Sandbox account even if no actual payout will be processed."},"BIC":{"type":"string","description":"The BIC (international identifier of the bank) for IBAN or OTHER-type bank accounts.\n\nThe BIC can have one of the two following formats:\n- BIC8 – 8-character BIC (AAAABBCC)\n- BIC11 – 11-character BIC (AAAABBCCDDD)\n\nIn which:\n- AAAA represents the bank code: 4 characters defining the bank\n- BB represents the country code: 2 characters forming the country ISO code (ISO 3166 format)\n- CC represents the location code: 2 localization characters (alphabetical or numeric) to distinguish banks from the same country\n- DDD represents the branch code: 3 characters used to define the branch of the bank (sometimes replaced with XXX)"},"UserId":{"type":"string","description":"The unique identifier of the user."},"OwnerName":{"type":"string","description":"Max. length: 255 characters\n\nThe full name of the owner of the bank account. (Format: FirstName LastName)"},"Type":{"type":"string","description":"**Returned values:** `IBAN`, `US`, `CA`, `GB`, `OTHER`\n\nThe type of the bank account, indicating the country where the real-life account is registered\nThe values are:\n- `IBAN` – For accounts registered in countries that use IBAN\n- `US` – For accounts registered in the United States\n- `CA` – For accounts registered in Canada\n- `GB` – For accounts registered in the United Kingdom\n- `OTHER` – For accounts registered in countries that do not use IBAN (and are not US, CA, GB)"},"Id":{"$ref":"#/components/schemas/Id"},"Tag":{"$ref":"#/components/schemas/Tag"},"CreationDate":{"$ref":"#/components/schemas/CreationDate"},"Active":{"type":"boolean","description":"Whether or not the Bank Account is active. Mangopay automatically sets this parameter to `false` if the bank account is closed or does not exist anymore."}},"title":"IBANBankAccountResponse"},"CreateAUSBankAccountRequest":{"type":"object","properties":{"OwnerAddress":{"$ref":"#/components/schemas/Address_PlatformHeadquarters"},"AccountNumber":{"type":"string","description":"Format: Digits only\n\nThe unique set of digits of the bank account."},"ABA":{"type":"string","description":"Length: 9 characters\n\nThe American Banking Association (ABA) routing number for US-type bank accounts."},"DepositAccountType":{"type":"string","description":"**Allowed values:** `CHECKING`, `SAVINGS`\n\nThe deposit type for US-type bank accounts."},"OwnerName":{"type":"string","description":"Max. length: 255 characters\n\nThe full name of the owner of the bank account. (Format: FirstName LastName)"},"Tag":{"$ref":"#/components/schemas/Tag"}},"required":["OwnerAddress","AccountNumber","ABA","OwnerName"],"title":"CreateAUSBankAccountRequest"},"CreateAUSBankAccountResponse":{"type":"object","properties":{"OwnerAddress":{"$ref":"#/components/schemas/Address"},"AccountNumber":{"type":"string","description":"Format: Digits only\n\nThe unique set of digits of the bank account."},"ABA":{"type":"string","description":"Length: 9 characters\n\nThe American Banking Association (ABA) routing number for US-type bank accounts."},"DepositAccountType":{"type":"string","description":"**Returned values:** `CHECKING`, `SAVINGS`\n\nThe deposit type for US-type bank accounts."},"UserId":{"type":"string","description":"The unique identifier of the User (natural or legal) who owns the bank account."},"OwnerName":{"type":"string","description":"Max. length: 255 characters\n\nThe full name of the owner of the bank account. (Format: FirstName LastName)"},"Type":{"type":"string","description":"**Returned values:** `IBAN`, `US`, `CA`, `GB`, `OTHER`\n\nThe type of the bank account, indicating the country where the real-life account is registered\nThe values are:\n- `IBAN` – For accounts registered in countries that use IBAN\n- `US` – For accounts registered in the United States\n- `CA` – For accounts registered in Canada\n- `GB` – For accounts registered in the United Kingdom\n- `OTHER` – For accounts registered in countries that do not use IBAN (and are not US, CA, GB)"},"Id":{"$ref":"#/components/schemas/Id"},"Tag":{"$ref":"#/components/schemas/Tag"},"CreationDate":{"$ref":"#/components/schemas/CreationDate"},"Active":{"type":"boolean","description":"Whether or not the Bank Account is active. Mangopay automatically sets this parameter to `false` if the bank account is closed or does not exist anymore."}},"title":"CreateAUSBankAccountResponse"},"CreateACABankAccountRequest":{"type":"object","properties":{"OwnerAddress":{"$ref":"#/components/schemas/Address_PlatformHeadquarters"},"AccountNumber":{"type":"string","description":"Format: Digits only\n\nThe unique number of the bank account (between 7 to 35 digits)."},"InstitutionNumber":{"type":"string","description":"Length: 3 digits\n\nThe 3-digit number assigned to Canadian financial institutions, for CA-type bank accounts."},"BranchCode":{"type":"string","description":"Length: 5 digits\n\nThe 5-digit number assigned to branches of Canadian financial institutions, for CA-type bank accounts."},"BankName":{"type":"string","description":"Max. length: 50 characters (letters and digits only)\n\nThe name of the Canadian bank for CA-type bank accounts."},"OwnerName":{"type":"string","description":"Max. length: 255 characters\n\nThe full name of the owner of the bank account. (Format: FirstName LastName)"},"Tag":{"$ref":"#/components/schemas/Tag"}},"required":["OwnerAddress","AccountNumber","InstitutionNumber","BranchCode","BankName","OwnerName"],"title":"CreateACABankAccountRequest"},"CreateACABankAccountResponse":{"type":"object","properties":{"OwnerAddress":{"$ref":"#/components/schemas/Address"},"AccountNumber":{"type":"string","description":"Format: Digits only\n\nThe unique number of the bank account (between 7 to 35 digits)."},"InstitutionNumber":{"type":"string","description":"Length: 3 digits\n\nThe 3-digit number assigned to Canadian financial institutions, for CA-type bank accounts."},"BranchCode":{"type":"string","description":"Length: 5 digits\n\nThe 5-digit number assigned to branches of Canadian financial institutions, for CA-type bank accounts."},"BankName":{"type":"string","description":"Max. length: 50 characters (letters and digits only)\n\nThe name of the Canadian bank for CA-type bank accounts."},"UserId":{"type":"string","description":"The unique identifier of the User (natural or legal) who owns the bank account."},"OwnerName":{"type":"string","description":"Max. length: 255 characters\n\nThe full name of the owner of the bank account. (Format: FirstName LastName)"},"Type":{"type":"string","description":"**Returned values:** `IBAN`, `US`, `CA`, `GB`, `OTHER`\n\nThe type of the bank account, indicating the country where the real-life account is registered\nThe values are:\n- `IBAN` – For accounts registered in countries that use IBAN\n- `US` – For accounts registered in the United States\n- `CA` – For accounts registered in Canada\n- `GB` – For accounts registered in the United Kingdom\n- `OTHER` – For accounts registered in countries that do not use IBAN (and are not US, CA, GB)"},"Id":{"$ref":"#/components/schemas/Id"},"Tag":{"$ref":"#/components/schemas/Tag"},"CreationDate":{"$ref":"#/components/schemas/CreationDate"},"Active":{"type":"boolean","description":"Whether or not the Bank Account is active. Mangopay automatically sets this parameter to `false` if the bank account is closed or does not exist anymore."}},"title":"CreateACABankAccountResponse"},"CreateAGBBankAccountRequest":{"type":"object","properties":{"OwnerAddress":{"$ref":"#/components/schemas/Address_PlatformHeadquarters"},"AccountNumber":{"type":"string","description":"Length: 8 digits\n\nThe unique set of digits of the bank account."},"SortCode":{"type":"string","description":"The 6-digit sort code, assigned to UK financial institutions, for GB-type bank accounts."},"OwnerName":{"type":"string","description":"Max. length: 255 characters\n\nThe full name of the owner of the bank account. (Format: FirstName LastName)"},"Tag":{"$ref":"#/components/schemas/Tag"}},"required":["OwnerAddress","AccountNumber","SortCode","OwnerName"],"title":"CreateAGBBankAccountRequest"},"CreateAGBBankAccountResponse":{"type":"object","properties":{"OwnerAddress":{"$ref":"#/components/schemas/Address"},"AccountNumber":{"type":"string","description":"Length: 8 digits\n\nThe unique set of digits of the bank account."},"SortCode":{"type":"string","description":"The 6-digit sort code, assigned to UK financial institutions, for GB-type bank accounts."},"UserId":{"type":"string","description":"The unique identifier of the User (natural or legal) who owns the bank account."},"OwnerName":{"type":"string","description":"Max. length: 255 characters\n\nThe full name of the owner of the bank account. (Format: FirstName LastName)"},"Type":{"type":"string","description":"**Returned values:** `IBAN`, `US`, `CA`, `GB`, `OTHER`\n\nThe type of the bank account, indicating the country where the real-life account is registered\nThe values are:\n- `IBAN` – For accounts registered in countries that use IBAN\n- `US` – For accounts registered in the United States\n- `CA` – For accounts registered in Canada\n- `GB` – For accounts registered in the United Kingdom\n- `OTHER` – For accounts registered in countries that do not use IBAN (and are not US, CA, GB)"},"Id":{"$ref":"#/components/schemas/Id"},"Tag":{"$ref":"#/components/schemas/Tag"},"CreationDate":{"$ref":"#/components/schemas/CreationDate"},"Active":{"type":"boolean","description":"Whether or not the Bank Account is active. Mangopay automatically sets this parameter to `false` if the bank account is closed or does not exist anymore."}},"title":"CreateAGBBankAccountResponse"},"CreateAnOTHERBankAccountRequest":{"type":"object","properties":{"OwnerAddress":{"$ref":"#/components/schemas/Address_PlatformHeadquarters"},"AccountNumber":{"type":"string","description":"Max. length 35, min. length 5; alphanumeric characters only.\n\nThe unique number of the bank account."},"BIC":{"type":"string","description":"The BIC (international identifier of the bank) for IBAN or OTHER-type bank accounts.\n\nThe BIC can have one of the two following formats:\n- BIC8 – 8-character BIC (AAAABBCC)\n- BIC11 – 11-character BIC (AAAABBCCDDD)\n\nIn which:\n- AAAA represents the bank code: 4 characters defining the bank\n- BB represents the country code: 2 characters forming the country ISO code (ISO 3166 format)\n- CC represents the location code: 2 localization characters (alphabetical or numeric) to distinguish banks from the same country\n- DDD represents the branch code: 3 characters used to define the branch of the bank (sometimes replaced with XXX)"},"Country":{"type":"string","description":"The country in which the bank account is registered."},"OwnerName":{"type":"string","description":"Max. length: 255 characters\n\nThe full name of the owner of the bank account. (Format: FirstName LastName)"},"Tag":{"$ref":"#/components/schemas/Tag"}},"required":["OwnerAddress","AccountNumber","BIC","Country","OwnerName"],"title":"CreateAnOTHERBankAccountRequest"},"CreateAnOTHERBankAccountResponse":{"type":"object","properties":{"OwnerAddress":{"$ref":"#/components/schemas/Address"},"AccountNumber":{"type":"string","description":"Max. length 35, min. length 5; alphanumeric characters only.\n\nThe unique number of the bank account."},"BIC":{"type":"string","description":"The BIC (international identifier of the bank) for IBAN or OTHER-type bank accounts.\n\nThe BIC can have one of the two following formats:\n- BIC8 – 8-character BIC (AAAABBCC)\n- BIC11 – 11-character BIC (AAAABBCCDDD)\n\nIn which:\n- AAAA represents the bank code: 4 characters defining the bank\n- BB represents the country code: 2 characters forming the country ISO code (ISO 3166 format)\n- CC represents the location code: 2 localization characters (alphabetical or numeric) to distinguish banks from the same country\n- DDD represents the branch code: 3 characters used to define the branch of the bank (sometimes replaced with XXX)"},"Country":{"type":"string","description":"Format: Two-letter country code ([ISO 3166-1 alpha-2 format](/api-reference/overview/data-formats))\n\nThe country in which the bank account is registered."},"UserId":{"type":"string","description":"The unique identifier of the User (natural or legal) who owns the bank account."},"OwnerName":{"type":"string","description":"Max. length: 255 characters\n\nThe full name of the owner of the bank account. (Format: FirstName LastName)"},"Type":{"type":"string","description":"**Returned values:** `IBAN`, `US`, `CA`, `GB`, `OTHER`\n\nThe type of the bank account, indicating the country where the real-life account is registered\nThe values are:\n- `IBAN` – For accounts registered in countries that use IBAN\n- `US` – For accounts registered in the United States\n- `CA` – For accounts registered in Canada\n- `GB` – For accounts registered in the United Kingdom\n- `OTHER` – For accounts registered in countries that do not use IBAN (and are not US, CA, GB)"},"Id":{"$ref":"#/components/schemas/Id"},"Tag":{"$ref":"#/components/schemas/Tag"},"CreationDate":{"$ref":"#/components/schemas/CreationDate"},"Active":{"type":"boolean","description":"Whether or not the Bank Account is active. Mangopay automatically sets this parameter to `false` if the bank account is closed or does not exist anymore."}},"title":"CreateAnOTHERBankAccountResponse"},"ViewABankAccountResponse":{"type":"object","properties":{"OwnerAddress":{"$ref":"#/components/schemas/Address"},"IBAN":{"type":"string","description":"Max. length: 34 characters\n\nThe IBAN (international bank account number) of the bank account. It follows the CCDDBBAN format in which: - CC represents the country code (ISO 3166-1 alpha 2) - DD represents two check digits used by banking systems to avoid simple errors - BBAN stands for the Basic Bank Account Number which is up to 30 alphanumeric characters that are country-specific. Note: You will need a valid IBAN (i.e., existing in real life) when testing on a Sandbox account even if no actual payout will be processed."},"BIC":{"type":"string","description":"The BIC (international identifier of the bank) for IBAN or OTHER-type bank accounts.\n\nThe BIC can have one of the two following formats:\n- BIC8 – 8-character BIC (AAAABBCC)\n- BIC11 – 11-character BIC (AAAABBCCDDD)\n\nIn which:\n- AAAA represents the bank code: 4 characters defining the bank\n- BB represents the country code: 2 characters forming the country ISO code (ISO 3166 format)\n- CC represents the location code: 2 localization characters (alphabetical or numeric) to distinguish banks from the same country\n- DDD represents the branch code: 3 characters used to define the branch of the bank (sometimes replaced with XXX)"},"UserId":{"type":"string","description":"The unique identifier of the User (natural or legal) who owns the bank account."},"OwnerName":{"type":"string","description":"Max. length: 255 characters\n\nThe full name of the owner of the bank account. (Format: FirstName LastName)"},"Type":{"type":"string","description":"**Returned values:** `IBAN`, `US`, `CA`, `GB`, `OTHER`\n\nThe type of the bank account, indicating the country where the real-life account is registered\nThe values are:\n- `IBAN` – For accounts registered in countries that use IBAN\n- `US` – For accounts registered in the United States\n- `CA` – For accounts registered in Canada\n- `GB` – For accounts registered in the United Kingdom\n- `OTHER` – For accounts registered in countries that do not use IBAN (and are not US, CA, GB)"},"Id":{"$ref":"#/components/schemas/Id"},"Tag":{"$ref":"#/components/schemas/Tag"},"CreationDate":{"$ref":"#/components/schemas/CreationDate"},"Active":{"type":"boolean","description":"Whether or not the Bank Account is active. Mangopay automatically sets this parameter to `false` if the bank account is closed or does not exist anymore."},"AccountNumber":{"type":"string","description":"Length: 8 digits\n\nThe unique set of digits of the bank account."},"SortCode":{"type":"string","description":"The 6-digit sort code, assigned to UK financial institutions, for GB-type bank accounts."}},"title":"ViewABankAccountResponse"},"ListBankAccountsForAUserResponseArrayBankAccountsItemsObjectBankAccounts":{"type":"object","properties":{"OwnerAddress":{"$ref":"#/components/schemas/Address"},"OwnerName":{"type":"string","description":"The owner of the banking alias, which is set automatically by Mangopay since September 15, 2025 ([read more](/guides/vop/payins#banking-alias-categorization)). If the User owning the attached wallet has `UserCategory` of `OWNER` and the `KYCLevel` of `REGULAR`, then the `OwnerName` is set to the `FirstName` and `LastName` values for a [Natural User](/api-reference/users/natural-user-object-sca) or the `Name` value for a [Legal User](/api-reference/users/legal-user-object-sca). In this case, the `VirtualAccountPurpose` in the API response is `USER_OWNED`. If the User is not KYC verified and an `OWNER`, then the `OwnerName` is set to “MGP `PlatformTradingName`\" in standard cases, or else “Mangopay” for Marketplace Payment Extension (MPE) workflows. In this case, the `VirtualAccountPurpose` in the API response is `COLLECTION`. **Caution:** Your platform must ensure that you use the `OwnerName` returned in the API response."},"Tag":{"type":"string","description":"Custom data that you can add to this object."},"IBAN":{"type":"string","description":"The IBAN (international bank account number) for the bank account."},"AccountNumber":{"type":"string","description":"The unique set of digits of the bank account."},"BIC":{"type":"string","description":"The BIC (international identifier of the bank) for IBAN or OTHER-type bank accounts.\n\nThe BIC can have one of the two following formats:\n- BIC8 – 8-character BIC (AAAABBCC)\n- BIC11 – 11-character BIC (AAAABBCCDDD)\n\nIn which:\n- AAAA represents the bank code: 4 characters defining the bank\n- BB represents the country code: 2 characters forming the country ISO code (ISO 3166 format)\n- CC represents the location code: 2 localization characters (alphabetical or numeric) to distinguish banks from the same country\n- DDD represents the branch code: 3 characters used to define the branch of the bank (sometimes replaced with XXX)"},"ABA":{"type":"string","description":"The American Banking Association (ABA) routing number for US-type bank accounts."},"DepositAccountType":{"type":"string","description":"**Returned values:** `CHECKING`, `SAVINGS`\n\nThe deposit type for US-type bank accounts."},"InstitutionNumber":{"type":"string","description":"The 3-digit number assigned to Canadian financial institutions, for CA-type bank accounts."},"BranchCode":{"type":"string","description":"The 5-digit number assigned to branches of Canadian financial institutions, for CA-type bank accounts."},"BankName":{"type":"string","description":"The name of the Canadian bank for CA-type bank accounts."},"SortCode":{"type":"string","description":"The 6-digit sort code, assigned to UK financial institutions, for GB-type bank accounts."},"Country":{"type":"string","description":"Format: Two-letter country code ([ISO 3166-1 alpha-2 format](/api-reference/overview/data-formats))\n\nThe country in which the bank account is registered."},"UserId":{"type":"string","description":"The unique identifier of the User (natural or legal) who owns the bank account."},"Type":{"type":"string","description":"**Returned values:** `IBAN`, `US`, `CA`, `GB`, `OTHER`\n\nThe type of the bank account, indicating the country where the real-life account is registered\nThe values are:\n- `IBAN` – For accounts registered in countries that use IBAN\n- `US` – For accounts registered in the United States\n- `CA` – For accounts registered in Canada\n- `GB` – For accounts registered in the United Kingdom\n- `OTHER` – For accounts registered in countries that do not use IBAN (and are not US, CA, GB)"},"Id":{"$ref":"#/components/schemas/Id"},"CreationDate":{"$ref":"#/components/schemas/CreationDate"},"Active":{"type":"boolean","description":"Whether or not the Bank Account is active. Mangopay automatically sets this parameter to `false` if the bank account is closed or does not exist anymore."}},"description":"The Bank Account object created by the platform.","title":"ListBankAccountsForAUserResponseArrayBankAccountsItemsObjectBankAccounts"},"ListBankAccountsForAUserResponseArrayBankAccountsItems":{"type":"object","properties":{"Object (Bank Accounts)":{"$ref":"#/components/schemas/ListBankAccountsForAUserResponseArrayBankAccountsItemsObjectBankAccounts","description":"The Bank Account object created by the platform."}},"title":"ListBankAccountsForAUserResponseArrayBankAccountsItems"},"ListBankAccountsForAUserResponse":{"type":"object","properties":{"Array (Bank Accounts)":{"type":"array","items":{"$ref":"#/components/schemas/ListBankAccountsForAUserResponseArrayBankAccountsItems"},"description":"The list of Bank Accounts objects created by the platform. Returned parameters can vary depending on the bank account `Type`."}},"title":"ListBankAccountsForAUserResponse"},"CreateAPayoutRequestDebitedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"required":["Currency","Amount"],"description":"Information about the debited funds.","title":"CreateAPayoutRequestDebitedFunds"},"CreateAPayoutRequestFees":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"required":["Currency","Amount"],"description":"Information about the fees.","title":"CreateAPayoutRequestFees"},"CreateAPayoutRequestPaymentRef":{"type":"object","properties":{"ReasonType":{"type":"string","description":"**Allowed values:** `PAYIN_REFUND` \n\nThe reason for the reference being provided:\n- `PAYIN_REFUND` – The payout serves to reimburse a pay-in."},"ReferenceId":{"type":"string","description":"**Allowed values:** The valid `Id` of a successful pay-in.\n\nThe unique identifier associated with the reference, whose value corresponds to the `ReasonType`:\n- `PAYIN_REFUND` – The `ReferenceId` value provided is the same as the `Id` of the initial pay-in being refunded."}},"required":["ReasonType","ReferenceId"],"description":"Information about the payment reference provided for the payout. \n\nThis object must be used to provide the reference of a [bank wire pay-in](/api-reference/bank-wire-payins/bank-wire-payin-object) or a [pay-in to virtual IBAN](/api-reference/virtual-accounts/external-instruction-bank-wire-payin-object), if the payout is being used to refund it.","title":"CreateAPayoutRequestPaymentRef"},"CreateAPayoutRequest":{"type":"object","properties":{"AuthorId":{"type":"string","description":"The unique identifier of the user at the source of the transaction.\n\n**Best practice:** When the payout author is different from the bank account owner, the Payout `AuthorId` value must be different from the Recipient `UserId` value as well. Otherwise, Mangopay's Compliance team will reject the payout."},"DebitedFunds":{"$ref":"#/components/schemas/CreateAPayoutRequestDebitedFunds","description":"Information about the debited funds."},"Fees":{"$ref":"#/components/schemas/CreateAPayoutRequestFees","description":"Information about the fees."},"DebitedWalletId":{"type":"string","description":"The unique identifier of the debited wallet."},"RecipientId":{"type":"string","description":"The unique identifier of the [Recipient](/api-reference/recipients/recipient-object) object to which the payout is being requested. This property should be used by platforms integrating for the first time (and not the `BankAccountId`)."},"BankAccountId":{"type":"string","description":"The unique identifier of the Bank Account. This property should **not** be used by platforms integrating for the first time – send the `RecipientId` instead."},"Tag":{"$ref":"#/components/schemas/Tag"},"BankWireRef":{"type":"string","description":"Max. length: 255 characters (< 12 recommended)\n\nCustom description to appear on the user's bank statement along with the platform name. The recommended length is 12 characters – strings longer than this may be truncated depending on the bank. \n\nFor the full structure of the string, see the <a href=\"/bank-statements\">Customizing bank statement references</a> article."},"PayoutModeRequested":{"type":"string","description":"**Possible values:** `STANDARD`, `INSTANT_PAYMENT`, `INSTANT_PAYMENT_ONLY`, `RTGS_PAYMENT`\n\n**Default value:** `STANDARD`\n\nThe mode defining how the payout request is sent:\n- `STANDARD` – **Non-EUR:** Sent via the relevant local rail if the Recipient's destination country corresponds, or otherwise sent via SWIFT. Mangopay automatically routes funds via the [available rails](/guides/payouts#all-rails-by-currency), which also determines [delivery times](/guides/payouts#delivery-times). Requests received after the applicable cutoff are processed the next working day. **EUR:** Sent via the SEPA Credit Transfer scheme or SWIFT (if non-domestic).\n- `INSTANT_PAYMENT` – **EUR only:** Sent via the SEPA Instant Credit Transfer scheme (funds processed within 10 seconds) with a fallback to `STANDARD` mode if any of the prerequisites are not met or if another issue occurs. If the payout is above the threshold agreed with Mangopay, the payout fails and there is no fallback.\n- `INSTANT_PAYMENT_ONLY` – **EUR only:** sent via the SEPA Instant Credit Transfer scheme (funds processed within 10 seconds) without a fallback. If an issue occurs, the wallet automatically refunded.\n- `RTGS_PAYMENT` – **EUR only:** sent via the Eurozone's [real-time gross settlement (RGTS)](/guides/payouts#real-time-gross-settlement-rtgs) scheme T2 (funds processed same working day) without a fallback. If the request is received after the applicable cutoff (16:15 CET), it is processed the next working day (from 07:00 CET)."},"PaymentRef":{"oneOf":[{"$ref":"#/components/schemas/CreateAPayoutRequestPaymentRef"},{"type":"null"}],"description":"Information about the payment reference provided for the payout. \n\nThis object must be used to provide the reference of a [bank wire pay-in](/api-reference/bank-wire-payins/bank-wire-payin-object) or a [pay-in to virtual IBAN](/api-reference/virtual-accounts/external-instruction-bank-wire-payin-object), if the payout is being used to refund it."},"ChargeBearer":{"type":"string","description":"Possible values: `SHA`, `OUR`\n\nDefault value: `SHA`\n\nThe allocation of [processing fees](/guides/payouts#fees-for-international-payouts) for an international SWIFT payout:\n- `SHA` - Fees are shared between the remitter and beneficiary. The beneficiary's share is deducted from the payout, meaning that the amount arriving on the recipient's bank account may be less than the Payout's `CreditedFunds.Amount`.\n- `OUR` - All fees are paid by the remitter. The recipient receives the full `CreditedFunds.Amount` of the Payout, and Mangopay recovers the fees from the platform during the billing cycle. A 400 HTTP error is returned if Mangopay's network of partners does not support `OUR` fees for the given currency and recipient country, or if this feature is not activated.\n\nFor non-SWIFT requests, the `ChargeBearer` is ignored and `SHA` or `null` is displayed by default in the response."}},"required":["AuthorId","DebitedFunds","Fees","DebitedWalletId"],"title":"CreateAPayoutRequest"},"CreatePayoutResponseDebitedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the debited funds.","title":"CreatePayoutResponseDebitedFunds"},"CreatePayoutResponseCreditedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the credited funds (`CreditedFunds` = `DebitedFunds` - `Fees`).","title":"CreatePayoutResponseCreditedFunds"},"CreatePayoutResponseFees":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the fees.","title":"CreatePayoutResponseFees"},"CreatePayoutResponseFallbackReason":{"type":"object","properties":{"ResultCode":{"$ref":"#/components/schemas/ResultCode"},"ResultMessage":{"$ref":"#/components/schemas/ResultMessage"}},"description":"Information regarding the reason for the refusal of the instant payout request.","title":"CreatePayoutResponseFallbackReason"},"CreatePayoutResponsePaymentRef":{"type":"object","properties":{"ReasonType":{"type":"string","description":"**Allowed values:** `PAYIN_REFUND` \n\nThe reason for the reference being provided:\n- `PAYIN_REFUND` – The payout serves to reimburse a pay-in."},"ReferenceId":{"type":"string","description":"**Allowed values:** The valid `Id` of a successful pay-in.\n\nThe unique identifier associated with the reference, whose value corresponds to the `ReasonType`:\n- `PAYIN_REFUND` – The `ReferenceId` value provided is the same as the `Id` of the initial pay-in being refunded."}},"description":"Information about the payment reference provided for the payout. \n\nThis object must be used to provide the reference of a [bank wire pay-in](/api-reference/bank-wire-payins/bank-wire-payin-object) or a [pay-in to virtual IBAN](/api-reference/virtual-accounts/external-instruction-bank-wire-payin-object), if the payout is being used to refund it.","title":"CreatePayoutResponsePaymentRef"},"RecipientVerificationOfPayeePayout":{"type":"object","properties":{"RecipientVerificationId":{"$ref":"#/components/schemas/RecipientVerificationId"},"RecipientVerificationCheck":{"$ref":"#/components/schemas/RecipientVerificationCheck"},"RecipientVerificationMessage":{"$ref":"#/components/schemas/RecipientVerificationMessage"}},"description":"Information about the [Verification of Payee (VOP)](/guides/vop) check\nperformed on the Recipient as part of a Payout request. Because VOP only\napplies to SEPA local schemes, this object is returned `null` if the\nRecipient's `Currency` is not `EUR` or its `PayoutMethodType` is not\n`LocalBankTransfer`.\n\nUnlike [Recipient](/api-reference/recipients/recipient-object) endpoints,\n`RecipientVerificationPayeeSuggestedName` is not returned on Payout\nresponses, even if the result is `CLOSE_MATCH`.","title":"RecipientVerificationOfPayeePayout"},"CreatePayoutResponse":{"type":"object","properties":{"Id":{"$ref":"#/components/schemas/Id"},"Tag":{"$ref":"#/components/schemas/Tag"},"CreationDate":{"$ref":"#/components/schemas/CreationDate"},"AuthorId":{"type":"string","description":"The unique identifier of the user at the source of the transaction. \n\nBest practice: When the payout author is different from the bank account owner, the Payout `AuthorId` value must be different from the Bank Account `UserId` value as well. Otherwise, Mangopay's Compliance team will reject the payout."},"CreditedUserId":{"description":"For a payout, the `CreditedUserId` is always `null` as the funds are being paid out of the Mangoapy environment."},"DebitedFunds":{"$ref":"#/components/schemas/CreatePayoutResponseDebitedFunds","description":"Information about the debited funds."},"CreditedFunds":{"$ref":"#/components/schemas/CreatePayoutResponseCreditedFunds","description":"Information about the credited funds (`CreditedFunds` = `DebitedFunds` - `Fees`)."},"Fees":{"$ref":"#/components/schemas/CreatePayoutResponseFees","description":"Information about the fees."},"Status":{"$ref":"#/components/schemas/TransactionStatus"},"ResultCode":{"$ref":"#/components/schemas/ResultCode"},"ResultMessage":{"$ref":"#/components/schemas/ResultMessage"},"ExecutionDate":{"$ref":"#/components/schemas/TransactionExecutionDate"},"Type":{"$ref":"#/components/schemas/TransactionType"},"Nature":{"$ref":"#/components/schemas/TransactionNature"},"CreditedWalletId":{"type":"string","description":"The unique identifier of the credited wallet. In the specific case of the Payout object, this value is always `null` since there is no credited wallet."},"DebitedWalletId":{"type":"string","description":"The unique identifier of the debited wallet."},"PaymentType":{"type":"string","description":"**Returned values:** `BANK_WIRE`\n\nThe payment type of the payout."},"BankAccountId":{"type":"string","description":"The unique identifier of the bank account."},"BankWireRef":{"type":"string","description":"Max. length: 255 characters (< 12 recommended)\n\nCustom description to appear on the user's bank statement along with the platform name. The recommended length is 12 characters – strings longer than this may be truncated depending on the bank. For the full structure of the string, see the <a href=\"/bank-statements\">Customizing bank statement references</a> article."},"ModeRequested":{"type":"string","description":"**Returned values:** `STANDARD`, `INSTANT_PAYMENT`, `INSTANT_PAYMENT_ONLY`, `RTGS_PAYMENT`\n\nThe value set for the `PayoutModeRequested` parameter when making the request."},"ModeApplied":{"type":"string","description":"**Returned values:** `STANDARD`, `INSTANT_PAYMENT`, `RTGS_PAYMENT`, `PENDING_RESPONSE`\n\nThe mode defining how the payout request is sent:\n- `STANDARD` – **Non-EUR:** Sent via the relevant local rail if the Recipient's destination country corresponds, or otherwise sent via SWIFT. Mangopay automatically routes funds via the [available rails](/guides/payouts#all-rails-by-currency), which also determines [delivery times](/guides/payouts#delivery-times). Requests received after the applicable cutoff are processed the next working day. **EUR:** Sent via the SEPA Credit Transfer scheme or SWIFT (if non-domestic).\n- `INSTANT_PAYMENT` – **EUR only:** Sent via the SEPA Instant Credit Transfer scheme (funds processed within 10 seconds).\n- `RTGS_PAYMENT` – **EUR only:** Sent via the Eurozone's [real-time gross settlement (RGTS)](/guides/payouts#real-time-gross-settlement-rtgs) scheme T2 (funds processed same working day) without a fallback. If the request is received after the applicable cutoff (16:15 CET), it is processed the next working day (from 07:00 CET).\n- `PENDING_RESPONSE` – Temporary state to accommodate the possible latency between the creation of the request and the mode being applied in the case of instant payment and RGTS modes."},"FallbackReason":{"oneOf":[{"$ref":"#/components/schemas/CreatePayoutResponseFallbackReason"},{"type":"null"}],"description":"Information regarding the reason for the refusal of the instant payout request."},"EndToEndId":{"type":"string","description":"The unique identifier of a bank wire for tracking purposes only."},"PaymentRef":{"oneOf":[{"$ref":"#/components/schemas/CreatePayoutResponsePaymentRef"},{"type":"null"}],"description":"Information about the payment reference provided for the payout. \n\nThis object must be used to provide the reference of a [bank wire pay-in](/api-reference/bank-wire-payins/bank-wire-payin-object) or a [pay-in to virtual IBAN](/api-reference/virtual-accounts/external-instruction-bank-wire-payin-object), if the payout is being used to refund it."},"RecipientVerificationOfPayee":{"oneOf":[{"$ref":"#/components/schemas/RecipientVerificationOfPayeePayout"},{"type":"null"}],"description":"Information about the [Verification of Payee (VOP)](/guides/vop) check\nperformed on the Recipient as part of a Payout request. Because VOP only\napplies to SEPA local schemes, this object is returned `null` if the\nRecipient's `Currency` is not `EUR` or its `PayoutMethodType` is not\n`LocalBankTransfer`.\n\nUnlike [Recipient](/api-reference/recipients/recipient-object) endpoints,\n`RecipientVerificationPayeeSuggestedName` is not returned on Payout\nresponses, even if the result is `CLOSE_MATCH`."},"RecipientId":{"type":"string","description":"The unique identifier of the [Recipient](/api-reference/recipients/recipient-object) object to which the payout is being requested. This property should be used by platforms integrating for the first time (and not the `BankAccountId`)."},"ChargeBearer":{"type":"string","description":"Possible values: `SHA`, `OUR`\n\nDefault value: `SHA`\n\nThe allocation of [processing fees](/guides/payouts#fees-for-international-payouts) for an international SWIFT payout:\n- `SHA` - SWIFT fees are shared between the remitter and beneficiary. The beneficiary's share is deducted from the payout, meaning that the amount arriving on the recipient's bank account may be less than the Payout's `CreditedFunds.Amount`.\n- `OUR` - All SWIFT fees are paid by the remitter. The recipient receives the full `CreditedFunds.Amount` of the Payout, and Mangopay recovers the fees from the platform during the billing cycle. A 400 HTTP error is returned if Mangopay's network of partners does not support `OUR` fees for the given currency and recipient country, or if this feature is not activated.\n\nFor non-SWIFT requests, the `ChargeBearer` is ignored and `SHA` or `null` is displayed by default in the response."}},"title":"CreatePayoutResponse"},"PayoutWithModeAppliedResponseDebitedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the debited funds.","title":"PayoutWithModeAppliedResponseDebitedFunds"},"PayoutWithModeAppliedResponseCreditedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the credited funds (`CreditedFunds` = `DebitedFunds` - `Fees`).","title":"PayoutWithModeAppliedResponseCreditedFunds"},"PayoutWithModeAppliedResponseFees":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the fees.","title":"PayoutWithModeAppliedResponseFees"},"PayoutWithModeAppliedResponseFallbackReason":{"type":"object","properties":{"ResultCode":{"$ref":"#/components/schemas/ResultCode"},"ResultMessage":{"$ref":"#/components/schemas/ResultMessage"}},"description":"Information regarding the reason for the refusal of the instant payout request.","title":"PayoutWithModeAppliedResponseFallbackReason"},"PayoutWithModeAppliedResponsePaymentRef":{"type":"object","properties":{"ReasonType":{"type":"string","description":"**Allowed values:** `PAYIN_REFUND` \n\nThe reason for the reference being provided:\n- `PAYIN_REFUND` – The payout serves to reimburse a pay-in."},"ReferenceId":{"type":"string","description":"**Allowed values:** The valid `Id` of a successful pay-in.\n\nThe unique identifier associated with the reference, whose value corresponds to the `ReasonType`:\n- `PAYIN_REFUND` – The `ReferenceId` value provided is the same as the `Id` of the initial pay-in being refunded."}},"description":"Information about the payment reference provided for the payout. \n\nThis object must be used to provide the reference of a [bank wire pay-in](/api-reference/bank-wire-payins/bank-wire-payin-object) or a [pay-in to virtual IBAN](/api-reference/virtual-accounts/external-instruction-bank-wire-payin-object), if the payout is being used to refund it.","title":"PayoutWithModeAppliedResponsePaymentRef"},"PayoutWithModeAppliedResponse":{"type":"object","properties":{"Id":{"$ref":"#/components/schemas/Id"},"Tag":{"$ref":"#/components/schemas/Tag"},"CreationDate":{"$ref":"#/components/schemas/CreationDate"},"AuthorId":{"type":"string","description":"The unique identifier of the user at the source of the transaction.\n\n**Best practice:** When the payout author is different from the bank account owner, the Payout `AuthorId` value must be different from the Recipient `UserId` value as well. Otherwise, Mangopay's Compliance team will reject the payout."},"CreditedUserId":{"description":"For a payout, the `CreditedUserId` is always `null` as the funds are being paid out of the Mangoapy environment."},"DebitedFunds":{"$ref":"#/components/schemas/PayoutWithModeAppliedResponseDebitedFunds","description":"Information about the debited funds."},"CreditedFunds":{"$ref":"#/components/schemas/PayoutWithModeAppliedResponseCreditedFunds","description":"Information about the credited funds (`CreditedFunds` = `DebitedFunds` - `Fees`)."},"Fees":{"$ref":"#/components/schemas/PayoutWithModeAppliedResponseFees","description":"Information about the fees."},"Status":{"$ref":"#/components/schemas/TransactionStatus"},"ResultCode":{"$ref":"#/components/schemas/ResultCode"},"ResultMessage":{"$ref":"#/components/schemas/ResultMessage"},"ExecutionDate":{"$ref":"#/components/schemas/TransactionExecutionDate"},"Type":{"$ref":"#/components/schemas/TransactionType"},"Nature":{"$ref":"#/components/schemas/TransactionNature"},"CreditedWalletId":{"description":"For a payout, the `CreditedWalletId` is always `null` as the funds are being paid out of the Mangoapy environment."},"DebitedWalletId":{"type":"string","description":"The unique identifier of the debited wallet."},"PaymentType":{"type":"string","description":"**Returned values:** `BANK_WIRE`\n\nThe payment type of the payout."},"BankAccountId":{"type":"string","description":"The unique identifier of the bank account."},"BankWireRef":{"type":"string","description":"Max. length: 255 characters (< 12 recommended)\n\nCustom description to appear on the user's bank statement along with the platform name. The recommended length is 12 characters – strings longer than this may be truncated depending on the bank. For the full structure of the string, see the <a href=\"/bank-statements\">Customizing bank statement references</a> article."},"ModeRequested":{"type":"string","description":"**Returned values:** `STANDARD`, `INSTANT_PAYMENT`, `INSTANT_PAYMENT_ONLY`, `RTGS_PAYMENT`\n\nThe value set for the `PayoutModeRequested` parameter when making the request."},"ModeApplied":{"type":"string","description":"**Returned values:** `STANDARD`, `INSTANT_PAYMENT`, `RTGS_PAYMENT`, `PENDING_RESPONSE`\n\nThe mode defining how the payout request is sent:\n- `STANDARD` – **Non-EUR:** Sent via the relevant local rail if the Recipient's destination country corresponds, or otherwise sent via SWIFT. Mangopay automatically routes funds via the [available rails](/guides/payouts#all-rails-by-currency), which also determines [delivery times](/guides/payouts#delivery-times). Requests received after the applicable cutoff are processed the next working day. **EUR:** Sent via the SEPA Credit Transfer scheme or SWIFT (if non-domestic).\n- `INSTANT_PAYMENT` – **EUR only:** Sent via the SEPA Instant Credit Transfer scheme (funds processed within 10 seconds).\n- `RTGS_PAYMENT` – **EUR only:** Sent via the Eurozone's [real-time gross settlement (RGTS)](/guides/payouts#real-time-gross-settlement-rtgs) scheme T2 (funds processed same working day) without a fallback. If the request is received after the applicable cutoff (16:15 CET), it is processed the next working day (from 07:00 CET).\n- `PENDING_RESPONSE` – Temporary state to accommodate the possible latency between the creation of the request and the mode being applied in the case of instant payment and RGTS modes."},"FallbackReason":{"oneOf":[{"$ref":"#/components/schemas/PayoutWithModeAppliedResponseFallbackReason"},{"type":"null"}],"description":"Information regarding the reason for the refusal of the instant payout request."},"EndToEndId":{"type":"string","description":"The unique identifier of a bank wire for tracking purposes only."},"PaymentRef":{"oneOf":[{"$ref":"#/components/schemas/PayoutWithModeAppliedResponsePaymentRef"},{"type":"null"}],"description":"Information about the payment reference provided for the payout. \n\nThis object must be used to provide the reference of a [bank wire pay-in](/api-reference/bank-wire-payins/bank-wire-payin-object) or a [pay-in to virtual IBAN](/api-reference/virtual-accounts/external-instruction-bank-wire-payin-object), if the payout is being used to refund it."},"RecipientId":{"type":"string","description":"The unique identifier of the [Recipient](/api-reference/recipients/recipient-object) object to which the payout is being requested. This property should be used by platforms integrating for the first time (and not the `BankAccountId`)."},"ChargeBearer":{"type":"string","description":"Possible values: `SHA`, `OUR`\n\nDefault value: `SHA`\n\nThe allocation of [processing fees](/guides/payouts#fees-for-international-payouts) for an international SWIFT payout:\n- `SHA` - SWIFT fees are shared between the remitter and beneficiary. The beneficiary's share is deducted from the payout, meaning that the amount arriving on the recipient's bank account may be less than the Payout's `CreditedFunds.Amount`.\n- `OUR` - All SWIFT fees are paid by the remitter. The recipient receives the full `CreditedFunds.Amount` of the Payout, and Mangopay recovers the fees from the platform during the billing cycle. A 400 HTTP error is returned if Mangopay's network of partners does not support `OUR` fees for the given currency and recipient country, or if this feature is not activated.\n\nFor non-SWIFT requests, the `ChargeBearer` is ignored and `SHA` or `null` is displayed by default in the response."}},"title":"PayoutWithModeAppliedResponse"},"PayoutWithoutModeAppliedResponseDebitedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the debited funds.","title":"PayoutWithoutModeAppliedResponseDebitedFunds"},"PayoutWithoutModeAppliedResponseCreditedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the credited funds (`CreditedFunds` = `DebitedFunds` - `Fees`).","title":"PayoutWithoutModeAppliedResponseCreditedFunds"},"PayoutWithoutModeAppliedResponseFees":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the fees.","title":"PayoutWithoutModeAppliedResponseFees"},"PayoutWithoutModeAppliedResponsePaymentRef":{"type":"object","properties":{"ReasonType":{"type":"string","description":"**Allowed values:** `PAYIN_REFUND`\n\nThe reason for the reference being provided:\n- `PAYIN_REFUND` – The payout serves to reimburse a pay-in."},"ReferenceId":{"type":"string","description":"**Allowed values:** The valid `Id` of a successful pay-in.\n\nThe unique identifier associated with the reference, whose value corresponds to the `ReasonType`:\n- `PAYIN_REFUND` – The `ReferenceId` value provided is the same as the `Id` of the initial pay-in being refunded."}},"description":"Information about the payment reference provided for the payout. This object is returned `null` if not provided.\n\nThis object must be used to provide the reference of a [bank wire pay-in](/api-reference/bank-wire-payins/bank-wire-payin-object) or a [pay-in to virtual IBAN](/api-reference/virtual-accounts/external-instruction-bank-wire-payin-object), if the payout is being used to refund it.","title":"PayoutWithoutModeAppliedResponsePaymentRef"},"PayoutWithoutModeAppliedResponse":{"type":"object","properties":{"Id":{"$ref":"#/components/schemas/Id"},"Tag":{"$ref":"#/components/schemas/Tag"},"CreationDate":{"$ref":"#/components/schemas/CreationDate"},"AuthorId":{"type":"string","description":"The unique identifier of the user at the source of the transaction.\n\n**Best practice:** When the payout author is different from the bank account owner, the Payout `AuthorId` value must be different from the Recipient `UserId` value as well. Otherwise, Mangopay's Compliance team will reject the payout."},"CreditedUserId":{"description":"For a payout, the `CreditedUserId` is always `null` as the funds are being paid out of the Mangoapy environment."},"DebitedFunds":{"$ref":"#/components/schemas/PayoutWithoutModeAppliedResponseDebitedFunds","description":"Information about the debited funds."},"CreditedFunds":{"$ref":"#/components/schemas/PayoutWithoutModeAppliedResponseCreditedFunds","description":"Information about the credited funds (`CreditedFunds` = `DebitedFunds` - `Fees`)."},"Fees":{"$ref":"#/components/schemas/PayoutWithoutModeAppliedResponseFees","description":"Information about the fees."},"Status":{"$ref":"#/components/schemas/TransactionStatus"},"ResultCode":{"$ref":"#/components/schemas/ResultCode"},"ResultMessage":{"$ref":"#/components/schemas/ResultMessage"},"ExecutionDate":{"$ref":"#/components/schemas/TransactionExecutionDate"},"Type":{"$ref":"#/components/schemas/TransactionType"},"Nature":{"$ref":"#/components/schemas/TransactionNature"},"CreditedWalletId":{"description":"For a payout, the `CreditedWalletId` is always `null` as the funds are being paid out of the Mangoapy environment."},"DebitedWalletId":{"type":"string","description":"The unique identifier of the debited wallet."},"PaymentType":{"type":"string","description":"**Returned values:** `BANK_WIRE`\n\nThe payment type of the payout."},"BankAccountId":{"type":"string","description":"The unique identifier of the bank account."},"BankWireRef":{"type":"string","description":"Max. length: 255 characters (< 12 recommended)\n\nCustom description to appear on the user's bank statement along with the platform name. The recommended length is 12 characters – strings longer than this may be truncated depending on the bank. For the full structure of the string, see the <a href=\"/bank-statements\">Customizing bank statement references</a> article."},"PaymentRef":{"oneOf":[{"$ref":"#/components/schemas/PayoutWithoutModeAppliedResponsePaymentRef"},{"type":"null"}],"description":"Information about the payment reference provided for the payout. This object is returned `null` if not provided.\n\nThis object must be used to provide the reference of a [bank wire pay-in](/api-reference/bank-wire-payins/bank-wire-payin-object) or a [pay-in to virtual IBAN](/api-reference/virtual-accounts/external-instruction-bank-wire-payin-object), if the payout is being used to refund it."},"RecipientId":{"type":"string","description":"The unique identifier of the [Recipient](/api-reference/recipients/recipient-object) object to which the payout is being requested. This property should be used by platforms integrating for the first time (and not the `BankAccountId`)."}},"title":"PayoutWithoutModeAppliedResponse"},"CheckInstantPayoutEligibilityRequestDebitedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"required":["Currency","Amount"],"description":"Information about the debited funds.","title":"CheckInstantPayoutEligibilityRequestDebitedFunds"},"CheckInstantPayoutEligibilityRequestFees":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"required":["Currency","Amount"],"description":"Information about the fees.","title":"CheckInstantPayoutEligibilityRequestFees"},"CheckInstantPayoutEligibilityRequest":{"type":"object","properties":{"PayoutModeRequested":{"type":"string","description":"**Allowed values:** `INSTANT_PAYMENT`\n\nThe mode of payout, which must be `INSTANT_PAYMENT` on this reachability endpoint, even if your subsequent payout request uses `INSTANT_PAYMENT_ONLY`."},"AuthorId":{"type":"string","description":"The unique identifier of the user at the source of the transaction.\n\n**Best practice:** When the payout author is different from the bank account owner, the Payout `AuthorId` value must be different from the Recipient `UserId` value as well. Otherwise, Mangopay's Compliance team will reject the payout."},"DebitedFunds":{"$ref":"#/components/schemas/CheckInstantPayoutEligibilityRequestDebitedFunds","description":"Information about the debited funds."},"Fees":{"$ref":"#/components/schemas/CheckInstantPayoutEligibilityRequestFees","description":"Information about the fees."},"DebitedWalletId":{"type":"string","description":"The unique identifier of the debited wallet."},"BankAccountId":{"type":"string","description":"The unique identifier of the Bank Account. This property should **not** be used by platforms integrating for the first time – send the `RecipientId` instead."},"BankWireRef":{"type":"string","description":"Max. length: 255 characters (< 12 recommended)\n\nCustom description to appear on the user's bank statement along with the platform name. The recommended length is 12 characters – strings longer than this may be truncated depending on the bank. For the full structure of the string, see the <a href=\"/bank-statements\">Customizing bank statement references</a> article."}},"required":["PayoutModeRequested","AuthorId","DebitedFunds","Fees","DebitedWalletId"],"title":"CheckInstantPayoutEligibilityRequest"},"UnreachableReason_InstantPayoutEligibility":{"type":"object","properties":{"Code":{"type":"string","description":"The error code for the reason why the bank is not reachable."},"Message":{"type":"string","description":"The reason why the bank is not reachable."}},"description":"Information regarding why the bank is unreachable.","title":"UnreachableReason_InstantPayoutEligibility"},"InstantPayoutEligibilityResponseDebitedFunds":{"type":"object","properties":{"IsReachable":{"type":"boolean","description":"Whether or not the bank is reachable."},"UnreachableReason":{"oneOf":[{"$ref":"#/components/schemas/UnreachableReason_InstantPayoutEligibility"},{"type":"null"}],"description":"Information regarding why the bank is unreachable. Returned `null` when `IsReachable` is `true`."}},"description":"The reachability result for an SCT Inst payout.","title":"InstantPayoutEligibilityResponseDebitedFunds"},"InstantPayoutEligibilityResponse":{"type":"object","properties":{"Id":{"$ref":"#/components/schemas/Id"},"Tag":{"$ref":"#/components/schemas/Tag"},"CreationDate":{"$ref":"#/components/schemas/CreationDate"},"AuthorId":{"type":"string","description":"The unique identifier of the user at the source of the transaction.\n\n**Best practice:** When the payout author is different from the bank account owner, the Payout `AuthorId` value must be different from the Recipient `UserId` value as well. Otherwise, Mangopay's Compliance team will reject the payout."},"CreditedUserId":{"description":"For a payout, the `CreditedUserId` is always `null` as the funds are being paid out of the Mangoapy environment."},"DebitedFunds":{"$ref":"#/components/schemas/InstantPayoutEligibilityResponseDebitedFunds","description":"The reachability result for an SCT Inst payout."}},"title":"InstantPayoutEligibilityResponse"},"ViewAnIndicativeConversionRateResponse":{"type":"object","properties":{"DebitedCurrency":{"type":"string","description":"**Returned values:** The three-letter <a href=\"/api-reference/overview/data-formats\" target=\"_blank\">ISO 4217 code</a> (EUR, GBP, etc.) of a <a href=\"/guides/currencies\" target=\"_blank\">supported currency</a> (depends on feature, contract, and activation settings).\n\nThe sell currency (the currency of the debited wallet during a conversion)."},"CreditedCurrency":{"type":"string","description":"**Returned values:** The three-letter <a href=\"/api-reference/overview/data-formats\" target=\"_blank\">ISO 4217 code</a> (EUR, GBP, etc.) of a <a href=\"/guides/currencies\" target=\"_blank\">supported currency</a> (depends on feature, contract, and activation settings).\n\nThe buy currency (the currency of the credited wallet during a conversion)."},"ClientRate":{"type":"number","format":"double","description":"Max. 7 decimal places\n\nThe rate including Mangopay's markup, indicative of the rate invoiced during the billing cycle: `ClientRate` = `MarketRate` * (1 - markup). \n\nThe `ClientRate` fluctuates in line with the `MarketRate`."},"MarketRate":{"type":"number","format":"double","description":"Max. 7 decimal places\n\nThe rate used to convert funds during a conversion: (`DebitedFunds.Amount` - `Fees`) * `MarketRate` = `CreditedFunds.Amount`.\n\nThe market rate fluctuates in line with FX market dynamics and is common to all platforms for the currency pair."},"MarketRateDate":{"type":"integer","description":"The date and time at which the market rate was retrieved."}},"title":"ViewAnIndicativeConversionRateResponse"},"CreateAQuoteForUserWalletsRequestDebitedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"type":"integer","description":"Required if `CreditedFunds.Amount` is `null`\n\nAn 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`).\n\nDuring a conversion, (`DebitedFunds.Amount` - `Fees`) * `MarketRate` = `CreditedFunds.Amount`."}},"required":["Currency"],"description":"Information about the debited funds.","title":"CreateAQuoteForUserWalletsRequestDebitedFunds"},"CreateAQuoteForUserWalletsRequestCreditedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"type":"integer","description":"Required if `DebitedFunds.Amount` is `null`\n\nAn 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`).\n\nDuring a conversion, (`DebitedFunds.Amount` - `Fees`) * `MarketRate` = `CreditedFunds.Amount`."}},"required":["Currency"],"description":"Information about the credited funds.","title":"CreateAQuoteForUserWalletsRequestCreditedFunds"},"QuoteFeesRequest":{"type":"object","properties":{"Type":{"type":["string","null"],"description":"**Allowed values:** `PERCENTAGE`, `FIXED`\n\n**Default value:** `FIXED`\n\nThe type of the `Value`."},"Value":{"type":"integer","description":"The value to be used for the `Type`:\n- `PERCENTAGE` – In quantities of 0.1% (e.g. `150` equals 1.5%), the percentage of `DebitedFunds.Amount` deducted as fees.\n- `FIXED` – The amount deducted from `DebitedFunds.Amount` as fees, as 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`)."},"Currency":{"type":"string","description":"**Allowed values:** The three-letter <a href=\"/api-reference/overview/data-formats\" target=\"_blank\">ISO 4217 code</a> (EUR, GBP, etc.) of a <a href=\"/guides/currencies\" target=\"_blank\">supported currency</a> (depends on feature, contract, and activation settings).\n\nThe currency of the fees, which must match the debited currency."},"Amount":{"type":"integer","description":"For backwards compatibility, the `Amount` is accepted if sent instead of the `Value`.","deprecated":true}},"required":["Value","Currency"],"description":"Information about the fees taken by the platform for this transaction (and hence transferred to the Fees Wallet).","title":"QuoteFeesRequest"},"QuoteUserMarginRequest":{"type":"object","properties":{"Type":{"type":"string","description":"**Allowed values:** `PERCENTAGE`, `PIP`\n\nThe type of the `Value`."},"Value":{"type":"number","format":"double","description":"The value of the `Type`:\n- `PERCENTAGE` – Max. value: `10.0` (10%); max. 16 decimal places. The quantities of 1% used to calculate the user margin.\n- `PIP` – Max. value: `1000.0`. The quantities of `0.0001` (one pip) used to calculate the user margin."},"Currency":{"type":"string","description":"**Allowed values:** The three-letter <a href=\"/api-reference/overview/data-formats\" target=\"_blank\">ISO 4217 code</a> (EUR, GBP, etc.) of a <a href=\"/guides/currencies\" target=\"_blank\">supported currency</a> (depends on feature, contract, and activation settings).\n\nThe currency of the fees, which must match the debited currency."}},"required":["Type","Value","Currency"],"description":"Information about an indicative margin your platform can calculate and\ncharge to the user after conversion. These values are used to calculate\nthe `ConversionRateResponse.FinalRate` and the `MarginsResponse.User` in\nthe API response.","title":"QuoteUserMarginRequest"},"CreateAQuoteForUserWalletsRequest":{"type":"object","properties":{"DebitedFunds":{"$ref":"#/components/schemas/CreateAQuoteForUserWalletsRequestDebitedFunds","description":"Information about the debited funds."},"CreditedFunds":{"$ref":"#/components/schemas/CreateAQuoteForUserWalletsRequestCreditedFunds","description":"Information about the credited funds."},"Fees":{"$ref":"#/components/schemas/QuoteFeesRequest"},"UserMargin":{"$ref":"#/components/schemas/QuoteUserMarginRequest"},"Tag":{"$ref":"#/components/schemas/Tag"},"Duration":{"type":"integer","description":"**Allowed values:** `300`, `3600`\n\nThe time in seconds during which the quote is active and can be used for conversions.\n\nBy default, quotes are available for a duration of 5 or 60 minutes, as agreed between Mangopay and the platform."}},"required":["DebitedFunds","CreditedFunds","Duration"],"description":"Request body for creating a Quote intended to guarantee a rate for a\nconversion between user wallets. Includes optional `Fees` and `UserMargin`\nparameters. Use this variant when the corresponding conversion will be a\nuser-wallet-to-user-wallet conversion.","title":"CreateAQuoteForUserWalletsRequest"},"CreateAQuoteForClientWalletsRequestDebitedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"type":"integer","description":"Required if `CreditedFunds.Amount` is `null`\n\nAn 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`)."}},"required":["Currency"],"description":"Information about the debited funds – the sell currency. During a conversion, (`DebitedFunds.Amount` - `Fees`) * `MarketRate` = `CreditedFunds.Amount`.","title":"CreateAQuoteForClientWalletsRequestDebitedFunds"},"CreateAQuoteForClientWalletsRequestCreditedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"type":"integer","description":"Required if `CreditedFunds.Amount` is `null`\n\nAn 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`)."}},"required":["Currency"],"description":"Information about the debited funds – the sell currency. During a conversion, (`DebitedFunds.Amount` - `Fees`) * `MarketRate` = `CreditedFunds.Amount`.","title":"CreateAQuoteForClientWalletsRequestCreditedFunds"},"CreateAQuoteForClientWalletsRequest":{"type":"object","properties":{"DebitedFunds":{"$ref":"#/components/schemas/CreateAQuoteForClientWalletsRequestDebitedFunds","description":"Information about the debited funds – the sell currency. During a conversion, (`DebitedFunds.Amount` - `Fees`) * `MarketRate` = `CreditedFunds.Amount`."},"CreditedFunds":{"$ref":"#/components/schemas/CreateAQuoteForClientWalletsRequestCreditedFunds","description":"Information about the debited funds – the sell currency. During a conversion, (`DebitedFunds.Amount` - `Fees`) * `MarketRate` = `CreditedFunds.Amount`."},"UserMargin":{"$ref":"#/components/schemas/QuoteUserMarginRequest"},"Tag":{"$ref":"#/components/schemas/Tag"},"Duration":{"type":"integer","description":"**Allowed values:** `300`, `3600`\n\nThe time in seconds during which the quote is active and can be used for conversions.\n\nBy default, quotes are available for a duration of 5 or 60 minutes, as agreed between Mangopay and the platform."}},"required":["DebitedFunds","CreditedFunds","Duration"],"description":"Request body for creating a Quote intended to guarantee a rate for a\nclient-wallet conversion. `Fees` must not be sent (the conversion attempt\nwill return a 400 if its `QuoteId` includes fees) and `UserMargin` is\ndisregarded by the conversion if sent.","title":"CreateAQuoteForClientWalletsRequest"},"CreateAQuoteRequest":{"oneOf":[{"$ref":"#/components/schemas/CreateAQuoteForUserWalletsRequest"},{"$ref":"#/components/schemas/CreateAQuoteForClientWalletsRequest"}],"title":"CreateAQuoteRequest"},"Amount_DebitedFunds_QuoteResponse":{"type":"integer","description":"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`).\n\nDuring a conversion, (`DebitedFunds.Amount` - `Fees`) * `MarketRate` = `CreditedFunds.Amount`.","title":"Amount_DebitedFunds_QuoteResponse"},"CreateAQuoteResponseDebitedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount_DebitedFunds_QuoteResponse"}},"description":"Information about the debited funds.","title":"CreateAQuoteResponseDebitedFunds"},"Amount_CreditedFunds_QuoteResponse":{"type":"integer","description":"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`).\n\nDuring a conversion, `CreditedFunds.Amount` = (`DebitedFunds.Amount` - `Fees`) * `MarketRate`.","title":"Amount_CreditedFunds_QuoteResponse"},"CreateAQuoteResponseCreditedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount_CreditedFunds_QuoteResponse"}},"description":"Information about the credited funds.","title":"CreateAQuoteResponseCreditedFunds"},"Fees_ConversionResponse":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the fees taken by the platform for this transaction (and hence transferred to the Fees Wallet).\n\n**Note:** The fees currency must match the debited funds currency.","title":"Fees_ConversionResponse"},"RequestedFees_Conversion":{"type":"object","properties":{"Type":{"type":"string","description":"**Allowed values:** `PERCENTAGE`, `FIXED`\n\n**Default value:** `FIXED`\n\nThe type of the `Value`."},"Value":{"type":"integer","description":"The value to be used for the `Type`:\n- `PERCENTAGE` – In quantities of 0.1% (e.g. `150` equals 1.5%), the percentage of `DebitedFunds.Amount` deducted as fees.\n- `FIXED` – The amount deducted from `DebitedFunds.Amount` as fees, as 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`)."},"Currency":{"type":"string","description":"**Allowed values:** The three-letter <a href=\"/api-reference/overview/data-formats\" target=\"_blank\">ISO 4217 code</a> (EUR, GBP, etc.) of a <a href=\"/guides/currencies\" target=\"_blank\">supported currency</a> (depends on feature, contract, and activation settings).\n\nThe currency of the fees, which must match the debited currency."}},"description":"Information about the `Fees` sent in the request.","title":"RequestedFees_Conversion"},"ConversionRateResponse":{"type":"object","properties":{"ClientRate":{"type":"number","format":"double","description":"Max. 7 decimal places\n\nThe indicative rate including Mangopay's markup, used during the billing cycle: `ClientRate` = `MarketRate` * (1 - `MarginsResponse.Mangopay`). The `MarginsResponse.Mangopay.Amount` gives the amount of debited currency that will be billed by Mangopay to your platform for the transaction.\n\nThe `ClientRate` fluctuates in line with the `MarketRate`."},"MarketRate":{"type":"number","format":"double","description":"Max. 7 decimal places\n\nThe rate used to convert funds during the conversion: (`DebitedFunds.Amount` - `Fees`) * `MarketRate` = `CreditedFunds.Amount`.\n\nThe market rate fluctuates in line with FX market dynamics and is common to all platforms for the currency pair."},"FinalRate":{"type":"number","format":"double","description":"Max. 7 decimal places\n\nThe indicative rate including the `UserMargin`, if your platform defined it in the request or the quote: `FinalRate` = `ClientRate` * (1 - `MarginsResponse.User`). The `MarginsResponse.User.Amount` gives the amount of debited currency that your platform could bill to the user for the transaction.\n\nIf no `UserMargin` was included, the `FinalRate` is the same as the `ClientRate`."}},"description":"Information about the `MarketRate` used to convert funds and other indicative rates.","title":"ConversionRateResponse"},"MarginsResponseMangopay":{"type":"object","properties":{"Type":{"type":"string","description":"**Response value:** `PERCENTAGE`\n\nThe type of the `Value`, which for Mangopay is always `PERCENTAGE`."},"Value":{"type":"number","format":"double","description":"The value to be used for the `Type`.\n\nMangopay's markup is expressed as a percentage (to convert to decimal, divide by 100)."},"Amount":{"type":"integer","description":"The amount of debited currency that Mangopay will charge your platform for the transaction during the billing cycle."}},"description":"The margin used by Mangopay to bill your platform (which is defined during contracting).","title":"MarginsResponseMangopay"},"MarginsResponseUser":{"type":"object","properties":{"Type":{"type":"string","description":"**Response values:** `PERCENTAGE`, `PIP`\n\nThe type of the `Value`."},"Value":{"type":"number","format":"double","description":"The value to be used for the `Type`:\n- `PERCENTAGE` – The quantities of 1% used to calculate the user margin.\n- `PIP` – The quantities of `0.0001` (one pip) used to calculate the user margin."},"Amount":{"type":"integer","description":"The amount of debited currency that your platform could bill to the user for the transaction."}},"description":"The margin your platform could use to bill the user, as calculated by `UserMargin` in the request or quote (otherwise `null` if not set).","title":"MarginsResponseUser"},"MarginsResponse":{"type":"object","properties":{"Mangopay":{"$ref":"#/components/schemas/MarginsResponseMangopay","description":"The margin used by Mangopay to bill your platform (which is defined during contracting)."},"User":{"$ref":"#/components/schemas/MarginsResponseUser","description":"The margin your platform could use to bill the user, as calculated by `UserMargin` in the request or quote (otherwise `null` if not set)."}},"description":"Information about the margins calculated for the transaction.","title":"MarginsResponse"},"CreateAQuoteResponse":{"type":"object","properties":{"Id":{"$ref":"#/components/schemas/Id"},"CreationDate":{"$ref":"#/components/schemas/CreationDate"},"ExpirationDate":{"type":"integer","description":"Unix timestamp (UTC) of the date and time the quote expires and can no longer be used."},"Status":{"type":"string","description":"**Returned values:** `ACTIVE`, `EXPIRED`\n\nThe status of the quote:\n- `ACTIVE` – The quote can be used to execute a quoted conversion.\n- `EXPIRED` – The quote can't be used because the `ExpirationDate` is passed."},"DebitedFunds":{"$ref":"#/components/schemas/CreateAQuoteResponseDebitedFunds","description":"Information about the debited funds."},"CreditedFunds":{"$ref":"#/components/schemas/CreateAQuoteResponseCreditedFunds","description":"Information about the credited funds."},"Fees":{"$ref":"#/components/schemas/Fees_ConversionResponse"},"RequestedFees":{"$ref":"#/components/schemas/RequestedFees_Conversion"},"ConversionRateResponse":{"$ref":"#/components/schemas/ConversionRateResponse"},"MarginsResponse":{"$ref":"#/components/schemas/MarginsResponse"},"Tag":{"$ref":"#/components/schemas/Tag"},"Duration":{"type":"integer","description":"**Allowed values:** `300`, `3600`\n\nThe time in seconds during which the quote is active and can be used for conversions.\n\nBy default, quotes are available for a duration of 5 or 60 minutes, as agreed between Mangopay and the platform."}},"title":"CreateAQuoteResponse"},"ViewAQuoteResponseDebitedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount_DebitedFunds_QuoteResponse"}},"description":"Information about the debited funds.","title":"ViewAQuoteResponseDebitedFunds"},"ViewAQuoteResponseCreditedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount_CreditedFunds_QuoteResponse"}},"description":"Information about the credited funds.","title":"ViewAQuoteResponseCreditedFunds"},"ViewAQuoteResponse":{"type":"object","properties":{"Id":{"$ref":"#/components/schemas/Id"},"CreationDate":{"$ref":"#/components/schemas/CreationDate"},"ExpirationDate":{"type":"integer","description":"Unix timestamp (UTC) of the date and time the quote expires and can no longer be used."},"Status":{"type":"string","description":"**Returned values:** `ACTIVE`, `EXPIRED`\n\nThe status of the quote:\n- `ACTIVE` – The quote can be used to execute a quoted conversion.\n- `EXPIRED` – The quote can't be used because the `ExpirationDate` is passed."},"DebitedFunds":{"$ref":"#/components/schemas/ViewAQuoteResponseDebitedFunds","description":"Information about the debited funds."},"CreditedFunds":{"$ref":"#/components/schemas/ViewAQuoteResponseCreditedFunds","description":"Information about the credited funds."},"Fees":{"$ref":"#/components/schemas/Fees_ConversionResponse"},"ConversionRateResponse":{"$ref":"#/components/schemas/ConversionRateResponse"},"RequestedFees":{"$ref":"#/components/schemas/RequestedFees_Conversion"},"MarginsResponse":{"$ref":"#/components/schemas/MarginsResponse"},"Tag":{"$ref":"#/components/schemas/Tag"},"Duration":{"type":"integer","description":"**Allowed values:** `300`, `3600`\n\nThe time in seconds during which the quote is active and can be used for conversions.\n\nBy default, quotes are available for a duration of 5 or 60 minutes, as agreed between Mangopay and the platform."}},"title":"ViewAQuoteResponse"},"CreateAQuotedConversionBetweenUserWalletsRequest":{"type":"object","properties":{"QuoteId":{"type":"string","description":"The unique identifier of the active quote which guaranteed the rate for the conversion."},"AuthorId":{"type":"string","description":"The unique identifier of the user at the source of the transaction. In a conversion, both the debited and credited wallets are owned by the author."},"DebitedWalletId":{"type":"string","description":"The unique identifier of the debited wallet (in the sell currency)."},"CreditedWalletId":{"type":"string","description":"The unique identifier of the credited wallet (in the buy currency)."},"Tag":{"$ref":"#/components/schemas/Tag"}},"required":["QuoteId","AuthorId","DebitedWalletId","CreditedWalletId"],"title":"CreateAQuotedConversionBetweenUserWalletsRequest"},"Amount_DebitedFunds_ConversionResponse":{"type":"integer","description":"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`).\n\nDuring a conversion, (`DebitedFunds.Amount` - `Fees`) * `MarketRate` = `CreditedFunds.Amount`.","title":"Amount_DebitedFunds_ConversionResponse"},"CreateAQuotedConversionBetweenUserWalletsResponseDebitedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount_DebitedFunds_ConversionResponse"}},"description":"Information about the debited funds.","title":"CreateAQuotedConversionBetweenUserWalletsResponseDebitedFunds"},"Amount_CreditedFunds_ConversionResponse":{"type":"integer","description":"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`).\n\nDuring a conversion, `CreditedFunds.Amount` = (`DebitedFunds.Amount` - `Fees`) * `MarketRate`.","title":"Amount_CreditedFunds_ConversionResponse"},"CreateAQuotedConversionBetweenUserWalletsResponseCreditedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount_CreditedFunds_ConversionResponse"}},"description":"Information about the credited funds.","title":"CreateAQuotedConversionBetweenUserWalletsResponseCreditedFunds"},"CreateAQuotedConversionBetweenUserWalletsResponse":{"type":"object","properties":{"Id":{"$ref":"#/components/schemas/Id"},"QuoteId":{"type":["string","null"],"description":"The unique identifier of the active quote which guaranteed the rate for the conversion.\n\nReturned `null` in the case of an instant conversion."},"Type":{"$ref":"#/components/schemas/TransactionType"},"Nature":{"$ref":"#/components/schemas/TransactionNature"},"CreationDate":{"$ref":"#/components/schemas/CreationDate"},"Status":{"$ref":"#/components/schemas/TransactionStatus"},"AuthorId":{"type":"string","description":"The unique identifier of the user at the source of the transaction. In a conversion, both the debited and credited wallets are owned by the author."},"DebitedWalletId":{"type":"string","description":"The unique identifier of the debited wallet (in the sell currency)."},"CreditedWalletId":{"type":"string","description":"The unique identifier of the credited wallet (in the buy currency)."},"DebitedFunds":{"$ref":"#/components/schemas/CreateAQuotedConversionBetweenUserWalletsResponseDebitedFunds","description":"Information about the debited funds."},"CreditedFunds":{"$ref":"#/components/schemas/CreateAQuotedConversionBetweenUserWalletsResponseCreditedFunds","description":"Information about the credited funds."},"Fees":{"$ref":"#/components/schemas/Fees_ConversionResponse"},"RequestedFees":{"$ref":"#/components/schemas/RequestedFees_Conversion"},"ResultCode":{"$ref":"#/components/schemas/ResultCode"},"ResultMessage":{"$ref":"#/components/schemas/ResultMessage"},"ExecutionDate":{"$ref":"#/components/schemas/TransactionExecutionDate"},"ConversionRateResponse":{"$ref":"#/components/schemas/ConversionRateResponse"},"MarginsResponse":{"$ref":"#/components/schemas/MarginsResponse"},"Tag":{"$ref":"#/components/schemas/Tag"}},"title":"CreateAQuotedConversionBetweenUserWalletsResponse"},"CreateAnInstantConversionBetweenUserWalletsRequestDebitedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"required":["Currency","Amount"],"description":"Information about the debited funds.","title":"CreateAnInstantConversionBetweenUserWalletsRequestDebitedFunds"},"CreateAnInstantConversionBetweenUserWalletsRequestCreditedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"}},"required":["Currency"],"description":"Information about the credited funds.","title":"CreateAnInstantConversionBetweenUserWalletsRequestCreditedFunds"},"CreateAnInstantConversionBetweenUserWalletsRequest":{"type":"object","properties":{"AuthorId":{"type":"string","description":"The unique identifier of the user at the source of the transaction. In a conversion, both the debited and credited wallets are owned by the author."},"DebitedWalletId":{"type":"string","description":"The unique identifier of the debited wallet (in the sell currency)."},"CreditedWalletId":{"type":"string","description":"The unique identifier of the credited wallet (in the buy currency)."},"DebitedFunds":{"$ref":"#/components/schemas/CreateAnInstantConversionBetweenUserWalletsRequestDebitedFunds","description":"Information about the debited funds."},"CreditedFunds":{"$ref":"#/components/schemas/CreateAnInstantConversionBetweenUserWalletsRequestCreditedFunds","description":"Information about the credited funds."},"Fees":{"$ref":"#/components/schemas/QuoteFeesRequest"},"UserMargin":{"$ref":"#/components/schemas/QuoteUserMarginRequest"},"Tag":{"$ref":"#/components/schemas/Tag"}},"required":["AuthorId","DebitedWalletId","CreditedWalletId","DebitedFunds","CreditedFunds"],"title":"CreateAnInstantConversionBetweenUserWalletsRequest"},"CreateAnInstantConversionBetweenUserWalletsResponseDebitedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount_DebitedFunds_ConversionResponse"}},"description":"Information about the debited funds.","title":"CreateAnInstantConversionBetweenUserWalletsResponseDebitedFunds"},"CreateAnInstantConversionBetweenUserWalletsResponseCreditedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount_CreditedFunds_ConversionResponse"}},"description":"Information about the credited funds.","title":"CreateAnInstantConversionBetweenUserWalletsResponseCreditedFunds"},"CreateAnInstantConversionBetweenUserWalletsResponse":{"type":"object","properties":{"Id":{"$ref":"#/components/schemas/Id"},"Type":{"$ref":"#/components/schemas/TransactionType"},"Nature":{"$ref":"#/components/schemas/TransactionNature"},"CreationDate":{"$ref":"#/components/schemas/CreationDate"},"Status":{"$ref":"#/components/schemas/TransactionStatus"},"AuthorId":{"type":"string","description":"The unique identifier of the user at the source of the transaction. In a conversion, both the debited and credited wallets are owned by the author."},"DebitedWalletId":{"type":"string","description":"The unique identifier of the debited wallet (in the sell currency)."},"CreditedWalletId":{"type":"string","description":"The unique identifier of the credited wallet (in the buy currency)."},"DebitedFunds":{"$ref":"#/components/schemas/CreateAnInstantConversionBetweenUserWalletsResponseDebitedFunds","description":"Information about the debited funds."},"CreditedFunds":{"$ref":"#/components/schemas/CreateAnInstantConversionBetweenUserWalletsResponseCreditedFunds","description":"Information about the credited funds."},"Fees":{"$ref":"#/components/schemas/Fees_ConversionResponse"},"RequestedFees":{"$ref":"#/components/schemas/RequestedFees_Conversion"},"ResultCode":{"$ref":"#/components/schemas/ResultCode"},"ResultMessage":{"$ref":"#/components/schemas/ResultMessage"},"ExecutionDate":{"$ref":"#/components/schemas/TransactionExecutionDate"},"ConversionRateResponse":{"$ref":"#/components/schemas/ConversionRateResponse"},"MarginsResponse":{"$ref":"#/components/schemas/MarginsResponse"},"Tag":{"$ref":"#/components/schemas/Tag"}},"title":"CreateAnInstantConversionBetweenUserWalletsResponse"},"DebitedWalletType_QuotedClientConversion":{"type":"string","description":"**Allowed values:** `FEES`, `CREDIT`\n\nThe type of the client wallet to be debited:\n- `FEES` – Fees Wallet, for fees collected by the platform.\n- `CREDIT` – Repudiation Wallet, for funds related to dispute management.\n\nThe amount and currency of the debited funds are defined by the quote.","title":"DebitedWalletType_QuotedClientConversion"},"CreditedWalletType_QuotedClientConversion":{"type":"string","description":"**Allowed values:** `FEES`, `CREDIT`\n\nThe type of the client wallet to be credited:\n- `FEES` – Fees Wallet, for fees collected by the platform.\n- `CREDIT` – Repudiation Wallet, for funds related to dispute management.\n\nThe amount and currency of the credited funds are defined by the quote.","title":"CreditedWalletType_QuotedClientConversion"},"CreateAQuotedConversionBetweenClientWalletsRequest":{"type":"object","properties":{"QuoteId":{"type":"string","description":"The unique identifier of the active quote which guaranteed the rate for the conversion."},"DebitedWalletType":{"$ref":"#/components/schemas/DebitedWalletType_QuotedClientConversion"},"CreditedWalletType":{"$ref":"#/components/schemas/CreditedWalletType_QuotedClientConversion"},"Tag":{"$ref":"#/components/schemas/Tag"}},"required":["QuoteId","DebitedWalletType","CreditedWalletType"],"title":"CreateAQuotedConversionBetweenClientWalletsRequest"},"QuotedConversionClientWalletsResponseDebitedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount_DebitedFunds_ConversionResponse"}},"description":"Information about the debited funds.","title":"QuotedConversionClientWalletsResponseDebitedFunds"},"QuotedConversionClientWalletsResponseCreditedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount_CreditedFunds_ConversionResponse"}},"description":"Information about the credited funds.","title":"QuotedConversionClientWalletsResponseCreditedFunds"},"QuotedConversionClientWalletsResponse":{"type":"object","properties":{"Id":{"$ref":"#/components/schemas/Id"},"QuoteId":{"type":["string","null"],"description":"The unique identifier of the active quote which guaranteed the rate for the conversion.\n\nReturned `null` in the case of an instant conversion."},"Type":{"$ref":"#/components/schemas/TransactionType"},"Nature":{"$ref":"#/components/schemas/TransactionNature"},"CreationDate":{"$ref":"#/components/schemas/CreationDate"},"Status":{"$ref":"#/components/schemas/TransactionStatus"},"AuthorId":{"type":"string","description":"The unique identifier of the user at the source of the transaction. In a conversion, both the debited and credited wallets are owned by the author."},"DebitedWalletId":{"type":"string","description":"The unique identifier of the debited wallet (in the sell currency)."},"CreditedWalletId":{"type":"string","description":"The unique identifier of the credited wallet (in the buy currency)."},"DebitedFunds":{"$ref":"#/components/schemas/QuotedConversionClientWalletsResponseDebitedFunds","description":"Information about the debited funds."},"CreditedFunds":{"$ref":"#/components/schemas/QuotedConversionClientWalletsResponseCreditedFunds","description":"Information about the credited funds."},"ResultCode":{"$ref":"#/components/schemas/ResultCode"},"ResultMessage":{"$ref":"#/components/schemas/ResultMessage"},"ExecutionDate":{"$ref":"#/components/schemas/TransactionExecutionDate"},"ConversionRateResponse":{"$ref":"#/components/schemas/ConversionRateResponse"},"Tag":{"$ref":"#/components/schemas/Tag"}},"title":"QuotedConversionClientWalletsResponse"},"DebitedWalletType_ClientConversion":{"type":"string","description":"**Allowed values:** `FEES`, `CREDIT`\n\nThe type of the client wallet to be debited:\n- `FEES` – Fees Wallet, for fees collected by the platform.\n- `CREDIT` – Repudiation Wallet, for funds related to dispute management.","title":"DebitedWalletType_ClientConversion"},"CreateAnInstantConversionBetweenClientWalletsRequestDebitedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"required":["Currency","Amount"],"description":"Information about the debited funds.","title":"CreateAnInstantConversionBetweenClientWalletsRequestDebitedFunds"},"CreditedWalletType_ClientConversion":{"type":"string","description":"**Allowed values:** `FEES`, `CREDIT`\n\nThe type of the client wallet to be credited:\n- `FEES` – Fees Wallet, for fees collected by the platform.\n- `CREDIT` – Repudiation Wallet, for funds related to dispute management.","title":"CreditedWalletType_ClientConversion"},"CreateAnInstantConversionBetweenClientWalletsRequestCreditedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"}},"required":["Currency"],"description":"Information about the credited funds – the buy currency.","title":"CreateAnInstantConversionBetweenClientWalletsRequestCreditedFunds"},"CreateAnInstantConversionBetweenClientWalletsRequest":{"type":"object","properties":{"DebitedWalletType":{"$ref":"#/components/schemas/DebitedWalletType_ClientConversion"},"DebitedFunds":{"$ref":"#/components/schemas/CreateAnInstantConversionBetweenClientWalletsRequestDebitedFunds","description":"Information about the debited funds."},"CreditedWalletType":{"$ref":"#/components/schemas/CreditedWalletType_ClientConversion"},"CreditedFunds":{"$ref":"#/components/schemas/CreateAnInstantConversionBetweenClientWalletsRequestCreditedFunds","description":"Information about the credited funds – the buy currency."},"Tag":{"$ref":"#/components/schemas/Tag"}},"required":["DebitedWalletType","DebitedFunds","CreditedWalletType","CreditedFunds"],"title":"CreateAnInstantConversionBetweenClientWalletsRequest"},"InstantConversionClientWalletsResponseDebitedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount_DebitedFunds_ConversionResponse"}},"description":"Information about the debited funds.","title":"InstantConversionClientWalletsResponseDebitedFunds"},"InstantConversionClientWalletsResponseCreditedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount_CreditedFunds_ConversionResponse"}},"description":"Information about the credited funds.","title":"InstantConversionClientWalletsResponseCreditedFunds"},"InstantConversionClientWalletsResponse":{"type":"object","properties":{"Id":{"$ref":"#/components/schemas/Id"},"Type":{"$ref":"#/components/schemas/TransactionType"},"Nature":{"$ref":"#/components/schemas/TransactionNature"},"CreationDate":{"$ref":"#/components/schemas/CreationDate"},"Status":{"$ref":"#/components/schemas/TransactionStatus"},"AuthorId":{"type":"string","description":"The unique identifier of the user at the source of the transaction. In a conversion, both the debited and credited wallets are owned by the author."},"DebitedWalletId":{"type":"string","description":"The unique identifier of the debited wallet (in the sell currency)."},"CreditedWalletId":{"type":"string","description":"The unique identifier of the credited wallet (in the buy currency)."},"DebitedFunds":{"$ref":"#/components/schemas/InstantConversionClientWalletsResponseDebitedFunds","description":"Information about the debited funds."},"CreditedFunds":{"$ref":"#/components/schemas/InstantConversionClientWalletsResponseCreditedFunds","description":"Information about the credited funds."},"ResultCode":{"$ref":"#/components/schemas/ResultCode"},"ResultMessage":{"$ref":"#/components/schemas/ResultMessage"},"ExecutionDate":{"$ref":"#/components/schemas/TransactionExecutionDate"},"ConversionRateResponse":{"$ref":"#/components/schemas/ConversionRateResponse"},"Tag":{"$ref":"#/components/schemas/Tag"}},"title":"InstantConversionClientWalletsResponse"},"ConversionResponseDebitedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount_DebitedFunds_ConversionResponse"}},"description":"Information about the debited funds.","title":"ConversionResponseDebitedFunds"},"ConversionResponseCreditedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount_CreditedFunds_ConversionResponse"}},"description":"Information about the credited funds.","title":"ConversionResponseCreditedFunds"},"ConversionResponse":{"type":"object","properties":{"Id":{"$ref":"#/components/schemas/Id"},"QuoteId":{"type":["string","null"],"description":"The unique identifier of the active quote which guaranteed the rate for the conversion.\n\nReturned `null` in the case of an instant conversion."},"Type":{"$ref":"#/components/schemas/TransactionType"},"Nature":{"$ref":"#/components/schemas/TransactionNature"},"CreationDate":{"$ref":"#/components/schemas/CreationDate"},"Status":{"$ref":"#/components/schemas/TransactionStatus"},"AuthorId":{"type":"string","description":"The unique identifier of the user at the source of the transaction. In a conversion, both the debited and credited wallets are owned by the author."},"DebitedWalletId":{"type":"string","description":"The unique identifier of the debited wallet (in the sell currency)."},"CreditedWalletId":{"type":"string","description":"The unique identifier of the credited wallet (in the buy currency)."},"DebitedFunds":{"$ref":"#/components/schemas/ConversionResponseDebitedFunds","description":"Information about the debited funds."},"CreditedFunds":{"$ref":"#/components/schemas/ConversionResponseCreditedFunds","description":"Information about the credited funds."},"Fees":{"$ref":"#/components/schemas/Fees_ConversionResponse"},"RequestedFees":{"$ref":"#/components/schemas/RequestedFees_Conversion"},"ResultCode":{"$ref":"#/components/schemas/ResultCode"},"ResultMessage":{"$ref":"#/components/schemas/ResultMessage"},"ExecutionDate":{"$ref":"#/components/schemas/TransactionExecutionDate"},"ConversionRateResponse":{"$ref":"#/components/schemas/ConversionRateResponse"},"MarginsResponse":{"$ref":"#/components/schemas/MarginsResponse"},"Tag":{"$ref":"#/components/schemas/Tag"}},"title":"ConversionResponse"},"TransactionResponseDebitedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the debited funds.","title":"TransactionResponseDebitedFunds"},"TransactionResponseCreditedFunds":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the credited funds (`CreditedFunds` = `DebitedFunds` - `Fees`).","title":"TransactionResponseCreditedFunds"},"TransactionResponseFees":{"type":"object","properties":{"Currency":{"$ref":"#/components/schemas/Currency"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"Information about the fees taken by the platform for this transaction (and hence transferred to the Fees Wallet).","title":"TransactionResponseFees"},"TransactionResponse":{"type":"object","properties":{"Id":{"$ref":"#/components/schemas/Id"},"Tag":{"type":"string","description":"Max. length: 255 characters\n\nCustom data that you can add to this object. For transactions (pay-in, transfer, payout), you can use this parameter to identify corresponding information regarding the user, transaction, or payment methods on your platform."},"CreationDate":{"$ref":"#/components/schemas/CreationDate"},"AuthorId":{"$ref":"#/components/schemas/AuthorId"},"CreditedUserId":{"$ref":"#/components/schemas/CreditedUserId"},"DebitedFunds":{"$ref":"#/components/schemas/TransactionResponseDebitedFunds","description":"Information about the debited funds."},"CreditedFunds":{"$ref":"#/components/schemas/TransactionResponseCreditedFunds","description":"Information about the credited funds (`CreditedFunds` = `DebitedFunds` - `Fees`)."},"Fees":{"$ref":"#/components/schemas/TransactionResponseFees","description":"Information about the fees taken by the platform for this transaction (and hence transferred to the Fees Wallet)."},"Status":{"$ref":"#/components/schemas/TransactionStatus"},"ResultCode":{"$ref":"#/components/schemas/ResultCode"},"ResultMessage":{"$ref":"#/components/schemas/ResultMessage"},"ExecutionDate":{"$ref":"#/components/schemas/TransactionExecutionDate"},"Type":{"$ref":"#/components/schemas/TransactionType"},"Nature":{"$ref":"#/components/schemas/TransactionNature"},"CreditedWalletId":{"type":"string","description":"The unique identifier of the credited wallet."},"DebitedWalletId":{"type":"string","description":"The unique identifier of the debited wallet."}},"title":"TransactionResponse"},"ListTransactionsResponseArrayTransactionsItems":{"type":"object","properties":{"Object (transaction)":{"$ref":"#/components/schemas/TransactionResponse"}},"title":"ListTransactionsResponseArrayTransactionsItems"},"ListTransactionsResponse":{"type":"object","properties":{"Array (Transactions)":{"type":"array","items":{"$ref":"#/components/schemas/ListTransactionsResponseArrayTransactionsItems"},"description":"The list of transactions created by the platform."}},"title":"ListTransactionsResponse"},"ListIntentExternalProvidersResponse":{"type":"array","items":{"type":"string"},"description":"The list of third-party PSP names supported as `ExternalData.ExternalProviderName` values on the Intent object.","title":"ListIntentExternalProvidersResponse"},"ExternalProcessingDateExternalProviderReferenceExternalMerchantReference2":{"type":"object","properties":{"ExternalProcessingDate":{"type":"integer","description":"The date at which the transaction authorization was created."},"ExternalProviderReference":{"type":"string","description":"The unique identifier of the transaction at the provider level."},"ExternalMerchantReference":{"type":"string","description":"The unique identifier of the transaction at the merchant level."},"ExternalProviderName":{"type":"string","description":"The [supported third-party PSP](/api-reference/echo/supported-providers) processing the transaction.\n\n**Note:** The uppercase value is expected. The API returns the sentence-case value."},"ExternalProviderPaymentMethod":{"type":"string","description":"One of the [supported payment methods](/api-reference/echo/supported-payment-methods) used to process the transaction."}},"required":["ExternalProcessingDate","ExternalProviderReference","ExternalProviderName"],"description":"Information about the transaction authorization processed by the third-party PSP.","title":"ExternalProcessingDateExternalProviderReferenceExternalMerchantReference2"},"BuyerId":{"type":"object","properties":{"Id":{"type":"string","description":"If it exists, the unique identifier of the Mangopay user making the payment via the third-party PSP. Must be a valid Mangopay `UserId`."}},"description":"Information about the buyer.","title":"BuyerId"},"AuthorIdWalletIdFeesAmount":{"type":"object","properties":{"AuthorId":{"type":"string","description":"The unique identifier of the seller of the line item.\n\nRequired if `WalletId` not sent."},"WalletId":{"type":"string","description":"The unique identifier of the wallet to credit the seller's funds.\n\nRequired if `AuthorId` not sent."},"FeesAmount":{"type":"integer","description":"The amount of fees that will be diverted to the platform's Fees Wallet when the Intent is split. This value can be overridden when the Split is created."},"TransferDate":{"type":"integer","description":"The future date when the funds are to be automatically transferred to the seller's wallet."}},"description":"Information about the seller of the line item.","title":"AuthorIdWalletIdFeesAmount"},"CreateAnIntentRequestLineItemsItemsShippingAddress":{"type":"object","properties":{"AddressLine1":{"type":"string","description":"The first line of the address."},"AddressLine2":{"type":"string","description":"The second line of the address."},"City":{"type":"string","description":"The city of the address."},"Region":{"type":"string","description":"The region of the address."},"PostalCode":{"type":"string","description":"The postal code of the address."},"Country":{"type":"string","description":"Format: Two-letter country code ([ISO 3166-1 alpha-2 format](/api-reference/overview/data-formats))\n\nThe country of the address."}},"description":"The shipping address.","title":"CreateAnIntentRequestLineItemsItemsShippingAddress"},"CreateAnIntentRequestLineItemsItems":{"type":"object","properties":{"Seller":{"$ref":"#/components/schemas/AuthorIdWalletIdFeesAmount"},"Sku":{"type":"string","description":"The stock keeping unit (SKU) or other unique identifier of the item."},"Name":{"type":"string","description":"The name of the item."},"Description":{"type":"string","description":"The description of the item."},"Quantity":{"type":"integer","description":"The number of units in the line item."},"UnitAmount":{"type":"integer","description":"The cost of each unit, including `TaxAmount` and excluding `DiscountAmount`."},"TaxAmount":{"type":"integer","description":"The amount of the `UnitAmount` which is tax."},"DiscountAmount":{"type":"integer","description":"The amount of discount applied to the item."},"Category":{"type":"string","description":"The category of the item, as defined by the platform."},"ShippingAddress":{"$ref":"#/components/schemas/CreateAnIntentRequestLineItemsItemsShippingAddress","description":"The shipping address."},"SplitOriginWalletId":{"type":"string","description":"The unique identifier of the wallet from which the split will be debited.\n\nThis parameter is required for Intents where `ExternalProviderName` is `Mangopay`. If it is not defined in the Intent it must be defined at Split creation."}},"required":["Seller","Sku","Quantity","UnitAmount"],"title":"CreateAnIntentRequestLineItemsItems"},"CreateAnIntentRequest":{"type":"object","properties":{"Amount":{"type":"integer","description":"The full amount authorized in the Intent, which must equal the sum of the total amounts of all `LineItems`."},"Currency":{"type":"string","description":"The currency of the intent."},"PlatformFeesAmount":{"type":"integer","description":"The amount of fees to be diverted to the platform's Fees Wallet when the Intent is split. This value can be overridden when the Split is created.\n\nThe `PlatformFeesAmount` value must the sum of all line item `Seller.FeesAmount` values."},"ExternalData":{"$ref":"#/components/schemas/ExternalProcessingDateExternalProviderReferenceExternalMerchantReference2"},"Buyer":{"$ref":"#/components/schemas/BuyerId"},"LineItems":{"type":"array","items":{"$ref":"#/components/schemas/CreateAnIntentRequestLineItemsItems"},"description":"Information about the items purchased in the transaction. A maximum of 100 line items can be created per Intent.\n\nThe sum of all line item amounts must equal the Intent `Amount` value. The total for each line items is calculated as ((`UnitAmount` x `Quantity`) - `DiscountAmount`), which is shown in the `TotalLineItemAmount` returned. The `TaxAmount` is indicative and included in the `UnitAmount`. \n\nThe sum of all line item `Seller.FeesAmount` values must equal the Intent `PlatformFeesAmount` value."},"Tag":{"$ref":"#/components/schemas/Tag"}},"required":["Amount","Currency","ExternalData","LineItems"],"title":"CreateAnIntentRequest"},"ExternalProcessingDateExternalProviderReferenceExternalMerchantReference":{"type":"object","properties":{"ExternalProcessingDate":{"type":"integer","description":"The date at which the transaction authorization was created."},"ExternalProviderReference":{"type":"string","description":"The unique identifier of the transaction at the provider level."},"ExternalMerchantReference":{"type":"string","description":"The unique identifier of the transaction at the merchant level."},"ExternalProviderName":{"type":"string","description":"The [supported third-party PSP](/api-reference/echo/supported-providers) processing the transaction.\n\n**Note:** The uppercase value is expected. The API returns the sentence-case value."},"ExternalProviderPaymentMethod":{"type":"string","description":"One of the [supported payment methods](/api-reference/echo/supported-payment-methods) used to process the transaction."}},"description":"Information about the transaction authorization processed by the third-party PSP.","title":"ExternalProcessingDateExternalProviderReferenceExternalMerchantReference"},"LineItemsIntentShippingAddress":{"type":"object","properties":{"AddressLine1":{"type":"string","description":"The first line of the address."},"AddressLine2":{"type":"string","description":"The second line of the address."},"City":{"type":"string","description":"The city of the address."},"Region":{"type":"string","description":"The region of the address."},"PostalCode":{"type":"string","description":"The postal code of the address."},"Country":{"type":"string","description":"Format: Two-letter country code ([ISO 3166-1 alpha-2 format](/api-reference/overview/data-formats))\n\nThe country of the address."}},"description":"The shipping address.","title":"LineItemsIntentShippingAddress"},"LineItems_Intent":{"type":"object","properties":{"Seller":{"$ref":"#/components/schemas/AuthorIdWalletIdFeesAmount"},"Id":{"type":"string","description":"The unique identifier of the line item in Mangopay's ecosystem."},"Sku":{"type":"string","description":"The stock keeping unit (SKU) or other unique identifier of the item."},"Name":{"type":"string","description":"The name of the item."},"Description":{"type":"string","description":"The description of the item."},"Quantity":{"type":"integer","description":"The number of units in the line item."},"UnitAmount":{"type":"integer","description":"The cost of each unit, including `TaxAmount` and excluding `DiscountAmount`."},"TaxAmount":{"type":"integer","description":"The amount of the `UnitAmount` which is tax."},"DiscountAmount":{"type":"integer","description":"The amount of discount applied to the line item."},"Category":{"type":"string","description":"The category of the item, as defined by the platform."},"ShippingAddress":{"$ref":"#/components/schemas/LineItemsIntentShippingAddress","description":"The shipping address."},"CapturedAmount":{"type":"integer","description":"The item total `CAPTURED` amount"},"RefundedAmount":{"type":"integer","description":"The item total `REFUNDED` amount"},"DisputedAmount":{"type":"integer","description":"The item total `DISPUTED` amount."},"SplitAmount":{"type":"integer","description":"The item total `COMPLETED` amount."},"CancelledAmount":{"type":"integer","description":"The item total `CANCELLED` amount."},"TotalLineItemAmount":{"type":"integer","description":"The total amount of the line item calculated as ((`UnitAmount` x `Quantity`) - `DiscountAmount`)."},"UnfundedSellerAmount":{"type":"integer","description":"The amount needing to be settled to the Platform's technical wallet before the Intent Splits can be executed for this seller."},"SplitOriginWalletId":{"type":"string","description":"The unique identifier of the wallet from which the split will be debited.\n\nThis parameter is required for Intents where `ExternalProviderName` is `Mangopay`. If it is not defined in the Intent it must be defined at Split creation."}},"title":"LineItems_Intent"},"IntentResponse":{"type":"object","properties":{"Id":{"type":"string","description":"The unique identifier of the intent."},"Amount":{"type":"integer","description":"The full amount authorized in the Intent, which must equal the sum of the total amounts of all `LineItems`."},"AvailableAmountToSplit":{"type":"integer","description":"The remaining amount of the Intent that can be split and transferred to the sellers' wallets."},"UnfundedAmount":{"type":"integer","description":"The amount needing to be settled to the Platform's technical wallet before the Intent Splits can be executed."},"Currency":{"type":"string","description":"The currency of the intent."},"PlatformFeesAmount":{"type":"integer","description":"The amount of fees to be diverted to the platform's Fees Wallet when the Intent is split. This value can be overridden when the Split is created.\n\nThe `PlatformFeesAmount` value must the sum of all line item `Seller.FeesAmount` values."},"Status":{"type":"string","description":"The status of the Intent, as declared by the platform through Intent Captures, Refunds (and reversals), or Disputes (and decisions). Where partial actions occur, the top-level Intent `Status` may differ from the `Status` of Intent `LineItems`.\n\nIntent `Status` values:\n- `AUTHORIZED` – The Intent `Amount` was authorized for acquisition by the PSP and can be captured or canceled.\n- `PARTIALLY_CAPTURED` – Part of the Intent `Amount` from one or more `LineItems` was captured. The other parts are either still available for capture or cancel.\n- `CAPTURED` – All of the Intent `Amount` was captured. Part of it may have been subsequently refunded or disputed.\n- `CANCELLED` – All of the Intent `Amount` was canceled.\n- `REFUNDED` – All of the `CapturedAmount` of all `LineItems` was refunded.\n- `REFUND_REVERSED` – The refund could not be completed and the funds were returned to the platform.\n- `DISPUTED` – All of the `CapturedAmount` of all `LineItems` was disputed.\n- `DEFENDED` – The dispute is being defended by the platform.\n- `DISPUTED_WON` – The dispute was resolved in favor of the platform.\n- `DISPUTED_LOST` – The dispute was resolved against the platform."},"NextActions":{"type":"string","description":"The possible next actions on the intent."},"ExternalData":{"$ref":"#/components/schemas/ExternalProcessingDateExternalProviderReferenceExternalMerchantReference"},"Buyer":{"$ref":"#/components/schemas/BuyerId"},"LineItems":{"type":"array","items":{"$ref":"#/components/schemas/LineItems_Intent"},"description":"Information about the items purchased in the transaction. A maximum of 100 line items can be created per Intent.\n\nThe sum of all line item amounts must equal the Intent `Amount` value. The total for each line items is calculated as ((`UnitAmount` x `Quantity`) - `DiscountAmount`), which is shown in the `TotalLineItemAmount` returned. The `TaxAmount` is indicative and included in the `UnitAmount`. \n\nThe sum of all line item `Seller.FeesAmount` values must equal the Intent `PlatformFeesAmount` value."},"Tag":{"$ref":"#/components/schemas/Tag"},"CreationDate":{"$ref":"#/components/schemas/CreationDate"},"ExecutionDate":{"type":"integer","description":"Unix timestamp (UTC) of the date and time the Intent moved to `AUTHORIZED`."}},"title":"IntentResponse"},"CancelAnIntentRequestExternalData":{"type":"object","properties":{"ExternalProcessingDate":{"type":"integer","description":"The date at which the cancellation was created."},"ExternalProviderReference":{"type":"string","description":"The unique identifier of the cancellation at the provider level"},"ExternalMerchantReference":{"type":"string","description":"The unique identifier of the cancellation at the merchant level"},"ExternalProviderName":{"type":"string","description":"The [supported third-party PSP](/api-reference/echo/supported-providers) processing the transaction."},"ExternalProviderPaymentMethod":{"type":"string","description":"One of the [supported payment methods](/api-reference/echo/supported-payment-methods) used to process the cancellation."}},"required":["ExternalProcessingDate"],"description":"Information about the cancellation processed by the third-party PSP.","title":"CancelAnIntentRequestExternalData"},"CancelAnIntentRequestLineItemsItems":{"type":"object","properties":{"Id":{"type":"string","description":"The unique identifier of the line item in Mangopay ecosystem."},"Amount":{"type":"integer","description":"The amount of the cancellation. The sum of the cancellation's `LineItems.Amount` values must equal the `Amount` of the cancellation."}},"required":["Id","Amount"],"title":"CancelAnIntentRequestLineItemsItems"},"CancelAnIntentRequest":{"type":"object","properties":{"Amount":{"type":"integer","description":"The amount of the cancellation, required for a partial cancellation. The cancellation `Amount` must equal the sum of its line items."},"Currency":{"type":"string","description":"The currency of the intent."},"PlatformFeesAmount":{"type":"integer","description":"The amount of fees to be diverted to the platform's Fees Wallet when the Intent is split. This value can be overridden when the Split is created.\n\nThe `PlatformFeesAmount` value must the sum of all line item `Seller.FeesAmount` values."},"ExternalData":{"$ref":"#/components/schemas/CancelAnIntentRequestExternalData","description":"Information about the cancellation processed by the third-party PSP."},"LineItems":{"type":"array","items":{"$ref":"#/components/schemas/CancelAnIntentRequestLineItemsItems"},"description":"Information about the items canceled, required for a partial cancellation."}},"title":"CancelAnIntentRequest"},"Id_IntentCancel":{"type":"object","properties":{"Id":{"type":"string","description":"The unique identifier of the Cancel."}},"description":"Information about the Cancel.","title":"Id_IntentCancel"},"CancelAnIntentResponse":{"type":"object","properties":{"Id":{"type":"string","description":"The unique identifier of the intent."},"Amount":{"type":"integer","description":"The full amount authorized in the Intent, which must equal the sum of the total amounts of all `LineItems`."},"AvailableAmountToSplit":{"type":"integer","description":"The remaining amount of the Intent that can be split and transferred to the sellers' wallets."},"UnfundedAmount":{"type":"integer","description":"The amount needing to be settled to the Platform's technical wallet before the Intent Splits can be executed."},"Currency":{"type":"string","description":"The currency of the intent."},"PlatformFeesAmount":{"type":"integer","description":"The amount of fees to be diverted to the platform's Fees Wallet when the Intent is split. This value can be overridden when the Split is created.\n\nThe `PlatformFeesAmount` value must the sum of all line item `Seller.FeesAmount` values."},"Status":{"type":"string","description":"The status of the Intent, as declared by the platform through Intent Captures, Refunds (and reversals), or Disputes (and decisions). Where partial actions occur, the top-level Intent `Status` may differ from the `Status` of Intent `LineItems`.\n\nIntent `Status` values:\n- `AUTHORIZED` – The Intent `Amount` was authorized for acquisition by the PSP and can be captured or canceled.\n- `PARTIALLY_CAPTURED` – Part of the Intent `Amount` from one or more `LineItems` was captured. The other parts are either still available for capture or cancel.\n- `CAPTURED` – All of the Intent `Amount` was captured. Part of it may have been subsequently refunded or disputed.\n- `CANCELLED` – All of the Intent `Amount` was canceled.\n- `REFUNDED` – All of the `CapturedAmount` of all `LineItems` was refunded.\n- `REFUND_REVERSED` – The refund could not be completed and the funds were returned to the platform.\n- `DISPUTED` – All of the `CapturedAmount` of all `LineItems` was disputed.\n- `DEFENDED` – The dispute is being defended by the platform.\n- `DISPUTED_WON` – The dispute was resolved in favor of the platform.\n- `DISPUTED_LOST` – The dispute was resolved against the platform."},"ExternalData":{"$ref":"#/components/schemas/ExternalProcessingDateExternalProviderReferenceExternalMerchantReference"},"Buyer":{"$ref":"#/components/schemas/BuyerId"},"LineItems":{"type":"array","items":{"$ref":"#/components/schemas/LineItems_Intent"},"description":"Information about the items purchased in the transaction. A maximum of 100 line items can be created per Intent.\n\nThe sum of all line item amounts must equal the Intent `Amount` value. The total for each line items is calculated as ((`UnitAmount` x `Quantity`) - `DiscountAmount`), which is shown in the `TotalLineItemAmount` returned. The `TaxAmount` is indicative and included in the `UnitAmount`. \n\nThe sum of all line item `Seller.FeesAmount` values must equal the Intent `PlatformFeesAmount` value."},"CreationDate":{"$ref":"#/components/schemas/CreationDate"},"ExecutionDate":{"type":"integer","description":"Unix timestamp (UTC) of the date and time the Intent moved to `AUTHORIZED`."},"Cancel":{"$ref":"#/components/schemas/Id_IntentCancel"}},"title":"CancelAnIntentResponse"},"CreateAnIntentCaptureRequestLineItemsItems":{"type":"object","properties":{"Id":{"type":"string","description":"The unique identifier of the line item in Mangopay ecosystem."},"Amount":{"type":"integer","description":"The amount of the capture. The sum of the Capture's `LineItems.Amount` values must equal the `Amount` of the Capture."}},"required":["Id","Amount"],"title":"CreateAnIntentCaptureRequestLineItemsItems"},"CreateAnIntentCaptureRequest":{"type":"object","properties":{"ExternalData":{"$ref":"#/components/schemas/ExternalProcessingDateExternalProviderReferenceExternalMerchantReference2"},"Amount":{"type":"integer","description":"The amount of the Capture, required for a partial capture. The Capture `Amount` must equal the sum of the `Amount` values captured for all line items."},"PlatformFeesAmount":{"type":"integer","description":"The amount of fees to be diverted to the platform's Fees Wallet when the Intent is split. This value can be overridden when the Split is created.\n\nThe `PlatformFeesAmount` value must the sum of all line item `Seller.FeesAmount` values."},"LineItems":{"type":"array","items":{"$ref":"#/components/schemas/CreateAnIntentCaptureRequestLineItemsItems"},"description":"Information about the items purchased in the transaction, required for a partial capture."},"Tag":{"$ref":"#/components/schemas/Tag"}},"title":"CreateAnIntentCaptureRequest"},"IdTotalLineItemAmountCapturedAmount":{"type":"object","properties":{"Id":{"type":"string","description":"The unique identifier of the line item in Mangopay's ecosystem."},"TotalLineItemAmount":{"type":"integer","description":"The total amount of the line item calculated as ((`UnitAmount` x `Quantity`) - `DiscountAmount`)."},"CapturedAmount":{"type":"integer","description":"The item total `CAPTURED` amount"},"RefundedAmount":{"type":"integer","description":"The item total `REFUNDED` amount"},"DisputedAmount":{"type":"integer","description":"The item total `DISPUTED` amount."},"SplitAmount":{"type":"integer","description":"The item total `COMPLETED` amount."},"UnfundedSellerAmount":{"type":"integer","description":"The amount needing to be settled to the Platform's technical wallet before the Intent Splits can be executed for this seller."}},"title":"IdTotalLineItemAmountCapturedAmount"},"Id_IntentCapture":{"type":"object","properties":{"Id":{"type":"string","description":"The unique identifier of the Capture."}},"description":"Information about the Capture.","title":"Id_IntentCapture"},"IntentCaptureResponse":{"type":"object","properties":{"Id":{"type":"string","description":"The unique identifier of the intent."},"Amount":{"type":"integer","description":"The full amount authorized in the Intent, which must equal the sum of the total amounts of all `LineItems`."},"AvailableAmountToSplit":{"type":"integer","description":"The remaining amount of the Intent that can be split and transferred to the sellers' wallets."},"UnfundedAmount":{"type":"integer","description":"The amount needing to be settled to the Platform's technical wallet before the Intent Splits can be executed."},"Currency":{"type":"string","description":"The currency of the intent."},"PlatformFeesAmount":{"type":"integer","description":"The amount of fees to be diverted to the platform's Fees Wallet when the Intent is split. This value can be overridden when the Split is created.\n\nThe `PlatformFeesAmount` value must the sum of all line item `Seller.FeesAmount` values."},"Status":{"type":"string","description":"The status of the Intent, as declared by the platform through Intent Captures, Refunds (and reversals), or Disputes (and decisions). Where partial actions occur, the top-level Intent `Status` may differ from the `Status` of Intent `LineItems`.\n\nIntent `Status` values:\n- `AUTHORIZED` – The Intent `Amount` was authorized for acquisition by the PSP and can be captured or canceled.\n- `PARTIALLY_CAPTURED` – Part of the Intent `Amount` from one or more `LineItems` was captured. The other parts are either still available for capture or cancel.\n- `CAPTURED` – All of the Intent `Amount` was captured. Part of it may have been subsequently refunded or disputed.\n- `CANCELLED` – All of the Intent `Amount` was canceled.\n- `REFUNDED` – All of the `CapturedAmount` of all `LineItems` was refunded.\n- `REFUND_REVERSED` – The refund could not be completed and the funds were returned to the platform.\n- `DISPUTED` – All of the `CapturedAmount` of all `LineItems` was disputed.\n- `DEFENDED` – The dispute is being defended by the platform.\n- `DISPUTED_WON` – The dispute was resolved in favor of the platform.\n- `DISPUTED_LOST` – The dispute was resolved against the platform."},"NextActions":{"type":"string","description":"The possible next actions on the intent."},"ExternalData":{"$ref":"#/components/schemas/ExternalProcessingDateExternalProviderReferenceExternalMerchantReference"},"Buyer":{"$ref":"#/components/schemas/BuyerId"},"LineItems":{"type":"array","items":{"$ref":"#/components/schemas/IdTotalLineItemAmountCapturedAmount"},"description":"Information about the line items included in the intent action."},"CreationDate":{"$ref":"#/components/schemas/CreationDate"},"ExecutionDate":{"type":"integer","description":"Unix timestamp (UTC) of the date and time the Intent moved to `AUTHORIZED`."},"Capture":{"$ref":"#/components/schemas/Id_IntentCapture"}},"title":"IntentCaptureResponse"},"CreateAnIntentRefundRequestLineItemsItems":{"type":"object","properties":{"Id":{"type":"string","description":"The unique identifier of the line item in Mangopay ecosystem."},"Amount":{"type":"integer","description":"The amount of the refund. The sum of the Refund's `LineItems.Amount` values must equal the `Amount` of the Refund."}},"required":["Id","Amount"],"title":"CreateAnIntentRefundRequestLineItemsItems"},"CreateAnIntentRefundRequest":{"type":"object","properties":{"ExternalData":{"$ref":"#/components/schemas/ExternalProcessingDateExternalProviderReferenceExternalMerchantReference2"},"Amount":{"type":"integer","description":"The amount of the Refund, required for a partial refund. The Refund `Amount` must equal the sum of the `Amount` values refunded for all line items."},"Currency":{"type":"string","description":"The currency of the intent."},"PlatformFeesAmount":{"type":"integer","description":"The amount of fees to be diverted to the platform's Fees Wallet when the Intent is split. This value can be overridden when the Split is created.\n\nThe `PlatformFeesAmount` value must the sum of all line item `Seller.FeesAmount` values."},"LineItems":{"type":"array","items":{"$ref":"#/components/schemas/CreateAnIntentRefundRequestLineItemsItems"},"description":"Information about the amount refunded for each line item, required for a partial refund."},"Tag":{"$ref":"#/components/schemas/Tag"}},"title":"CreateAnIntentRefundRequest"},"Id_IntentRefund":{"type":"object","properties":{"Id":{"type":"string","description":"The unique identifier of the Refund."}},"description":"Information about the Refund.","title":"Id_IntentRefund"},"IntentRefundResponse":{"type":"object","properties":{"Id":{"type":"string","description":"The unique identifier of the intent."},"Amount":{"type":"integer","description":"The full amount authorized in the Intent, which must equal the sum of the total amounts of all `LineItems`."},"AvailableAmountToSplit":{"type":"integer","description":"The remaining amount of the Intent that can be split and transferred to the sellers' wallets."},"UnfundedAmount":{"type":"integer","description":"The amount needing to be settled to the Platform's technical wallet before the Intent Splits can be executed."},"Currency":{"type":"string","description":"The currency of the intent."},"PlatformFeesAmount":{"type":"integer","description":"The amount of fees to be diverted to the platform's Fees Wallet when the Intent is split. This value can be overridden when the Split is created.\n\nThe `PlatformFeesAmount` value must the sum of all line item `Seller.FeesAmount` values."},"Status":{"type":"string","description":"The status of the Intent, as declared by the platform through Intent Captures, Refunds (and reversals), or Disputes (and decisions). Where partial actions occur, the top-level Intent `Status` may differ from the `Status` of Intent `LineItems`.\n\nIntent `Status` values:\n- `AUTHORIZED` – The Intent `Amount` was authorized for acquisition by the PSP and can be captured or canceled.\n- `PARTIALLY_CAPTURED` – Part of the Intent `Amount` from one or more `LineItems` was captured. The other parts are either still available for capture or cancel.\n- `CAPTURED` – All of the Intent `Amount` was captured. Part of it may have been subsequently refunded or disputed.\n- `CANCELLED` – All of the Intent `Amount` was canceled.\n- `REFUNDED` – All of the `CapturedAmount` of all `LineItems` was refunded.\n- `REFUND_REVERSED` – The refund could not be completed and the funds were returned to the platform.\n- `DISPUTED` – All of the `CapturedAmount` of all `LineItems` was disputed.\n- `DEFENDED` – The dispute is being defended by the platform.\n- `DISPUTED_WON` – The dispute was resolved in favor of the platform.\n- `DISPUTED_LOST` – The dispute was resolved against the platform."},"NextActions":{"type":"string","description":"The possible next actions on the intent."},"ExternalData":{"$ref":"#/components/schemas/ExternalProcessingDateExternalProviderReferenceExternalMerchantReference"},"Buyer":{"$ref":"#/components/schemas/BuyerId"},"LineItems":{"type":"array","items":{"$ref":"#/components/schemas/IdTotalLineItemAmountCapturedAmount"},"description":"Information about the line items included in the intent action."},"CreationDate":{"$ref":"#/components/schemas/CreationDate"},"ExecutionDate":{"type":"integer","description":"Unix timestamp (UTC) of the date and time the Intent moved to `AUTHORIZED`."},"Refund":{"$ref":"#/components/schemas/Id_IntentRefund"}},"title":"IntentRefundResponse"},"CreateAnIntentDisputeRequestLineItemsItems":{"type":"object","properties":{"Id":{"type":"string","description":"The unique identifier of the line item in Mangopay ecosystem."}},"required":["Id"],"title":"CreateAnIntentDisputeRequestLineItemsItems"},"CreateAnIntentDisputeRequest":{"type":"object","properties":{"ExternalData":{"$ref":"#/components/schemas/ExternalProcessingDateExternalProviderReferenceExternalMerchantReference2"},"Amount":{"type":"integer","description":"The amount of the Dispute, required for a partial dispute. The Dispute `Amount` must equal the sum of the `Amount` values disputed for all line items."},"Currency":{"type":"string","description":"The currency of the intent."},"PlatformFeesAmount":{"type":"integer","description":"The amount of fees to be diverted to the platform's Fees Wallet when the Intent is split. This value can be overridden when the Split is created.\n\nThe `PlatformFeesAmount` value must the sum of all line item `Seller.FeesAmount` values."},"LineItems":{"type":"array","items":{"$ref":"#/components/schemas/CreateAnIntentDisputeRequestLineItemsItems"},"description":"Information about the amount disputed for each line item, required for a partial dispute."},"Tag":{"$ref":"#/components/schemas/Tag"}},"required":["ExternalData","Amount","LineItems"],"title":"CreateAnIntentDisputeRequest"},"Id_IntentDispute":{"type":"object","properties":{"Id":{"type":"string","description":"The unique identifier of the Dispute."}},"description":"Information about the Dispute.","title":"Id_IntentDispute"},"IntentDisputeResponse":{"type":"object","properties":{"Id":{"type":"string","description":"The unique identifier of the intent."},"Amount":{"type":"integer","description":"The full amount authorized in the Intent, which must equal the sum of the total amounts of all `LineItems`."},"AvailableAmountToSplit":{"type":"integer","description":"The remaining amount of the Intent that can be split and transferred to the sellers' wallets."},"UnfundedAmount":{"type":"integer","description":"The amount needing to be settled to the Platform's technical wallet before the Intent Splits can be executed."},"Currency":{"type":"string","description":"The currency of the intent."},"PlatformFeesAmount":{"type":"integer","description":"The amount of fees to be diverted to the platform's Fees Wallet when the Intent is split. This value can be overridden when the Split is created.\n\nThe `PlatformFeesAmount` value must the sum of all line item `Seller.FeesAmount` values."},"Status":{"type":"string","description":"The status of the Intent, as declared by the platform through Intent Captures, Refunds (and reversals), or Disputes (and decisions). Where partial actions occur, the top-level Intent `Status` may differ from the `Status` of Intent `LineItems`.\n\nIntent `Status` values:\n- `AUTHORIZED` – The Intent `Amount` was authorized for acquisition by the PSP and can be captured or canceled.\n- `PARTIALLY_CAPTURED` – Part of the Intent `Amount` from one or more `LineItems` was captured. The other parts are either still available for capture or cancel.\n- `CAPTURED` – All of the Intent `Amount` was captured. Part of it may have been subsequently refunded or disputed.\n- `CANCELLED` – All of the Intent `Amount` was canceled.\n- `REFUNDED` – All of the `CapturedAmount` of all `LineItems` was refunded.\n- `REFUND_REVERSED` – The refund could not be completed and the funds were returned to the platform.\n- `DISPUTED` – All of the `CapturedAmount` of all `LineItems` was disputed.\n- `DEFENDED` – The dispute is being defended by the platform.\n- `DISPUTED_WON` – The dispute was resolved in favor of the platform.\n- `DISPUTED_LOST` – The dispute was resolved against the platform."},"NextActions":{"type":"string","description":"The possible next actions on the intent."},"ExternalData":{"$ref":"#/components/schemas/ExternalProcessingDateExternalProviderReferenceExternalMerchantReference"},"Buyer":{"$ref":"#/components/schemas/BuyerId"},"LineItems":{"type":"array","items":{"$ref":"#/components/schemas/IdTotalLineItemAmountCapturedAmount"},"description":"Information about the line items included in the intent action."},"CreationDate":{"$ref":"#/components/schemas/CreationDate"},"ExecutionDate":{"type":"integer","description":"Unix timestamp (UTC) of the date and time the Intent moved to `AUTHORIZED`."},"Dispute":{"$ref":"#/components/schemas/Id_IntentDispute"}},"title":"IntentDisputeResponse"},"UpdateAnIntentDisputeRequest":{"type":"object","properties":{"Decision":{"type":"string","description":"**Allowed values:** `DEFENDED`, `DISPUTED_WON`, `DISPUTED_LOST`\n\nThe outcome of the Dispute, which can be declared as one of the following values:\n- `DEFENDED`\n- `DISPUTED_WON`\n- `DISPUTED_LOST`"}},"required":["Decision"],"title":"UpdateAnIntentDisputeRequest"},"UpdateAnIntentDisputeResponse":{"type":"object","properties":{"Id":{"type":"string","description":"The unique identifier of the intent."},"Amount":{"type":"integer","description":"The full amount authorized in the Intent, which must equal the sum of the total amounts of all `LineItems`."},"AvailableAmountToSplit":{"type":"integer","description":"The remaining amount of the Intent that can be split and transferred to the sellers' wallets."},"UnfundedAmount":{"type":"integer","description":"The amount needing to be settled to the Platform's technical wallet before the Intent Splits can be executed."},"Currency":{"type":"string","description":"The currency of the intent."},"PlatformFeesAmount":{"type":"integer","description":"The amount of fees to be diverted to the platform's Fees Wallet when the Intent is split. This value can be overridden when the Split is created.\n\nThe `PlatformFeesAmount` value must the sum of all line item `Seller.FeesAmount` values."},"Status":{"type":"string","description":"The status of the Intent, as declared by the platform through Intent Captures, Refunds (and reversals), or Disputes (and decisions). Where partial actions occur, the top-level Intent `Status` may differ from the `Status` of Intent `LineItems`.\n\nIntent `Status` values:\n- `AUTHORIZED` – The Intent `Amount` was authorized for acquisition by the PSP and can be captured or canceled.\n- `PARTIALLY_CAPTURED` – Part of the Intent `Amount` from one or more `LineItems` was captured. The other parts are either still available for capture or cancel.\n- `CAPTURED` – All of the Intent `Amount` was captured. Part of it may have been subsequently refunded or disputed.\n- `CANCELLED` – All of the Intent `Amount` was canceled.\n- `REFUNDED` – All of the `CapturedAmount` of all `LineItems` was refunded.\n- `REFUND_REVERSED` – The refund could not be completed and the funds were returned to the platform.\n- `DISPUTED` – All of the `CapturedAmount` of all `LineItems` was disputed.\n- `DEFENDED` – The dispute is being defended by the platform.\n- `DISPUTED_WON` – The dispute was resolved in favor of the platform.\n- `DISPUTED_LOST` – The dispute was resolved against the platform."},"NextActions":{"type":"string","description":"The possible next actions on the intent."},"ExternalData":{"$ref":"#/components/schemas/ExternalProcessingDateExternalProviderReferenceExternalMerchantReference"},"Buyer":{"$ref":"#/components/schemas/BuyerId"},"LineItems":{"type":"array","items":{"$ref":"#/components/schemas/IdTotalLineItemAmountCapturedAmount"},"description":"Information about the line items included in the intent action."},"CreationDate":{"$ref":"#/components/schemas/CreationDate"},"ExecutionDate":{"type":"integer","description":"Unix timestamp (UTC) of the date and time the Intent moved to `AUTHORIZED`."},"Dispute":{"$ref":"#/components/schemas/Id_IntentDispute"},"Decision":{"type":"string","description":"The outcome of the Dispute, which can be declared as one of the following values:\n- `DEFENDED`\n- `DISPUTED_WON`\n- `DISPUTED_LOST`"}},"title":"UpdateAnIntentDisputeResponse"},"ViewAnIntentResponseCapturesItemsLineItemsItems":{"type":"object","properties":{"Id":{"type":"string","description":"The unique identifier of the line item."},"Amount":{"type":"integer","description":"The amount of the line item."}},"title":"ViewAnIntentResponseCapturesItemsLineItemsItems"},"ViewAnIntentResponseCapturesItems":{"type":"object","properties":{"Id":{"type":"string","description":"The unique identifier of the Capture."},"Amount":{"type":"integer","description":"The amount of the Capture."},"Status":{"type":"string","description":"The status of the Intent Capture:\n- `CAPTURED` – The funds have been acquired by the third-party PSP and are expected on the technical wallet.\n- `SETTLED_NOT_PAID` – The transaction was included in a settlement file successfully uploaded by the platform using the [POST Create a Settlement](/api-reference/settlements/create-settlement) endpoint.\n- `PAID` – The funds were received on the platform's technical wallet."},"LineItems":{"type":"array","items":{"$ref":"#/components/schemas/ViewAnIntentResponseCapturesItemsLineItemsItems"},"description":"Information about the line items in the Capture."},"CreationDate":{"type":"integer","description":"Unix timestamp (UTC) of the date and time the Capture was created."},"ExecutionDate":{"type":"integer","description":"The date at which the object was successfully moved to `CAPTURED`."},"Tag":{"$ref":"#/components/schemas/Tag"}},"title":"ViewAnIntentResponseCapturesItems"},"ViewAnIntentResponseRefundsItemsLineItemsItems":{"type":"object","properties":{"Id":{"type":"string","description":"The unique identifier of the line item."},"Amount":{"type":"integer","description":"The amount of the line item."}},"title":"ViewAnIntentResponseRefundsItemsLineItemsItems"},"ViewAnIntentResponseRefundsItems":{"type":"object","properties":{"Id":{"type":"string","description":"The unique identifier of the Refund."},"Amount":{"type":"integer","description":"The amount of the Refund."},"Status":{"type":"string","description":"The status of the Intent Refund:\n- `REFUNDED` – The funds were subject to a refund are not expected on the technical wallet.\n- `REFUND_REVERSED` – The refund could not be completed: the funds were returned to the platform and are expected on the technical wallet."},"LineItems":{"type":"array","items":{"$ref":"#/components/schemas/ViewAnIntentResponseRefundsItemsLineItemsItems"},"description":"Information about the line items in the Refund."},"CreationDate":{"type":"integer","description":"Unix timestamp (UTC) of the date and time the Refund was created."},"ExecutionDate":{"type":"integer","description":"The date at which the object was successfully moved to `REFUNDED`."},"Tag":{"$ref":"#/components/schemas/Tag"}},"title":"ViewAnIntentResponseRefundsItems"},"ViewAnIntentResponseDisputesItemsLineItemsItems":{"type":"object","properties":{"Id":{"type":"string","description":"The unique identifier of the line item."},"Amount":{"type":"integer","description":"The amount of the line item."}},"title":"ViewAnIntentResponseDisputesItemsLineItemsItems"},"ViewAnIntentResponseDisputesItems":{"type":"object","properties":{"Id":{"type":"string","description":"The unique identifier of the Dispute."},"Amount":{"type":"integer","description":"The amount of the Dispute."},"Status":{"type":"string","description":"The status of the Intent Dispute:\n- `NEEDS_RESPONSE` – The outcome of the dispute has not been declared by the platform.\n- `DEFENDED` – The dispute is being defended and the funds may have been returned to the platform temporarily, but they are not expected on the technical wallet.\n- `DISPUTED_WON` – The dispute was resolved in favor of the platform and the funds are expected on the technical wallet.\n- `DISPUTED_LOST` – The dispute was ruled against the platform and the funds were returned to the user."},"LineItems":{"type":"array","items":{"$ref":"#/components/schemas/ViewAnIntentResponseDisputesItemsLineItemsItems"},"description":"Information about the line items in the Dispute."},"CreationDate":{"type":"integer","description":"Unix timestamp (UTC) of the date and time the Dispute was created."},"ExecutionDate":{"type":"integer","description":"The date at which the object was successfully moved to `DISPUTED`."},"Tag":{"$ref":"#/components/schemas/Tag"}},"title":"ViewAnIntentResponseDisputesItems"},"ViewAnIntentResponseCancelsItemsLineItemsItems":{"type":"object","properties":{"Id":{"type":"string","description":"The unique identifier of the line item."},"Amount":{"type":"integer","description":"The amount of the line item."}},"title":"ViewAnIntentResponseCancelsItemsLineItemsItems"},"ViewAnIntentResponseCancelsItems":{"type":"object","properties":{"Id":{"type":"string","description":"The unique identifier of the Cancel."},"Amount":{"type":"integer","description":"The amount of the Cancel."},"Status":{"type":"string","description":"The status of the Intent Cancel:\n- `CANCELLED` – The transaction authorized was canceled and its funds are not expected on the platform's technical wallet."},"LineItems":{"type":"array","items":{"$ref":"#/components/schemas/ViewAnIntentResponseCancelsItemsLineItemsItems"},"description":"Information about the line items in the Capture."},"CreationDate":{"type":"integer","description":"Unix timestamp (UTC) of the date and time the Cancel was created."},"ExecutionDate":{"type":"integer","description":"The date at which the object was successfully moved to `CANCELLED`."}},"title":"ViewAnIntentResponseCancelsItems"},"ViewAnIntentResponseSplitsItemsLineItemsItems":{"type":"object","properties":{"Id":{"type":"string","description":"The unique identifier of the line item."},"Amount":{"type":"integer","description":"The amount of the line item."}},"title":"ViewAnIntentResponseSplitsItemsLineItemsItems"},"ViewAnIntentResponseSplitsItems":{"type":"object","properties":{"Id":{"type":"string","description":"The unique identifier of the Split."},"Amount":{"type":"integer","description":"The amount of the Split."},"Status":{"type":"string","description":"The status of the Split:\n- `CREATED` – The Split was successfully declared via the API but it is not yet confirmed whether the funds for the parent Intent are available.\n- `PENDING_FUNDS_RECEPTION` – The Split is linked to an Intent that has been reconciled with a settlement file. The system is waiting for the funds to be confirmed in the technical wallet.\n- `AVAILABLE` – The funds for the parent Intent have been received and confirmed. The Split is ready to be executed.\n- `PENDING` – The Split execution has been initiated and is being processed.\n- `COMPLETED` – The transfer was successful and the funds have been moved to the seller's wallet.\n- `REJECTED` – The Split execution failed immediately due to a synchronous error (e.g. invalid wallet ID). The platform can retry execution or reverse the Split.\n- `FAILED` – The Split execution was initiated but the transfer failed due to an asynchronous error (e.g. insufficient funds in the source wallet). A new Split must be created to retry.\n- `REVERSED` – The Split was canceled by the platform while in `AVAILABLE` or `REJECTED` status.\n- `REFUND_SPLIT_PENDING` – A refund has been declared on the parent Intent and the refund of this Split is pending.\n- `REFUND_SPLIT_REJECTED` – The refund of this Split was rejected.\n- `REFUND_SPLIT_COMPLETED` – The refund of this Split was completed successfully."},"LineItems":{"type":"array","items":{"$ref":"#/components/schemas/ViewAnIntentResponseSplitsItemsLineItemsItems"},"description":"Information about the line items in the Split."},"CreationDate":{"type":"integer","description":"Unix timestamp (UTC) of the date and time the Split was created."},"ExecutionDate":{"type":"integer","description":"The date at which the Split status became `COMPLETED`."}},"title":"ViewAnIntentResponseSplitsItems"},"ViewAnIntentResponse":{"type":"object","properties":{"Id":{"type":"string","description":"The unique identifier of the intent."},"Amount":{"type":"integer","description":"The full amount authorized in the Intent, which must equal the sum of the total amounts of all `LineItems`."},"AvailableAmountToSplit":{"type":"integer","description":"The remaining amount of the Intent that can be split and transferred to the sellers' wallets."},"UnfundedAmount":{"type":"integer","description":"The amount needing to be settled to the Platform's technical wallet before the Intent Splits can be executed."},"Currency":{"type":"string","description":"The currency of the intent."},"PlatformFeesAmount":{"type":"integer","description":"The amount of fees to be diverted to the platform's Fees Wallet when the Intent is split. This value can be overridden when the Split is created.\n\nThe `PlatformFeesAmount` value must the sum of all line item `Seller.FeesAmount` values."},"Status":{"type":"string","description":"The status of the Intent, as declared by the platform through Intent Captures, Refunds (and reversals), or Disputes (and decisions). Where partial actions occur, the top-level Intent `Status` may differ from the `Status` of Intent `LineItems`.\n\nIntent `Status` values:\n- `AUTHORIZED` – The Intent `Amount` was authorized for acquisition by the PSP and can be captured or canceled.\n- `PARTIALLY_CAPTURED` – Part of the Intent `Amount` from one or more `LineItems` was captured. The other parts are either still available for capture or cancel.\n- `CAPTURED` – All of the Intent `Amount` was captured. Part of it may have been subsequently refunded or disputed.\n- `CANCELLED` – All of the Intent `Amount` was canceled.\n- `REFUNDED` – All of the `CapturedAmount` of all `LineItems` was refunded.\n- `REFUND_REVERSED` – The refund could not be completed and the funds were returned to the platform.\n- `DISPUTED` – All of the `CapturedAmount` of all `LineItems` was disputed.\n- `DEFENDED` – The dispute is being defended by the platform.\n- `DISPUTED_WON` – The dispute was resolved in favor of the platform.\n- `DISPUTED_LOST` – The dispute was resolved against the platform."},"NextActions":{"type":"string","description":"The possible next actions on the intent."},"ExternalData":{"$ref":"#/components/schemas/ExternalProcessingDateExternalProviderReferenceExternalMerchantReference"},"Buyer":{"$ref":"#/components/schemas/BuyerId"},"LineItems":{"type":"array","items":{"$ref":"#/components/schemas/LineItems_Intent"},"description":"Information about the items purchased in the transaction. A maximum of 100 line items can be created per Intent.\n\nThe sum of all line item amounts must equal the Intent `Amount` value. The total for each line items is calculated as ((`UnitAmount` x `Quantity`) - `DiscountAmount`), which is shown in the `TotalLineItemAmount` returned. The `TaxAmount` is indicative and included in the `UnitAmount`. \n\nThe sum of all line item `Seller.FeesAmount` values must equal the Intent `PlatformFeesAmount` value."},"Captures":{"type":"array","items":{"$ref":"#/components/schemas/ViewAnIntentResponseCapturesItems"},"description":"Information about the amounts captured against the Intent."},"Refunds":{"type":"array","items":{"$ref":"#/components/schemas/ViewAnIntentResponseRefundsItems"},"description":"Information about the Refunds created against the Intent."},"Disputes":{"type":"array","items":{"$ref":"#/components/schemas/ViewAnIntentResponseDisputesItems"},"description":"Information about the Disputes created against against the Intent."},"Cancels":{"type":"array","items":{"$ref":"#/components/schemas/ViewAnIntentResponseCancelsItems"},"description":"Information about the amounts Canceled in the Intent."},"Splits":{"type":"array","items":{"$ref":"#/components/schemas/ViewAnIntentResponseSplitsItems"},"description":"Information about the Splits created against the Intent."},"CreationDate":{"$ref":"#/components/schemas/CreationDate"},"ExecutionDate":{"type":"integer","description":"Unix timestamp (UTC) of the date and time the Intent moved to `AUTHORIZED`."},"Tag":{"$ref":"#/components/schemas/Tag"},"SettlementIds":{"type":"array","items":{"type":"string"},"description":"The unique identifier of the Settlement(s) linked to this Intent, if successfully created by uploading a settlement file to [POST Create a Settlement](/api-reference/settlements/create-settlement)."}},"title":"ViewAnIntentResponse"},"ListAllIntentsResponseItemsExternalData":{"type":"object","properties":{"ExternalProcessingDate":{"type":"integer","description":"The date the PSP processed the transaction."},"ExternalProviderReference":{"type":"string","description":"The unique reference of the transaction from the PSP."},"ExternalProviderName":{"type":"string","description":"The supported third-party PSP processing the transaction."},"ExternalProviderPaymentMethod":{"type":"string","description":"The payment method used for the transaction."}},"title":"ListAllIntentsResponseItemsExternalData"},"ListAllIntentsResponseItems":{"type":"object","properties":{"Id":{"type":"string","description":"The unique identifier of the intent."},"Amount":{"type":"integer","description":"The full amount authorized in the Intent."},"Currency":{"type":"string","description":"The currency of the intent."},"Status":{"type":"string","description":"The status of the Intent.\n\nIntent `Status` values:\n- `AUTHORIZED` – The Intent `Amount` was authorized for acquisition by the PSP and can be captured or canceled.\n- `PARTIALLY_CAPTURED` – Part of the Intent `Amount` from one or more `LineItems` was captured.\n- `CAPTURED` – All of the Intent `Amount` was captured.\n- `CANCELLED` – All of the Intent `Amount` was canceled.\n- `REFUNDED` – All of the `CapturedAmount` of all `LineItems` was refunded.\n- `REFUND_REVERSED` – The refund could not be completed and the funds were returned to the platform.\n- `DISPUTED` – All of the `CapturedAmount` of all `LineItems` was disputed.\n- `DEFENDED` – The dispute is being defended by the platform.\n- `DISPUTED_WON` – The dispute was resolved in favor of the platform.\n- `DISPUTED_LOST` – The dispute was resolved against the platform."},"ExternalData":{"$ref":"#/components/schemas/ListAllIntentsResponseItemsExternalData"},"CreationDate":{"type":"integer","description":"The date and time the Intent was created."},"ExecutionDate":{"type":["integer","null"],"description":"Unix timestamp (UTC) of the date and time the Intent moved to `AUTHORIZED`."}},"title":"ListAllIntentsResponseItems"},"ListAllIntentsResponse":{"type":"array","items":{"$ref":"#/components/schemas/ListAllIntentsResponseItems"},"title":"ListAllIntentsResponse"},"CreateAnIntentSplitRequestSplitsItems":{"type":"object","properties":{"LineItemId":{"type":"string","description":"The unique identifier of the line item."},"SplitAmount":{"type":"integer","description":"The amount to transfer to the seller's `WalledId`.\n\nThe sum of the `SplitAmount` values of all `Splits` must be lower than or equal to the `AvailableAmountToSplit` of the Intent."},"FeesAmount":{"type":"integer","description":"The amount of fees.\n\nThe sum of the `FeesAmount` values of all `Splits` must be lower than or equal to the `PlatformFeesAmount` of the Intent."},"TransferDate":{"type":"integer","description":"The future date when the funds are to be automatically transferred to the seller's wallet."},"Description":{"type":"string","description":"The description of the Split."},"SplitOriginWalletId":{"type":"string","description":"The unique identifier of the wallet from which the split will be debited.\n\nThis parameter is required for Intents where `ExternalProviderName` is `Mangopay`. If it is not defined in the Intent it must be defined at Split creation."},"Tag":{"$ref":"#/components/schemas/Tag"}},"required":["LineItemId","SplitAmount"],"title":"CreateAnIntentSplitRequestSplitsItems"},"CreateAnIntentSplitRequest":{"type":"object","properties":{"Splits":{"type":"array","items":{"$ref":"#/components/schemas/CreateAnIntentSplitRequestSplitsItems"},"description":"The future Splits to create to transfer Intent funds to the line item sellers."}},"title":"CreateAnIntentSplitRequest"},"IntentSplitsResponseSplitsItems":{"type":"object","properties":{"Id":{"type":"string","description":"The unique identifier of the Split."},"LineItemId":{"type":"string","description":"The unique identifier of the line item."},"SellerId":{"type":"string","description":"The unique identifier of the seller of the line item."},"WalletId":{"type":"string","description":"The unique identifier of the wallet to credit the seller's funds."},"SplitAmount":{"type":"integer","description":"The amount to transfer to the seller's `WalledId`.\n\nThe sum of the `SplitAmount` values of all `Splits` must be lower than or equal to the `AvailableAmountToSplit` of the Intent."},"FeesAmount":{"type":"integer","description":"The amount of fees.\n\nThe sum of the `FeesAmount` values of all `Splits` must be lower than or equal to the `PlatformFeesAmount` of the Intent."},"TransferDate":{"type":"integer","description":"The future date when the funds are to be automatically transferred to the seller's wallet."},"Description":{"type":"string","description":"The description of the Split."},"Status":{"type":"string","description":"The status of the Split:\n- `CREATED`\n- `PENDING_FUNDS_RECEPTION`\n- `AVAILABLE`\n- `PENDING`\n- `COMPLETED`\n- `REJECTED`\n- `FAILED`\n- `REVERSED`\n- `REFUND_SPLIT_PENDING`\n- `REFUND_SPLIT_REJECTED`\n- `REFUND_SPLIT_COMPLETED`"},"SplitOriginWalletId":{"type":"string","description":"The unique identifier of the wallet from which the split will be debited.\n\nThis parameter is required for Intents where `ExternalProviderName` is `Mangopay`. If it is not defined in the Intent it must be defined at Split creation."},"Tag":{"$ref":"#/components/schemas/Tag"}},"title":"IntentSplitsResponseSplitsItems"},"IntentSplitsResponse":{"type":"object","properties":{"Splits":{"type":"array","items":{"$ref":"#/components/schemas/IntentSplitsResponseSplitsItems"},"description":"The Splits requested."}},"title":"IntentSplitsResponse"},"IntentSplitResponse":{"type":"object","properties":{"Id":{"type":"string","description":"The unique identifier of the Split."},"LineItemId":{"type":"string","description":"The unique identifier of the line item."},"SellerId":{"type":"string","description":"The unique identifier of the seller of the line item."},"WalletId":{"type":"string","description":"The unique identifier of the wallet to credit the seller's funds."},"SplitAmount":{"type":"integer","description":"The amount to transfer to the seller's `WalledId`.\n\nThe sum of the `SplitAmount` values of all `Splits` must be lower than or equal to the `AvailableAmountToSplit` of the Intent."},"FeesAmount":{"type":"integer","description":"The amount of fees.\n\nThe sum of the `FeesAmount` values of all `Splits` must be lower than or equal to the `PlatformFeesAmount` of the Intent."},"TransferDate":{"type":"integer","description":"The future date when the funds are to be automatically transferred to the seller's wallet."},"Description":{"type":"string","description":"The description of the Split."},"Status":{"type":"string","description":"The status of the Split:\n- `CREATED` – The Split was successfully declared via the API but it is not yet confirmed whether the funds for the parent Intent are available.\n- `PENDING_FUNDS_RECEPTION` – The Split is linked to an Intent that has been reconciled with a settlement file. The system is waiting for the funds to be confirmed in the technical wallet.\n- `AVAILABLE` – The funds for the parent Intent have been received and confirmed. The Split is ready to be executed.\n- `PENDING` – The Split execution has been initiated and is being processed.\n- `COMPLETED` – The transfer was successful and the funds have been moved to the seller's wallet.\n- `REJECTED` – The Split execution failed immediately due to a synchronous error (e.g. invalid wallet ID). The platform can retry execution or reverse the Split.\n- `FAILED` – The Split execution was initiated but the transfer failed due to an asynchronous error (e.g. insufficient funds in the source wallet). A new Split must be created to retry.\n- `REVERSED` – The Split was canceled by the platform while in `AVAILABLE` or `REJECTED` status.\n- `REFUND_SPLIT_PENDING` – A refund has been declared on the parent Intent and the refund of this Split is pending.\n- `REFUND_SPLIT_REJECTED` – The refund of this Split was rejected.\n- `REFUND_SPLIT_COMPLETED` – The refund of this Split was completed successfully."},"Tag":{"$ref":"#/components/schemas/Tag"}},"title":"IntentSplitResponse"},"ListAllSplitsResponseItems":{"type":"object","properties":{"Id":{"type":"string","description":"The unique identifier of the Split."},"IntentId":{"type":"string","description":"The unique identifier of the parent Intent."},"LineItemId":{"type":"string","description":"The unique identifier of the line item."},"SellerId":{"type":"string","description":"The unique identifier of the seller of the line item."},"WalletId":{"type":"string","description":"The unique identifier of the wallet to credit the seller's funds."},"SplitAmount":{"type":"integer","description":"The amount to transfer to the seller's wallet."},"FeesAmount":{"type":"integer","description":"The amount of fees."},"TransferDate":{"type":"integer","description":"The future date when the funds are to be automatically transferred to the seller's wallet."},"Description":{"type":"string","description":"The description of the Split."},"Status":{"type":"string","description":"The status of the Split:\n- `CREATED` – The Split was successfully declared via the API but it is not yet confirmed whether the funds for the parent Intent are available.\n- `PENDING_FUNDS_RECEPTION` – The Split is linked to an Intent that has been reconciled with a settlement file. The system is waiting for the funds to be confirmed in the technical wallet.\n- `AVAILABLE` – The funds for the parent Intent have been received and confirmed. The Split is ready to be executed.\n- `PENDING` – The Split execution has been initiated and is being processed.\n- `COMPLETED` – The transfer was successful and the funds have been moved to the seller's wallet.\n- `REJECTED` – The Split execution failed immediately due to a synchronous error (e.g. invalid wallet ID). The platform can retry execution or reverse the Split.\n- `FAILED` – The Split execution was initiated but the transfer failed due to an asynchronous error (e.g. insufficient funds in the source wallet). A new Split must be created to retry.\n- `REVERSED` – The Split was canceled by the platform while in `AVAILABLE` or `REJECTED` status.\n- `REFUND_SPLIT_PENDING` – A refund has been declared on the parent Intent and the refund of this Split is pending.\n- `REFUND_SPLIT_REJECTED` – The refund of this Split was rejected.\n- `REFUND_SPLIT_COMPLETED` – The refund of this Split was completed successfully."}},"title":"ListAllSplitsResponseItems"},"ListAllSplitsResponse":{"type":"array","items":{"$ref":"#/components/schemas/ListAllSplitsResponseItems"},"title":"ListAllSplitsResponse"},"CreateASettlementAndGenerateASecureURLForFileUploadRequest":{"type":"object","properties":{"FileName":{"type":"string","description":"The name of your file, which can be anything you wish. The file extension must be `.csv`."}},"required":["FileName"],"title":"CreateASettlementAndGenerateASecureURLForFileUploadRequest"},"SettlementFileUploadResponse":{"type":"object","properties":{"UploadUrl":{"type":"string","description":"The unique temporary pre-signed URL to which to upload your CSV file. Use the full dynamic URL including the host, path, and all query parameters. The URL is already authenticated, so the call does not require an Authorization header. See [PUT Upload a settlement file to the secure URL](/api-reference/settlements/upload-settlement-file) for details"},"SettlementId":{"type":"string","description":"The unique identifier of the Settlement."}},"title":"SettlementFileUploadResponse"},"settlements_upload_settlement_file_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"settlements_upload_settlement_file_Response_200"},"SettlementResponse":{"type":"object","properties":{"SettlementId":{"type":"string","description":"The unique identifier of the Settlement."},"Status":{"type":"string","description":"The status of the Settlement:\n- `PENDING_UPLOAD` – Settlement object and `SettlementFileUploadUrl` generated.\n- `UPLOADED` – A file was uploaded.\n- `CREATED` – The uploaded file was considered valid and reconciliation is in progress. A file is considered valid when it includes all required columns and a properly formatted footer.\n- `UNMATCHED` – None of the entries in the settlement file match the declared intents.\n- `PARTIALLY_MATCHED` – Settlement file parsed and some lines matched successfully. If at least one line is incorrectly formatted, the file remains in this status and does not progress further. Cancel the Settlement and re-submit.\n- `PENDING_FUNDS_RECEPTION` – Settlement file parsed and fully matched with Intents; waiting for funds to arrive on the technical wallet.\n- `INSUFFICIENT_FUNDS` – Partial amount received: `FundsMissingAmount` shows the shortfall.\n- `RECONCILED` – Full settlement amount (`ActualSettlementAmount`) received on the technical wallet.\n- `FAILED` – Settlement file rejected due to a technical error (e.g. format, timeout).\n- `CANCELLED` – Settlement file invalidated due to a reconciliation error. Once canceled, no further actions can be taken on this Settlement.\n\nIf status becomes `FAILED` or `CANCELLED`, then call [POST Create a Settlement and secure URL for file upload](/api-reference/settlements/create-settlement) to create a new object. If the status becomes `UNMATCHED` or remains in `PARTIALLY_MATCHED` unexpectedly, then call [PUT Update a Settlement and generate a new upload URL](/api-reference/settlements/update-settlement) only a new URL is required for the existing `SettlementId`."},"CreationDate":{"type":"integer","description":"The date and time the Settlement was created."},"SettlementDate":{"type":"integer","description":"The creation date of the settlement from the provider."},"ExternalProviderName":{"type":"string","description":"The [supported third-party PSP](/api-reference/echo/supported-providers) processing the transaction.\n\n**Note:** The uppercase value is expected. The API returns the sentence-case value."},"DeclaredIntentAmount":{"type":"integer","description":"The total amount declared through Intent API calls, using the following calculation:\n\n(Sum of captured intents) - (Sum of refunded amounts) + (Sum of refund reversed amounts) - (Sum of `DISPUTED` disputes) + (Sum of `DISPUTED_WON` disputes)"},"ExternalProcessorFeesAmount":{"type":"integer","description":"The total fees charged by the external provider"},"ActualSettlementAmount":{"type":"integer","description":"The total amount due to the platform, to be held in the technical wallet. This amount corresponds to the `TotalNetSettlementAmount` of the settlement file.\n\nA negative amount results in this parameter being set to zero, indicating no incoming funds to the technical wallet."},"FundsMissingAmount":{"type":"integer","description":"The difference between `ActualSettlementAmount` and the amount received on the technical wallet"},"FileName":{"type":"string","description":"The `FileName` submitted to the [POST Create a Settlement and generate upload URL](/api-reference/settlements/create-settlement) endpoint, with a timestamp of the Settlement creation date automatically appended by Mangopay."}},"title":"SettlementResponse"},"ViewValidationErrorsForASettlementResponseFooterErrorsItems":{"type":"object","properties":{"FooterName":{"type":"string","description":"The footer line which produced the error."},"Code":{"type":"string","description":"**Returned values:** `TOTAL_NET_MISCALCULATED`, `FEES_TOTAL_MISMATCH`, `FORMAT_DATE_INVALID`, `PROVIDER_NAME_MISSING`, `CURRENCY_MISMATCH`\n\nThe type of error encountered.\n- `TOTAL_NET_MISCALCULATED` – Arithmetic check failed. The calculated net amount does not match the file's stated amount. `FooterName`: `TotalNetSettlementAmount`.\n- `FEES_TOTAL_MISMATCH` – The footer value does not equal the sum of all `ExternalProviderFees` found in the transaction lines. `FooterName`: `TotalSettlementFeesAmount`.\n- `FORMAT_DATE_INVALID` – Date format is invalid or empty. Expected: DD-MM-YYYY. `FooterName`: `SettlementDate`.\n- `PROVIDER_NAME_MISSING` – The mandatory `ExternalProviderName` field is empty. `FooterName`: `ExternalProviderName`.\n- `CURRENCY_MISMATCH` – Currency code provided is not a valid ISO 4217 code or does not match line item currencies. `FooterName`: `SettlementCurrency`."},"Description":{"type":"string","description":"A description of the error."}},"title":"ViewValidationErrorsForASettlementResponseFooterErrorsItems"},"ViewValidationErrorsForASettlementResponseLinesErrorsItemsDetailsItems":{"type":"object","properties":{"Code":{"type":"string","description":"**Returned values:** `MATCH_REF_NOT_FOUND`, `INTENT_WRONG_STATUS`, `AMOUNT_MISMATCH`, `MANDATORY_MISSING`, `FORMAT_DATE_INVALID`\n\nThe type of error encountered.\n- `MATCH_REF_NOT_FOUND` – `ExternalProviderReference` not found for any existing Intent in the system, possibly triggered by an intent not created in Echo, a reference mismatch, or a wrong environment.\n- `INTENT_WRONG_STATUS` – Intent associated with this transaction is not in a reconcilable state (e.g., `AUTHORIZED` or `CANCELED`), possibly triggered by an intent already settled, cancelled, or not captured.\n- `AMOUNT_MISMATCH` – File amount does not match the Intent's captured amount, possibly triggered by a currency conversion issue, a partial settlement, or a fee calculation error.\n- `MANDATORY_MISSING` – A required field is empty or missing, possibly triggered by incomplete PSP data or a file format issue.\n- `FORMAT_DATE_INVALID` – A date field has an invalid format (expected DD-MM-YYYY), possibly triggered by an incorrect date format or a timezone issue."},"Description":{"type":"string","description":"A description of the error."}},"title":"ViewValidationErrorsForASettlementResponseLinesErrorsItemsDetailsItems"},"ViewValidationErrorsForASettlementResponseLinesErrorsItems":{"type":"object","properties":{"ExternalProviderReference":{"type":"string","description":"The unique identifier of the transaction at the provider level."},"ExternalTransactionType":{"type":"string","description":"Response values: `PAYMENT`, `REFUND`, `DISPUTE`\n\nThe type of the transaction."},"Details":{"type":"array","items":{"$ref":"#/components/schemas/ViewValidationErrorsForASettlementResponseLinesErrorsItemsDetailsItems"},"description":"The validation errors for this transaction line."}},"title":"ViewValidationErrorsForASettlementResponseLinesErrorsItems"},"ViewValidationErrorsForASettlementResponse":{"type":"object","properties":{"FooterErrors":{"type":"array","items":{"$ref":"#/components/schemas/ViewValidationErrorsForASettlementResponseFooterErrorsItems"},"description":"The errors encountered in the CSV footer."},"LinesErrors":{"type":"array","items":{"$ref":"#/components/schemas/ViewValidationErrorsForASettlementResponseLinesErrorsItems"},"description":"The errors encountered in the CSV's transaction lines."}},"title":"ViewValidationErrorsForASettlementResponse"},"ListAllSettlementsResponse":{"type":"array","items":{"$ref":"#/components/schemas/SettlementResponse"},"title":"ListAllSettlementsResponse"},"ViewAnApiResponseResource":{"type":"object","properties":{},"description":"The body of the request's response.","title":"ViewAnApiResponseResource"},"ViewAnApiResponse":{"type":"object","properties":{"StatusCode":{"type":"string","description":"The HTTP response code indicating the success or the failure of the request."},"ContentLength":{"type":"string","description":"The size of the message body in bytes."},"ContentType":{"type":"string","description":"The media type (two-part identifier for file formats and format contents) of the resource."},"Date":{"type":"string","description":"The date and time when the response was sent."},"RequestURL":{"type":"string","description":"The URL of the API request."},"Resource":{"$ref":"#/components/schemas/ViewAnApiResponseResource","description":"The body of the request's response."}},"title":"ViewAnApiResponse"},"CountryAuthorizationsResponseAuthorization":{"type":"object","properties":{"BlockUserCreation":{"type":"boolean","description":"Whether or not user creation is possible based on the user's country of residence, address, and nationality."},"BlockBankAccountCreation":{"type":"boolean","description":"Whether or not bank account creation is possible based on the bank's country of domiciliation."},"BlockPayout":{"type":"boolean","description":"Whether or not payout creation is possible based on the bank's country of domiciliation."}},"description":"Information about the country's restrictions.","title":"CountryAuthorizationsResponseAuthorization"},"CountryAuthorizationsResponse":{"type":"object","properties":{"CountryCode":{"type":"string","description":"Format: Two-letter country code ([ISO 3166-1 alpha-2 format](/api-reference/overview/data-formats))\n\nThe code of the country."},"CountryName":{"type":"string","description":"Name of the country."},"Authorization":{"$ref":"#/components/schemas/CountryAuthorizationsResponseAuthorization","description":"Information about the country's restrictions."},"LastUpdate":{"type":"integer","description":"The date and time when at least one of the country's authorizations has been last updated."}},"title":"CountryAuthorizationsResponse"},"ListAuthorizationsForAllCountriesResponseArrayAuthorizationsItemsObjectCountryAuthorizationAuthorization":{"type":"object","properties":{"BlockUserCreation":{"type":"boolean","description":"Whether or not user creation is possible based on the user's country of residence, address, and nationality."},"BlockBankAccountCreation":{"type":"boolean","description":"Whether or not bank account creation is possible based on the bank's country of domiciliation."},"BlockPayout":{"type":"boolean","description":"Whether or not payout creation is possible based on the bank's country of domiciliation."}},"description":"Information about the country's restrictions.","title":"ListAuthorizationsForAllCountriesResponseArrayAuthorizationsItemsObjectCountryAuthorizationAuthorization"},"ListAuthorizationsForAllCountriesResponseArrayAuthorizationsItemsObjectCountryAuthorization":{"type":"object","properties":{"CountryCode":{"type":"string","description":"Format: Two-letter country code ([ISO 3166-1 alpha-2 format](/api-reference/overview/data-formats))\n\nThe code of the country."},"CountryName":{"type":"string","description":"Name of the country."},"Authorization":{"$ref":"#/components/schemas/ListAuthorizationsForAllCountriesResponseArrayAuthorizationsItemsObjectCountryAuthorizationAuthorization","description":"Information about the country's restrictions."},"LastUpdate":{"type":"integer","description":"The date and time when at least one of the country's authorizations has been last updated."}},"description":"The country authorization object indicating if there are restrictions for a given country.","title":"ListAuthorizationsForAllCountriesResponseArrayAuthorizationsItemsObjectCountryAuthorization"},"ListAuthorizationsForAllCountriesResponseArrayAuthorizationsItems":{"type":"object","properties":{"Object (Country Authorization)":{"$ref":"#/components/schemas/ListAuthorizationsForAllCountriesResponseArrayAuthorizationsItemsObjectCountryAuthorization","description":"The country authorization object indicating if there are restrictions for a given country."}},"title":"ListAuthorizationsForAllCountriesResponseArrayAuthorizationsItems"},"ListAuthorizationsForAllCountriesResponse":{"type":"object","properties":{"Array (Authorizations)":{"type":"array","items":{"$ref":"#/components/schemas/ListAuthorizationsForAllCountriesResponseArrayAuthorizationsItems"},"description":"The list of countries and their restrictions."}},"title":"ListAuthorizationsForAllCountriesResponse"},"CreateAHookRequest":{"type":"object","properties":{"EventType":{"type":"string","description":"**Allowed values:** An `EventType` listed in the <a href=\"/webhooks/event-types\">event types list</a>\n\nThe type of the event."},"Url":{"type":"string","description":"Max. length: 255 characters\n\nThe URL to which the notification is sent."},"Tag":{"$ref":"#/components/schemas/Tag"},"Email":{"type":"string","description":"Format: A valid email address\n\nThe `Email` address to which alerts are sent in case of [consecutive failed notification attempts](/webhooks#notification-retries-and-failure).\n\n**Caution:** Mangopay may populate this property automatically if your platform had webhooks integrated in Production before April 2, 2026. If so, setting the `Email` on a single Hook stops this automatic population for any new Hooks you create - [read more](/webhooks#transition-from-default-email-april-2026).\n\nFor all platforms, if this property is returned `null` then no alerts are sent but the Hook still becomes `INVALID` after 100 consecutive failed notifications."}},"required":["EventType","Url"],"title":"CreateAHookRequest"},"HookResponse":{"type":"object","properties":{"Url":{"type":"string","description":"Max. length: 255 characters\n\nThe URL to which the notification is sent."},"Status":{"type":"string","description":"**Returned values:** `DISABLED`, `ENABLED`\n\nWhether the hook is enabled or not."},"Validity":{"type":"string","description":"**Returned values:** `VALID`, `INVALID`\n\nWhether the hook is valid or not. Once `INVALID` (following unsuccessful retries) the hook must be disabled and re-enabled."},"EventType":{"type":"string","description":"**Returned values:** An `EventType` listed in the <a href=\"/webhooks/event-types\">event types list</a>\n\nThe type of the event."},"Id":{"$ref":"#/components/schemas/Id"},"Tag":{"$ref":"#/components/schemas/Tag"},"CreationDate":{"$ref":"#/components/schemas/CreationDate"},"Email":{"type":"string","description":"Format: A valid email address\n\nThe `Email` address to which alerts are sent in case of [consecutive failed notification attempts](/webhooks#notification-retries-and-failure).\n\n**Caution:** Mangopay may populate this property automatically if your platform had webhooks integrated in Production before April 2, 2026. If so, setting the `Email` on a single Hook stops this automatic population for any new Hooks you create - [read more](/webhooks#transition-from-default-email-april-2026).\n\nFor all platforms, if this property is returned `null` then no alerts are sent but the Hook still becomes `INVALID` after 100 consecutive failed notifications."}},"title":"HookResponse"},"UpdateAHookRequest":{"type":"object","properties":{"Url":{"type":"string","description":"The URL to which the notification is sent."},"Status":{"type":"string","description":"**Allowed values:** `DISABLED`, `ENABLED`\n\nWhether the hook is enabled or not."},"Tag":{"type":"string","description":"Custom data that you can add to this object."}},"title":"UpdateAHookRequest"},"ListAllHooksResponseArrayHooksItemsHook":{"type":"object","properties":{"Url":{"type":"string","description":"The URL to which the notification is sent."},"Status":{"type":"string","description":"**Returned values:** `DISABLED`, `ENABLED`\n\nWhether the hook is enabled or not."},"Validity":{"type":"string","description":"**Returned values:** `VALID`, `INVALID`\n\nWhether the hook is valid or not. Once `INVALID` (following unsuccessful retries) the hook must be disabled and re-enabled."},"EventType":{"type":"string","description":"**Returned values:** An `EventType` listed in the <a href=\"/webhooks/event-types\">event types list</a>\n\nThe type of the event."},"Id":{"$ref":"#/components/schemas/Id"},"Tag":{"type":"string","description":"Custom data that you can add to this object."},"CreationDate":{"$ref":"#/components/schemas/CreationDate"},"Email":{"type":"string","description":"Format: A valid email address\n\nThe `Email` address to which alerts are sent in case of [consecutive failed notification attempts](/webhooks#notification-retries-and-failure).\n\n**Caution:** Mangopay may populate this property automatically if your platform had webhooks integrated in Production before April 2, 2026. If so, setting the `Email` on a single Hook stops this automatic population for any new Hooks you create - [read more](/webhooks#transition-from-default-email-april-2026).\n\nFor all platforms, if this property is returned `null` then no alerts are sent but the Hook still becomes `INVALID` after 100 consecutive failed notifications."}},"description":"The hook object created by the platform.","title":"ListAllHooksResponseArrayHooksItemsHook"},"ListAllHooksResponseArrayHooksItems":{"type":"object","properties":{"Hook":{"$ref":"#/components/schemas/ListAllHooksResponseArrayHooksItemsHook","description":"The hook object created by the platform."}},"title":"ListAllHooksResponseArrayHooksItems"},"ListAllHooksResponse":{"type":"object","properties":{"Array (Hooks)":{"type":"array","items":{"$ref":"#/components/schemas/ListAllHooksResponseArrayHooksItems"},"description":"The list of hooks created by the platform."}},"title":"ListAllHooksResponse"},"EventResponse":{"type":"object","properties":{"ResourceId":{"type":"string","description":"Max. length: 255 characters\n\nThe unique identifier of the event."},"Date":{"type":"integer","description":"The date and time the event occurred."},"EventType":{"type":"string","description":"**Returned values:** An `EventType` listed in the <a href=\"/webhooks/event-types\">event types list</a>\n\nThe type of the event."}},"title":"EventResponse"},"ListAllEventsResponseArrayEventsItems":{"type":"object","properties":{"Object":{"$ref":"#/components/schemas/EventResponse"}},"title":"ListAllEventsResponseArrayEventsItems"},"ListAllEventsResponse":{"type":"object","properties":{"Array (Events)":{"type":"array","items":{"$ref":"#/components/schemas/ListAllEventsResponseArrayEventsItems"},"description":"The list of events created by the platform."}},"title":"ListAllEventsResponse"},"ReportType_COLLECTED_FEES_Request":{"type":"string","description":"**Allowed values:** `COLLECTED_FEES`\n\nThe type of the report. Each `ReportType` has different available `Columns` and `Filters`.\n\nUseful for all platforms:\n- `USER_WALLET_TRANSACTIONS` – All successful transactions crediting or debiting user wallets: pay-ins, transfers, conversions, and payouts, as well as refunds of all types and repudiations (from chargebacks).\n- `COLLECTED_FEES`– Detail of transactions crediting or debiting the fees wallet: successful transactions of all types (pay-ins, transfers, refunds, payouts, etc.) that have a positive or negative fees amount.\n\nUseful for platforms using [Echo](/guides/echo), Mangopay's solution for integrations working with third-party PSPs:\n- `ECHO_INTENT` – Summary of all intents declared during the selected period, detailing the total funds expected to enter the platform's technical wallets.\n- `ECHO_INTENT_ACTION` – Summary of all operations related to intents processed during the selected period, detailing the expected money movements to be escrowed — including payments, refunds, refund reversals, and chargebacks.\n- `ECHO_SETTLEMENT` – Summary of all settlement files uploaded during the selected period to initiate the reconciliation process, confirming the funds expected on the techncial wallet.\n- `ECHO_SPLIT` – Summary of all splits related to intents during the selected period, detailing the transfer of funds to the declared destination.","title":"ReportType_COLLECTED_FEES_Request"},"ReportFilters_COLLECTED_FEES":{"type":"object","properties":{"Currency":{"type":"string","description":"The currency of the `DebitedFunds`, `CreditedFunds`, or `Fees` of the transactions."}},"description":"Filters available on the `COLLECTED_FEES` report. The `Currency` filter\nis available; if not specified, the report contains data on all\ncurrencies.","title":"ReportFilters_COLLECTED_FEES"},"CreateAReportRequest_COLLECTED_FEES":{"type":"object","properties":{"Tag":{"type":"string","description":"Max. length: 255 characters\n\nCustom data that you can add to this object.\n\nFor reports, this parameter can be useful to give the report a name."},"DownloadFormat":{"type":"string","description":"**Possible values:** `CSV`\n\nThe format of the report file."},"Sort":{"type":"string","description":"**Possible values:** `CreationDate:ASC`, `CreationDate:DESC`\n\n**Default value**: `CreationDate:DESC`\n\nThe sort direction based on transaction creation date."},"AfterDate":{"type":"integer","description":"**Possible values:** Any past date and time up 24 months ago that is earlier than the `BeforeDate` by less than 12 months.\n\nThe date and time after which the report's transaction was created, based on the transaction's `CreationDate`."},"BeforeDate":{"type":"integer","description":"**Possible values:** Any past date and time up 24 months ago that is later than the `AfterDate` by less than 12 months.\n\nThe date and time before which the report's transaction was created, based on the transaction's `CreationDate`."},"Columns":{"type":"array","items":{"type":"string"},"description":"**Possible values:** The columns listed in the [Reports](/reports) guide, which differ according to the report type.\n\n**Default values:** The default columns listed in the [Reports](/reports) guide, which differ according to the report type.\n\nThe data columns to be included in the report."},"ReportType":{"$ref":"#/components/schemas/ReportType_COLLECTED_FEES_Request"},"Filters":{"$ref":"#/components/schemas/ReportFilters_COLLECTED_FEES"},"DateRangeBy":{"type":"string","description":"**Possible values:** `CreationDate`, `ExecutionDate`\n\n**Default value:** `CreationDate`\n\nThe date to which `BeforeDate` and `AfterDate` apply. The `DateRangeBy` property can only be sent on `USER_WALLET_TRANSACTIONS` and `COLLECTED_FEES` reports. It is returned `null` for other types.\n\nThe `ExecutionDate` value is likely to be more useful, because this is the date and time that the transaction `Status` became `SUCCEEDED`. Note also that these reports only contain successful transactions."}},"required":["DownloadFormat","AfterDate","BeforeDate","ReportType"],"description":"Request body for creating a `COLLECTED_FEES` report with its available `Filters` and `DateRangeBy`.\n\nDetail of transactions crediting or debiting the fees wallet: successful transactions of all types (pay-ins, transfers, refunds, payouts, etc.) that have a positive or negative fees amount.","title":"CreateAReportRequest_COLLECTED_FEES"},"ReportType_USER_WALLET_TRANSACTIONS_Request":{"type":"string","description":"**Allowed values:** `USER_WALLET_TRANSACTIONS`\n\nThe type of the report. Each `ReportType` has different available `Columns` and `Filters`.\n\nUseful for all platforms:\n- `USER_WALLET_TRANSACTIONS` – All successful transactions crediting or debiting user wallets: pay-ins, transfers, conversions, and payouts, as well as refunds of all types and repudiations (from chargebacks).\n- `COLLECTED_FEES`– Detail of transactions crediting or debiting the fees wallet: successful transactions of all types (pay-ins, transfers, refunds, payouts, etc.) that have a positive or negative fees amount.\n\nUseful for platforms using [Echo](/guides/echo), Mangopay's solution for integrations working with third-party PSPs:\n- `ECHO_INTENT` – Summary of all intents declared during the selected period, detailing the total funds expected to enter the platform's technical wallets.\n- `ECHO_INTENT_ACTION` – Summary of all operations related to intents processed during the selected period, detailing the expected money movements to be escrowed — including payments, refunds, refund reversals, and chargebacks.\n- `ECHO_SETTLEMENT` – Summary of all settlement files uploaded during the selected period to initiate the reconciliation process, confirming the funds expected on the techncial wallet.\n- `ECHO_SPLIT` – Summary of all splits related to intents during the selected period, detailing the transfer of funds to the declared destination.","title":"ReportType_USER_WALLET_TRANSACTIONS_Request"},"ReportFilters_USER_WALLET_TRANSACTIONS":{"type":"object","properties":{"Currency":{"type":"string","description":"The currency of the `DebitedFunds`, `CreditedFunds`, or `Fees` of the transactions."},"UserId":{"type":"string","description":"The unique identifier of the user referenced as the `AuthorId` of the transaction."},"WalletId":{"type":"string","description":"The unique identifier of the wallet referenced as the `DebitedWalletId` or `CreditedWalletId` of the transaction."}},"description":"Filters available on the `USER_WALLET_TRANSACTIONS` report. `Currency`,\n`UserId`, and `WalletId` can be used alone or in combination, in which\ncase the report data satisfies both filters. `Currency` and `WalletId`\ncannot be used together. If no filters are specified, the report\ncontains all successful transactions crediting or debiting all user\nwallets.","title":"ReportFilters_USER_WALLET_TRANSACTIONS"},"CreateAReportRequest_USER_WALLET_TRANSACTIONS":{"type":"object","properties":{"Tag":{"type":"string","description":"Max. length: 255 characters\n\nCustom data that you can add to this object.\n\nFor reports, this parameter can be useful to give the report a name."},"DownloadFormat":{"type":"string","description":"**Possible values:** `CSV`\n\nThe format of the report file."},"Sort":{"type":"string","description":"**Possible values:** `CreationDate:ASC`, `CreationDate:DESC`\n\n**Default value**: `CreationDate:DESC`\n\nThe sort direction based on transaction creation date."},"AfterDate":{"type":"integer","description":"**Possible values:** Any past date and time up 24 months ago that is earlier than the `BeforeDate` by less than 12 months.\n\nThe date and time after which the report's transaction was created, based on the transaction's `CreationDate`."},"BeforeDate":{"type":"integer","description":"**Possible values:** Any past date and time up 24 months ago that is later than the `AfterDate` by less than 12 months.\n\nThe date and time before which the report's transaction was created, based on the transaction's `CreationDate`."},"Columns":{"type":"array","items":{"type":"string"},"description":"**Possible values:** The columns listed in the [Reports](/reports) guide, which differ according to the report type.\n\n**Default values:** The default columns listed in the [Reports](/reports) guide, which differ according to the report type.\n\nThe data columns to be included in the report."},"ReportType":{"$ref":"#/components/schemas/ReportType_USER_WALLET_TRANSACTIONS_Request"},"Filters":{"$ref":"#/components/schemas/ReportFilters_USER_WALLET_TRANSACTIONS"},"DateRangeBy":{"type":"string","description":"**Possible values:** `CreationDate`, `ExecutionDate`\n\n**Default value:** `CreationDate`\n\nThe date to which `BeforeDate` and `AfterDate` apply. The `DateRangeBy` property can only be sent on `USER_WALLET_TRANSACTIONS` and `COLLECTED_FEES` reports. It is returned `null` for other types.\n\nThe `ExecutionDate` value is likely to be more useful, because this is the date and time that the transaction `Status` became `SUCCEEDED`. Note also that these reports only contain successful transactions."}},"required":["DownloadFormat","AfterDate","BeforeDate","ReportType"],"description":"Request body for creating a `USER_WALLET_TRANSACTIONS` report with its available `Filters` and `DateRangeBy`.\n\nAll successful transactions crediting or debiting user wallets: pay-ins, transfers, conversions, and payouts, as well as refunds of all types and repudiations (from chargebacks).","title":"CreateAReportRequest_USER_WALLET_TRANSACTIONS"},"ReportType_ECHO_INTENT_Request":{"type":"string","description":"**Allowed values:** `ECHO_INTENT`\n\nThe type of the report. Each `ReportType` has different available `Columns` and `Filters`.\n\nUseful for all platforms:\n- `USER_WALLET_TRANSACTIONS` – All successful transactions crediting or debiting user wallets: pay-ins, transfers, conversions, and payouts, as well as refunds of all types and repudiations (from chargebacks).\n- `COLLECTED_FEES`– Detail of transactions crediting or debiting the fees wallet: successful transactions of all types (pay-ins, transfers, refunds, payouts, etc.) that have a positive or negative fees amount.\n\nUseful for platforms using [Echo](/guides/echo), Mangopay's solution for integrations working with third-party PSPs:\n- `ECHO_INTENT` – Summary of all intents declared during the selected period, detailing the total funds expected to enter the platform's technical wallets.\n- `ECHO_INTENT_ACTION` – Summary of all operations related to intents processed during the selected period, detailing the expected money movements to be escrowed — including payments, refunds, refund reversals, and chargebacks.\n- `ECHO_SETTLEMENT` – Summary of all settlement files uploaded during the selected period to initiate the reconciliation process, confirming the funds expected on the techncial wallet.\n- `ECHO_SPLIT` – Summary of all splits related to intents during the selected period, detailing the transfer of funds to the declared destination.","title":"ReportType_ECHO_INTENT_Request"},"ReportFilters_ECHO_INTENT":{"type":"object","properties":{"Type":{"type":"string","description":"**Possible values:** `PAYIN`, `REFUND`, `DISPUTE`.\n\nThe type of Intent (as indicated in the settlement file)."},"Status":{"type":"string","description":"**Possible values:** `AUTHORIZED`, `PARTIALLY_CAPTURED`, `CAPTURED`, `CANCELED`, `REFUNDED`, `REFUND_REVERSED`, `DISPUTED`, `DEFENDED`, `DISPUTED_WON`, `DISPUTED_LOST`.\n\nThe `Status` of the Intent."},"PaymentMethod":{"type":"string","description":"The payment method of the Intent – one of the [supported values](/api-reference/echo/supported-payment-methods) of the `ExternalProviderPaymentMethod`."}},"description":"Filters available on the `ECHO_INTENT` report. Can be used in any\ncombination. (`ECHO_INTENT` and `ECHO_INTENT_ACTION` share the same\nfilter shape.)","title":"ReportFilters_ECHO_INTENT"},"CreateAReportRequest_ECHO_INTENT":{"type":"object","properties":{"Tag":{"type":"string","description":"Max. length: 255 characters\n\nCustom data that you can add to this object.\n\nFor reports, this parameter can be useful to give the report a name."},"DownloadFormat":{"type":"string","description":"**Possible values:** `CSV`\n\nThe format of the report file."},"Sort":{"type":"string","description":"**Possible values:** `CreationDate:ASC`, `CreationDate:DESC`\n\n**Default value**: `CreationDate:DESC`\n\nThe sort direction based on transaction creation date."},"AfterDate":{"type":"integer","description":"**Possible values:** Any past date and time up 24 months ago that is earlier than the `BeforeDate` by less than 12 months.\n\nThe date and time after which the report's transaction was created, based on the transaction's `CreationDate`."},"BeforeDate":{"type":"integer","description":"**Possible values:** Any past date and time up 24 months ago that is later than the `AfterDate` by less than 12 months.\n\nThe date and time before which the report's transaction was created, based on the transaction's `CreationDate`."},"Columns":{"type":"array","items":{"type":"string"},"description":"**Possible values:** The columns listed in the [Reports](/reports) guide, which differ according to the report type.\n\n**Default values:** The default columns listed in the [Reports](/reports) guide, which differ according to the report type.\n\nThe data columns to be included in the report."},"ReportType":{"$ref":"#/components/schemas/ReportType_ECHO_INTENT_Request"},"Filters":{"$ref":"#/components/schemas/ReportFilters_ECHO_INTENT"}},"required":["DownloadFormat","AfterDate","BeforeDate","ReportType"],"description":"Request body for creating an `ECHO_INTENT` report, with its available `Filters`.\n\nSummary of all intents declared during the selected period, detailing the total funds expected to enter the platform's technical wallets.","title":"CreateAReportRequest_ECHO_INTENT"},"ReportType_ECHO_INTENT_ACTION_Request":{"type":"string","description":"**Allowed values:** `ECHO_INTENT_ACTION`\n\nThe type of the report. Each `ReportType` has different available `Columns` and `Filters`.\n\nUseful for all platforms:\n- `USER_WALLET_TRANSACTIONS` – All successful transactions crediting or debiting user wallets: pay-ins, transfers, conversions, and payouts, as well as refunds of all types and repudiations (from chargebacks).\n- `COLLECTED_FEES`– Detail of transactions crediting or debiting the fees wallet: successful transactions of all types (pay-ins, transfers, refunds, payouts, etc.) that have a positive or negative fees amount.\n\nUseful for platforms using [Echo](/guides/echo), Mangopay's solution for integrations working with third-party PSPs:\n- `ECHO_INTENT` – Summary of all intents declared during the selected period, detailing the total funds expected to enter the platform's technical wallets.\n- `ECHO_INTENT_ACTION` – Summary of all operations related to intents processed during the selected period, detailing the expected money movements to be escrowed — including payments, refunds, refund reversals, and chargebacks.\n- `ECHO_SETTLEMENT` – Summary of all settlement files uploaded during the selected period to initiate the reconciliation process, confirming the funds expected on the techncial wallet.\n- `ECHO_SPLIT` – Summary of all splits related to intents during the selected period, detailing the transfer of funds to the declared destination.","title":"ReportType_ECHO_INTENT_ACTION_Request"},"ReportFilters_ECHO_INTENT_ACTION":{"type":"object","properties":{"Type":{"type":"string","description":"**Possible values:** `PAYIN`, `REFUND`, `DISPUTE`.\n\nThe type of Intent (as indicated in the settlement file)."},"Status":{"type":"string","description":"**Possible values:** `AUTHORIZED`, `PARTIALLY_CAPTURED`, `CAPTURED`, `CANCELED`, `REFUNDED`, `REFUND_REVERSED`, `DISPUTED`, `DEFENDED`, `DISPUTED_WON`, `DISPUTED_LOST`.\n\nThe `Status` of the Intent."},"PaymentMethod":{"type":"string","description":"The payment method of the Intent – one of the [supported values](/api-reference/echo/supported-payment-methods) of the `ExternalProviderPaymentMethod`."}},"description":"Filters available on the `ECHO_INTENT_ACTION` report. Can be used in any\ncombination. (`ECHO_INTENT` and `ECHO_INTENT_ACTION` share the same\nfilter shape.)","title":"ReportFilters_ECHO_INTENT_ACTION"},"CreateAReportRequest_ECHO_INTENT_ACTION":{"type":"object","properties":{"Tag":{"type":"string","description":"Max. length: 255 characters\n\nCustom data that you can add to this object.\n\nFor reports, this parameter can be useful to give the report a name."},"DownloadFormat":{"type":"string","description":"**Possible values:** `CSV`\n\nThe format of the report file."},"Sort":{"type":"string","description":"**Possible values:** `CreationDate:ASC`, `CreationDate:DESC`\n\n**Default value**: `CreationDate:DESC`\n\nThe sort direction based on transaction creation date."},"AfterDate":{"type":"integer","description":"**Possible values:** Any past date and time up 24 months ago that is earlier than the `BeforeDate` by less than 12 months.\n\nThe date and time after which the report's transaction was created, based on the transaction's `CreationDate`."},"BeforeDate":{"type":"integer","description":"**Possible values:** Any past date and time up 24 months ago that is later than the `AfterDate` by less than 12 months.\n\nThe date and time before which the report's transaction was created, based on the transaction's `CreationDate`."},"Columns":{"type":"array","items":{"type":"string"},"description":"**Possible values:** The columns listed in the [Reports](/reports) guide, which differ according to the report type.\n\n**Default values:** The default columns listed in the [Reports](/reports) guide, which differ according to the report type.\n\nThe data columns to be included in the report."},"ReportType":{"$ref":"#/components/schemas/ReportType_ECHO_INTENT_ACTION_Request"},"Filters":{"$ref":"#/components/schemas/ReportFilters_ECHO_INTENT_ACTION"}},"required":["DownloadFormat","AfterDate","BeforeDate","ReportType"],"description":"Request body for creating an `ECHO_INTENT_ACTION` report, with its available `Filters`. \n\nSummary of all operations related to intents processed during the selected period, detailing the expected money movements to be escrowed — including payments, refunds, refund reversals, and chargebacks.","title":"CreateAReportRequest_ECHO_INTENT_ACTION"},"ReportType_ECHO_SETTLEMENT_Request":{"type":"string","description":"**Allowed values:** `ECHO_SETTLEMENT`\n\nThe type of the report. Each `ReportType` has different available `Columns` and `Filters`.\n\nUseful for all platforms:\n- `USER_WALLET_TRANSACTIONS` – All successful transactions crediting or debiting user wallets: pay-ins, transfers, conversions, and payouts, as well as refunds of all types and repudiations (from chargebacks).\n- `COLLECTED_FEES`– Detail of transactions crediting or debiting the fees wallet: successful transactions of all types (pay-ins, transfers, refunds, payouts, etc.) that have a positive or negative fees amount.\n\nUseful for platforms using [Echo](/guides/echo), Mangopay's solution for integrations working with third-party PSPs:\n- `ECHO_INTENT` – Summary of all intents declared during the selected period, detailing the total funds expected to enter the platform's technical wallets.\n- `ECHO_INTENT_ACTION` – Summary of all operations related to intents processed during the selected period, detailing the expected money movements to be escrowed — including payments, refunds, refund reversals, and chargebacks.\n- `ECHO_SETTLEMENT` – Summary of all settlement files uploaded during the selected period to initiate the reconciliation process, confirming the funds expected on the techncial wallet.\n- `ECHO_SPLIT` – Summary of all splits related to intents during the selected period, detailing the transfer of funds to the declared destination.","title":"ReportType_ECHO_SETTLEMENT_Request"},"ReportFilters_ECHO_SETTLEMENT":{"type":"object","properties":{"Status":{"type":"string","description":"**Possible values:** `UPLOADED`, `CREATED`, `UNMATCHED`, `PARTIALLY_MATCHED`, `PENDING_FUNDS_RECEPTION`, `INSUFFICIENT_FUNDS`, `RECONCILED`, `FAILED`.\n\nThe `Status` of the Settlement."},"ExternalProviderName":{"type":"string","description":"The [supported third-party PSP](/api-reference/echo/supported-providers) processing the transaction."}},"description":"Filters available on the `ECHO_SETTLEMENT` report (alone or together).","title":"ReportFilters_ECHO_SETTLEMENT"},"CreateAReportRequest_ECHO_SETTLEMENT":{"type":"object","properties":{"Tag":{"type":"string","description":"Max. length: 255 characters\n\nCustom data that you can add to this object.\n\nFor reports, this parameter can be useful to give the report a name."},"DownloadFormat":{"type":"string","description":"**Possible values:** `CSV`\n\nThe format of the report file."},"Sort":{"type":"string","description":"**Possible values:** `CreationDate:ASC`, `CreationDate:DESC`\n\n**Default value**: `CreationDate:DESC`\n\nThe sort direction based on transaction creation date."},"AfterDate":{"type":"integer","description":"**Possible values:** Any past date and time up 24 months ago that is earlier than the `BeforeDate` by less than 12 months.\n\nThe date and time after which the report's transaction was created, based on the transaction's `CreationDate`."},"BeforeDate":{"type":"integer","description":"**Possible values:** Any past date and time up 24 months ago that is later than the `AfterDate` by less than 12 months.\n\nThe date and time before which the report's transaction was created, based on the transaction's `CreationDate`."},"Columns":{"type":"array","items":{"type":"string"},"description":"**Possible values:** The columns listed in the [Reports](/reports) guide, which differ according to the report type.\n\n**Default values:** The default columns listed in the [Reports](/reports) guide, which differ according to the report type.\n\nThe data columns to be included in the report."},"ReportType":{"$ref":"#/components/schemas/ReportType_ECHO_SETTLEMENT_Request"},"Filters":{"$ref":"#/components/schemas/ReportFilters_ECHO_SETTLEMENT"}},"required":["DownloadFormat","AfterDate","BeforeDate","ReportType"],"description":"Request body for creating an `ECHO_SETTLEMENT` report, with its available `Filters`.\n\nSummary of all settlement files uploaded during the selected period to initiate the reconciliation process, confirming the funds expected on the techncial wallet.","title":"CreateAReportRequest_ECHO_SETTLEMENT"},"ReportType_ECHO_SPLIT_Request":{"type":"string","description":"**Allowed values:** `ECHO_SPLIT`\n\nThe type of the report. Each `ReportType` has different available `Columns` and `Filters`.\n\nUseful for all platforms:\n- `USER_WALLET_TRANSACTIONS` – All successful transactions crediting or debiting user wallets: pay-ins, transfers, conversions, and payouts, as well as refunds of all types and repudiations (from chargebacks).\n- `COLLECTED_FEES`– Detail of transactions crediting or debiting the fees wallet: successful transactions of all types (pay-ins, transfers, refunds, payouts, etc.) that have a positive or negative fees amount.\n\nUseful for platforms using [Echo](/guides/echo), Mangopay's solution for integrations working with third-party PSPs:\n- `ECHO_INTENT` – Summary of all intents declared during the selected period, detailing the total funds expected to enter the platform's technical wallets.\n- `ECHO_INTENT_ACTION` – Summary of all operations related to intents processed during the selected period, detailing the expected money movements to be escrowed — including payments, refunds, refund reversals, and chargebacks.\n- `ECHO_SETTLEMENT` – Summary of all settlement files uploaded during the selected period to initiate the reconciliation process, confirming the funds expected on the techncial wallet.\n- `ECHO_SPLIT` – Summary of all splits related to intents during the selected period, detailing the transfer of funds to the declared destination.","title":"ReportType_ECHO_SPLIT_Request"},"ReportFilters_ECHO_SPLIT":{"type":"object","properties":{"Status":{"type":"string","description":"**Possible values:** `CREATED`, `PENDING_FUNDS_RECEPTION`, `AVAILABLE`, `PENDING`, `COMPLETED`, `REJECTED`, `FAILED`, `REVERSED`.\n\nThe `Status` of the Split."},"IntentId":{"type":"string","description":"The unique identifier of the related Intent.\n\n**Caution:** There is no validation that the `IntentId` is valid."},"Scheduled":{"type":"boolean","description":"Whether or not the `TransferDate` was sent (in either the Intent or the Split), regardless of the `Status` of the Split."}},"description":"Filters available on the `ECHO_SPLIT` report (alone or in combination).","title":"ReportFilters_ECHO_SPLIT"},"CreateAReportRequest_ECHO_SPLIT":{"type":"object","properties":{"Tag":{"type":"string","description":"Max. length: 255 characters\n\nCustom data that you can add to this object.\n\nFor reports, this parameter can be useful to give the report a name."},"DownloadFormat":{"type":"string","description":"**Possible values:** `CSV`\n\nThe format of the report file."},"Sort":{"type":"string","description":"**Possible values:** `CreationDate:ASC`, `CreationDate:DESC`\n\n**Default value**: `CreationDate:DESC`\n\nThe sort direction based on transaction creation date."},"AfterDate":{"type":"integer","description":"**Possible values:** Any past date and time up 24 months ago that is earlier than the `BeforeDate` by less than 12 months.\n\nThe date and time after which the report's transaction was created, based on the transaction's `CreationDate`."},"BeforeDate":{"type":"integer","description":"**Possible values:** Any past date and time up 24 months ago that is later than the `AfterDate` by less than 12 months.\n\nThe date and time before which the report's transaction was created, based on the transaction's `CreationDate`."},"Columns":{"type":"array","items":{"type":"string"},"description":"**Possible values:** The columns listed in the [Reports](/reports) guide, which differ according to the report type.\n\n**Default values:** The default columns listed in the [Reports](/reports) guide, which differ according to the report type.\n\nThe data columns to be included in the report."},"ReportType":{"$ref":"#/components/schemas/ReportType_ECHO_SPLIT_Request"},"Filters":{"$ref":"#/components/schemas/ReportFilters_ECHO_SPLIT"}},"required":["DownloadFormat","AfterDate","BeforeDate","ReportType"],"description":"Request body for creating an `ECHO_SPLIT` report, with its available `Filters`.\n\nSummary of all splits related to intents during the selected period, detailing the transfer of funds to the declared destination.","title":"CreateAReportRequest_ECHO_SPLIT"},"CreateAReportRequest":{"oneOf":[{"$ref":"#/components/schemas/CreateAReportRequest_COLLECTED_FEES"},{"$ref":"#/components/schemas/CreateAReportRequest_USER_WALLET_TRANSACTIONS"},{"$ref":"#/components/schemas/CreateAReportRequest_ECHO_INTENT"},{"$ref":"#/components/schemas/CreateAReportRequest_ECHO_INTENT_ACTION"},{"$ref":"#/components/schemas/CreateAReportRequest_ECHO_SETTLEMENT"},{"$ref":"#/components/schemas/CreateAReportRequest_ECHO_SPLIT"}],"title":"CreateAReportRequest"},"ReportType_Reporting_Response":{"type":"string","description":"**Returned values:** `COLLECTED_FEES`, `USER_WALLET_TRANSACTIONS`, `ECHO_INTENT`, `ECHO_INTENT_ACTION`, `ECHO_SETTLEMENT`, `ECHO_SPLIT`\n\nThe type of the report. Each `ReportType` has different available `Columns` and `Filters`.\n\nUseful for all platforms:\n- `USER_WALLET_TRANSACTIONS` – All successful transactions crediting or debiting user wallets: pay-ins, transfers, conversions, and payouts, as well as refunds of all types and repudiations (from chargebacks).\n- `COLLECTED_FEES`– Detail of transactions crediting or debiting the fees wallet: successful transactions of all types (pay-ins, transfers, refunds, payouts, etc.) that have a positive or negative fees amount.\n\nUseful for platforms using [Echo](/guides/echo), Mangopay's solution for integrations working with third-party PSPs:\n- `ECHO_INTENT` – Summary of all intents declared during the selected period, detailing the total funds expected to enter the platform's technical wallets.\n- `ECHO_INTENT_ACTION` – Summary of all operations related to intents processed during the selected period, detailing the expected money movements to be escrowed — including payments, refunds, refund reversals, and chargebacks.\n- `ECHO_SETTLEMENT` – Summary of all settlement files uploaded during the selected period to initiate the reconciliation process, confirming the funds expected on the techncial wallet.\n- `ECHO_SPLIT` – Summary of all splits related to intents during the selected period, detailing the transfer of funds to the declared destination.","title":"ReportType_Reporting_Response"},"CreateAReportResponseFilters":{"type":"object","properties":{},"description":"The filters sent in the request. Different filters are available for each `ReportType`.","title":"CreateAReportResponseFilters"},"CreateAReportResponseColumnsItems":{"type":"object","properties":{"Name":{"type":"string","description":"The name of the column."},"IsDefault":{"type":"boolean","description":"Whether the column is a default for the report or not."}},"title":"CreateAReportResponseColumnsItems"},"CreateAReportResponse":{"type":"object","properties":{"Id":{"$ref":"#/components/schemas/Id"},"Tag":{"$ref":"#/components/schemas/Tag"},"CreationDate":{"$ref":"#/components/schemas/CreationDate"},"ReportDate":{"type":["integer","null"],"description":"Unix timestamp (UTC) of the date and time the report was generated."},"Status":{"type":"string","description":"**Returned values:** `PENDING`, `READY_FOR_DOWNLOAD`, `FAILED`, `EXPIRED`\n\nThe status of the report:\n- `PENDING` – The report is being generated.\n- `READY_FOR_DOWNLOAD` – The report has been created, and can be downloaded.\n- `FAILED` – The report cannot be generated.\n- `EXPIRED` – The report was created, but is no longer available for download (it can be re-run to be downloaded again with fresh data)."},"ResultCode":{"$ref":"#/components/schemas/ResultCode"},"ResultMessage":{"$ref":"#/components/schemas/ResultMessage"},"DownloadFormat":{"type":"string","description":"**Returned values:** `CSV`\n\nThe format in which the report is going to be downloaded."},"DownloadURL":{"type":["string","null"],"description":"The URL at which the report file can be downloaded when the `Status` is `GENERATED`."},"ReportType":{"$ref":"#/components/schemas/ReportType_Reporting_Response"},"Sort":{"type":"string","description":"**Possible values:** `CreationDate:ASC`, `CreationDate:DESC`\n\n**Default value**: `CreationDate:DESC`\n\nThe sort direction based on transaction creation date."},"DateRangeBy":{"type":["string","null"],"description":"**Possible values:** `CreationDate`, `ExecutionDate`\n\n**Default value:** `CreationDate`\n\nThe date to which `BeforeDate` and `AfterDate` apply. The `DateRangeBy` property can only be sent on `USER_WALLET_TRANSACTIONS` and `COLLECTED_FEES` reports. It is returned `null` for other types.\n\nThe `ExecutionDate` value is likely to be more useful, because this is the date and time that the transaction `Status` became `SUCCEEDED`. Note also that these reports only contain successful transactions."},"AfterDate":{"type":"integer","description":"**Possible values:** Any date and time (before the `BeforeDate`) between the present and 24 months ago.\n\nThe date and time after which the report's transaction was created, based on the transaction's `CreationDate`.\n\n**Note:** The period between the `AfterDate` and the `BeforeDate` cannot exceed 12 months."},"BeforeDate":{"type":"integer","description":"**Possible values:** Any date and time (after the `AfterDate`) between the present and 24 months ago.\n\nThe date and time before which the report's transaction was created, based on the transaction's `CreationDate`.\n\n**Note:** The period between the `AfterDate` and the `BeforeDate` cannot exceed 12 months."},"Filters":{"$ref":"#/components/schemas/CreateAReportResponseFilters","description":"The filters sent in the request. Different filters are available for each `ReportType`."},"Columns":{"type":"array","items":{"$ref":"#/components/schemas/CreateAReportResponseColumnsItems"},"description":"**Possible values:** The columns listed in the [Reports](/reports) guide, which differ according to the report type.\n\n**Default values:** The default columns listed in the [Reports](/reports) guide, which differ according to the report type.\n\nThe data columns to be included in the report."}},"title":"CreateAReportResponse"},"ReportResponseFilters":{"type":"object","properties":{},"description":"The filters sent in the request. Different filters are available for each `ReportType`.","title":"ReportResponseFilters"},"ReportResponseColumnsItems":{"type":"object","properties":{"Name":{"type":"string","description":"The name of the column."},"IsDefault":{"type":"boolean","description":"Whether the column is a default for the report or not."}},"title":"ReportResponseColumnsItems"},"ReportResponse":{"type":"object","properties":{"Id":{"$ref":"#/components/schemas/Id"},"Tag":{"$ref":"#/components/schemas/Tag"},"CreationDate":{"$ref":"#/components/schemas/CreationDate"},"ReportDate":{"type":["integer","null"],"description":"Unix timestamp (UTC) of the date and time the report was generated."},"Status":{"type":"string","description":"**Returned values:** `PENDING`, `READY_FOR_DOWNLOAD`, `FAILED`, `EXPIRED`\n\nThe status of the report:\n- `PENDING` – The report is being generated.\n- `READY_FOR_DOWNLOAD` – The report has been created, and can be downloaded.\n- `FAILED` – The report cannot be generated.\n- `EXPIRED` – The report was created, but is no longer available for download (it can be re-run to be downloaded again with fresh data)."},"ResultCode":{"$ref":"#/components/schemas/ResultCode"},"ResultMessage":{"$ref":"#/components/schemas/ResultMessage"},"DownloadFormat":{"type":"string","description":"**Returned values:** `CSV`\n\nThe format in which the report is going to be downloaded."},"DownloadURL":{"type":["string","null"],"description":"The URL at which the report file can be downloaded when the `Status` is `GENERATED`."},"ReportType":{"$ref":"#/components/schemas/ReportType_Reporting_Response"},"Sort":{"type":"string","description":"The sorting direction of the CreationDate column. By default, the generated report is sorted by ascending creation date."},"DateRangeBy":{"type":["string","null"],"description":"**Possible values:** `CreationDate`, `ExecutionDate`\n\n**Default value:** `CreationDate`\n\nThe date to which `BeforeDate` and `AfterDate` apply. The `DateRangeBy` property can only be sent on `USER_WALLET_TRANSACTIONS` and `COLLECTED_FEES` reports. It is returned `null` for other types.\n\nThe `ExecutionDate` value is likely to be more useful, because this is the date and time that the transaction `Status` became `SUCCEEDED`. Note also that these reports only contain successful transactions."},"AfterDate":{"type":"integer","description":"**Possible values:** Any date and time (before the `BeforeDate`) between the present and 24 months ago.\n\nThe date and time after which the report's transaction was created, based on the transaction's `CreationDate`.\n\n**Note:** The period between the `AfterDate` and the `BeforeDate` cannot exceed 12 months."},"BeforeDate":{"type":"integer","description":"**Possible values:** Any date and time (after the `AfterDate`) between the present and 24 months ago.\n\nThe date and time before which the report's transaction was created, based on the transaction's `CreationDate`.\n\n**Note:** The period between the `AfterDate` and the `BeforeDate` cannot exceed 12 months."},"Filters":{"$ref":"#/components/schemas/ReportResponseFilters","description":"The filters sent in the request. Different filters are available for each `ReportType`."},"Columns":{"type":"array","items":{"$ref":"#/components/schemas/ReportResponseColumnsItems"},"description":"**Possible values:** The columns listed in the [Reports](/reports) guide, which differ according to the report type.\n\n**Default values:** The default columns listed in the [Reports](/reports) guide, which differ according to the report type.\n\nThe data columns to be included in the report."}},"title":"ReportResponse"},"ListAllReportsResponseArrayReportsItemsObjectReports":{"type":"object","properties":{"Id":{"$ref":"#/components/schemas/Id"},"ReportType":{"$ref":"#/components/schemas/ReportType_Reporting_Response"},"Status":{"type":"string","description":"**Returned values:** `PENDING`, `READY_FOR_DOWNLOAD`, `FAILED`, `EXPIRED`\n\nThe status of the report:\n- `PENDING` – The report is being generated.\n- `READY_FOR_DOWNLOAD` – The report has been created, and can be downloaded.\n- `FAILED` – The report cannot be generated.\n- `EXPIRED` – The report was created, but is no longer available for download (it can be re-run to be downloaded again with fresh data)."},"LastUpdated":{"type":"integer","description":"Unix timestamp (UTC) of the date and time the object was updated."},"CreationDate":{"$ref":"#/components/schemas/CreationDate"},"Tag":{"type":"string","description":"Max. length: 255 characters\n\nCustom data that you can add to this object.\n\nFor reports, this parameter can be useful to give the report a name."},"ResultCode":{"$ref":"#/components/schemas/ResultCode"},"ResultMessage":{"$ref":"#/components/schemas/ResultMessage"}},"description":"Key data about the Reporting Service report object created by the platform.","title":"ListAllReportsResponseArrayReportsItemsObjectReports"},"ListAllReportsResponseArrayReportsItems":{"type":"object","properties":{"Object (reports)":{"$ref":"#/components/schemas/ListAllReportsResponseArrayReportsItemsObjectReports","description":"Key data about the Reporting Service report object created by the platform."}},"title":"ListAllReportsResponseArrayReportsItems"},"ListAllReportsResponse":{"type":"object","properties":{"Array (Reports)":{"type":"array","items":{"$ref":"#/components/schemas/ListAllReportsResponseArrayReportsItems"},"description":"The list of reports created by the platform."}},"title":"ListAllReportsResponse"},"BeforeDateAfterDateType":{"type":"object","properties":{"BeforeDate":{"type":"integer","description":"**Returned values:** Any date between today's date and 36 months in the past.\n\nThe date before which the transaction was created (based on the transaction's `CreationDate` parameter).\n\n**Caution:** The time range between the `BeforeDate` and the `AfterDate` cannot exceed 6 months."},"AfterDate":{"type":"integer","description":"The date after which the transaction was created (based on the transaction's `CreationDate` parameter).\n\n**Caution:** The time range between the `BeforeDate` and the `AfterDate` cannot exceed 6 months."},"Type":{"type":"array","items":{"type":"string"},"description":"The transaction types to be taken into account."},"ResultCode":{"type":"array","items":{"type":"string"},"description":"The transaction result codes to be taken into account."},"Status":{"type":"array","items":{"type":"string"},"description":"The transaction statuses to be taken into account."},"Nature":{"type":"array","items":{"type":"string"},"description":"**Returned values:** `REGULAR`, `REPUDIATION`, `REFUND`, `SETTLEMENT`\n\nThe transaction natures to be taken into account.\n- `REGULAR` – Relative to most of the transactions (pay-ins, payouts, and transfers) in a usual workflow.\n- `REPUDIATION` – Automatic withdrawal of funds from the platform's repudiation wallet as part of the dispute process (when the user has requested a chargeback).\n- `REFUND` – Reimbursement of a transaction to the user (pay-in refund), to a wallet (transfer refund), or of a payout (payout refund, only initiated by Mangopay).\n- `SETTLEMENT` – Transfer made to the repudiation wallet by the platform to settle a lost dispute."},"WalletId":{"type":"string","description":"The unique identifier of the wallet that is to be taken into account."},"AuthorId":{"$ref":"#/components/schemas/AuthorId"},"MinDebitedFundsAmount":{"type":"integer","description":"The debited funds amount above which the transactions are taken into account."},"MinDebitedFundsCurrency":{"type":"string","description":"**Returned values:** The three-letter <a href=\"/api-reference/overview/data-formats\" target=\"_blank\">ISO 4217 code</a> (EUR, GBP, etc.) of a <a href=\"/guides/currencies\" target=\"_blank\">supported currency</a> (depends on feature, contract, and activation settings).\n\nThe currency of the `MinDebitedFundsAmount` value."},"MaxDebitedFundsAmount":{"type":"integer","description":"The debited funds amount below which the transactions are taken into account."},"MaxDebitedFundsCurrency":{"type":"string","description":"**Returned values:** The three-letter <a href=\"/api-reference/overview/data-formats\" target=\"_blank\">ISO 4217 code</a> (EUR, GBP, etc.) of a <a href=\"/guides/currencies\" target=\"_blank\">supported currency</a> (depends on feature, contract, and activation settings).\n\nThe currency of the `MaxDebitedFundsAmount` value."},"MinFeesAmount":{"type":"integer","description":"The fees amount below which the transactions are taken into account."},"MinFeesCurrency":{"type":"string","description":"**Returned values:** The three-letter <a href=\"/api-reference/overview/data-formats\" target=\"_blank\">ISO 4217 code</a> (EUR, GBP, etc.) of a <a href=\"/guides/currencies\" target=\"_blank\">supported currency</a> (depends on feature, contract, and activation settings).\n\nThe currency of the `MinFeesAmount` value."},"MaxFeesAmount":{"type":"integer","description":"The fees amount above which the transactions are taken into account."},"MaxFeesCurrency":{"type":"string","description":"**Returned values:** The three-letter <a href=\"/api-reference/overview/data-formats\" target=\"_blank\">ISO 4217 code</a> (EUR, GBP, etc.) of a <a href=\"/guides/currencies\" target=\"_blank\">supported currency</a> (depends on feature, contract, and activation settings).\n\nThe currency of the `MaxFeesAmount` value."}},"description":"The filtering parameters to optimize the report.","title":"BeforeDateAfterDateType"},"CreateATransactionsReportRequest":{"type":"object","properties":{"Tag":{"$ref":"#/components/schemas/Tag"},"DownloadFormat":{"type":"string","description":"**Possible values:** `CSV`\n\nThe format of the report file."},"CallbackURL":{"type":"string","description":"Max. length: 255 characters\n\nThe URL to which the notification indicating that the report is ready to be downloaded will be sent."},"Sort":{"type":"string","description":"**Possible values:** `CreationDate:ASC`, `CreationDate:DESC`\n\n**Default value**: `CreationDate:ASC`\n\nThe sort direction based on transaction creation date."},"Preview":{"type":"boolean","description":"Whether the report is limited to the first 10 lines (and therefore quicker to generate)."},"Filters":{"$ref":"#/components/schemas/BeforeDateAfterDateType"},"Columns":{"type":"array","items":{"type":"string"},"description":"**Allowed values:** The `Columns` listed in the <a href=\"/reports\">Reports</a> article, which differ according to the report type.\n\nThe information to be included in the report."}},"title":"CreateATransactionsReportRequest"},"ReportType_Legacy_Response":{"type":"string","description":"**Returned values:** `TRANSACTIONS`, `WALLETS`\n\nThe type of the report, indicating whether it lists transactions or wallets.","title":"ReportType_Legacy_Response"},"CreateATransactionsReportResponse":{"type":"object","properties":{"Id":{"$ref":"#/components/schemas/Id"},"CreationDate":{"$ref":"#/components/schemas/CreationDate"},"Tag":{"$ref":"#/components/schemas/Tag"},"ReportDate":{"type":["integer","null"],"description":"Unix timestamp (UTC) of the date and time the report was generated."},"Status":{"type":"string","description":"**Returned values:** `PENDING`, `READY_FOR_DOWNLOAD`, `FAILED`, `EXPIRED`\n\nThe status of the report:\n- `PENDING` – The report is being generated.\n- `READY_FOR_DOWNLOAD` – The report has been created, and can be downloaded.\n- `FAILED` – The report cannot be generated.\n- `EXPIRED` – The report was created, but is no longer available for download (it can be re-run to be downloaded again with fresh data)."},"DownloadFormat":{"type":"string","description":"**Returned values:** `CSV`\n\nThe format in which the report is going to be downloaded."},"DownloadURL":{"type":["string","null"],"description":"The URL at which the report file can be downloaded when the `Status` is `GENERATED`."},"CallbackURL":{"type":"string","description":"Max. length: 255 characters\n\nThe URL to which the notification indicating that the report is ready to be downloaded will be sent."},"ReportType":{"$ref":"#/components/schemas/ReportType_Legacy_Response"},"Sort":{"type":"string","description":"The sorting direction of the CreationDate column. By default, the generated report is sorted by ascending creation date."},"Preview":{"type":"boolean","description":"Whether the report is limited to the first 10 lines (and therefore quicker to generate)."},"Filters":{"$ref":"#/components/schemas/BeforeDateAfterDateType"},"Columns":{"type":"array","items":{"type":"string"},"description":"**Returned values:** The `Columns` listed in the <a href=\"/reports\">Reports</a> article, which differ according to the report type.\n\nThe information to be included in the report."},"ResultCode":{"$ref":"#/components/schemas/ResultCode"},"ResultMessage":{"$ref":"#/components/schemas/ResultMessage"}},"title":"CreateATransactionsReportResponse"},"CreateAWalletsReportRequestFilters":{"type":"object","properties":{"BeforeDate":{"type":"integer","description":"The date before which the wallet was created (based on the wallet's `CreationDate` parameter).\n\n**Caution:** The time range between the `BeforeDate` and the `AfterDate` cannot exceed 24 months."},"AfterDate":{"type":"integer","description":"The date after which the wallet was created (based on the wallet's `CreationDate` parameter).\n\n**Caution:** The time range between the `BeforeDate` and the `AfterDate` cannot exceed 24 months."},"OwnerId":{"type":"string","description":"The unique identifier of the user owning the wallet."},"Currency":{"$ref":"#/components/schemas/Currency"},"MinBalanceAmount":{"type":"integer","description":"The balance amount above which the wallets are taken into account."},"MinBalanceCurrency":{"type":"string","description":"**Allowed values:** The three-letter <a href=\"/api-reference/overview/data-formats\" target=\"_blank\">ISO 4217 code</a> (EUR, GBP, etc.) of a <a href=\"/guides/currencies\" target=\"_blank\">supported currency</a> (depends on feature, contract, and activation settings).\n\nThe currency of the `MinBalanceAmount` value."},"MaxBalanceAmount":{"type":"integer","description":"The balance amount below which the wallets are taken into account."},"MaxBalanceCurrency":{"type":"string","description":"**Allowed values:** The three-letter <a href=\"/api-reference/overview/data-formats\" target=\"_blank\">ISO 4217 code</a> (EUR, GBP, etc.) of a <a href=\"/guides/currencies\" target=\"_blank\">supported currency</a> (depends on feature, contract, and activation settings).\n\nThe currency of the `MaxBalanceAmount` value."}},"description":"The filtering parameters to optimize the report.","title":"CreateAWalletsReportRequestFilters"},"CreateAWalletsReportRequest":{"type":"object","properties":{"Tag":{"$ref":"#/components/schemas/Tag"},"DownloadFormat":{"type":"string","description":"**Possible values:** `CSV`\n\nThe format of the report file."},"CallbackURL":{"type":"string","description":"Max. length: 255 characters\n\nThe URL to which the notification indicating that the report is ready to be downloaded will be sent."},"Sort":{"type":"string","description":"**Possible values:** `CreationDate:ASC`, `CreationDate:DESC`\n\n**Default value**: `CreationDate:ASC`\n\nThe sort direction based on transaction creation date."},"Preview":{"type":"boolean","description":"Whether the report is limited to the first 10 lines (and therefore quicker to generate)."},"Filters":{"$ref":"#/components/schemas/CreateAWalletsReportRequestFilters","description":"The filtering parameters to optimize the report."},"Columns":{"type":"array","items":{"type":"string"},"description":"**Allowed values:** The `Columns` listed in the <a href=\"/reports\">Reports</a> article, which differ according to the report type.\n\nThe information to be included in the report."}},"title":"CreateAWalletsReportRequest"},"CreateAWalletsReportResponseFilters":{"type":"object","properties":{"BeforeDate":{"type":"integer","description":"The date before which the wallet was created (based on the wallet's `CreationDate` parameter).\n\n**Caution:** The time range between the `BeforeDate` and the `AfterDate` cannot exceed 24 months."},"AfterDate":{"type":"integer","description":"The date after which the wallet was created (based on the wallet's `CreationDate` parameter).\n\n**Caution:** The time range between the `BeforeDate` and the `AfterDate` cannot exceed 24 months."},"OwnerId":{"type":"string","description":"The unique identifier of the user owning the wallet."},"Currency":{"type":"string","description":"**Returned values:** The three-letter <a href=\"/api-reference/overview/data-formats\" target=\"_blank\">ISO 4217 code</a> (EUR, GBP, etc.) of a <a href=\"/guides/currencies\" target=\"_blank\">supported currency</a> (depends on feature, contract, and activation settings).\n\nThe currency of the wallets to take into account."},"MinBalanceAmount":{"type":"integer","description":"The balance amount above which the wallets are taken into account."},"MinBalanceCurrency":{"type":"string","description":"**Returned values:** The three-letter <a href=\"/api-reference/overview/data-formats\" target=\"_blank\">ISO 4217 code</a> (EUR, GBP, etc.) of a <a href=\"/guides/currencies\" target=\"_blank\">supported currency</a> (depends on feature, contract, and activation settings).\n\nThe currency of the `MinBalanceAmount` value."},"MaxBalanceAmount":{"type":"integer","description":"The balance amount below which the wallets are taken into account."},"MaxBalanceCurrency":{"type":"string","description":"**Returned values:** The three-letter <a href=\"/api-reference/overview/data-formats\" target=\"_blank\">ISO 4217 code</a> (EUR, GBP, etc.) of a <a href=\"/guides/currencies\" target=\"_blank\">supported currency</a> (depends on feature, contract, and activation settings).\n\nThe currency of the `MaxBalanceAmount` value."}},"description":"The filtering parameters to optimize the report.","title":"CreateAWalletsReportResponseFilters"},"CreateAWalletsReportResponse":{"type":"object","properties":{"Id":{"$ref":"#/components/schemas/Id"},"CreationDate":{"$ref":"#/components/schemas/CreationDate"},"Tag":{"$ref":"#/components/schemas/Tag"},"ReportDate":{"type":["integer","null"],"description":"Unix timestamp (UTC) of the date and time the report was generated."},"Status":{"type":"string","description":"**Returned values:** `PENDING`, `READY_FOR_DOWNLOAD`, `FAILED`, `EXPIRED`\n\nThe status of the report:\n- `PENDING` – The report is being generated.\n- `READY_FOR_DOWNLOAD` – The report has been created, and can be downloaded.\n- `FAILED` – The report cannot be generated.\n- `EXPIRED` – The report was created, but is no longer available for download (it can be re-run to be downloaded again with fresh data)."},"DownloadFormat":{"type":"string","description":"**Returned values:** `CSV`\n\nThe format in which the report is going to be downloaded."},"DownloadURL":{"type":["string","null"],"description":"The URL at which the report file can be downloaded when the `Status` is `GENERATED`."},"CallbackURL":{"type":"string","description":"Max. length: 255 characters\n\nThe URL to which the notification indicating that the report is ready to be downloaded will be sent."},"ReportType":{"$ref":"#/components/schemas/ReportType_Legacy_Response"},"Sort":{"type":"string","description":"The sorting direction of the CreationDate column. By default, the generated report is sorted by ascending creation date."},"Preview":{"type":"boolean","description":"Whether the report is limited to the first 10 lines (and therefore quicker to generate)."},"Filters":{"$ref":"#/components/schemas/CreateAWalletsReportResponseFilters","description":"The filtering parameters to optimize the report."},"Columns":{"type":"array","items":{"type":"string"},"description":"**Returned values:** The `Columns` listed in the <a href=\"/reports\">Reports</a> article, which differ according to the report type.\n\nThe information to be included in the report."},"ResultCode":{"$ref":"#/components/schemas/ResultCode"},"ResultMessage":{"$ref":"#/components/schemas/ResultMessage"}},"title":"CreateAWalletsReportResponse"},"ReportResponseLegacy":{"type":"object","properties":{"Id":{"$ref":"#/components/schemas/Id"},"CreationDate":{"$ref":"#/components/schemas/CreationDate"},"Tag":{"$ref":"#/components/schemas/Tag"},"ReportDate":{"type":["integer","null"],"description":"Unix timestamp (UTC) of the date and time the report was generated."},"Status":{"type":"string","description":"**Returned values:** `PENDING`, `READY_FOR_DOWNLOAD`, `FAILED`, `EXPIRED`\n\nThe status of the report:\n- `PENDING` – The report is being generated.\n- `READY_FOR_DOWNLOAD` – The report has been created, and can be downloaded.\n- `FAILED` – The report cannot be generated.\n- `EXPIRED` – The report was created, but is no longer available for download (it can be re-run to be downloaded again with fresh data)."},"DownloadFormat":{"type":"string","description":"**Returned values:** `CSV`\n\nThe format in which the report is going to be downloaded."},"DownloadURL":{"type":["string","null"],"description":"The URL at which the report file can be downloaded when the `Status` is `GENERATED`."},"CallbackURL":{"type":"string","description":"Max. length: 255 characters\n\nThe URL to which the notification indicating that the report is ready to be downloaded will be sent."},"ReportType":{"$ref":"#/components/schemas/ReportType_Legacy_Response"},"Sort":{"type":"string","description":"The sorting direction of the CreationDate column. By default, the generated report is sorted by ascending creation date."},"Preview":{"type":"boolean","description":"Whether the report is limited to the first 10 lines (and therefore quicker to generate)."},"Filters":{"$ref":"#/components/schemas/BeforeDateAfterDateType"},"Columns":{"type":"array","items":{"type":"string"},"description":"**Returned values:** The `Columns` listed in the <a href=\"/reports\">Reports</a> article, which differ according to the report type.\n\nThe information to be included in the report."},"ResultCode":{"type":"array","items":{"type":"string"},"description":"The transaction result codes to be taken into account."},"ResultMessage":{"$ref":"#/components/schemas/ResultMessage"}},"title":"ReportResponseLegacy"},"ListAllReportsResponseLegacyArrayReportsItemsObjectReports":{"type":"object","properties":{"Id":{"$ref":"#/components/schemas/Id"},"CreationDate":{"$ref":"#/components/schemas/CreationDate"},"Tag":{"type":"string","description":"Max. length: 255 characters\n\nCustom data that you can add to this object.\n\nFor reports, this parameter can be useful to give the report a name."},"ReportDate":{"type":["integer","null"],"description":"Unix timestamp (UTC) of the date and time the report was generated."},"Status":{"type":"string","description":"**Returned values:** `PENDING`, `READY_FOR_DOWNLOAD`, `FAILED`, `EXPIRED`\n\nThe status of the report:\n- `PENDING` – The report is being generated.\n- `READY_FOR_DOWNLOAD` – The report has been created, and can be downloaded.\n- `FAILED` – The report cannot be generated.\n- `EXPIRED` – The report was created, but is no longer available for download (it can be re-run to be downloaded again with fresh data)."},"DownloadFormat":{"type":"string","description":"**Returned values:** `CSV`\n\nThe format in which the report is going to be downloaded."},"DownloadURL":{"type":["string","null"],"description":"The URL at which the report file can be downloaded when the `Status` is `GENERATED`."},"CallbackURL":{"type":"string","description":"Max. length: 255 characters\n\nThe URL to which the notification indicating that the report is ready to be downloaded will be sent."},"ReportType":{"$ref":"#/components/schemas/ReportType_Legacy_Response"},"Sort":{"type":"string","description":"The sorting direction of the CreationDate column. By default, the generated report is sorted by ascending creation date."},"Preview":{"type":"boolean","description":"Whether the report is limited to the first 10 lines (and therefore quicker to generate)."},"Filters":{"$ref":"#/components/schemas/BeforeDateAfterDateType"},"Columns":{"type":"array","items":{"type":"string"},"description":"**Returned values:** The `Columns` listed in the <a href=\"/reports\">Reports</a> article, which differ according to the report type.\n\nThe information to be included in the report."},"ResultCode":{"$ref":"#/components/schemas/ResultCode"},"ResultMessage":{"$ref":"#/components/schemas/ResultMessage"}},"description":"The Report object created by the platform.","title":"ListAllReportsResponseLegacyArrayReportsItemsObjectReports"},"ListAllReportsResponseLegacyArrayReportsItems":{"type":"object","properties":{"Object (Reports)":{"$ref":"#/components/schemas/ListAllReportsResponseLegacyArrayReportsItemsObjectReports","description":"The Report object created by the platform."}},"title":"ListAllReportsResponseLegacyArrayReportsItems"},"ListAllReportsResponseLegacy":{"type":"object","properties":{"Array (Reports)":{"type":"array","items":{"$ref":"#/components/schemas/ListAllReportsResponseLegacyArrayReportsItems"},"description":"The list of reports created by the platform."}},"title":"ListAllReportsResponseLegacy"},"UpdateAClientRequest":{"type":"object","properties":{"TechEmails":{"type":"array","items":{"type":"string"},"description":"Format: Emails must be ≤ 40 characters\n\nList of email addresses to contact the platform for technical matters. Important: If the email length exceeds 40 characters, it will be be impossible to process some payments."},"AdminEmails":{"type":"array","items":{"type":"string"},"description":"List of email addresses to contact the platform for administrative or commercial matters."},"BillingEmails":{"type":"array","items":{"type":"string"},"description":"List of email addresses to contact the platform for billing matters."},"FraudEmails":{"type":"array","items":{"type":"string"},"description":"List of email addresses to contact the platform for fraud and compliance matters."},"HeadquartersAddress":{"$ref":"#/components/schemas/Address_PlatformHeadquarters"},"HeadquartersPhoneNumber":{"type":"string","description":"Max. length: 15 characters; international telephone numbering plan E.164 (+ followed by the country code, then the number)\n\nThe phone number of the platform operator's headquarters."},"TaxNumber":{"type":"string","description":"The tax (or VAT) number for the company operating the platform."},"PlatformURL":{"type":"string","description":"The URL of the platform's website."},"PlatformDescription":{"type":"string","description":"Max. length: 2,000 characters\n\nThe description of what the platform does."},"PrimaryThemeColour":{"type":"string","description":"Hex color code\n\nThe color used in accent highlights and icon elements on Mangopay-hosted webpages, such as in [SCA customization](/guides/sca/factors#customization)."},"PrimaryButtonColour":{"type":"string","description":"Hex color code\n\nThe color used for call-to-action (CTA) buttons on Mangopay-hosted webpages, such as in [SCA customization](/guides/sca/factors#customization)."}},"title":"UpdateAClientRequest"},"UpdateAClientResponsePlatformCategorization":{"type":"object","properties":{"BusinessType":{"type":"string","description":"The business type of the platform."},"Sector":{"type":"string","description":"The sector of activity of the platform."}},"description":"The categorization of the platform in terms of business and sector of activity.","title":"UpdateAClientResponsePlatformCategorization"},"UpdateAClientResponse":{"type":"object","properties":{"PlatformType":{"type":"string","description":"Type of the platform. This field has been replaced by the `PlatformCategorization` object."},"ClientId":{"type":"string","description":"The unique identifier associated with the API key, giving access to either the Sandbox or Production environment."},"Name":{"type":"string","description":"The trading name of the company operating the platform."},"RegisteredName":{"type":"string","description":"The registered legal name of the company operating the platform."},"TechEmails":{"type":"array","items":{"type":"string"},"description":"Format: Emails must be ≤ 40 characters\n\nList of email addresses to contact the platform for technical matters. Important: If the email length exceeds 40 characters, it will be be impossible to process some payments."},"AdminEmails":{"type":"array","items":{"type":"string"},"description":"List of email addresses to contact the platform for administrative or commercial matters."},"BillingEmails":{"type":"array","items":{"type":"string"},"description":"List of email addresses to contact the platform for billing matters."},"FraudEmails":{"type":"array","items":{"type":"string"},"description":"List of email addresses to contact the platform for fraud and compliance matters."},"HeadquartersAddress":{"$ref":"#/components/schemas/Address"},"HeadquartersPhoneNumber":{"type":"string","description":"Max. length: 15 characters; international telephone numbering plan E.164 (+ followed by the country code, then the number)\n\nThe phone number of the platform operator's headquarters."},"TaxNumber":{"type":"string","description":"The tax (or VAT) number for the company operating the platform."},"PlatformCategorization":{"$ref":"#/components/schemas/UpdateAClientResponsePlatformCategorization","description":"The categorization of the platform in terms of business and sector of activity."},"PlatformURL":{"type":"string","description":"The URL of the platform's website."},"PlatformDescription":{"type":"string","description":"Max. length: 2,000 characters\n\nThe description of what the platform does."},"CompanyReference":{"type":"string","description":"The unique reference for the platform, which should be used when contacting Mangopay."},"PrimaryThemeColour":{"type":"string","description":"Hex color code\n\nThe color used in accent highlights and icon elements on Mangopay-hosted webpages, such as in [SCA customization](/guides/sca/factors#customization)."},"PrimaryButtonColour":{"type":"string","description":"Hex color code\n\nThe color used for call-to-action (CTA) buttons on Mangopay-hosted webpages, such as in [SCA customization](/guides/sca/factors#customization)."},"Logo":{"type":"string","description":"The URL of the platform's logo. Logos may be added by using the Upload a Client Logo endpoint."},"CompanyNumber":{"type":"string","description":"The registration number of the company operating the platform, assigned by the relevant national authority."},"MCC":{"type":"string","description":"4-digit merchant category code. The MCC is used to classify a business by the types of goods or services it provides."}},"title":"UpdateAClientResponse"},"client_upload_client_logo_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"client_upload_client_logo_Response_200"},"ClientResponsePlatformCategorization":{"type":"object","properties":{"BusinessType":{"type":"string","description":"The business type of the platform."},"Sector":{"type":"string","description":"The sector of activity of the platform."}},"description":"The categorization of the platform in terms of business and sector of activity.","title":"ClientResponsePlatformCategorization"},"ClientResponse":{"type":"object","properties":{"PlatformType":{"type":"string","description":"Type of the platform. This field has been replaced by the `PlatformCategorization` object."},"ClientId":{"type":"string","description":"The unique identifier associated with the API key, giving access to either the Sandbox or Production environment."},"Name":{"type":"string","description":"The trading name of the company operating the platform."},"RegisteredName":{"type":"string","description":"The registered legal name of the company operating the platform."},"TechEmails":{"type":"array","items":{"type":"string"},"description":"Format: Emails must be ≤ 40 characters\n\nList of email addresses to contact the platform for technical matters. Important: If the email length exceeds 40 characters, it will be be impossible to process some payments."},"AdminEmails":{"type":"array","items":{"type":"string"},"description":"List of email addresses to contact the platform for administrative or commercial matters."},"BillingEmails":{"type":"array","items":{"type":"string"},"description":"List of email addresses to contact the platform for billing matters."},"FraudEmails":{"type":"array","items":{"type":"string"},"description":"List of email addresses to contact the platform for fraud and compliance matters."},"HeadquartersAddress":{"$ref":"#/components/schemas/Address"},"HeadquartersPhoneNumber":{"type":"string","description":"Max. length: 15 characters; international telephone numbering plan E.164 (+ followed by the country code, then the number)\n\nThe phone number of the platform operator's headquarters."},"TaxNumber":{"type":"string","description":"The tax (or VAT) number for the company operating the platform."},"PlatformCategorization":{"$ref":"#/components/schemas/ClientResponsePlatformCategorization","description":"The categorization of the platform in terms of business and sector of activity."},"PlatformURL":{"type":"string","description":"The URL of the platform's website."},"PlatformDescription":{"type":"string","description":"Max. length: 2,000 characters\n\nThe description of what the platform does."},"CompanyReference":{"type":"string","description":"The unique reference for the platform, which should be used when contacting Mangopay."},"PrimaryThemeColour":{"type":"string","description":"Hex color code\n\nThe color used in accent highlights and icon elements on Mangopay-hosted webpages, such as in [SCA customization](/guides/sca/factors#customization)."},"PrimaryButtonColour":{"type":"string","description":"Hex color code\n\nThe color used for call-to-action (CTA) buttons on Mangopay-hosted webpages, such as in [SCA customization](/guides/sca/factors#customization)."},"Logo":{"type":"string","description":"The URL of the platform's logo. Logos may be added by using the Upload a Client Logo endpoint."},"CompanyNumber":{"type":"string","description":"The registration number of the company operating the platform, assigned by the relevant national authority."},"MCC":{"type":"string","description":"4-digit merchant category code. The MCC is used to classify a business by the types of goods or services it provides."},"Licensor":{"type":"string","description":"Possible values: `EU`, `UK`\n\nThe licensor of the platform's company account, indicating the Mangopay entity the platform contracted with:\n- `EU` – Mangopay S.A.\n- `UK` – Mangopay U.K. Ltd."}},"title":"ClientResponse"}},"securitySchemes":{"oauth2":{"type":"http","scheme":"bearer","description":"Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL."}}}}