Codes & Statuses

Reference lists of the values the Payments API returns: types, statuses and codes.

• Sale Types: PayMe sale types: the number returned by queries, the name sent in callbacks, and the sale_type value to send in requests (sale, authorize, token, seller-token, credit, template, multi-capture).
• Sale Statuses: Reference list of sale statuses, from initial and completed to refunded, chargeback and voided, with what each means.
• Understand the sale lifecycle: A sale starts initial. Payment moves it to completed (sale-complete), or authorized for sale_type authorize (sale-authorized). A failed attempt moves it to failed (sale-failure per attempt), but failed isn't final: sale_url stays payable while initial or failed, until sale_expiry_seconds passes (then HTTP 403 and error 367; the status doesn't change). Capture: completed. Void: voided or partial-void. Refund: refunded, or partial-refund (it stays so). Chargeback: chargeback or partial-chargeback; reversal: completed. Confirm with get-sales and send sale_status: initial is hidden by default.
• Transaction Types: Reference list of transaction type numbers, such as Sale, Token, Authorization/Void and Balance.
• Transaction Statuses: Reference list of transaction statuses, from pending and validated to refunds, chargebacks and voids.
• Subscription statuses: Reference list of subscription statuses (sub_status): initial, active, paused, failed, canceled, completed, and failed with a retry pending.
• Subscription iteration types: Reference list of subscription billing intervals (sub_iteration_type): daily, weekly, monthly, yearly and quarterly.
• Bank authorization statuses: Values of authorization_status in the Israeli direct-debit callback, and what each does to the buyer: opened, failed, canceled, moved, reactivated and more.
• Banks in Israel: Israeli bank codes and names, used as seller_bank_code on create-seller and update-seller (unknown code: error 106), with the branch and account-number validation rules (error 165) and the sandbox test bank 54.
• Document types: Values of doc_type for Create a document: work order, delivery note, invoices, invoice receipt, credit invoice, receipts and price offer.