Create a new charge.

1 min

POST

/api/v1/sales/{id}/charges

Creates a new charge for a specific sale and returns it.

Body Parameters

bodyundefinedrequired

Responses

201Created

object
- dataobject
  - idinteger
  - amountnumber<float>
    Example
    100
  - amount_refundednumber<float>
  - amount_leftnumber<float>
  - typeinteger
    Example
    2
    Description
    `1` - Cash `2` - Card `3` - Order `4` - Over Draft `5` - Online `6` - Check `7` - Other `9` - Care Credit `10` - Pet Transfer Acquitted
  - card_brandstring<master_card | visa | american_express | discover | other>
    Example
    master_card
  - main_sale_idstring
    Example
    1
  - main_saleobject
  - main_payment_idstring
    Example
    1
  - main_paymentobject
  - has_single_paymentboolean
  - has_multiple_paymentboolean
    Example
    true
  - paymentsobject[]

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"
    ]
  }
}

curl

curl --request POST \
     --url /api/v1/sales/{id}/charges \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{"body":"undefined"}'

javascript

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

var raw = JSON.stringify({
   "body": "undefined"
});

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

fetch("/api/v1/sales/{id}/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("/api/v1/sales/{id}/charges")

http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Post.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
request.body = JSON.dump({
   "body": "undefined"
})

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

python

import requests
import json

url = "/api/v1/sales/{id}/charges"

payload = json.dumps({
   "body": "undefined"
})
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,
    "amount_refunded": "",
    "amount_left": "",
    "type": 2,
    "card_brand": "master_card",
    "main_sale_id": "1",
    "main_sale": {},
    "main_payment_id": "1",
    "main_payment": {},
    "has_single_payment": false,
    "has_multiple_payment": true,
    "payments": [
      {}
    ]
  }
}

422

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