API বিবরণ

বর্তমান OpenAPI চুক্তির ফিল্ড ও প্রতিক্রিয়া দেখুন।

OpenAPI চুক্তি

API সংস্করণ 0.9.0-draft · OpenAPI 3.1.0

প্রকাশিত সব পথ

পদ্ধতি	পথ
`GET`	`/v1/workspaces/{workspaceID}/documents/customers`
`POST`	`/v1/workspaces/{workspaceID}/documents/customers`
`GET`	`/v1/workspaces/{workspaceID}/documents/customers/{documentID}`
`PATCH`	`/v1/workspaces/{workspaceID}/documents/customers/{documentID}`
`POST`	`/v1/workspaces/{workspaceID}/documents/customers/commands/import-preview`
`POST`	`/v1/workspaces/{workspaceID}/documents/customers/commands/import`
`POST`	`/v1/workspaces/{workspaceID}/documents/customers/commands/export`
`GET`	`/v1/workspaces/{workspaceID}/documents/invoices`
`POST`	`/v1/workspaces/{workspaceID}/documents/invoices`
`GET`	`/v1/workspaces/{workspaceID}/documents/invoices/{documentID}`
`PATCH`	`/v1/workspaces/{workspaceID}/documents/invoices/{documentID}`
`POST`	`/v1/workspaces/{workspaceID}/documents/invoices/{documentID}/issue`
`POST`	`/v1/workspaces/{workspaceID}/documents/invoices/{documentID}/cancel`
`POST`	`/v1/workspaces/{workspaceID}/documents/invoices/{documentID}/correct`
`POST`	`/v1/workspaces/{workspaceID}/documents/invoices/commands/export`
`GET`	`/v1/workspaces/{workspaceID}/documents/payment-links`
`POST`	`/v1/workspaces/{workspaceID}/documents/payment-links`
`GET`	`/v1/workspaces/{workspaceID}/documents/payment-links/{documentID}`
`PATCH`	`/v1/workspaces/{workspaceID}/documents/payment-links/{documentID}`
`POST`	`/v1/workspaces/{workspaceID}/documents/payment-links/{documentID}/publish`
`POST`	`/v1/workspaces/{workspaceID}/documents/payment-links/{documentID}/archive`
`POST`	`/v1/workspaces/{workspaceID}/documents/payment-links/commands/export`
`GET`	`/v1/workspaces/{workspaceID}/refunds`
`POST`	`/v1/workspaces/{workspaceID}/refunds`
`GET`	`/v1/workspaces/{workspaceID}/refunds/{refundID}`
`POST`	`/v1/workspaces/{workspaceID}/refunds/{refundID}/review`
`POST`	`/v1/workspaces/{workspaceID}/refunds/{refundID}/approve`
`POST`	`/v1/workspaces/{workspaceID}/refunds/{refundID}/reject`
`POST`	`/v1/workspaces/{workspaceID}/refunds/{refundID}/report-returned`
`POST`	`/v1/workspaces/{workspaceID}/refunds/{refundID}/cancel`
`GET`	`/v1/public/documents/{token}`
`POST`	`/v1/public/documents/{token}`
`POST`	`/v1/public/checkout/{token}/refunds`
`GET`	`/v1/workspaces/{workspaceID}/reconciliation`
`POST`	`/v1/workspaces/{workspaceID}/reconciliation/statement-preview`
`POST`	`/v1/workspaces/{workspaceID}/reconciliation/statement-import`
`POST`	`/v1/workspaces/{workspaceID}/reconciliation/settlement-link`
`GET`	`/v1/workspaces/{workspaceID}/integrations`
`POST`	`/v1/workspaces/{workspaceID}/integrations`
`POST`	`/v1/workspaces/{workspaceID}/integrations/{integrationID}/enable`
`POST`	`/v1/workspaces/{workspaceID}/integrations/{integrationID}/disable`
`POST`	`/v1/workspaces/{workspaceID}/integrations/{integrationID}/edit`
`GET`	`/v1/workspaces/{workspaceID}/activity/audit`
`GET`	`/v1/workspaces/{workspaceID}/activity/api`
`GET`	`/v1/workspaces/{workspaceID}/activity/exports`
`GET`	`/v1/workspaces/{workspaceID}/reports`
`GET`	`/v1/workspaces/{workspaceID}/notifications`
`POST`	`/v1/workspaces/{workspaceID}/notifications/{notificationID}/read`
`POST`	`/v1/workspaces/{workspaceID}/privacy/{requestID}/cancel`
`GET`	`/v1/workspaces/{workspaceID}/workspace-tools/team`
`GET`	`/v1/workspaces/{workspaceID}/workspace-tools/settings`
`POST`	`/v1/workspaces/{workspaceID}/workspace-tools/settings`
`GET`	`/v1/workspaces/{workspaceID}/workspace-tools/help`
`POST`	`/v1/workspaces/{workspaceID}/workspace-tools/help`
`GET`	`/v1/workspaces/{workspaceID}/privacy`
`POST`	`/v1/workspaces/{workspaceID}/privacy`
`GET`	`/v1/workspaces/{workspaceID}/billing`
`POST`	`/v1/workspaces/{workspaceID}/billing`
`POST`	`/v1/workspaces/{workspaceID}/billing/{invoiceID}/reconcile`
`POST`	`/v1/workspaces/{workspaceID}/billing/free`
`GET`	`/v1/platform/workspaces/{workspaceID}/payment-usage`
`POST`	`/v1/workspaces/{workspaceID}/workspace-tools/invite`
`POST`	`/v1/workspaces/{workspaceID}/workspace-tools/remove-member/{targetID}`
`POST`	`/v1/workspaces/{workspaceID}/workspace-tools/change-role/{targetID}`
`POST`	`/v1/workspaces/{workspaceID}/workspace-tools/revoke-invite/{targetID}`
`POST`	`/v1/workspaces/{workspaceID}/workspace-tools/resend-invite/{targetID}`
`POST`	`/v1/workspaces/{workspaceID}/workspace-tools/grants/{targetID}`
`POST`	`/v1/workspaces/{workspaceID}/workspace-tools/transfer-owner/{targetID}`
`POST`	`/v1/workspace-invites/accept-invite`
`POST`	`/v1/workspaces/{workspaceID}/exports`
`GET`	`/v1/workspaces/{workspaceID}/exports/{exportID}`
`GET`	`/v1/workspaces/{workspaceID}/exports/{exportID}/download`
`POST`	`/v1/public/documents/{token}/files`
`GET`	`/v1/workspaces/{workspaceID}/sandbox/scenarios`
`GET`	`/v1/workspaces/{workspaceID}/sandbox/runs`
`POST`	`/v1/workspaces/{workspaceID}/sandbox/runs`
`POST`	`/v1/workspaces/{workspaceID}/sandbox/reset`
`POST`	`/v1/workspaces/{workspaceID}/documents/invoices/{documentID}/send`
`POST`	`/v1/workspaces/{workspaceID}/documents/invoices/{documentID}/remind`
`POST`	`/v1/public/checkout/{token}/notices/{noticeAction}`
`GET`	`/v1/workspaces/{workspaceID}/operations/{resource}`
`POST`	`/v1/workspaces/{workspaceID}/operations/{resource}`
`GET`	`/v1/workspaces/{workspaceID}/operations/{resource}/{resourceID}`
`POST`	`/v1/workspaces/{workspaceID}/operations/{resource}/{resourceID}/{action}`
`POST`	`/v1/device/{action}`
`GET`	`/healthz`
`GET`	`/readyz`
`GET`	`/v1/merchant/context`
`GET`	`/v1/workspaces/{workspaceID}/linked-sources`
`POST`	`/v1/workspaces/{workspaceID}/linked-sources`
`POST`	`/v1/payment/create`
`POST`	`/v1/payment/verify`
`GET`	`/v1/payment-intents`
`POST`	`/v1/payment-intents`
`GET`	`/v1/payment-intents/{intentID}`
`POST`	`/v1/payment-intents/{intentID}/cancel`
`POST`	`/v1/payment-intents/{intentID}/verify-transaction`
`GET`	`/v1/workspaces/{workspaceID}/payment-intents`
`POST`	`/v1/workspaces/{workspaceID}/payment-intents`
`GET`	`/v1/workspaces/{workspaceID}/payment-intents/{intentID}`
`POST`	`/v1/workspaces/{workspaceID}/payment-intents/{intentID}/cancel`
`GET`	`/v1/public/checkout/{token}`
`POST`	`/v1/public/checkout/{token}/lock`

