Transfer funds while managing the entities to transfer money to recoup funds from a seller, return money from a refund or to make up the difference when running a promotion.
Initiate a transfer of funds from source entity to destination entity.
The details of the transfer.
Transfer successfully created.
Bad Request
Unauthorized
Invalid data was sent
{- "reference": "superhero1234",
- "transfer_type": "commission",
- "source": {
- "id": "ent_azsiyswl7bwe2ynjzujy7lcjca",
- "amount": 100,
- "currency": "GBP"
}, - "destination": {
- "id": "ent_w4jelhppmfiufdnatam37wrfc4"
}
}{- "id": "tra_y3oqhf46pyzuxjbcn2giaqnb4",
- "status": "pending",
- "_links": {
}
}Retrieve transfer details using the transfer identifier.
Transfer found
Bad Request
Unauthorized
Transfer not found
Invalid data was sent
// For more information please refer to https://github.com/checkout/checkout-sdk-net using Checkout.Transfers; ICheckoutApi api = CheckoutSdk.Builder().OAuth() .ClientCredentials("client_id", "client_secret") .Scopes(OAuthScope.Transfers) .Environment(Environment.Sandbox) .EnvironmentSubdomain("{prefix}") // Your base URL's {prefix} value is unique to your account and environment. To learn how to retrieve your base URLs for the sandbox and production environments, see https://www.checkout.com/docs/developer-resources/api/api-endpoints. .HttpClientFactory(new DefaultHttpClientFactory()) .Build(); CreateTransferRequest createTransferRequest = new CreateTransferRequest { Source = new TransferSourceRequest {Amount = 100, Id = "entity_source_id"}, Destination = new TransferDestinationRequest {Id = "entity_destination_id"}, TransferType = TransferType.Commission }; try { TransferDetailsResponse transferDetailsResponse = await api.TransfersClient().RetrieveATransfer("transfer_id"); } catch (CheckoutApiException e) { // API error string requestId = e.RequestId; var statusCode = e.HttpStatusCode; IDictionary<string, object> errorDetails = e.ErrorDetails; } catch (CheckoutArgumentException e) { // Bad arguments } catch (CheckoutAuthorizationException e) { // Invalid authorization }
{- "id": "tra_y3oqhf46pyzuxjbcn2giaqnb4",
- "reference": "superhero1234",
- "status": "rejected",
- "transfer_type": "commission",
- "requested_on": "2021-12-15T09:15:02.3845763Z",
- "reason_codes": [
- "destination_transfers_capability_disabled",
- "source_and_destination_currency_accounts_must_be_different"
], - "source": {
- "entity_id": "ent_azsiyswl7bwe2ynjzujy7lcjca",
- "amount": 100,
- "currency": "GBP"
}, - "destination": {
- "entity_id": "ent_bqik7gxoavwhmy3ot6kvmbx6py"
}, - "_links": {
}
}