3-D Secure

🚧

Under Construction

External Authorization

Example request for One Step charge with external authorization

Request, POST /v1/payment-charges/:

{
  "paymentMethod": "CARD",
  "paymentDescriptor": "PPRO test CP dev team",
  "merchantPaymentChargeReference": "MTR12345678",
  "autoCapture": true,
  "instrument": {
    "type": "RAW_CARD",
    "details": {
      "brand": "VISA",
      "number": "4111111111111111",
      "cvv": "123",
      "holderName": "John Smith",
      "expiryMonth": 1,
      "expiryYear": 2024
  },
  "amount": {
    "value": 1000,
    "currency": "BRL"
  },
  "consumer": {
    "name": "John Smith",
    "taxIdentification": "12345678909"
  },
  "authenticationSettings": [{
    "type": "EXTERNAL_3DS",
    "settings" : {
      "authenticationStatus" : "SUCCESS",
      "authenticationValue" : "e3f7a0c2-fff8-4fb8-afab-dbae6e17c9cc",
      "eci" : "01",
      "version" : "2.0.0",
      "externalId" : "a7fe5eae-d5bb-4f57-a946-2125c3c32801",
      "challenge" : {
        "preference": "NO_CHALLENGE_REQUESTED",
        "outcome":"FRICTIONLESS",
        "exemptionReason": "LOW_VALUE"
      }
    }
  }]
}

Response:

{
    "id": "charge_wQM59vfK5ZoteCHPWmGJE",
    "paymentMethod": "CARD",
    "paymentMedium": "ECOMMERCE",
    "scheduleType": "UNSCHEDULED",
    "instrumentId": "instr_oX4NDzo0KX5zCzCsRq2vN",
    "currency": "BRL",
    "paymentDescriptor": "PPRO test CP dev team",
    "status": "CAPTURED",
    "consumer": {
        "name": "John Smith",
        "taxIdentification": "12345678909"
    },
    "authorizations": [
        {
            "id": "authz_Tk9xjlDqKPdLRgrpohfiD",
            "amount": 1000,
            "status": "AUTHORIZED",
            "merchantPaymentChargeReference": "MTR12345678",
            "createdAt": "2023-08-23T12:09:16.415Z",
            "updatedAt": "2023-08-23T12:09:16.415Z"
        }
    ],
    "captures": [
        {
            "id": "capture_SZ9nJhaXFdK6pLOgN96XW",
            "amount": 1000,
            "status": "CAPTURED",
            "merchantCaptureReference": "MTR12345678",
            "createdAt": "2023-08-23T12:09:16.415Z",
            "updatedAt": "2023-08-23T12:09:16.415Z"
        }
    ],
    "refunds": [],
    "voids": [],
    "createdAt": "2023-08-23T12:09:14.526Z",
    "updatedAt": "2023-08-23T12:09:16.415Z"
    }
}