Cet objet représente un destinataire qui recevra une partie d'un paiement fractionné. Il représente le compte d'un vendeur sur votre place de marché. Le partage vous permet de verser l'argent d'un achat sur votre place de marché directement sur le compte du vendeur, tandis que votre commission est versée sur votre compte de place de marché.
Attributs
id chaîne
L'identifiant unique du destinataire (MAX 64 ; MIN 36).
Example: 9104911d-5df9-429e-8488-ad41abea1a4b.
account_id chaîne
L'identifiant unique du compte (MAX 64 ; MIN 36).
Exemple : 4323f8a0-7699-4a5b-8293-f4d712312eb3bd.
merchant_recipient_id chaîne
L'identifiant unique du destinataire pour le propriétaire de la place de marché (MAX 255 ; MIN 3).
Exemple : AAAA01.
national_entity chaîne
Catégorie d'entité nationale du bénéficiaire. Il peut s'agir d'un INDIVIDU ou d'une ENTITÉ.
Exemple : INDIVIDUEL.
entity_type chaîne
Type d'entité nationale du bénéficiaire. Il peut s'agir d'une entité publique, gouvernementale, sans but lucratif ou privée.
Exemple : PRIVÉ.
first_name chaîne
Le prénom du destinataire (MAX 255 ; MIN 3).
Exemple : Jean.
last_name chaîne
Le nom de famille du destinataire (MAX 255 ; MIN 3).
Exemple : Doe.
legal_name chaîne
Nom du bénéficiaire. (Max : 80) Uniquement nécessaire lorsque l'entité nationale est ENTITY (MAX 64 ; MIN 36).
Exemple : Arcos dorados S.A.
email chaîne
L'e-mail du destinataire (MAX 255 ; MIN 3).
Exemple : [email protected].
date_of_birth chaîne
La date de naissance du destinataire au format AAAA-MM-JJ (MAX 10 ; MIN 10).
Exemple : 1990-02-28.
country enum
Le pays du destinataire (MAX 2 ; MIN 2 ; ISO 3166-1).
Valeurs possibles de l'énumération : Vérifier la liste des codes pays.
website chaîne
URL du site web du destinataire (MAX 255 ; MIN 3).
Exemple : https://www.my-site.com
industry chaîne
Secteur d'activité du destinataire (MAX 235 ; MIN 1) Pour plus d'informations, consultez la page de référence de la catégorie Secteur d'activité.
Exemple : VIRTUAL_GOODS
merchant_category_code chaîne
Code de la catégorie du commerçant (MAX 235 ; MIN 1).
Exemple : TTR
document objet
Spécifie l'objet document du destinataire, y compris son numéro et son type.
document_number chaîne
Le numéro de document du destinataire (MAX 40 ; MIN 3).
Exemple : 1093333333.
document_type enum
Le type de document du destinataire (MAX 6, MIN 2).
Valeurs possibles de l'énumération : consultez la référence des pays.
phone objet
Spécifie l'objet numéro de téléphone du destinataire.
country_code chaîne
Le code pays du téléphone du destinataire (MAX 3 ; MIN 2).
Exemple : 57.
number chaîne
Le numéro de téléphone du destinataire, sans l'indicatif du pays (MAX 32 ; MIN 1).
Exemple : 3132450765.
address objet
Spécifie l'objet adresse de facturation du destinataire.
address_line_1 chaîne
La ligne d'adresse de facturation principale du destinataire (MAX 255 ; MIN 3).
Exemple : Calle 34 # 56 - 78.
address_line_2 chaîne
La ligne d'adresse de facturation secondaire du destinataire (MAX 255 ; MIN 3).
Exemple : Apartamento 502, Torre I.
city chaîne
La ville considérée pour l'adresse de facturation (MAX 255 ; MIN 3).
Exemple : Bogota.
country enum
Le pays considéré pour l'adresse de facturation (MAX 2 ; MIN 2 ; ISO 3166-1).
Valeurs possibles de l'énumération : Vérifier la liste des codes pays.
state chaîne
État considéré pour l'adresse de facturation (MAX 255 ; MIN 3).
Exemple : Cundinamarca.
zip_code chaîne
Le code postal pris en compte pour l'adresse de facturation (MAX 11 ; MIN 4).
Exemple : 111111.
withdrawal_methods tableau d'objets
Une liste d'objets de méthodes de retrait ; chaque élément contient un objet banque.
bank struct
Coordonnées bancaires pour cette méthode de retrait.
code chaîne
Code de la banque (MAX 3 ; MIN 3).
Exemple : 246
branch chaîne
Succursale de la banque (MAX 3 ; MIN 3).
Exemple : 123
branch_digit chaîne
Chiffre de la succursale de la banque (MAX 1 ; MIN 1).
Exemple : 5
account chaîne
Numéro de compte bancaire du bénéficiaire (MAX 250 ; MIN 3).
Exemple : 1093333333
account_digit chaîne
Chiffre du compte bancaire du bénéficiaire (MAX 1 ; MIN 1).
Exemple : 7
account_type enum
Type de compte bancaire du bénéficiaire : CHECKINGS ou SAVINGS.
Exemple : ÉPARGNE
routing chaîne
Numéro d'acheminement du compte bancaire du bénéficiaire.
Exemple : 021000021
country chaîne
Le pays du compte bancaire (ISO 3166-1 alpha-2).
Exemple : LE CO
currency chaîne
La devise du compte bancaire (ISO 4217).
Exemple : COP
documentation tableau d'objets
Un tableau d'objets de documentation fournis par le commerçant.
file_name chaîne
Le nom de la documentation envoyée (MAX 255 ; MIN 3).
Exemple : receipt.pdf
Exemple : receipt.pdf
content_type enum
Le type de documentation envoyée par le commerçant.
Exemple : RECEPTION
Exemple : RECEPTION
content_category chaîne
Catégorie de la documentation envoyée par le commerçant (par exemple, INVOICE, ID_PROOF).
content chaîne
Le contenu de la documentation encodé en base64 (Taille maximale : 1MB).
Exemple:JVBERi0xLjQKJcfs...
Exemple:JVBERi0xLjQKJcfs...
onboardings tableau d'objets
Liste des enregistrements d'intégration pour chaque connexion de fournisseur.
id enum
L'identificateur unique de l'enregistrement.
Exemple: 9104911d-5df9-429e-8488-ad41abea1a4b
type enum
Type d'intégration. S'il a été effectué précédemment ou par l'intermédiaire de Yuno.
PRÉCÉDEMMENT EMBARQUÉS, EMBARQUÉS VERS LE FOURNISSEUR
workflow enum
Workflow de l'onboarding.
HÉBERGÉ_PAR_FOURNISSEUR, HÉBERGÉ_PAR_YUNO, DIRECT
status enum
Statut de la vinculation avec le commerçant.
PENDING, SUCCEEDED, DECLINED, BLOQUÉ, ANNULÉ, REJECTED, ERROR
provider_response_code chaîne
Code de réponse renvoyé par le fournisseur lors de l'intégration.
Exemple : 00
provider_response_message chaîne
Message descriptif du fournisseur associé à la réponse d'intégration.
Exemple : Approuvé
provider_raw_response chaîne
Référence à la réponse brute complète du fournisseur. Utilisez cet identifiant pour récupérer la charge utile complète lorsque cela est nécessaire.
Exemple : 64b3f8cba12e3c7d9f0a1234
callback_url chaîne
URL pour rediriger votre client après le processus d'onboarding, si nécessaire.
Exemple : https://www.google.com
provider objet
Informations sur la connexion du prestataire de paiement.
id chaîne
Identifiant du prestataire.
Exemple : ADYEN
connection_id chaîne
L'identifiant de connexion Yuno spécifique associé à cette intégration.
Exemple : 322d48b6-f423-4438-8ffb-0b9b5059a2e9
recipient_id chaîne
L'identifiant unique du destinataire du prestataire.
Exemple: 9104911d-5df9-429e-8488-ad41abea1a4b
redirect_url chaîne
URL de redirection vers laquelle l'utilisateur final sera redirigé une fois l'intégration terminée.
Exemple : https://www.example.com/callback
onboarding_url chaîne
URL pour rediriger votre destinataire afin de finaliser l'onboarding.
Exemple : https://www.provider.com/onboarding
legal_entity chaîne
Identifiant de l'entité juridique associé au fournisseur.
recipient_additional_id chaîne
Informations supplémentaires concernant le destinataire. Généralement, l'identifiant de la personne morale.
balance_account_id chaîne
Identifiant unique du compte de solde du fournisseur.
documentation tableau d'objets
Un tableau d'objets de documentation fournis par le commerçant.
file_name chaîne
Le nom de la documentation envoyée (MAX 255 ; MIN 3).
Exemple : receipt.pdf
content_type enum
Le type de documentation envoyée par le commerçant.
Exemple : RECEPTION
content_category chaîne
La catégorie de la documentation envoyée par le commerçant.
content chaîne
Le contenu de la documentation encodé en base64 (Taille maximale : 1MB).
Exemple : JVBERi0xLjQKJcfs...
withdrawal_methods tableau d'objets
Une liste d'objets de méthodes de retrait ; chacun d'entre eux contient un objet bank struct.
bank struct.
bank struct
Coordonnées bancaires pour cette méthode de retrait.
code chaîne
Code de la banque (MAX 3 ; MIN 3).
Exemple : 246
branch chaîne
Succursale de la banque (MAX 3 ; MIN 3).
Exemple : 123
branch_digit chaîne
Chiffre de l'agence de la banque (MAX 3 ; MIN 3).
Exemple : 5
account chaîne
Numéro de compte bancaire du bénéficiaire (MAX 250 ; MIN 3).
Exemple : 1093333333
account_digit chaîne
Chiffre du compte bancaire du bénéficiaire (MAX 250 ; MIN 1).
Exemple : 7
account_type enum
Type de compte bancaire du bénéficiaire : CHECKINGS, SAVINGS
Exemple : ÉPARGNE
created_at timestamp
Date de création de l'onboarding (ISO 8601).
Exemple: 2022-05-09T20:46:54.786342Z
updated_at timestamp
Date de la dernière mise à jour de l'onboarding (ISO 8601).
Example: 2022-07-09T20:43:54.786342Z
created_at timestamp
Date et heure de création du destinataire (MAX 27 ; MIN 27 ; ISO 8601).
Example: 2022-05-09T20:46:54.786342Z.
updated_at timestamp
Date et heure de la dernière mise à jour du destinataire (MAX 27 ; MIN 27 ; ISO 8601).
Example: 2022-05-09T20:46:54.786342Z.