Skip to main content

Create a credit memo / Record offline payment

POST 
/api/v3/transaction

Create a credit memo for a customer.

Notes:

  • The transaction_type value MUST be "cre"
  • The gateway_method value MUST be "credit"
  • The gateway_status value should be either 1 (to indicate the payment was successful) or 0 (zero, to log a payment that failed/was declined)

A payment transaction is used to indicate an invoice has been paid (either entirely paid, or partially paid for).

Note: This does not actually charge a credit card or an ACH account. If you're trying to do that, please see the attempt a payment endpoint.

Notes:

  • The transaction_type value MUST be “pay”
  • The gateway_status value should be either 1 (to indicate the payment was successful) or 0 (zero, to log a payment that failed/was declined)
  • The gateway_method value MUST be one of: visa, mastercard, american-express, discover, check, paypal, credit, ach

Request​

Body

    customer_id integer

    Customer ID #

    gateway_id integer

    Payment gateway ID #

    gateway_status integer

    Payment gateway status (1 for success, 0 for failure)

    gateway_transid string

    Payment gateway transaction identifier

    gateway_method string

    Payment gateway method

    gateway_msg string

    A customer-facing error message indicating why the transaction declined/failed

    external_key string

    Transaction external key value

    amount float

    Total transaction amount (refunds will be negative)

    transaction_date date

    Date of the transaction

    transaction_type string

    Transaction type (one of: pay, ref, cre, spl)

    transaction_method string

    Transaction method

    transaction_detail string

    Transaction details

    custom_1 string

    Custom field #1

    custom_2 string

    Custom field #2

    custom_3 string

    Custom field #3

    custom_4 string

    Custom field #4

    custom_5 string

    Custom field #5

    memo string

    Transaction memo

Responses​

Object was created successfully

Schema

    code integer
    status string
    message stringnullable
    details objectnullable

    response

    object

    id integer
Loading...