Create PAYIN
Endpoint
- Method:
POST - Path:
/v1/payins - Purpose: Create a pay-in transaction
- Optional Header:
Idempotency-Key
Request Payload
| Field | Type | Required | Description |
|---|---|---|---|
amount | string (numeric) | Yes | Transaction amount |
paymentMethodCode | string | Yes | Example: BKASH |
customer | object | Yes | Customer info object |
customer.name | string | Yes | Customer name |
customer.email | string | Yes | Customer email |
customer.phone | string | Yes | Customer phone |
customer.deviceId | string | Yes | Device id |
goodsInfo | object | Yes | Product info object |
goodsInfo.name | string | Yes | Product name |
goodsInfo.id | string | Yes | Product/order id |
goodsInfo.price | string (numeric) | Yes | Product price |
Example Payload
{
"amount": "500",
"paymentMethodCode": "BKASH",
"customer": {
"name": "Test Customer",
"email": "customer@example.com",
"phone": "01712345678",
"deviceId": "device-123"
},
"goodsInfo": {
"name": "Test Product",
"id": "prod-1",
"price": "500"
}
}Response
Success (200)
| Field | Type | Description |
|---|---|---|
transactionId | string | Transaction identifier |
status | string | Usually pending initially |
amount | string | Requested amount |
platformOrderId | string | Platform order reference |
paymentInfo | object | Payment details for customer |
expiresAt | string (ISO datetime) | Expiry timestamp |
{
"transactionId": "uuid-here",
"status": "pending",
"amount": "500",
"platformOrderId": "platform-order-id",
"paymentInfo": {},
"expiresAt": "2025-03-09T00:00:00.000Z"
}