APappdirect
Invoice

Pay an Invoice

Changed on

If the invoice is unpaid, will process the payment and return the result. Will return an exception otherwise

post/billing/v1/invoices/{invoiceNumber}/payments

Request

Path parameters

invoiceNumberinteger required

The unique identifier for the invoice provided by the channel.

Request body

amountnumber nullable

Payment amount.

currency'USD' | 'CAD' | 'EUR' | 'JPY' | 'GBP' | 'KRW' | 'CHF' | 'SEK' | 'SGD' | 'MYR' | 'AUD' | 'MXN' | 'INR' | 'BRL' | 'DKK' | 'NZD' | 'NOK' | 'ZAR' | 'PHP' | 'CNY' | 'SAR' | 'GTQ' | 'IDR' | 'ARS' | 'COP' | 'PEN'

Supported currencies for the system

datenumber nullable

Payment date.

idnumber nullable

Payment number.

method'CREDIT_CARD' | 'PAYPAL' | 'MANUAL' | 'EXTERNAL_INVOICE' | 'MARKETPLACE_CREDITS'

The supported payment methods

result'SUCCESSFUL' | 'FAILED' | 'GATEWAY_NOT_AVAILABLE' | 'MANUAL'
transactionIdstring nullable

Transaction ID.

Example request

{
  "amount": 12345,
  "company": {
    "href": "...",
    "id": "..."
  },
  "currency": "INR",
  "date": 12345,
  "gatewayResponse": {
    "avs": true,
    "code": "...",
    "cvv": true,
    "message": "..."
  },
  "id": 12345,
  "links": [
    {
      "href": "...",
      "rel": "..."
    },
    {
      "href": "...",
      "rel": "..."
    }
  ],
  "method": "PAYPAL",
  "result": "GATEWAY_NOT_AVAILABLE",
  "transactionId": "...",
  "user": {
    "href": "...",
    "id": "..."
  }
}

Response

OK

amountnumber nullable

Payment amount.

currency'USD' | 'CAD' | 'EUR' | 'JPY' | 'GBP' | 'KRW' | 'CHF' | 'SEK' | 'SGD' | 'MYR' | 'AUD' | 'MXN' | 'INR' | 'BRL' | 'DKK' | 'NZD' | 'NOK' | 'ZAR' | 'PHP' | 'CNY' | 'SAR' | 'GTQ' | 'IDR' | 'ARS' | 'COP' | 'PEN'

Supported currencies for the system

datenumber nullable

Payment date.

idnumber nullable

Payment number.

method'CREDIT_CARD' | 'PAYPAL' | 'MANUAL' | 'EXTERNAL_INVOICE' | 'MARKETPLACE_CREDITS'

The supported payment methods

result'SUCCESSFUL' | 'FAILED' | 'GATEWAY_NOT_AVAILABLE' | 'MANUAL'
transactionIdstring nullable

Transaction ID.

Example response

{
  "amount": 12345,
  "company": {
    "href": "...",
    "id": "..."
  },
  "currency": "INR",
  "date": 12345,
  "gatewayResponse": {
    "avs": true,
    "code": "...",
    "cvv": true,
    "message": "..."
  },
  "id": 12345,
  "links": [
    {
      "href": "...",
      "rel": "..."
    },
    {
      "href": "...",
      "rel": "..."
    }
  ],
  "method": "PAYPAL",
  "result": "GATEWAY_NOT_AVAILABLE",
  "transactionId": "...",
  "user": {
    "href": "...",
    "id": "..."
  }
}

Changes