Skip to main content
POST

Authorizations

X-SFPY-AGGREGATOR-SECRET-KEY
string
header
required

Path Parameters

raast-aggregator-id
string
required

The unique identifier for the aggregator

Example:

"agg_2288490a-2176-4de5-b373-0ffb6f8e2e6e"

Body

application/json

Request to create an RTP Now or RTP Later

Base RTP creation payload shared across all debitor identifier options.

request_id
string
required

Client-supplied idempotency identifier for the RTP request.

amount
integer
required

Payment amount in the smallest currency unit (PKR).

aggregator_merchant_identifier
string
required

Identifier for the merchant on whose behalf the RTP is initiated.

order_id
string
required

Merchant order identifier associated with the RTP.

type
enum<string>
required

Indicates whether the RTP should be processed immediately or scheduled.

Available options:
RTP_NOW,
RTP_LATER
debitor_raast_id
string
required

Raast alias for the debitor (for example, a mobile number).

expiry_in_minutes
integer

Minutes until the RTP NOW request expires; must be between 1 and 180.

Required range: 1 <= x <= 180
expiry_in_days
integer

Days until the RTP LATER request expires; must be between 1 and 40.

Required range: 1 <= x <= 40

Response

Response envelope returned after a payment request is accepted.

Standard response structure for successful operations

api_version
string

The current version of the API spec

Example:

"v1"

data
object

Data returned when an RTP request is created successfully.