Testing & Sandbox
Sandbox

Initiate a Contractor Invoice payment

Changed on

Approves the selected issued Contractor Invoices and initiates a bank-transfer payment for them on the company's behalf, as Remote would. The invoices become pending_payment and carry a payment reference, so the payment summary and the pay-in details of a real payment can be read back.

Preconditions:

  • Run POST /v1/sandbox/companies/{company_id}/bypass-eligibility-checks first, so the legal entity has passed KYB.
  • Every contractor on the selected invoices must hold a bank-account payout method, and every contractor in one request must use the same payout method.
  • The company's legal entity must be able to pay in the invoice currency — its default currency, or one it holds an active virtual account for.
  • When the contractors are paid on Remote's licensed rails, the user initiating the payment must have completed identity verification.

Calling it again for invoices that are already pending_payment returns the same payment, creates nothing new and does not retry the pay-in. If pay_in_method stays not_selected after initiation, Remote has not recorded the pay-in: initiate a fresh batch of invoices, or contact Remote.

This endpoint is only available in Sandbox, otherwise it will respond with a 404. There is no pay action on the production API: payments are initiated in Remote.

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.
post/v1/sandbox/contractor-invoices/initiate-payment

Request

  • Base URL: https://gateway.remote.com
  • URL: https://gateway.remote.com/v1/sandbox/contractor-invoices/initiate-payment
  • Auth: HTTP bearer and OAuth 2 (authorization code, authorization URL /auth/oauth2/authorize, token URL /auth/oauth2/token)

Request body

contractor_invoice_idsUuidSlug[] required

Identifiers of the Contractor Invoices to pay. They must all belong to the same payer legal entity and share one currency, and each one may appear only once.

Example request

{
  "contractor_invoice_ids": [
    "663e0b79-c893-45ff-a1b2-f6dcabc098b5",
    "0a4d1a10-2a8c-4d0e-9c1a-2c0bb5f7cd11"
  ]
}

Response

Success

Example response

{
  "data": {
    "status": "ok"
  }
}

Changes