Skip to content

Create a forward payment

Request

Trigger a forward payment against an advanced invoice.

Use this endpoint when the customer has already paid you outside Resolve and you want Resolve to collect its portion from the forwarded amount.

Security
bearerAuth or basicAuth
Bodyapplication/json

Create a forward payment against an advanced invoice.

Send this request when a customer has already paid you outside Resolve and you need to forward the payment to Resolve.

invoice_idstringrequired

ID of the advanced invoice to forward payment against.

Example:"PMMlaE5wbg0"
amountnumber, (double)required

Amount to forward in USD.

Example:500
forward_reason_codestringrequired

Reason code for the forward payment.

This is the field that triggers the forward-payment flow.

Enum:"ach""check""wire""credit_card""other"
Example:"wire"
forward_reason_messagestring

Required when forward_reason_code is other.

Example:"Customer paid by wire transfer outside Resolve."
curl -i -X POST \
  https://docs.resolvepay.com/_mock/merchant-api/openapi/payments \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "invoice_id": "PMMlaE5wbg0",
    "amount": 500,
    "forward_reason_code": "wire",
    "forward_reason_message": "Customer paid by wire transfer outside Resolve."
  }'

Responses

An object representing a payment.

Bodyapplication/json
idstring

Unique identifier for the payment.

Example:"PMMlaE5wbg0"
customer_idstring

Unique identifier of the customer that made the payment.

Example:"X50sgfRd"
sourcestring

Source of the payment.

Enum:"api""merchant_user""admin_user""customer_user""payment_gateway""check""guest_checkout"
Example:"customer_user"
amountnumber, (double)

Amount of the payment in USD.

Example:1000
methodstring

Method of payment made by the customer.

Enum:"check""ach_debit""direct_deposit""card""merchant""unapplied_payment_adjustment""credit_note""adjustment""wire"
Example:"ach_debit"
statusstring

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.
Enum:"pending""in_transit""in_review""paid""failed""canceled"
Example:"paid"
created_atstring, (date-time)

Date the payment was created.

Example:"2020-01-01T00:00:00.730Z"
paid_atstring, (date-time)

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

Example:"2020-01-02T00:00:00.730Z"
canceled_atstring, (date-time)

Date the payment was canceled by request.

Example:null
failed_atstring, (date-time)

Date the payment failed processing.

Example:null
processed_atstring, (date-time)

Date the payment was processed by Resolve.

Example:"2020-01-01T12:00:00.730Z"
scheduled_atstring, (date-time)

Date the payment was scheduled for processing, if applicable.

Example:null
processing_feenumber, (double)

Processing fee for the payment.

Example:25.5
canceled_codestring

Code indicating the reason the payment was canceled.

Example:null
failed_codestring

Code indicating the reason the payment failed processing.

Example:null
dispute_codestring

Code indicating the reason the payment is in dispute.

Example:null
forward_reason_codestring

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.

Enum:"ach""check""wire""credit_card""other"
Example:"check"
forward_reason_messagestring

Free-form reason text for a forward payment.

Required when forward_reason_code is other.

Example:"Customer paid by wire transfer outside Resolve."
created_by_user_idstring

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

Example:null
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", "canceled_at": null, "failed_at": null, "processed_at": "2020-01-01T12:00:00.730Z", "scheduled_at": null, "processing_fee": 25.5, "canceled_code": null, "failed_code": null, "dispute_code": null, "forward_reason_code": "check", "forward_reason_message": "Customer paid by wire transfer outside Resolve.", "payment_links": [ { … } ], "created_by_user_id": null }