Charge Receivable

Description

Performs the charge of a receivable using the member's credit card. This endpoint should be used when it is necessary to carry out the transaction directly linked to an existing receivable in the system, debiting the specified amount from the credit card associated with the member.

📨 Request Body

The fields necessary for the charge must be provided in the request body.

Parameter	Type	Required	Description
idReceivable	int32	Yes	ID of the receivable to be charged.
idMember	int32	Yes	ID of the member holding the credit card that will make the payment.
idBranch	int32	Yes	ID of the member's branch.
idCreditCard	int32	Yes	ID of the credit card.
amount	int32	Yes	Amount to charge. Must be equal to or greater than the outstanding balance. If greater, the excess is generated as credit in the member's account.

📤 Response Structure

The response returns detailed information about the result of the charge operation.

Field	Type	Description
success	boolean	Indicates whether the operation was successful.
idSale	int32	ID of the sale.
receiptWidth	int32	Width of the receipt.
receipt	string	Receipt.

Request

Authorization

Basic Auth

Send your HTTP requests with an

Authorization

header that contains the word Basic followed by a space and a base64-encoded string username:password

Example:

Authorization: Basic *****************

Body Params

application/json-patch+json

Example

{
    "idReceivable": 0,
    "idMember": 0,
    "idBranch": 0,
    "idCreditCard": 0,
    "amount": 0
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Charge a receivable using a member's credit card

Charge Receivable

Description

📨 Request Body

📤 Response Structure

Request

Request Code Samples

Responses

Charge a receivable using a member's credit card

Charge Receivable#

Description#

📨 Request Body#

📤 Response Structure#

Request

Request Code Samples

Responses

Charge Receivable

Description

📨 Request Body

📤 Response Structure