payments

Get a payment by ID

Requires the PAYMENT.VIEW permission.

get/v{version}/payments/{resourceId}

Request

  • Base URL: https://test.api.solvimon.com
  • URL: https://test.api.solvimon.com/v{version}/payments/{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
created_atstring nullable
timestampstring date-time nullable
customer_idstring nullable
invoice_idstring nullable

Resource ID of type INVOICE

payment_acceptor_idstring nullable

Resource ID of type PAYMENT_ACCEPTOR

payment_acceptor_referencestring nullable
payment_method_idstring nullable

Resource ID of type PAYMENT_METHOD

integration_payment_method_referencestring nullable
external_referencestring
referencestring nullable
result'AUTHORIZED' | 'CANCELLED' | 'CHARGED_BACK' | 'ERROR' | 'PENDING' | 'REFUSED' | 'REFUNDED' | 'PARTIALLY_REFUNDED'
updated_atstring nullable

Changes

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