Skip to content

Confirming Payment

Transactions Write

Confirm a payment transaction and finalize the booking. This endpoint verifies successful payment and generates a detailed receipt with shipment information, charges breakdown, and tracking details.

Receipt Generated
On Success
Status Updated
Booking State
Shipment Ready
Processing

Endpoint

POST {{base_url}}/transactions/{{order_id}}/confirm/

Path Parameters

Parameter Type Required Description
order_id string Yes The transaction or order ID to confirm

Headers

Header Value Description
Content-Type application/json Specifies the media type
Authorization Bearer {{ token }} Authentication token

Sample Request

curl --request POST \
  --url '{{ base_url }}/transactions/c106e7ea-dff1-4e9d-b973/confirm/' \
  --header 'Authorization: Bearer {{ token }}' \
  --header 'Content-Type: application/json'

No Request Body

This endpoint does not require a request body. The order_id is passed directly in the URL path.


Response

{
  "message": "payment confirmed",
  "status_code": "200",
  "receipt": {
    "id": "8f5e0433-2cdb-4899-8297-ade685d9422a",
    "items": [
      {
        "name": "WOVEN WOMEN DRESS MFG BY SLASH COURTURE, 8 FEBURG ROAD, AGEGE, LAGOS STATE",
        "price": 13000,
        "quantity": 1,
        "unitMeasurement": "PCS"
      }
    ],
    "customer": "Temitope Joshua",
    "date_time": "2024-11-04T03:38:36.706223+01:00",
    "weight": 10.0,
    "served_by": "Sir Desmond Tutu",
    "insurance": {
      "fee": 0,
      "type": "NE"
    },
    "addons": {
      "addons": [],
      "total_addons_price": 0.0
    },
    "amount_paid": 10893.0,
    "extra_charges": {
      "packaging_fee": {
        "type": "price",
        "value": 0,
        "amount": 4000
      },
      "fuel_surcharge": {
        "type": "percentage",
        "value": 0,
        "amount": 0.0
      },
      "on_shipping_fee": 6097.1375
    },
    "ship_to": "28, STELLA SHOLANKE STREET,",
    "tracking_no": "",
    "rate": "SR",
    "total": 10893.0,
    "name": "R353",
    "tax": 794.362,
    "origin": {
      "address": "1, DEGUN STREET, IJEBU ODE",
      "city": "ijebu-ode",
      "state": "ogun",
      "country": "Nigeria",
      "postal_code": "120101",
      "name": "OLATUNJI MUTIAT ADEWUMI"
    },
    "destination": {
      "address": "28, STELLA SHOLANKE STREET,",
      "city": "lagos",
      "state": "lagos",
      "country": "Nigeria",
      "postal_code": "100263",
      "name": "TAIWO HASSANAT SHOGEYINBO"
    },
    "branch_name": "Gbagada",
    "voided": false,
    "source": {
      "id": "",
      "name": "",
      "account_number": "",
      "customer_id": "",
      "branch": ""
    },
    "invoice": 353,
    "shipment": 838,
    "bill_to": 89
  }
}

Response Fields

Root Object

Field Type Description
message string Success message confirming payment
status_code string HTTP status code
receipt object Detailed receipt object

Receipt Object

Field Type Description
id string Unique receipt identifier (UUID)
items array Array of items included in the shipment
customer string Customer name
date_time string Payment confirmation timestamp
weight number Total shipment weight in kg
served_by string Staff member who processed the transaction
insurance object Insurance details (fee and type)
addons object Additional services and charges
amount_paid number Total amount paid
extra_charges object Breakdown of additional charges
ship_to string Destination address summary
tracking_no string Shipment tracking number
rate string Service rate code
total number Total transaction amount
name string Receipt name/reference
tax number Tax amount
origin object Origin address details
destination object Destination address details
branch_name string Processing branch name
voided boolean Whether the transaction has been voided
source object Source account details
invoice integer Associated invoice ID
shipment integer Associated shipment ID
bill_to integer Bill ID

Extra Charges Object

Field Type Description
packaging_fee object Packaging fee details (type, value, amount)
fuel_surcharge object Fuel surcharge (type, percentage, amount)
on_shipping_fee number Base shipping fee amount

Address Object (Origin/Destination)

Field Type Description
address string Street address
city string City name
state string State/province
country string Country name
postal_code string Postal/ZIP code
name string Contact name at address

Insurance Types

Code Description
NE No insurance / Not enrolled
BA Basic insurance coverage
PR Premium insurance coverage

Payment Flow Complete

Once payment is confirmed, the booking transitions to a shipment and is ready for processing. The tracking number will be assigned when the shipment is dispatched.