Sign in
Payments

Retrieve a single Payment Intent

get/payment-intents/{id}

Path parameters

idstring uuid required

The ID of the Payment Intent

Query parameters

payerIdstring uuid required

The Payer ID of the Payment Intent

Headers

Trace-Idstring

A valid UUID (V4) for tracing requests. Will be returned as a header. If not present or invalid, a generated UUID will be returned.

End-User-Agentstring

A string representing the User Agent of the end user. Recommended for compliance. Required only when the request is not coming from the end user's browser.

End-User-Ipstring

The IP address of the end user. Recommended for compliance.

End-User-OSstring

The Operating System of the end user. Recommended for compliance.

End-User-Device-Idstring

A unique identifier for the end user's device. Recommended for compliance.

End-User-Device-Manufacturerstring

The manufacturer of the device used by the end user. Recommended for compliance.

End-User-Device-Modelstring

The device model used by the end user. Recommended for compliance.

Response

A Payment Intent object

idstring uuid
status'CAPTURABLE' | 'CAPTURED' | 'EXPIRED' | 'UNCAPTURABLE'
statusReasonsobject[]
deliveryDatestring date
createdAtstring date-time
expiresAtstring date-time

Example response

{
  "id": "9998b94e-9008-4f10-9263-1476d2f7bd40",
  "fees": [
    {
      "amount": {
        "value": 2.9
      },
      "rate": "2.90%"
    }
  ],
  "sourceAmount": {
    "value": 102.9
  },
  "targetAmount": {
    "value": 100
  },
  "paymentMethod": {
    "id": "6f0eb884-3f41-4b57-b86a-80f62dca011e"
  },
  "recipient": {
    "id": "a8d4e641-e130-43d1-90a0-9717561539aa"
  },
  "payer": {
    "id": "8f51c396-6e29-49a6-ba5a-1a31d5420158"
  },
  "details": {
    "accountName": "Jen Doe",
    "accountNumber": "647823643287423",
    "memo": "Payment for Oct. coffee beans inventory",
    "disbursementInformation": {
      "bankName": "Silicon Valley Bank"
    },
    "traceInformation": {
      "reference": "125109006"
    }
  },
  "status": "CAPTURABLE",
  "statusReasons": [],
  "warnings": [
    {
      "code": "WARNING_CODE",
      "message": "Some message with information about this warning"
    }
  ],
  "deliveryDate": "2020-11-20",
  "createdAt": "2020-11-19T01:35:53.096Z",
  "expiresAt": "2020-11-19T01:40:53.096Z",
  "deliveryOptions": [
    {
      "cutoffTime": "2020-11-19T01:40:53.096Z",
      "deliveryDate": "2020-11-20",
      "fees": [
        {
          "amount": {
            "value": 2.9
          },
          "rate": "2.90%"
        }
      ]
    }
  ]
}

Changes

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