Skip to main content
Use when: Evaluating card, transfer, USSD, or other payment instruments. Endpoint: Realtime URL of a Payments Flow Request Template: 
    {
      "key": "6WgE3W1",
      "type": "payments",
      "user": {
        "user_id": "9931fac0-6bfa-4b3c-842c-7840006d89b6",
        "user_type": "individual",
        "registration_time": "2022-12-12T12:15:05.392Z",
        "email": "jane.doe@anon.com",
        "name": "Jane Doe",
        "dob": "1980-01-01",
        "tier": "silver",
        "account_type": "checking",
        "gender": "male",
        "balance": 24500.50,
        "mobile": "5797454931",
        "last_pin_change": "2022-11-01T08:30:00.000Z",
        "last_password_change": "2022-10-15T14:22:10.000Z",
        "credit_score": "720",
        "employer_information": {
          "annual_income": "",
          "employment_status": "employed",
          "employer_name": "Innovate Solutions"
        },
        "kyc_information": [
          {
            "id_number": "1234567890",
            "id_type": "bvn",
            "country": "NG"
          },
          {
            "id_number": "1234567890",
            "id_type": "NIN",
            "country": "NG"
          }
        ]
      },
      "transaction": {
        "id": "87554303-3f75-4883-8fb8-48fce003859f",
        "time": "2022-12-12T12:15:05.391Z",
        "amount": 8291,
        "currency": "XAF",
        "ref": "xaf",
        "session_id": "xaf",
        "type": "deposit",
        "channel": "mobile",
        "purpose": "salary payment",
        "source_of_funds": "employment income"
      },
      "payment": {
        "payment_id": "9931fac0-6bfa-4b3c-842c",
        "is_recurring": true,
        "method_type": "card",
        "scheme": "Visa",
        "card_funding": "debit",
        "card_last_four": "9876",
        "expiry_month": "10",
        "expiry_year": "25",
        "is_3ds_enabled": true,
        "is_card_present": true,
        "cvv_provided": true,
        "avs_passed": true,
        "name_on_card": "John Buchanan",
        "billing_address": {
          "city": "North Sarah",
          "street": "6238 Walker Unions Suite 802",
          "country": "Morocco"
        }
      },
      "merchant": {
        "name": "Merchant 1",
        "category": "Android",
        "country": "Nigeria"
      },
      "device": {
        "type": "mobile",
        "os": "Android",
        "model": "Pixel 7",
        "language": "en-US",
        "ip_address": "154.72.170.233",
        "device_id": "ff97adb7-8d3d-4f15-94df-87e21e1212de"
      },
      "address": {
        "address1": "6238 Walker Unions Suite 802",
        "address2": "",
        "city": "North Sarah",
        "region": "",
        "zipcode": "23401",
        "country": "Morocco"
      }
    }