tradeConfirmationForPayment

Overview

This query returns a pdf trade confirmation for the payment ID given.

Special Considerations

  • Query takes a payment ID as input.
  • Work with AFEX.

Inputs

QueryTradeConfirmationForPaymentArgs

Required Data

paymentId: string

Returns

Promise<string>

A promise containing a string, the pdf.

Example

Running this query:

query {
  tradeConfirmationForPayments(paymentId: "ckb9pzs16uia3z8f8")
}

Gives us:

{
  "data": "example.pdf"
}

Common Errors

  • You do not have access to the trade confirmation for this payment. (I-4905)

    • Either the payment is incomplete, doesn't exist, or you lack the authority to access the confirmation. Check the payment ID.

  • Error fetching payment confirmation. (I-4906)

    • Third party service has received an error.
← requestedPaymentsNext →