Cet objet représente le paiement créé après avoir généré une transaction pour transférer des fonds de votre compte vers un autre compte ou un autre destinataire.
id chaîne
L'identifiant unique du paiement (MAX 64 ; MIN 36).
Exemple : 5404911d-5df9-429e-8488-ad41abea1a4b
account_id chaîne
L'identifiant unique du compte (MAX 64 ; MIN 36).
Example: 2404911d-5df9-429e-8488-ad41abea1a4b
status enum
Le statut du paiement (MAX 255 ; MIN 3).
Exemple : SUCCÈS
merchant_reference chaîne
L'identifiant unique de la commande du client (MAX 255 ; MIN 3).
Exemple : 4234
description chaîne
Description du paiement (MAX 255 ; MIN 3).
Exemple : paiement sur le marché
purpose enum
Indique l'objet du paiement.
Valeurs possibles de l'énumération : Vérifier la liste des objectifs.
country enum
Pays où la transaction doit être traitée (MAX 2 ; MIN 2 ; ISO 3166-1).
Valeurs possibles : Voir la référence du pays.
amount objet
Spécifie l'objet montant du paiement, avec la valeur et la devise.
value nombre
Le montant du paiement (multiple de 0,0001).
Exemple : 10000
currency enum
La devise utilisée pour effectuer le paiement (MAX 3 ; MIN 3 ; ISO 4217).
Valeurs possibles : Voir la référence du pays.
beneficiary objet
Spécifie l'objet bénéficiaire avec son identification.
merchant_beneficiary_id chaîne
Identifiant unique du bénéficiaire défini par le commerçant.
Exemple : AAAA01
national_entity enum
Type d'entité nationale du bénéficiaire.
Valeurs possibles : INDIVIDUAL ou ENTITY
first_name chaîne
Prénom du bénéficiaire (MAX 80 ; MIN 1).
Exemple : John
last_name chaîne
Nom de famille du bénéficiaire (MAX 80 ; MIN 1).
Exemple : Doe
legal_name chaîne
Nom du bénéficiaire (Max : 80). Nécessaire uniquement lorsque national_entity est
ENTITY.
Exemple : Arcos dorados S.A.
email chaîne
email du bénéficiaire (MAX 255 ; MIN 3).
Exemple : [email protected]
country enum
Pays du bénéficiaire (MAX 2 ; MIN 2 ; ISO 3166-1).
Valeurs possibles : Voir la référence du pays.
date_of_birth date
La date de naissance du bénéficiaire au format AAAA-MM-JJ (MAX 10 ; MIN 10).
Exemple : 1990-02-28
document objet
Spécifie l'objet du document du bénéficiaire, y compris son numéro et son type.
document_number chaîne
Le numéro de document du bénéficiaire (MAX 40 ; MIN 3).
Exemple : 1093333333
document_type enum
Le type de document du bénéficiaire (MAX 6, MIN 2).
Valeurs possibles de l'énumération : Vérifier la référence du pays.
phone objet
Spécifie l'objet numéro de téléphone du bénéficiaire.
country_code chaîne
Le code d'appel du pays du téléphone du bénéficiaire (MAX 3 ; MIN 1). Valeurs possibles : Vérifier le
Référence des pays.
Exemple : 57
number chaîne
Le numéro de téléphone du bénéficiaire, sans l'indicatif du pays (MAX 32 ; MIN 1).
Exemple : 3132450765
address objet
Spécifie l'objet adresse du bénéficiaire.
address_line_1 chaîne
Ligne d'adresse principale du bénéficiaire (MAX 255 ; MIN 3).
Exemple : Calle 34 # 56 - 78
address_line_2 chaîne
Ligne d'adresse secondaire du bénéficiaire (MAX 255 ; MIN 3).
Exemple : Apartamento 502, Torre I
city chaîne
La ville considérée pour l'adresse du bénéficiaire (MAX 255 ; MIN 3).
Exemple : Bogota
country enum
Le pays de l'adresse du bénéficiaire (MAX 2 ; MIN 2 ; ISO 3166-1).
Valeurs possibles : Voir la référence du pays.
state chaîne
L'adresse de l'État ou de la province du bénéficiaire (MAX 255 ; MIN 3).
Exemple : Cundinamarca
zip_code chaîne
Le code postal considéré pour l'adresse du bénéficiaire (MAX 11 ; MIN 4).
Exemple : 111111
withdrawal_method objet
Spécifie l'objet withdrawal_method du bénéficiaire.
type enum
Le type de méthode de retrait.
Exemple : ASTROPAY_WALLET
provider_id enum
Le fournisseur avec lequel le paiement doit être traité.
Exemple : ASTROPAY
vaulted_token chaîne
Le vaulted_token représente une méthode de paiement stockée en toute sécurité. Principalement pour les cartes de crédit/débit dans les paiements.
Exemple : 41032411d-5df9-429e-1238-ad41abea1cft
original_transaction_id chaîne
Id de l'opération de paiement référencée. Uniquement pour les paiements à la CARTE. (MAX 64 ; MIN 36).
Exemple: 9104911d-5df9-429e-8488-ad41abea1a4b
on_hold bool
Définit si le marchand souhaite conserver le paiement et le traiter ultérieurement à l'aide du endpoint Release payout. Faux par défaut.
Exemple : faux
detail objet
Spécifie les détails de la méthode de retrait.
bank_transfer objet
Spécifie l'objet withdrawal_method du bénéficiaire.
code chaîne
Code de l'institution financière du bénéficiaire (MAX 3 ; MIN 3).
Exemple : 246
branch chaîne
La branche spécifique de l'institution financière du bénéficiaire (MAX 3 ; MIN 3).
Exemple : XXX
branch_digit chaîne
Chiffre de la succursale de l'institution financière du bénéficiaire (MAX 3 ; MIN 3).
Exemple : 123
account objet
Spécifie l'objet de compte bank_transfer du bénéficiaire.
number chaîne
Numéro de compte de l'institution financière du bénéficiaire ou alias de compte de l'institution financière, tel que Clabe
pour MX (MAX 255 ; MIN 3).
Exemple : 1093333333
digit chaîne
Chiffre du compte de l'institution financière du bénéficiaire (MAX 3 ; MIN 1).
Exemple : 123
type enum
Type de compte du bénéficiaire (MAX 255 ; MIN 3).
Valeurs possibles : CHECKINGS, SAVINGS, VISTA,
PIX_EMAIL, PIX_PHONE, PIX_DOCUMENT_ID,
PIX_BANK_ACCOUNT
address objet
Spécifie l'objet adresse du bénéficiaire.
address_line_1 chaîne
Ligne d'adresse principale du bénéficiaire (MAX 255 ; MIN 3).
Exemple : Calle 34 # 56 - 78
address_line_2 chaîne
Ligne d'adresse secondaire du bénéficiaire (MAX 255 ; MIN 3).
Exemple : Apartamento 502, Torre I
city chaîne
La ville considérée pour l'adresse du bénéficiaire (MAX 255 ; MIN 3).
Exemple : Bogota
country enum
Le pays de l'adresse du bénéficiaire (MAX 2 ; MIN 2 ; ISO 3166-1).
Valeurs possibles : Voir la référence du pays.
state chaîne
L'adresse de l'État ou de la province du bénéficiaire (MAX 255 ; MIN 3).
Exemple : Cundinamarca
zip_code chaîne
Le code postal considéré pour l'adresse du bénéficiaire (MAX 11 ; MIN 4).
Exemple : 111111
wallet objet
Spécifie l'objet withdrawal_method du bénéficiaire.
code chaîne
Le code portefeuille du bénéficiaire (MAX 3 ; MIN 3).
Exemple : 246
email chaîne
L'email spécifique du bénéficiaire (MAX 3 ; MIN 3).
Exemple : [email protected]
country enum
Pays du portefeuille du bénéficiaire (MAX 2 ; MIN 2 ; ISO 3166-1).
Valeurs possibles : Voir la référence du pays.
document objet
Spécifie l'objet du document du bénéficiaire, y compris son numéro et son type.
document_number chaîne
Le numéro de document du bénéficiaire (MAX 40 ; MIN 3).
Exemple : 1093333333
document_type enum
Le type de document du bénéficiaire (MAX 6, MIN 2).
Valeurs possibles de l'énumération : Vérifier la référence du pays.
phone objet
Spécifie l'objet numéro de téléphone du bénéficiaire.
country_code chaîne
Le code d'appel du pays du téléphone du bénéficiaire (MAX 3 ; MIN 1). Valeurs possibles : Vérifier le
Référence des pays.
Exemple : 57
number chaîne
Le numéro de téléphone du bénéficiaire, sans l'indicatif du pays (MAX 32 ; MIN 1).
Exemple : 3132450765
transactions tableau d'objets
Spécifie une liste d'objets de paiement.
id chaîne
L'identifiant unique de l'intention de paiement (MAX 64 ; MIN 36).
Exemple: 9104911d-5df9-429e-8488-ad41abea1a4b
type enum
Le type d'intention de paiement (MAX 255 ; MIN 3).
status enum
Le statut de l'intention de paiement (MAX 255 ; MIN 3).
response_code enum
Le code de réponse indique le statut de la demande d'intention de paiement (MAX 255 ; MIN 3).
merchant_reference chaîne
L'identification de la transaction de paiement définie par le commerçant (MAX 255 ; MIN 3).
Exemple : AAB01-432245
amount objet
Spécifie l'objet montant du paiement, avec la valeur et la devise.
value nombre
Le montant du paiement (multiple de 0,0001).
Exemple : 10000
currency enum
La devise utilisée pour effectuer le paiement (MAX 3 ; MIN 3 ; ISO 4217).
Valeurs possibles : Voir la référence du pays.
purpose enum
Spécifie l'objet du paiement.
description chaîne
Description du paiement (MAX 255 ; MIN 3).
Exemple : Salaire
provider_data objet
Spécifie le fournisseur de données.
id enum
L'identification du fournisseur de données.
Valeurs possibles : ADDI, MERCADO_PAGO, SPINPAY,
WOMPI
transaction_id chaîne
L'identifiant unique du paiement du prestataire.
Exemple : 12345678
account_id chaîne
L'identifiant du compte du prestataire de paiement du commerçant.
Exemple : 9990128
status chaîne
Statut de la transaction par le prestataire (MAX 255 ; MIN 3).
Exemple : accrédité
status_detail chaîne
Statut détaillé de la transaction par le fournisseur de données (MAX 255 ; MIN 3).
Exemple : approuvé
raw_response chaîne
La réponse brute du fournisseur de données. Le format dépend de la réponse du fournisseur.
La réponse varie d'un fournisseur de données à l'autre.
created_at timestamp
Date de création des transactions (MAX 27 ; MIN 27, ISO
8601).
Exemple: 2022-05-09T20:46:54.786342Z
updated_at timestamp
Date de la dernière mise à jour des transactions (MAX 27 ; MIN 27, ISO
8601).
Exemple: 2022-05-09T20:46:54.786342Z
metadata tableau d'objets
Spécifie une liste de paires clé-valeur personnalisées associées au paiement (pour les références internes, le rapprochement ou les balises de flux de travail). Vous pouvez ajouter jusqu'à 50 objets de métadonnées.
metadata object objet
Spécifie une clé de métadonnées et la valeur correspondante.
A utiliser pour attacher un contexte défini par le commerçant (par exemple : batch_id, payout_reason). Évitez d'envoyer des données sensibles ou personnelles.
batch_id, payout_reason). Évitez d'envoyer des données sensibles ou personnelles.key chaîne
Clé de métadonnées (MAX 48 ; MIN 1).
Exemple : order_id
value chaîne
Valeur de la clé de métadonnées (MAX 512 ; MIN 1).
Exemple : AA001
created_at timestamp
Date de création des transactions (MAX 27 ; MIN 27, ISO 8601).
Exemple: 2022-05-09T20:46:54.786342Z
updated_at timestamp
Date de la dernière mise à jour des transactions (MAX 27 ; MIN 27, ISO
8601).
Exemple: 2022-05-09T20:46:54.786342Z