Contractors
Invoices

Show Contractor Invoice pay-in details

Changed on

Shows how the payment that collects a Contractor Invoice is paid in, and where to send it.

bank_accounts carries Remote's receiving accounts while status is awaiting_payment. It is null once the funds are in flight or received, while the payment sits on a compliance hold (blocked) or is partly paid (partially_paid, where amount_due overstates what remains and Remote follows up with the balance directly), and whenever Remote has no account to publish.

pay_in_method says whether a transfer is yours to send at all: Remote collects direct_debit, card and prefunding_credit payments itself, and a transfer would pay the same invoices twice. That holds after a failed or disputed collection too: the payment reads awaiting_payment with its method unchanged until the company retries it in Remote, so a failed debit is not an invitation to wire, even when accounts are present. Accounts can differ from one payment to the next, so read them before every transfer rather than storing them.

The endpoint answers 404 only while no payment stands behind the invoice. A passing database fault surfaces as a 504 or a 500; retry either.

Authentication

This endpoint accepts any one of the following token types:

  • Company-scoped access token (OAuth2AuthorizationCode) — obtained through the Authorization Code flow or the Refresh Token flow. See Authentication for partners.
  • Customer API token (CustomerAPIToken) — generated by the customer on their Integration Settings page. See Authorization for customers.

Scopes

CategoryRead only ScopeWrite only Scope (read access implicit)
View pay-in bank details (pay_in_details)View pay-in details (pay_in_details:read)-
get/v1/contractor-invoices/{id}/pay-in-details

Request

  • Base URL: https://gateway.remote.com
  • URL: https://gateway.remote.com/v1/contractor-invoices/{id}/pay-in-details
  • Auth: HTTP bearer and OAuth 2 (authorization code, authorization URL /auth/oauth2/authorize, token URL /auth/oauth2/token, scopes: https://gateway.remote.com/company.manage, pay_in_details:read, pay_in_details, all:write, all:read)

Path parameters

idstring uuid required

A unique identifier in UUID v4 format.

Example:663e0b79-c893-45ff-a1b2-f6dcabc098b5

Contractor invoice identifier

Response

Pay-in details

Example response

{
  "data": {
    "pay_in_details": {
      "amount_due": 350000,
      "bank_accounts": [
        {
          "account_holder": "Remote Technology Services, Inc",
          "account_number": "70123456789",
          "ach_routing_number": "021000089",
          "address": {
            "city": "New York",
            "country": "United States",
            "name": "Community Federal Savings Bank",
            "postal_code": "10013",
            "state": "NY",
            "street": "388 Greenwich Street"
          },
          "bank_code": null,
          "bank_name": "Citibank N.A.",
          "branch_code": null,
          "branch_name": null,
          "bsb_code": null,
          "charge": "OUR",
          "clearing_code": null,
          "cnaps_code": null,
          "iban": null,
          "ifsc": null,
          "institution_number": null,
          "intermediary_bank_code": null,
          "sort_code": null,
          "swift": "CITIUS33",
          "transit_number": null,
          "wire_routing_number": "021000089"
        }
      ],
      "currency": "USD",
      "due_date": "2024-06-15",
      "pay_in_method": "bank_transfer",
      "reference": "TR0000000042",
      "status": "awaiting_payment"
    }
  }
}

Changes