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"
}
'
import requests

url = "https://api-sb.meld.io/payments/risk-analysis"

payload = {
"achClass": "CCD",
"amount": "10.50",
"currencyCode": "USD"
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({achClass: 'CCD', amount: '10.50', currencyCode: 'USD'})
};

fetch('https://api-sb.meld.io/payments/risk-analysis', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api-sb.meld.io/payments/risk-analysis",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'achClass' => 'CCD',
'amount' => '10.50',
'currencyCode' => 'USD'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api-sb.meld.io/payments/risk-analysis"

payload := strings.NewReader("{\n \"achClass\": \"CCD\",\n \"amount\": \"10.50\",\n \"currencyCode\": \"USD\"\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api-sb.meld.io/payments/risk-analysis")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"achClass\": \"CCD\",\n \"amount\": \"10.50\",\n \"currencyCode\": \"USD\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api-sb.meld.io/payments/risk-analysis")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"achClass\": \"CCD\",\n \"amount\": \"10.50\",\n \"currencyCode\": \"USD\"\n}"

response = http.request(request)
puts response.read_body
{
  "decision": "<string>",
  "decisionRationale": {
    "code": "<string>",
    "description": "<string>"
  },
  "risk": {
    "bankInitiatedReturnScore": 123,
    "customerInitiatedReturnScore": 123,
    "riskLevel": "<string>"
  },
  "serviceProviderTransferAuthorizationId": "<string>"
}
{
"code": "<string>",
"displayMessage": "<string>",
"errors": [
"<string>"
],
"message": "<string>",
"requestId": "<string>",
"serviceProviderDetails": {},
"timestamp": "2023-11-07T05:31:56Z"
}
{
"code": "<string>",
"displayMessage": "<string>",
"errors": [
"<string>"
],
"message": "<string>",
"requestId": "<string>",
"serviceProviderDetails": {},
"timestamp": "2023-11-07T05:31:56Z"
}

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,
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
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,
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
serviceProviderTransferAuthorizationId
string