Create a Charge

1 min

POST

https://developer.digitail.io/api/v1/charges

Permissions needed: any of (CREATE_CHECKUPS, VIEW_COUNTER_SALE) Creates a new charge for a specific pet parent and clinic and returns it. surcharge is accepted only for DSP integrated saved card payments (when provider_data.payment_method_id is provided).

Query Parameters

include
Description
Additional info to include: mainSale,mainPayment,payments,chargeReceipt

Body Parameters

bodyobjectrequired
- clinic_idinteger
  Example
  1234
  Description
  Clinic is on which pet parent is client on.
- client_idinteger
  Example
  234
  Description
  Pet parent id
- sale_idinteger
  Example
  234
  Description
  Id of sale to associate the charge to, if as_credit is false the sale will be paid first if there are multiple due sales and amount is greater than sale amount due
- amountnumber<float>
  Example
  100
  Format
  float
- typeinteger
  Example
  2
  Description
  1 - Cash 2 - Card 3 - Order 6 - Check 7 - Other
  Allowed
  123467
- card_brandstring<master_card | visa | american_express | discover | other>
  Example
  master_card
  Allowed
  master_cardvisaamerican_expressdiscoverother
- provider_dataobject
  Description
  Required for DSP integrated saved card payments.
  - payment_method_idstring
    Example
    pm_123
    Description
    The saved card payment method id to use for this charge.
- datestring<date-time>
  Example
  2020-01-01T00:00:00Z
  Format
  date-time
- notesstring
  Description
  Payment note
- create_receiptboolean
- as_creditboolean
  Description
  If true charge is not applied to due sales and is kept as client credit
- surchargenumber<float>
  Example
  0.35
  Description
  Surcharge amount to be added to the charge total. Can be sent only for DSP integrated saved card payments (provider_data.payment_method_id).
  Format
  float
  Minimum (exclusive)
  0

Responses

201Created

object
- dataobject
  Description
  A charge is the act of the customer paying the clinic. A charge can later on be allocated to different sales through payments. If no sale is outstanding, the charge will be left as a credit in the customer's account.
  - idinteger
  - amountstring
    Example
    100.00
  - amount_refundedstring
    Example
    0.00
  - amount_leftstring<float>
    Description
    Amount left to refund
    Format
    float
  - made_atstring<date-time>
    Example
    2023-12-14T11:32:44.000000Z
    Format
    date-time
  - typeinteger
    Example
    2
    Description
    1 - Cash 2 - Card 3 - Order 4 - Overdraft 5 - Online 6 - Check 7 - Other 8 - Client Credit 9 - Care Credit 10 - Pet Transfer Acquitted 11 - Credit Note
    Allowed
    1234567891011
  - card_brandcard_brand
  - main_sale_idinteger
    Example
    1
    Description
    Sale id charge is associated to
  - main_saleobject
  - main_payment_idinteger
    Example
    1
  - main_paymentobject
  - has_single_paymentboolean
  - has_multiple_paymentboolean
    Example
    true
  - paymentsdata[]
  - paid_salesdata[]
  - charge_receiptobject

422Bad request

undefined

Example

{
  "message": "The given data was invalid.",
  "errors": {
    "card_brand": [
      "The card brand field can only be provided on Payments with Cards"
    ],
    "surcharge": [
      "The surcharge field can only be provided for DSP integrated saved card payments."
    ]
  }
}

curl

curl --request POST \
     --url https://developer.digitail.io/api/v1/charges \
     --header 'accept: application/json'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");

var requestOptions = {
   method: 'POST',
   headers: myHeaders,
   redirect: 'follow'
};

fetch("https://developer.digitail.io/api/v1/charges", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://developer.digitail.io/api/v1/charges")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Post.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"

response = https.request(request)
puts response.read_body

python

import requests
import json

url = "https://developer.digitail.io/api/v1/charges"

payload = {}
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

201

// Created
{
  "data": {
    "id": 0,
    "amount": "100.00",
    "amount_refunded": "0.00",
    "amount_left": "",
    "made_at": "2023-12-14T11:32:44.000000Z",
    "type": 2,
    "card_brand": {},
    "main_sale_id": 1,
    "main_sale": {},
    "main_payment_id": 1,
    "main_payment": {},
    "has_single_payment": false,
    "has_multiple_payment": true,
    "payments": [
      ""
    ],
    "paid_sales": [
      ""
    ],
    "charge_receipt": {}
  }
}

422

// Bad request
"{\"message\":\"The given data was invalid.\",\"errors\":{\"card_brand\":[\"The card brand field can only be provided on Payments with Cards\"],\"surcharge\":[\"The surcharge field can only be provided for DSP integrated saved card payments.\"]}}"