Get Payment

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

Point de terminaison

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

GET

{base_url}/api/v3.1/site/{site_id}/payment/{external_id}

Demande

Aucun corps n'est requis pour cet appel API

Réponse

Champ

Type

Description

external_id

String

Le paiement unique id du système/source de données. Si nous détectons un enregistrement avec le même external_id, il sera mis à jour, sinon il sera ajouté.

_id

String

L'identifiant du paiement, attribué par le système.

display_name

String

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

last_4

String

Les 4 derniers chiffres du mode de paiement. Retourné uniquement pour les paiements effectués avec un mode de paiement enregistré; un paiement enregistré par cette API n'en a pas, il est donc omis.

amount

Number

Le montant qui a été payé. Format = 0.00

paid_on

Date

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

gateway_transaction_id

String

L'identifiant unique qui a été attribué à l'enregistrement de paiement par la passerelle lorsque le paiement a été traité.

tip

Number

Le montant du pourboire qui a été ajouté. Format = 0.00

tax

Number

Le montant de taxe qui a été ajouté. Format = 0.00

fee

Number

Le montant des frais qui a été ajouté. Format = 0.00

invoice

Une référence à l'enregistrement Facture. En écriture, c'est ainsi que le paiement est appliqué à Facture; elle est retournée en lecture, avec la liste plus complète allocations.

payment_type

String

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

payment_sub_type

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

status

String

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

created_at

Date

La date à laquelle le paiement a été créé.

updated_at

Date

La date à laquelle le paiement a été dernièrement mis à jour.

reference_number

String

Le numéro de référence unique attribué au paiement par le système et affiché au marchand.

early_pay_discounts_and_late_fees

Number

Le montant net après tout escompte de paiement anticipé et tous frais de retard appliqués au paiement. Format = 0.00

is_refund

Boolean

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

orig_payment

String

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

custom_fields

Object

Les champs personnalisés consignés sur le paiement, sous forme de paires nom/valeur. {} s'il n'y en a aucun.

allocations

Comment le paiement a été appliqué. Un paiement réparti sur plusieurs Factures comporte une entrée par Facture.

Sample Response

			
{
  "_id": "61f32dc2f62bdc6a48945067",
  "external_id": "65432325",
  "reference_number": "N7E6N7T75WM9-PGEM",
  "gateway_transaction_id": "53912387124235234",
  "payment_type": "payment_card",
  "payment_sub_type": "amex",
  "display_name": "AMEX ****** 3422",
  "amount": 30,
  "tip": 0,
  "tax": 0,
  "fee": 0,
  "early_pay_discounts_and_late_fees": 0,
  "paid_on": "2021-03-15T16:32:11Z",
  "status": "captured",
  "is_refund": false,
  "custom_fields": {},
  "allocations": [
    {
      "ref_type": "Invoice",
      "ref": {
        "_id": "61f32dc2f62bdc6a48951255",
        "external_id": "65432661",
        "reference_number": "N7E6NICAC2FE"
      },
      "amount": 30
    }
  ],
  "created_at": "2025-05-30T19:19:44.143Z",
  "updated_at": "2025-05-30T19:19:44.143Z"
}

Sample Response (Refund)

			
{
  "_id": "61f32dc2f62bdc6a48962418",
  "reference_number": "N7E6P2KD81QA-PGEM",
  "gateway_transaction_id": "53912387124298771",
  "payment_type": "payment_card",
  "payment_sub_type": "amex",
  "display_name": "AMEX ****** 3422",
  "amount": 30,
  "tip": 0,
  "tax": 0,
  "fee": 0,
  "early_pay_discounts_and_late_fees": 0,
  "paid_on": "2021-03-18T10:04:52Z",
  "status": "refunded",
  "is_refund": true,
  "custom_fields": {},
  "allocations": [
    {
      "ref_type": "Invoice",
      "ref": {
        "_id": "61f32dc2f62bdc6a48951255",
        "external_id": "65432661",
        "reference_number": "N7E6NICAC2FE"
      },
      "amount": 30
    }
  ],
  "created_at": "2025-06-02T15:04:52.311Z",
  "updated_at": "2025-06-02T15:04:52.311Z",
  "orig_payment": "61f32dc2f62bdc6a48945067"
}