Add Transaction Details

Use this API to input invoice details for a specific transaction. You have the flexibility to upload multiple invoices until the cumulative total of all invoice amounts matches the transaction amount.

POST /gc/transactions/{referenceId}/invoice-details

Add Transaction Details for Partner Merchants

cURL

curl --request POST \
  --url https://sandbox.cashfree.com/gc/transactions/{referenceId}/invoice-details \
  --header 'Content-Type: application/json' \
  --header 'x-api-version: <x-api-version>' \
  --header 'x-partner-api-key: <x-partner-api-key>' \
  --header 'x-partner-merchantid: <x-partner-merchantid>' \
  --data '
{
  "invoiceNumber": "<string>",
  "invoiceAmount": "<string>",
  "invoiceFile": "<string>",
  "remitterName": "<string>",
  "purposeCode": "<string>"
}
'

201

{
  "cmsProfileId": 23802472,
  "cmsPaymentId": 310729,
  "invoiceNumber": "ABC123",
  "invoiceAmount": 1,
  "remitterName": "remitter",
  "status": "SUCCESS"
}

Based on who you are, consider the below values in the API requests

Cashfree Merchant	Cashfree Partner
x-client-id	x-partner-api-key
x-client-secret	x-partner-merchantid

Headers

x-partner-api-key · string · required

Enter partner API keygit

x-partner-merchantid · string · required

Enter the merchant reference id used while creating merchant during onboarding

x-api-version · string · required

API version

Path Parameters

referenceId · string · required

Body

application/json

invoiceNumber · string · required

invoiceAmount · string · required

invoiceFile · file · required

remitterName · string · required

purposeCode · string

Response

201

application/json

Success response for adding invoice details.

cmsProfileId · integer

Example:

23802472

cmsPaymentId · integer

Example:

310729

invoiceNumber · string

Example:

"ABC123"

invoiceAmount · integer

Example:

1

remitterName · string

Example:

"remitter"

status · string

Example:

"SUCCESS"