pinpayments_get_balance
Get balance
The current Pin Payments account balance: available (ready to transfer) and pending (available plus estimated funds from charges that have not settled yet), per currency, in the currency's base unit (cents for AUD). GET /balance.
无需输入参数。
pinpayments_list_charges
List charges
List charges (card payments), 25 per page: amount (in the currency's base unit, e.g. cents for AUD), currency, description, payer email, status_message/success, total_fees, merchant_entitlement, amount_refunded, captured, settlement transfers, chargebacks flag, metadata. The card is shown only as scheme and last four digits. GET /charges.
输入参数page
pinpayments_search_charges
Search charges
Search charges by free text (description, email, metadata, cardholder name, currency, exact amount in the currency's base unit, exact charge/card/refund/customer token) and/or a created-date range. GET /charges/search.
输入参数pagesortqueryend_datedirectionstart_date
pinpayments_get_charge
Get charge
One charge by token (ch_...), with fees, refunds total, settlement transfer state and chargeback flag. GET /charges/{token}.
输入参数charge_token必填
pinpayments_list_charge_refunds
List refunds of a charge
All refunds issued against one charge. GET /charges/{token}/refunds.
输入参数pagecharge_token必填
pinpayments_list_refunds
List refunds
List all refunds, 25 per page: amount (in the currency's base unit), currency, charge token, status_message, error_message, created_at. GET /refunds.
输入参数page
pinpayments_get_refund
Get refund
One refund by token (rf_...). GET /refunds/{token}.
输入参数refund_token必填
pinpayments_list_authorisations
List authorisations
List card authorisations (held funds, not yet captured; they expire after seven days) with amount, amount_captured, amount_remaining and expired flags. GET /authorisations.
输入参数page
pinpayments_get_authorisation
Get authorisation
One authorisation by token (auth_...). GET /authorisations/{token}.
输入参数authorisation_token必填
pinpayments_list_customers
List customers
List stored customers, 25 per page: token, email, first_name, last_name, phone_number, company, notes and the primary card as scheme and last four digits. GET /customers.
输入参数page
pinpayments_get_customer
Get customer
One customer by token (cus_...). GET /customers/{token}.
输入参数customer_token必填
pinpayments_list_customer_charges
List a customer's charges
Charges made by one customer. GET /customers/{token}/charges.
输入参数pagecustomer_token必填
pinpayments_list_customer_cards
List a customer's cards
Cards stored for one customer, each shown only as scheme, last four digits and issuing country (no token, expiry or address). GET /customers/{token}/cards.
输入参数pagecustomer_token必填
pinpayments_list_customer_subscriptions
List a customer's subscriptions
Subscriptions of one customer: state, plan, next billing date, active interval, cancellation time. GET /customers/{token}/subscriptions.
输入参数pagecustomer_token必填
pinpayments_list_deposits
List deposits
List deposits made to the account (amount, currency, bank narration, available_at). GET /deposits.
输入参数page
pinpayments_get_deposit
Get deposit
One deposit by token (dpo_...). GET /deposits/{token}.
输入参数deposit_token必填
pinpayments_list_transfers
List transfers
List transfers (payouts to bank accounts), 25 per page: status, amount, debits/credits, paid_at, reference, line item count, bank account (masked) and recipient. GET /transfers.
输入参数page
pinpayments_search_transfers
Search transfers
Search transfers by token, description, amount or recipient details and/or a created-date range. GET /transfers/search.
输入参数pagesortqueryend_datedirectionstart_date
pinpayments_get_transfer
Get transfer
One transfer by token (tfer_...). GET /transfers/{token}.
输入参数transfer_token必填
pinpayments_list_transfer_line_items
List transfer line items
The ledger line items that make up one transfer (charge entitlements, fees, refunds, chargebacks). GET /transfers/{token}/line_items.
输入参数pagetransfer_token必填
pinpayments_list_recipients
List recipients
List transfer recipients (name, email, masked bank account). GET /recipients.
输入参数page
pinpayments_get_recipient
Get recipient
One recipient by token (rp_...). GET /recipients/{token}.
输入参数recipient_token必填
pinpayments_list_recipient_transfers
List a recipient's transfers
Transfers paid to one recipient. GET /recipients/{token}/transfers.
输入参数pagerecipient_token必填
pinpayments_list_disputes
List disputes
List chargeback disputes: category, status, amount, the disputed charge, evidence_required_by and the relevant evidence types. GET /disputes.
输入参数pagesortdirection
pinpayments_search_disputes
Search disputes
Search disputes by status or exact charge token, optionally filtered by status. GET /disputes/search.
输入参数pagesortquerystatusdirection
pinpayments_get_dispute
Get dispute
One dispute by token (dis_...). GET /disputes/{token}.
输入参数dispute_token必填
pinpayments_get_dispute_activity
Get dispute activity
The activity feed of one dispute (status changes, ledger entries such as chargeback fees and recoveries). GET /disputes/{token}/activity.
输入参数dispute_token必填
pinpayments_list_plans
List plans
List subscription plans: name, amount, currency, interval, trial and setup amounts, subscription counts by state. GET /plans.
输入参数page
pinpayments_get_plan
Get plan
One plan by token (plan_...). GET /plans/{token}.
输入参数plan_token必填
pinpayments_list_plan_subscriptions
List a plan's subscriptions
Subscriptions to one plan. GET /plans/{token}/subscriptions.
输入参数pageplan_token必填
pinpayments_list_subscriptions
List subscriptions
List all subscriptions: state (trial, active, cancelling, cancelled), plan, customer, next_billing_date, active interval, cancelled_at. GET /subscriptions.
输入参数page
pinpayments_get_subscription
Get subscription
One subscription by token (sub_...). GET /subscriptions/{token}.
输入参数subscription_token必填
pinpayments_get_subscription_ledger
Get subscription ledger
The ledger entries (credits and debits) of one subscription. GET /subscriptions/{token}/ledger.
输入参数pagesubscription_token必填
pinpayments_list_events
List events
The account's event log (charge.captured, refund.created, dispute.updated, ...), each with the affected record (cards masked). GET /events.
输入参数page
pinpayments_get_event
Get event
One event by token (evt_...). GET /events/{token}.
输入参数event_token必填