v1

latestOpenAPI 3.1.0Apache 2.02026-07-2265186296.2 KB

Risk

Create a risk analysis

Perform an ACH risk analysis and create associated records

post/payments/risk-analysis

Headers

X-Idempotency-Keystring uuid

Request body

achClass'CCD' | 'PPD' | 'TEL' | 'WEB' required

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

amountnumber required

Amount intended to be sent by this transaction

currencyCodestring required

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

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.

type'CHARGE' | 'REFUND' | 'CRYPTO_PURCHASE' | 'CRYPTO_PURCHASE_SWAP' | 'CRYPTO_SELL' | 'CRYPTO_SELL_SWAP' | 'CRYPTO_TRANSFER' | 'PAYOUT'

The type of the transaction, either CHARGE or PAYOUT

Example request

{
  "currencyCode": "USD"
}

Response

Risk analysis created successfully