Skip to content

Latest commit

 

History

History
120 lines (88 loc) · 4.09 KB

TransfersApi.md

File metadata and controls

120 lines (88 loc) · 4.09 KB
Raw

TransfersApi

All URIs are relative to https://balanceplatform-api-test.adyen.com/btl/v4

Method HTTP request Description
postTransfers POST /transfers Transfer funds
postTransfersIdReturns POST /transfers/{id}/returns Return a transfer

postTransfers

Transfer postTransfers(wwWAuthenticate, transferInfo)

Transfer funds

>Versions 1 and 2 of the Transfers API are deprecated. If you are just starting your implementation, use the latest version. Starts a request to transfer funds to balance accounts, transfer instruments, or third-party bank accounts. Adyen sends the outcome of the transfer request through webhooks. To use this endpoint, you need an additional role for your API credential and transfers must be enabled for the source balance account. Your Adyen contact will set these up for you.

Example

// Import classes:
//import com.adyen.client.infrastructure.*
//import com.adyen.model.transfers.*

val apiInstance = TransfersApi()
val wwWAuthenticate : kotlin.String = SCA realm="Transfer" auth-param1="eyJjaGFsbGVuZ2UiOiJiVlV6ZW5wek0waFNl..." // kotlin.String | Header for authenticating through SCA
val transferInfo : TransferInfo =  // TransferInfo | 
try {
    val result : Transfer = apiInstance.postTransfers(wwWAuthenticate, transferInfo)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling TransfersApi#postTransfers")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling TransfersApi#postTransfers")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
wwWAuthenticate kotlin.String Header for authenticating through SCA [optional]
transferInfo TransferInfo [optional]

Return type

Transfer

Authorization

Configure ApiKeyAuth: ApiClient.apiKey["X-API-Key"] = "" ApiClient.apiKeyPrefix["X-API-Key"] = "" Configure BasicAuth: ApiClient.username = "" ApiClient.password = ""

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

postTransfersIdReturns

ReturnTransferResponse postTransfersIdReturns(id, returnTransferRequest)

Return a transfer

Returns previously transferred funds without creating a new `transferId`.

Example

// Import classes:
//import com.adyen.client.infrastructure.*
//import com.adyen.model.transfers.*

val apiInstance = TransfersApi()
val id : kotlin.String = id_example // kotlin.String | The unique identifier of the transfer to be returned.
val returnTransferRequest : ReturnTransferRequest =  // ReturnTransferRequest | 
try {
    val result : ReturnTransferResponse = apiInstance.postTransfersIdReturns(id, returnTransferRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling TransfersApi#postTransfersIdReturns")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling TransfersApi#postTransfersIdReturns")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
id kotlin.String The unique identifier of the transfer to be returned.
returnTransferRequest ReturnTransferRequest [optional]

Return type

ReturnTransferResponse

Authorization

Configure ApiKeyAuth: ApiClient.apiKey["X-API-Key"] = "" ApiClient.apiKeyPrefix["X-API-Key"] = "" Configure BasicAuth: ApiClient.username = "" ApiClient.password = ""

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json