payments

Get a Payment Request by ID

Requires the PAYMENT_REQUEST.VIEW permission.

get/v{version}/payment-requests/{resourceId}

Request

  • Base URL: https://test.api.solvimon.com
  • URL: https://test.api.solvimon.com/v{version}/payment-requests/{resourceId}
  • Auth: API key in header X-API-KEY

Path parameters

versionstring required

version

resourceIdstring required

The ID of the resource to be requested.

Query parameters

expand[]string[]

The id fields of the resources that are going to be expanded.

Headers

x-platform-idstring

Platform ID.

Response

OK

object_typestring nullable
idstring nullable
payment_schedule_idstring nullable

The id of the payment schedule

customer_idstring nullable

The id of the customer

status'SCHEDULED' | 'IN_PROGRESS' | 'ON_HOLD' | 'FAILED' | 'DONE' | 'SKIPPED'

The status of the payment request

created_atstring nullable

The moment the payment request was created

execute_atstring nullable

The moment the payment request must be executed

indexinteger nullable

The index of the payment request of the payment schedule

Changes

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