PIpismo
Marketplace creditor operations

Create creditor operation

Create a creditor operation.

This endpoint generates a Marketplace creditor operation created event.

post/marketplaces/{marketplaceId}/creditors-operations

Request

  • Base URL
    https://sandbox.pismolabs.io/marketplace
  • URL
    https://sandbox.pismolabs.io/marketplace/marketplaces/{marketplaceId}/creditors-operations
  • Auth
    HTTP bearer

Path parameters

marketplaceIdinteger required

Marketplace ID

Headers

Authorizationstring

Authorization token. This is a regular access token, which does not need to include an account ID.

Content-Typestring

Content type

Request body

creditor_idinteger required

Creditor ID. This represents the owner of a business.

first_installment_days_to_paymentinteger required

Number of days before first installment is due

installmentsinteger required

Number of installments

n_installment_days_to_paymentinteger required

Number of days before each subsequent installment is due. The customer has first_installment_days_to_payment days to pay the first installment. They have n_installment_days_to_payment days to pay each installment after that.

card_not_present_allowedboolean

Indicates whether a card-not-present (CNP) transaction is allowed. A CNP transaction is a purchase made virtually, without processing a physical card via a card reader or terminal (and without manually entering a PIN).

doc_number_allowedboolean

Indicates whether document number is allowed.

matched_mdrboolean

Indicates whether this is a matched Merchant Discount Rate (MDR). If false, the fixed transaction fee and the MDR amount is applied only to the first installment. The default value is false.

matched_settlementboolean

Indicates whether this is a matched settlement. A matched settlement means the settlement is paid in several batches, whereas false indicates the full amount is paid in one single payment. The default value is false.

mdrnumber float

MDR fee. The Merchant Discount Rate (MDR) is the rate charged to a merchant for payment processing services on debit and credit card transactions. The merchant must set up this service and agree to the rate before accepting debit and credit cards as payment.

networkstring

Card network

operation_type_idinteger

Operation type ID defined by the Pismo platform.<br> An operation type ID is an operation type processing code, which is a custom alphanumeric identifier that defines how the Pismo platform handles a certain financial operation type. See Processing codes and transaction types for more information.<br> <b>Note:</b> Either operation_type_id or processing_code is required. Using processing_code is recommended as operation_type_id is deprecated and scheduled for removal.

processing_codestring

A processing code is a custom alphanumeric identifier that defines the type of financial operation that the Pismo platform handles.<br> For more information, refer to Processing codes.

start_datestring date

Date from which this operation is considered active. Format = yyyy-mm-dd.

transaction_feenumber

Transaction fee

work_daysboolean

If true, only business days are used to calculate the date of the next payment.

Example request

{
  "creditor_id": 12345,
  "first_installment_days_to_payment": 2,
  "installments": 3,
  "n_installment_days_to_payment": 2,
  "card_not_present_allowed": true,
  "doc_number_allowed": true,
  "matched_mdr": true,
  "matched_settlement": true,
  "mdr": 0.01,
  "network": "Visa",
  "operation_type_id": 4,
  "processing_code": "700203",
  "start_date": "2022-12-21",
  "transaction_fee": 5
}

Response

OK

idinteger

Creditor operation ID

successstring

Indicates whether the creditor was successfully created.

Example response

{
  "id": 128427,
  "success": "true"
}

Changes

No recorded changes to this operation across all 1 revision of this API.