Sign in

v1

latestOpenAPI 3.1.02026-07-245361280.3 KB
Transfers

Cancel a transfer

This service can be used to cancel a transfer.

put/v2/transfers/{id}/cancel

Path parameters

idstring required
Example:TF-a47f44c3-c115-4ddc-bd3d-900640bd33f4

dLocal transfer ID.

Response

OK

idstring

dLocal transfer ID.

originstring

Origin account ID.

destinationstring

Destination account ID.

amountnumber

Transfer amount to be sent to destination.

currencystring

Currency of the transfer amount.

release_datestring date-time

Release date when the transfer will be executed. ISO-8601 - Notification’s timestamp (YYYY-MM-DDTHH:mm:ss.SSSSZ).

transaction_idstring

Transaction ID related to the transfer. This will only appear if the transfer is related to a split payment.

external_idstring

ID given by the merchant in their system.

descriptionstring

Transfer description.

created_datestring date-time

Transfer creation’s timestamp. ISO-8601 - Notification’s timestamp (YYYY-MM-DDTHH:mm:ss.SSSSZ).

notification_urlstring

URL where dLocal will send notifications associated with the transfer.

statusstring

Transfer status. <br><br> See details.

status_codenumber

Transfer status code. <br><br> See details.

typestring

The type of transaction. <br><br> Possible values: INSTANT or SCHEDULED.

last_updated_datestring date-time

Transfer last modification's timestamp (YYYY-MM-DDTHH:mm:ss).

Example response

{
  "id": "TF-a47f44c3-c115-4ddc-bd3d-900640bd33f4",
  "origin": "AC-d907f733-5e17-4470-b963-c2ac2c11a440",
  "destination": "AC-303ccbd43-f346-4365-a245-910aeafea032",
  "amount": 120000,
  "currency": "BRL",
  "release_date": "2023-12-15T00:00:00.000Z",
  "transaction_id": "T-244010-7327bbff-7153-4349-8782-6e32bdcfaf6f",
  "external_id": "e043ca72-3530-4c2f-8458-99d89f1f2d8a",
  "description": "Platform commission",
  "created_date": "2021-07-12T13:07:08.000Z",
  "notification_url": "https://marketplace.com/notifications",
  "status": "CANCELED",
  "status_code": 500,
  "type": "SCHEDULED",
  "last_updated_date": "2023-12-15T00:00:00.000Z"
}