Fetch Saved Instruments Token API

Merchant’s backend should call this API to fetch the savedInstrumentsToken that must be passed to the SDK to fetch the saved instruments of the PhonePe user.

API Host and Endpoint

Copied !

Host

Environment	Http Method	API Host URL
`Sandbox`	POST	https://api-preprod.phonepe.com/apis/pg-sandbox
`Production`	POST	https://api.phonepe.com/apis/pg

Endpoint

/payments/v2/sdk/init – Endpoint is common for sandbox and production.

Request Headers

Header Name	Header Value
`Content-Type`	application/json
`Authorization`	O-Bearer <merchant-auth-token>

Request Parameters

Parameter Name	Type	Description
`amount`	Long	Transaction amount in paise, minimum value 1

Sample Request


{
    "amount": 1000
}

Sample Response


{
    “savedInstrumentsToken”: “<token>”,
    “expireAfter”: <token-expires-after>
}

Response Parameters

Parameter Name	Type	Description
`savedInstrumentsToken`	String	Pass this to the PhonePe SDK via the merchant app.
`expireAfter`	Long	TTL of savedInstrumentsToken in seconds

Merchant’s backend should call this API to fetch the savedInstrumentsToken that must be passed to the SDK to fetch the saved instruments of the PhonePe user.

API Host and Endpoint

Copied !

Host

Environment	Http Method	API Host URL
`Sandbox`	POST	https://api-preprod.phonepe.com/apis/pg-sandbox
`Production`	POST	https://api.phonepe.com/apis/pg

Endpoint

/payments/v2/sdk/init – Endpoint is common for sandbox and production.

Request Headers

Header Name	Header Value
`Content-Type`	application/json
`Authorization`	O-Bearer <merchant-auth-token>

Request Parameters

Parameter Name	Type	Description
`amount`	Long	Transaction amount in paise, minimum value 1

Sample Request


{
    "amount": 1000
}

Sample Response


{
    “savedInstrumentsToken”: “<token>”,
    “expireAfter”: <token-expires-after>
}

Response Parameters

Parameter Name	Type	Description
`savedInstrumentsToken`	String	Pass this to the PhonePe SDK via the merchant app.
`expireAfter`	Long	TTL of savedInstrumentsToken in seconds

Merchant’s backend should call this API to fetch the savedInstrumentsToken that must be passed to the SDK to fetch the saved instruments of the PhonePe user.

API Host and Endpoint

Copied !

Host

Environment	Http Method	API Host URL
`Sandbox`	POST	https://api-preprod.phonepe.com/apis/pg-sandbox
`Production`	POST	https://api.phonepe.com/apis/pg

Endpoint

/payments/v2/sdk/init – Endpoint is common for sandbox and production.

Request Headers

Header Name	Header Value
`Content-Type`	application/json
`Authorization`	O-Bearer <merchant-auth-token>

Request Parameters

Parameter Name	Type	Description
`amount`	Long	Transaction amount in paise, minimum value 1

Sample Request


{
    "amount": 1000
}

Sample Response


{
    “savedInstrumentsToken”: “<token>”,
    “expireAfter”: <token-expires-after>
}

Response Parameters

Parameter Name	Type	Description
`savedInstrumentsToken`	String	Pass this to the PhonePe SDK via the merchant app.
`expireAfter`	Long	TTL of savedInstrumentsToken in seconds

Merchant’s backend should call this API to fetch the savedInstrumentsToken that must be passed to the SDK to fetch the saved instruments of the PhonePe user.

API Host and Endpoint

Copied !

Host

Environment	Http Method	API Host URL
`Sandbox`	POST	https://api-preprod.phonepe.com/apis/pg-sandbox
`Production`	POST	https://api.phonepe.com/apis/pg

Endpoint

/payments/v2/sdk/init – Endpoint is common for sandbox and production.

Request Headers

Header Name	Header Value
`Content-Type`	application/json
`Authorization`	O-Bearer <merchant-auth-token>

Request Parameters

Parameter Name	Type	Description
`amount`	Long	Transaction amount in paise, minimum value 1

Sample Request


{
    "amount": 1000
}

Sample Response


{
    “savedInstrumentsToken”: “<token>”,
    “expireAfter”: <token-expires-after>
}

Response Parameters

Parameter Name	Type	Description
`savedInstrumentsToken`	String	Pass this to the PhonePe SDK via the merchant app.
`expireAfter`	Long	TTL of savedInstrumentsToken in seconds

API Host and Endpoint

Host

Endpoint

Request Headers

Request Parameters

Sample Request

Sample Response

Response Parameters

API Host and Endpoint

Host

Endpoint

Request Headers

Request Parameters

Sample Request

Sample Response

Response Parameters

API Host and Endpoint

Host

Endpoint

Request Headers

Request Parameters

Sample Request

Sample Response

Response Parameters

API Host and Endpoint

Host

Endpoint

Request Headers

Request Parameters

Sample Request

Sample Response

Response Parameters

Updated on Jul 02, 2024