REresolvepay
Payments

Create a payment

Trigger a forwarded payment for an invoice belonging to one of your sub-merchants.

Send POST /payments with invoice_id and amount to create the forward payment in the partner API.

The payment will be forwarded from the bank account of the entity that receives payouts. If the payout receiver is the partner, the partner's bank account will be used. If the payout receiver is the sub-merchant, the sub-merchant's bank account will be used.

The invoice must be sent, and the payment amount must not exceed the invoice's outstanding balance.

post/payments

Request

Request body

invoice_idstring required

ID of the invoice to create a payment for. The invoice must belong to one of your sub-merchants and must be sent.

amountnumber double required

Payment amount in dollars. Must be greater than zero and must not exceed the invoice's outstanding balance.

Example request

{
  "invoice_id": "PMMlaE5wbg0",
  "amount": 1000.5
}

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 for a payment dispute.

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

Reason code associated with a forwarded payment. This is populated when the payment was created through the merchant API and may be null for partner API-created payments.

forward_reason_messagestring nullable

Human-readable reason text associated with a forwarded payment. This is populated when the payment was created through the merchant API and may be null for partner API-created payments.

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,
  "payment_links": [
    {
      "record_id": "PMMlaE5wbg0",
      "record_type": "invoice",
      "amount": 500
    }
  ]
}

Changes

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