Get Payment Details

v1.0.0

Returns the details of a specific payment.

As the customer goes through the process of making the payment the status of the payment will change.

AWAITING_AUTHORISATION -This is the initial status of all your payments.
AUTHORISED - This is the status that your payment is set to after the customer has authorised the payment with their ASPSP / bank.
AWAITING_MULTI_AUTHORISATION - Some business accounts such as charities require dual authorisation.
NOT_AUTHORISED - Either your customer clicked on cancel or the payment was rejected by their ASPSP / bank.
PENDING - This is the status that your payment is set to after the customer has authorised the payment with their ASPSP / bank but the bank may want to carry out another check before funding the transaction.
PAID - Funds were received into your fire.com GBP or EUR account from your customer’s ASPSP / bank.

You will need to enable the PERM_BUSINESS_GET_PAYMENT permission to use this endpoint.

Input

{
  "type": "object",
  "properties": {
    "paymentUuid": {
      "type": "string",
      "description": "The unique id for the transaction."
    }
  },
  "required": [
    "paymentUuid"
  ],
  "additionalProperties": false
}

Output

{
  "type": "object",
  "properties": {
    "additionalFields": {
      "type": "string",
      "description": "These fields will be dispalyed to the payer when using the hosted option. You can choose to display any of `ORDER_ID`, `PRODUCT_ID`, `CUSTOMER_ID`, `CUSTOMER_NUMBER` and `COMMENT2` to the payer."
    },
    "amount": {
      "type": "integer",
      "format": "int64",
      "description": "The requested amount to pay. Note the last two digits represent pennies/cents, (e.g., £1.00 = 100)."
    },
    "collectFields": {
      "type": "string",
      "description": "For the hosted option, the payer will be asked to fill in these fields but they will not be mandatory. You can choose to collect any of the payer's `ADDRESS`, `REFERENCE` and/or `COMMENT1`. If you choose to collect these fields from the payer, you cannot set 'delivery’, 'variableReference’ or 'comment1’ fields respectively."
    },
    "currency": {
      "type": "object",
      "description": "The currency.",
      "properties": {
        "code": {
          "type": "string",
          "description": "The three letter code for the currency - either `EUR` or `GBP`.",
          "enum": [
            "EUR",
            "GBP"
          ]
        },
        "description": {
          "type": "string",
          "description": "The name of the currency"
        }
      }
    },
    "description": {
      "type": "string",
      "description": "A public facing description of the request. This will be shown to the user when they tap or scan the request."
    },
    "expiry": {
      "type": "string",
      "format": "date-time",
      "description": "This is the expiry of the payment request. After this time, the payment cannot be paid."
    },
    "icanTo": {
      "type": "integer",
      "format": "int64",
      "description": "The ican of the account to collect the funds into. Must be one of your fire.com Accounts."
    },
    "mandatoryFields": {
      "type": "string",
      "description": "For the hosted option, these fields will be madatory for the payer to fill in on the hosted payment page. You can choose to collect any the payer's `ADDRESS`, `REFERENCE` and/or `COMMENT1`. If you choose to collect these fields from the payer, you cannot set 'delivery’, 'variableReference’ or 'comment1’ fields respectively."
    },
    "maxNumberPayments": {
      "type": "integer",
      "description": "The max number of people who can pay this request. Must be set to 1 for the ECOMMERCE_GOODS and ECOMMERCE_SERVICES types."
    },
    "myRef": {
      "type": "string",
      "description": "An internal description of the request."
    },
    "orderDetails": {
      "type": "object",
      "properties": {
        "comment1": {
          "type": "string",
          "description": "This is your own comment for the transaction."
        },
        "comment2": {
          "type": "string",
          "description": "This is your own comment for the transaction."
        },
        "customerNumber": {
          "type": "string",
          "description": "Use this field to store a customer number for the transaction (for example)."
        },
        "deliveryAddressLine1": {
          "type": "string",
          "description": "The first line of the delivery address."
        },
        "deliveryAddressLine2": {
          "type": "string",
          "description": "The second line of the delivery address."
        },
        "deliveryCity": {
          "type": "string",
          "description": "Delivery address city"
        },
        "deliveryCountry": {
          "type": "string",
          "description": "2-digit code for the country"
        },
        "deliveryPostCode": {
          "type": "string",
          "description": "Delivery address post code"
        },
        "merchantCustomerIdentification": {
          "type": "string",
          "description": "This is a reference you use to uniquely identify each of your customers."
        },
        "merchantNumber": {
          "type": "string",
          "description": "Your Merchant Number (if applicable)."
        },
        "orderId": {
          "type": "string",
          "description": "Use this field to store the order id for the transaction. The Order Id cannot be set unless the `maxNumberPayments` is 1."
        },
        "productId": {
          "type": "string",
          "description": "Use this field to store a product id for the transaction (for example)."
        },
        "variableReference": {
          "type": "string",
          "description": "Use this field to store any other reference for the transaction (for example, a phone number)."
        }
      }
    },
    "paymentRequestCode": {
      "type": "string",
      "description": "The code that was returned when you created the payment request."
    },
    "paymentUuid": {
      "type": "string",
      "description": "A unique id for the transaction."
    },
    "returnUrl": {
      "type": "string",
      "description": "The merchant return URL where the customer will be re-directed to with the result of the transaction."
    },
    "status": {
      "type": "string",
      "description": "The status of the transaction",
      "enum": [
        "AWAITING_AUTHORISATION",
        "AUTHORISED",
        "AWAITING_MULTI_AUTHORISATION",
        "NOT_AUTHORISED",
        "PAID",
        "REJECTED",
        "ACCEPTED",
        "RECEIVED"
      ]
    },
    "transactionType": {
      "type": "string",
      "description": "The type of payment request payment",
      "enum": [
        "REFUND_REQUEST",
        "PAYMENT"
      ]
    },
    "type": {
      "type": "string",
      "description": "The type of Fire Open Payment that was created",
      "enum": [
        "OTHER"
      ]
    },
    "webhookUrl": {
      "type": "string",
      "description": "A URL to be called in the background with the details of the payment after the payment is complete"
    }
  }
}