PIpismo
Payment requests

Create payment request

Create a new payment request. Once created, call the Transfer funds endpoint to execute the payment.

For additional information, see the Payment requests guide.

post/payments/v1/payment-requests

Request

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

Headers

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

Unique Org ID.

x-account-idstring

Source account ID (optional). Can be ommited if from specifies the source account ID.

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

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

Request body

amountnumber float required

Payment request amount.

processing_codestring

Payment request processing code.

expirationstring date-time

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

tracking_idstring

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

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 request

{
  "to": {
    "account": {
      "id": 101
    },
    "amount": 12.13,
    "processing_code": "004000",
    "currency": "BRL",
    "beneficiary_id": "2c298321-bc21-4039-9c45-780cc6d4ec46"
  },
  "from": {
    "account": {
      "id": 101
    },
    "amount": 12.13,
    "processing_code": "004000",
    "currency": "BRL",
    "beneficiary_id": "2c298321-bc21-4039-9c45-780cc6d4ec46"
  },
  "amount": 9.95,
  "processing_code": "004000",
  "expiration": "2020-05-11T10:39:00.000Z",
  "tracking_id": "1ff51e99-3a05-448a-bc19-7b5c05274174",
  "metadata": {
    "any-key": "any-value"
  },
  "location": {
    "lat": 12.2,
    "lng": -12.2
  }
}

Response

OK

typestring

Payment request format type.

codestring

Payment request ID code. Token field for Transfer funds (v1/payments)

Example response

{
  "type": "TOKEN",
  "code": "a78f0809-7a22-4485-8e57-abf70168c5f0"
}

Changes

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