Skip to content
Merchant API/
/
Fetch a payment

Fetch a payment

Request

Retrieve an existing payment by its ID.

Security
bearerAuth or basicAuth
Path
payment_idstringrequired

ID of the payment to retrieve

curl -i -X GET \
  'https://docs.resolvepay.com/_mock/merchant-api/openapi/payments/{payment_id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

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
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,
  "payment_links": [
    { … }
  ],
  "created_by_user_id": null
}