Payments

Upload invoice file for a payment

post

Upload an invoice file (PDF, image) for a specific payment record

Authorizations

Path parameters

paymentintegerRequired

Payment ID

Body

invoice_filefileOptional

Invoice file (PDF, JPEG, PNG, JPG, GIF)

Responses

201

Invoice file uploaded successfully

application/json

400

Validation error

application/json

post

/api/admin/payments/{payment}/upload-invoice

POST /api/admin/payments/{payment}/upload-invoice HTTP/1.1
Content-Type: multipart/form-data
Accept: */*
Content-Length: 21

{
  "invoice_file": null
}

{
  "success": true,
  "message": "OK",
  "data": null
}

Approve or reject a payment

post

Admin endpoint to approve or reject a pending payment request

Authorizations

Path parameters

paymentintegerRequired

Payment ID

Body

statusstring · enumRequired

Payment approval status

Possible values:

Responses

201

Payment status updated successfully

application/json

401

Payment not pending or unauthorized

application/json

500

Server error

application/json

post

/api/admin/payments/{payment}/process-status

POST /api/admin/payments/{payment}/process-status HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 19

{
  "status": "ACCEPT"
}

{
  "success": true,
  "message": "OK",
  "data": null
}

Charge an organization's wallet

post

Authorizations

Path parameters

organizationstring · uuidRequired

Organization UUID

Body

amountintegerRequired

Amount to charge

Example: 1000

servicestring · enumRequired

Service type

Example: smsPossible values:

sms_pointintegerOptional

Required when service is 'sms'. Number of SMS points

Example: 100

reasonstringOptional

Optional reason for the charge

Example: Monthly SMS package

Responses

200

Charge processed successfully

application/json

successbooleanOptionalExample: true

messagestringOptionalExample: Charge processed successfully

datanullOptional

422

Validation error

application/json

500

Error processing charge

application/json

post

/api/admin/payments/{organization}/charge

POST /api/admin/payments/{organization}/charge HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 78

{
  "amount": 1000,
  "service": "sms",
  "sms_point": 100,
  "reason": "Monthly SMS package"
}

{
  "success": true,
  "message": "Charge processed successfully",
  "data": null
}

Process a checkout request for a service

post

This endpoint processes a checkout request, calculates the total amount including tax, determines SMS points if applicable, and generates a payment URL.

Body

servicestringRequired

The service type (sms or other)

Example: sms

amountintegerRequired

The amount to be processed

Example: 100

Responses

200

Payment URL Generated

application/json

successbooleanOptionalExample: true

messagestringOptionalExample: Payment Url

datastringOptionalExample: https://payment-gateway.com?paymentid=1234567890

400

Payment Online Disabled

application/json

422

Validation Error(s)

application/json

500

Internal Server Error

application/json

post

/api/payments/workspaces/{workspace}/payment/checkout

POST /api/payments/workspaces/{workspace}/payment/checkout HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 30

{
  "service": "sms",
  "amount": 100
}

{
  "success": true,
  "message": "Payment Url",
  "data": "https://payment-gateway.com?paymentid=1234567890"
}

Handle URWay payment callback

get

This endpoint handles the callback from URWay after a payment attempt.

Body

PaymentIdstringOptional

Payment ID

TrackIdstringOptional

Tracking ID

TranIdstringOptional

Transaction ID

ResultstringOptional

Payment result

ResponseCodestringOptional

Response code from payment gateway

responseHashstringOptional

Response hash for validation

cardBrandstringOptional

Brand of the card used for payment

amountnumberOptional

Amount paid

maskedPANstringOptional

Masked PAN of the card

PaymentTypestringOptional

Type of payment (e.g., CreditCard)

UserField1stringOptional

Additional user data, typically in JSON format

Responses

200

Payment processed successfully

No content

401

Unauthorized or failed payment

500

Server error

get

/api/payment/callback

GET /api/payment/callback   HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 203

{
  "PaymentId": "text",
  "TrackId": "text",
  "TranId": "text",
  "Result": "text",
  "ResponseCode": "text",
  "responseHash": "text",
  "cardBrand": "text",
  "amount": 1,
  "maskedPAN": "text",
  "PaymentType": "text",
  "UserField1": "text"
}

No content

Calculate the total amount including tax for a specific service

get

This endpoint calculates the total amount for a specified service (e.g., SMS or Other) including tax or other operations.

Body

servicestringRequired

The service type (sms or other)

Example: sms

amountintegerRequired

The amount to be processed

Example: 100

Responses

200

Success

application/json

successbooleanOptionalExample: true

messagestringOptionalExample: OK

422

Validation Error(s)

application/json

500

Internal Server Error

application/json

get

/api/payment/workspaces/{workspace}/payment/total-amount

GET /api/payment/workspaces/{workspace}/payment/total-amount HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 30

{
  "service": "sms",
  "amount": 100
}

{
  "success": true,
  "message": "OK",
  "data": {
    "total_amount": 115
  }
}

Submit a request to convert points to currency or currency to points

post

Allows a user to submit a conversion request, which must be approved by an admin.

Authorizations

Body

amountnumber · floatRequiredExample: 100

conversion_typestring · enumRequiredExample: points_to_currencyPossible values:

Responses

200

Conversion request submitted successfully

application/json

successbooleanOptionalExample: true

messagestringOptionalExample: Conversion request submitted successfully

401

Unauthorized

application/json

422

Validation or processing error

application/json

post

/api/request-conversion

POST /api/request-conversion HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 53

{
  "amount": 100,
  "conversion_type": "points_to_currency"
}

{
  "success": true,
  "message": "Conversion request submitted successfully"
}

Get available payment methods

get

Retrieve list of payment methods

Path parameters

workspaceintegerRequired

Workspace ID

Responses

200

Successful operation

application/json

successbooleanOptionalExample: true

messagestringOptionalExample: paymentMethods

get

/api/organizations/{organization}/plans/payment_method

GET /api/organizations/{organization}/plans/payment_method HTTP/1.1
Accept: */*

