Get payments for a contract

GET

/contracts/{contractId}/payments

const url = 'https://apisandbox.puurk.com/contracts/example/payments';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://apisandbox.puurk.com/contracts/example/payments \
  --header 'Authorization: Bearer <token>'

Returns all payments associated with a contract

Authorizations

service_token

Parameters

Path Parameters

contractId

required

string

ID of the contract

Responses

200

Successful operation

application/json

Array<object>

object

Unique identifier for the payment

string

type

Type of payment

string

Allowed values: client fee

purpose

Purpose of the payment (e.g. installment, tip, deposit)

string

uid

User ID this payment belongs to

string

oid

Organization ID

string

location_id

Location ID

string

client_id

Client ID this payment belongs to

string

contract_id

Contract ID this payment is allocated to

string

original_contract_id

Original contract ID if payment has been moved to a new contract

string

offer_id

Offer ID this payment is allocated to

string

plan_title

Plan title this payment is allocated to

string

plan_number

Plan number this payment is allocated to

number

scheduled_payment_id

Scheduled payment ID

string

method

Method of payment

string

Allowed values: ach card debit credit cash terminal

payment_account_id

Payment account ID

string

status

Status of the payment

string

Allowed values: authorizing authorized capturing captured declined cancelled canceled partially_refunded refunded returned voided

amount

Payment amount

number format: double

amount_refunded

Amount refunded

number format: double

fee_amount

Fee amount

number format: double

provider_fee_amount

Provider fee amount

number format: double

payout_fee_amount

Payout fee amount

number format: double

total_amount

Total amount

number format: double

premium_amount

Premium amount

number format: double

provider_premium_amount

Provider premium amount

number format: double

puurk_premium_amount

Puurk premium amount

number format: double

principal_amount

Principal amount

number format: double

provider_amount

Provider amount

number format: double

tip_amount

Tip amount

number format: double

tax_amount

Tax amount

number format: double

protection_amount

Protection amount

number format: double

refund_amount

Refund amount

number format: double

gateway

Payment gateway used

string

Allowed values: stripe mock

gateway_id

Gateway ID

string

off_session

Whether payment is off session

boolean

payment_datetime

Payment datetime

string format: date-time

source

Source that created the payment (e.g. manual, checkout)

string

settle_on

Settlement date

string format: date-time

settled_on

Date when payment was settled

string format: date-time

reverse_settle_on

Reverse settlement date

string format: date

reverse_settled_on

Date when payment was reverse settled

string format: date

failure_code

Failure code if payment failed

string

failure_message

Failure message if payment failed

string

decline_code

Stripe’s decline code for a declined card or a returned bank debit, when the gateway supplied one; null until the retry engine is enabled.

string

nullable

retry_category

How Puurk classified the decline for retry purposes: insufficient_funds, do_not_honor, processor_error, expired_card, hard_decline, blocked, needs_customer_action, ach_nsf, ach_return, or platform_error; null until the retry engine is enabled.

string

nullable

retry_attempt_number

1 for the scheduled attempt, incrementing per retry within the cycle; null until the retry engine is enabled.

integer

nullable

retry_next_attempt_at

ISO 8601, 00:00:00 UTC on the day of the next scheduled retry; null when none is scheduled, or until the retry engine is enabled.

string format: date-time

nullable

retry_stop_reason

Why Puurk stopped retrying, when it has: ineligible, manual, cap_reached, method_invalid, platform_error, or exhausted; null until the retry engine is enabled.

string

nullable

memo

Payment memo

string

related_payment_id

Related payment ID

string

created_by

User who created the payment

string

allocation_instructions

Instructions for payment allocation

string

Allowed values: leave_open apply_to_principal

Example

[
  {
    "type": "client",
    "method": "ach",
    "status": "authorizing",
    "gateway": "stripe",
    "allocation_instructions": "leave_open"
  }
]

401

Unauthorized