PaymentDetails action

Get details about an existing payment.

API endpoint:

PaymentDetails request parameters

RequiredParameterData typeDescription
RequiredtokenGuidThe token obtained when creating the payment.

PaymentDetails Response Parameters

ParameterData typeDescription
responseEnvelope.ackAckCodeAcknowledge code indicating the overall success of the request.
responseEnvelope.timestampDateTimeTimestamp that identifies when the response was sent.
purchaseIdintPayson purchaseId for this payment.
senderEmailstringThe sender’s email address.
statusPaymentStatusThe status of the payment.
typePaymentTypeType of payment.
guaranteeStatusGuaranteeStatusThe status of an ongoing Payson Guarantee payment. This is only set if type is GUARANTEE.
guaranteeDeadlineTimestampDateTimeTimestamp that identifies when the next guarantee deadline is due, if one exists.
invoiceStatusInvoiceStatusThe status of an ongoing Payson Invoice payment. This is only set if type is INVOICE.
customstringA free-form field submitted with the Pay request.
trackingIdstringYour own invoice or tracking id submitted with the Pay request.
receiverList.receiver(n).emailstringEmail address of the receiver.
receiverList.receiver(n).amountstringThe amount to transfer to this receiver.
receiverList.receiver(n).primaryboolDetermines whether this is the primary receiver or not.
currencyCodeCurrencyCodeA three-character currency code.
receiverFeedecimalThe fee charged the receiver of the payment

Shipping address

Invoice shipping address info. Only set if the type is INVOICE and invoiceStatus is one of ORDERCREATED, SHIPPED, DONE or CREDITED. Please note that this address must be used as shipping address.

ParameterData typeDescription
shippingAddress.namestringThe name of the shipment’s receiver.
shippingAddress.streetAddressstringThe shipment receiver’s street address.
shippingAddress.postalCodestringThe shipment receiver’s postal code.
shippingAddress.citystringThe shipment receiver’s city.
shippingAddress.countrystringThe shipment receiver’s country.