POST api/ussd/v1/confirm

Request Information

URI Parameters

None.

Body Parameters

PayStackResponseModel
NameDescriptionTypeAdditional information
status

boolean

None.

message

string

None.

data

Data

None.

Request Formats

application/json, text/json

Sample:
{
  "status": true,
  "message": "sample string 2",
  "data": {
    "id": 1,
    "domain": "sample string 2",
    "status": "sample string 3",
    "display_text": "sample string 4",
    "reference": "sample string 5",
    "amount": 6,
    "message": "sample string 7",
    "gateway_response": "sample string 8",
    "paid_at": "2025-12-10T09:35:46.3873295+00:00",
    "created_at": "2025-12-10T09:35:46.3873295+00:00",
    "channel": "sample string 9",
    "currency": "sample string 10",
    "ip_address": "sample string 11",
    "metadata": {},
    "log": {
      "start_time": 1,
      "time_spent": 2,
      "attempts": 3,
      "errors": 4,
      "success": true,
      "mobile": true,
      "input": [
        {},
        {}
      ],
      "history": [
        {
          "type": "sample string 1",
          "message": "sample string 2",
          "time": 3
        },
        {
          "type": "sample string 1",
          "message": "sample string 2",
          "time": 3
        }
      ]
    },
    "fees": 13,
    "fees_split": {},
    "authorization": {
      "authorization_code": "sample string 1",
      "bin": "sample string 2",
      "last4": "sample string 3",
      "exp_month": "sample string 4",
      "exp_year": "sample string 5",
      "channel": "sample string 6",
      "card_type": "sample string 7",
      "bank": "sample string 8",
      "country_code": "sample string 9",
      "brand": "sample string 10",
      "reusable": true,
      "signature": "sample string 12",
      "account_name": {}
    },
    "customer": {
      "id": 1,
      "first_name": {},
      "last_name": {},
      "email": "sample string 4",
      "customer_code": "sample string 5",
      "phone": {},
      "metadata": {},
      "risk_action": "sample string 8",
      "international_format_phone": {}
    },
    "plan": {},
    "split": {},
    "order_id": {},
    "paidAt": "2025-12-10T09:35:46.4028782+00:00",
    "createdAt": "2025-12-10T09:35:46.4028782+00:00",
    "requested_amount": 17,
    "pos_transaction_data": {},
    "source": {},
    "fees_breakdown": {},
    "transaction_date": "2025-12-10T09:35:46.4028782+00:00",
    "plan_object": {},
    "subaccount": {}
  }
}

application/xml, text/xml

Sample:
<PayStackResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/vouvher_sales_api.Utils.Payment.PayStack">
  <data>
    <amount>6</amount>
    <authorization>
      <account_name />
      <authorization_code>sample string 1</authorization_code>
      <bank>sample string 8</bank>
      <bin>sample string 2</bin>
      <brand>sample string 10</brand>
      <card_type>sample string 7</card_type>
      <channel>sample string 6</channel>
      <country_code>sample string 9</country_code>
      <exp_month>sample string 4</exp_month>
      <exp_year>sample string 5</exp_year>
      <last4>sample string 3</last4>
      <reusable>true</reusable>
      <signature>sample string 12</signature>
    </authorization>
    <channel>sample string 9</channel>
    <createdAt>2025-12-10T09:35:46.4028782+00:00</createdAt>
    <created_at>2025-12-10T09:35:46.3873295+00:00</created_at>
    <currency>sample string 10</currency>
    <customer>
      <customer_code>sample string 5</customer_code>
      <email>sample string 4</email>
      <first_name />
      <id>1</id>
      <international_format_phone />
      <last_name />
      <metadata />
      <phone />
      <risk_action>sample string 8</risk_action>
    </customer>
    <display_text>sample string 4</display_text>
    <domain>sample string 2</domain>
    <fees>13</fees>
    <fees_breakdown />
    <fees_split />
    <gateway_response>sample string 8</gateway_response>
    <id>1</id>
    <ip_address>sample string 11</ip_address>
    <log>
      <attempts>3</attempts>
      <errors>4</errors>
      <history>
        <History>
          <message>sample string 2</message>
          <time>3</time>
          <type>sample string 1</type>
        </History>
        <History>
          <message>sample string 2</message>
          <time>3</time>
          <type>sample string 1</type>
        </History>
      </history>
      <input xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:anyType />
        <d4p1:anyType />
      </input>
      <mobile>true</mobile>
      <start_time>1</start_time>
      <success>true</success>
      <time_spent>2</time_spent>
    </log>
    <message>sample string 7</message>
    <metadata />
    <order_id />
    <paidAt>2025-12-10T09:35:46.4028782+00:00</paidAt>
    <paid_at>2025-12-10T09:35:46.3873295+00:00</paid_at>
    <plan />
    <plan_object />
    <pos_transaction_data />
    <reference>sample string 5</reference>
    <requested_amount>17</requested_amount>
    <source />
    <split />
    <status>sample string 3</status>
    <subaccount />
    <transaction_date>2025-12-10T09:35:46.4028782+00:00</transaction_date>
  </data>
  <message>sample string 2</message>
  <status>true</status>
</PayStackResponseModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.