arrow_back Back to all endpoints
POST https://test-api.finerworks.com/v3/credit_transaction

Credit Transaction

Creates a credit transaction record for users in the account credits ledger. Only available to authorized users.

Body

Request to be submitted via JSON in the body parameter

Name Description Type Additional information
amount Amount of the transaction. This should always be a positive number. decimal

Required

memo Memo text

Required

Max length: 50

widthdrawal Indicate if this is a withrawal or not. boolean

Required

order_id Order associated with this credit transaction. number

Required

account_id Associated account id number

Required

Example JSON Body

application/json, text/json

{
  "amount": 1.0,
  "memo": "sample string 2",
  "widthdrawal": true,
  "order_id": 4,
  "account_id": 5
}

Sample Code Library

curl --location --request POST 'https://test-api.finerworks.com/v3/credit_transaction' \
--header 'Content-Type: application/json' \
--header 'web_api_key: my-web-api-key-goes-here' \
--header 'app_key: my-app-key-goes-here' \
--data-raw '{
  "amount": 1.0,
  "memo": "sample string 2",
  "widthdrawal": true,
  "order_id": 4,
  "account_id": 5
}'