Sign in

v1

latestOpenAPI 3.1.0Apache 2.02026-07-2265186296.2 KB
Transactions

Create a payout transaction

Use this endpoint to create a payout transaction. You can find sample code in our public Postman collection, or build it in the adjacent API explorer. The link to our postman collection is: https://www.postman.com/meldeng/workspace/meld-io-public-api-collection

IDEMPOTENT REQUESTS: Please refer to Idempotency Key

ERRORS: Please refer to Error Responses

post/payments/transactions/payout

Headers

X-Idempotency-Keystring uuid

Request body

customerIdstring

Meld's internal Id for the Customer

descriptionstring

A description about the transaction

externalCustomerIdstring

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

serviceProvider'ACROSS' | 'AEROPAY' | 'AKOYA' | 'ALCHEMYPAY' | 'APPLEPAY' | 'AUTHORIZENET' | 'BANXA' | 'BILIRA' | 'BINANCECONNECT' | 'BINANCEPAY' | 'BLOCKCHAINDOTCOM' | 'BOOMFI' | 'BRAINTREE' | 'BRALE' | 'BTCDIRECT' | 'CASHAPP' | 'CHECKOUT' | 'CIRCLE' | 'COINBASEPAY' | 'COINFLOW' | 'DUENETWORK' | 'ELDORADO' | 'FINICITY' | 'FLASHNET' | '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'

The service provider used for this transaction.

serviceProviderDetailsobject

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

sourceAmountstring required

Amount intended to be sent by this payout

sourceCurrencyCodestring required

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

Example request

{
  "paymentMethod": {
    "details": {
      "cvc": "123",
      "number": "4111111111111111"
    }
  },
  "sourceAmount": "10.50",
  "sourceCurrencyCode": "USD"
}

Response

Payout transaction created successfully