Get Started

Transaction Details

This table contains all information needed about the incoming payment in order to notify about a status update.

Data Type Field Name Description

Long

Id

Unique identifier assigned by GP2.0 to an incoming payment.

String

parentId

Is applicable only for refunds, the unique transaction id of the transaction against which refund is initiated

String

Reference

A unique Reference assigned to incoming payment

String

invoiceNumber

Invoice number against which this payment is made.

String

externalReference

External reference number

Long

sellerId

Partner ID

String

sellerName

Institution name

String

sellerDisplayName

Institution display name

String

sellerCountry

Institution country

String

payoutCurrency

The currency in which payment is to be made to institution

BigDecimal

payoutAmount

Expected payout amount to Partner/Client

String

Language

Preferred language of the institution

String

Status

Payment status

TransactionType

transactionType

CARD or RECEIVABLE

DealType

dealType

SALE or REFUND

BigDecimal

expectedAmount

Amount the student needs to pay in their quoted currency

String

expectedCurrency

Expected currency (all payment types excluding DCC transactions and MCP transactions where Partner/Client is MOR)

BigDecimal

bookedAmount

Actual amount paid out to Partner/Client

String

buyerBusinessId

Business Id (Student Id)

String

buyerFirstName

Buyer first name

String

buyerLastName

Buyer last name

String

buyerEmail

Buyer email

BigDecimal

paidOutAmount

Actual amount paid out to Partner/Client

String

paymentTypeId

Payment type ID, (refer to section 2.1.2 for definitions)

String

senderName

Sender name

String

senderEmail

Sender email address

String

refundedCurrency

Currency in which refund is to be made

BigDecimal

refundedAmount

Amount refunded in student currency

BigDecimal

refundAmount

Total amount to be refunded (refund amount is university currency)

String

cardCurrency

Card currency (DCC transactions only)

DateTime

createdDate

Date quote was created in GP2.0

DateTime

dueDate

Due date of the payment

DateTime

receivedDate

Date payment is received

DateTime

postedDate

Date the funds are booked to be sent to client

DateTime

authorisedDate

Date payment was authorised

DateTime

settlementDate

Settlement date

DateTime

lastUpdatedDate

Last update time stamp

String

custom1 – custom 20

Payment can have up to 20 custom field as required by Client. These are string type fields which can contain any information defined by Client.