Secondary Payment source ID via API

Summary

This article explains how to retrieve the payment source ID of a secondary payment method (not marked as a BACKUP) which is applied while creating a subscription via API.

By using the Create subscription api, you can retrieve a transaction ID from the response under Linked Payments. This transaction ID can then be used with the Retrieve Transaction API to extract the payment source ID and override the billing profile if needed.

Description

When creating a subscription with a secondary payment method via API, you might need to extract the payment source ID without setting the method as a ‘backup'.

Here's how you can achieve this through Chargebee's API.

Create Subscription API Response: When you create a subscription using the Create Subscription API with a secondary card, the response will include a linked_payments section. This section contains the Transaction ID associated with the payment. Example Response:

"linked_payments": [
{
"txn_id": "txn_16BSRVUZShRX53j83",
"applied_amount": 55000,
"applied_at": 1736495808,
"txn_status": "success",
"txn_date": 1736495808
}
]

Retrieve Payment Source ID: Use the transaction ID obtained from the previous step with the Retrieve Transaction API to get the payment source ID of the secondary payment method.

Important Notes:

• This method works effectively for regular subscriptions where payments are applied immediately.
• For trial or $0 subscriptions:
  • No charge is applied until the end of the trial period, meaning the Create Subscription API will not generate a transaction ID for these subscriptions.
  • To retrieve the payment source details in such cases, you can use the payment gateway's API.
  • Implement the 3D Secure (3DS) flow using the gateway's JavaScript and server APIs to fetch transaction details.