Skip to content

Introduction

Overview of the Payroc API, covering merchant boarding, funding accounts, transaction processing, and core features such as idempotency, metadata, pagination, and versioning.

Browse API reference

Use our API explorer to view a detailed breakdown of our API and to discover how you can integrate with it to do the following:

Board merchants - Add merchants to your organization and set up their accounts.
Manage funding accounts - Move funds to your merchants and other organizations.
Run transactions - Take payments from customers using a range of payment methods.

Our API supports the following features:

We also provide easy-to-use guides that contain all the information you need to integrate with the key functions of our API.

OpenAPI specification

139 operations in this build. Generate clients, mock servers and tests.

Download OpenAPI YAML Download OpenAPI JSON

Postman collection

Every published operation, with request examples and variables ready for your API client.

Browse the API

139 operations

Attachments

Attachments

GETRetrieve attachment/attachments/{attachmentId}

Boarding

Contacts

DELETEDelete contact/contacts/{contactId}GETRetrieve contact/contacts/{contactId}PUTUpdate contact/contacts/{contactId}

Devices

GETSearch devices/devices

Merchant platforms

GETList merchant platform's processing accounts/merchant-platforms/{merchantPlatformId}/processing-accountsGETList merchant platforms/merchant-platformsGETRetrieve merchant platform/merchant-platforms/{merchantPlatformId}POSTCreate merchant platform/merchant-platformsPOSTCreate processing account/merchant-platforms/{merchantPlatformId}/processing-accounts

Owners

DELETEDelete owner/owners/{ownerId}GETRetrieve owner/owners/{ownerId}PUTUpdate owner/owners/{ownerId}

Pricing intents

DELETEDelete pricing intent/pricing-intents/{pricingIntentId}GETList pricing intents/pricing-intentsGETRetrieve pricing intent/pricing-intents/{pricingIntentId}PATCHPartially update pricing intent/pricing-intents/{pricingIntentId}POSTCreate pricing intent/pricing-intentsPUTUpdate pricing intent/pricing-intents/{pricingIntentId}

Processing accounts

GETList contacts/processing-accounts/{processingAccountId}/contactsGETList owners/processing-accounts/{processingAccountId}/ownersGETList processing account's funding accounts/processing-accounts/{processingAccountId}/funding-accountsGETList processing terminals/processing-accounts/{processingAccountId}/processing-terminalsGETList terminal orders/processing-accounts/{processingAccountId}/terminal-ordersGETRetrieve processing account/processing-accounts/{processingAccountId}GETRetrieve processing account pricing agreement/processing-accounts/{processingAccountId}/pricingPOSTCreate reminder for processing account/processing-accounts/{processingAccountId}/remindersPOSTCreate terminal order/processing-accounts/{processingAccountId}/terminal-ordersPOSTUpload attachment to processing account/processing-accounts/{processingAccountId}/attachments

Processing terminals

GETRetrieve a device configuration/processing-terminals/{processingTerminalId}/device-configurations/{model}GETRetrieve host processor configuration/processing-terminals/{processingTerminalId}/host-configurationsGETRetrieve processing terminal/processing-terminals/{processingTerminalId}POSTClose batch for processing terminal/processing-terminals/{processingTerminalId}/close-batch

Terminal orders

GETRetrieve terminal order/terminal-orders/{terminalOrderId}

Payment intents

GETRetrieve payment intent/payment-intents/{paymentIntentId}

Payroc Cloud

Payment instructions

DELETECancel payment instruction/payment-instructions/{paymentInstructionId}GETRetrieve payment instruction/payment-instructions/{paymentInstructionId}POSTSubmit payment instruction/devices/{serialNumber}/payment-instructions

Refund instructions

DELETECancel refund instruction/refund-instructions/{refundInstructionId}GETRetrieve refund instruction/refund-instructions/{refundInstructionId}POSTSubmit refund instruction/devices/{serialNumber}/refund-instructions

Signature instructions

DELETECancel signature instruction/signature-instructions/{signatureInstructionId}GETRetrieve signature instruction/signature-instructions/{signatureInstructionId}POSTSubmit signature instruction/devices/{serialNumber}/signature-instructions

Signatures

GETRetrieve signature/signatures/{signatureId}

Closed-loop reads

GETRetrieve closed loop read/closed-loop-reads/{closedLoopReadId}

Card payments

Payments

GETList payments/paymentsGETRetrieve payment/payments/{paymentId}POSTAdjust payment/payments/{paymentId}/adjustPOSTCapture payment/payments/{paymentId}/capturePOSTCreate payment/paymentsPOSTCreate referenced refund/payments/{paymentId}/refundPOSTReverse payment/payments/{paymentId}/reverse

Refunds

GETList refunds/refundsGETRetrieve refund/refunds/{refundId}POSTAdjust refund/refunds/{refundId}/adjustPOSTCreate unreferenced refund/refundsPOSTReverse refund/refunds/{refundId}/reverse

Bank transfer payments

Bank transfer payments

GETList payments/bank-transfer-paymentsGETRetrieve payment/bank-transfer-payments/{paymentId}POSTClose return/bank-transfer-payments/{paymentId}/closePOSTCreate payment/bank-transfer-paymentsPOSTCreate referenced refund/bank-transfer-payments/{paymentId}/refundPOSTRe-present payment/bank-transfer-payments/{paymentId}/representPOSTReverse payment/bank-transfer-payments/{paymentId}/reverse

Bank transfer refunds

