Get Payment

The following endpoint can be used to retrieve the details of a payment within the Trace AR application.

Point de terminaison

The following endpoint can be used to retrieve a payment. You must replace the {base_url} , {_id} and {site_id} variables with the appropriate values.

GET

{base_url}/api/v4/site/{site_id}/payment/{_id}

Demande

Aucun corps n'est requis pour cet appel API

Réponse

Champ

Type

Description

_id

String

L'identifiant du paiement. Ce champ est généré automatiquement par le système et n'est pas requis lors de la création d'un nouveau paiement, mais il est requis lors de la mise à jour d'un paiement existant.

externalId

String

L'identifiant unique du paiement provenant du système/de la base de données source. Obligatoire lorsque _id n'est pas transmis. Si nous détectons un enregistrement avec le même externalId, il sera mis à jour; sinon, il sera ajouté.

displayName

String

Le nom convivial sécurisé de la méthode de paiement. Exemple : VISA **** 3421.

amount

Number

Le montant qui a été payé. Il s'agit d'un nombre entier de cents, donc 1035 signifie $10.35.

paidOn

Date

La date et l'heure à laquelle le paiement a été effectué. Format = YYYY-MM-DDTHH:mm:ssZ

status

String

L'état actuel du paiement.
Default = captured | One of declined, authorized, captured, voided, settled, returned, refundFailed, refunded, refundSettled

customer

String

L'_id du client qui a effectué le paiement.

site

String

L'identifiant du site

type

String

Le type de méthode de paiement utilisé pour effectuer le paiement.
One of payment_card, ach, cash, check

subType

String

Le sous-type de la méthode de paiement utilisée pour effectuer le paiement.
One of checking, savings, visa, mastercard, discover, amex, cash, other

totals

Les montants totaux du paiement.

isRefund

Boolean

Indique si le paiement est un remboursement d'un autre paiement.

origPayment

String

Pour un remboursement, l'_id du paiement qu'il a remboursé. Omis pour les paiements qui ne sont pas des remboursements.

allocations

Les allocations pour le paiement. Il s'agit d'un tableau d'objets qui spécifient comment le paiement a été alloué à différentes commandes ou remboursements.

paymentTransactionEvents

Les événements de transaction pour le paiement. Il s'agit d'un tableau d'objets qui spécifient l'historique de la transaction de paiement, comme quand elle a été autorisée, capturée, remboursée, etc.

Sample Response

			
{
  "_id": "61f32dc2f62bdc6a48945067",
  "externalId": "62331255",
  "displayName": "VISA **** 5123",
  "site": "6201825a0cf5e23261a08646",
  "customer": "649dc5bb468bd5b5d863c7d1",
  "type": "payment_card",
  "subType": "visa",
  "amount": 3515,
  "totals": {
    "taxes": 0,
    "discounts": 0,
    "total": 3515
  },
  "paidOn": "2021-01-01T14:32:18.000Z",
  "status": "captured",
  "isRefund": false,
  "allocations": [
    {
      "refType": "Invoice",
      "ref": "61f32dc2f62bdc6a48951255",
      "amount": 3515
    }
  ],
  "paymentTransactionEvents": [
    {
      "type": "sale",
      "amount": 3515,
      "successful": true,
      "createdAt": "2021-01-01T14:32:18.000Z",
      "transactionId": "53912387124235234"
    }
  ]
}

Sample Response (Refund)

			
{
  "_id": "61f32dc2f62bdc6a48962418",
  "externalId": null,
  "displayName": "VISA **** 5123",
  "site": "6201825a0cf5e23261a08646",
  "customer": "649dc5bb468bd5b5d863c7d1",
  "type": "payment_card",
  "subType": "visa",
  "amount": 3515,
  "totals": {
    "taxes": 0,
    "discounts": 0,
    "total": 3515
  },
  "paidOn": "2021-01-04T09:12:40.000Z",
  "status": "refunded",
  "isRefund": true,
  "origPayment": "61f32dc2f62bdc6a48945067",
  "allocations": [
    {
      "refType": "Invoice",
      "ref": "61f32dc2f62bdc6a48951255",
      "amount": 3515
    }
  ],
  "paymentTransactionEvents": [
    {
      "type": "refund",
      "amount": 3515,
      "successful": true,
      "createdAt": "2021-01-04T09:12:40.000Z",
      "transactionId": "53912387124298771"
    }
  ]
}