Skip to main content
POST
/
payments
/
transactions
/
payout
Create a payout transaction
curl --request POST \
  --url https://api-sb.meld.io/payments/transactions/payout \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "sourceAmount": "10.50",
  "sourceCurrencyCode": "USD"
}
'
{
  "transaction": {
    "createdAt": "2023-11-07T05:31:56Z",
    "id": "<string>",
    "serviceProvider": "<string>",
    "sessionId": "<string>",
    "status": "<string>",
    "transactionType": "<string>",
    "updatedAt": "2023-11-07T05:31:56Z",
    "accountId": "<string>",
    "countryCode": "<string>",
    "cryptoDetails": {
      "blockchainTransactionId": "<string>",
      "chainId": "<string>",
      "institution": "<string>",
      "networkFee": 123,
      "networkFeeInUsd": 123,
      "offrampDestinationWalletAddress": "<string>",
      "partnerFee": 123,
      "partnerFeeInUsd": 123,
      "swapFee": 123,
      "swapFeeInUsd": 123,
      "totalFee": 123,
      "totalFeeInUsd": 123,
      "transactionFee": 123,
      "transactionFeeInUsd": 123,
      "walletAddress": "<string>"
    },
    "customer": {
      "accountId": "<string>",
      "addresses": [
        {
          "addressDetails": {
            "city": "<string>",
            "country": "<string>",
            "firstName": "<string>",
            "lastName": "<string>",
            "lineOne": "<string>",
            "lineTwo": "<string>",
            "postalCode": "<string>",
            "region": "<string>"
          }
        }
      ],
      "email": "<string>",
      "externalId": "<string>",
      "id": "<string>",
      "name": {
        "firstName": "<string>",
        "lastName": "<string>"
      },
      "phone": "<string>",
      "serviceProviders": {},
      "status": "<string>"
    },
    "description": "<string>",
    "destinationAmount": 123,
    "destinationCurrencyCode": "<string>",
    "externalCustomerId": "<string>",
    "externalReferenceId": "<string>",
    "externalSessionId": "<string>",
    "externalSubaccountCustomerId": "<string>",
    "fiatAmountInUsd": 123,
    "isImported": true,
    "isPassthrough": true,
    "key": "<string>",
    "multiFactorAuthorizationStatus": [
      {
        "submitted": true,
        "successful": true,
        "url": "<string>"
      }
    ],
    "orderId": "<string>",
    "parentPaymentTransactionId": "<string>",
    "passthroughReference": "<string>",
    "paymentDetails": {
      "authAmount": 123,
      "captureAmount": 123
    },
    "paymentMethodType": "<string>",
    "serviceProviderCreatedAt": "2023-11-07T05:31:56Z",
    "serviceProviderDetails": {},
    "serviceProviderTransactionUrl": "<string>",
    "serviceTransactionId": "<string>",
    "sessionClientTags": {},
    "sourceAmount": 123,
    "sourceCurrencyCode": "<string>",
    "subaccountCustomerId": "<string>"
  }
}

Authorizations

Authorization
string
header
default:BASIC <Meld API Key>
required

Headers

X-Idempotency-Key
string<uuid>

Body

application/json
sourceAmount
string
required

Amount intended to be sent by this payout

Minimum string length: 1
Example:

"10.50"

sourceCurrencyCode
string
required

Three-letter ISO currency code, in lowercase. Must be a supported currency

Minimum string length: 1
Example:

"USD"

customerId
string

Meld's internal Id for the Customer

description
string

A description about the transaction

externalCustomerId
string

Your (optional) Id for this customer, for example an id or reference from your database which you may supply during customer creation

paymentMethod
object

PaymentMethod objects represent your customer's receiving payment instrument

serviceProvider
enum<string>

The service provider used for this transaction.

Available options:
ACROSS,
AEROPAY,
AKOYA,
ALCHEMYPAY,
APPLEPAY,
AUTHORIZENET,
BANXA,
BILIRA,
BINANCECONNECT,
BINANCEPAY,
BLOCKCHAINDOTCOM,
BOOMFI,
BRAINTREE,
BRALE,
BTCDIRECT,
CASHAPP,
CHECKOUT,
CIRCLE,
COINBASEPAY,
COINFLOW,
DUENETWORK,
ELDORADO,
FINICITY,
FONBNK,
GUARDARIAN,
HARBOUR,
KOYWE,
KRYPTONIM,
MERCURYO,
MESH,
MESO,
MOONPAY,
MOOV,
MX,
NMI,
NOAH,
ONMETA,
ONRAMPMONEY,
PAYBIS,
PAYPAL,
PLAID,
RAMP,
REVOLUT,
ROBINHOOD,
ROUTERPROTOCOL,
SALTEDGE,
SALTEDGEPARTNERS,
SARDINE,
SHIFT4,
SHOPIFY,
SIMPLEX,
SKRILLCRYPTO,
SQUARE,
STRIPE,
SUMSUB,
SWAPPED,
TANGOCARD,
TELLER,
TOPPER,
TRANSAK,
TREMENDOUS,
TRANSFI,
UNLIMIT,
WYRE,
XANPOOL,
YELLOWCARD,
YODLEE
serviceProviderDetails
object

Provider specific details which may can be provided for this transaction, if supported by the Service Provider.

Response

Payout transaction created successfully

transaction
object

Payment transaction information