Create a charge for a specific account

URL Expired

The URL for this request expired after 30 days.

Request Parameters

• account_id
  string
  required
  ID of the Account

• line_item_id
  string
^(?!can_).*$
  The ID associated to be with the line item for future requests. If not provided on line item creation, Canopy will generate this field.

• line_item_status
  string
  enum
  Defaults to VALID
  The status of a line item.

• VALID

  • INVALID
  • OFFSET
  • PENDING
  • AUTHORIZED
  • DECLINED
  • VOID
  • POSTED

• original_amount_cents
  integer
  required
  Defaults to 0
  The amount charged (in cents).

• effective_at
  date-time
  The Date-Time that the charge is made applicable to the account. Although a charge may be made today, it can be set effective 10 days prior.

• merchant_data
  object | null

• issuer_processor_metadata
  object

• external_fields
  array,null | object,null

Response Status Codes

• 200 Charge Created
• 401 Unauthorized.
• 403 Forbidden.
• 422 Invalid input
• 429 Too many requests.
• default Unexpected Error.

Example Curl Request

curl --request POST \
     --url https://contact/%20sales%20to%20enable%20your%20sandbox/accounts//line_items/charges \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '\n{\n  "line_item_status": "VALID",\n  "original_amount_cents": 0\n}\n'  

Response Example

{  
  "status": "200",  
  "message": "Charge Created"  
}