Make a payout to a third-party card

Make an API request to pay out funds to a third-party card.

This page explains how to make a payout request to transfer funds to Mastercard or Visa cards. In the following sections, you can see examples for one-off or recurring payouts.

After you make the payout request, you can track the status of the transfer by using webhooks.

Requirements

Ensure that:

You reached out to your Adyen contact to enable the feature on your account.
The card is eligible for payouts (recommended).
If you are not fully PCI compliant or want to make recurring payouts, you tokenized and saved the card details.
Your API credential for balance platform (ws[_123456]@BalancePlatform.[YourBalancePlatform]) has the following roles to use with the Transfers API.
- Bank Transfer Initiation Webservice role
- TransferService Webservice Initiate role
Your server receives and accepts webhooks.
You subscribed to Transfer webhooks and Transaction webhooks in your Balance Platform Customer Area.

Initiate a payout

The following tabs show how to make one-off and recurring payments. If you are fully PCI compliant, you are allowed to make payout requests using raw card details. Otherwise, you must use tokenized card details in your request.

To make a request for a one-off card payout, make a POST /transfers request, specifying the following parameters:

Parameter	Required	Description

Parameter	Required	Description
amount		The amount of the transfer.
balanceAccountId		The balance account from which funds are deducted.
category		Set to card.
counterparty.card.cardHolder		An object that contains details about the cardholder of the counterparty card.
counterparty.card.cardIdentification		An object that contains the identification details of the counterparty card.
description		Your description for the transfer. You can use this to identify the payout in your Customer Area. The description is only used within your balance platform and not sent to the recipient.
reference		Your reference for the transfer. You can use this to identify the payout in your Customer Area. The reference is only used within your balance platform and not sent to the recipient. If you do not provide this value in the request, Adyen generates a unique reference.

Example request for a one-off payout with raw card details

 curl https://balanceplatform-api-test.adyen.com/btl/v4/transfers \
-H 'x-api-key: ADYEN_BALANCE_PLATFORM_API_KEY' \
-H 'content-type: application/json' \
-X POST \
-d '{
    "amount": {
        "value": 10000,
        "currency": "USD"
    },
    "balanceAccountId": "BA00000000000000000000001",
    "category": "card",
    "counterparty": {
        "card": {
            "cardHolder": {
                "type": "individual",
                "firstName": "Albert",
                "lastName": "Klaassen",
                "address": {
                    "city": "San Francisco",
                    "country": "US",
                    "line1": "274",
                    "line2": "Brannan St",
                    "postalCode": "94107",
                    "stateOrProvince": "CA"
                }
            },
            "cardIdentification": {
                "number": "4321123456788765",
                "expiryMonth": "03",
                "expiryYear": "2030"
            }
        }
    },
    "reference": "Your internal reference for the transfer",
    "description": "Your internal description for the transfer"
}'

The following tabs show examples of the responses that you receive after a successful request.

Example response for a one-off payout

 {
    "creationDate": "2023-12-28T15:26:06+01:00",
    "id": "48POP561F0ZWWLNW",
    "accountHolder": {
        "description": "Your description for the account holder",
        "id": "AH00000000000000000000001"
    },
    "amount": {
        "currency": "USD",
        "value": 10000
    },
    "balanceAccount": {
        "description": "Your description for the balance account",
        "id": "BA00000000000000000000001"
    },
    "category": "card",
    "counterparty": {
        "card": {
            "cardHolder": {
                "address": {
                    "city": "San Francisco",
                    "country": "US",
                    "postalCode": "94107",
                    "stateOrProvince": "CA",
                    "line1": "274",
                    "line2": "Brannan St"
                },
                "firstName": "Albert",
                "lastName": "Klaassen",
                "type": "individual"
            },
            "cardIdentification": {
                "expiryMonth": "03",
                "expiryYear": "2030",
                "number": "432112******8765"
            }
        }
    },
    "description": "Your internal description of the transfer",
    "direction": "outgoing",
    "reason": "approved",
    "reference": "Your internal reference for the transfer",
    "status": "authorised",
    "type": "cardTransfer"
}

Get updates on the status of the transfer

Track the transfer request by using the webhooks that Adyen sends to your server. You receive a webhook each time that the status of the request changes. For example, you receive webhooks when Adyen receives the request, when the transfer is authorised, and when the funds are booked and deducted from the balance account.

You can also view the transfer details in your Customer Area.