Skip to main content
POST
/
gc
/
transactions
/
{referenceId}
/
invoice-details
Add Transaction Details for Partner Merchants
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>",
  "remitterName": "<string>",
  "purposeCode": "<string>"
}'
{
  "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 MerchantCashfree Partner
x-client-idx-partner-api-key
x-client-secretx-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

Successfully added 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"