200

Successful operation

{
  "success": true,
  "message": "paymentMethods",
  "data": [
    {
      "id": 1,
      "name": "text"
    }
  ]
}

Process plan payment through gateway

post

Create a payment request for a plan through payment gateway

Path parameters

organizationintegerRequired

Organization ID

Body

plan_idintegerOptional

Plan ID

Responses

200

Payment URL generated successfully

application/json

successbooleanOptionalExample: true

messagestringOptionalExample: Payment Url

datastringOptionalExample: https://payment-gateway.com/checkout

400

Validation error

401

Plan does not belong to organization

post

/api/organizations/{organization}/plans/gatway_checkout

POST /api/organizations/{organization}/plans/gatway_checkout HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 13

{
  "plan_id": 1
}

{
  "success": true,
  "message": "Payment Url",
  "data": "https://payment-gateway.com/checkout"
}

Payment gateway callback

get

Handle the payment gateway callback after payment processing

Path parameters

organizationintegerRequired

Organization ID

Query parameters

PaymentIdstringRequired

UserField1stringRequired

Responses

302

Redirect to payment status page

401

Payment validation failed

get

/organizations/{organization}/plans/urway_callback

GET /organizations/{organization}/plans/urway_callback?PaymentId=text&UserField1=text HTTP/1.1
Accept: */*

No content

Create bank charge request for plan

post

Submit a bank transfer request for purchasing a plan with receipt attachment

Path parameters

organizationintegerRequired

Organization ID

Body

plan_idintegerOptional

Plan ID

receipt_attachstring · binaryOptional

Receipt attachment image

Responses

201

Charge request created successfully

application/json

400

Validation error

application/json

401

Plan does not belong to organization

application/json

post

/api/organizations/{organization}/plans/charge_request_bank

POST /api/organizations/{organization}/plans/charge_request_bank HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 39

{
  "plan_id": 1,
  "receipt_attach": "binary"
}

{
  "success": true,
  "message": "Plan payment submitted successfully",
  "data": null
}

PreviousWhatsApp NextPlans

Last updated 9 months ago

hashtagUpload invoice file for a payment

hashtagApprove or reject a payment

hashtagCharge an organization's wallet

hashtagProcess a checkout request for a service

hashtagHandle URWay payment callback

hashtagCalculate the total amount including tax for a specific service

hashtagSubmit a request to convert points to currency or currency to points

hashtagGet available payment methods

hashtagProcess plan payment through gateway

hashtagPayment gateway callback

hashtagCreate bank charge request for plan

Upload invoice file for a payment

Approve or reject a payment

Charge an organization's wallet

Process a checkout request for a service

Handle URWay payment callback

Calculate the total amount including tax for a specific service

Submit a request to convert points to currency or currency to points

Get available payment methods

Process plan payment through gateway

Payment gateway callback

Create bank charge request for plan