UPupflow
Payments

Get Payment

This endpoint can be used to get details of a specific payment by its ID.

get/payments/{paymentId}

Request

  • Base URL
    https://api.upflow.io/v1
  • Auth
    API key in header X-Api-Key and API key in header X-Api-Secret

Response

Payment details.

refNumberstring required

Payment reference number.

currency'EUR' | 'CHF' | 'USD' | 'CAD' | 'GBP' required

ISO 4217 Currency Code

amountinteger required

Payment amount (in cents).

instrument'WIRE_TRANSFER' | 'DIRECT_DEBIT' | 'CARD' | 'CASH' | 'CHECK' | 'UNKNOWN'

Instrument used for the payment.

validatedAtstring date-time required

The date when the payment is validated (ISO 8601 format).

externalIdstring

Payment external identifier.

idstring uuid required

The Payment ID.

type'ACCOUNT' | 'MANUAL' | 'PARSED_INVOICE' | 'API' | 'BATCH_IMPORT' | 'NATIVE_INTEGRATION'

Source or method by which the payment was created.

amountLinkedinteger required

Amount allocated to invoices (in cents).

modifiedAtstring date-time required

The date when the payment was last updated (ISO 8601 format).

createdAtstring date-time

The date at which the payment was created (ISO 8601 format).

updatedAtstring date-time

The date at which the payment was last updated (ISO 8601 format).

Example response

{
  "refNumber": "PYMT123",
  "currency": "EUR",
  "amount": 1700,
  "validatedAt": "2015-05-05T12:30:00Z",
  "externalId": "92842AB37",
  "customFields": [
    {
      "id": "00a70b35-2be3-4c43-aefb-397190134655",
      "externalId": "AEGaaZD"
    }
  ],
  "id": "00a70b35-2be3-4c43-aefb-397190134655",
  "amountLinked": 1700,
  "modifiedAt": "2015-05-05T12:30:00Z",
  "linkedInvoices": [
    {
      "linkedAmount": 3000,
      "invoice": {
        "id": "00a70b35-2be3-4c43-aefb-397190134655",
        "currency": "EUR",
        "amountOutstanding": 1500,
        "customId": "FAC123",
        "grossAmount": 2200,
        "netAmount": 2000,
        "name": "Facture couvrant les prestations de service de Decembre",
        "issuedAt": "2015-05-05T12:30:00Z",
        "dueDate": "2015-05-05T12:30:00Z",
        "paidDate": "2015-05-05T12:30:00Z",
        "externalId": "92842AB37"
      }
    }
  ],
  "customer": {
    "id": "00a70b35-2be3-4c43-aefb-397190134655",
    "externalId": "1a2c3b",
    "companyName": "Upflow SAS",
    "accountingRef": "UPFL-SAS"
  },
  "createdAt": "2015-05-05T12:30:00Z",
  "updatedAt": "2015-05-05T12:30:00Z"
}

Changes

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