পেমেন্ট তৈরি

POST/v1/payment/createpayments:write

ফিল্ড	ধরন	আবশ্যক	বিবরণ
`amount`	`number`	হ্যাঁ	টাকায় পরিমাণ; দশমিকের পরে সর্বোচ্চ দুই ঘর।
`redirect_url`	`uri`	না	পেমেন্ট শেষে ফেরত যাওয়ার প্রকাশ্য HTTPS ঠিকানা।
`webhook_url`	`uri`	না	স্বাক্ষরযুক্ত পেমেন্টের বার্তা নেওয়ার প্রকাশ্য HTTPS ঠিকানা।
`cancel_url`	`uri`	না	বাতিল হলে ফেরত যাওয়ার প্রকাশ্য HTTPS ঠিকানা।
`reference`	`string`	না	নিজের অর্ডারের পরিচয়; না দিলে নিজে তৈরি হবে।
`customer_name`	`string`	না	গ্রাহকের নাম।
`customer_email`	`string`	না	গ্রাহকের ইমেইল ঠিকানা।
`customer_phone`	`string`	না	যোগাযোগের নম্বর; পেমেন্টের প্রমাণ নয়।
`metadata`	`object`	না	অর্ডারের অতিরিক্ত তথ্য; গোপন তথ্য নয়।

পেমেন্ট যাচাই

POST/v1/payment/verifypayments:read

ফিল্ড	ধরন	আবশ্যক	বিবরণ
`invoice_id`	`uuid`	হ্যাঁ	পেমেন্ট তৈরির সময় পাওয়া invoice_id।

প্রতিক্রিয়ার একক

অনুরোধে amount টাকায় দিতে হয়। বর্তমান যাচাই প্রতিক্রিয়ার চুক্তিতে amount_minor পয়সায় ফেরত আসে: 15000 মানে ৳১৫০.০০। তুলনার আগে অর্ডারের পরিমাণ একই এককে নিন; এই পোর্টাল API চুক্তি বদলায় না।

200 OK

{
  "invoice_id": "550e8400-e29b-41d4-a716-446655440000",
  "status": "COMPLETED",
  "amount_minor": 15000,
  "currency": "BDT",
  "reference": "ORDER-123"
}

এখনও প্রকাশিত নয়

করণীয়: প্রকাশ্য নিজস্ব API ঠিকানা নির্ধারণ।
করণীয়: একই অনুরোধের চাবি সংরক্ষণের নিশ্চিত সময়সীমা প্রকাশ।

API বিবরণ

OpenAPI চুক্তি#

পেমেন্ট তৈরি#

পেমেন্ট যাচাই#

প্রতিক্রিয়ার একক#

OpenAPI চুক্তি

পেমেন্ট তৈরি

পেমেন্ট যাচাই

প্রতিক্রিয়ার একক