v1

latestOpenAPI 3.0.3Apache License Version 2.02026-07-2631211285.4 KB

WireTransfer

Create Evaluation

Receives a new transaction for antifraud analysis.

post/v1/antifraud/evaluations

Request body

type'WireTransfer' required

Antifraud type

order_datestring required

Date order is issued

execution_datestring

Date order is actually executed

instantboolean

Represents if the transfer will be scheduled or executed now

transfer_type'DEPOSIT' | 'WITHDRAW' | 'TRANSFER' required

Transfer type

sla_datestring

The date that the evaluation is expected to be resolved

callback_urlstring

A publicly accessible HTTPS endpoint where your application will receive asynchronous notifications about the status of the evaluation.

Example request

{
  "device": {
    "ipv4": "70.56.69.13",
    "ipv6": "2001:0db8:85a3:0000:0000:8a2e:0370:7334",
    "location": {
      "latitude": -34.56532789616039,
      "longitude": -58.48945822129388
    },
    "merchant_device": "234c20c3-45de-41bf-b243-87ad5$RTbc3b",
    "session_id": "5b8c20c3-45de-41bf-b243-87ad5d21bc3b"
  },
  "store": {
    "name": "Store23",
    "countryCode": "BR",
    "document": "1234567"
  },
  "transaction": {
    "reference_id": "FGCCCEA53JYSHXX",
    "business_id": "6LVHR8W0V7BYEQX",
    "sequence": "1",
    "country_code": "AR",
    "total_amount": {
      "currency_code": "USD",
      "value": 8008.99
    }
  },
  "account_from": {
    "number": "0007895241236987",
    "bank_name": "6LVHR8W0V7BYEQX",
    "bank_code": "1145",
    "holder": "Hugo Sconochini",
    "currency_code": "USD",
    "creation_date": "2021-07-23T16:00:00.307062Z",
    "user_id": "user12"
  },
  "account_to": {
    "number": "0007895241236987",
    "bank_name": "6LVHR8W0V7BYEQX",
    "bank_code": "1145",
    "holder": "Hugo Sconochini",
    "currency_code": "USD",
    "creation_date": "2021-07-23T16:00:00.307062Z",
    "user_id": "user12"
  },
  "order_date": "2021-07-23T16:00:00.307062Z",
  "execution_date": "2021-07-23T16:00:00.307062Z",
  "sla_date": "2021-07-23T16:00:00.307062Z",
  "callback_url": "http://domain/service"
}

Response

Evaluation response

onboardingIdstring required

Onboarding identification

referenceIdstring required

Client transaction identifier

Onboarding status

messagestring

Information message

Example response

{
  "onboardingId": "31ff2cc8-199e-4c3c-ba2d-4d85b88bd9f2",
  "referenceId": "FGCCCEA53JYSHXX",
  "message": "Test message",
  "credentials": {
    "storeCode": "STORE12",
    "privateKey": "dqwg43yefnjnk5fe",
    "orgId": "s4fes6ytr4"
  },
  "paymentAccounts": [
    {
      "account": "AP12345PI",
      "evaluatesFraud": true
    }
  ]
}