Skip to main content
POST
/
v1
/
customer_balance_transactions
Create a customer balance transaction
curl --request POST \
  --url https://api.yorlet.com/v1/customer_balance_transactions \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": 123,
  "currency": "<string>",
  "customer": "<string>",
  "description": "<string>"
}
'
{
  "id": "<string>",
  "created": 123,
  "object": "customer_balance_transaction",
  "amount": 123,
  "currency": "<string>",
  "customer": {
    "id": "<string>",
    "created": 123,
    "object": "customer",
    "address": {
      "line1": "<string>",
      "line2": "<string>",
      "city": "<string>",
      "country": "<string>",
      "postal_code": "<string>",
      "state": "<string>"
    },
    "default_payment_method": "<string>",
    "delinquent": true,
    "description": "<string>",
    "email": "[email protected]",
    "invoice_prefix": "<string>",
    "invoicing": {
      "arrears_emails": true,
      "email_cc": [
        "[email protected]"
      ],
      "email_to": "[email protected]"
    },
    "legal": {
      "dob": {
        "day": 16,
        "month": 6.5,
        "year": 5949.5
      },
      "first_name": "<string>",
      "last_name": "<string>"
    },
    "name": "<string>",
    "phone": "<string>",
    "radar": {
      "message": "<string>",
      "reason": "<string>",
      "risk_level": "<string>"
    },
    "account": "<string>",
    "deleted": false,
    "metadata": {}
  },
  "description": "<string>",
  "ending_balance": 123,
  "type": "adjustment",
  "account": "<string>",
  "deleted": false,
  "invoice": {
    "id": "<string>",
    "created": 123,
    "object": "invoice",
    "application": "<string>",
    "assignee": "<string>",
    "billing_reason": "manual",
    "collection_method": "charge_automatically",
    "credit_grant": "<string>",
    "credit_grant_creation": {
      "enabled": true,
      "credit_grant_data": {
        "applicability_config": {
          "limits": {
            "max_credit_per_invoice_item": 123
          }
        },
        "name": "<string>"
      }
    },
    "currency": "<string>",
    "custom_fields": [
      {
        "name": "<string>",
        "value": "<string>"
      }
    ],
    "customer": "<string>",
    "customer_address": {
      "line1": "<string>",
      "line2": "<string>",
      "city": "<string>",
      "country": "<string>",
      "postal_code": "<string>",
      "state": "<string>"
    },
    "customer_email": "<string>",
    "customer_name": "<string>",
    "default_payment_method": "<string>",
    "description": "<string>",
    "discount": {},
    "discount_amount": 123,
    "due_date": 123,
    "ending_balance": 123,
    "finalized_at": 123,
    "footer": "<string>",
    "from_invoice": {
      "action": "<string>",
      "invoice": "<string>"
    },
    "hosted_invoice_url": "<string>",
    "issuer": {
      "type": "owner",
      "owner": "<string>"
    },
    "last_finalization_error": {
      "code": "<string>",
      "message": "<string>"
    },
    "late_payment_failure_invoice": "<string>",
    "latest_revision": "<string>",
    "marked_uncollectible_at": 123,
    "next_payment_attempt": 123,
    "number": "<string>",
    "number_transfer_reference": "<string>",
    "off_platform_reference": "<string>",
    "optimized_collection_date": 123,
    "optimized_collection_reason": "bacs_debit",
    "paid": true,
    "paid_at": 123,
    "paid_off_platform": true,
    "payment_settings": {
      "payment_method_types": [
        "autogiro"
      ]
    },
    "period": {
      "end": 123,
      "start": 123
    },
    "source_dispute": "<string>",
    "starting_balance": 123,
    "status": "draft",
    "subscription": "<string>",
    "transaction": "<string>",
    "transfer_error": {
      "message": "<string>",
      "reason": "<string>"
    },
    "voided_at": 123,
    "account": "<string>",
    "deleted": false,
    "amount_due": 0,
    "amount_paid": 0,
    "amount_remaining": 0,
    "applied_balance": 0,
    "apply_customer_balance": false,
    "attempt_count": 0,
    "attempted": false,
    "auto_advance": false,
    "late_payment_failure": false,
    "metadata": {},
    "part_payment_amount": 0,
    "pending_part_payment": false,
    "pending_transaction": false,
    "post_payment_credit_notes_amount": 0,
    "pre_payment_credit_notes_amount": 0,
    "subtotal": 0,
    "tax": 0,
    "total": 0,
    "total_excluding_tax": 0,
    "total_pretax_credit_amounts": [],
    "total_tax_amounts": [],
    "transfer_data": []
  }
}

Authorizations

Authorization
string
header
required

API Key authentication. Use "Bearer YOUR_API_KEY".

Body

application/json
amount
integer
required

The amount of the transaction.

currency
string
required

The currency of the transaction.

customer
string
required

The ID of the customer the customer balance transaction is for.

description
string | null
required

An arbitrary string attached to the object. Often useful for displaying to users.

Response

200 - application/json

Create a customer balance transaction

id
string
required

Unique identifier for the object.

created
number
required

Time at which the object was created. Measured in seconds since the Unix epoch.

object
enum<string>
required
Available options:
customer_balance_transaction
amount
integer
required

The amount of the transaction.

currency
string
required

The currency of the transaction.

customer
required

The customer this transaction is for.

description
string | null
required

An arbitrary string attached to the object. Often useful for displaying to users.

ending_balance
integer
required

The ending balance of the transaction.

type
enum<string> | null
required

The type of the transaction.

Available options:
adjustment,
applied_to_invoice,
payment,
refund,
null
account
string

The account that the object belongs to. Only returned if the request is made with a valid Yorlet-Context header.

deleted
boolean
default:false

Only returned if the object has been deleted.

invoice

The invoice attached to the transaction.