REresolvepay
Payments

Fetch a payment

Retrieve an existing payment by its ID.

get/payments/{payment_id}

Request

Path parameters

payment_idstring required

ID of the payment to retrieve

Response

An object representing a payment.

idstring

Unique identifier for the payment.

customer_idstring

Unique identifier of the customer that made the payment.

source'api' | 'merchant_user' | 'admin_user' | 'customer_user' | 'payment_gateway' | 'check' | 'guest_checkout'

Source of the payment.

amountnumber double

Amount of the payment in USD.

method'check' | 'ach_debit' | 'direct_deposit' | 'card' | 'merchant' | 'unapplied_payment_adjustment' | 'credit_note' | 'adjustment' | 'wire'

Method of payment made by the customer.

status'pending' | 'in_transit' | 'in_review' | 'paid' | 'failed' | 'canceled'

Status of the payment.

  • pending - Payment is pending processing.
  • in_transit - Payment has been processed and is in transit.
  • in_review - Payment is being reviewed.
  • paid - Payment has been confirmed and applied to the customer's account.
  • failed - Payment failed confirmation (e.g., bank transfer or credit card payment rejected).
  • canceled - Payment was canceled by request.
created_atstring date-time

Date the payment was created.

paid_atstring date-time

Date the payment was confirmed by Resolve and applied to the customer's account.

canceled_atstring date-time

Date the payment was canceled by request.

failed_atstring date-time

Date the payment failed processing.

processed_atstring date-time

Date the payment was processed by Resolve.

scheduled_atstring date-time

Date the payment was scheduled for processing, if applicable.

processing_feenumber double

Processing fee for the payment.

canceled_codestring

Code indicating the reason the payment was canceled.

failed_codestring

Code indicating the reason the payment failed processing.

dispute_codestring

Code indicating the reason the payment is in dispute.

forward_reason_code'ach' | 'check' | 'wire' | 'credit_card' | 'other'

Reason code for a forward payment.

Use this field to trigger the forward-payment flow. A forward payment is how you tell Resolve that the customer already paid you and that Resolve should collect its portion from the forwarded amount.

forward_reason_messagestring

Free-form reason text for a forward payment.

Required when forward_reason_code is other.

created_by_user_idstring

ID of the user who created the payment, if applicable.

Example response

{
  "id": "PMMlaE5wbg0",
  "customer_id": "X50sgfRd",
  "source": "customer_user",
  "amount": 1000,
  "method": "ach_debit",
  "status": "paid",
  "created_at": "2020-01-01T00:00:00.730Z",
  "paid_at": "2020-01-02T00:00:00.730Z",
  "processed_at": "2020-01-01T12:00:00.730Z",
  "processing_fee": 25.5,
  "forward_reason_code": "check",
  "forward_reason_message": "Customer paid by wire transfer outside Resolve.",
  "payment_links": [
    {
      "record_id": "PMMlaE5wbg0",
      "record_type": "invoice",
      "amount": 500
    }
  ]
}

Changes

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