Sign in

v1

latestOpenAPI 3.1.02026-08-06236494759.4 KB
Pre-approved Spend

Get Purchases

Endpoint to get a specific Purchase by ID.

get/business/v2/purchases/{purchaseId}

Path parameters

purchaseIdstring required

The Purchase ID.

Example:7bf79328-a7ae-4222-aa54-091ff7f429a7

Response

The returned resource is a single Purchase.

idstring

The Purchase ID (sortable: no).

status'SUCCESSFUL' | 'ACTIVE' | 'ASSIGNED' | 'DELETED' | 'EXPIRED' | 'REQUEST_EXTENSION'
titlestring

The name of the Purchase (sortable: no).

descriptionstring

The description of the Purchase (sortable: no).

amountnumber

The maximum spendable amount of the Purchase (sortable: no).

amount_currency'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRO' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLE' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STD' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VED' | 'VEF' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL'
wallet_idstring

The ID of the Wallet the money are taken from, the funding source of the Purchase (sortable: no).

wallet_namestring

The name of the Wallet the money are taken from, the funding source of the Purchase (sortable: no).

has_attachmentsboolean

It determines whether the Purchase has one or more attachments (sortable: no).

notesstring

The notes of the Purchase (sortable: no).

assignee_idstring

The ID of the User assigned to the Purchase (sortable: no).

additional_assignee_idsstring[]

The IDs of any additional User assigned to the Purchase (sortable: no).

assignee_custom_reference_idstring

The custom reference of the User assigned to the Purchase (sortable: no).

author_idstring

The ID of the User that created the Purchase (sortable: no).

author_custom_reference_idstring

The custom reference of the User that created the purchase (sortable: no).

expiration_datestring

The date and time when the Purchase will expire (sortable: no).

card_idstring

The ID of the Card assigned to the Purchase, only available after the redemption Order has been completed (sortable: no).

max_tx_numberinteger

The max number of the Transactions that can be made with the Card.

creation_timestring

The date and time when the Purchase was created (sortable: yes).

last_update_timestring

The date and time when the Purchase was last updated (sortable: yes).

Example response

{
  "id": "7bf79328-a7ae-4222-aa54-091ff7f429a7",
  "title": "Tech book",
  "description": "A purchase to approve",
  "amount": 10.25,
  "wallet_id": "2d65bd5e-3fdf-4002-b166-bde7fb8863fa",
  "wallet_name": "John Doe",
  "has_attachments": true,
  "notes": "Notes about the purchase request",
  "assignee_id": "XMPL1234-000003",
  "assignee_custom_reference_id": "123456-user-1",
  "author_id": "XMPL1234-000001",
  "author_custom_reference_id": "123456-user-2",
  "expiration_date": "2017-06-01T12:48:40Z",
  "card_id": "2d65bd5e-3fdf-4002-b166-bde7fb8863fa",
  "transactions": [
    {
      "id": "c861cc24-6663-410f-8c78-73f886fff4ef",
      "amount": 10.25,
      "completed_time": "2017-06-01T12:48:40Z"
    }
  ],
  "max_tx_number": 3,
  "creation_time": "2017-06-01T12:48:40Z",
  "last_update_time": "2017-06-01T12:48:40Z"
}