Lire la liste des transactions

Lire la liste des transactionsServer-sideAdmin

get/merchants/{merchant_id}/reports/transactions/registry.{format}

Renvoie une liste d'informations détaillées sur les transactions réussies et annulées pour une période donnée. Vous recevrez des informations sur les paiements, les frais, les taxes, les commandes et les utilisateurs. La liste est fournie au format JSON ou CSV. Cet appel API convient pour effectuer un rapprochement financier.

Remarque

Cet appel API ne contient pas le paramètre de chemin project_id, vous devez donc utiliser la clé API valide dans tous les projets de l'entreprise pour l'autorisation.

SecuritybasicAuth

Request

path Parameters

merchant_id required	integer ID de commerçant.
format required	string Format de données. Enum: "json" "csv" "xls"

query Parameters

datetime_from

required

string <datetime>

Début de la période au format AAAA-MM-JJ. Non requis si le paramètre limit est passé.

Example: datetime_from=2023-02-08

datetime_to

required

string <datetime>

Fin de la période au format AAAA-MM-JJ. Non requis si le paramètre limit est passé. Assurez-vous que la différence entre datetime_from et datetime_to ne dépasse pas 92 jours.

Example: datetime_to=2023-03-08

in_transfer_currency

required

integer

Convertit toutes les données financières dans la devise de virement (la devise de paiement est utilisée par défaut).

show_total

required

boolean

Ajoute des totaux au rapport.

merchant_of_records

string or null

Merchant of Record. La valeur peut être xsolla, merchant ou ne pas être spécifiée. Si merchant, renvoie les transactions effectuées via les passerelles du partenaire. Si xsolla, renvoie les transactions effectuées sans passer par les passerelles du partenaire. Si elle n'est pas spécifiée, toutes les transactions sont renvoyées.

Enum:	Description
merchant	Renvoie les transactions effectuées via les passerelles du partenaire.
xsolla	Renvoie les transactions effectuées sans passer par les passerelles du partenaire.

project_id

integer

ID de projet.

show_dry_run

boolean

Détermine l'inclusion des transactions test.

transfer_id

integer

ID de virement.

report_id

integer

ID de rapport financier.

offset

integer

Numéro de l'élément à partir duquel la liste est générée (le décompte commence à 0).

limit

integer

Limite du nombre de transactions affichées sur la page. Si ce paramètre est passé, les paramètres datetime_from et datetime_to ne sont plus requis.

status

string

Statut de transaction.

Enum: "done" "canceled" "error"

Responses

200

Liste des transactions renvoyée avec succès.

Request samples

Response samples

application/json

[{"payment_details": {"chargebackPenalty": {"amount": 0
},
"commission_agent": {"amount": 0,
"percent": 0
},
"commission_agent_fixed": 0,
"commission_ps": {"amount": 0,
"fixed_amount": 0,
"percent": 0
},
"commission_ps_from_vat": {"amount": 0
},
"commission_user": {"amount": 0.01,
"percent": 33.33
},
"commission_xsolla": {"amount": 0,
"fixed_amount": 0,
"percent": 5
},
"cpa_network_commission": {"amount": 0,
"percent": 0
},
"direct_wht": {"amount": 0,
"percent": 0
},
"payment": {"amount": 0.03,
"amount_from_ps": 0,
"currency": "USD"
},
"payout": {"amount": 0.02,
"amount_from_ps": 0,
"currency": "RUB",
"fx_rate": 64.1386407767,
"percent": 100
},
"refundPenalty": {"amount": 0
},
"repatriation_costs": {"amount": 0,
"percent": 0
},
"sales_tax": {"amount": 0,
"percent": 0
},
"vat": {"amount": 0,
"percent": 0,
"user_amount": 0,
"user_percent": 0
}
},
"purchase": {"friend": {"email": null,
"user_id": null
},
"items_amount": 1,
"pin_codes": {"amount": null,
"content": null,
"currency": null
},
"purchase_amount": 0.02,
"simple_checkout": {"amount": null,
"currency": null
},
"subscription": {"name": null,
"plan_id": null,
"product_id": null,
"product_name": null,
"subscription_id": null
},
"virtual_currency": {"amount": 0.02,
"currency": "USD"
},
"virtual_currency_amount": 1,
"virtual_items": {"amount": null,
"content": null,
"currency": null
}
},
"transaction": {"custom_parameters": null,
"direct_account": 0,
"dry_run": 0,
"external_id": null,
"id": 418756634,
"payment_method": {"class": "Digital Payment Methods",
"id": 2760,
"name": "Your Balance"
},
"project": {"id": 21092,
"name": "Smith"
},
"refund_reason": null,
"refund_reason_comment": null,
"status": "done",
"transfer_date": "2019-02-11T13:32:00+03:00"
},
"user": {"country": "US",
"custom": null,
"email": "email@example.com",
"id": "smith123",
"ip": "209.11.22.33",
"marketplace": "Pay Station",
"name": "Tom",
"phone": null
},
"user_balance": {"payment_currency": {"deduction_amount": 0,
"payout_amount_from_balance": 0.02,
"purchase_amount_from_balance": 0.02
}
}
}
]