HomeGuidesAPI ReferenceStatus Page
API Reference

The Refund Object

PropertyTypeDescription
idStringThe refund ID.
payment_idStringThe payment ID.
amount Positive FloatThe amount of the refund. Always in local currency.
amount_refundedPositive FloatAmount received by the end user. Always in local currency.
currencyStringThe currency code of the refund.
statusStringThe status of the refund.
status_codeStringThe status code of the refund.
status_detailStringThe status detail.
created_dateStringThe date of when the refund was executed.
notification_urlStringURL where dLocal will send notifications associated to changes in this refund.
descriptionStringDescription of the refund.
bankStringUser's bank name.
bank_accountStringUser's bank account number.
bank_account_typeStringType of bank account. C: for Current accounts; S: for Savings accounts; I: International accounts.
bank_branchStringUser's bank branch name.
order_idStringID of the payment, given by the merchant in their system.

© 2024 DLOCAL. ALL RIGHTS RESERVED

Dlocal LLP (Company Number UK OC413287) is a limited liability partnership incorporated in England and Wales. DLocal Limited (Company Registration Number C77538) is authorised by the Malta Financial Services Authority under the Financial Institutions Act for the issuance of electronic money and the provision of payment services. Dlocal Corp LLP (Company Number UK OC 424987) is registered as a Money Service Business (MSB) with Financial Crime Enforcement Network in United States of America (USA) under MSB Registration Numbers 31000193620515. Dlocal Corp LLP acts as agent of e-commerce merchants based in the USA, and collects payments from end users based in emerging markets, on behalf of the merchants.