GETList refunds/bank-transfer-refundsGETRetrieve refund/bank-transfer-refunds/{refundId}POSTCreate unreferenced refund/bank-transfer-refundsPOSTReverse refund/bank-transfer-refunds/{refundId}/reverse

Repeat payments

Payment plans

DELETEDelete payment plan/processing-terminals/{processingTerminalId}/payment-plans/{paymentPlanId}GETList payment plans/processing-terminals/{processingTerminalId}/payment-plansGETRetrieve payment plan/processing-terminals/{processingTerminalId}/payment-plans/{paymentPlanId}PATCHPartially update payment plan/processing-terminals/{processingTerminalId}/payment-plans/{paymentPlanId}POSTCreate payment plan/processing-terminals/{processingTerminalId}/payment-plans

Subscriptions

GETList subscriptions/processing-terminals/{processingTerminalId}/subscriptionsGETRetrieve subscription/processing-terminals/{processingTerminalId}/subscriptions/{subscriptionId}PATCHPartially update subscription/processing-terminals/{processingTerminalId}/subscriptions/{subscriptionId}POSTCreate subscription/processing-terminals/{processingTerminalId}/subscriptionsPOSTDeactivate subscription/processing-terminals/{processingTerminalId}/subscriptions/{subscriptionId}/deactivatePOSTPay manual subscription/processing-terminals/{processingTerminalId}/subscriptions/{subscriptionId}/payPOSTRe-activate subscription/processing-terminals/{processingTerminalId}/subscriptions/{subscriptionId}/reactivate

Payment links

Payment links

GETList payment link sharing events/payment-links/{paymentLinkId}/sharing-eventsGETList payment links/processing-terminals/{processingTerminalId}/payment-linksGETRetrieve payment link/payment-links/{paymentLinkId}PATCHPartially update payment link/payment-links/{paymentLinkId}POSTCreate payment link/processing-terminals/{processingTerminalId}/payment-linksPOSTDeactivate payment link/payment-links/{paymentLinkId}/deactivatePOSTShare payment link/payment-links/{paymentLinkId}/sharing-events

Tokenization

Secure tokens

DELETEDelete secure token/processing-terminals/{processingTerminalId}/secure-tokens/{secureTokenId}GETList secure tokens/processing-terminals/{processingTerminalId}/secure-tokensGETRetrieve secure token/processing-terminals/{processingTerminalId}/secure-tokens/{secureTokenId}PATCHPartially update secure token/processing-terminals/{processingTerminalId}/secure-tokens/{secureTokenId}POSTCreate secure token/processing-terminals/{processingTerminalId}/secure-tokensPOSTUpdate account details/processing-terminals/{processingTerminalId}/secure-tokens/{secureTokenId}/update-account

Single use tokens

POSTCreate single use token/processing-terminals/{processingTerminalId}/single-use-tokens

Payment features

Cards

POSTLook up BIN information/cards/bin-lookupPOSTVerify card/cards/verifyPOSTView EBT balance/cards/balance

Bank accounts

POSTVerify bank account/bank-accounts/verify

Currency conversion

POSTVerify DCC eligibility/fx-rates

Hosted Fields

Hosted Fields

POSTCreate Hosted Fields session/processing-terminals/{processingTerminalId}/hosted-fields-sessions

Apple Pay sessions

Apple Pay session

POSTStart Apple Pay session/processing-terminals/{processingTerminalId}/apple-pay-sessions

Funding

Funding accounts

DELETEDelete funding account/funding-accounts/{fundingAccountId}GETList funding accounts/funding-accountsGETRetrieve funding account/funding-accounts/{fundingAccountId}PUTUpdate funding account/funding-accounts/{fundingAccountId}

Funding instructions

DELETEDelete funding instruction/funding-instructions/{instructionId}GETList funding instructions/funding-instructionsGETRetrieve funding instruction/funding-instructions/{instructionId}POSTCreate funding instruction/funding-instructionsPUTUpdate funding instruction/funding-instructions/{instructionId}

Funding recipients

DELETEDelete funding recipient/funding-recipients/{recipientId}GETList funding recipient owners/funding-recipients/{recipientId}/ownersGETList funding recipient's funding accounts/funding-recipients/{recipientId}/funding-accountsGETList funding recipients/funding-recipientsGETRetrieve funding recipient/funding-recipients/{recipientId}POSTCreate funding account/funding-recipients/{recipientId}/funding-accountsPOSTCreate funding recipient/funding-recipientsPOSTCreate funding recipient owner/funding-recipients/{recipientId}/ownersPUTUpdate funding recipient/funding-recipients/{recipientId}

Funding activity

GETList funding activity/funding-activityGETList funding balances/funding-balance

Reporting

Settlement

GETList ACH deposit fees/ach-deposit-feesGETList ACH deposits/ach-depositsGETList authorizations/authorizationsGETList batches/batchesGETList dispute statuses/disputes/{disputeId}/statusesGETList disputes/disputesGETList transactions/transactionsGETRetrieve ACH deposit/ach-deposits/{achDepositId}GETRetrieve authorization/authorizations/{authorizationId}GETRetrieve batch/batches/{batchId}GETRetrieve transaction/transactions/{transactionId}

Notifications

Event Subscriptions

DELETEDelete event subscription/event-subscriptions/{subscriptionId}GETList event subscriptions/event-subscriptionsGETRetrieve event subscription/event-subscriptions/{subscriptionId}PATCHPartially update event subscription/event-subscriptions/{subscriptionId}POSTCreate event subscription/event-subscriptionsPUTUpdate event subscription/event-subscriptions/{subscriptionId}