PIpismo
Payment requests

List payment requests

List previously created payment requests. Filter with either (but not both) account ID in from or to.

get/payments/v1/payment-requests

Request

  • Base URL
    https://sandbox.pismolabs.io
  • URL
    https://sandbox.pismolabs.io/payments/v1/payment-requests
  • Auth
    HTTP bearer

Query parameters

fromstring

Filter results with destination account ID

tostring

Filter results with source account ID

statusstring

Filter results with this payment request status

Headers

x-tenantstring
Example:TN-c0e4c660-9059-404c-ab22-761aa431766c

Unique Org ID.

x-cidstring
Example:c737895c-8159-4c0c-a92a-a4f8600bff37

Related correlation ID. If none is provided, a random one is generated.

Response

OK

amountnumber

Payment request amount.

processing_codestring

Payment request processing code.

tointeger

Target account ID.

expirationstring

Payment request expiration date in UTC-0 (RFC3339) format.

tracking_idstring

Optional unique ID correlating the payment request's associated credit and debit authorizations.

status'PAID' | 'PENDING' | 'EXPIRED' | 'DELETED' | 'REJECTED' | 'CANCELLED' | 'ACTIVE'

Payment request status

idstring

Payment request unique ID.

creation_datestring date-time

Payment request creation date in UTC-0 (RFC3339) format.

metadataMetadata

This optional user-defined key-value object field can be used with external operations to provide additional context or supplementary custom information for the operation.

The Pismo platform does not perform any validation or processing on this field but passes this object to the acquirer in transactions involving calls to the acquirer and sends it in the events related to the stream of data produced at the end of the request.

Note: This field must not be used to send Personally Identifiable Information (PII), Payment Card Industry (PCI) data, or any sensitive/regulated information. Metadata fields are intended for operational, non-sensitive data only. For sensitive data, use the specific parameters designed for that purpose. For more information, refer to Get started with Pismo APIs.

Example response

[
  {
    "amount": 9.95,
    "processing_code": "004000",
    "to": 10,
    "expiration": "2020-05-11T10:39:00.000Z",
    "location": {
      "lat": 12.2,
      "lng": -12.2
    },
    "tracking_id": "1ff51e99-3a05-448a-bc19-7b5c05274174",
    "id": "0f45e7a3-0d9e-4454-be8b-c74a58427946",
    "creation_date": "2020-06-11T10:39:00.000Z",
    "metadata": {
      "any-key": "any-value"
    }
  }
]

Changes

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