Skip to main content
POST
/
payments
/
risk-analysis
Create a risk analysis
curl --request POST \
  --url https://api-sb.meld.io/payments/risk-analysis \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "achClass": "CCD",
  "amount": "10.50",
  "currencyCode": "USD"
}
'
{
  "decision": "<string>",
  "decisionRationale": {
    "code": "<string>",
    "description": "<string>"
  },
  "risk": {
    "bankInitiatedReturnScore": 123,
    "customerInitiatedReturnScore": 123,
    "riskLevel": "<string>"
  },
  "serviceProviderTransferAuthorizationId": "<string>"
}

Authorizations

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

Headers

​
X-Idempotency-Key
string<uuid>

Body

application/json
​
achClass
enum<string>
required

The ACH class of the transaction (CCD, PPD, TEL, WEB)

Available options:
CCD,
PPD,
TEL,
WEB
​
amount
number
required

Amount intended to be sent by this transaction

Example:

"10.50"

​
currencyCode
string
required

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

Minimum string length: 1
Example:

"USD"

​
name
object

Customer name

​
plaidTransferAccountFields
object

The id and token for a Plaid account used in a transfer

​
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
​
type
enum<string>

The type of the transaction, either CHARGE or PAYOUT

Available options:
CHARGE,
REFUND,
CRYPTO_PURCHASE,
CRYPTO_PURCHASE_SWAP,
CRYPTO_SELL,
CRYPTO_SELL_SWAP,
CRYPTO_TRANSFER,
PAYOUT

Response

Risk analysis created successfully

​
decision
string
​
decisionRationale
object
​
risk
object
​
serviceProvider
enum<string>
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
​
serviceProviderTransferAuthorizationId
string