{
"components": {
"securitySchemes": {
"bearerAuth": {
"$ref": "#/x-devx-bundled/ref_eea3e8d8fb1af5850e3d"
}
}
},
"info": {
"contact": {
"email": "helpdesk@payroc.com",
"name": "Payroc Helpdesk",
"url": "https://docs.payroc.com/api"
},
"description": "Api for accessing Payroc services",
"title": "Payroc API",
"version": "1"
},
"openapi": "3.1.0",
"paths": {
"/ach-deposit-fees": {
"get": {
"description": "Retrieve a list of ACH deposit fees.\n\n> **Important:** You must provide a value for either the 'date' query parameter or the 'achDepositId' query parameter.\n",
"operationId": "getAchDepositFees",
"parameters": [
{
"$ref": "#/x-devx-bundled/ref_eb4bec06b486e2ceb76c"
},
{
"$ref": "#/x-devx-bundled/ref_e258178e3e59c83f2c9a"
},
{
"$ref": "#/x-devx-bundled/ref_59a42c003a97fcdab712"
},
{
"description": "Date to retrieve results from. You must provide either the 'achDepositId' or the 'date'.",
"in": "query",
"name": "date",
"schema": {
"example": "2024-07-02",
"format": "date",
"type": "string"
}
},
{
"$ref": "#/x-devx-bundled/ref_77edacc39d6563d3cbed"
},
{
"$ref": "#/x-devx-bundled/ref_ea59515d841f46f0d0e1"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"noActivity": {
"$ref": "#/x-devx-bundled/ref_7ad5ac1e2a5096a96273"
},
"paginatedList": {
"$ref": "#/x-devx-bundled/ref_8ce0797d4dd986ab9a89"
}
},
"schema": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_f9d963d00740bbe00c9e"
},
{
"properties": {
"data": {
"description": "Array of ACH deposit objects.",
"items": {
"$ref": "#/x-devx-bundled/ref_a911f07c5b4759ee8471"
},
"type": "array"
}
},
"required": [
"data"
],
"type": "object"
}
],
"type": "object"
}
}
},
"description": "Successful request. Returns a paginated list of ACH deposit fees."
},
"400": {
"content": {
"application/problem+json": {
"examples": {
"paginationError": {
"$ref": "#/x-devx-bundled/ref_b394dd97f528cb101adf"
},
"parameterError": {
"$ref": "#/x-devx-bundled/ref_33e366b095d33923fb79"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_9477586d4a50bb60f5a4"
}
}
},
"description": "Validation error"
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"403": {
"$ref": "#/x-devx-bundled/ref_e17edbd5866b60d4beb9"
},
"406": {
"$ref": "#/x-devx-bundled/ref_c791fb405083799347c1"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "List ACH deposit fees",
"tags": [
"Settlement"
]
}
},
"/ach-deposits": {
"get": {
"description": "Use this method to return a [paginated](https://docs.payroc.com/api/pagination) list of ACH deposits that we paid to your merchants. \n\n**Note:** If you want to view the details of a specific ACH deposit and you have its achDepositId, use our [Retrieve ACH Deposit](https://docs.payroc.com/api/schema/reporting/settlement/retrieve-ach-deposit) method. \n\nUse query parameters to filter the list of results that we return, for example, to search for ACH deposits that we paid to a specific merchant. \n\n> **Important:** You must provide a value for the date query parameter. \n\nOur gateway returns the following information about each ACH deposit in the list: \n- Merchant that we sent the ACH deposit to.\n- Total amount that we paid the merchant.\n- Breakdown of sales, returns, and fees.\n",
"operationId": "getAchDeposits",
"parameters": [
{
"$ref": "#/x-devx-bundled/ref_eb4bec06b486e2ceb76c"
},
{
"$ref": "#/x-devx-bundled/ref_e258178e3e59c83f2c9a"
},
{
"$ref": "#/x-devx-bundled/ref_59a42c003a97fcdab712"
},
{
"description": "Filter results by the date that the merchant received the ACH deposit.",
"in": "query",
"name": "date",
"required": true,
"schema": {
"example": "2024-07-02",
"format": "date",
"type": "string"
}
},
{
"$ref": "#/x-devx-bundled/ref_ea59515d841f46f0d0e1"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"noActivity": {
"$ref": "#/x-devx-bundled/ref_7ad5ac1e2a5096a96273"
},
"paginatedList": {
"$ref": "#/x-devx-bundled/ref_faf1a830a92d4db7bd17"
}
},
"schema": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_f9d963d00740bbe00c9e"
},
{
"properties": {
"data": {
"description": "Array of ACH deposit objects.",
"items": {
"$ref": "#/x-devx-bundled/ref_3460aa5ce7d26ebeac26"
},
"type": "array"
}
},
"required": [
"data"
],
"type": "object"
}
],
"type": "object"
}
}
},
"description": "Successful request. Returns a paginated list of ACH deposits."
},
"400": {
"content": {
"application/problem+json": {
"examples": {
"paginationError": {
"$ref": "#/x-devx-bundled/ref_b394dd97f528cb101adf"
},
"parameterError": {
"$ref": "#/x-devx-bundled/ref_33e366b095d33923fb79"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_9477586d4a50bb60f5a4"
}
}
},
"description": "Validation error"
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"403": {
"$ref": "#/x-devx-bundled/ref_e17edbd5866b60d4beb9"
},
"406": {
"$ref": "#/x-devx-bundled/ref_c791fb405083799347c1"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "List ACH deposits",
"tags": [
"Settlement"
]
}
},
"/ach-deposits/{achDepositId}": {
"get": {
"description": "Use this method to retrieve information about an ACH deposit that we paid to a merchant. \n\n**Note:** To retrieve an ACH deposit, you need its achDepositId. If you don't have the achDepositId, use our [List ACH Deposits](https://docs.payroc.com/api/schema/reporting/settlement/list-ach-deposits) method to search for the ACH deposit. \n\nOur gateway returns the following information about the ACH deposit: \n\n- Merchant that we sent the ACH deposit to. \n- Total amount that we paid the merchant. \n- Breakdown of sales, returns, and fees. \n",
"operationId": "getAchDeposit",
"parameters": [
{
"$ref": "#/x-devx-bundled/ref_ed895fe230c39097d47a"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"retrieveAchDepositResponse": {
"$ref": "#/x-devx-bundled/ref_0a6bd7f4cbca22d74320"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_3460aa5ce7d26ebeac26"
}
}
},
"description": "Successful request. Returns the requested ACH deposit."
},
"400": {
"content": {
"application/problem+json": {
"examples": {
"idError": {
"$ref": "#/x-devx-bundled/ref_28af77069da9ddbc9a01"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_9477586d4a50bb60f5a4"
}
}
},
"description": "Validation error"
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"403": {
"$ref": "#/x-devx-bundled/ref_e17edbd5866b60d4beb9"
},
"404": {
"$ref": "#/x-devx-bundled/ref_49bf9231904bbd9aa1c0"
},
"406": {
"$ref": "#/x-devx-bundled/ref_c791fb405083799347c1"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "Retrieve ACH deposit",
"tags": [
"Settlement"
]
}
},
"/attachments/{attachmentId}": {
"get": {
"description": "Use this method to retrieve the details of an attachment. \n\nTo retrieve the details of an attachment you need its attachmentId. Our gateway returned the attachmentId in the response of the [Upload Attachment to Processing Account](https://docs.payroc.com/api/schema/boarding/processing-accounts/upload-to-processing-account) method. \n\nOur gateway returns information about the attachment, including its upload status and the entity that the attachment is linked to. Our gateway doesn't return the file that you uploaded. \n",
"operationId": "getAttachment",
"parameters": [
{
"$ref": "#/x-devx-bundled/ref_60a40c9edfc460ad1dab"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"attachment": {
"$ref": "#/x-devx-bundled/ref_8db6575413e6e6ff617a"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_6e5f6c82188ec67f61c8"
}
}
},
"description": "Successful request. Returns the attachment."
},
"400": {
"$ref": "#/x-devx-bundled/ref_ae89d3d539618a89d2dd"
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"403": {
"$ref": "#/x-devx-bundled/ref_e17edbd5866b60d4beb9"
},
"404": {
"$ref": "#/x-devx-bundled/ref_49bf9231904bbd9aa1c0"
},
"406": {
"$ref": "#/x-devx-bundled/ref_c791fb405083799347c1"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "Retrieve attachment",
"tags": [
"Attachments"
]
}
},
"/authorizations": {
"get": {
"description": "Use this method to retrieve a [paginated](https://docs.payroc.com/api/pagination) list of authorizations. \n\nUse query parameters to filter the list of results that we return, for example, to search for authorizations linked to a specific merchant. \n\n> **Important:** You must provide a value for either the date query parameter or the batchId query parameter. \n\nOur gateway returns the following information about each authorization in the list:\n- Authorization response from the issuing bank.\n- Amount that the issuing bank authorized.\n- Merchant that ran the authorization.\n- Details about the customer's card, the transaction, and the batch.\n",
"operationId": "getAuthorizations",
"parameters": [
{
"$ref": "#/x-devx-bundled/ref_eb4bec06b486e2ceb76c"
},
{
"$ref": "#/x-devx-bundled/ref_e258178e3e59c83f2c9a"
},
{
"$ref": "#/x-devx-bundled/ref_59a42c003a97fcdab712"
},
{
"$ref": "#/x-devx-bundled/ref_c44068086d1083ebf58a"
},
{
"$ref": "#/x-devx-bundled/ref_39b2977516ad960a5b10"
},
{
"$ref": "#/x-devx-bundled/ref_ea59515d841f46f0d0e1"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"noActivity": {
"$ref": "#/x-devx-bundled/ref_7ad5ac1e2a5096a96273"
},
"paginatedList": {
"$ref": "#/x-devx-bundled/ref_26e232823eb4af447e3b"
}
},
"schema": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_f9d963d00740bbe00c9e"
},
{
"properties": {
"data": {
"description": "Array of authorization objects.",
"items": {
"$ref": "#/x-devx-bundled/ref_38167371beaf6208ef91"
},
"type": "array"
}
},
"required": [
"data"
],
"type": "object"
}
],
"type": "object"
}
}
},
"description": "Successful request. Returns a paginated list of authorizations."
},
"400": {
"content": {
"application/problem+json": {
"examples": {
"paginationError": {
"$ref": "#/x-devx-bundled/ref_b394dd97f528cb101adf"
},
"parameterError": {
"$ref": "#/x-devx-bundled/ref_33e366b095d33923fb79"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_9477586d4a50bb60f5a4"
}
}
},
"description": "Validation error"
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"403": {
"$ref": "#/x-devx-bundled/ref_e17edbd5866b60d4beb9"
},
"406": {
"$ref": "#/x-devx-bundled/ref_c791fb405083799347c1"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "List authorizations",
"tags": [
"Settlement"
]
}
},
"/authorizations/{authorizationId}": {
"get": {
"description": "Use this method to retrieve information about an authorization. \n\n**Note:** To retrieve an authorization, you need its authorizationId. If you don't have the authorizationId, use our [List Authorizations](https://docs.payroc.com/api/schema/reporting/settlement/list-authorizations) method to search for the authorization. \n\nOur gateway returns the following information about the authorization:\n- Authorization response from the issuing bank.\n- Amount that the issuing bank authorized.\n- Merchant that ran the authorization.\n- Details about the customer's card, the transaction, and the batch.\n",
"operationId": "getAuthorization",
"parameters": [
{
"$ref": "#/x-devx-bundled/ref_e3c7678fac680cc8015b"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"retrieveAuthorizationResponse": {
"$ref": "#/x-devx-bundled/ref_c8f4fa759ab78a27b39c"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_38167371beaf6208ef91"
}
}
},
"description": "Successful request. Returns the requested authorization."
},
"400": {
"$ref": "#/x-devx-bundled/ref_ae89d3d539618a89d2dd"
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"403": {
"$ref": "#/x-devx-bundled/ref_e17edbd5866b60d4beb9"
},
"404": {
"$ref": "#/x-devx-bundled/ref_49bf9231904bbd9aa1c0"
},
"406": {
"$ref": "#/x-devx-bundled/ref_c791fb405083799347c1"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "Retrieve authorization",
"tags": [
"Settlement"
]
}
},
"/bank-accounts/verify": {
"post": {
"description": "Use this method to verify a customer's bank account details. \n\nIn the request, send the customer's bank account details. Our gateway can verify the following types of bank details: \n- Automated Clearing House (ACH) details \n- Pre-Authorized Debit (PAD) details \n\nIn the response, our gateway indicates if the account details are valid and if you should use them in follow-on actions. \n \n",
"operationId": "verifyBankAccount",
"parameters": [
{
"$ref": "#/x-devx-bundled/ref_b92d206f2e50ffc4c068"
}
],
"requestBody": {
"content": {
"application/json": {
"examples": {
"verifyBankAccountAchRequest": {
"$ref": "#/x-devx-bundled/ref_cf90a713b43d9f748754"
},
"verifyBankAccountPadRequest": {
"$ref": "#/x-devx-bundled/ref_50c6f808250ff4a84ea9"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_5ad699da95aecdeeae2d"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"verifyBankAccountAchResponse": {
"$ref": "#/x-devx-bundled/ref_837868fc01b96f4271ad"
},
"verifyBankAccountPadResponse": {
"$ref": "#/x-devx-bundled/ref_36928188f6dabc3fb610"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_c4fe60b71e4150611cad"
}
}
},
"description": "Successful request. Returns the verification status of the customer's bank account details."
},
"400": {
"content": {
"application/problem+json": {
"examples": {
"idempotentKeyInUse": {
"$ref": "#/x-devx-bundled/ref_3917c6024cc650b3ea83"
},
"idempotentKeyMissing": {
"$ref": "#/x-devx-bundled/ref_d9867eacc8169139adec"
},
"validationError": {
"$ref": "#/x-devx-bundled/ref_2b3621a1c5ae119c6693"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_9477586d4a50bb60f5a4"
}
}
},
"description": "Validation error"
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"403": {
"$ref": "#/x-devx-bundled/ref_e17edbd5866b60d4beb9"
},
"404": {
"$ref": "#/x-devx-bundled/ref_49bf9231904bbd9aa1c0"
},
"406": {
"$ref": "#/x-devx-bundled/ref_c791fb405083799347c1"
},
"409": {
"$ref": "#/x-devx-bundled/ref_33a47f40f610a3ad4109"
},
"415": {
"$ref": "#/x-devx-bundled/ref_40869c40b438e4591cbc"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "Verify bank account",
"tags": [
"Bank accounts"
]
}
},
"/bank-transfer-payments": {
"get": {
"description": "Use this method to return a [paginated](https://docs.payroc.com/api/pagination) list of payments. \n\n**Note:** If you want to view the details of a specific payment and you have its paymentId, use our [Retrieve Payment](https://docs.payroc.com/api/schema/bank-transfer-payments/payments/retrieve) method. \n\nUse query parameters to filter the list of results that we return, for example, to search for payments for a customer, a date range, or a settlement state. \n\nOur gateway returns the following information about each payment in the list: \n\n- Order details, including the transaction amount and when it was processed. \n- Bank account details, including the customer’s name and account number. \n- Customer's details, including the customer’s phone number. \n- Transaction details, including any refunds or re-presentments. \n\nFor each transaction, we also return the paymentId and an optional secureTokenId, which you can use to perform follow-on actions. \n",
"operationId": "listBankTransferPayments",
"parameters": [
{
"$ref": "#/x-devx-bundled/ref_56fb59ea73f456ce6c1e"
},
{
"$ref": "#/x-devx-bundled/ref_8f2d2339a1306a14acd3"
},
{
"$ref": "#/x-devx-bundled/ref_aa08a6b5181eb570f201"
},
{
"$ref": "#/x-devx-bundled/ref_43021934074700baba3c"
},
{
"$ref": "#/x-devx-bundled/ref_142be7cd484c5802cb79"
},
{
"$ref": "#/x-devx-bundled/ref_a38d1197edd9f3650cd6"
},
{
"$ref": "#/x-devx-bundled/ref_dcbbdede824381a2835b"
},
{
"$ref": "#/x-devx-bundled/ref_1c54aece4f1b17738900"
},
{
"$ref": "#/x-devx-bundled/ref_598cfb3afda24a016a26"
},
{
"$ref": "#/x-devx-bundled/ref_77b5fb747c9a6c1ea0a5"
},
{
"$ref": "#/x-devx-bundled/ref_8896a0cf9b51c598f769"
},
{
"$ref": "#/x-devx-bundled/ref_eb4bec06b486e2ceb76c"
},
{
"$ref": "#/x-devx-bundled/ref_e258178e3e59c83f2c9a"
},
{
"$ref": "#/x-devx-bundled/ref_59a42c003a97fcdab712"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"noActivity": {
"$ref": "#/x-devx-bundled/ref_7ad5ac1e2a5096a96273"
},
"paginatedResults": {
"$ref": "#/x-devx-bundled/ref_0378dbfda3aaeccfef2d"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_7dc8d292519db9a2cdd0"
}
}
},
"description": "Successful request. Returns a list of payments."
},
"400": {
"$ref": "#/x-devx-bundled/ref_ae89d3d539618a89d2dd"
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"403": {
"$ref": "#/x-devx-bundled/ref_e17edbd5866b60d4beb9"
},
"406": {
"$ref": "#/x-devx-bundled/ref_c791fb405083799347c1"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "List payments",
"tags": [
"Bank transfer payments"
]
},
"post": {
"description": "Use this method to run a sale with a customer's bank account details. \n\nIn the response, our gateway returns information about the bank transfer payment and a paymentId, which you need for the following methods: \n-\t[Retrieve payment](https://docs.payroc.com/api/schema/bank-transfer-payments/payments/retrieve) - View the details of the bank transfer payment.\n-\t[Reverse payment](https://docs.payroc.com/api/schema/bank-transfer-payments/refunds/reverse-payment) - Cancel the bank transfer payment if it's an open batch.\n-\t[Refund payment](https://docs.payroc.com/api/schema/bank-transfer-payments/refunds/refund) - Run a referenced refund to return funds to the customer's bank account.\n\n**Payment methods** \n\nOur gateway accepts the following payment methods: \n-\tAutomated clearing house (ACH) details\n-\tPre-authorized debit (PAD) details \n\nYou can also use [secure tokens](https://docs.payroc.com/api/schema/payments/secure-tokens/overview) and [single-use tokens](https://docs.payroc.com/api/schema/tokenization/single-use-tokens/create) that you created from ACH details or PAD details. \n",
"operationId": "bankTransferPayment",
"parameters": [
{
"$ref": "#/x-devx-bundled/ref_b92d206f2e50ffc4c068"
}
],
"requestBody": {
"content": {
"application/json": {
"examples": {
"createdBankTransferPaymentStoreToken": {
"$ref": "#/x-devx-bundled/ref_de8b01992f3a8526085d"
},
"secureTokenRepeatPaymentRequest": {
"$ref": "#/x-devx-bundled/ref_4052cf0ae88fc0b68fd4"
},
"singleUseTokenSaleRequest": {
"$ref": "#/x-devx-bundled/ref_512556cc226fd696bef9"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_e1da9671f0c63820f66b"
}
}
},
"required": true
},
"responses": {
"201": {
"content": {
"application/json": {
"examples": {
"createdBankTransferPaymentStoreToken": {
"$ref": "#/x-devx-bundled/ref_37ddbc3abaadbc5fe0a6"
},
"secureTokenRepeatPaymentResponse": {
"$ref": "#/x-devx-bundled/ref_3b22179a595bc4f9519d"
},
"singleUseTokenSaleResponse": {
"$ref": "#/x-devx-bundled/ref_767f7633cd631493d2ab"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_b78a8dc49545610d9bab"
}
}
},
"description": "Successful request. We processed the sale.",
"headers": {
"location": {
"$ref": "#/x-devx-bundled/ref_7b13ec5af2d2b1d9f8e7"
}
}
},
"400": {
"content": {
"application/problem+json": {
"examples": {
"idempotentKeyInUse": {
"$ref": "#/x-devx-bundled/ref_3917c6024cc650b3ea83"
},
"idempotentKeyMissing": {
"$ref": "#/x-devx-bundled/ref_d9867eacc8169139adec"
},
"validationError": {
"$ref": "#/x-devx-bundled/ref_2b3621a1c5ae119c6693"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_9477586d4a50bb60f5a4"
}
}
},
"description": "Validation error"
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"403": {
"$ref": "#/x-devx-bundled/ref_e17edbd5866b60d4beb9"
},
"406": {
"$ref": "#/x-devx-bundled/ref_c791fb405083799347c1"
},
"409": {
"$ref": "#/x-devx-bundled/ref_33a47f40f610a3ad4109"
},
"415": {
"$ref": "#/x-devx-bundled/ref_40869c40b438e4591cbc"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "Create payment",
"tags": [
"Bank transfer payments"
]
}
},
"/bank-transfer-payments/{paymentId}": {
"get": {
"description": "Use this method to retrieve information about a bank transfer payment. \n\nTo retrieve a payment, you need its paymentId. Our gateway returned the paymentId in the response of the [Create Payment](https://docs.payroc.com/api/schema/bank-transfer-payments/payments/create) method. \n\nNote: If you don’t have the paymentId, use our [List Payments](https://docs.payroc.com/api/schema/bank-transfer-payments/payments/list) method to search for the payment. \n\nOur gateway returns the following information about the payment: \n\n-\tOrder details, including the transaction amount and when it was processed. \n-\tBank account details, including the customer’s name and account number. \n-\tCustomer’s details, including the customer’s phone number. \n-\tTransaction details, including any refunds or re-presentments. \n\nIf the merchant saved the customer’s bank account details, our gateway returns a secureTokenID, which you can use to perform follow-on actions.\n",
"operationId": "getBankTransferPayment",
"parameters": [
{
"$ref": "#/x-devx-bundled/ref_ecf2f0f7e7e376484555"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"bankTransferPayment": {
"$ref": "#/x-devx-bundled/ref_37ddbc3abaadbc5fe0a6"
},
"retrievePaymentDeclinedResponse": {
"$ref": "#/x-devx-bundled/ref_eaf5d3470b5ee12b1835"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_b78a8dc49545610d9bab"
}
}
},
"description": "Successful request. Returns the specific payment."
},
"400": {
"$ref": "#/x-devx-bundled/ref_ae89d3d539618a89d2dd"
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"403": {
"$ref": "#/x-devx-bundled/ref_e17edbd5866b60d4beb9"
},
"404": {
"$ref": "#/x-devx-bundled/ref_49bf9231904bbd9aa1c0"
},
"406": {
"$ref": "#/x-devx-bundled/ref_c791fb405083799347c1"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "Retrieve payment",
"tags": [
"Bank transfer payments"
]
}
},
"/bank-transfer-payments/{paymentId}/close": {
"post": {
"description": "Use this method to close a return if the customer used an alternative payment method to resolve a returned payment. \n\nTo close a return, you need the paymentId of the return. To get the paymentId of the return, complete the following steps:\n\n1.\tUse our [Retrieve Payment](https://docs.payroc.com/api/schema/bank-transfer-payments/payments/retrieve) method to view the details of the original payment.\n2.\tFrom the [returns object](https://docs.payroc.com/api/schema/bank-transfer-payments/payments/retrieve#response.body.returns) in the response, get the paymentId of the return.\n\nIf your request is successful, our gateway closes the return.\n",
"operationId": "closeBankTransferPayment",
"parameters": [
{
"$ref": "#/x-devx-bundled/ref_b92d206f2e50ffc4c068"
},
{
"$ref": "#/x-devx-bundled/ref_ecf2f0f7e7e376484555"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"bankTransferPayment": {
"$ref": "#/x-devx-bundled/ref_37ddbc3abaadbc5fe0a6"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_b78a8dc49545610d9bab"
}
}
},
"description": "Successful request. We closed the return."
},
"400": {
"content": {
"application/problem+json": {
"examples": {
"idempotentKeyInUse": {
"$ref": "#/x-devx-bundled/ref_3917c6024cc650b3ea83"
},
"idempotentKeyMissing": {
"$ref": "#/x-devx-bundled/ref_d9867eacc8169139adec"
},
"validationError": {
"$ref": "#/x-devx-bundled/ref_2b3621a1c5ae119c6693"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_9477586d4a50bb60f5a4"
}
}
},
"description": "Validation error"
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"403": {
"$ref": "#/x-devx-bundled/ref_e17edbd5866b60d4beb9"
},
"404": {
"$ref": "#/x-devx-bundled/ref_49bf9231904bbd9aa1c0"
},
"406": {
"$ref": "#/x-devx-bundled/ref_c791fb405083799347c1"
},
"409": {
"$ref": "#/x-devx-bundled/ref_33a47f40f610a3ad4109"
},
"415": {
"$ref": "#/x-devx-bundled/ref_40869c40b438e4591cbc"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "Close return",
"tags": [
"Bank transfer payments"
]
}
},
"/bank-transfer-payments/{paymentId}/refund": {
"post": {
"description": "Use this method to refund a bank transfer payment that is in a closed batch. \n\nTo refund a bank transfer payment, you need its paymentId. Our gateway returned the paymentId in the response of the [Create Payment](https://docs.payroc.com/api/schema/bank-transfer-payments/payments/create) method. \n\n**Note:** If you don’t have the paymentId, use our [List Payments](https://docs.payroc.com/api/schema/bank-transfer-payments/payments/list) method to search for the bank transfer payment. \n\nIf your refund is successful, our gateway returns the payment amount to the customer's account. \n\n**Things to consider** \n- If the merchant refunds a bank transfer payment that is in an open batch, our gateway reverses the bank transfer payment. \n- Some merchants can run unreferenced refunds, which means that they don’t need a paymentId to return an amount to a customer. For more information about how to run an unreferenced refund, go to [Create Refund](https://docs.payroc.com/api/schema/bank-transfer-payments/refunds/create). \n",
"operationId": "refundBankTransferPayment",
"parameters": [
{
"$ref": "#/x-devx-bundled/ref_b92d206f2e50ffc4c068"
},
{
"$ref": "#/x-devx-bundled/ref_ecf2f0f7e7e376484555"
}
],
"requestBody": {
"content": {
"application/json": {
"examples": {
"refundBankTransferPayment": {
"$ref": "#/x-devx-bundled/ref_8fa86deb8d98d9b24051"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_42c25495328c9289df3b"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"bankTransferPayment": {
"$ref": "#/x-devx-bundled/ref_8f61348dac434c012f6d"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_b78a8dc49545610d9bab"
}
}
},
"description": "Successful request. We refunded the payment."
},
"400": {
"content": {
"application/problem+json": {
"examples": {
"idempotentKeyInUse": {
"$ref": "#/x-devx-bundled/ref_3917c6024cc650b3ea83"
},
"idempotentKeyMissing": {
"$ref": "#/x-devx-bundled/ref_d9867eacc8169139adec"
},
"validationError": {
"$ref": "#/x-devx-bundled/ref_2b3621a1c5ae119c6693"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_9477586d4a50bb60f5a4"
}
}
},
"description": "Validation error"
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"403": {
"$ref": "#/x-devx-bundled/ref_e17edbd5866b60d4beb9"
},
"404": {
"$ref": "#/x-devx-bundled/ref_49bf9231904bbd9aa1c0"
},
"406": {
"$ref": "#/x-devx-bundled/ref_c791fb405083799347c1"
},
"409": {
"$ref": "#/x-devx-bundled/ref_33a47f40f610a3ad4109"
},
"415": {
"$ref": "#/x-devx-bundled/ref_40869c40b438e4591cbc"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "Create referenced refund",
"tags": [
"Bank transfer payments"
]
}
},
"/bank-transfer-payments/{paymentId}/represent": {
"post": {
"description": "Use this method to re-present an ACH payment. \n\nTo re-present a payment, you need the paymentId of the return. To get the paymentId of the return, complete the following steps: \n\n1.\tUse our [Retrieve Payment](https://docs.payroc.com/api/schema/bank-transfer-payments/payments/retrieve) method to view the details of the original payment. \n2.\tFrom the [returns object](https://docs.payroc.com/api/schema/bank-transfer-payments/payments/retrieve#response.body.returns) in the response, get the paymentId of the return. \n\nOur gateway uses the bank account details from the original payment. If you want to update the customer's bank account details, send the new bank account details in the request. \n\nIf your request is successful, our gateway re-presents the payment.\n",
"operationId": "representBankTransferPayment",
"parameters": [
{
"$ref": "#/x-devx-bundled/ref_b92d206f2e50ffc4c068"
},
{
"$ref": "#/x-devx-bundled/ref_ecf2f0f7e7e376484555"
}
],
"requestBody": {
"content": {
"application/json": {
"examples": {
"representBankTransferPayment": {
"$ref": "#/x-devx-bundled/ref_43f62b6723bf993b5ac0"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_a28a168a0ca17374feda"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"bankTransferPayment": {
"$ref": "#/x-devx-bundled/ref_91fb2fa5a740e5e339ef"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_b78a8dc49545610d9bab"
}
}
},
"description": "Successful request. We processed the payment."
},
"400": {
"content": {
"application/problem+json": {
"examples": {
"idempotentKeyInUse": {
"$ref": "#/x-devx-bundled/ref_3917c6024cc650b3ea83"
},
"idempotentKeyMissing": {
"$ref": "#/x-devx-bundled/ref_d9867eacc8169139adec"
},
"validationError": {
"$ref": "#/x-devx-bundled/ref_2b3621a1c5ae119c6693"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_9477586d4a50bb60f5a4"
}
}
},
"description": "Validation error"
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"403": {
"$ref": "#/x-devx-bundled/ref_e17edbd5866b60d4beb9"
},
"404": {
"$ref": "#/x-devx-bundled/ref_49bf9231904bbd9aa1c0"
},
"406": {
"$ref": "#/x-devx-bundled/ref_c791fb405083799347c1"
},
"409": {
"$ref": "#/x-devx-bundled/ref_33a47f40f610a3ad4109"
},
"415": {
"$ref": "#/x-devx-bundled/ref_40869c40b438e4591cbc"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "Re-present payment",
"tags": [
"Bank transfer payments"
]
}
},
"/bank-transfer-payments/{paymentId}/reverse": {
"post": {
"description": "Use this method to cancel a bank transfer payment in an open batch. This is also known as voiding a payment. \n\nTo cancel a bank transfer payment, you need its paymentId. Our gateway returned the paymentId in the response of the [Create Payment](https://docs.payroc.com/api/schema/bank-transfer-payments/payments/create) method. \n\n**Note:** If you don't have the paymentId, use our [List Payments](https://docs.payroc.com/api/schema/bank-transfer-payments/payments/list) method to search for the bank transfer payment. \n\nIf your request is successful, our gateway removes the bank transfer payment from the merchant’s open batch and no funds are taken from the customer's bank account. \n",
"operationId": "reverseBankTransferPayment",
"parameters": [
{
"$ref": "#/x-devx-bundled/ref_b92d206f2e50ffc4c068"
},
{
"$ref": "#/x-devx-bundled/ref_ecf2f0f7e7e376484555"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"reversePaymentResponse": {
"$ref": "#/x-devx-bundled/ref_6543d0b0fbcfb8aa2a4d"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_b78a8dc49545610d9bab"
}
}
},
"description": "Successful request. We voided the payment."
},
"400": {
"content": {
"application/problem+json": {
"examples": {
"idempotentKeyInUse": {
"$ref": "#/x-devx-bundled/ref_3917c6024cc650b3ea83"
},
"idempotentKeyMissing": {
"$ref": "#/x-devx-bundled/ref_d9867eacc8169139adec"
},
"validationError": {
"$ref": "#/x-devx-bundled/ref_2b3621a1c5ae119c6693"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_9477586d4a50bb60f5a4"
}
}
},
"description": "Validation error"
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"403": {
"$ref": "#/x-devx-bundled/ref_e17edbd5866b60d4beb9"
},
"404": {
"$ref": "#/x-devx-bundled/ref_49bf9231904bbd9aa1c0"
},
"406": {
"$ref": "#/x-devx-bundled/ref_c791fb405083799347c1"
},
"409": {
"$ref": "#/x-devx-bundled/ref_33a47f40f610a3ad4109"
},
"415": {
"$ref": "#/x-devx-bundled/ref_40869c40b438e4591cbc"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "Reverse payment",
"tags": [
"Bank transfer payments"
]
}
},
"/bank-transfer-refunds": {
"get": {
"description": "Use this method to return a [paginated](https://docs.payroc.com/api/pagination) list of bank transfer refunds. \n\n**Note:** If you want to view the details of a specific refund and you have its refundId, use our [Retrieve Refund](https://docs.payroc.com/api/schema/bank-transfer-payments/refunds/retrieve) method. \n\nUse query parameters to filter the list of results that we return, for example, to search for refunds for a customer, an orderId, or a date range. \n\nOur gateway returns the following information about each refund in the list: \n\n-\tOrder details, including the refund amount and when it was processed. \n-\tBank account details, including the customer’s name and account number. \n\nFor referenced refunds, our gateway also returns details about the payment that the refund is linked to.\n",
"operationId": "listBankTransferRefunds",
"parameters": [
{
"$ref": "#/x-devx-bundled/ref_9cecec158fac171a2359"
},
{
"$ref": "#/x-devx-bundled/ref_73b332ab2e0080910d47"
},
{
"$ref": "#/x-devx-bundled/ref_26f07dc17d5d0565bae2"
},
{
"$ref": "#/x-devx-bundled/ref_97fd591be23011b399ca"
},
{
"$ref": "#/x-devx-bundled/ref_daefdac9b965c8c44156"
},
{
"$ref": "#/x-devx-bundled/ref_7bef60d9d8959e45cc53"
},
{
"$ref": "#/x-devx-bundled/ref_16560a085e477303e24b"
},
{
"$ref": "#/x-devx-bundled/ref_f55097134a658e246ef1"
},
{
"$ref": "#/x-devx-bundled/ref_cf73da6ef9cd0d35a508"
},
{
"$ref": "#/x-devx-bundled/ref_fa7c86811eba798b4839"
},
{
"$ref": "#/x-devx-bundled/ref_eb4bec06b486e2ceb76c"
},
{
"$ref": "#/x-devx-bundled/ref_e258178e3e59c83f2c9a"
},
{
"$ref": "#/x-devx-bundled/ref_59a42c003a97fcdab712"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"noActivity": {
"$ref": "#/x-devx-bundled/ref_7ad5ac1e2a5096a96273"
},
"paginatedResults": {
"$ref": "#/x-devx-bundled/ref_4afcb7f0fde89d0dc39f"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_5a22509861c42e65faff"
}
}
},
"description": "Successful request. Returns a list of refund transactions."
},
"400": {
"$ref": "#/x-devx-bundled/ref_ae89d3d539618a89d2dd"
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"403": {
"$ref": "#/x-devx-bundled/ref_e17edbd5866b60d4beb9"
},
"406": {
"$ref": "#/x-devx-bundled/ref_c791fb405083799347c1"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "List refunds",
"tags": [
"Bank transfer refunds"
]
},
"post": {
"description": "Use this method to create an unreferenced refund. An unreferenced refund is a refund that isn’t linked to a bank transfer payment. \n\n**Note:** If you have the paymentId of the payment you want to refund, use our [Refund Payment](https://docs.payroc.com/api/schema/bank-transfer-payments/refunds/refund) method. If you use our Refund Payment method, our gateway sends the refund amount to the customer’s original payment method and links the refund to the payment. \n\nIn the request, you must provide the customer’s payment method and information about the order including the refund amount. \n\nIn the response, our gateway returns information about the refund and a refundId, which you need for the following methods: \n\n-\t[Retrieve refund](https://docs.payroc.com/api/schema/bank-transfer-payments/refunds/retrieve) – View the details of the refund. \n-\t[Reverse refund](https://docs.payroc.com/api/schema/bank-transfer-payments/refunds/reverse-refund) – Cancel the refund if it’s in an open batch. \n",
"operationId": "bankTransferUnreferencedRefund",
"parameters": [
{
"$ref": "#/x-devx-bundled/ref_b92d206f2e50ffc4c068"
}
],
"requestBody": {
"content": {
"application/json": {
"examples": {
"createUnreferencedRefundRequest": {
"$ref": "#/x-devx-bundled/ref_786215eeb604b861c0d9"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_3123aae2343c4cee5777"
}
}
},
"required": true
},
"responses": {
"201": {
"content": {
"application/json": {
"examples": {
"createUnreferencedRefundResponse": {
"$ref": "#/x-devx-bundled/ref_4d097caef54b1645d917"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_ac099976d4eaf2dbdeec"
}
}
},
"description": "Successful request. We sent the refund to the customer's bank account.",
"headers": {
"location": {
"$ref": "#/x-devx-bundled/ref_7b13ec5af2d2b1d9f8e7"
}
}
},
"400": {
"content": {
"application/problem+json": {
"examples": {
"idempotentKeyInUse": {
"$ref": "#/x-devx-bundled/ref_3917c6024cc650b3ea83"
},
"idempotentKeyMissing": {
"$ref": "#/x-devx-bundled/ref_d9867eacc8169139adec"
},
"validationError": {
"$ref": "#/x-devx-bundled/ref_2b3621a1c5ae119c6693"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_9477586d4a50bb60f5a4"
}
}
},
"description": "Validation error"
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"403": {
"$ref": "#/x-devx-bundled/ref_e17edbd5866b60d4beb9"
},
"406": {
"$ref": "#/x-devx-bundled/ref_c791fb405083799347c1"
},
"409": {
"$ref": "#/x-devx-bundled/ref_33a47f40f610a3ad4109"
},
"415": {
"$ref": "#/x-devx-bundled/ref_40869c40b438e4591cbc"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "Create unreferenced refund",
"tags": [
"Bank transfer refunds"
]
}
},
"/bank-transfer-refunds/{refundId}": {
"get": {
"description": "Use this method to retrieve information about a refund. \n\nTo retrieve a refund, you need its refundId. Our gateway returned the refundId in the response of the [Refund Payment](https://docs.payroc.com/api/schema/bank-transfer-payments/refunds/refund) method or the [Create Refund](https://docs.payroc.com/api/schema/bank-transfer-payments/refunds/create) method. \n\n**Note:** If you don’t have the refundId, use our [List Refunds](https://docs.payroc.com/api/schema/bank-transfer-payments/refunds/list) method to search for the refund. \n\nOur gateway returns the following information about the refund: \n\n- Order details, including the refund amount and when it was processed. \n- Bank account details, including the customer’s name and account number. \n\nIf the refund is a referenced refund, our gateway also returns details about the payment that the refund is linked to.\n",
"operationId": "getBankTransferRefund",
"parameters": [
{
"$ref": "#/x-devx-bundled/ref_6f855718c62bdd201bb6"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"bankTransferUnreferencedRefund": {
"$ref": "#/x-devx-bundled/ref_4d097caef54b1645d917"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_ac099976d4eaf2dbdeec"
}
}
},
"description": "Successful request. Returns the specific refund."
},
"400": {
"$ref": "#/x-devx-bundled/ref_ae89d3d539618a89d2dd"
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"403": {
"$ref": "#/x-devx-bundled/ref_e17edbd5866b60d4beb9"
},
"404": {
"$ref": "#/x-devx-bundled/ref_49bf9231904bbd9aa1c0"
},
"406": {
"$ref": "#/x-devx-bundled/ref_c791fb405083799347c1"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "Retrieve refund",
"tags": [
"Bank transfer refunds"
]
}
},
"/bank-transfer-refunds/{refundId}/reverse": {
"post": {
"description": "Use this method to cancel a bank transfer refund in an open batch. \n\nTo cancel a refund, you need its refundId. Our gateway returned the refundId in the response of the [Refund Payment](https://docs.payroc.com/api/schema/bank-transfer-payments/refunds/refund) or [Create Refund](https://docs.payroc.com/api/schema/bank-transfer-payments/refunds/create) method. \n\n**Note:** If you don’t have the refundId, use our [List Refunds](https://docs.payroc.com/api/schema/bank-transfer-payments/refunds/list) method to search for the refund. \n\nIf your request is successful, the gateway removes the refund from the merchant’s open batch, and no funds are returned to the cardholder’s account. \n",
"operationId": "reverseBankTransferRefund",
"parameters": [
{
"$ref": "#/x-devx-bundled/ref_b92d206f2e50ffc4c068"
},
{
"$ref": "#/x-devx-bundled/ref_6f855718c62bdd201bb6"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"bankTransferUnreferencedRefund": {
"$ref": "#/x-devx-bundled/ref_558a709ae7ced0d8495a"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_ac099976d4eaf2dbdeec"
}
}
},
"description": "Successful request. We reversed the refund transaction."
},
"400": {
"content": {
"application/problem+json": {
"examples": {
"idempotentKeyInUse": {
"$ref": "#/x-devx-bundled/ref_3917c6024cc650b3ea83"
},
"idempotentKeyMissing": {
"$ref": "#/x-devx-bundled/ref_d9867eacc8169139adec"
},
"validationError": {
"$ref": "#/x-devx-bundled/ref_2b3621a1c5ae119c6693"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_9477586d4a50bb60f5a4"
}
}
},
"description": "Validation error"
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"403": {
"$ref": "#/x-devx-bundled/ref_e17edbd5866b60d4beb9"
},
"404": {
"$ref": "#/x-devx-bundled/ref_49bf9231904bbd9aa1c0"
},
"406": {
"$ref": "#/x-devx-bundled/ref_c791fb405083799347c1"
},
"409": {
"$ref": "#/x-devx-bundled/ref_33a47f40f610a3ad4109"
},
"415": {
"$ref": "#/x-devx-bundled/ref_40869c40b438e4591cbc"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "Reverse refund",
"tags": [
"Bank transfer refunds"
]
}
},
"/batches": {
"get": {
"description": "Use this method to return a [paginated](https://docs.payroc.com/api/pagination) list of batches that your merchants submitted to the processor on a specific date. \n\n**Note:** If you want to view the details of a specific batch and you have its batchId, use our [Retrieve Batch](https://docs.payroc.com/api/schema/reporting/settlement/retrieve-batch) method. \n\nUse query parameters to filter the list of results that we return, for example, to search for batches that were submitted by a specific merchant. \n\n> **Important:** You must provide a value for the date query parameter. \n\nOur gateway returns the following information about each batch in the list: \n-\tTransaction information, including the number of transactions and total value of sales. \n-\tMerchant information, including the merchant ID (MID) and the processing account that the batch is associated with. \n",
"operationId": "getbatches",
"parameters": [
{
"$ref": "#/x-devx-bundled/ref_eb4bec06b486e2ceb76c"
},
{
"$ref": "#/x-devx-bundled/ref_e258178e3e59c83f2c9a"
},
{
"$ref": "#/x-devx-bundled/ref_59a42c003a97fcdab712"
},
{
"$ref": "#/x-devx-bundled/ref_08a2598fddfe444f3098"
},
{
"$ref": "#/x-devx-bundled/ref_ea59515d841f46f0d0e1"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"noActivity": {
"$ref": "#/x-devx-bundled/ref_7ad5ac1e2a5096a96273"
},
"paginatedList": {
"$ref": "#/x-devx-bundled/ref_e41a722a917310618c88"
}
},
"schema": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_f9d963d00740bbe00c9e"
},
{
"properties": {
"data": {
"description": "Array of batch objects.",
"items": {
"$ref": "#/x-devx-bundled/ref_e2a430c1cc67558414bd"
},
"type": "array"
}
},
"required": [
"data"
],
"type": "object"
}
],
"type": "object"
}
}
},
"description": "Successful request. Returns a paginated list of batches."
},
"400": {
"content": {
"application/problem+json": {
"examples": {
"idError": {
"$ref": "#/x-devx-bundled/ref_b98520de58f4ca31a283"
},
"paginationError": {
"$ref": "#/x-devx-bundled/ref_b394dd97f528cb101adf"
},
"parameterError": {
"$ref": "#/x-devx-bundled/ref_33e366b095d33923fb79"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_9477586d4a50bb60f5a4"
}
}
},
"description": "Validation error"
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"403": {
"$ref": "#/x-devx-bundled/ref_e17edbd5866b60d4beb9"
},
"406": {
"$ref": "#/x-devx-bundled/ref_c791fb405083799347c1"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "List batches",
"tags": [
"Settlement"
]
}
},
"/batches/{batchId}": {
"get": {
"description": "Use this method to retrieve information about a batch. \n\n**Note:** To retrieve a batch, you need its batchId. If you don't have the batchId, use our [List Batches](https://docs.payroc.com/api/schema/reporting/settlement/list-batches) method to search for the batch. \n\nOur gateway returns the following information about the batch: \n\n-\tTransaction information, including the number of transactions and total value of sales. \n-\tMerchant information, including the merchant ID (MID) and the processing account that the batch is associated with. \n",
"operationId": "getbatch",
"parameters": [
{
"$ref": "#/x-devx-bundled/ref_6ad2ac0964a4eb2dc24b"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"retrieveBatchResponse": {
"$ref": "#/x-devx-bundled/ref_24e1f4e8993b8fe696fe"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_e2a430c1cc67558414bd"
}
}
},
"description": "Successful request. Returns the requested batch."
},
"400": {
"content": {
"application/problem+json": {
"examples": {
"idError": {
"$ref": "#/x-devx-bundled/ref_b98520de58f4ca31a283"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_9477586d4a50bb60f5a4"
}
}
},
"description": "Validation error"
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"403": {
"$ref": "#/x-devx-bundled/ref_e17edbd5866b60d4beb9"
},
"404": {
"$ref": "#/x-devx-bundled/ref_49bf9231904bbd9aa1c0"
},
"406": {
"$ref": "#/x-devx-bundled/ref_c791fb405083799347c1"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "Retrieve batch",
"tags": [
"Settlement"
]
}
},
"/cards/balance": {
"post": {
"description": "Use this method to view the balance of an Electronic Benefit Transfer (EBT) card. \n\nIf the request is successful, our gateway returns the current balance of an EBT card. \n",
"operationId": "balanceCard",
"requestBody": {
"content": {
"application/json": {
"examples": {
"viewEbtBalanceRequest": {
"$ref": "#/x-devx-bundled/ref_7f6b21f25beeffad163f"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_7a93007b2f94a5098fc4"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"viewEbtBalanceResponse": {
"$ref": "#/x-devx-bundled/ref_8fa1afd5dd605a4e2fdf"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_82beb7666aa84da98879"
}
}
},
"description": "Successful request. Returns the current balance of the EBT card."
},
"400": {
"$ref": "#/x-devx-bundled/ref_ae89d3d539618a89d2dd"
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"403": {
"$ref": "#/x-devx-bundled/ref_e17edbd5866b60d4beb9"
},
"404": {
"$ref": "#/x-devx-bundled/ref_49bf9231904bbd9aa1c0"
},
"406": {
"$ref": "#/x-devx-bundled/ref_c791fb405083799347c1"
},
"409": {
"$ref": "#/x-devx-bundled/ref_33a47f40f610a3ad4109"
},
"415": {
"$ref": "#/x-devx-bundled/ref_40869c40b438e4591cbc"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "View EBT balance",
"tags": [
"Cards"
]
}
},
"/cards/bin-lookup": {
"post": {
"description": "Use this method to retrieve information about a debit card, a credit card, or an EBT card. If you apply surcharges to transactions, you can also check if the card supports surcharging. \n\nIn the response, our gateway returns the following information about the card: \n\n- **Card details** - Information about the card, for example, the issuing bank and the masked card number. \n\n- **Surcharging information** - If you apply a surcharge to transactions, our gateway checks that the card supports surcharging and returns information about the surcharge. For more information about surcharging, go to [Credit card surcharging](https://docs.payroc.com/knowledge/card-payments/credit-card-surcharging). \n",
"operationId": "binLookup",
"requestBody": {
"content": {
"application/json": {
"examples": {
"lookUpBinInformationRequest": {
"$ref": "#/x-devx-bundled/ref_160ac044e8ca8da9e82c"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_4dc72a3a5d43b92f74b4"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"lookUpBinInformationResponse": {
"$ref": "#/x-devx-bundled/ref_e749498bd04d8b0b6e15"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_080cc40e493d508bee9e"
}
}
},
"description": "Successful request. Returns the BIN information."
},
"400": {
"$ref": "#/x-devx-bundled/ref_ae89d3d539618a89d2dd"
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"403": {
"$ref": "#/x-devx-bundled/ref_e17edbd5866b60d4beb9"
},
"404": {
"$ref": "#/x-devx-bundled/ref_49bf9231904bbd9aa1c0"
},
"406": {
"$ref": "#/x-devx-bundled/ref_c791fb405083799347c1"
},
"409": {
"$ref": "#/x-devx-bundled/ref_33a47f40f610a3ad4109"
},
"415": {
"$ref": "#/x-devx-bundled/ref_40869c40b438e4591cbc"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "Look up BIN information",
"tags": [
"Cards"
]
}
},
"/cards/verify": {
"post": {
"description": "Use this method to verify a customer’s card details. \n\nIn the request, send the customer’s card details. \n\nIn the response, our gateway indicates if the card details are valid and if you should use them in follow-on actions. \n",
"operationId": "verifyCard",
"parameters": [
{
"$ref": "#/x-devx-bundled/ref_b92d206f2e50ffc4c068"
}
],
"requestBody": {
"content": {
"application/json": {
"examples": {
"verifyCardRequest": {
"$ref": "#/x-devx-bundled/ref_38c700c5a4360532893e"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_12ecf6130480ac459b2d"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"verifyCardResponse": {
"$ref": "#/x-devx-bundled/ref_e138b0befb3e82a5221d"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_1381eacf966cbfd0f303"
}
}
},
"description": "Successful request. Returns the verification status of the card details."
},
"400": {
"content": {
"application/problem+json": {
"examples": {
"idempotentKeyInUse": {
"$ref": "#/x-devx-bundled/ref_3917c6024cc650b3ea83"
},
"idempotentKeyMissing": {
"$ref": "#/x-devx-bundled/ref_d9867eacc8169139adec"
},
"validationError": {
"$ref": "#/x-devx-bundled/ref_2b3621a1c5ae119c6693"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_9477586d4a50bb60f5a4"
}
}
},
"description": "Validation error"
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"403": {
"$ref": "#/x-devx-bundled/ref_e17edbd5866b60d4beb9"
},
"404": {
"$ref": "#/x-devx-bundled/ref_49bf9231904bbd9aa1c0"
},
"406": {
"$ref": "#/x-devx-bundled/ref_c791fb405083799347c1"
},
"409": {
"$ref": "#/x-devx-bundled/ref_33a47f40f610a3ad4109"
},
"415": {
"$ref": "#/x-devx-bundled/ref_40869c40b438e4591cbc"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "Verify card",
"tags": [
"Cards"
]
}
},
"/closed-loop-reads/{closedLoopReadId}": {
"get": {
"description": "Use this method to retrieve information that a payment device captured from a closed-loop card. \n\nA closed-loop card is a type of card that a customer can use only with a specific merchant. Each time a payment device captures information from a closed-loop card, we store the information as a closed-loop read. \n\nOur gateway returns the following information from a closed-loop read: \n-\tDate that the payment device captured the information.\n-\tUnstructured payload from the card.\n",
"operationId": "getClosedLoop",
"parameters": [
{
"$ref": "#/x-devx-bundled/ref_59f945de11366ab1ba9f"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"retrieveClosedLoopReadResponse": {
"$ref": "#/x-devx-bundled/ref_b7b00394b33d048ac7e8"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_f757013ea5967635deaf"
}
}
},
"description": "Successful request. Returns information from the closed-loop card."
},
"400": {
"$ref": "#/x-devx-bundled/ref_ae89d3d539618a89d2dd"
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"403": {
"$ref": "#/x-devx-bundled/ref_e17edbd5866b60d4beb9"
},
"404": {
"$ref": "#/x-devx-bundled/ref_49bf9231904bbd9aa1c0"
},
"406": {
"$ref": "#/x-devx-bundled/ref_c791fb405083799347c1"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "Retrieve closed loop read",
"tags": [
"Closed-loop reads"
]
}
},
"/contacts/{contactId}": {
"delete": {
"description": "Use this method to delete a contact associated with a processing account. \n\nTo delete a contact, you need their contactId. Our gateway returned the contactId in the response of the [Create Processing Account](https://docs.payroc.com/api/schema/boarding/merchant-platforms/create-processing-account) method. \n\n**Note:** If you don’t have the contactId, use our [Retrieve Processing Account](https://docs.payroc.com/api/schema/boarding/processing-accounts/retrieve) method or our [List Contacts](https://docs.payroc.com/api/schema/boarding/processing-accounts/list-contacts) method to search for the contact. \n",
"operationId": "deleteContact",
"parameters": [
{
"$ref": "#/x-devx-bundled/ref_bdd8ff6b1a30d57341ad"
}
],
"responses": {
"204": {
"description": "Successful request. We deleted the contact."
},
"400": {
"$ref": "#/x-devx-bundled/ref_ae89d3d539618a89d2dd"
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"403": {
"$ref": "#/x-devx-bundled/ref_e17edbd5866b60d4beb9"
},
"404": {
"$ref": "#/x-devx-bundled/ref_49bf9231904bbd9aa1c0"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "Delete contact",
"tags": [
"Contacts"
]
},
"get": {
"description": "Use this method to retrieve details about a contact. \n\nTo retrieve a contact, you need its contactId. Our gateway returned the contactId in the [Create Processing Account](https://docs.payroc.com/api/schema/boarding/merchant-platforms/create-processing-account) method. \n\n**Note:** If you don't have the contactId, use the [List Contacts](https://docs.payroc.com/api/schema/boarding/processing-accounts/list-contacts) method to search for the contact. \n\nOur gateway returns the following information about a contact: \n\n-\tName and contact method, including their phone number or mobile number. \n-\tRole within the business, for example, if they are a manager. \n",
"operationId": "getContact",
"parameters": [
{
"$ref": "#/x-devx-bundled/ref_bdd8ff6b1a30d57341ad"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"contact": {
"$ref": "#/x-devx-bundled/ref_ab4750ca54e918c1794a"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_df1dbb6190ccee505722"
}
}
},
"description": "Successful request. Returns the requested contact."
},
"400": {
"$ref": "#/x-devx-bundled/ref_ae89d3d539618a89d2dd"
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"403": {
"$ref": "#/x-devx-bundled/ref_e17edbd5866b60d4beb9"
},
"404": {
"$ref": "#/x-devx-bundled/ref_49bf9231904bbd9aa1c0"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "Retrieve contact",
"tags": [
"Contacts"
]
},
"put": {
"description": "Use this method to update a contact of a processing account. \n\nTo update a contact, you need its contactId. Our gateway returned the contactId in the response of the [Create Processing Account](https://docs.payroc.com/api/schema/boarding/merchant-platforms/create-processing-account) method. \n\n**Note:** If you don't have the contactId, use our [List Contacts](https://docs.payroc.com/api/schema/boarding/processing-accounts/list-contacts) method to search for the contact. \n\nYou can update the following details about a contact: \n\n-\tFirst name and last name. \n-\tContact details, including their phone number or mobile number. \n-\tIdentification details, including their identification type and number. \n-\tRole within the business, for example, if they are a manager. \n",
"operationId": "updateContact",
"parameters": [
{
"$ref": "#/x-devx-bundled/ref_bdd8ff6b1a30d57341ad"
}
],
"requestBody": {
"content": {
"application/json": {
"examples": {
"updateContactRequest": {
"$ref": "#/x-devx-bundled/ref_e760e7fd6ad0cb29adc8"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_df1dbb6190ccee505722"
}
}
}
},
"responses": {
"204": {
"description": "Successful request. We updated the contact."
},
"400": {
"content": {
"application/problem+json": {
"examples": {
"validationError": {
"$ref": "#/x-devx-bundled/ref_2b3621a1c5ae119c6693"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_9477586d4a50bb60f5a4"
}
}
},
"description": "Validation errors."
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"403": {
"$ref": "#/x-devx-bundled/ref_e17edbd5866b60d4beb9"
},
"404": {
"$ref": "#/x-devx-bundled/ref_49bf9231904bbd9aa1c0"
},
"406": {
"$ref": "#/x-devx-bundled/ref_c791fb405083799347c1"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "Update contact",
"tags": [
"Contacts"
]
}
},
"/devices": {
"get": {
"description": "Use this method to return a [paginated](https://docs.payroc.com/api/pagination) list of devices associated with a merchant's API key or an ISV's API key. \n\nUse the query parameters to filter the list of results that we return, for example, to search for devices by their model. \n\nOur gateway returns the following information about each device in the list: \n\n- Unique identifier that we assigned to the device.\n- Serial number of the device.\n- Key serial identifier (KSI) of the device.\n- Device model or type of device.\n- Date that our gateway added the device to our systems.\n- Information about the last transaction that the device processed.\n",
"operationId": "searchDevices",
"parameters": [
{
"$ref": "#/x-devx-bundled/ref_eb4bec06b486e2ceb76c"
},
{
"$ref": "#/x-devx-bundled/ref_e258178e3e59c83f2c9a"
},
{
"$ref": "#/x-devx-bundled/ref_59a42c003a97fcdab712"
},
{
"description": "Filter by the device status. Send one of the following values:\n\n- `true` – Return only active devices.\n- `false` – Return only inactive devices.\n",
"in": "query",
"name": "active",
"schema": {
"example": true,
"type": "boolean"
}
},
{
"description": "Filter by the serial number of the device.",
"example": "SN123456789",
"in": "query",
"name": "serialNumber",
"schema": {
"maxLength": 64,
"minLength": 1,
"type": "string"
}
},
{
"description": "Filter by the key serial identifier (KSI) of the device.",
"example": "FFFF5B0991ABCD01",
"in": "query",
"name": "ksi",
"schema": {
"maxLength": 16,
"minLength": 1,
"type": "string"
}
},
{
"description": "Filter by the model or type of the device.",
"example": "idtechKioskV",
"in": "query",
"name": "model",
"schema": {
"maxLength": 30,
"minLength": 1,
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"noActivity": {
"$ref": "#/x-devx-bundled/ref_7ad5ac1e2a5096a96273"
},
"paginatedResults": {
"$ref": "#/x-devx-bundled/ref_500acc5a8f54cd3372c1"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_2e70e7dd6cd1784afd3a"
}
}
},
"description": "Successful request. Returns a list of devices associated with the API key."
},
"400": {
"$ref": "#/x-devx-bundled/ref_ae89d3d539618a89d2dd"
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"403": {
"$ref": "#/x-devx-bundled/ref_e17edbd5866b60d4beb9"
},
"406": {
"$ref": "#/x-devx-bundled/ref_c791fb405083799347c1"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "Search devices",
"tags": [
"Devices"
]
}
},
"/devices/{serialNumber}/payment-instructions": {
"post": {
"description": "Use this method to submit an instruction request to initiate a sale on a payment device. \n\nIn the request, include the order amount and currency. \n\nWhen you send a successful request, our gateway returns information about the payment instruction and a paymentInstructionId, which you need for the following methods:\n- [Retrieve payment instruction](https://docs.payroc.com/api/schema/payroc-cloud/payment-instructions/retrieve) - View the details of the payment instruction.\n- [Cancel payment instruction](https://docs.payroc.com/api/schema/payroc-cloud/payment-instructions/delete) - Cancel the payment instruction.\n",
"operationId": "sendPaymentInstruction",
"parameters": [
{
"$ref": "#/x-devx-bundled/ref_da57bdc2edb33f29319b"
},
{
"$ref": "#/x-devx-bundled/ref_b92d206f2e50ffc4c068"
}
],
"requestBody": {
"content": {
"application/json": {
"examples": {
"submitPaymentInstructionMifareClosedLoopOptionsRequest": {
"$ref": "#/x-devx-bundled/ref_e599f09b65108c7f9eb1"
},
"submitPaymentInstructionRequest": {
"$ref": "#/x-devx-bundled/ref_be0915cd698503b8a10f"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_3bbb81954426a0605ef3"
}
}
},
"required": true
},
"responses": {
"202": {
"content": {
"application/json": {
"examples": {
"paymentInstruction": {
"$ref": "#/x-devx-bundled/ref_4b7bb203f9ff456d5d10"
},
"paymentInstructionMiFare": {
"$ref": "#/x-devx-bundled/ref_e5ac528592a678296a44"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_4a7b91fc0a7e14e78dfc"
}
}
},
"description": "Successful request. We accepted the payment instruction."
},
"400": {
"content": {
"application/problem+json": {
"examples": {
"idempotentKeyMissing": {
"$ref": "#/x-devx-bundled/ref_d9867eacc8169139adec"
},
"validationError": {
"$ref": "#/x-devx-bundled/ref_2b3621a1c5ae119c6693"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_9477586d4a50bb60f5a4"
}
}
},
"description": "Validation error"
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"403": {
"$ref": "#/x-devx-bundled/ref_e17edbd5866b60d4beb9"
},
"404": {
"$ref": "#/x-devx-bundled/ref_49bf9231904bbd9aa1c0"
},
"406": {
"$ref": "#/x-devx-bundled/ref_c791fb405083799347c1"
},
"409": {
"$ref": "#/x-devx-bundled/ref_33a47f40f610a3ad4109"
},
"415": {
"$ref": "#/x-devx-bundled/ref_40869c40b438e4591cbc"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "Submit payment instruction",
"tags": [
"Payment instructions"
]
}
},
"/devices/{serialNumber}/refund-instructions": {
"post": {
"description": "Use this method to submit an instruction request to initiate a refund on a payment device. \n\nIn the request, include the refund amount and currency. \n\nIf the request is successful, our gateway returns information about the refund instruction and a refundInstructionId, which you need for the following methods:\n- [Retrieve refund instruction](https://docs.payroc.com/api/schema/payroc-cloud/refund-instructions/retrieve) - View the details of the refund instruction.\n- [Cancel refund instruction](https://docs.payroc.com/api/schema/payroc-cloud/refund-instructions/delete) - Cancel the refund instruction.\n",
"operationId": "sendRefundInstruction",
"parameters": [
{
"$ref": "#/x-devx-bundled/ref_38fcc3d1658ae8f60f14"
},
{
"$ref": "#/x-devx-bundled/ref_b92d206f2e50ffc4c068"
}
],
"requestBody": {
"content": {
"application/json": {
"examples": {
"submitRefundInstructionRequest": {
"$ref": "#/x-devx-bundled/ref_4b3a055024c05d126044"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_4e2978844bcac27ec794"
}
}
},
"required": true
},
"responses": {
"202": {
"content": {
"application/json": {
"examples": {
"refundInstruction": {
"$ref": "#/x-devx-bundled/ref_1d27536e303131535b26"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_8625c84fd7dc6d8a6045"
}
}
},
"description": "Successful request. We accepted the refund instruction."
},
"400": {
"content": {
"application/problem+json": {
"examples": {
"idempotentKeyMissing": {
"$ref": "#/x-devx-bundled/ref_d9867eacc8169139adec"
},
"validationError": {
"$ref": "#/x-devx-bundled/ref_2b3621a1c5ae119c6693"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_9477586d4a50bb60f5a4"
}
}
},
"description": "Validation error"
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"403": {
"$ref": "#/x-devx-bundled/ref_e17edbd5866b60d4beb9"
},
"404": {
"$ref": "#/x-devx-bundled/ref_49bf9231904bbd9aa1c0"
},
"406": {
"$ref": "#/x-devx-bundled/ref_c791fb405083799347c1"
},
"409": {
"$ref": "#/x-devx-bundled/ref_33a47f40f610a3ad4109"
},
"415": {
"$ref": "#/x-devx-bundled/ref_40869c40b438e4591cbc"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "Submit refund instruction",
"tags": [
"Refund instructions"
]
}
},
"/devices/{serialNumber}/signature-instructions": {
"post": {
"description": "Use this method to submit an instruction to capture a customer's signature on a payment device. \n\nOur gateway returns information about the signature instruction and a signatureInstructionId, which you need for the following methods:\n- [Retrieve signature instruction](https://docs.payroc.com/api/schema/payroc-cloud/signature-instructions/retrieve) - View the details of the signature instruction.\n- [Cancel signature instruction](https://docs.payroc.com/api/schema/payroc-cloud/signature-instructions/delete) - Cancel the signature instruction.\n",
"operationId": "sendSignatureInstruction",
"parameters": [
{
"$ref": "#/x-devx-bundled/ref_a59a28abab857f03a07f"
},
{
"$ref": "#/x-devx-bundled/ref_b92d206f2e50ffc4c068"
}
],
"requestBody": {
"content": {
"application/json": {
"examples": {
"submitSignatureInstructionRequest": {
"$ref": "#/x-devx-bundled/ref_ff5778400f1d9cc0abb1"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_5bdee1909a4721a11ce5"
}
}
},
"required": true
},
"responses": {
"202": {
"content": {
"application/json": {
"examples": {
"signatureInstruction": {
"$ref": "#/x-devx-bundled/ref_830d113f4c1fff49df12"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_93badc2c64529eef6d80"
}
}
},
"description": "Successful request. We accepted the signature instruction."
},
"400": {
"content": {
"application/problem+json": {
"examples": {
"idempotentKeyMissing": {
"$ref": "#/x-devx-bundled/ref_d9867eacc8169139adec"
},
"validationError": {
"$ref": "#/x-devx-bundled/ref_2b3621a1c5ae119c6693"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_9477586d4a50bb60f5a4"
}
}
},
"description": "Validation error"
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"403": {
"$ref": "#/x-devx-bundled/ref_e17edbd5866b60d4beb9"
},
"404": {
"$ref": "#/x-devx-bundled/ref_49bf9231904bbd9aa1c0"
},
"406": {
"$ref": "#/x-devx-bundled/ref_c791fb405083799347c1"
},
"409": {
"$ref": "#/x-devx-bundled/ref_33a47f40f610a3ad4109"
},
"415": {
"$ref": "#/x-devx-bundled/ref_40869c40b438e4591cbc"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "Submit signature instruction",
"tags": [
"Signature instructions"
]
}
},
"/disputes": {
"get": {
"description": "Use this method to return a [paginated](https://docs.payroc.com/api/pagination) list of disputes. \n\nUse query parameters to filter the list of results that we return, for example, to search for disputes linked to a specific merchant. \n\n> **Important:** You must provide a value for the date query parameter. \n\nOur gateway returns the following information about each dispute in the list: \n- Its status, type, and description. \n- Transaction that the dispute is linked to, including the transaction date, merchant who ran the transaction, and the payment method that the cardholder used. \n",
"operationId": "getdisputes",
"parameters": [
{
"$ref": "#/x-devx-bundled/ref_eb4bec06b486e2ceb76c"
},
{
"$ref": "#/x-devx-bundled/ref_e258178e3e59c83f2c9a"
},
{
"$ref": "#/x-devx-bundled/ref_59a42c003a97fcdab712"
},
{
"$ref": "#/x-devx-bundled/ref_41718efbbf91b6e633ec"
},
{
"$ref": "#/x-devx-bundled/ref_ea59515d841f46f0d0e1"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"noActivity": {
"$ref": "#/x-devx-bundled/ref_7ad5ac1e2a5096a96273"
},
"paginatedList": {
"$ref": "#/x-devx-bundled/ref_13c415d839c305766788"
}
},
"schema": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_f9d963d00740bbe00c9e"
},
{
"properties": {
"data": {
"description": "Array of dispute objects.",
"items": {
"$ref": "#/x-devx-bundled/ref_69f1460a68f2f59d262a"
},
"type": "array"
}
},
"required": [
"data"
],
"type": "object"
}
],
"type": "object"
}
}
},
"description": "Successful request. Returns a paginated list of disputes."
},
"400": {
"content": {
"application/problem+json": {
"examples": {
"paginationError": {
"$ref": "#/x-devx-bundled/ref_b394dd97f528cb101adf"
},
"parameterError": {
"$ref": "#/x-devx-bundled/ref_33e366b095d33923fb79"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_9477586d4a50bb60f5a4"
}
}
},
"description": "Validation error"
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"403": {
"$ref": "#/x-devx-bundled/ref_e17edbd5866b60d4beb9"
},
"406": {
"$ref": "#/x-devx-bundled/ref_c791fb405083799347c1"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "List disputes",
"tags": [
"Settlement"
]
}
},
"/disputes/{disputeId}/statuses": {
"get": {
"description": "Use this method to return the status history of a dispute. \n\nTo view the status history of a dispute, you need its disputeId. If you don't have the disputeId, use our [List Disputes](https://docs.payroc.com/api/schema/reporting/settlement/list-disputes) method to search for the dispute. \n\nOur gateway returns a list that contains each status change, the date it was changed, and its updated status. \n",
"operationId": "getdisputesStatuses",
"parameters": [
{
"$ref": "#/x-devx-bundled/ref_88af1998c4067fca5d3d"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"listDisputeStatusesResponse": {
"$ref": "#/x-devx-bundled/ref_c0f0cd70a9b62501770e"
}
},
"schema": {
"description": "Collection of status",
"items": {
"$ref": "#/x-devx-bundled/ref_0e07938f865866b952e7"
},
"type": "array"
}
}
},
"description": "Successful request. Returns the status history for a specific dispute."
},
"400": {
"content": {
"application/problem+json": {
"examples": {
"parameterError": {
"$ref": "#/x-devx-bundled/ref_33e366b095d33923fb79"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_9477586d4a50bb60f5a4"
}
}
},
"description": "Validation error"
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"403": {
"$ref": "#/x-devx-bundled/ref_e17edbd5866b60d4beb9"
},
"404": {
"$ref": "#/x-devx-bundled/ref_49bf9231904bbd9aa1c0"
},
"406": {
"$ref": "#/x-devx-bundled/ref_c791fb405083799347c1"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "List dispute statuses",
"tags": [
"Settlement"
]
}
},
"/event-subscriptions": {
"get": {
"description": "Use this method to return a [paginated](https://docs.payroc.com/api/pagination) list of event subscriptions that are linked to your ISV account. \n\n**Note:** If you want to view the details of a specific event subscription and you have its id, use our [Retrieve Event Subscription](https://docs.payroc.com/api/schema/notifications/event-subscriptions/retrieve) method. \n\nUse query parameters to filter the list of results that we return, for example, to search for subscriptions with a specific status or an event type. \n\nOur gateway returns the following information about each subscription in the list: \n- Event types that you have subscribed to. \n- Whether you have enabled notifications for the subscription. \n- How we contact you when an event occurs, including the endpoint that send notifications to. \n- If there are any issues when we try to send you a notification, for example, if we can't contact your endpoint. \n\nFor each event subscription, we also return its id, which you can use to perform follow-on actions. \n",
"operationId": "listEventSubscriptions",
"parameters": [
{
"$ref": "#/x-devx-bundled/ref_5e3029a3ef34877c347f"
},
{
"$ref": "#/x-devx-bundled/ref_8dc1969fd3fabc37aa31"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"paginatedList": {
"$ref": "#/x-devx-bundled/ref_b54ec0fee326408828f5"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_5e8c60d58d02042ee191"
}
}
},
"description": "Successful request. Returns a list of event subscriptions."
},
"400": {
"$ref": "#/x-devx-bundled/ref_ae89d3d539618a89d2dd"
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "List event subscriptions",
"tags": [
"Event Subscriptions"
]
},
"post": {
"description": "Use this method to create an event subscription that we use to notify you when an event occurs, for example, when we change the status of a processing account. \n\nIn the request, include the events that you want to subscribe to and the public endpoint that we send event notifications to. For a complete list of events that you can subscribe to, go to [Events List](https://docs.payroc.com/knowledge/events/events-list). \n\nIn the response, our gateway returns the id of the event subscription, which you can use to perform follow-on actions. \n",
"operationId": "createEventSubscription",
"parameters": [
{
"$ref": "#/x-devx-bundled/ref_b92d206f2e50ffc4c068"
}
],
"requestBody": {
"content": {
"application/json": {
"examples": {
"createEventSubscriptionMetadataRequest": {
"$ref": "#/x-devx-bundled/ref_7bf22606967313df17c3"
},
"createEventSubscriptionRequest": {
"$ref": "#/x-devx-bundled/ref_78ffcfd2b99c05650b3c"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_4b7a26467bd32e0d5fa8"
}
}
}
},
"responses": {
"201": {
"content": {
"application/json": {
"examples": {
"createEventSubscriptionMetadataResponse": {
"$ref": "#/x-devx-bundled/ref_209438ddfe4e1d353487"
},
"createdEventSubscription": {
"$ref": "#/x-devx-bundled/ref_bfd782ac32787312f48a"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_4b7a26467bd32e0d5fa8"
}
}
},
"description": "Successful request. We created the event subscription.",
"headers": {
"Location": {
"$ref": "#/x-devx-bundled/ref_5044f4bf170b9c7bac4a"
}
}
},
"400": {
"content": {
"application/problem+json": {
"examples": {
"idempotentKeyMissing": {
"$ref": "#/x-devx-bundled/ref_d9867eacc8169139adec"
},
"validationError": {
"$ref": "#/x-devx-bundled/ref_2b3621a1c5ae119c6693"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_9477586d4a50bb60f5a4"
}
}
},
"description": "Validation error"
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"406": {
"$ref": "#/x-devx-bundled/ref_c791fb405083799347c1"
},
"409": {
"content": {
"application/problem+json": {
"examples": {
"idempotentKeyInUse": {
"$ref": "#/x-devx-bundled/ref_3917c6024cc650b3ea83"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_478798693738e1bfadb1"
}
}
},
"description": "Conflict"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "Create event subscription",
"tags": [
"Event Subscriptions"
]
}
},
"/event-subscriptions/{subscriptionId}": {
"delete": {
"description": "Use this method to delete an event subscription. \n\n> **Important:** After you delete an event subscription, you can’t recover it. You won't receive event notifications from the event subscription. \n\nTo delete an event subscription, you need its subscriptionId. Our gateway returned the subscriptionId in the response of the [Create Event Subscription](https://docs.payroc.com/api/schema/notifications/event-subscriptions/create) method. \n\nIf you want to stop receiving event notifications but don't want to delete the event subscription, use our [Update Event Subscription](https://docs.payroc.com/api/schema/notifications/event-subscriptions/update) method to deactivate it. \n",
"operationId": "deleteEventSubscription",
"responses": {
"204": {
"description": "Successful request. We deleted the event subscription."
},
"400": {
"$ref": "#/x-devx-bundled/ref_ae89d3d539618a89d2dd"
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"404": {
"$ref": "#/x-devx-bundled/ref_49bf9231904bbd9aa1c0"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "Delete event subscription",
"tags": [
"Event Subscriptions"
]
},
"get": {
"description": "Use this method to retrieve the details of an event subscription. \n\nIn your request, include the subscriptionId that we sent to you when we created the event subscription. \n \n**Note:** If you don't know the subscriptionId of the event subscription, go to [List event subscriptions](https://docs.payroc.com/api/schema/notifications/event-subscriptions/list).\n",
"operationId": "getEventSubscription",
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"retrieveEventSubscriptionResponse": {
"$ref": "#/x-devx-bundled/ref_a660bef0c3f97b2ed00a"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_4b7a26467bd32e0d5fa8"
}
}
},
"description": "Returns the event subscription object."
},
"400": {
"$ref": "#/x-devx-bundled/ref_ae89d3d539618a89d2dd"
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"404": {
"$ref": "#/x-devx-bundled/ref_49bf9231904bbd9aa1c0"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "Retrieve event subscription",
"tags": [
"Event Subscriptions"
]
},
"parameters": [
{
"$ref": "#/x-devx-bundled/ref_df56a24cf3e227b81f77"
}
],
"patch": {
"description": "Use this method to partially update an event subscription. Structure your request to follow the [RFC 6902](https://datatracker.ietf.org/doc/html/rfc6902) standard. \n\nTo update an event subscription, you need its subscriptionId. Our gateway returned the subscriptionId in the id field in the response of the [Create Event Subscription](https://docs.payroc.com/api/schema/notifications/event-subscriptions/create) method. \n\n**Note:** If you don't have the subscriptionId, use our [List Event Subscriptions](https://docs.payroc.com/api/schema/notifications/event-subscriptions/list) method to search for the subscription. \n\nYou can update the following properties of an event subscription: \n- **eventTypes** - Subscribe to new events or remove events that you are subscribed to. \n- **notifications** - Information about your endpoint and who we email if we can't contact your endpoint. \n- **enabled** - Turn on or turn off notifications for the subscription. \n",
"operationId": "patchEventSubscription",
"parameters": [
{
"$ref": "#/x-devx-bundled/ref_b92d206f2e50ffc4c068"
}
],
"requestBody": {
"content": {
"application/json": {
"examples": {
"partiallyUpdateEventSubscriptionAddRequest": {
"$ref": "#/x-devx-bundled/ref_6b9b37b9a97eaeb09c2c"
},
"partiallyUpdateEventSubscriptionCopyRequest": {
"$ref": "#/x-devx-bundled/ref_4ce7328eee513fc70eea"
},
"partiallyUpdateEventSubscriptionMoveRequest": {
"$ref": "#/x-devx-bundled/ref_72e672837842d3f036da"
},
"partiallyUpdateEventSubscriptionRealisticRequest": {
"$ref": "#/x-devx-bundled/ref_eb84992a3f298576baf5"
},
"partiallyUpdateEventSubscriptionRemoveRequest": {
"$ref": "#/x-devx-bundled/ref_a96c55b0181acbd6d321"
},
"partiallyUpdateEventSubscriptionReplaceRequest": {
"$ref": "#/x-devx-bundled/ref_69c528d104cc88086e40"
},
"partiallyUpdateEventSubscriptionTestRequest": {
"$ref": "#/x-devx-bundled/ref_a92561cbba84d7ff51f3"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_83c73ee340defd8c776d"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"patchEventSubscriptionAdd": {
"$ref": "#/x-devx-bundled/ref_44412a5fc0ef6c3b3f73"
},
"patchEventSubscriptionCopy": {
"$ref": "#/x-devx-bundled/ref_6eb9ea50131ff5aa24f5"
},
"patchEventSubscriptionMove": {
"$ref": "#/x-devx-bundled/ref_fee7c4d5f68fe4bab281"
},
"patchEventSubscriptionRemove": {
"$ref": "#/x-devx-bundled/ref_0c4c5cb0b4eeef5fb143"
},
"patchEventSubscriptionReplace": {
"$ref": "#/x-devx-bundled/ref_0d196bd1023e19b5208b"
},
"patchEventSubscriptionTest": {
"$ref": "#/x-devx-bundled/ref_91ecc468ca61b768be31"
},
"patchedEventSubscription": {
"$ref": "#/x-devx-bundled/ref_45926d9e37fe15bd34c3"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_4b7a26467bd32e0d5fa8"
}
}
},
"description": "Successful request. We updated the event subscription."
},
"400": {
"content": {
"application/problem+json": {
"examples": {
"idempotentKeyMissing": {
"$ref": "#/x-devx-bundled/ref_d9867eacc8169139adec"
},
"validationError": {
"$ref": "#/x-devx-bundled/ref_2b3621a1c5ae119c6693"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_9477586d4a50bb60f5a4"
}
}
},
"description": "Validation error"
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"404": {
"$ref": "#/x-devx-bundled/ref_49bf9231904bbd9aa1c0"
},
"406": {
"$ref": "#/x-devx-bundled/ref_c791fb405083799347c1"
},
"409": {
"content": {
"application/problem+json": {
"examples": {
"idempotentKeyInUse": {
"$ref": "#/x-devx-bundled/ref_3917c6024cc650b3ea83"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_478798693738e1bfadb1"
}
}
},
"description": "Conflict"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "Partially update event subscription",
"tags": [
"Event Subscriptions"
]
},
"put": {
"description": "Use this method to update the details of an event subscription. \n\nTo update an event subscription, you need its subscriptionId. Our gateway returned the subscriptionId in the response of the [Create Event Subscription](https://docs.payroc.com/api/schema/notifications/event-subscriptions/create) method. \n\n**Note:** If you don’t have the subscriptionId, use our [List Event Subscriptions](https://docs.payroc.com/api/schema/notifications/event-subscriptions/list) method to search for the event subscription. \n\nYou can update the following details about an event subscription: \n\n- Status of the event subscription. \n- Events that you have subscribed to. For a list of events that you can subscribe to, go to [Events list](https://docs.payroc.com/knowledge/events/events-list). \n- Information about how we contact you when an event occurs. \n",
"operationId": "updateEventSubscription",
"requestBody": {
"content": {
"application/json": {
"examples": {
"updateEventSubscriptionRequest": {
"$ref": "#/x-devx-bundled/ref_4bc30f329291c16d15f6"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_4b7a26467bd32e0d5fa8"
}
}
}
},
"responses": {
"204": {
"description": "Successful request. We updated the event subscription."
},
"400": {
"$ref": "#/x-devx-bundled/ref_ae89d3d539618a89d2dd"
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"404": {
"$ref": "#/x-devx-bundled/ref_49bf9231904bbd9aa1c0"
},
"406": {
"$ref": "#/x-devx-bundled/ref_c791fb405083799347c1"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "Update event subscription",
"tags": [
"Event Subscriptions"
]
}
},
"/funding-accounts": {
"get": {
"description": "Use this method to return a [paginated](https://docs.payroc.com/api/pagination) list of funding accounts associated with your account. \n\n**Note:** If you want to view the details of a specific funding account and you have its fundingAccountId, use our [Retrieve Funding Account](https://docs.payroc.com/api/schema/funding/funding-accounts/retrieve) method. \n\nOur gateway returns the following information about each funding account in the list: \n- Name of the account holder and ACH details for the account. \n- Status of the account. \n- Whether we send funds to the account, withdraw funds from the account, or both. \n\nFor each funding account, we also return the fundingAccountId, which you can use to perform follow-on actions. \n",
"operationId": "listFundingAccount",
"parameters": [
{
"$ref": "#/x-devx-bundled/ref_eb4bec06b486e2ceb76c"
},
{
"$ref": "#/x-devx-bundled/ref_e258178e3e59c83f2c9a"
},
{
"$ref": "#/x-devx-bundled/ref_59a42c003a97fcdab712"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"fundingAccountExample": {
"$ref": "#/x-devx-bundled/ref_57317f96ab7baac16ed9"
},
"listFundingAccountsNoResultsFoundResponse": {
"$ref": "#/x-devx-bundled/ref_8ad7d0d31ac1c6e3fc04"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_32d9784fa4b18a444793"
}
}
},
"description": "Successful request. Returns a paginated list of all funding accounts."
},
"400": {
"$ref": "#/x-devx-bundled/ref_ae89d3d539618a89d2dd"
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"403": {
"$ref": "#/x-devx-bundled/ref_e17edbd5866b60d4beb9"
},
"404": {
"$ref": "#/x-devx-bundled/ref_49bf9231904bbd9aa1c0"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "List funding accounts",
"tags": [
"Funding accounts"
]
}
},
"/funding-accounts/{fundingAccountId}": {
"delete": {
"description": "> **Important:** You can't delete a funding account that is associated with a processing account. \n\nUse this method to delete a funding account that is associated with a funding recipient. \n\nTo delete a funding account, you need its fundingAccountId. Our gateway returned the fundingAccountId when you created the funding account. \n\n**Note:** If you don't have the fundingAccountId, use our [List Funding Accounts](https://docs.payroc.com/api/schema/funding/funding-accounts/list) method to search for the funding account. \n",
"operationId": "deleteFundingAccount",
"parameters": [
{
"$ref": "#/x-devx-bundled/ref_a48b3847246c8a8e58e4"
}
],
"responses": {
"204": {
"description": "Successful request. We deleted the funding account."
},
"400": {
"$ref": "#/x-devx-bundled/ref_ae89d3d539618a89d2dd"
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"403": {
"$ref": "#/x-devx-bundled/ref_e17edbd5866b60d4beb9"
},
"404": {
"$ref": "#/x-devx-bundled/ref_49bf9231904bbd9aa1c0"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "Delete funding account",
"tags": [
"Funding accounts"
]
},
"get": {
"description": "Use this method to retrieve information about a funding account. \n\nTo retrieve a funding account, you need its fundingAccountId. Our gateway returned the fundingAccountId when you created the funding account. \n\n**Note:** If you don't have the fundingAccountId, use our [List Funding Accounts](https://docs.payroc.com/api/schema/funding/funding-accounts/list) method to search for the account. \n\nOur gateway returns the following information about the funding account: \n- Name of the account holder and ACH details for the account. \n- Status of the account. \n- Whether we send funds to the account, withdraw funds from the account, or both. \n",
"operationId": "getFundingAccount",
"parameters": [
{
"$ref": "#/x-devx-bundled/ref_a48b3847246c8a8e58e4"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"retrieveFundingAccountResponse": {
"$ref": "#/x-devx-bundled/ref_48f636cd57461cc98031"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_9a102086f05b94adac7a"
}
}
},
"description": "Successful request. Returns the requested funding account."
},
"400": {
"$ref": "#/x-devx-bundled/ref_ae89d3d539618a89d2dd"
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"403": {
"$ref": "#/x-devx-bundled/ref_e17edbd5866b60d4beb9"
},
"404": {
"$ref": "#/x-devx-bundled/ref_49bf9231904bbd9aa1c0"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "Retrieve funding account",
"tags": [
"Funding accounts"
]
},
"put": {
"description": "> **Important:** You can't update the details of a funding account that is associated with a processing account. \n\nUse this method to update the details of a funding account that is associated with a funding recipient. \n\nTo update a funding account, you need its fundingAccountId. Our gateway returned the fundingAccountId when you created the funding account. \n\n**Note:** If you don’t have the fundingAccountId, use our [List Funding Accounts](https://docs.payroc.com/api/schema/funding/funding-accounts/list) method to search for the funding account. \n\nYou can update the following details about the funding account: \n-\tAccount type. \n-\tAccount holder's name. \n-\tACH information for the account. \n",
"operationId": "updateFundingAccount",
"parameters": [
{
"$ref": "#/x-devx-bundled/ref_a48b3847246c8a8e58e4"
}
],
"requestBody": {
"content": {
"application/json": {
"examples": {
"updateFundingAccountRequest": {
"$ref": "#/x-devx-bundled/ref_060ac11e14a755a9a144"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_9a102086f05b94adac7a"
}
}
}
},
"responses": {
"204": {
"description": "Successful request. We updated the funding account."
},
"400": {
"content": {
"application/problem+json": {
"examples": {
"kycCheckFailed": {
"$ref": "#/x-devx-bundled/ref_2f94b2465c1e3956dcf6"
},
"validationError": {
"$ref": "#/x-devx-bundled/ref_2b3621a1c5ae119c6693"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_9477586d4a50bb60f5a4"
}
}
},
"description": "Validation errors"
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"403": {
"$ref": "#/x-devx-bundled/ref_e17edbd5866b60d4beb9"
},
"404": {
"$ref": "#/x-devx-bundled/ref_49bf9231904bbd9aa1c0"
},
"406": {
"$ref": "#/x-devx-bundled/ref_c791fb405083799347c1"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "Update funding account",
"tags": [
"Funding accounts"
]
}
},
"/funding-activity": {
"get": {
"description": "Use this method to return a [paginated](https://docs.payroc.com/api/pagination) list of activity associated with your merchants' funding balances within a specific date range. \n\nUse query parameters to filter the list of results we return, for example, to view the activity for a specific merchant's funding balance. \n\nOur gateway returns the following information about each activity in the list:\n- Name of the merchant who owns the funding balance.\n-\tAmount of funds added or removed from the funding balance.\n-\tFunding account that received funds from the funding balance.\n",
"operationId": "getFundingActivity",
"parameters": [
{
"$ref": "#/x-devx-bundled/ref_eb4bec06b486e2ceb76c"
},
{
"$ref": "#/x-devx-bundled/ref_e258178e3e59c83f2c9a"
},
{
"$ref": "#/x-devx-bundled/ref_59a42c003a97fcdab712"
},
{
"$ref": "#/x-devx-bundled/ref_162eec4b493b189ca496"
},
{
"$ref": "#/x-devx-bundled/ref_224f0933b0049b6a323c"
},
{
"$ref": "#/x-devx-bundled/ref_ea59515d841f46f0d0e1"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"listFundingActivityResponse": {
"$ref": "#/x-devx-bundled/ref_f2dca78935024ce9572f"
},
"noActivity": {
"$ref": "#/x-devx-bundled/ref_7ad5ac1e2a5096a96273"
}
},
"schema": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_f9d963d00740bbe00c9e"
},
{
"properties": {
"data": {
"description": "Array of activityRecord objects.",
"items": {
"$ref": "#/x-devx-bundled/ref_dc58c2edd8de4473d826"
},
"type": "array"
}
},
"required": [
"data"
],
"type": "object"
}
],
"type": "object"
}
}
},
"description": "Successful request. Returns a list of funding activity."
},
"400": {
"content": {
"application/problem+json": {
"examples": {
"outsideRecordRange": {
"$ref": "#/x-devx-bundled/ref_dd635faa759cfd56238d"
},
"paginationError": {
"$ref": "#/x-devx-bundled/ref_ced7ecb5610bd5b00dfe"
},
"parameterError": {
"$ref": "#/x-devx-bundled/ref_4603625cf4689f36173f"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_9477586d4a50bb60f5a4"
}
}
},
"description": "Validation error."
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"403": {
"$ref": "#/x-devx-bundled/ref_e17edbd5866b60d4beb9"
},
"406": {
"$ref": "#/x-devx-bundled/ref_c791fb405083799347c1"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "List funding activity",
"tags": [
"Funding activity"
]
}
},
"/funding-balance": {
"get": {
"description": "Use this method to return a [paginated](https://docs.payroc.com/api/pagination) list of funding balances available for each merchant linked to your account. \n\nUse query parameters to filter the list of results we return, for example, to search for the funding balance for a specific merchant. \n\nOur gateway returns the following information about each merchant in the list: \n- Total funds for the merchant. \n- Available funds that you can use for funding instructions. \n- Pending funds that we have not yet sent to funding accounts. \n",
"operationId": "getFundingBalance",
"parameters": [
{
"$ref": "#/x-devx-bundled/ref_eb4bec06b486e2ceb76c"
},
{
"$ref": "#/x-devx-bundled/ref_e258178e3e59c83f2c9a"
},
{
"$ref": "#/x-devx-bundled/ref_59a42c003a97fcdab712"
},
{
"$ref": "#/x-devx-bundled/ref_ea59515d841f46f0d0e1"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"listSplitsExample": {
"$ref": "#/x-devx-bundled/ref_d1c3cf82793d52ba4205"
},
"noActivity": {
"$ref": "#/x-devx-bundled/ref_7ad5ac1e2a5096a96273"
}
},
"schema": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_f9d963d00740bbe00c9e"
},
{
"properties": {
"data": {
"description": "Array of merchantBalance objects.",
"items": {
"$ref": "#/x-devx-bundled/ref_8315546d83136ae702c6"
},
"type": "array"
}
},
"required": [
"data"
],
"type": "object"
}
],
"type": "object"
}
}
},
"description": "Successful request. Returns the funding balance available for each merchant."
},
"400": {
"content": {
"application/problem+json": {
"examples": {
"paginationError": {
"$ref": "#/x-devx-bundled/ref_84983d869f962c56f303"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_9477586d4a50bb60f5a4"
}
}
},
"description": "Validation error."
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"403": {
"$ref": "#/x-devx-bundled/ref_e17edbd5866b60d4beb9"
},
"406": {
"$ref": "#/x-devx-bundled/ref_c791fb405083799347c1"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "List funding balances",
"tags": [
"Funding activity"
]
}
},
"/funding-instructions": {
"get": {
"description": "> Important: You can return a list of funding instructions from only the previous two years. If you want to view a funding instruction from more than two years ago and you have its instructionId, use our [Retrieve Funding Instruction](https://docs.payroc.com/api/schema/funding/funding-instructions/retrieve) method. \n\nUse this method to return a [paginated](https://docs.payroc.com/api/pagination) list of funding instructions within a specific date range. \n\n**Note:** If you want to view the details of a specific funding instruction and you have its instructionId, use our [Retrieve Funding Instruction](https://docs.payroc.com/api/schema/funding/funding-instructions/retrieve) method. \n\nOur gateway returns the following information for each instruction in the list: \n-\tStatus of the funding instruction. \n-\tFunding information, including which merchant's funding balance we distribute and the funding account that we send the balance to. \n\nFor each funding instruction, we also return the instructionId, which you can use to perform follow-on actions. \n",
"operationId": "listInstructions",
"parameters": [
{
"$ref": "#/x-devx-bundled/ref_eb4bec06b486e2ceb76c"
},
{
"$ref": "#/x-devx-bundled/ref_e258178e3e59c83f2c9a"
},
{
"$ref": "#/x-devx-bundled/ref_59a42c003a97fcdab712"
},
{
"$ref": "#/x-devx-bundled/ref_aca19c0e9ba8e5923c83"
},
{
"$ref": "#/x-devx-bundled/ref_53394fbdfe65e9c5ea22"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"listSplitsExample": {
"$ref": "#/x-devx-bundled/ref_34a8174ecf8111b901e0"
},
"noActivity": {
"$ref": "#/x-devx-bundled/ref_7ad5ac1e2a5096a96273"
}
},
"schema": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_f9d963d00740bbe00c9e"
},
{
"properties": {
"data": {
"description": "Array of fundingInstruction objects.",
"items": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_72499517f50376b0b204"
},
{
"properties": {
"link": {
"$ref": "#/x-devx-bundled/ref_27e6d0e095fb23cba669"
}
},
"type": "object"
}
]
},
"type": "array"
}
},
"required": [
"data"
],
"type": "object"
}
],
"type": "object"
}
}
},
"description": "Successful request. Returns a list of funding instructions."
},
"400": {
"content": {
"application/problem+json": {
"examples": {
"outsideRecordRange": {
"$ref": "#/x-devx-bundled/ref_9e589a3238fca8393cd6"
},
"paginationError": {
"$ref": "#/x-devx-bundled/ref_fedffac120362e641ae9"
},
"parameterError": {
"$ref": "#/x-devx-bundled/ref_4a11108147084e09940d"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_9477586d4a50bb60f5a4"
}
}
},
"description": "Validation error."
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"403": {
"$ref": "#/x-devx-bundled/ref_e17edbd5866b60d4beb9"
},
"406": {
"$ref": "#/x-devx-bundled/ref_c791fb405083799347c1"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "List funding instructions",
"tags": [
"Funding instructions"
]
},
"post": {
"description": "Use this method to create a funding instruction that tells us how to distribute the funds from your merchants' transactions. \n\n**Note:** Before you create a funding instruction, you can use our [List Funding Balances](https://docs.payroc.com/api/schema/funding/funding-activity/retrieve-balance) method to view the amount of available funds that a merchant has. \n\nIn your request, include an array of merchantInstruction objects. Each merchantInstruction object contains the following: \n-\tMerchant ID (MID) of the merchant whose funding balance you want to distribute. \n-\tFunding account that you want to send funds to. \n-\tAmount that you want to send to the funding account. \n\nOur gateway returns the instructionId, which you can use to run follow-on actions.\n",
"operationId": "createInstruction",
"parameters": [
{
"$ref": "#/x-devx-bundled/ref_b92d206f2e50ffc4c068"
}
],
"requestBody": {
"content": {
"application/json": {
"examples": {
"createFundingInstructionMetadataRequest": {
"$ref": "#/x-devx-bundled/ref_632a507d8d5dbb2e493d"
},
"createFundingInstructionRequest": {
"$ref": "#/x-devx-bundled/ref_a476e2edec6c049e74c7"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_72499517f50376b0b204"
}
}
}
},
"responses": {
"201": {
"content": {
"application/json": {
"examples": {
"createFundingInstructionMetadataResponse": {
"$ref": "#/x-devx-bundled/ref_df9a27b1eda78844a30f"
},
"newInstructions": {
"$ref": "#/x-devx-bundled/ref_174073fb4a8caae28863"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_72499517f50376b0b204"
}
}
},
"description": "Successful request. We accepted the instructions.",
"headers": {
"location": {
"$ref": "#/x-devx-bundled/ref_7b13ec5af2d2b1d9f8e7"
}
}
},
"400": {
"content": {
"application/problem+json": {
"examples": {
"fundingAccountsRestricted": {
"$ref": "#/x-devx-bundled/ref_c547a592272a9e41d5f3"
},
"idempotentKeyMissing": {
"$ref": "#/x-devx-bundled/ref_d9867eacc8169139adec"
},
"insufficientFunds": {
"$ref": "#/x-devx-bundled/ref_4fdd06abb7b34e50e5f6"
},
"recipientAmountValueLimitExceeded": {
"$ref": "#/x-devx-bundled/ref_9133dec53865497ea171"
},
"validationError": {
"$ref": "#/x-devx-bundled/ref_2b3621a1c5ae119c6693"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_9477586d4a50bb60f5a4"
}
}
},
"description": "Validation error."
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"403": {
"$ref": "#/x-devx-bundled/ref_e17edbd5866b60d4beb9"
},
"406": {
"$ref": "#/x-devx-bundled/ref_c791fb405083799347c1"
},
"409": {
"content": {
"application/problem+json": {
"examples": {
"idempotentKeyInUse": {
"$ref": "#/x-devx-bundled/ref_3917c6024cc650b3ea83"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_478798693738e1bfadb1"
}
}
},
"description": "Conflict"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "Create funding instruction",
"tags": [
"Funding instructions"
]
}
},
"/funding-instructions/{instructionId}": {
"delete": {
"description": "> **Important:** You can delete a funding instruction only if its status is `accepted`. To view the status of a funding instruction, use our [Retrieve Funding Instruction](https://docs.payroc.com/api/schema/funding/funding-instructions/retrieve) method. \n\nUse this method to delete a funding instruction. \n\nTo delete a funding instruction, you need its instructionId. Our gateway returned the instructionId in the response of the [Create Funding Instruction](https://docs.payroc.com/api/schema/funding/funding-instructions/create) method. \n\n**Note:** If you don't have the instructionId, use our [List Funding Instructions](https://docs.payroc.com/api/schema/funding/funding-instructions/list) method to search for the funding instruction.\n",
"operationId": "deleteInstructions",
"responses": {
"204": {
"description": "Successful request. We deleted the funding instruction."
},
"400": {
"content": {
"application/problem+json": {
"examples": {
"instructionIdError": {
"$ref": "#/x-devx-bundled/ref_f19f62b6b85953855c92"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_9477586d4a50bb60f5a4"
}
}
},
"description": "Validation error."
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"403": {
"$ref": "#/x-devx-bundled/ref_e17edbd5866b60d4beb9"
},
"404": {
"$ref": "#/x-devx-bundled/ref_49bf9231904bbd9aa1c0"
},
"409": {
"content": {
"application/problem+json": {
"examples": {
"canNotBeModified": {
"$ref": "#/x-devx-bundled/ref_57a1ebd7dd882416e71e"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_478798693738e1bfadb1"
}
}
},
"description": "Conflict."
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "Delete funding instruction",
"tags": [
"Funding instructions"
]
},
"get": {
"description": "Use this method to retrieve information about a funding instruction. \n\nTo retrieve a funding instruction, you need its instructionId. Our gateway returned the instructionId in the response of the [Create Funding Instruction](https://docs.payroc.com/api/schema/funding/funding-instructions/create) method. \n\n**Note:** If you don't have the instructionId, use our [List Funding Instructions](https://docs.payroc.com/api/schema/funding/funding-instructions/list) method to search for the funding instruction. \n\nOur gateway returns the following information about the funding instruction: \n-\tStatus of the funding instruction. \n-\tFunding information, including which merchant's funding balance we distribute and the funding account that we send the balance to. \n",
"operationId": "getInstruction",
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"retrieveFundingInstructionResponse": {
"$ref": "#/x-devx-bundled/ref_1ed5f3fe0b142fc6e27a"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_72499517f50376b0b204"
}
}
},
"description": "Successful request. Returns the funding instruction."
},
"400": {
"content": {
"application/problem+json": {
"examples": {
"instructionIdError": {
"$ref": "#/x-devx-bundled/ref_f19f62b6b85953855c92"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_9477586d4a50bb60f5a4"
}
}
},
"description": "Validation error."
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"403": {
"$ref": "#/x-devx-bundled/ref_e17edbd5866b60d4beb9"
},
"404": {
"$ref": "#/x-devx-bundled/ref_49bf9231904bbd9aa1c0"
},
"406": {
"$ref": "#/x-devx-bundled/ref_c791fb405083799347c1"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "Retrieve funding instruction",
"tags": [
"Funding instructions"
]
},
"parameters": [
{
"$ref": "#/x-devx-bundled/ref_06f5be23d6297306e3c5"
}
],
"put": {
"description": "> **Important:** You can update a funding instruction only if its status is `accepted`. To view the status of a funding instruction, use our [Retrieve Funding Instruction](https://docs.payroc.com/api/schema/funding/funding-instructions/retrieve) method. \n\nUse this method to update the details of a funding instruction. \n\nTo update a funding instruction, you need its instructionId. Our gateway returned the instructionId in the response of the [Create Funding Instruction](https://docs.payroc.com/api/schema/funding/funding-instructions/create) method. \n\n**Note:** If you don't have the fundingInstructionId, use our [List Funding Instructions](https://docs.payroc.com/api/schema/funding/funding-instructions/list) method to search for the funding instruction. \n\nYou can modify the following information for the funding instruction: \n-\tMerchant ID (MID) of the merchant whose funding balance you want to distribute. \n-\tFunding account that you want to send funds to. \n-\tAmount that you want to send to the funding account. \n",
"operationId": "updateInstructions",
"requestBody": {
"content": {
"application/json": {
"examples": {
"updateFundingInstructionRequest": {
"$ref": "#/x-devx-bundled/ref_be3d9127d2fe7064be93"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_72499517f50376b0b204"
}
}
}
},
"responses": {
"204": {
"description": "Successful request. We updated the funding instruction."
},
"400": {
"content": {
"application/problem+json": {
"examples": {
"fundingAccountsRestricted": {
"$ref": "#/x-devx-bundled/ref_c547a592272a9e41d5f3"
},
"instructionIdError": {
"$ref": "#/x-devx-bundled/ref_f19f62b6b85953855c92"
},
"insufficientFunds": {
"$ref": "#/x-devx-bundled/ref_4fdd06abb7b34e50e5f6"
},
"recipientAmountValueLimitExceeded": {
"$ref": "#/x-devx-bundled/ref_9133dec53865497ea171"
},
"validationError": {
"$ref": "#/x-devx-bundled/ref_2b3621a1c5ae119c6693"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_9477586d4a50bb60f5a4"
}
}
},
"description": "Validation error."
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"403": {
"$ref": "#/x-devx-bundled/ref_e17edbd5866b60d4beb9"
},
"404": {
"$ref": "#/x-devx-bundled/ref_49bf9231904bbd9aa1c0"
},
"409": {
"content": {
"application/problem+json": {
"examples": {
"canNotBeModified": {
"$ref": "#/x-devx-bundled/ref_57a1ebd7dd882416e71e"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_478798693738e1bfadb1"
}
}
},
"description": "Conflict."
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "Update funding instruction",
"tags": [
"Funding instructions"
]
}
},
"/funding-recipients": {
"get": {
"description": "Use this method to return a [paginated](https://docs.payroc.com/api/pagination) list of funding recipients linked to your account. \n\nNote: If you want to view the details of a specific funding recipient and you have its recipientId, use our [Retrieve Funding Recipient](https://docs.payroc.com/api/schema/funding/funding-recipients/retrieve) method. \n\nOur gateway returns the following information about each funding recipient in the list: \n- Tax ID and Doing Business As (DBA) name. \n- Address and contact details. \n- Funding accounts linked to the funding recipient. \n\nFor each funding recipient, we also return the recipientId, which you can use to perform follow-on actions.\n",
"operationId": "listFundingRecipients",
"parameters": [
{
"$ref": "#/x-devx-bundled/ref_eb4bec06b486e2ceb76c"
},
{
"$ref": "#/x-devx-bundled/ref_e258178e3e59c83f2c9a"
},
{
"$ref": "#/x-devx-bundled/ref_59a42c003a97fcdab712"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"noActivity": {
"$ref": "#/x-devx-bundled/ref_7ad5ac1e2a5096a96273"
},
"paginatedFundingRecipients": {
"$ref": "#/x-devx-bundled/ref_c06e30cc1afc11042537"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_cbfa9e6af4185110bdd9"
}
}
},
"description": "Successful request. Returns a paginated list of all funding recipients."
},
"400": {
"$ref": "#/x-devx-bundled/ref_ae89d3d539618a89d2dd"
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"403": {
"$ref": "#/x-devx-bundled/ref_e17edbd5866b60d4beb9"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "List funding recipients",
"tags": [
"Funding recipients"
]
},
"post": {
"description": "Use this method to create a funding recipient. \n\nA funding recipient is a business or organization that can receive funds but can't run transactions, for example, a charity. \n\nIn the request, include the following information: \n-\tLegal information, including its tax ID, Doing Business As (DBA) name, and address. \n-\tContact information, including the email address. \n-\tOwners' details, including their contact details. \n-\tFunding account details. \n\nOur gateway returns the recipientId of the funding recipient, which you can use to run follow-on actions. \n",
"operationId": "createFundingRecipient",
"parameters": [
{
"$ref": "#/x-devx-bundled/ref_b92d206f2e50ffc4c068"
}
],
"requestBody": {
"content": {
"application/json": {
"examples": {
"createFundingRecipientRequest": {
"$ref": "#/x-devx-bundled/ref_6e69f732f5c733ad3613"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_076d4ba29a457ae4ea8d"
}
}
}
},
"responses": {
"201": {
"content": {
"application/json": {
"examples": {
"createFundingRecipientResponse": {
"$ref": "#/x-devx-bundled/ref_82411e2afe6edf10b1bd"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_cf614403c80b98c3ec2a"
}
}
},
"description": "Successful request. We created the funding recipient.",
"headers": {
"location": {
"$ref": "#/x-devx-bundled/ref_7b13ec5af2d2b1d9f8e7"
}
}
},
"400": {
"content": {
"application/problem+json": {
"examples": {
"idempotentKeyMissing": {
"$ref": "#/x-devx-bundled/ref_d9867eacc8169139adec"
},
"kycCheckFailed": {
"$ref": "#/x-devx-bundled/ref_2f94b2465c1e3956dcf6"
},
"validationError": {
"$ref": "#/x-devx-bundled/ref_2b3621a1c5ae119c6693"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_9477586d4a50bb60f5a4"
}
}
},
"description": "Validation errors"
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"403": {
"$ref": "#/x-devx-bundled/ref_e17edbd5866b60d4beb9"
},
"406": {
"$ref": "#/x-devx-bundled/ref_c791fb405083799347c1"
},
"409": {
"content": {
"application/problem+json": {
"examples": {
"idempotentKeyInUse": {
"$ref": "#/x-devx-bundled/ref_3917c6024cc650b3ea83"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_478798693738e1bfadb1"
}
}
},
"description": "Conflict"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "Create funding recipient",
"tags": [
"Funding recipients"
]
},
"summary": "Create and manage funding recipients."
},
"/funding-recipients/{recipientId}": {
"delete": {
"description": "Use this method to delete a funding recipient, including its funding accounts and owners. \n\nTo delete a funding recipient, you need its recipientId. Our gateway returned the recipientId in the response of the [Create Funding Recipient](https://docs.payroc.com/api/schema/funding/funding-recipients/create) method. \n\n**Note**: If you don't have the recipientId, use our [List Funding Recipients](https://docs.payroc.com/api/schema/funding/funding-recipients/list) method to search for the funding recipient. \n",
"operationId": "deleteFundingRecipient",
"parameters": [
{
"$ref": "#/x-devx-bundled/ref_c19a1775c4f3ce903a8c"
}
],
"responses": {
"204": {
"description": "Successful request. We deleted the funding recipient."
},
"400": {
"$ref": "#/x-devx-bundled/ref_ae89d3d539618a89d2dd"
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"403": {
"$ref": "#/x-devx-bundled/ref_e17edbd5866b60d4beb9"
},
"404": {
"$ref": "#/x-devx-bundled/ref_49bf9231904bbd9aa1c0"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "Delete funding recipient",
"tags": [
"Funding recipients"
]
},
"get": {
"description": "Use this method to retrieve information about a funding recipient. \n\nTo retrieve a funding recipient, you need its recipientId. Our gateway returned the recipientId in the response of the [Create Funding Recipient](https://docs.payroc.com/api/schema/funding/funding-recipients/create) method. \n\n**Note:** If you don't have the recipientId, use our [List Funding Recipients](https://docs.payroc.com/api/schema/funding/funding-recipients/list) method to search for the funding recipient. \n\nOur gateway returns the following information about the funding recipient: \n\n- Tax ID and Doing Business As (DBA) name. \n- Address and contact details. \n- Funding accounts linked to the funding recipient. \n",
"operationId": "getFundingRecipient",
"parameters": [
{
"$ref": "#/x-devx-bundled/ref_c19a1775c4f3ce903a8c"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"retrieveFundingRecipientResponse": {
"$ref": "#/x-devx-bundled/ref_98b4d9070f47d116d568"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_cf614403c80b98c3ec2a"
}
}
},
"description": "Successful request. Returns the requested funding recipient."
},
"400": {
"$ref": "#/x-devx-bundled/ref_ae89d3d539618a89d2dd"
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"403": {
"$ref": "#/x-devx-bundled/ref_e17edbd5866b60d4beb9"
},
"404": {
"$ref": "#/x-devx-bundled/ref_49bf9231904bbd9aa1c0"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "Retrieve funding recipient",
"tags": [
"Funding recipients"
]
},
"put": {
"description": "Use this method to update the details of a funding recipient. If a request contains significant changes, we might need to re-approve the funding recipient. \n\nTo update a funding recipient, you need it's recipientId. Our gateway returned the recipientId in the response of the [Create Funding Recipient](https://docs.payroc.com/api/schema/funding/funding-recipients/create) method. \n\n**Note**: If you don't have the recipientId, use our [List Funding Recipients](https://docs.payroc.com/api/schema/funding/funding-recipients/list) method to search for the funding recipient. \n\nYou can update the following details of a funding recipient: \n- Doing Business As (DBA) name \n- Tax ID and charity ID \n- Address and contact methods \n",
"operationId": "updateFundingRecipient",
"parameters": [
{
"$ref": "#/x-devx-bundled/ref_c19a1775c4f3ce903a8c"
}
],
"requestBody": {
"content": {
"application/json": {
"examples": {
"updateFundingRecipientRequest": {
"$ref": "#/x-devx-bundled/ref_d33de35f24d92438e9df"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_cf614403c80b98c3ec2a"
}
}
}
},
"responses": {
"204": {
"description": "Successful request. We updated the funding recipient."
},
"400": {
"content": {
"application/problem+json": {
"examples": {
"kycCheckFailed": {
"$ref": "#/x-devx-bundled/ref_2f94b2465c1e3956dcf6"
},
"validationError": {
"$ref": "#/x-devx-bundled/ref_2b3621a1c5ae119c6693"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_9477586d4a50bb60f5a4"
}
}
},
"description": "Validation errors"
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"403": {
"$ref": "#/x-devx-bundled/ref_e17edbd5866b60d4beb9"
},
"404": {
"$ref": "#/x-devx-bundled/ref_49bf9231904bbd9aa1c0"
},
"406": {
"$ref": "#/x-devx-bundled/ref_c791fb405083799347c1"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "Update funding recipient",
"tags": [
"Funding recipients"
]
}
},
"/funding-recipients/{recipientId}/funding-accounts": {
"get": {
"description": "Use this method to return a list of funding accounts associated with a funding recipient. \n\n**Note:** If you want to view the details of a specific funding account and you have its fundingAccountId, use our [Retrieve Funding Account](https://docs.payroc.com/api/schema/funding/funding-accounts/retrieve) method. \n\nTo retrieve the funding accounts associated with a funding recipient, you need the recipientId. If you don't have the recipientId, use our [List Funding Recipients](https://docs.payroc.com/api/schema/funding/funding-recipients/list) method to search for the funding recipient. \n \nOur gateway returns the following information about each funding account: \n-\tName of the account holder. \n-\tACH details for the account. \n-\tStatus of the account. \n\nOur gateway also returns the fundingAccountId, which you can use to run follow-on actions.\n",
"operationId": "listFundRecipientFundingAccounts",
"parameters": [
{
"$ref": "#/x-devx-bundled/ref_c19a1775c4f3ce903a8c"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"listFundingRecipientFundingAccountsResponse": {
"$ref": "#/x-devx-bundled/ref_21823b96a22cc3523dce"
}
},
"schema": {
"items": {
"$ref": "#/x-devx-bundled/ref_9a102086f05b94adac7a"
},
"type": "array"
}
}
},
"description": "Successful request. Returns a list of all funding accounts associated with the funding recipient."
},
"400": {
"$ref": "#/x-devx-bundled/ref_ae89d3d539618a89d2dd"
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"403": {
"$ref": "#/x-devx-bundled/ref_e17edbd5866b60d4beb9"
},
"404": {
"$ref": "#/x-devx-bundled/ref_49bf9231904bbd9aa1c0"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "List funding recipient's funding accounts",
"tags": [
"Funding recipients"
]
},
"post": {
"description": "Use this method to create a funding account and add it to a funding recipient. \n\nTo add a funding account to a funding recipient, you need the recipientId. Our gateway returned the recipientId in the response of the [Create Funding Recipient](https://docs.payroc.com/api/schema/funding/funding-recipients/create) method. \n\n**Note:** If you don't have the recipientId, use our [List Funding Recipients](https://docs.payroc.com/api/schema/funding/funding-recipients/list) method to search for the funding recipient. \n\nIn the request, include the following information: \n-\tAccount type, for example, if the account is a checking or savings account. \n-\tAccount holder's name. \n-\tACH information, including the routing number and account number of the account. \n\nOur gateway returns the fundingAccountId, which you can use to run follow-on actions.\n",
"operationId": "createFundRecipientFundingAccount",
"parameters": [
{
"$ref": "#/x-devx-bundled/ref_c19a1775c4f3ce903a8c"
},
{
"$ref": "#/x-devx-bundled/ref_b92d206f2e50ffc4c068"
}
],
"requestBody": {
"content": {
"application/json": {
"examples": {
"createFundingAccountRequest": {
"$ref": "#/x-devx-bundled/ref_c0ebd5256603a818f424"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_9a102086f05b94adac7a"
}
}
}
},
"responses": {
"201": {
"content": {
"application/json": {
"examples": {
"createFundingAccountResponse": {
"$ref": "#/x-devx-bundled/ref_25d3a2d160d559fe0850"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_9a102086f05b94adac7a"
}
}
},
"description": "Successful request. We created the funding account and added it to the funding recipient.",
"headers": {
"location": {
"$ref": "#/x-devx-bundled/ref_7b13ec5af2d2b1d9f8e7"
}
}
},
"400": {
"content": {
"application/problem+json": {
"examples": {
"idempotentKeyMissing": {
"$ref": "#/x-devx-bundled/ref_d9867eacc8169139adec"
},
"kycCheckFailed": {
"$ref": "#/x-devx-bundled/ref_2f94b2465c1e3956dcf6"
},
"validationError": {
"$ref": "#/x-devx-bundled/ref_2b3621a1c5ae119c6693"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_9477586d4a50bb60f5a4"
}
}
},
"description": "Validation errors"
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"403": {
"$ref": "#/x-devx-bundled/ref_e17edbd5866b60d4beb9"
},
"404": {
"$ref": "#/x-devx-bundled/ref_49bf9231904bbd9aa1c0"
},
"406": {
"$ref": "#/x-devx-bundled/ref_c791fb405083799347c1"
},
"409": {
"content": {
"application/problem+json": {
"examples": {
"idempotentKeyInUse": {
"$ref": "#/x-devx-bundled/ref_3917c6024cc650b3ea83"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_478798693738e1bfadb1"
}
}
},
"description": "Conflict"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "Create funding account",
"tags": [
"Funding recipients"
]
}
},
"/funding-recipients/{recipientId}/owners": {
"get": {
"description": "Use this method to return a list of owners of a funding recipient. \n\n**Note:** If you want to view the details of a specific owner and you have their ownerId, use our [Retrieve Owner](https://docs.payroc.com/api/schema/boarding/owners/retrieve) method. \n\nTo list the owners of a funding recipient, you need its recipientId. Our gateway returned the recipientId in the response of the [Create Funding Recipient](https://docs.payroc.com/api/schema/funding/funding-recipients/create) method. If you don't have the recipientId, use our [List Funding Recipients](https://docs.payroc.com/api/schema/funding/funding-recipients/list) method to search for the funding recipient. \n\nOur gateway returns the following information about each owner in the list: \n-\tName, date of birth, and address. \n-\tContact details, including their email address. \n-\tRelationship to the funding recipient. \n\nOur gateway also returns the ownerId, which you can use to perform follow-on actions. \n",
"operationId": "listFundRecipientOwners",
"parameters": [
{
"$ref": "#/x-devx-bundled/ref_c19a1775c4f3ce903a8c"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"listFundingRecipientOwnersResponse": {
"$ref": "#/x-devx-bundled/ref_95fb68692a3d0cd73a1d"
}
},
"schema": {
"items": {
"$ref": "#/x-devx-bundled/ref_d8267a8278910c858c37"
},
"type": "array"
}
}
},
"description": "Successful request. Returns a list of all owners associated with the funding recipient."
},
"400": {
"$ref": "#/x-devx-bundled/ref_ae89d3d539618a89d2dd"
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"403": {
"$ref": "#/x-devx-bundled/ref_e17edbd5866b60d4beb9"
},
"404": {
"$ref": "#/x-devx-bundled/ref_49bf9231904bbd9aa1c0"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "List funding recipient owners",
"tags": [
"Funding recipients"
]
},
"post": {
"description": "Use this method to add an additional owner to a funding recipient. \n\nTo add an owner to a funding recipient, you need the recipientId. Our gateway returned the recipientId in the response of the [Create Funding Recipient](https://docs.payroc.com/api/schema/funding/funding-recipients/create) method. \n\n**Note:** If you don't have the recipientId, use our [List Funding Recipients](https://docs.payroc.com/api/schema/funding/funding-recipients/list) method to search for the funding recipient. \n\nIn the request, include the following information about the owner: \n\n- Name, date of birth, and address. \n- Contact details, including their email address. \n- Relationship to the funding recipient, including whether they are a control prong. \n\nIn the response, our gateway returns the ownerId, which you can use to run follow-on actions. \n",
"operationId": "createFundRecipientOwner",
"parameters": [
{
"$ref": "#/x-devx-bundled/ref_c19a1775c4f3ce903a8c"
},
{
"$ref": "#/x-devx-bundled/ref_b92d206f2e50ffc4c068"
}
],
"requestBody": {
"content": {
"application/json": {
"examples": {
"createFundingRecipientOwnerRequest": {
"$ref": "#/x-devx-bundled/ref_27d1b319aaf3d8f75f65"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_d8267a8278910c858c37"
}
}
}
},
"responses": {
"201": {
"content": {
"application/json": {
"examples": {
"createFundingRecipientOwnerResponse": {
"$ref": "#/x-devx-bundled/ref_3bf02c1047cc10c95b6d"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_d8267a8278910c858c37"
}
}
},
"description": "Successful request. We created the owner and added it to the funding recipient.",
"headers": {
"location": {
"$ref": "#/x-devx-bundled/ref_7b13ec5af2d2b1d9f8e7"
}
}
},
"400": {
"content": {
"application/problem+json": {
"examples": {
"idempotentKeyMissing": {
"$ref": "#/x-devx-bundled/ref_d9867eacc8169139adec"
},
"kycCheckFailed": {
"$ref": "#/x-devx-bundled/ref_2f94b2465c1e3956dcf6"
},
"validationError": {
"$ref": "#/x-devx-bundled/ref_2b3621a1c5ae119c6693"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_9477586d4a50bb60f5a4"
}
}
},
"description": "Validation errors"
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"403": {
"$ref": "#/x-devx-bundled/ref_e17edbd5866b60d4beb9"
},
"404": {
"$ref": "#/x-devx-bundled/ref_49bf9231904bbd9aa1c0"
},
"406": {
"$ref": "#/x-devx-bundled/ref_c791fb405083799347c1"
},
"409": {
"content": {
"application/problem+json": {
"examples": {
"idempotentKeyInUse": {
"$ref": "#/x-devx-bundled/ref_3917c6024cc650b3ea83"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_478798693738e1bfadb1"
}
}
},
"description": "Conflict"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "Create funding recipient owner",
"tags": [
"Funding recipients"
]
}
},
"/fx-rates": {
"post": {
"description": "> **Important:** There are restrictions on which merchants can use this method. For more information, go to [Dynamic Currency Conversion](https://docs.payroc.com/knowledge/card-payments/dynamic-currency-conversion). \n\nUse this method to check if a card is eligible for Dynamic Currency Conversion (DCC) and to retrieve the conversion rate for a transaction amount. DCC provides a customer with the option to use their card's currency instead of the merchant's currency, for example, in Ireland, an American customer can pay in US dollars instead of Euros. \n\nThe request includes the following: \n\n- **Payment method** - Card information, a secure token, or digital wallet. \n- **Transaction information** - Amount and currency of the transaction in the merchant's currency. \n\nIf the card is eligible for DCC, our gateway returns the transaction amount in the card's currency and a dccOffer object that contains information about the conversion rate. The dccOffer object contains the following fields that you need when you [run a sale](https://docs.payroc.com/api/schema/card-payments/payments/create) or [unreferenced refund](https://docs.payroc.com/api/schema/card-payments/refunds/create-unreferenced-refund) with DCC: \n- fxAmount \n- fxCurrency \n- fxRate \n- markup \n- accepted \n- offerReference \n",
"operationId": "getFxRates",
"requestBody": {
"content": {
"application/json": {
"examples": {
"verifyDccEligibilityRequest": {
"$ref": "#/x-devx-bundled/ref_ff895c9be121743fda06"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_5a3ff2fba2045fc11a6c"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"verifyDccEligibilityResponse": {
"$ref": "#/x-devx-bundled/ref_32eaece5951b6d65379a"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_8a0780be1b8961295131"
}
}
},
"description": "Successful request. Returns the currency conversion rate for the transaction."
},
"400": {
"$ref": "#/x-devx-bundled/ref_ae89d3d539618a89d2dd"
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"403": {
"$ref": "#/x-devx-bundled/ref_e17edbd5866b60d4beb9"
},
"404": {
"$ref": "#/x-devx-bundled/ref_49bf9231904bbd9aa1c0"
},
"406": {
"$ref": "#/x-devx-bundled/ref_c791fb405083799347c1"
},
"409": {
"$ref": "#/x-devx-bundled/ref_33a47f40f610a3ad4109"
},
"415": {
"$ref": "#/x-devx-bundled/ref_40869c40b438e4591cbc"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "Verify DCC eligibility",
"tags": [
"Currency conversion"
]
}
},
"/merchant-platforms": {
"get": {
"description": "Use this method to return a [paginated](https://docs.payroc.com/api/pagination) list of merchant platforms that are linked to your ISV account. \n\n**Note**: If you want to view the details of a specific merchant platform and you have its merchantPlatformId, use our [Retrieve Merchant Platform](https://docs.payroc.com/api/schema/boarding/merchant-platforms/retrieve) method. \n\nOur gateway returns the following information about each merchant platform in the list: \n- Legal information, including its legal name and address. \n- Contact information, including the email address for the business. \n- Processing account information, including the processingAccountId and status of each processing account that's linked to the merchant platform. \n\nFor each merchant platform, we also return its merchantPlatformId and its linked processingAccountIds, which you can use to perform follow-on actions. \n",
"operationId": "listMerchantPlatforms",
"parameters": [
{
"$ref": "#/x-devx-bundled/ref_eb4bec06b486e2ceb76c"
},
{
"$ref": "#/x-devx-bundled/ref_e258178e3e59c83f2c9a"
},
{
"$ref": "#/x-devx-bundled/ref_59a42c003a97fcdab712"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"listMerchantPlatformsResponse": {
"$ref": "#/x-devx-bundled/ref_35f977ff5a4cbc011b68"
},
"noActivity": {
"$ref": "#/x-devx-bundled/ref_7ad5ac1e2a5096a96273"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_bcb851c87eef17bb9b82"
}
}
},
"description": "Successful request. Returns a list of merchant platforms associated with the ISV's account."
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"403": {
"$ref": "#/x-devx-bundled/ref_e17edbd5866b60d4beb9"
},
"406": {
"$ref": "#/x-devx-bundled/ref_c791fb405083799347c1"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "List merchant platforms",
"tags": [
"Merchant platforms"
]
},
"post": {
"description": "Use this method to board a merchant with Payroc. \n\n**Note**: This method is part of our Boarding solution. To help you understand how this method works with other Boarding methods, go to [Board a Merchant](https://docs.payroc.com/guides/board-merchants/boarding). \n\nIn the request, include the following information: \n- Legal information, including its legal name and address. \n- Contact information, including the email address for the business. \n- Processing account information, including the pricing model, owners, and contacts for the processing account. \n\nWhen you send a successful request, we review the merchant's information. After we complete our review and approve the merchant, we assign: \n- **merchantPlatformId** - Unique identifier for the merchant platform. \n- **processingAccountId** - Unique identifier for each processing account linked to the merchant platform. \n\nYou need to keep these to perform follow-on actions, for example, you need the processingAccountId to [order terminals](https://docs.payroc.com/api/schema/boarding/processing-accounts/create-terminal-order) for the processing account.\n",
"operationId": "createMerchant",
"parameters": [
{
"$ref": "#/x-devx-bundled/ref_b92d206f2e50ffc4c068"
}
],
"requestBody": {
"content": {
"application/json": {
"examples": {
"createMerchantPlatformAddendumsRequest": {
"$ref": "#/x-devx-bundled/ref_e51c40a52ecb254b0a94"
},
"createMerchantPlatformFiservCloverAmendmentRequest": {
"$ref": "#/x-devx-bundled/ref_f0824408a74fbe3169d2"
},
"createMerchantPlatformRequest": {
"$ref": "#/x-devx-bundled/ref_e34fb71792f1a2594c56"
},
"createMerchantPlatformRocGivingRequest": {
"$ref": "#/x-devx-bundled/ref_b65288f9c4e554ac3078"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_44f6cabb0f45caf9bc65"
}
}
}
},
"responses": {
"201": {
"content": {
"application/json": {
"examples": {
"created": {
"$ref": "#/x-devx-bundled/ref_7b6a073264e2e400d69a"
},
"createdFiservWithCloverAmendment": {
"$ref": "#/x-devx-bundled/ref_58b532704ca76eef45cb"
},
"createdWithAddendums": {
"$ref": "#/x-devx-bundled/ref_4417d20cfb0a581b592e"
},
"createdWithRocGiving": {
"$ref": "#/x-devx-bundled/ref_88faa6e8a02090e6f7f0"
},
"partialSuccess": {
"$ref": "#/x-devx-bundled/ref_37bcccdc99a0ca8fdad6"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_5ef41b0d7789b150c540"
}
}
},
"description": "Successful request. We created the merchant platform.",
"headers": {
"location": {
"description": "URI reference to the resource.",
"schema": {
"type": "string"
}
}
}
},
"400": {
"content": {
"application/problem+json": {
"examples": {
"addendumMissingRequiredFields": {
"$ref": "#/x-devx-bundled/ref_05105d02b9d70ef97d64"
},
"dailyDiscountAndRewardPayConflict": {
"$ref": "#/x-devx-bundled/ref_934de109dee2c56fbd84"
},
"duplicateAddendumType": {
"$ref": "#/x-devx-bundled/ref_eadb292c05306fab39ef"
},
"fundingAccountsLimitReached": {
"$ref": "#/x-devx-bundled/ref_4464dcd514df15e8a3c4"
},
"idempotentKeyMissing": {
"$ref": "#/x-devx-bundled/ref_d9867eacc8169139adec"
},
"noControlProng": {
"$ref": "#/x-devx-bundled/ref_7a1d6586d5d2a85d9ad7"
},
"tooManyControlProngs": {
"$ref": "#/x-devx-bundled/ref_2fd09ba629b748a2894a"
},
"unrecognisedAddendumType": {
"$ref": "#/x-devx-bundled/ref_3ceb0dcb095102350228"
},
"unrecognisedProcessor": {
"$ref": "#/x-devx-bundled/ref_02bc8dae9d717a1f1e16"
},
"validationError": {
"$ref": "#/x-devx-bundled/ref_2b3621a1c5ae119c6693"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_9477586d4a50bb60f5a4"
}
}
},
"description": "Validation error."
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"403": {
"$ref": "#/x-devx-bundled/ref_e17edbd5866b60d4beb9"
},
"406": {
"$ref": "#/x-devx-bundled/ref_c791fb405083799347c1"
},
"409": {
"content": {
"application/problem+json": {
"examples": {
"idempotentKeyInUse": {
"$ref": "#/x-devx-bundled/ref_3917c6024cc650b3ea83"
},
"nationalIdInUse": {
"$ref": "#/x-devx-bundled/ref_e08abee75402279abc03"
},
"taxIdInUse": {
"$ref": "#/x-devx-bundled/ref_298348ccdbe167891cea"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_478798693738e1bfadb1"
}
}
},
"description": "Conflict"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "Create merchant platform",
"tags": [
"Merchant platforms"
]
},
"summary": "Provide capabilities to manage a merchant platform."
},
"/merchant-platforms/{merchantPlatformId}": {
"get": {
"description": "Use this method to retrieve information about a merchant platform. \n\nTo retrieve a merchant platform, you need its merchantPlatformId. Our gateway returned the merchantPlatformId in the response of the [Create Merchant Platform](https://docs.payroc.com/api/schema/boarding/merchant-platforms/create) method. \n\n**Note:** If you don't have the merchantPlatformId, use our [List Merchant Platforms](https://docs.payroc.com/api/schema/boarding/merchant-platforms/list) method to search for the merchant platform.\n\nOur gateway returns the following information about the merchant platform:\n-\tLegal information, including its legal name and address.\n-\tContact information, including the email address for the business. \n-\tProcessing account information, including the processingAccountId and status of each processing account that's linked to the merchant platform. \n",
"operationId": "getMerchantAccounts",
"parameters": [
{
"$ref": "#/x-devx-bundled/ref_3436967d00d8bbbdb47f"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"retrieveMerchantPlatformResponse": {
"$ref": "#/x-devx-bundled/ref_874b864c557792343f79"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_5ef41b0d7789b150c540"
}
}
},
"description": "Successful request. Returns the merchant platform."
},
"400": {
"$ref": "#/x-devx-bundled/ref_ae89d3d539618a89d2dd"
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"403": {
"$ref": "#/x-devx-bundled/ref_e17edbd5866b60d4beb9"
},
"404": {
"$ref": "#/x-devx-bundled/ref_49bf9231904bbd9aa1c0"
},
"406": {
"$ref": "#/x-devx-bundled/ref_c791fb405083799347c1"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "Retrieve merchant platform",
"tags": [
"Merchant platforms"
]
}
},
"/merchant-platforms/{merchantPlatformId}/processing-accounts": {
"get": {
"description": "Use this method to return a [paginated](https://docs.payroc.com/api/pagination) list of processing accounts linked to a merchant platform. \n\n**Note**: If you want to view the details of a specific processing account and you have its processingAccountId, use our [Retrieve Processing Account](https://docs.payroc.com/api/schema/boarding/processing-accounts/retrieve) method. \n\nUse the query parameters to filter the list of results that we return, for example, to search for only closed processing accounts. \n\nTo list the processing accounts for a merchant platform, you need its merchantPlatformId. If you don't have the merchantPlatformId, use our [List Merchant Platforms](https://docs.payroc.com/api/schema/boarding/merchant-platforms/list) method to search for the merchant platform.\n\nOur gateway returns the following information about eahc processing account in the list: \n- Business details, including its status, time zone, and address. \n- Owners' details, including their contact details. \n- Funding, pricing, and processing information, including its pricing model and funding accounts. \n\nFor each processing account, we also return its processingAccountId, which you can use to perform follow-on actions. \n",
"operationId": "listMerchantLocations",
"parameters": [
{
"$ref": "#/x-devx-bundled/ref_3436967d00d8bbbdb47f"
},
{
"$ref": "#/x-devx-bundled/ref_eb4bec06b486e2ceb76c"
},
{
"$ref": "#/x-devx-bundled/ref_e258178e3e59c83f2c9a"
},
{
"$ref": "#/x-devx-bundled/ref_59a42c003a97fcdab712"
},
{
"$ref": "#/x-devx-bundled/ref_d6fca19f77413d66469c"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"listMerchantPlatformProcessingAccountsResponse": {
"$ref": "#/x-devx-bundled/ref_a9d70376596ad36868dd"
},
"noActivity": {
"$ref": "#/x-devx-bundled/ref_7ad5ac1e2a5096a96273"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_52512ed7a070cd51d20e"
}
}
},
"description": "Successful request. Returns a list of processing accounts associated with the merchant platform."
},
"400": {
"$ref": "#/x-devx-bundled/ref_ae89d3d539618a89d2dd"
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"403": {
"$ref": "#/x-devx-bundled/ref_e17edbd5866b60d4beb9"
},
"406": {
"$ref": "#/x-devx-bundled/ref_c791fb405083799347c1"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "List merchant platform's processing accounts",
"tags": [
"Merchant platforms"
]
},
"post": {
"description": "Use this method to add an additional processing account to a merchant platform. \n\nTo add a processing account to a merchant platform, you need the merchantPlatformId. Our gateway returned the merchantPlatformId in the response of the [Create Merchant Platform](https://docs.payroc.com/api/schema/boarding/merchant-platforms/create) method. \n\n**Note**: If you don't have the merchantPlatformId, use our [List Merchant Platforms](https://docs.payroc.com/api/schema/boarding/merchant-platforms/list) method to search for the merchant platform. \n\nIn the request, include the following information: \n- Business details, including its business type, time zone, and address. \n- Owners' details, including their contact details. \n- Funding, pricing, and processing information, including its pricing model and funding accounts. \n- Additional forms that you need us to send to the merchant, for example, attestations and questionnaires.\n\nWhen you send a successful request, we review the information about the processing account. After we complete our review and approve the processing account, we assign a processingAccountId, which you need to perform follow-on actions. \n\n**Note**: You can subscribe to our processingAccount.status.changed event to get notifications when we update the status of a processing account. For more information about how to subscribe to events, go to [Events List](https://docs.payroc.com/knowledge/events/events-list).\n",
"operationId": "createProcessingAccount",
"parameters": [
{
"$ref": "#/x-devx-bundled/ref_3436967d00d8bbbdb47f"
},
{
"$ref": "#/x-devx-bundled/ref_b92d206f2e50ffc4c068"
}
],
"requestBody": {
"content": {
"application/json": {
"examples": {
"createProcessingAccountAddendumsRequest": {
"$ref": "#/x-devx-bundled/ref_4c7d7df93d7361f18712"
},
"createProcessingAccountFiservRequest": {
"$ref": "#/x-devx-bundled/ref_597d3524aa5e3d0750d8"
},
"createProcessingAccountMerchantPlatformRequest": {
"$ref": "#/x-devx-bundled/ref_bc4b96b694763626a81c"
},
"createProcessingAccountRocGivingRequest": {
"$ref": "#/x-devx-bundled/ref_c26b7e140cdf0511d715"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_892cf73eb4222b64e3e5"
}
}
}
},
"responses": {
"201": {
"content": {
"application/json": {
"examples": {
"createProcessingAccountAddendumsResponse": {
"$ref": "#/x-devx-bundled/ref_51e918dea70bea67fcf8"
},
"createProcessingAccountFiservCloverAmendmentResponse": {
"$ref": "#/x-devx-bundled/ref_bed4509beb9fb54e6ad6"
},
"createProcessingAccountFiservNoCloverResponse": {
"$ref": "#/x-devx-bundled/ref_7370bae0071197c0ab53"
},
"createProcessingAccountResponse": {
"$ref": "#/x-devx-bundled/ref_e682501abdc2c1d6f4e2"
},
"createProcessingAccountRocGivingResponse": {
"$ref": "#/x-devx-bundled/ref_5cbe2263a9f2282f6a63"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_214544c04ba3708ed212"
}
}
},
"description": "Successful request. We created the processing account.",
"headers": {
"location": {
"description": "URI reference to the resource.",
"schema": {
"type": "string"
}
}
}
},
"400": {
"content": {
"application/problem+json": {
"examples": {
"addendumMissingRequiredFields": {
"$ref": "#/x-devx-bundled/ref_05105d02b9d70ef97d64"
},
"dailyDiscountAndRewardPayConflict": {
"$ref": "#/x-devx-bundled/ref_934de109dee2c56fbd84"
},
"duplicateAddendumType": {
"$ref": "#/x-devx-bundled/ref_eadb292c05306fab39ef"
},
"fundingAccountsLimitReached": {
"$ref": "#/x-devx-bundled/ref_4464dcd514df15e8a3c4"
},
"idempotentKeyMissing": {
"$ref": "#/x-devx-bundled/ref_d9867eacc8169139adec"
},
"noControlProng": {
"$ref": "#/x-devx-bundled/ref_7a1d6586d5d2a85d9ad7"
},
"tooManyControlProngs": {
"$ref": "#/x-devx-bundled/ref_2fd09ba629b748a2894a"
},
"unrecognisedAddendumType": {
"$ref": "#/x-devx-bundled/ref_3ceb0dcb095102350228"
},
"unrecognisedProcessor": {
"$ref": "#/x-devx-bundled/ref_02bc8dae9d717a1f1e16"
},
"validationError": {
"$ref": "#/x-devx-bundled/ref_2b3621a1c5ae119c6693"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_9477586d4a50bb60f5a4"
}
}
},
"description": "Validation error."
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"404": {
"$ref": "#/x-devx-bundled/ref_49bf9231904bbd9aa1c0"
},
"406": {
"$ref": "#/x-devx-bundled/ref_c791fb405083799347c1"
},
"409": {
"content": {
"application/problem+json": {
"examples": {
"idempotentKeyInUse": {
"$ref": "#/x-devx-bundled/ref_3917c6024cc650b3ea83"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_478798693738e1bfadb1"
}
}
},
"description": "Conflict"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "Create processing account",
"tags": [
"Merchant platforms"
]
}
},
"/owners/{ownerId}": {
"delete": {
"description": "> **Important:** You can't delete an owner of a processing account. \n\nUse this method to delete an owner associated with a funding recipient. You can delete an owner only if the funding recipient has more than one owner. \n\nTo delete an owner, you need their ownerId. Our gateway returned the ownerId in the response of the [Create Funding Recipient](https://docs.payroc.com/api/schema/funding/funding-recipients/create) method and the [Create Funding Recipient Owner](https://docs.payroc.com/api/schema/funding/funding-recipients/create-owner) method. \n\n**Note:** If you don't have the ownerId, use the [List Funding Recipient Owners](https://docs.payroc.com/api/schema/funding/funding-recipients/list-owners) method, the [Retrieve Funding Recipient](https://docs.payroc.com/api/schema/funding/funding-recipients/retrieve) method, or the [List Funding Recipients](https://docs.payroc.com/api/schema/funding/funding-recipients/list) method to search for the funding recipient owner. \n",
"operationId": "deleteOwner",
"parameters": [
{
"$ref": "#/x-devx-bundled/ref_1676b2d018f8f9b3160a"
}
],
"responses": {
"204": {
"description": "Successful request. We deleted the owner."
},
"400": {
"$ref": "#/x-devx-bundled/ref_ae89d3d539618a89d2dd"
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"403": {
"$ref": "#/x-devx-bundled/ref_e17edbd5866b60d4beb9"
},
"404": {
"$ref": "#/x-devx-bundled/ref_49bf9231904bbd9aa1c0"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "Delete owner",
"tags": [
"Owners"
]
},
"get": {
"description": "Use this method to retrieve details about an owner of a processing account or an owner associated with a funding recipient. \n\nTo retrieve an owner, you need their ownerId. Our gateway returned the ownerId in the response of the [Create Processing Account](https://docs.payroc.com/api/schema/boarding/merchant-platforms/create-processing-account) method or the [Create Funding Recipient Owner](https://docs.payroc.com/api/schema/funding/funding-recipients/create-owner) method. \n\n**Note:** If you don't have the ownerId, use the [Retrieve Processing Account](https://docs.payroc.com/api/schema/boarding/processing-accounts/retrieve) method if you are searching for a processing account owner, or use the [List Funding Recipient Owners](https://docs.payroc.com/api/schema/funding/funding-recipients/list-owners) method if you are searching for a funding recipient owner. \n\nOur gateway returns the following information about an owner: \n- Name, date of birth, and address. \n- Contact details, including their email address. \n- Relationship to the business, including whether they are a control prong or authorized signatory, and their equity stake in the business. \n",
"operationId": "getOwner",
"parameters": [
{
"$ref": "#/x-devx-bundled/ref_1676b2d018f8f9b3160a"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"retrieveOwnerResponse": {
"$ref": "#/x-devx-bundled/ref_0d2180a6aea8b0cb280c"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_d8267a8278910c858c37"
}
}
},
"description": "Successful request. Returns the requested owner."
},
"400": {
"$ref": "#/x-devx-bundled/ref_ae89d3d539618a89d2dd"
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"403": {
"$ref": "#/x-devx-bundled/ref_e17edbd5866b60d4beb9"
},
"404": {
"$ref": "#/x-devx-bundled/ref_49bf9231904bbd9aa1c0"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "Retrieve owner",
"tags": [
"Owners"
]
},
"put": {
"description": "> **Important:** You can't update the details of an owner of a processing account. \n\nUse this method to update the details of an owner associated with a funding recipient. \n\nTo update an owner, you need their ownerId. Our gateway returned the ownerId in the response of the [Create Funding Recipient](https://docs.payroc.com/api/schema/funding/funding-recipients/create) method and the [Create Funding Recipient Owner](https://docs.payroc.com/api/schema/funding/funding-recipients/create-owner) method. \n\n**Note:** If you don't have the ownerId, use the [List Funding Recipient Owners](https://docs.payroc.com/api/schema/funding/funding-recipients/list-owners) method, the [Retrieve Funding Recipient](https://docs.payroc.com/api/schema/funding/funding-recipients/retrieve) method, or the [List Funding Recipients](https://docs.payroc.com/api/schema/funding/funding-recipients/list) method to search for the funding recipient owner. \n\nYou can update the following details about an owner: \n\n- Personal details, including their name, date of birth, and address. \n- Identification details, including their identification type and number. \n- Contact details, including their email address. \n- Relationship to the business, including whether they are a control prong. \n",
"operationId": "updateOwner",
"parameters": [
{
"$ref": "#/x-devx-bundled/ref_1676b2d018f8f9b3160a"
}
],
"requestBody": {
"content": {
"application/json": {
"examples": {
"updateOwnerRequest": {
"$ref": "#/x-devx-bundled/ref_bbf5dd0b28f6c5984e91"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_d8267a8278910c858c37"
}
}
}
},
"responses": {
"204": {
"description": "Successful request. We updated the owner."
},
"400": {
"content": {
"application/problem+json": {
"examples": {
"kycCheckFailed": {
"$ref": "#/x-devx-bundled/ref_2f94b2465c1e3956dcf6"
},
"validationError": {
"$ref": "#/x-devx-bundled/ref_2b3621a1c5ae119c6693"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_9477586d4a50bb60f5a4"
}
}
},
"description": "Validation errors."
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"403": {
"$ref": "#/x-devx-bundled/ref_e17edbd5866b60d4beb9"
},
"404": {
"$ref": "#/x-devx-bundled/ref_49bf9231904bbd9aa1c0"
},
"406": {
"$ref": "#/x-devx-bundled/ref_c791fb405083799347c1"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "Update owner",
"tags": [
"Owners"
]
}
},
"/payment-instructions/{paymentInstructionId}": {
"delete": {
"description": "Use this method to cancel a payment instruction. \n\nYou can cancel a payment instruction only if its status is `inProgress`. To retrieve the status of a payment instruction, use our [Retrieve Payment Instruction](https://docs.payroc.com/api/schema/payroc-cloud/payment-instructions/retrieve) method. \n\nTo cancel a payment instruction, you need its paymentInstructionId. Our gateway returned the paymentInstructionId in the response of the [Submit Payment Instruction](https://docs.payroc.com/api/schema/payroc-cloud/payment-instructions/submit) method.\n",
"operationId": "deletePaymentInstruction",
"parameters": [
{
"$ref": "#/x-devx-bundled/ref_5a29f67f5e5f798760db"
}
],
"responses": {
"204": {
"description": "Successful request. We canceled the payment instruction."
},
"400": {
"$ref": "#/x-devx-bundled/ref_ae89d3d539618a89d2dd"
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"403": {
"$ref": "#/x-devx-bundled/ref_e17edbd5866b60d4beb9"
},
"404": {
"$ref": "#/x-devx-bundled/ref_49bf9231904bbd9aa1c0"
},
"406": {
"$ref": "#/x-devx-bundled/ref_c791fb405083799347c1"
},
"409": {
"content": {
"application/problem+json": {
"examples": {
"paymentInstructionCompleted": {
"$ref": "#/x-devx-bundled/ref_75f958179d546bcbf343"
},
"paymentInstructionFailed": {
"$ref": "#/x-devx-bundled/ref_2814f083a1062466f4a7"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_478798693738e1bfadb1"
}
}
},
"description": "Conflict"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "Cancel payment instruction",
"tags": [
"Payment instructions"
]
},
"get": {
"description": "Use this method to retrieve information about a payment instruction. \n\nTo retrieve a payment instruction, you need its paymentInstructionId. Our gateway returned the paymentInstructionId in the response of the [Submit Payment Instruction](https://docs.payroc.com/api/schema/payroc-cloud/payment-instructions/submit) method. \n\nOur gateway returns the status of the payment instruction. If the payment device completed the payment instruction, the response also includes a link to the payment.\n",
"operationId": "getPaymentInstruction",
"parameters": [
{
"$ref": "#/x-devx-bundled/ref_5a29f67f5e5f798760db"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"retrievePaymentInstructionCompletedResponse": {
"$ref": "#/x-devx-bundled/ref_9a1e75662789fc8b8cc1"
},
"retrievePaymentInstructionMifareCardResponse": {
"$ref": "#/x-devx-bundled/ref_089d247e655158a8093a"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_4a7b91fc0a7e14e78dfc"
}
}
},
"description": "Successful request. Returns the current status of the requested payment instruction."
},
"400": {
"$ref": "#/x-devx-bundled/ref_ae89d3d539618a89d2dd"
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"403": {
"$ref": "#/x-devx-bundled/ref_e17edbd5866b60d4beb9"
},
"404": {
"$ref": "#/x-devx-bundled/ref_49bf9231904bbd9aa1c0"
},
"406": {
"$ref": "#/x-devx-bundled/ref_c791fb405083799347c1"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "Retrieve payment instruction",
"tags": [
"Payment instructions"
]
}
},
"/payment-intents/{paymentIntentId}": {
"get": {
"description": "Use this method to retrieve a payment intent, including who is paying for the terminal order and how they are paying for the terminal order. \n\nInclude the paymentIntentId that we sent you when you created the terminal order.\n",
"operationId": "getPaymentIntent",
"parameters": [
{
"$ref": "#/x-devx-bundled/ref_0a288d7a7d1bbdc66d5d"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"paymentIntent": {
"$ref": "#/x-devx-bundled/ref_b7793096ce4d62ff8422"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_6fb9b9559ed218c0aa0a"
}
}
},
"description": "Successful request. Returns the payment intent."
},
"400": {
"$ref": "#/x-devx-bundled/ref_ae89d3d539618a89d2dd"
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"403": {
"$ref": "#/x-devx-bundled/ref_e17edbd5866b60d4beb9"
},
"404": {
"$ref": "#/x-devx-bundled/ref_49bf9231904bbd9aa1c0"
},
"406": {
"$ref": "#/x-devx-bundled/ref_c791fb405083799347c1"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "Retrieve payment intent",
"tags": [
"Payment intents"
]
}
},
"/payment-links/{paymentLinkId}": {
"get": {
"description": "Use this method to retrieve information about a payment link. \n\nTo retrieve a payment link, you need its paymentLinkId. Our gateway returned the paymentLinkId in the response of the [Create Payment Link](https://docs.payroc.com/api/schema/payment-links/create) method. \n\n**Note:** If you don't have the paymentLinkId, use our [List Payment Links](https://docs.payroc.com/api/schema/payment-links/list) method to search for the payment link. \n\nOur gateway returns the following information about the payment link: \n- **type** - Indicates whether the link can be used only once or if it can be used multiple times. \n- **authType** - Indicates whether the transaction is a sale or a pre-authorization. \n- **paymentMethods** - Indicates the payment method that the merchant accepts. \n- **charge** - Indicates whether the merchant or the customer enters the amount for the transaction.\n- **status** - Indicates if the payment link is active. \n",
"operationId": "retrievePaymentLink",
"parameters": [
{
"$ref": "#/x-devx-bundled/ref_c68b02cf90eaad772b5f"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"paymentLink": {
"$ref": "#/x-devx-bundled/ref_16ee05144593b91396cb"
}
},
"schema": {
"oneOf": [
{
"$ref": "#/x-devx-bundled/ref_210fbadc5eb6d4079f9a"
},
{
"$ref": "#/x-devx-bundled/ref_0f813605d6f1b2a63bdb"
}
],
"type": "object"
}
}
},
"description": "Successful request. We return a polymorphic object that contains payment link information.\nThe value of the type parameter determines which variant you should use:\n-\t`multiUse` - Create a link that the merchant can use to take multiple payments.\n-\t`singleUse` - Create a link that the merchant can use for only one payment.\n"
},
"400": {
"$ref": "#/x-devx-bundled/ref_ae89d3d539618a89d2dd"
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"403": {
"$ref": "#/x-devx-bundled/ref_e17edbd5866b60d4beb9"
},
"404": {
"$ref": "#/x-devx-bundled/ref_49bf9231904bbd9aa1c0"
},
"406": {
"$ref": "#/x-devx-bundled/ref_c791fb405083799347c1"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "Retrieve payment link",
"tags": [
"Payment links"
]
},
"patch": {
"description": "Use this method to partially update a payment link. Structure your request to follow the [RFC 6902](https://datatracker.ietf.org/doc/html/rfc6902) standard.\n\nTo update a payment link, you need its paymentLinkId, which we sent you in the response of the [Create Payment Link](https://docs.payroc.com/api/schema/payment-links/create) method. \n\n**Note:** If you don't have the paymentLinkId, use our [List Payment Links](https://docs.payroc.com/api/schema/payment-links/list) method to search for the payment link. \n\nYou can update the following properties of a multi-use link:\n- **expiresOn parameter** - Expiration date of the link.\n- **customLabels object** - Label for the payment button.\n- **credentialOnFile object** - Settings for saving the customer's payment details.\n\nYou can update the following properties of a single-use link:\n- **expiresOn parameter** - Expiration date of the link.\n- **authType parameter** - Transaction type of the payment link.\n- **amount parameter** - Total amount of the transaction.\n- **currency parameter** - Currency of the transaction.\n- **description parameter** - Brief description of the transaction.\n- **customLabels object** - Label for the payment button.\n- **credentialOnFile object** - Settings for saving the customer's payment details.\n\n**Note:** When a merchant updates a single-use link, we update the payment URL and HTML code in the assets object. The customer can't use the original link to make a payment.\n",
"operationId": "updatePaymentLink",
"parameters": [
{
"$ref": "#/x-devx-bundled/ref_b92d206f2e50ffc4c068"
},
{
"$ref": "#/x-devx-bundled/ref_c68b02cf90eaad772b5f"
}
],
"requestBody": {
"content": {
"application/json": {
"examples": {
"partiallyUpdatePaymentLinkAddRequest": {
"$ref": "#/x-devx-bundled/ref_a71fc2114d097f488c6e"
},
"partiallyUpdatePaymentLinkCopyRequest": {
"$ref": "#/x-devx-bundled/ref_de4ac55714caec7e9f55"
},
"partiallyUpdatePaymentLinkMoveRequest": {
"$ref": "#/x-devx-bundled/ref_886ee4f1d8c61cf8a614"
},
"partiallyUpdatePaymentLinkRealisticRequest": {
"$ref": "#/x-devx-bundled/ref_b064a307eb20a800a23c"
},
"partiallyUpdatePaymentLinkRemoveRequest": {
"$ref": "#/x-devx-bundled/ref_365438e6711d2ea8ba95"
},
"partiallyUpdatePaymentLinkReplaceRequest": {
"$ref": "#/x-devx-bundled/ref_d3a4eba54bda0d8ac8e1"
},
"partiallyUpdatePaymentLinkTestRequest": {
"$ref": "#/x-devx-bundled/ref_408c032a9e6bad0d9e05"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_83c73ee340defd8c776d"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"patchPaymentLinkAdd": {
"$ref": "#/x-devx-bundled/ref_ef28873e9f9f9507a593"
},
"patchPaymentLinkCopy": {
"$ref": "#/x-devx-bundled/ref_1a3439d8d471f6290741"
},
"patchPaymentLinkMove": {
"$ref": "#/x-devx-bundled/ref_147d3bc5742cd6354104"
},
"patchPaymentLinkRealistic": {
"$ref": "#/x-devx-bundled/ref_43f30bf2d87d182bd302"
},
"patchPaymentLinkRemove": {
"$ref": "#/x-devx-bundled/ref_7f6a2dd1c7bdccb0dcef"
},
"patchPaymentLinkReplace": {
"$ref": "#/x-devx-bundled/ref_f218edb412905fb7df43"
},
"patchPaymentLinkTest": {
"$ref": "#/x-devx-bundled/ref_3200994f911b36ba58d7"
}
},
"schema": {
"oneOf": [
{
"$ref": "#/x-devx-bundled/ref_210fbadc5eb6d4079f9a"
},
{
"$ref": "#/x-devx-bundled/ref_0f813605d6f1b2a63bdb"
}
],
"type": "object"
}
}
},
"description": "Successful request. We updated the payment link and return a polymorphic object that contains payment link information.\nThe value of the type parameter determines which variant you should use:\n-\t`multiUse` - Create a link that the merchant can use to take multiple payments.\n-\t`singleUse` - Create a link that the merchant can use for only one payment.\n"
},
"400": {
"$ref": "#/x-devx-bundled/ref_ae89d3d539618a89d2dd"
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"403": {
"$ref": "#/x-devx-bundled/ref_e17edbd5866b60d4beb9"
},
"404": {
"$ref": "#/x-devx-bundled/ref_49bf9231904bbd9aa1c0"
},
"406": {
"$ref": "#/x-devx-bundled/ref_c791fb405083799347c1"
},
"409": {
"$ref": "#/x-devx-bundled/ref_33a47f40f610a3ad4109"
},
"415": {
"$ref": "#/x-devx-bundled/ref_40869c40b438e4591cbc"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "Partially update payment link",
"tags": [
"Payment links"
]
}
},
"/payment-links/{paymentLinkId}/deactivate": {
"post": {
"description": "Use this method to deactivate a payment link. \n\nTo deactivate a payment link, you need its paymentLinkId. Our gateway returned the paymentLinkId in the response of the [Create Payment Link](https://docs.payroc.com/api/schema/payment-links/create) method. \n\n**Note:** If you don't have the paymentLinkId, use our [List Payment Links](https://docs.payroc.com/api/schema/payment-links/list) method to search for the payment link. \n\nIf your request is successful, our gateway deactivates the payment link. The customer can't use the link to make a payment, and you can't reactivate the payment link. \n",
"operationId": "deactivatePaymentLink",
"parameters": [
{
"$ref": "#/x-devx-bundled/ref_c68b02cf90eaad772b5f"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"deactivatePaymentLinkResponse": {
"$ref": "#/x-devx-bundled/ref_b431b957bb62172688d7"
}
},
"schema": {
"oneOf": [
{
"$ref": "#/x-devx-bundled/ref_210fbadc5eb6d4079f9a"
},
{
"$ref": "#/x-devx-bundled/ref_0f813605d6f1b2a63bdb"
}
],
"type": "object"
}
}
},
"description": "Successful request. We return a polymorphic object that contains payment link information. \n\nThe value of the type parameter determines which variant you should use: \n-\t`multiUse` - Create a link that the merchant can use to take multiple payments.\n-\t`singleUse` - Create a link that the merchant can use for only one payment.\n"
},
"400": {
"$ref": "#/x-devx-bundled/ref_ae89d3d539618a89d2dd"
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"403": {
"$ref": "#/x-devx-bundled/ref_e17edbd5866b60d4beb9"
},
"404": {
"$ref": "#/x-devx-bundled/ref_49bf9231904bbd9aa1c0"
},
"406": {
"$ref": "#/x-devx-bundled/ref_c791fb405083799347c1"
},
"409": {
"$ref": "#/x-devx-bundled/ref_33a47f40f610a3ad4109"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "Deactivate payment link",
"tags": [
"Payment links"
]
}
},
"/payment-links/{paymentLinkId}/sharing-events": {
"get": {
"description": "Use this method to return a [paginated](https://docs.payroc.com/api/pagination) list of sharing events for a payment link. A sharing event occurs when a merchant shares a payment link with a customer. \n\nTo list the sharing events for a payment link, you need its paymentLinkId. Our gateway returned the paymentLinkId in the response of the [Create Payment Link](https://docs.payroc.com/api/schema/payment-links/create) method. \n\n**Note:** If you don't have the paymentLinkId, use our [List Payment Links](https://docs.payroc.com/api/schema/payment-links/list) method to search for the payment link. \n\nUse query parameters to filter the list of results that we return, for example, to search for links sent to a specific customer. \n\nOur gateway returns the following information for each sharing event in the list: \n- Customer that the merchant sent the link to. \n- Date that the merchant sent the link. \n",
"operationId": "listPaymentLinkShareEvents",
"parameters": [
{
"$ref": "#/x-devx-bundled/ref_c68b02cf90eaad772b5f"
},
{
"$ref": "#/x-devx-bundled/ref_fc48a721906cd4080a66"
},
{
"$ref": "#/x-devx-bundled/ref_110d5c260cf5acafc170"
},
{
"$ref": "#/x-devx-bundled/ref_eb4bec06b486e2ceb76c"
},
{
"$ref": "#/x-devx-bundled/ref_e258178e3e59c83f2c9a"
},
{
"$ref": "#/x-devx-bundled/ref_59a42c003a97fcdab712"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"noActivity": {
"$ref": "#/x-devx-bundled/ref_7ad5ac1e2a5096a96273"
},
"paginatedResults": {
"$ref": "#/x-devx-bundled/ref_a7d713eee6a8492cd70e"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_5170561f048f13dd2a04"
}
}
},
"description": "Successful request. Returns a [paginated](https://docs.payroc.com/api/pagination) list of sharing events for the payment link."
},
"400": {
"$ref": "#/x-devx-bundled/ref_ae89d3d539618a89d2dd"
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"403": {
"$ref": "#/x-devx-bundled/ref_e17edbd5866b60d4beb9"
},
"404": {
"$ref": "#/x-devx-bundled/ref_49bf9231904bbd9aa1c0"
},
"406": {
"$ref": "#/x-devx-bundled/ref_c791fb405083799347c1"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "List payment link sharing events",
"tags": [
"Payment links"
]
},
"post": {
"description": "Use this method to email a payment link to a customer. \n\nTo email a payment link, you need its paymentLinkId. Our gateway returned the paymentLinkId in the response of the [Create Payment Link](https://docs.payroc.com/api/schema/payment-links/create) method. \n\n**Note:** If you don't have the paymentLinkId, use our [List Payment Links](https://docs.payroc.com/api/schema/payment-links/list) method to search for the payment link. \n\nIn the request, you must provide the recipient's name and email address. \n\nIn the response, our gateway returns a sharingEventId, which you can use to [List Payment Link Sharing Events](https://docs.payroc.com/api/schema/payment-links/sharing-events/list). \n",
"operationId": "sharePaymentLink",
"parameters": [
{
"$ref": "#/x-devx-bundled/ref_b92d206f2e50ffc4c068"
},
{
"$ref": "#/x-devx-bundled/ref_c68b02cf90eaad772b5f"
}
],
"requestBody": {
"content": {
"application/json": {
"examples": {
"sharePaymentLinkRequest": {
"$ref": "#/x-devx-bundled/ref_eb7d7cab924d0e73a344"
}
},
"schema": {
"description": "Polymorphic object that contains information about how to share a payment link.",
"oneOf": [
{
"$ref": "#/x-devx-bundled/ref_c808d1e5154b0c70f97a"
}
],
"type": "object"
}
}
}
},
"responses": {
"201": {
"content": {
"application/json": {
"examples": {
"sharePaymentLinkResponse": {
"$ref": "#/x-devx-bundled/ref_18649c5e5a02aae46fe7"
}
},
"schema": {
"oneOf": [
{
"$ref": "#/x-devx-bundled/ref_c808d1e5154b0c70f97a"
}
],
"type": "object"
}
}
},
"description": "Successful request. We return a polymorphic object that contains information about how the merchant shared a payment link."
},
"400": {
"$ref": "#/x-devx-bundled/ref_ae89d3d539618a89d2dd"
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"403": {
"$ref": "#/x-devx-bundled/ref_e17edbd5866b60d4beb9"
},
"404": {
"$ref": "#/x-devx-bundled/ref_49bf9231904bbd9aa1c0"
},
"406": {
"$ref": "#/x-devx-bundled/ref_c791fb405083799347c1"
},
"409": {
"$ref": "#/x-devx-bundled/ref_33a47f40f610a3ad4109"
},
"415": {
"$ref": "#/x-devx-bundled/ref_40869c40b438e4591cbc"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "Share payment link",
"tags": [
"Payment links"
]
}
},
"/payments": {
"get": {
"description": "Use this method to return a [paginated](https://docs.payroc.com/api/pagination) list of payments. \n\n**Note:** If you want to view the details of a specific payment and you have its paymentId, use our [Retrieve Payment](https://docs.payroc.com/api/schema/card-payments/payments/retrieve) method. \n\nUse query parameters to filter the list of results that we return, for example, to search for payments for a customer, a tip mode, or a date range. \n\nOur gateway returns the following information about each payment in the list: \n\n- Order details, including the transaction amount and when it was processed. \n- Payment card details, including the masked card number, expiry date, and payment method. \n- Cardholder details, including their contact information and shipping address. \n- Payment details, including the payment type, status, and response. \n \nFor each transaction, we also return the paymentId and an optional secureTokenId, which you can use to perform follow-on actions. \n",
"operationId": "listPayments",
"parameters": [
{
"$ref": "#/x-devx-bundled/ref_43adc899006f90cf2a05"
},
{
"$ref": "#/x-devx-bundled/ref_a216874b9b80aef287c3"
},
{
"$ref": "#/x-devx-bundled/ref_7b54f337810177aab4ea"
},
{
"$ref": "#/x-devx-bundled/ref_469616a334f866d76d69"
},
{
"$ref": "#/x-devx-bundled/ref_462955d95507e451c10a"
},
{
"$ref": "#/x-devx-bundled/ref_5ea9b5245b40a95eeedc"
},
{
"$ref": "#/x-devx-bundled/ref_c14cdf72d460735f556a"
},
{
"$ref": "#/x-devx-bundled/ref_7972062fc6cd36ac2403"
},
{
"$ref": "#/x-devx-bundled/ref_c38156a5dcc3d94377dd"
},
{
"$ref": "#/x-devx-bundled/ref_9c408ea9145a23c7cbb5"
},
{
"$ref": "#/x-devx-bundled/ref_c1027736facd2c2a7c95"
},
{
"$ref": "#/x-devx-bundled/ref_f0ab6d6e61cc49ba06f0"
},
{
"$ref": "#/x-devx-bundled/ref_cbd9e2b982aae4d5cfe2"
},
{
"$ref": "#/x-devx-bundled/ref_79086ca6df742d8600e5"
},
{
"$ref": "#/x-devx-bundled/ref_a277ab132bf37a57216a"
},
{
"$ref": "#/x-devx-bundled/ref_eb4bec06b486e2ceb76c"
},
{
"$ref": "#/x-devx-bundled/ref_e258178e3e59c83f2c9a"
},
{
"$ref": "#/x-devx-bundled/ref_59a42c003a97fcdab712"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"noActivity": {
"$ref": "#/x-devx-bundled/ref_7ad5ac1e2a5096a96273"
},
"paginatedResults": {
"$ref": "#/x-devx-bundled/ref_c98fc2a997d2d5b4667f"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_a8ae0075bcc4b67292b5"
}
}
},
"description": "Successful request. Returns a list of payments."
},
"400": {
"$ref": "#/x-devx-bundled/ref_ae89d3d539618a89d2dd"
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"403": {
"$ref": "#/x-devx-bundled/ref_e17edbd5866b60d4beb9"
},
"406": {
"$ref": "#/x-devx-bundled/ref_c791fb405083799347c1"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "List payments",
"tags": [
"Payments"
]
},
"post": {
"description": "Use this method to run a sale or a pre-authorization with a customer's payment card. \n\nIn the response, our gateway returns information about the card payment and a paymentId, which you need for the following methods:\n\n-\t[Retrieve payment](https://docs.payroc.com/api/schema/card-payments/payments/retrieve) - View the details of the card payment.\n-\t[Adjust payment](https://docs.payroc.com/api/schema/card-payments/payments/adjust) - Update the details of the card payment.\n-\t[Capture payment](https://docs.payroc.com/api/schema/card-payments/payments/capture) - Capture the pre-authorization.\n-\t[Reverse payment](https://docs.payroc.com/api/schema/card-payments/refunds/reverse) - Cancel the card payment if it's in an open batch.\n-\t[Refund payment](https://docs.payroc.com/api/schema/card-payments/refunds/create-referenced-refund) - Run a referenced refund to return funds to the payment card.\n\n**Payment methods** \n\n- **Cards** - Credit, debit, and EBT\n- **Digital wallets** - [Apple Pay®](https://docs.payroc.com/guides/take-payments/apple-pay) and [Google Pay®](https://docs.payroc.com/guides/take-payments/google-pay) \n- **Tokens** - Secure tokens and single-use tokens\n\n**Features** \n\nOur Create Payment method also supports the following features: \n\n- [Repeat payments](https://docs.payroc.com/guides/take-payments/repeat-payments/use-your-own-software) - Run multiple payments as part of a payment schedule that you manage with your own software. \n- **Offline sales** - Run a sale or a pre-authorization if the terminal loses its connection to our gateway. \n- [Tokenization](https://docs.payroc.com/guides/take-payments/save-payment-details) - Save card details to use in future transactions. \n- [3-D Secure](https://docs.payroc.com/guides/take-payments/3-d-secure) - Verify the identity of the cardholder. \n- [Custom fields](https://docs.payroc.com/guides/take-payments/add-custom-fields) - Add your own data to a payment. \n- **Tips** - Add tips to the card payment. \n- **Taxes** - Add local taxes to the card payment. \n- **Surcharging** - Add a surcharge to the card payment. \n- **Dual pricing** - Offer different prices based on payment method, for example, if you use our RewardPay Choice pricing program. \n- **Healthcare** - Accept payments from Health Savings Accounts (HSA) and Flexible Spending Accounts (FSA). \n",
"operationId": "payment",
"parameters": [
{
"$ref": "#/x-devx-bundled/ref_b92d206f2e50ffc4c068"
}
],
"requestBody": {
"content": {
"application/json": {
"examples": {
"createPaymentApplePayRequest": {
"$ref": "#/x-devx-bundled/ref_369a25ddd2da2be81ec6"
},
"createPaymentCardRequest": {
"$ref": "#/x-devx-bundled/ref_0ff6e6363362a158bcfc"
},
"createPaymentPreAuthorizationRequest": {
"$ref": "#/x-devx-bundled/ref_24a38a2bbccf921f1090"
},
"secureTokenRepeatPaymentRequest": {
"$ref": "#/x-devx-bundled/ref_6db5fbe977e5d9f1070e"
},
"singleUseTokenSaleRequest": {
"$ref": "#/x-devx-bundled/ref_a5e56f21e2529bc7d22a"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_01a894a1ad862c50b69d"
}
}
},
"required": true
},
"responses": {
"201": {
"content": {
"application/json": {
"examples": {
"createPaymentApplePayResponse": {
"$ref": "#/x-devx-bundled/ref_14fab24aef7cf31d79a1"
},
"createPaymentPreAuthorizationResponse": {
"$ref": "#/x-devx-bundled/ref_a8c42d7993030cdfd2f1"
},
"createdPayment": {
"$ref": "#/x-devx-bundled/ref_bc5449817f6e001fe0c5"
},
"secureTokenRepeatPaymentResponse": {
"$ref": "#/x-devx-bundled/ref_0dc3afc11188caa4b25b"
},
"singleUseTokenSaleResponse": {
"$ref": "#/x-devx-bundled/ref_292e08bfbecddaecee9e"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_7037b7c3d717e0c53992"
}
}
},
"description": "Successful request. We processed the transaction.",
"headers": {
"location": {
"$ref": "#/x-devx-bundled/ref_7b13ec5af2d2b1d9f8e7"
}
}
},
"400": {
"content": {
"application/problem+json": {
"examples": {
"idempotentKeyInUse": {
"$ref": "#/x-devx-bundled/ref_3917c6024cc650b3ea83"
},
"idempotentKeyMissing": {
"$ref": "#/x-devx-bundled/ref_d9867eacc8169139adec"
},
"validationError": {
"$ref": "#/x-devx-bundled/ref_2b3621a1c5ae119c6693"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_9477586d4a50bb60f5a4"
}
}
},
"description": "Validation error"
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"403": {
"$ref": "#/x-devx-bundled/ref_e17edbd5866b60d4beb9"
},
"406": {
"$ref": "#/x-devx-bundled/ref_c791fb405083799347c1"
},
"409": {
"$ref": "#/x-devx-bundled/ref_33a47f40f610a3ad4109"
},
"415": {
"$ref": "#/x-devx-bundled/ref_40869c40b438e4591cbc"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "Create payment",
"tags": [
"Payments"
]
}
},
"/payments/{paymentId}": {
"get": {
"description": "Use this method to retrieve information about a card payment. \n\nTo retrieve a payment, you need its paymentId. Our gateway returned the paymentId in the response of the [Create Payment](https://docs.payroc.com/api/schema/card-payments/payments/create) method. \n\n**Note:** If you don't have the paymentId, use our [List Payments](https://docs.payroc.com/api/schema/card-payments/payments/list) method to search for the payment. \n\nOur gateway returns the following information about the payment: \n\n- Order details, including the transaction amount and when it was processed. \n- Payment card details, including the masked card number, expiry date, and payment method. \n- Cardholder details, including their contact information and shipping address. \n- Payment details, including the payment type, status, and response. \n\nIf the merchant saved the customer's card details, our gateway returns a secureTokenID, which you can use to perform follow-on actions. \n",
"operationId": "getPayment",
"parameters": [
{
"$ref": "#/x-devx-bundled/ref_0b0239b0eccb01bab7f7"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"createdPayment": {
"$ref": "#/x-devx-bundled/ref_93ecbac866b583bd60a3"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_9939e4d9d5c3293a1455"
}
}
},
"description": "Successful request. Returns the payment."
},
"400": {
"$ref": "#/x-devx-bundled/ref_ae89d3d539618a89d2dd"
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"403": {
"$ref": "#/x-devx-bundled/ref_e17edbd5866b60d4beb9"
},
"404": {
"$ref": "#/x-devx-bundled/ref_49bf9231904bbd9aa1c0"
},
"406": {
"$ref": "#/x-devx-bundled/ref_c791fb405083799347c1"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "Retrieve payment",
"tags": [
"Payments"
]
}
},
"/payments/{paymentId}/adjust": {
"post": {
"description": "Use this method to adjust a payment in an open batch. \n\nTo adjust a payment, you need its paymentId. Our gateway returned the paymentId in the response of the [Create Payment](https://docs.payroc.com/api/schema/card-payments/payments/create) method.\n\n**Note:** If you don't have the paymentId, use our [List Payments](https://docs.payroc.com/api/schema/card-payments/payments/list) method to search for the payment. \n\nYou can adjust the following details of the payment:\n- Sale amount and tip amount\n- Payment status\n- Cardholder shipping address and contact information\n- Cardholder signature data\n\nOur gateway returns information about the adjusted payment, including information about the payment card and the cardholder.\n",
"operationId": "adjustPayment",
"parameters": [
{
"$ref": "#/x-devx-bundled/ref_b92d206f2e50ffc4c068"
},
{
"$ref": "#/x-devx-bundled/ref_0b0239b0eccb01bab7f7"
}
],
"requestBody": {
"content": {
"application/json": {
"examples": {
"adjustPaymentPreAuthorizationRequest": {
"$ref": "#/x-devx-bundled/ref_ef2d0bbf2b4dd8888832"
},
"adjustPaymentRequest": {
"$ref": "#/x-devx-bundled/ref_d6bcaa20c2875a8f1079"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_c49d710e5998a3f0ac5f"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"adjustPaymentPreAuthorizationResponse": {
"$ref": "#/x-devx-bundled/ref_994ae86a6e6e6d25cca7"
},
"adjustPaymentResponse": {
"$ref": "#/x-devx-bundled/ref_7c70e6f6af9f83a14992"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_7037b7c3d717e0c53992"
}
}
},
"description": "Successful request. We adjusted the transaction."
},
"400": {
"content": {
"application/problem+json": {
"examples": {
"idempotentKeyInUse": {
"$ref": "#/x-devx-bundled/ref_3917c6024cc650b3ea83"
},
"idempotentKeyMissing": {
"$ref": "#/x-devx-bundled/ref_d9867eacc8169139adec"
},
"validationError": {
"$ref": "#/x-devx-bundled/ref_2b3621a1c5ae119c6693"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_9477586d4a50bb60f5a4"
}
}
},
"description": "Validation error"
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"403": {
"$ref": "#/x-devx-bundled/ref_e17edbd5866b60d4beb9"
},
"404": {
"$ref": "#/x-devx-bundled/ref_49bf9231904bbd9aa1c0"
},
"406": {
"$ref": "#/x-devx-bundled/ref_c791fb405083799347c1"
},
"409": {
"$ref": "#/x-devx-bundled/ref_33a47f40f610a3ad4109"
},
"415": {
"$ref": "#/x-devx-bundled/ref_40869c40b438e4591cbc"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "Adjust payment",
"tags": [
"Payments"
]
}
},
"/payments/{paymentId}/capture": {
"post": {
"description": "Use this method to capture a pre-authorization. \n\nTo capture a pre-authorization, you need its paymentId. Our gateway returned the paymentId in the response of the [Create Payment](https://docs.payroc.com/api/schema/card-payments/payments/create) method.\n\n**Note:** If you don't have the paymentId, use our [List Payments](https://docs.payroc.com/api/schema/card-payments/payments/list) method to search for the payment.\n\nDepending on the amount you want to capture, complete the following:\n-\t**Capture the full amount of the pre-authorization** - Don't send a value for the amount parameter in your request.\n-\t**Capture less than the amount of the pre-authorization** - Send a value for the amount parameter in your request. \n-\t**Capture more than the amount of the pre-authorization** - Adjust the pre-authorization before you capture it. For more information about adjusting a pre-authorization, go to [Adjust Payment](https://docs.payroc.com/api/schema/card-payments/payments/adjust).\n\nIf your request is successful, our gateway takes the amount from the payment card. \n\n**Note:** For more information about pre-authorizations and captures, go to [Run a pre-authorization](https://docs.payroc.com/guides/integrate/run-a-pre-authorization).\n",
"operationId": "capturePayment",
"parameters": [
{
"$ref": "#/x-devx-bundled/ref_b92d206f2e50ffc4c068"
},
{
"$ref": "#/x-devx-bundled/ref_0b0239b0eccb01bab7f7"
}
],
"requestBody": {
"content": {
"application/json": {
"examples": {
"capturePreAuthorization": {
"$ref": "#/x-devx-bundled/ref_faa337c615389cdead2b"
},
"paymentCapture": {
"$ref": "#/x-devx-bundled/ref_dd10526e1c61ed520dcd"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_65dae029e49a7e458791"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"capturePreAuthorization": {
"$ref": "#/x-devx-bundled/ref_99e7d9ae8ed734f625cc"
},
"payment": {
"$ref": "#/x-devx-bundled/ref_522a943067adee09f936"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_7037b7c3d717e0c53992"
}
}
},
"description": "Successful request. We captured the payment."
},
"400": {
"content": {
"application/problem+json": {
"examples": {
"idempotentKeyInUse": {
"$ref": "#/x-devx-bundled/ref_3917c6024cc650b3ea83"
},
"idempotentKeyMissing": {
"$ref": "#/x-devx-bundled/ref_d9867eacc8169139adec"
},
"validationError": {
"$ref": "#/x-devx-bundled/ref_2b3621a1c5ae119c6693"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_9477586d4a50bb60f5a4"
}
}
},
"description": "Validation error"
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"403": {
"$ref": "#/x-devx-bundled/ref_e17edbd5866b60d4beb9"
},
"404": {
"$ref": "#/x-devx-bundled/ref_49bf9231904bbd9aa1c0"
},
"406": {
"$ref": "#/x-devx-bundled/ref_c791fb405083799347c1"
},
"409": {
"$ref": "#/x-devx-bundled/ref_33a47f40f610a3ad4109"
},
"415": {
"$ref": "#/x-devx-bundled/ref_40869c40b438e4591cbc"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "Capture payment",
"tags": [
"Payments"
]
}
},
"/payments/{paymentId}/refund": {
"post": {
"description": "Use this method to refund a payment that is in a closed batch. \n\nTo refund a payment, you need its paymentId. Our gateway returned the paymentId in the response of the [Create Payment](https://docs.payroc.com/api/schema/card-payments/payments/create) method. \n\n**Note:** If you don't have the paymentId, use our [List Payments](https://docs.payroc.com/api/schema/card-payments/payments/list) method to search for the payment. \n\nIf your refund is successful, our gateway returns the payment amount to the cardholder's account. \n\n**Things to consider** \n\n- If the merchant refunds a payment that is in an open batch, our gateway reverses the payment.\n- Some merchants can run unreferenced refunds, which means that they don't need a paymentId to return an amount to a customer. For more information about how to run an unreferenced refund, go to [Create Refund](https://docs.payroc.com/api/schema/card-payments/refunds/create-unreferenced-refund).\n",
"operationId": "refundPayment",
"parameters": [
{
"$ref": "#/x-devx-bundled/ref_b92d206f2e50ffc4c068"
},
{
"$ref": "#/x-devx-bundled/ref_0b0239b0eccb01bab7f7"
}
],
"requestBody": {
"content": {
"application/json": {
"examples": {
"createReferencedRefundRequest": {
"$ref": "#/x-devx-bundled/ref_5055b13d53a7203177a7"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_618d306001605c811547"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"refundPayment": {
"$ref": "#/x-devx-bundled/ref_5e268a344618d438f814"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_7037b7c3d717e0c53992"
}
}
},
"description": "Successful request. We refunded the payment."
},
"400": {
"content": {
"application/problem+json": {
"examples": {
"idempotentKeyInUse": {
"$ref": "#/x-devx-bundled/ref_3917c6024cc650b3ea83"
},
"idempotentKeyMissing": {
"$ref": "#/x-devx-bundled/ref_d9867eacc8169139adec"
},
"validationError": {
"$ref": "#/x-devx-bundled/ref_2b3621a1c5ae119c6693"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_9477586d4a50bb60f5a4"
}
}
},
"description": "Validation error"
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"403": {
"$ref": "#/x-devx-bundled/ref_e17edbd5866b60d4beb9"
},
"404": {
"$ref": "#/x-devx-bundled/ref_49bf9231904bbd9aa1c0"
},
"406": {
"$ref": "#/x-devx-bundled/ref_c791fb405083799347c1"
},
"409": {
"$ref": "#/x-devx-bundled/ref_33a47f40f610a3ad4109"
},
"415": {
"$ref": "#/x-devx-bundled/ref_40869c40b438e4591cbc"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "Create referenced refund",
"tags": [
"Payments"
]
}
},
"/payments/{paymentId}/reverse": {
"post": {
"description": "Use this method to cancel or to partially cancel a payment in an open batch. This is also known as voiding a payment. \n\nTo cancel a payment, you need its paymentId. Our gateway returned the paymentId in the response of the [Create Payment](https://docs.payroc.com/api/schema/card-payments/payments/create) method. \n\n**Note:** If you don't have the paymentId, use our [List Payments](https://docs.payroc.com/api/schema/card-payments/payments/list) method to search for the payment. \n\nIf your request is successful, our gateway removes the payment from the merchant's open batch and no funds are taken from the cardholder's account. \n",
"operationId": "reversePayment",
"parameters": [
{
"$ref": "#/x-devx-bundled/ref_b92d206f2e50ffc4c068"
},
{
"$ref": "#/x-devx-bundled/ref_0b0239b0eccb01bab7f7"
}
],
"requestBody": {
"content": {
"application/json": {
"examples": {
"reversalPayment": {
"$ref": "#/x-devx-bundled/ref_bd3a1e97c2759c4f8111"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_286c4ce529563a5dbc40"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"reversalPayment": {
"$ref": "#/x-devx-bundled/ref_e34ba36a4bdd6667f439"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_7037b7c3d717e0c53992"
}
}
},
"description": "Successful request. We reversed the payment."
},
"400": {
"content": {
"application/problem+json": {
"examples": {
"idempotentKeyInUse": {
"$ref": "#/x-devx-bundled/ref_3917c6024cc650b3ea83"
},
"idempotentKeyMissing": {
"$ref": "#/x-devx-bundled/ref_d9867eacc8169139adec"
},
"validationError": {
"$ref": "#/x-devx-bundled/ref_2b3621a1c5ae119c6693"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_9477586d4a50bb60f5a4"
}
}
},
"description": "Validation error"
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"403": {
"$ref": "#/x-devx-bundled/ref_e17edbd5866b60d4beb9"
},
"404": {
"$ref": "#/x-devx-bundled/ref_49bf9231904bbd9aa1c0"
},
"406": {
"$ref": "#/x-devx-bundled/ref_c791fb405083799347c1"
},
"409": {
"$ref": "#/x-devx-bundled/ref_33a47f40f610a3ad4109"
},
"415": {
"$ref": "#/x-devx-bundled/ref_40869c40b438e4591cbc"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "Reverse payment",
"tags": [
"Payments"
]
}
},
"/pricing-intents": {
"get": {
"description": "Use this method to return a [paginated](https://docs.payroc.com/api/pagination) list of pricing intents associated with the ISV. \n\n**Note:** If you want to view the details of a specific pricing intent and you have its pricingIntentId, use our [Retrieve Pricing Intent](https://docs.payroc.com/api/schema/boarding/pricing-intents/retrieve) method. \n\nOur gateway returns the following information about each pricing intent in the list: \n\n- Information about the fees, including the base fees, gateway fees, and processor fees. \n- Status of the pricing intent, including whether we approved the pricing intent. \n\nFor each pricing intent, we also return its pricingIntentId which you can use to perform follow-on actions. \n",
"operationId": "listPricingIntents",
"parameters": [
{
"$ref": "#/x-devx-bundled/ref_eb4bec06b486e2ceb76c"
},
{
"$ref": "#/x-devx-bundled/ref_e258178e3e59c83f2c9a"
},
{
"$ref": "#/x-devx-bundled/ref_59a42c003a97fcdab712"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"noActivity": {
"$ref": "#/x-devx-bundled/ref_7ad5ac1e2a5096a96273"
},
"paginatedResults": {
"$ref": "#/x-devx-bundled/ref_af4c19209ffc646d3ee0"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_a1171e1612477c2e8ea7"
}
}
},
"description": "Successful response. Returns a list of pricing intents."
},
"400": {
"$ref": "#/x-devx-bundled/ref_ae89d3d539618a89d2dd"
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"403": {
"$ref": "#/x-devx-bundled/ref_e17edbd5866b60d4beb9"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "List pricing intents",
"tags": [
"Pricing intents"
]
},
"post": {
"description": "Use this method to create a pricing intent that you can assign to a processing account. \n\nIn the request, you must provide the following:\n-\tProcessing fees, including the pricing program and the fee to process each transaction.\n-\tGateway fees, including the fee for each transaction handled by our gateway.\n-\tBase fees, including maintenance and PCI fees.\n\nIn the response, our gateway returns information about the pricing intent and the pricingIntentId, which you need for the following methods:\n-\t[Create Merchant Platform](https://docs.payroc.com/api/schema/boarding/merchant-platforms/create) - Assign the pricing intent to a processing account, when you create the merchant platform and its processing accounts.\n-\t[Create Processing Account](https://docs.payroc.com/api/schema/boarding/merchant-platforms/create-processing-account) - Assign the pricing intent to a processing account.\n-\t[Retrieve Pricing Intent](https://docs.payroc.com/api/schema/boarding/pricing-intents/retrieve) - Retrieve information about a pricing intent.\n-\t[Update Pricing Intent](https://docs.payroc.com/api/schema/boarding/pricing-intents/update) - Update the details of a pricing intent. \n-\t[Delete Pricing Intent](https://docs.payroc.com/api/schema/boarding/pricing-intents/delete) - Delete a pricing intent.\n-\t[Partially Update Pricing Intent](https://docs.payroc.com/api/schema/boarding/pricing-intents/partially-update) - Partially update the details of a pricing intent.\n",
"operationId": "createPricingIntent",
"parameters": [
{
"$ref": "#/x-devx-bundled/ref_b92d206f2e50ffc4c068"
}
],
"requestBody": {
"content": {
"application/json": {
"examples": {
"createPricingIntentConsumerChoiceRequest": {
"$ref": "#/x-devx-bundled/ref_a12134c49289ff848c94"
},
"createPricingIntentFlatRateRequest": {
"$ref": "#/x-devx-bundled/ref_6f0582c73052d88625d6"
},
"createPricingIntentInterchangePlusRequest": {
"$ref": "#/x-devx-bundled/ref_ab2d4f80b9ccfeea47e7"
},
"createPricingIntentRewardPayChoiceRequest": {
"$ref": "#/x-devx-bundled/ref_b891b8ba48185cd163b9"
},
"createPricingIntentTiered3Request": {
"$ref": "#/x-devx-bundled/ref_9f1e1ce656a540c2f16f"
},
"createPricingIntentTiered4Request": {
"$ref": "#/x-devx-bundled/ref_bcdfbf44b6681305ed2e"
},
"createPricingIntentTiered6Request": {
"$ref": "#/x-devx-bundled/ref_0064ca7c922c5bfd664c"
},
"interchangePlusTiered3": {
"$ref": "#/x-devx-bundled/ref_45e14bbffce42c49117b"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_e112f6279759eeb46e44"
}
}
}
},
"responses": {
"201": {
"content": {
"application/json": {
"examples": {
"createPricingIntentResponse": {
"$ref": "#/x-devx-bundled/ref_616651e4cab06fc31947"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_e112f6279759eeb46e44"
}
}
},
"description": "Successful response. We created the pricing intent and it is waiting for approval.",
"headers": {
"location": {
"$ref": "#/x-devx-bundled/ref_7b13ec5af2d2b1d9f8e7"
}
}
},
"400": {
"content": {
"application/problem+json": {
"examples": {
"idempotentKeyMissing": {
"$ref": "#/x-devx-bundled/ref_d9867eacc8169139adec"
},
"validationError": {
"$ref": "#/x-devx-bundled/ref_2b3621a1c5ae119c6693"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_9477586d4a50bb60f5a4"
}
}
},
"description": "Validation error"
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"403": {
"$ref": "#/x-devx-bundled/ref_e17edbd5866b60d4beb9"
},
"406": {
"$ref": "#/x-devx-bundled/ref_c791fb405083799347c1"
},
"409": {
"content": {
"application/problem+json": {
"examples": {
"idempotentKeyInUse": {
"$ref": "#/x-devx-bundled/ref_3917c6024cc650b3ea83"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_478798693738e1bfadb1"
}
}
},
"description": "Conflict"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "Create pricing intent",
"tags": [
"Pricing intents"
]
},
"summary": "Provides capabilities to list and create pricing intents."
},
"/pricing-intents/{pricingIntentId}": {
"delete": {
"description": "Use this method to delete a pricing intent. \n\n> **Important:** When you delete a pricing intent, you can't recover it. You also won't be able to assign the pricing intent to a merchant's boarding application. \n\nTo delete a pricing intent, you need its pricingIntentId. Our gateway returned the pricingIntentId in the response of the [Create Pricing Intent](https://docs.payroc.com/api/schema/boarding/pricing-intents/create) method. \n\n**Note:** If you don't have the pricingIntentId, use our [List Pricing Intents](https://docs.payroc.com/api/schema/boarding/pricing-intents/list) method to search for the pricing intent.\n",
"operationId": "deletePricingIntent",
"responses": {
"204": {
"description": "Successful request. We deleted the pricing intent."
},
"400": {
"$ref": "#/x-devx-bundled/ref_ae89d3d539618a89d2dd"
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"403": {
"$ref": "#/x-devx-bundled/ref_e17edbd5866b60d4beb9"
},
"404": {
"$ref": "#/x-devx-bundled/ref_49bf9231904bbd9aa1c0"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "Delete pricing intent",
"tags": [
"Pricing intents"
]
},
"get": {
"description": "Use this method to retrieve information about a pricing intent. \n\nTo retrieve a pricing intent, you need its pricingIntentId. Our gateway returned the pricingIntentId in the response of the [Create Pricing Intent](https://docs.payroc.com/api/schema/boarding/pricing-intents/create) method. \n\n**Note:** If you don't have the pricingIntentId, use our [List Pricing Intents](https://docs.payroc.com/api/schema/boarding/pricing-intents/list) method to search for the pricing intent. \n\nOur gateway returns the following information about the pricing intent: \n\n- Information about the fees, including the base fees, gateway fees, and processor fees. \n- Status of the pricing intent, including whether we approved the pricing intent. \n",
"operationId": "getPricingIntent",
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"retrievePricingIntentResponse": {
"$ref": "#/x-devx-bundled/ref_671d522a51c56d5d73b9"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_ed5b576489ee24a9c772"
}
}
},
"description": "Successful response. Returns the requested pricing intent."
},
"400": {
"$ref": "#/x-devx-bundled/ref_ae89d3d539618a89d2dd"
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"403": {
"$ref": "#/x-devx-bundled/ref_e17edbd5866b60d4beb9"
},
"404": {
"$ref": "#/x-devx-bundled/ref_49bf9231904bbd9aa1c0"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "Retrieve pricing intent",
"tags": [
"Pricing intents"
]
},
"parameters": [
{
"$ref": "#/x-devx-bundled/ref_1046806ef63d4413b658"
}
],
"patch": {
"description": "Use this method to partially update a pricing intent. Structure your request to follow the [RFC 6902](https://datatracker.ietf.org/doc/html/rfc6902) standard. \n\nIf you update a pricing intent, it won't affect merchants you've previously onboarded. \n\nTo update a pricing intent, you need its pricingIntentId. Our gateway returned the pricingIntentId in the response of the [Create Pricing Intent](https://docs.payroc.com/api/schema/boarding/pricing-intents/create) method. \n\n**Note:** If you don't have the pricingIntentId, use our [List Pricing Intents](https://docs.payroc.com/api/schema/boarding/pricing-intents/list) method to search for the pricing intent. \n\nYou can update the following details about a pricing intent: \n\n- Fees, including the base fees, processor fees, and gateway fees. \n- Custom name for the pricing intent. \n- Additional services that merchants can sign up for. \n",
"operationId": "patchPricingIntent",
"parameters": [
{
"$ref": "#/x-devx-bundled/ref_b92d206f2e50ffc4c068"
}
],
"requestBody": {
"content": {
"application/json": {
"examples": {
"partiallyUpdatePricingIntentAddRequest": {
"$ref": "#/x-devx-bundled/ref_3bcfe805ef24017c999a"
},
"partiallyUpdatePricingIntentCopyRequest": {
"$ref": "#/x-devx-bundled/ref_a4703b740ae138d5b46b"
},
"partiallyUpdatePricingIntentMoveRequest": {
"$ref": "#/x-devx-bundled/ref_9eba136cf19525a5d7a6"
},
"partiallyUpdatePricingIntentRealisticRequest": {
"$ref": "#/x-devx-bundled/ref_64549aab9b1ce6e9af13"
},
"partiallyUpdatePricingIntentRemoveRequest": {
"$ref": "#/x-devx-bundled/ref_6ec7b620681ea282f7ed"
},
"partiallyUpdatePricingIntentReplaceRequest": {
"$ref": "#/x-devx-bundled/ref_3fa9fb9b9104e878045a"
},
"partiallyUpdatePricingIntentTestRequest": {
"$ref": "#/x-devx-bundled/ref_4815ca9859cd3076cb7c"
},
"patchOperations": {
"$ref": "#/x-devx-bundled/ref_76695c1b0a3debe0d3fd"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_83c73ee340defd8c776d"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"partiallyUpdatePricingIntentResponse": {
"$ref": "#/x-devx-bundled/ref_c35ba0e64f1d0adaba7e"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_e112f6279759eeb46e44"
}
}
},
"description": "Successful request. We updated the pricing intent."
},
"400": {
"content": {
"application/problem+json": {
"examples": {
"idempotentKeyMissing": {
"$ref": "#/x-devx-bundled/ref_d9867eacc8169139adec"
},
"validationError": {
"$ref": "#/x-devx-bundled/ref_2b3621a1c5ae119c6693"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_9477586d4a50bb60f5a4"
}
}
},
"description": "Validation error"
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"403": {
"$ref": "#/x-devx-bundled/ref_e17edbd5866b60d4beb9"
},
"404": {
"$ref": "#/x-devx-bundled/ref_49bf9231904bbd9aa1c0"
},
"406": {
"$ref": "#/x-devx-bundled/ref_c791fb405083799347c1"
},
"409": {
"content": {
"application/problem+json": {
"examples": {
"idempotentKeyInUse": {
"$ref": "#/x-devx-bundled/ref_3917c6024cc650b3ea83"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_478798693738e1bfadb1"
}
}
},
"description": "Conflict"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "Partially update pricing intent",
"tags": [
"Pricing intents"
]
},
"put": {
"description": "Use this method to update the details of a pricing intent. If you update a pricing intent, it won't affect merchant that you've previously onboarded. \n\nTo update a pricing intent, you need its pricingIntentId. Our gateway returned the pricingIntentId in the response of the [Create Pricing Intent](https://docs.payroc.com/api/schema/boarding/pricing-intents/create) method. \n\n**Note:** If you don't have the pricingIntentId, use our [List Pricing Intents](https://docs.payroc.com/api/schema/boarding/pricing-intents/list) method to search for the pricing intent. \n\nYou can update the following details about a pricing intent: \n\n- Fees, including the base fees, processor fees, and gateway fees. \n- Custom name for the pricing intent. \n- Additional services that merchants can sign up for. \n",
"operationId": "updatePricingIntent",
"requestBody": {
"content": {
"application/json": {
"examples": {
"pricingIntent": {
"$ref": "#/x-devx-bundled/ref_2b731996ac4e1475cf38"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_e112f6279759eeb46e44"
}
}
}
},
"responses": {
"204": {
"description": "Resource successfully updated"
},
"400": {
"$ref": "#/x-devx-bundled/ref_ae89d3d539618a89d2dd"
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"403": {
"$ref": "#/x-devx-bundled/ref_e17edbd5866b60d4beb9"
},
"404": {
"$ref": "#/x-devx-bundled/ref_49bf9231904bbd9aa1c0"
},
"406": {
"$ref": "#/x-devx-bundled/ref_c791fb405083799347c1"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "Update pricing intent",
"tags": [
"Pricing intents"
]
},
"summary": "Provides create/read/updated/delete capabilities for specific pricing intents"
},
"/processing-accounts/{processingAccountId}": {
"get": {
"description": "Use this method to retrieve information about a specific processing account. \n\nTo retrieve a processing account, you need its processingAccountId. Our gateway returned the processingAccountId in the response of the [Create Merchant Platform](https://docs.payroc.com/api/schema/boarding/merchant-platforms/create) method or the [Create Processing Account](https://docs.payroc.com/api/schema/boarding/merchant-platforms/create-processing-account) method. \n\n**Note:** If you don't have the processingAccountId, use our [List Merchant Platform's Processing Accounts](https://docs.payroc.com/api/schema/boarding/merchant-platforms/list-processing-accounts) method to search for the processing account. \n\nOur gateway returns the following information about the processing account: \n\n-\tBusiness information, including the Merchant Category Code (MCC), status of the processing account, and address of the business. \n-\tProcessing information, including the merchant’s refund policies and card types that the merchant accepts. \n-\tFunding information, including funding schedules, funding fees, and details for the merchant’s funding accounts. \n-\tPricing information, including [HATEOAS](https://docs.payroc.com/knowledge/basic-concepts/hypermedia-as-the-engine-of-application-state-hateoas) links to retrieve the pricing program for the processing account. \n",
"operationId": "getProcessingAccounts",
"parameters": [
{
"$ref": "#/x-devx-bundled/ref_04eec39981f6e77f8e6b"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"processingAccount": {
"$ref": "#/x-devx-bundled/ref_32b762f183bf0f0317c8"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_214544c04ba3708ed212"
}
}
},
"description": "Successful request. Returns the processing account."
},
"400": {
"$ref": "#/x-devx-bundled/ref_ae89d3d539618a89d2dd"
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"403": {
"$ref": "#/x-devx-bundled/ref_e17edbd5866b60d4beb9"
},
"404": {
"$ref": "#/x-devx-bundled/ref_49bf9231904bbd9aa1c0"
},
"406": {
"$ref": "#/x-devx-bundled/ref_c791fb405083799347c1"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "Retrieve processing account",
"tags": [
"Processing accounts"
]
}
},
"/processing-accounts/{processingAccountId}/attachments": {
"post": {
"description": "> Before you upload an attachment, make sure that you follow local privacy regulations and get the merchant's consent to process their information. \n\n**Note:** You need the ID of the processing account before you can upload an attachment. If you don't know the processingAccountId, go to the [Retrieve a Merchant Platform](https://docs.payroc.com/api/schema/boarding/merchant-platforms/retrieve) method. \n\nThe attachment must be an uncompressed file under 50MB in one of the following formats:\n- .bmp, csv, .doc, .docx, .gif, .htm, .html, .jpg, .jpeg, .msg, .pdf, .png, .ppt, .pptx, .tif, .tiff, .txt, .xls, .xlsx \n\nIn the request, include the attachment that you want to upload and the following information about the attachment:\n- **type** - Type of attachment that you want to upload.\n- **description** - Short description of the attachment. \n\nIn the response, our gateway returns information about the attachment including its upload status and an attachmentId that you can use to [Retrieve the details of the Attachment](https://docs.payroc.com/api/schema/attachments/retrieve).\n",
"operationId": "createProcessingAccountAttachment",
"parameters": [
{
"$ref": "#/x-devx-bundled/ref_b92d206f2e50ffc4c068"
},
{
"$ref": "#/x-devx-bundled/ref_04eec39981f6e77f8e6b"
}
],
"requestBody": {
"content": {
"multipart/form-data": {
"examples": {
"uploadAttachmentToProcessingAccountRequest": {
"$ref": "#/x-devx-bundled/ref_f2a33074005524a7a836"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_92ff5c2bd438d0e2fcd1"
}
}
},
"required": true
},
"responses": {
"201": {
"content": {
"application/json": {
"examples": {
"uploadAttachmentToProcessingAccountResponse": {
"$ref": "#/x-devx-bundled/ref_c9a0fa68acaddaeb81ec"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_6e5f6c82188ec67f61c8"
}
}
},
"description": "Successful request. We received the attachment.",
"headers": {
"location": {
"$ref": "#/x-devx-bundled/ref_7b13ec5af2d2b1d9f8e7"
}
}
},
"400": {
"content": {
"application/problem+json": {
"examples": {
"idempotentKeyInUse": {
"$ref": "#/x-devx-bundled/ref_3917c6024cc650b3ea83"
},
"idempotentKeyMissing": {
"$ref": "#/x-devx-bundled/ref_d9867eacc8169139adec"
},
"validationError": {
"$ref": "#/x-devx-bundled/ref_2b3621a1c5ae119c6693"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_9477586d4a50bb60f5a4"
}
}
},
"description": "Validation error"
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"403": {
"$ref": "#/x-devx-bundled/ref_e17edbd5866b60d4beb9"
},
"404": {
"$ref": "#/x-devx-bundled/ref_49bf9231904bbd9aa1c0"
},
"406": {
"$ref": "#/x-devx-bundled/ref_c791fb405083799347c1"
},
"409": {
"$ref": "#/x-devx-bundled/ref_33a47f40f610a3ad4109"
},
"413": {
"$ref": "#/x-devx-bundled/ref_2d8cb91e6a2384abffc7"
},
"415": {
"$ref": "#/x-devx-bundled/ref_40869c40b438e4591cbc"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "Upload attachment to processing account",
"tags": [
"Processing accounts"
]
}
},
"/processing-accounts/{processingAccountId}/contacts": {
"get": {
"description": "Use this method to return a list of contacts for a processing account. \n\n**Note:** If you want to view the details of a specific contact and you have their contactId, use our [Retrieve Contact](https://docs.payroc.com/api/schema/boarding/contacts/retrieve) method. \n\nTo list contacts for a processing account, you need the processingAccountId. Our gateway returned the processingAccountId in the response of the [Create Merchant Platform](https://docs.payroc.com/api/schema/boarding/merchant-platforms/create) method or the [Create Processing Account](https://docs.payroc.com/api/schema/boarding/merchant-platforms/create-processing-account) method. \n\nOur gateway returns the following information about each contact: \n\n- Name and contact method, including their phone number or mobile number. \n- Role within the business, for example, if they are a manager. \n\nFor each contact, we also return a contactId, which you can use to perform follow-on actions. \n",
"operationId": "listProcessingAccountContacts",
"parameters": [
{
"$ref": "#/x-devx-bundled/ref_04eec39981f6e77f8e6b"
},
{
"$ref": "#/x-devx-bundled/ref_eb4bec06b486e2ceb76c"
},
{
"$ref": "#/x-devx-bundled/ref_e258178e3e59c83f2c9a"
},
{
"$ref": "#/x-devx-bundled/ref_59a42c003a97fcdab712"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"noActivity": {
"$ref": "#/x-devx-bundled/ref_7ad5ac1e2a5096a96273"
},
"paginatedContacts": {
"$ref": "#/x-devx-bundled/ref_62daed56a1e56021e904"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_0f05902499b8df71219f"
}
}
},
"description": "Successful request. Returns a list of contacts associated with the processing account."
},
"400": {
"$ref": "#/x-devx-bundled/ref_ae89d3d539618a89d2dd"
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"403": {
"$ref": "#/x-devx-bundled/ref_e17edbd5866b60d4beb9"
},
"404": {
"$ref": "#/x-devx-bundled/ref_49bf9231904bbd9aa1c0"
},
"406": {
"$ref": "#/x-devx-bundled/ref_c791fb405083799347c1"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "List contacts",
"tags": [
"Processing accounts"
]
}
},
"/processing-accounts/{processingAccountId}/funding-accounts": {
"get": {
"description": "Use this method to return a list of funding accounts linked to a processing acccount. \n\nTo retrieve a list of funding accounts for a processing account, you need the processingAccountId. Our gateway returned the processingAccountId in the response of the [Create Merchant Platform](https://docs.payroc.com/api/schema/boarding/merchant-platforms/create) method or the [Create Proccessing Account](https://docs.payroc.com/api/schema/boarding/merchant-platforms/create-processing-account) method. \n\nOur gateway returns information about the following for each funding account in the list: \n- Account information, including the name on the account and payment methods. \n- Status, including whether we have approved or rejected the account. \n\nFor each funding account, we also return its fundingAccountId, which you can use to perform follow-on actions. \n",
"operationId": "listProcessingAccountsFundingAccounts",
"parameters": [
{
"$ref": "#/x-devx-bundled/ref_04eec39981f6e77f8e6b"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"fundingAccounts": {
"$ref": "#/x-devx-bundled/ref_10d667ba338f4f03a5cd"
}
},
"schema": {
"description": "Array of funding account objects for the processing account. Each processing account must have: \n\n- One funding account that accepts both credits to the account and debits from the account. \n\nOR \n\n- Two funding accounts - one for credits to the account, and another account for debits from the account. \n",
"items": {
"$ref": "#/x-devx-bundled/ref_9a102086f05b94adac7a"
},
"type": "array"
}
}
},
"description": "Successful request. Returns a list of funding accounts associated with the processing account."
},
"400": {
"$ref": "#/x-devx-bundled/ref_ae89d3d539618a89d2dd"
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"403": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"404": {
"$ref": "#/x-devx-bundled/ref_49bf9231904bbd9aa1c0"
},
"406": {
"$ref": "#/x-devx-bundled/ref_c791fb405083799347c1"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "List processing account's funding accounts",
"tags": [
"Processing accounts"
]
}
},
"/processing-accounts/{processingAccountId}/owners": {
"get": {
"description": "Use this method to return a list of owners of a processing account. \n\n**Note:** If you want to view the details of a specific owner and you have the ownerId, go to our [Retrieve Owner](https://docs.payroc.com/api/schema/boarding/owners/retrieve) method. \n\nTo list the owners of a processing account, you need its processingAccountId. If you don't have the processingAccountId, use our [List Merchant Platform's Processing Accounts](https://docs.payroc.com/api/schema/boarding/merchant-platforms/list-processing-accounts) method to search for the processing account. \n\nOur gateway returns the following information about each owner in the list: \n\n- Name, date of birth, and address. \n- Contact details, including their email address. \n- Relationship to the business, including whether they are a control prong or authorized signatory, and their equity stake in the business. \n",
"operationId": "listMerchantOwners",
"parameters": [
{
"$ref": "#/x-devx-bundled/ref_04eec39981f6e77f8e6b"
},
{
"$ref": "#/x-devx-bundled/ref_eb4bec06b486e2ceb76c"
},
{
"$ref": "#/x-devx-bundled/ref_e258178e3e59c83f2c9a"
},
{
"$ref": "#/x-devx-bundled/ref_59a42c003a97fcdab712"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"listOwnersResponse": {
"$ref": "#/x-devx-bundled/ref_52be224302e47215ddfc"
},
"noActivity": {
"$ref": "#/x-devx-bundled/ref_7ad5ac1e2a5096a96273"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_fe8bb1cf77667d3bf0ca"
}
}
},
"description": "Successful request. Returns a list of owners associated with the processing account."
},
"400": {
"$ref": "#/x-devx-bundled/ref_ae89d3d539618a89d2dd"
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"404": {
"$ref": "#/x-devx-bundled/ref_49bf9231904bbd9aa1c0"
},
"406": {
"$ref": "#/x-devx-bundled/ref_c791fb405083799347c1"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "List owners",
"tags": [
"Processing accounts"
]
}
},
"/processing-accounts/{processingAccountId}/pricing": {
"get": {
"description": "Use this method to retrieve the pricing agreement that we apply to a processing account. \n\nTo retrieve the pricing agreement of a processing account, you need the processingAccountId. Our gateway returned the processingAccountId in the response to the [Create Merchant Platform](https://docs.payroc.com/api/schema/boarding/merchant-platforms/create) method and [Create Processing Account](https://docs.payroc.com/api/schema/boarding/merchant-platforms/create-processing-account) method. \n\n**Note:** If you don't have the processingAccountId, use our [List Merchant Platform’s Processing Accounts](https://docs.payroc.com/api/schema/boarding/merchant-platforms/list-processing-accounts) method to search for the processing account. \n\nOur gateway returns the following information about the pricing agreement that we apply to the processing account: \n\n- Base fees, including the annual fee and the fees for each chargeback and retrieval. \n- Processor fees, including the fees that we apply for processing card and ACH payments. \n- Gateway fees, including the setup fee and the fees for each transaction. \n- Service fees, including the fee that we apply if the merchant has signed up to a Hardware Advantage Plan. \n",
"operationId": "retrieveProcessingAccountPricing",
"parameters": [
{
"$ref": "#/x-devx-bundled/ref_04eec39981f6e77f8e6b"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"paginatedContacts": {
"$ref": "#/x-devx-bundled/ref_99e60c4d17bea0756274"
}
},
"schema": {
"oneOf": [
{
"$ref": "#/x-devx-bundled/ref_4dd0a7bded1cced57558"
},
{
"$ref": "#/x-devx-bundled/ref_a655a7bef3118e3aec71"
},
{
"$ref": "#/x-devx-bundled/ref_2334f7c0d1cd64614f53"
}
]
}
}
},
"description": "Successful request. We return a polymorphic object that contains the pricing agreement for the processing account. \n\nThe value of the version field determines which variant you should use:\n-\t`4.0` - Pricing agreement version 4.\n-\t`5.0` - Pricing agreement version 5.\n-\t`5.2` - Pricing agreement version 5.2.\n"
},
"400": {
"$ref": "#/x-devx-bundled/ref_ae89d3d539618a89d2dd"
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"403": {
"$ref": "#/x-devx-bundled/ref_e17edbd5866b60d4beb9"
},
"404": {
"$ref": "#/x-devx-bundled/ref_49bf9231904bbd9aa1c0"
},
"406": {
"$ref": "#/x-devx-bundled/ref_c791fb405083799347c1"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "Retrieve processing account pricing agreement",
"tags": [
"Processing accounts"
]
}
},
"/processing-accounts/{processingAccountId}/processing-terminals": {
"get": {
"description": "Use this method to return a [paginated](https://docs.payroc.com/api/pagination) list of processing terminals associated with a processing account. \n\n**Note:** If you want to view the details of a specific processing terminal and you have its processingTerminalId, use our [Retrieve Processing Terminal](https://docs.payroc.com/api/schema/boarding/processing-terminals/retrieve) method. \n\nTo list the terminals for a processing account, you need its processingAccountId. If you don't have the processingAccountId, use our [List Merchant Platforms](https://docs.payroc.com/api/schema/boarding/merchant-platforms/list) method to search for a merchant platform and its processing accounts. \n\nOur gateway returns the following information for each processing terminal in the list: \n\n- Status indicating whether the terminal is active or inactive. \n- Configuration settings, including gateway settings and application settings. \n- Features, receipt settings, and security settings. \n- Devices that use the processing terminal's configuration. \n\nFor each processing terminal, we also return its processingTerminalId, which you can use to perform follow-on actions. \n",
"operationId": "listProcessingAccountsProcessingTerminals",
"parameters": [
{
"$ref": "#/x-devx-bundled/ref_04eec39981f6e77f8e6b"
},
{
"$ref": "#/x-devx-bundled/ref_eb4bec06b486e2ceb76c"
},
{
"$ref": "#/x-devx-bundled/ref_e258178e3e59c83f2c9a"
},
{
"$ref": "#/x-devx-bundled/ref_59a42c003a97fcdab712"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"processingTerminals": {
"$ref": "#/x-devx-bundled/ref_a2bf1ec730b1a8ae74b5"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_d52f6ca29cad3f557108"
}
}
},
"description": "Successful request. Returns a list of processing terminals associated with the processing account."
},
"400": {
"$ref": "#/x-devx-bundled/ref_ae89d3d539618a89d2dd"
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"403": {
"$ref": "#/x-devx-bundled/ref_e17edbd5866b60d4beb9"
},
"404": {
"$ref": "#/x-devx-bundled/ref_49bf9231904bbd9aa1c0"
},
"406": {
"$ref": "#/x-devx-bundled/ref_c791fb405083799347c1"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "List processing terminals",
"tags": [
"Processing accounts"
]
}
},
"/processing-accounts/{processingAccountId}/reminders": {
"post": {
"description": "Use this method to prompt a merchant to sign their pricing agreement. \n\nYou can create a reminder only if you requested the merchant’s signature by email when you created the processing account for the merchant. \n\nTo create a reminder, you need the processingAccountId. Our gateway returned the processingAccountId in the response of the [Create Merchant Platform](https://docs.payroc.com/api/schema/boarding/merchant-platforms/create) method or [Create Processing Account](https://docs.payroc.com/api/schema/boarding/merchant-platforms/create-processing-account) method. \n\n**Note:** If you don’t know the processingAccountId, use our [List Merchant Platform’s Processing Accounts](https://docs.payroc.com/api/schema/boarding/merchant-platforms/list-processing-accounts) method to search for the processing account. \n\nWhen you send a successful request, we send an email to the merchant that prompts them to sign their pricing agreement. \n",
"operationId": "createReminder",
"parameters": [
{
"$ref": "#/x-devx-bundled/ref_b92d206f2e50ffc4c068"
},
{
"$ref": "#/x-devx-bundled/ref_04eec39981f6e77f8e6b"
}
],
"requestBody": {
"content": {
"application/json": {
"examples": {
"createReminderProcessingAccountRequest": {
"$ref": "#/x-devx-bundled/ref_ac65d706ccd09f715e75"
}
},
"schema": {
"discriminator": {
"mapping": {
"pricingAgreement": "#/components/schemas/pricingAgreementReminder"
},
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/x-devx-bundled/ref_eb6353451b063de00d76"
}
]
}
}
},
"description": "Polymorphic object that contains reminder details."
},
"responses": {
"201": {
"content": {
"application/json": {
"examples": {
"createReminderProcessingAccountResponse": {
"$ref": "#/x-devx-bundled/ref_f2abf89ac2d4b9e16ebd"
}
},
"schema": {
"discriminator": {
"mapping": {
"pricingAgreement": "#/components/schemas/pricingAgreementReminder"
},
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/x-devx-bundled/ref_eb6353451b063de00d76"
}
]
}
}
},
"description": "Successful request. We sent an email to the merchant and we return a polymorphic object that contains reminder details."
},
"400": {
"content": {
"application/problem+json": {
"examples": {
"badRequest": {
"$ref": "#/x-devx-bundled/ref_2b3621a1c5ae119c6693"
},
"contractAlreadySigned": {
"$ref": "#/x-devx-bundled/ref_8a064dce5871f699f344"
},
"idempotentKeyMissing": {
"$ref": "#/x-devx-bundled/ref_d9867eacc8169139adec"
},
"noPricingAgreementExistsForTheProcessingAccount": {
"$ref": "#/x-devx-bundled/ref_c934abb36246f5c66750"
},
"notRequestedByEmail": {
"$ref": "#/x-devx-bundled/ref_160441a54125204b4701"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_9477586d4a50bb60f5a4"
}
}
},
"description": "Bad request"
},
"403": {
"$ref": "#/x-devx-bundled/ref_e17edbd5866b60d4beb9"
},
"404": {
"$ref": "#/x-devx-bundled/ref_49bf9231904bbd9aa1c0"
},
"409": {
"content": {
"application/problem+json": {
"examples": {
"idempotentKeyInUse": {
"$ref": "#/x-devx-bundled/ref_3917c6024cc650b3ea83"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_478798693738e1bfadb1"
}
}
},
"description": "Conflict"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "Create reminder for processing account",
"tags": [
"Processing accounts"
]
}
},
"/processing-accounts/{processingAccountId}/terminal-orders": {
"get": {
"description": "Use this method to return a [paginated](https://docs.payroc.com/api/pagination) list of terminal orders associated with a processing account. \n\n**Note:** If you want to view the details of a specific terminal order and you have its terminalOrderId, use our [Retrieve Terminal Order](https://docs.payroc.com/api/schema/boarding/terminal-orders/retrieve) method. \n\nUse the query parameters to filter the list of results that we return, for example, to search for terminal orders by their status. \n\nTo list the terminal orders for a processing account, you need its processingAccountId. If you don't have the processingAccountId, use our [List Merchant Platforms](https://docs.payroc.com/api/schema/boarding/merchant-platforms/list) method to search for a merchant platform and its processing accounts.\n\nOur gateway returns the following information for each terminal order in the list: \n\n- Status of the order \n- Items in the order \n- Training provider \n- Shipping information \n\nFor each terminal order, we also return its terminalOrderId, which you can use to perform follow-on actions. \n",
"operationId": "listProcessingAccountsTerminalOrders",
"parameters": [
{
"$ref": "#/x-devx-bundled/ref_04eec39981f6e77f8e6b"
},
{
"$ref": "#/x-devx-bundled/ref_7d106756add78c1ab4a4"
},
{
"$ref": "#/x-devx-bundled/ref_cc0c6d339aacc9796e52"
},
{
"$ref": "#/x-devx-bundled/ref_189f0093666f2903bc12"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"terminalOrders": {
"$ref": "#/x-devx-bundled/ref_c0b0838a8aec80b427aa"
}
},
"schema": {
"description": "Array of terminal order objects.",
"items": {
"$ref": "#/x-devx-bundled/ref_965109f2a9a48b5186c7"
},
"type": "array"
}
}
},
"description": "Successful request. Returns a list of terminal orders associated with the processing account."
},
"400": {
"$ref": "#/x-devx-bundled/ref_ae89d3d539618a89d2dd"
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"403": {
"$ref": "#/x-devx-bundled/ref_e17edbd5866b60d4beb9"
},
"404": {
"$ref": "#/x-devx-bundled/ref_49bf9231904bbd9aa1c0"
},
"406": {
"$ref": "#/x-devx-bundled/ref_c791fb405083799347c1"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "List terminal orders",
"tags": [
"Processing accounts"
]
},
"post": {
"description": "Use this method to order and configure terminals for a processing account. \n\n**Note**: You need the ID of the processing account before you can create an order. If you don't know the processingAccountId, go to the [Retrieve a Merchant Platform](https://docs.payroc.com/api/schema/boarding/merchant-platforms/retrieve) method. \n\nIn the request, specify the gateway settings, device settings, and application settings for the terminal. \n\nIn the response, our gateway returns information about the terminal order including its status and terminalOrderId that you can use to [retrieve the terminal order](https://docs.payroc.com/api/schema/boarding/terminal-orders/retrieve). \n\n**Note**: You can subscribe to the terminalOrder.status.changed event to get notifications when we update the status of a terminal order. For more information about how to subscribe to events, go to [Events Subscriptions](https://docs.payroc.com/guides/board-merchants/event-subscriptions). \n",
"operationId": "createTerminalOrder",
"parameters": [
{
"$ref": "#/x-devx-bundled/ref_b92d206f2e50ffc4c068"
},
{
"$ref": "#/x-devx-bundled/ref_04eec39981f6e77f8e6b"
}
],
"requestBody": {
"content": {
"application/json": {
"examples": {
"terminalOrder": {
"$ref": "#/x-devx-bundled/ref_41a0012cedf970a13c0a"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_1b72ad544bfe7951ee5d"
}
}
}
},
"responses": {
"201": {
"content": {
"application/json": {
"examples": {
"terminalOrder": {
"$ref": "#/x-devx-bundled/ref_16714e0921c52a5403e4"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_965109f2a9a48b5186c7"
}
}
},
"description": "Successful request. We created the terminal order."
},
"400": {
"content": {
"application/problem+json": {
"examples": {
"idempotentKeyMissing": {
"$ref": "#/x-devx-bundled/ref_d9867eacc8169139adec"
},
"validationError": {
"$ref": "#/x-devx-bundled/ref_2b3621a1c5ae119c6693"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_9477586d4a50bb60f5a4"
}
}
},
"description": "Bad request"
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"403": {
"$ref": "#/x-devx-bundled/ref_e17edbd5866b60d4beb9"
},
"404": {
"content": {
"application/problem+json": {
"examples": {
"notFound": {
"$ref": "#/x-devx-bundled/ref_9999b37089d453ef5f5f"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_9cd983fda49001e08d81"
}
}
},
"description": "Not found"
},
"409": {
"content": {
"application/problem+json": {
"examples": {
"idempotentKeyInUse": {
"$ref": "#/x-devx-bundled/ref_3917c6024cc650b3ea83"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_478798693738e1bfadb1"
}
}
},
"description": "Conflict"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "Create terminal order",
"tags": [
"Processing accounts"
]
}
},
"/processing-terminals/{processingTerminalId}": {
"get": {
"description": "**Important:** You can retrieve a processing terminal only if the terminal order was created using the Payroc API.\n\nUse this method to retrieve information about a processing terminal. \n\nTo retrieve a processing terminal, you need its processingTerminalId. Our gateway returned the processingTerminalId in the response of the [Create Terminal Order](https://docs.payroc.com/api/schema/boarding/processing-accounts/create-terminal-order) method. \n\n**Note:** If you don't have the processingTerminalId, use our [Retrieve Terminal Order](https://docs.payroc.com/api/schema/boarding/terminal-orders/retrieve) method or our [List Processing Terminals](https://docs.payroc.com/api/schema/boarding/processing-accounts/list-processing-terminals) method to search for the processing terminal. \n\nOur gateway returns the following information about the processing terminal: \n\n- Status indicating whether the terminal is active or inactive. \n- Configuration settings, including gateway settings and application settings. \n- Features, receipt settings, and security settings. \n- Devices that use the processing terminal's configuration. \n \n",
"operationId": "getProcessingTerminal",
"parameters": [
{
"$ref": "#/x-devx-bundled/ref_3f43c40ece7bf219e047"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"processingTerminals": {
"$ref": "#/x-devx-bundled/ref_0f614eff4d27ca486267"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_9978c2f4aebe867fd1cc"
}
}
},
"description": "Successful request. Returns the processing terminal."
},
"400": {
"$ref": "#/x-devx-bundled/ref_ae89d3d539618a89d2dd"
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"403": {
"$ref": "#/x-devx-bundled/ref_e17edbd5866b60d4beb9"
},
"404": {
"$ref": "#/x-devx-bundled/ref_49bf9231904bbd9aa1c0"
},
"406": {
"$ref": "#/x-devx-bundled/ref_c791fb405083799347c1"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "Retrieve processing terminal",
"tags": [
"Processing terminals"
]
}
},
"/processing-terminals/{processingTerminalId}/apple-pay-sessions": {
"post": {
"description": "Use this method to start an Apple Pay session for your merchant. \n\nIn the response, we return the startSessionObject that you send to Apple when you retrieve the cardholder's encrypted payment details. \n\n**Note:** For more information about how to integrate with Apple Pay, go to [Apple Pay](https://docs.payroc.com/guides/take-payments/apple-pay).\n",
"operationId": "applePaySessions",
"parameters": [
{
"$ref": "#/x-devx-bundled/ref_3f43c40ece7bf219e047"
}
],
"requestBody": {
"content": {
"application/json": {
"examples": {
"startApplePaySessionRequest": {
"$ref": "#/x-devx-bundled/ref_29b4dc1e4e86986370be"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_68cb5c4588a1d2dd977a"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"startApplePaySessionResponse": {
"$ref": "#/x-devx-bundled/ref_4c7c5de1cea50ef531e3"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_c4f3f834f7733f0d9fed"
}
}
},
"description": "Successful request. We started the Apple Pay session."
},
"400": {
"content": {
"application/problem+json": {
"examples": {
"validationError": {
"$ref": "#/x-devx-bundled/ref_2b3621a1c5ae119c6693"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_9477586d4a50bb60f5a4"
}
}
},
"description": "Validation error"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "Start Apple Pay session",
"tags": [
"Apple Pay session"
]
}
},
"/processing-terminals/{processingTerminalId}/close-batch": {
"post": {
"description": "Use this method to manually close a batch on a processing terminal.\n\nOur gateway returns a cut-off time that indicates when our gateway closes the batch.\n\n**Note:** After our gateway closes the batch, the merchant can use the [Self-Care Portal](https://payments.payroc.com/) to view the details of the batch.\n",
"operationId": "closeBatch",
"parameters": [
{
"$ref": "#/x-devx-bundled/ref_b92d206f2e50ffc4c068"
},
{
"$ref": "#/x-devx-bundled/ref_3f43c40ece7bf219e047"
}
],
"responses": {
"202": {
"content": {
"application/json": {
"examples": {
"closeBatchProcessingTerminalResponse": {
"$ref": "#/x-devx-bundled/ref_aceed7495a711cbfb898"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_d465d569f024a45a9197"
}
}
},
"description": "Successful request. We closed the batch for the processing terminal."
},
"400": {
"content": {
"application/problem+json": {
"examples": {
"idempotentKeyMissing": {
"$ref": "#/x-devx-bundled/ref_d9867eacc8169139adec"
},
"validationError": {
"$ref": "#/x-devx-bundled/ref_2b3621a1c5ae119c6693"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_9477586d4a50bb60f5a4"
}
}
},
"description": "Validation error"
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"403": {
"$ref": "#/x-devx-bundled/ref_e17edbd5866b60d4beb9"
},
"404": {
"$ref": "#/x-devx-bundled/ref_49bf9231904bbd9aa1c0"
},
"406": {
"$ref": "#/x-devx-bundled/ref_c791fb405083799347c1"
},
"409": {
"$ref": "#/x-devx-bundled/ref_33a47f40f610a3ad4109"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "Close batch for processing terminal",
"tags": [
"Processing terminals"
]
}
},
"/processing-terminals/{processingTerminalId}/device-configurations/{model}": {
"get": {
"description": "Use this method to retrieve configuration details for a device associated with a processing terminal.\n\nOur gateway returns the following details about the configuration:\n\n- Supported features\n- Applications\n- Certificates and revoked certificates\n- Visual assets\n",
"operationId": "retrieveDeviceConfiguration",
"parameters": [
{
"$ref": "#/x-devx-bundled/ref_3f43c40ece7bf219e047"
},
{
"$ref": "#/x-devx-bundled/ref_a8600843dd7defbf7deb"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"deviceConfiguration": {
"$ref": "#/x-devx-bundled/ref_645d48ac4453f76791af"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_c9a3b88a5341a996fb4c"
}
}
},
"description": "Successful request. Returns the device configuration details."
},
"400": {
"$ref": "#/x-devx-bundled/ref_ae89d3d539618a89d2dd"
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"403": {
"$ref": "#/x-devx-bundled/ref_e17edbd5866b60d4beb9"
},
"404": {
"$ref": "#/x-devx-bundled/ref_49bf9231904bbd9aa1c0"
},
"406": {
"$ref": "#/x-devx-bundled/ref_c791fb405083799347c1"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "Retrieve a device configuration",
"tags": [
"Processing terminals"
]
}
},
"/processing-terminals/{processingTerminalId}/host-configurations": {
"get": {
"description": "Use this method to retrieve the host processor configuration of a processing terminal. Integrate with this method only if you use your own gateway and want to validate the processor configuration. \n\nOur gateway returns the configuration settings for the merchant and the payment terminal.\n",
"operationId": "getProcessingTerminalHostConfiguration",
"parameters": [
{
"$ref": "#/x-devx-bundled/ref_3f43c40ece7bf219e047"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"retrieveHostProcessorConfigurationResponse": {
"$ref": "#/x-devx-bundled/ref_d2abe31f0db8698b23fb"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_4c16ec99a0cf81f8e16d"
}
}
},
"description": "Successful request. Returns the host configuration of the processing terminal."
},
"400": {
"$ref": "#/x-devx-bundled/ref_ae89d3d539618a89d2dd"
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"403": {
"$ref": "#/x-devx-bundled/ref_e17edbd5866b60d4beb9"
},
"404": {
"$ref": "#/x-devx-bundled/ref_49bf9231904bbd9aa1c0"
},
"406": {
"$ref": "#/x-devx-bundled/ref_c791fb405083799347c1"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "Retrieve host processor configuration",
"tags": [
"Processing terminals"
]
}
},
"/processing-terminals/{processingTerminalId}/hosted-fields-sessions": {
"post": {
"description": "Use this method to create a Hosted Fields session token. You need to generate a new session token each time you load Hosted Fields on a webpage. \n\nIn your request, you need to indicate whether the merchant is using Hosted Fields to run a sale, save payment details, or update saved payment details. \n\nIn the response, our gateway returns the session token and the time that it expires. You need the session token when you configure the JavaScript for Hosted Fields. \n\nFor more information about adding Hosted Fields to a webpage, go to [Hosted Fields](https://docs.payroc.com/guides/take-payments/hosted-fields). \n",
"operationId": "createSession",
"parameters": [
{
"$ref": "#/x-devx-bundled/ref_b92d206f2e50ffc4c068"
},
{
"$ref": "#/x-devx-bundled/ref_3f43c40ece7bf219e047"
}
],
"requestBody": {
"content": {
"application/json": {
"examples": {
"createHostedFieldsSessionRequest": {
"$ref": "#/x-devx-bundled/ref_1fc34136cbdb8c5e933b"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_38ddc242f7a6907e5c9c"
}
}
},
"required": true
},
"responses": {
"201": {
"content": {
"application/json": {
"examples": {
"createHostedFieldsSessionResponse": {
"$ref": "#/x-devx-bundled/ref_f9cda9181de4b9730c36"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_6a8d98cf489862e020dc"
}
}
},
"description": "Successful request. We created the session and returned a session token.",
"headers": {
"location": {
"$ref": "#/x-devx-bundled/ref_7b13ec5af2d2b1d9f8e7"
}
}
},
"400": {
"content": {
"application/problem+json": {
"examples": {
"idempotentKeyInUse": {
"$ref": "#/x-devx-bundled/ref_3917c6024cc650b3ea83"
},
"idempotentKeyMissing": {
"$ref": "#/x-devx-bundled/ref_d9867eacc8169139adec"
},
"validationError": {
"$ref": "#/x-devx-bundled/ref_2b3621a1c5ae119c6693"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_9477586d4a50bb60f5a4"
}
}
},
"description": "Validation error"
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"403": {
"$ref": "#/x-devx-bundled/ref_e17edbd5866b60d4beb9"
},
"406": {
"$ref": "#/x-devx-bundled/ref_c791fb405083799347c1"
},
"409": {
"$ref": "#/x-devx-bundled/ref_33a47f40f610a3ad4109"
},
"415": {
"$ref": "#/x-devx-bundled/ref_40869c40b438e4591cbc"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "Create Hosted Fields session",
"tags": [
"Hosted Fields"
]
}
},
"/processing-terminals/{processingTerminalId}/payment-links": {
"get": {
"description": "Use this method to return a [paginated](https://docs.payroc.com/api/pagination) list of payment links linked to a processing terminal. \n\n**Note:** If you want to view the details of a specific payment link and you have its paymentLinkId, use our [Retrieve Payment Link](https://docs.payroc.com/api/schema/payment-links/retrieve) method. \n\nUse query parameters to filter the list of results that we return, for example, to search for only active links or multi-use links. \n\nOur gateway returns the following information about each payment link in the list: \n- **type** - Indicates whether the link can be used only once or if it can be used multiple times. \n- **authType** - Indicates whether the transaction is a sale or a pre-authorization. \n- **paymentMethods** - Indicates the payment method that the merchant accepts. \n- **charge** - Indicates whether the merchant or the customer enters the amount for the transaction. \n- **status** - Indicates if the payment link is active. \n\nFor each payment link, we also return a paymentLinkId, which you can use for follow-on actions. \n",
"operationId": "listPaymentLinks",
"parameters": [
{
"$ref": "#/x-devx-bundled/ref_3f43c40ece7bf219e047"
},
{
"$ref": "#/x-devx-bundled/ref_2193dd0fa84b6ecfcf2e"
},
{
"$ref": "#/x-devx-bundled/ref_d1e967a8d89aef838dd2"
},
{
"$ref": "#/x-devx-bundled/ref_484be455c52965692b06"
},
{
"$ref": "#/x-devx-bundled/ref_8e1b104378f74dcbbd14"
},
{
"$ref": "#/x-devx-bundled/ref_fc48a721906cd4080a66"
},
{
"$ref": "#/x-devx-bundled/ref_110d5c260cf5acafc170"
},
{
"$ref": "#/x-devx-bundled/ref_b97613a1c74f57f86288"
},
{
"$ref": "#/x-devx-bundled/ref_19a8e307cfe221c92341"
},
{
"$ref": "#/x-devx-bundled/ref_eb4bec06b486e2ceb76c"
},
{
"$ref": "#/x-devx-bundled/ref_e258178e3e59c83f2c9a"
},
{
"$ref": "#/x-devx-bundled/ref_59a42c003a97fcdab712"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"noActivity": {
"$ref": "#/x-devx-bundled/ref_7ad5ac1e2a5096a96273"
},
"paginatedResults": {
"$ref": "#/x-devx-bundled/ref_9512d9356d224e7686c7"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_bfececc849bf00f27e2b"
}
}
},
"description": "Successful request. Returns a [paginated](https://docs.payroc.com/api/pagination) list of payment links."
},
"400": {
"$ref": "#/x-devx-bundled/ref_ae89d3d539618a89d2dd"
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"403": {
"$ref": "#/x-devx-bundled/ref_e17edbd5866b60d4beb9"
},
"404": {
"$ref": "#/x-devx-bundled/ref_49bf9231904bbd9aa1c0"
},
"406": {
"$ref": "#/x-devx-bundled/ref_c791fb405083799347c1"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "List payment links",
"tags": [
"Payment links"
]
},
"post": {
"description": "Use this method to create a payment link that a customer can use to make a payment for goods or services. \n\nThe request includes the following settings:\n- **type** - Indicates whether the link can be used only once or if it can be used multiple times.\n- **authType** - Indicates whether the transaction is a sale or a pre-authorization.\n- **paymentMethod** - Indicates the payment methods that the merchant accepts.\n- **charge** - Indicates whether the merchant or the customer enters the amount for the transaction. \n\nIf your request is successful, our gateway returns a paymentLinkId, which you can use to perform follow-on actions. \n\n**Note:** To share the payment link with a customer, use our [Share Payment Link](https://docs.payroc.com/api/schema/payment-links/sharing-events/share) method.\n",
"operationId": "createPaymentLink",
"parameters": [
{
"$ref": "#/x-devx-bundled/ref_b92d206f2e50ffc4c068"
},
{
"$ref": "#/x-devx-bundled/ref_3f43c40ece7bf219e047"
}
],
"requestBody": {
"content": {
"application/json": {
"examples": {
"createPaymentLinkMultiUseRequest": {
"$ref": "#/x-devx-bundled/ref_8ed290b57437ba306cdd"
},
"createPaymentLinkSingleUseRequest": {
"$ref": "#/x-devx-bundled/ref_32bae5e693f8a11675b7"
}
},
"schema": {
"oneOf": [
{
"$ref": "#/x-devx-bundled/ref_210fbadc5eb6d4079f9a"
},
{
"$ref": "#/x-devx-bundled/ref_0f813605d6f1b2a63bdb"
}
],
"type": "object"
}
}
},
"description": "Polymorphic object that contains payment link information. \n\nThe value of the type parameter determines which variant you should use:\n-\t`multiUse` - Create a link that the merchant can use to take multiple payments.\n-\t`singleUse` - Create a link that the merchant can use for only one payment.\n",
"required": true
},
"responses": {
"201": {
"content": {
"application/json": {
"examples": {
"createPaymentLinkSingleUseResponse": {
"$ref": "#/x-devx-bundled/ref_192143ce438ffb4a184e"
},
"createdPaymentLink": {
"$ref": "#/x-devx-bundled/ref_ac8399da4ad96bb34ceb"
}
},
"schema": {
"oneOf": [
{
"$ref": "#/x-devx-bundled/ref_210fbadc5eb6d4079f9a"
},
{
"$ref": "#/x-devx-bundled/ref_0f813605d6f1b2a63bdb"
}
],
"type": "object"
}
}
},
"description": "Successful request. We return a polymorphic object that contains payment link information.\nThe value of the type parameter determines which variant you should use:\n-\t`multiUse` - Create a link that the merchant can use to take multiple payments.\n-\t`singleUse` - Create a link that the merchant can use for only one payment.\n",
"headers": {
"location": {
"$ref": "#/x-devx-bundled/ref_7b13ec5af2d2b1d9f8e7"
}
}
},
"400": {
"content": {
"application/problem+json": {
"examples": {
"idempotentKeyMissing": {
"$ref": "#/x-devx-bundled/ref_d9867eacc8169139adec"
},
"validationError": {
"$ref": "#/x-devx-bundled/ref_2b3621a1c5ae119c6693"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_9477586d4a50bb60f5a4"
}
}
},
"description": "Validation error"
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"403": {
"$ref": "#/x-devx-bundled/ref_e17edbd5866b60d4beb9"
},
"404": {
"$ref": "#/x-devx-bundled/ref_49bf9231904bbd9aa1c0"
},
"406": {
"$ref": "#/x-devx-bundled/ref_c791fb405083799347c1"
},
"409": {
"$ref": "#/x-devx-bundled/ref_33a47f40f610a3ad4109"
},
"415": {
"$ref": "#/x-devx-bundled/ref_40869c40b438e4591cbc"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "Create payment link",
"tags": [
"Payment links"
]
}
},
"/processing-terminals/{processingTerminalId}/payment-plans": {
"get": {
"description": "Use this method to return a [paginated](https://docs.payroc.com/api/pagination) list of payment plans for a processing terminal. \n\n**Note:** If you want to view the details of a specific payment plan and you have its paymentPlanId, use our [Retrieve Payment Plan](https://docs.payroc.com/api/schema/repeat-payments/payment-plans/retrieve) method. \n\nOur gateway returns the following information about each payment plan in the list: \n\n -\tName, length, and currency of the plan \n -\tHow often our gateway collects each payment \n -\tHow much our gateway collects for each payment \n -\tWhat happens if the merchant updates or deletes the plan \n\nFor each payment plan, we return the paymentPlanId, which you can use to perform follow-on actions.\n",
"operationId": "listPaymentPlans",
"parameters": [
{
"$ref": "#/x-devx-bundled/ref_3f43c40ece7bf219e047"
},
{
"$ref": "#/x-devx-bundled/ref_eb4bec06b486e2ceb76c"
},
{
"$ref": "#/x-devx-bundled/ref_e258178e3e59c83f2c9a"
},
{
"$ref": "#/x-devx-bundled/ref_59a42c003a97fcdab712"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"noActivity": {
"$ref": "#/x-devx-bundled/ref_7ad5ac1e2a5096a96273"
},
"paginatedResults": {
"$ref": "#/x-devx-bundled/ref_d12dac40c833df284787"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_062e3c457eb4c3dc83dd"
}
}
},
"description": "Successful request. Returns a paginated list of payment plans."
},
"400": {
"$ref": "#/x-devx-bundled/ref_ae89d3d539618a89d2dd"
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"403": {
"$ref": "#/x-devx-bundled/ref_e17edbd5866b60d4beb9"
},
"406": {
"$ref": "#/x-devx-bundled/ref_c791fb405083799347c1"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "List payment plans",
"tags": [
"Payment plans"
]
},
"post": {
"description": "Use this method to create a payment schedule that you can assign customers to. \n\n**Note:** This method is part of our Repeat Payments feature. To help you understand how this method works with our Subscriptions endpoints, go to [Repeat Payments](https://docs.payroc.com/guides/take-payments/repeat-payments). \n\nWhen you create a payment plan you need to provide a unique paymentPlanId that you use to run follow-on actions: \n\n-\t[Retrieve Payment Plan](https://docs.payroc.com/api/schema/repeat-payments/payment-plans/retrieve) - View the details of the payment plan. \n-\t[Update Payment Plan](https://docs.payroc.com/api/schema/repeat-payments/payment-plans/partially-update) - Update the details of the payment plan. \n-\t[Delete Payment Plan](https://docs.payroc.com/api/schema/repeat-payments/payment-plans/delete) - Delete the payment plan. \n-\t[Create Subscription](https://docs.payroc.com/api/schema/repeat-payments/subscriptions/create) - Subscribe a customer to the payment plan. \n\nThe request includes the following settings: \n\n-\t**type** - Indicates if our gateway or the merchant collects payments. If the merchant manually collects payments, integrate with the [Pay Manual Subscription](https://docs.payroc.com/api/schema/repeat-payments/subscriptions/pay) method. \n-\t**recurringOrder** - Amount of each payment if the gateway automatically collect payments. \n-\t**setupOrder** - Setup fee that our gateway immediately collects from the customer's payment method. \n-\t**onUpdate and onDelete** - Indicates what happens to associated subscriptions if the merchant updates or deletes the payment plan. \n",
"operationId": "createPaymentPlan",
"parameters": [
{
"$ref": "#/x-devx-bundled/ref_b92d206f2e50ffc4c068"
},
{
"$ref": "#/x-devx-bundled/ref_3f43c40ece7bf219e047"
}
],
"requestBody": {
"content": {
"application/json": {
"examples": {
"createPaymentPlanRequest": {
"$ref": "#/x-devx-bundled/ref_1692c517eaa8450a6234"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_c80128c537381f745ab9"
}
}
},
"required": true
},
"responses": {
"201": {
"content": {
"application/json": {
"examples": {
"createdPaymentPlan": {
"$ref": "#/x-devx-bundled/ref_4887d00cb91f7c43ee62"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_c80128c537381f745ab9"
}
}
},
"description": "Successful request. We created the payment plan.",
"headers": {
"location": {
"$ref": "#/x-devx-bundled/ref_7b13ec5af2d2b1d9f8e7"
}
}
},
"400": {
"content": {
"application/problem+json": {
"examples": {
"idempotentKeyInUse": {
"$ref": "#/x-devx-bundled/ref_3917c6024cc650b3ea83"
},
"idempotentKeyMissing": {
"$ref": "#/x-devx-bundled/ref_d9867eacc8169139adec"
},
"validationError": {
"$ref": "#/x-devx-bundled/ref_2b3621a1c5ae119c6693"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_9477586d4a50bb60f5a4"
}
}
},
"description": "Validation error"
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"403": {
"$ref": "#/x-devx-bundled/ref_e17edbd5866b60d4beb9"
},
"406": {
"$ref": "#/x-devx-bundled/ref_c791fb405083799347c1"
},
"409": {
"$ref": "#/x-devx-bundled/ref_33a47f40f610a3ad4109"
},
"415": {
"$ref": "#/x-devx-bundled/ref_40869c40b438e4591cbc"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "Create payment plan",
"tags": [
"Payment plans"
]
}
},
"/processing-terminals/{processingTerminalId}/payment-plans/{paymentPlanId}": {
"delete": {
"description": "Use this method to delete a payment plan. \n\n> **Important:** When you delete a payment plan, you can’t recover it. You also won’t be able to add subscriptions to the payment plan. \n\nTo delete a payment plan, you need its paymentPlanId, which you sent in the request of the [Create Payment Plan](https://docs.payroc.com/api/schema/repeat-payments/payment-plans/create) method. \n\n**Note:** If you don't have the paymentPlanId, use our [List Payment Plans](https://docs.payroc.com/api/schema/repeat-payments/payment-plans/list) method to search for the payment plan. \n\nThe value you sent for the onDelete parameter when you created the payment plan indicates what happens to associated subscriptions when you delete the plan: \n\n -\t`complete` - Our gateway stops taking payments for the subscriptions associated with the payment plan. \n -\t`continue` - Our gateway continues to take payments for the subscriptions associated with the payment plan. To stop a subscription for a canceled payment plan, go to the [Deactivate Subscription](https://docs.payroc.com/api/schema/repeat-payments/subscriptions/deactivate) method. \n",
"operationId": "deletePaymentPlan",
"parameters": [
{
"$ref": "#/x-devx-bundled/ref_3f43c40ece7bf219e047"
},
{
"$ref": "#/x-devx-bundled/ref_dcd1553cbd8f2356acda"
}
],
"responses": {
"204": {
"description": "Successful request. We deleted the payment plan."
},
"400": {
"$ref": "#/x-devx-bundled/ref_ae89d3d539618a89d2dd"
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"403": {
"$ref": "#/x-devx-bundled/ref_e17edbd5866b60d4beb9"
},
"404": {
"$ref": "#/x-devx-bundled/ref_49bf9231904bbd9aa1c0"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "Delete payment plan",
"tags": [
"Payment plans"
]
},
"get": {
"description": "Use this method to retrieve information about a payment plan. \n\nTo retrieve a payment plan, you need its paymentPlanId. Our gateway returned the paymentPlanId in the response of the [Create Payment Plan](https://docs.payroc.com/api/schema/repeat-payments/payment-plans/create) method. \n\n**Note:** If you don't have the paymentPlanId, use our [List Payment Plans](https://docs.payroc.com/api/schema/repeat-payments/payment-plans/list) method to search for the payment plan. \n\nOur gateway returns the following information about the payment plan: \n\n -\tName, length, and currency of the plan \n -\tHow often our gateway collects each payment \n -\tHow much our gateway collects for each payment \n -\tWhat happens if the merchant updates or deletes the plan \n",
"operationId": "getPaymentPlan",
"parameters": [
{
"$ref": "#/x-devx-bundled/ref_3f43c40ece7bf219e047"
},
{
"$ref": "#/x-devx-bundled/ref_dcd1553cbd8f2356acda"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"paymentPlan": {
"$ref": "#/x-devx-bundled/ref_4887d00cb91f7c43ee62"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_c80128c537381f745ab9"
}
}
},
"description": "Successful request. Returns the requested payment plan."
},
"400": {
"$ref": "#/x-devx-bundled/ref_ae89d3d539618a89d2dd"
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"403": {
"$ref": "#/x-devx-bundled/ref_e17edbd5866b60d4beb9"
},
"404": {
"$ref": "#/x-devx-bundled/ref_49bf9231904bbd9aa1c0"
},
"406": {
"$ref": "#/x-devx-bundled/ref_c791fb405083799347c1"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "Retrieve payment plan",
"tags": [
"Payment plans"
]
},
"patch": {
"description": "Use this method to partially update a payment plan. Structure your request to follow the [RFC 6902](https://datatracker.ietf.org/doc/html/rfc6902) standard. \n\nTo update a payment plan, you need its paymentPlanId, which you sent in the request of the [Create Payment Plan](https://docs.payroc.com/api/schema/repeat-payments/payment-plans/create) method. \n\n**Note:** If you don't have the paymentPlanId, use our [List Payment Plans](https://docs.payroc.com/api/schema/repeat-payments/payment-plans/list) method to search for the payment plan. \n\nYou can update all of the properties of the payment plan except for the paymentPlanId. \n\nThe value you sent for the onUpdate parameter when you created the payment plan indicates what happens to the associated subscriptions when you update the plan: \n- `update` - Our gateway updates the subscriptions associated with the payment plan.\n- `continue` - Our gateway doesn't update the subscriptions associated with the payment plan.\n",
"operationId": "updatePaymentPlan",
"parameters": [
{
"$ref": "#/x-devx-bundled/ref_b92d206f2e50ffc4c068"
},
{
"$ref": "#/x-devx-bundled/ref_3f43c40ece7bf219e047"
},
{
"$ref": "#/x-devx-bundled/ref_dcd1553cbd8f2356acda"
}
],
"requestBody": {
"content": {
"application/json": {
"examples": {
"partiallyUpdatePaymentPlanAddRequest": {
"$ref": "#/x-devx-bundled/ref_5f670ac0be2d47f8a490"
},
"partiallyUpdatePaymentPlanCopyRequest": {
"$ref": "#/x-devx-bundled/ref_51455fa42a9b093dc3db"
},
"partiallyUpdatePaymentPlanMoveRequest": {
"$ref": "#/x-devx-bundled/ref_c6665370075f60a9dc13"
},
"partiallyUpdatePaymentPlanRealisticRequest": {
"$ref": "#/x-devx-bundled/ref_67037bfcf97d8dcb9e3c"
},
"partiallyUpdatePaymentPlanRemoveRequest": {
"$ref": "#/x-devx-bundled/ref_1984086edf68a329c63d"
},
"partiallyUpdatePaymentPlanReplaceRequest": {
"$ref": "#/x-devx-bundled/ref_131240e23a2ae006742f"
},
"partiallyUpdatePaymentPlanTestRequest": {
"$ref": "#/x-devx-bundled/ref_20bd6f7961f9beaf2021"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_83c73ee340defd8c776d"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"partiallyUpdatePaymentPlanAddResponse": {
"$ref": "#/x-devx-bundled/ref_d542796289b905797418"
},
"partiallyUpdatePaymentPlanCopyResponse": {
"$ref": "#/x-devx-bundled/ref_e459d08e6c292e0fc1b5"
},
"partiallyUpdatePaymentPlanMoveResponse": {
"$ref": "#/x-devx-bundled/ref_d20a778f5c01261ca9cd"
},
"partiallyUpdatePaymentPlanRealisticResponse": {
"$ref": "#/x-devx-bundled/ref_283ef553782c41aae434"
},
"partiallyUpdatePaymentPlanRemoveResponse": {
"$ref": "#/x-devx-bundled/ref_139c6fc55dfb6af1864a"
},
"partiallyUpdatePaymentPlanReplaceResponse": {
"$ref": "#/x-devx-bundled/ref_8f68cc0e352a60082b55"
},
"partiallyUpdatePaymentPlanTestResponse": {
"$ref": "#/x-devx-bundled/ref_2c0da1d78400d9a0cf32"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_c80128c537381f745ab9"
}
}
},
"description": "Successful request. We updated the payment plan."
},
"400": {
"$ref": "#/x-devx-bundled/ref_ae89d3d539618a89d2dd"
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"403": {
"$ref": "#/x-devx-bundled/ref_e17edbd5866b60d4beb9"
},
"404": {
"$ref": "#/x-devx-bundled/ref_49bf9231904bbd9aa1c0"
},
"406": {
"$ref": "#/x-devx-bundled/ref_c791fb405083799347c1"
},
"409": {
"$ref": "#/x-devx-bundled/ref_33a47f40f610a3ad4109"
},
"415": {
"$ref": "#/x-devx-bundled/ref_40869c40b438e4591cbc"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "Partially update payment plan",
"tags": [
"Payment plans"
]
}
},
"/processing-terminals/{processingTerminalId}/secure-tokens": {
"get": {
"description": "Use this method to return a [paginated](https://docs.payroc.com/api/pagination) list of secure tokens. \n\n**Note:** If you want to view the details of a specific secure token and you have its secureTokenId, use our [Retrieve Secure Token](https://docs.payroc.com/api/schema/tokenization/secure-tokens/retrieve) method. \n\nUse query parameters to filter the list of results that we return, for example, to search for secure tokens by customer or by the first four digits of a card number. \n\nOur gateway returns information about the following for each secure token in the list: \n\n -\tPayment details that the secure token represents. \n -\tCustomer details, including shipping and billing addresses. \n -\tSecure token that you can use to carry out transactions. \n\n For each secure token, we also return the secureTokenId, which you can use to perform follow-on actions.\n",
"operationId": "listSecureTokens",
"parameters": [
{
"$ref": "#/x-devx-bundled/ref_3f43c40ece7bf219e047"
},
{
"$ref": "#/x-devx-bundled/ref_0f141912e7871a73611a"
},
{
"$ref": "#/x-devx-bundled/ref_9a9e3c82286fa836da18"
},
{
"$ref": "#/x-devx-bundled/ref_9901c23553590ebbcce4"
},
{
"$ref": "#/x-devx-bundled/ref_a71510b23f1c84ff1755"
},
{
"$ref": "#/x-devx-bundled/ref_c409d186912eaed5dbdf"
},
{
"$ref": "#/x-devx-bundled/ref_370da86d628188b0917a"
},
{
"$ref": "#/x-devx-bundled/ref_2e353a00051ad58aa9b8"
},
{
"$ref": "#/x-devx-bundled/ref_eb4bec06b486e2ceb76c"
},
{
"$ref": "#/x-devx-bundled/ref_e258178e3e59c83f2c9a"
},
{
"$ref": "#/x-devx-bundled/ref_59a42c003a97fcdab712"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"noActivity": {
"$ref": "#/x-devx-bundled/ref_7ad5ac1e2a5096a96273"
},
"paginatedResults": {
"$ref": "#/x-devx-bundled/ref_f8dacd706f9d02dd8d64"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_fb18ff3a7be62ead942a"
}
}
},
"description": "Successful request. Returns a list of secure tokens that are currently saved on the terminal."
},
"400": {
"$ref": "#/x-devx-bundled/ref_ae89d3d539618a89d2dd"
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"403": {
"$ref": "#/x-devx-bundled/ref_e17edbd5866b60d4beb9"
},
"406": {
"$ref": "#/x-devx-bundled/ref_c791fb405083799347c1"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "List secure tokens",
"tags": [
"Secure tokens"
]
},
"post": {
"description": "Use this method to create a secure token that represents a customer's payment details. \n\nWhen you create a secure token, you need to generate and provide a secureTokenId that you use to run follow-on actions: \n- [Retrieve Secure Token](https://docs.payroc.com/api/schema/tokenization/secure-tokens/retrieve) – View the details of the secure token. \n- [Delete Secure Token](https://docs.payroc.com/api/schema/tokenization/secure-tokens/delete) – Delete the secure token. \n- [Update Secure Token](https://docs.payroc.com/api/schema/tokenization/secure-tokens/partially-update) – Update the details of the secure token. \n- [Update Account Details](https://docs.payroc.com/api/schema/tokenization/secure-tokens/update-account) – Update the secure token with the details from a single-use token. \n\n**Note:** If you don't generate a secureTokenId to identify the token, our gateway generates a unique identifier and returns it in the response. \n\nIf the request is successful, our gateway returns a token that the merchant can use in transactions instead of the customer's sensitive payment details, for example, when they [run a sale](https://docs.payroc.com/api/schema/card-payments/payments/create).\n",
"operationId": "createSecureToken",
"parameters": [
{
"$ref": "#/x-devx-bundled/ref_b92d206f2e50ffc4c068"
},
{
"$ref": "#/x-devx-bundled/ref_3f43c40ece7bf219e047"
}
],
"requestBody": {
"content": {
"application/json": {
"examples": {
"createSecureToken": {
"$ref": "#/x-devx-bundled/ref_c9541bb57e90d1d0eccb"
},
"createSecureTokenSingleUseToken": {
"$ref": "#/x-devx-bundled/ref_813e84ea1d7275ef40d3"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_37fb5700e029d2a6af06"
}
}
},
"required": true
},
"responses": {
"201": {
"content": {
"application/json": {
"examples": {
"createdSecureToken": {
"$ref": "#/x-devx-bundled/ref_715be958a787f9a1f183"
},
"createdSecureTokenSingleUseToken": {
"$ref": "#/x-devx-bundled/ref_f677b5a197b397de6df2"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_bb4eb3fe9ae988b55c71"
}
}
},
"description": "Successful request. We created a secure token that represents your customer's payment details.",
"headers": {
"location": {
"$ref": "#/x-devx-bundled/ref_7b13ec5af2d2b1d9f8e7"
}
}
},
"400": {
"content": {
"application/problem+json": {
"examples": {
"idempotentKeyInUse": {
"$ref": "#/x-devx-bundled/ref_3917c6024cc650b3ea83"
},
"idempotentKeyMissing": {
"$ref": "#/x-devx-bundled/ref_d9867eacc8169139adec"
},
"validationError": {
"$ref": "#/x-devx-bundled/ref_2b3621a1c5ae119c6693"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_9477586d4a50bb60f5a4"
}
}
},
"description": "Validation error"
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"403": {
"$ref": "#/x-devx-bundled/ref_e17edbd5866b60d4beb9"
},
"406": {
"$ref": "#/x-devx-bundled/ref_c791fb405083799347c1"
},
"409": {
"$ref": "#/x-devx-bundled/ref_33a47f40f610a3ad4109"
},
"415": {
"$ref": "#/x-devx-bundled/ref_40869c40b438e4591cbc"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "Create secure token",
"tags": [
"Secure tokens"
]
}
},
"/processing-terminals/{processingTerminalId}/secure-tokens/{secureTokenId}": {
"delete": {
"description": "Use this method to delete a secure token and its related payment details from our vault. \n\nTo delete a secure token, you need its secureTokenId, which you sent in the request of the [Create Secure Token](https://docs.payroc.com/api/schema/tokenization/secure-tokens/create) method. \n\n**Note:** If you don’t have the secureTokenId, use our [List Secure Tokens](https://docs.payroc.com/api/schema/tokenization/secure-tokens/list) method to search for the secure token. \n\nWhen you delete a secure token, you can’t recover it, and you can’t reuse its identifier for a new token. \n",
"operationId": "deleteSecureToken",
"parameters": [
{
"$ref": "#/x-devx-bundled/ref_3f43c40ece7bf219e047"
},
{
"$ref": "#/x-devx-bundled/ref_9d2f2af2f39a90b039e0"
}
],
"responses": {
"204": {
"description": "Successful request. We deleted the secure token."
},
"400": {
"$ref": "#/x-devx-bundled/ref_ae89d3d539618a89d2dd"
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"403": {
"$ref": "#/x-devx-bundled/ref_e17edbd5866b60d4beb9"
},
"404": {
"$ref": "#/x-devx-bundled/ref_49bf9231904bbd9aa1c0"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "Delete secure token",
"tags": [
"Secure tokens"
]
},
"get": {
"description": "Use this method to retrieve information about a secure token. \n\nTo retrieve a secure token, you need its secureTokenID, which you sent in the request of the [Create Secure Token](https://docs.payroc.com/api/schema/tokenization/secure-tokens/create) method. \n\n**Note:** If you don't have the secureTokenId, use our [List Secure Tokens](https://docs.payroc.com/api/schema/tokenization/secure-tokens/list) method to search for the secure token. \n\nOur gateway returns the following information about the secure token: \n\n -\tPayment details that the secure token represents. \n -\tCustomer details, including shipping and billing addresses. \n -\tSecure token that you can use to carry out transactions. \n",
"operationId": "getSecureToken",
"parameters": [
{
"$ref": "#/x-devx-bundled/ref_3f43c40ece7bf219e047"
},
{
"$ref": "#/x-devx-bundled/ref_9d2f2af2f39a90b039e0"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"secureToken": {
"$ref": "#/x-devx-bundled/ref_715be958a787f9a1f183"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_b0b4930f5830799eddd0"
}
}
},
"description": "Successful request. Returns the secure token and its related payment details."
},
"400": {
"$ref": "#/x-devx-bundled/ref_ae89d3d539618a89d2dd"
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"403": {
"$ref": "#/x-devx-bundled/ref_e17edbd5866b60d4beb9"
},
"404": {
"$ref": "#/x-devx-bundled/ref_49bf9231904bbd9aa1c0"
},
"406": {
"$ref": "#/x-devx-bundled/ref_c791fb405083799347c1"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "Retrieve secure token",
"tags": [
"Secure tokens"
]
},
"patch": {
"description": "Use this method to partially update a secure token. Structure your request to follow the [RFC 6902](https://datatracker.ietf.org/doc/html/rfc6902) standard. \n\nTo update a secure token, you need its secureTokenId, which you sent in the request of the [Create Secure Token](https://docs.payroc.com/api/schema/tokenization/secure-tokens/create) method. \n\n**Note:** If you don't have the secureTokenId, use our [List Secure Tokens](https://docs.payroc.com/api/schema/tokenization/secure-tokens/list) method to search for the payment. \n\nYou can update all of the properties of the secure token, except the following: \n- processingTerminalId \n- type \n- token \n- status \n- source/Card \n - type \n - cardNumber \n - cardType \n - currency \n - debit \n - surcharging \n- source/ACH account \n - accountNumber \n - routingNumber \n- source/PAD account \n - type \n - accountNumber \n - transitNumber \n",
"operationId": "updateSecureToken",
"parameters": [
{
"$ref": "#/x-devx-bundled/ref_b92d206f2e50ffc4c068"
},
{
"$ref": "#/x-devx-bundled/ref_3f43c40ece7bf219e047"
},
{
"$ref": "#/x-devx-bundled/ref_9d2f2af2f39a90b039e0"
}
],
"requestBody": {
"content": {
"application/json": {
"examples": {
"partiallyUpdateSecureTokenAddRequest": {
"$ref": "#/x-devx-bundled/ref_ae8cb5ff6737954e04c4"
},
"partiallyUpdateSecureTokenCopyRequest": {
"$ref": "#/x-devx-bundled/ref_b7bc699fee675ee28da3"
},
"partiallyUpdateSecureTokenMoveRequest": {
"$ref": "#/x-devx-bundled/ref_12539077028451b8ba4f"
},
"partiallyUpdateSecureTokenRealisticRequest": {
"$ref": "#/x-devx-bundled/ref_db52edd25af194f3f64d"
},
"partiallyUpdateSecureTokenRemoveRequest": {
"$ref": "#/x-devx-bundled/ref_fca565eee84a34e9245c"
},
"partiallyUpdateSecureTokenReplaceRequest": {
"$ref": "#/x-devx-bundled/ref_77722c3f40102e1b2d41"
},
"partiallyUpdateSecureTokenTestRequest": {
"$ref": "#/x-devx-bundled/ref_e1e62762b403f96522b7"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_83c73ee340defd8c776d"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"patchSecureTokenAdd": {
"$ref": "#/x-devx-bundled/ref_6f5f7c66fc3a21e3ef34"
},
"patchSecureTokenCopy": {
"$ref": "#/x-devx-bundled/ref_2da15af34cb3b5834e40"
},
"patchSecureTokenMove": {
"$ref": "#/x-devx-bundled/ref_7e5445e7e9561dc2e167"
},
"patchSecureTokenRemove": {
"$ref": "#/x-devx-bundled/ref_bd462bdbfedcdb655bb7"
},
"patchSecureTokenReplace": {
"$ref": "#/x-devx-bundled/ref_4e9a6ec939cc1e1b4a7e"
},
"patchSecureTokenTest": {
"$ref": "#/x-devx-bundled/ref_ea51a751962ec64b8d86"
},
"secureToken": {
"$ref": "#/x-devx-bundled/ref_08466de59d13fe2751af"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_bb4eb3fe9ae988b55c71"
}
}
},
"description": "Successful request. We updated the customer's payment details."
},
"400": {
"content": {
"application/problem+json": {
"examples": {
"idempotentKeyInUse": {
"$ref": "#/x-devx-bundled/ref_3917c6024cc650b3ea83"
},
"idempotentKeyMissing": {
"$ref": "#/x-devx-bundled/ref_d9867eacc8169139adec"
},
"validationError": {
"$ref": "#/x-devx-bundled/ref_2b3621a1c5ae119c6693"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_9477586d4a50bb60f5a4"
}
}
},
"description": "Validation error"
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"403": {
"$ref": "#/x-devx-bundled/ref_e17edbd5866b60d4beb9"
},
"404": {
"$ref": "#/x-devx-bundled/ref_49bf9231904bbd9aa1c0"
},
"406": {
"$ref": "#/x-devx-bundled/ref_c791fb405083799347c1"
},
"409": {
"$ref": "#/x-devx-bundled/ref_33a47f40f610a3ad4109"
},
"415": {
"$ref": "#/x-devx-bundled/ref_40869c40b438e4591cbc"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "Partially update secure token",
"tags": [
"Secure tokens"
]
}
},
"/processing-terminals/{processingTerminalId}/secure-tokens/{secureTokenId}/update-account": {
"post": {
"description": "Use this method to update a secure token if you have a single-use token from Hosted Fields. \n\n**Note:** If you don't have a single-use token, you can update saved payment details with our [Update Secure Token](https://docs.payroc.com/api/resources#updateSecureToken) method. For more information about our two options to update a secure token, go to [Update saved payment details](https://docs.payroc.com/guides/take-payments/update-saved-payment-details). \n",
"operationId": "accountUpdate",
"parameters": [
{
"$ref": "#/x-devx-bundled/ref_b92d206f2e50ffc4c068"
},
{
"$ref": "#/x-devx-bundled/ref_3f43c40ece7bf219e047"
},
{
"$ref": "#/x-devx-bundled/ref_9d2f2af2f39a90b039e0"
}
],
"requestBody": {
"content": {
"application/json": {
"examples": {
"accountUpdate": {
"$ref": "#/x-devx-bundled/ref_86ce204cda364b21fc2a"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_142bc03c19d01d9629ce"
}
}
},
"description": "Polymorphic object that contains information about the single-use token.",
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"accountUpdateResponse": {
"$ref": "#/x-devx-bundled/ref_293e87b51ba5db0b6d53"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_bb4eb3fe9ae988b55c71"
}
}
},
"description": "Successful request. We updated the payment details represented by the secure token."
},
"400": {
"$ref": "#/x-devx-bundled/ref_ae89d3d539618a89d2dd"
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"403": {
"$ref": "#/x-devx-bundled/ref_e17edbd5866b60d4beb9"
},
"404": {
"$ref": "#/x-devx-bundled/ref_49bf9231904bbd9aa1c0"
},
"406": {
"$ref": "#/x-devx-bundled/ref_c791fb405083799347c1"
},
"409": {
"$ref": "#/x-devx-bundled/ref_33a47f40f610a3ad4109"
},
"413": {
"$ref": "#/x-devx-bundled/ref_2d8cb91e6a2384abffc7"
},
"415": {
"$ref": "#/x-devx-bundled/ref_40869c40b438e4591cbc"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "Update account details",
"tags": [
"Secure tokens"
]
}
},
"/processing-terminals/{processingTerminalId}/single-use-tokens": {
"post": {
"description": "Use this method to create a single-use token that represents a customer’s payment details. \n\nA single-use token expires after 30 minutes and merchants can use them only once. \n\n**Note:** To create a reusable permanent token, go to [Create Secure Token](https://docs.payroc.com/api/schema/tokenization/secure-tokens/create). \n\nIn the request, send the customer’s payment details. If the request is successful, our gateway returns a token that you can use in a follow-on action, for example, [run a sale](https://docs.payroc.com/api/schema/card-payments/payments/create).\n",
"operationId": "createSingleUseToken",
"parameters": [
{
"$ref": "#/x-devx-bundled/ref_b92d206f2e50ffc4c068"
},
{
"$ref": "#/x-devx-bundled/ref_98165b13204272c0645a"
}
],
"requestBody": {
"content": {
"application/json": {
"examples": {
"createSingleUseToken": {
"$ref": "#/x-devx-bundled/ref_181b399a0b28f6afb5a3"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_8ba1d56e097ef6db192c"
}
}
},
"required": true
},
"responses": {
"201": {
"content": {
"application/json": {
"examples": {
"createSingleUseToken": {
"$ref": "#/x-devx-bundled/ref_8f5a1a5b0001a0830136"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_80b86c970506c2b4c4c6"
}
}
},
"description": "Successful request. We created the single-use token.",
"headers": {
"location": {
"$ref": "#/x-devx-bundled/ref_7b13ec5af2d2b1d9f8e7"
}
}
},
"400": {
"content": {
"application/problem+json": {
"examples": {
"idempotentKeyInUse": {
"$ref": "#/x-devx-bundled/ref_3917c6024cc650b3ea83"
},
"idempotentKeyMissing": {
"$ref": "#/x-devx-bundled/ref_d9867eacc8169139adec"
},
"validationError": {
"$ref": "#/x-devx-bundled/ref_2b3621a1c5ae119c6693"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_9477586d4a50bb60f5a4"
}
}
},
"description": "Validation error"
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"403": {
"$ref": "#/x-devx-bundled/ref_e17edbd5866b60d4beb9"
},
"406": {
"$ref": "#/x-devx-bundled/ref_c791fb405083799347c1"
},
"409": {
"$ref": "#/x-devx-bundled/ref_33a47f40f610a3ad4109"
},
"415": {
"$ref": "#/x-devx-bundled/ref_40869c40b438e4591cbc"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "Create single use token",
"tags": [
"Single use tokens"
]
}
},
"/processing-terminals/{processingTerminalId}/subscriptions": {
"get": {
"description": "Use this method to return a [paginated](https://docs.payroc.com/api/pagination) list of subscriptions. \n\nNote: If you want to view the details of a specific subscription and you have its subscriptionId, use our [Retrieve subscription](https://docs.payroc.com/api/schema/repeat-payments/subscriptions/retrieve) method. \n\nUse query parameters to filter the list of results that we return, for example, to search for subscriptions for a customer, a payment plan, or frequency. \n\nOur gateway returns information about the following for each subscription in the list: \n\n-\tPayment plan the subscription is linked to. \n-\tSecure token that represents cardholder’s payment details. \n-\tCurrent state of the subscription, including its status, next due date, and invoices. \n-\tFees for setup and the cost of the recurring order. \n-\tSubscription length, end date, and frequency. \n\nFor each subscription, we also return the subscriptionId, the paymentPlanId, and the secureTokenId, which you can use to perform follow-actions. \n",
"operationId": "listSubscriptions",
"parameters": [
{
"$ref": "#/x-devx-bundled/ref_3f43c40ece7bf219e047"
},
{
"$ref": "#/x-devx-bundled/ref_7be0b0e9b61342d5719f"
},
{
"$ref": "#/x-devx-bundled/ref_0d2f883617ee5b39f1e1"
},
{
"$ref": "#/x-devx-bundled/ref_15f114d485c46156439d"
},
{
"$ref": "#/x-devx-bundled/ref_713c3c35d5f331b857c8"
},
{
"$ref": "#/x-devx-bundled/ref_35f0540a1f531997dbad"
},
{
"$ref": "#/x-devx-bundled/ref_6acf0a083a03589f9afe"
},
{
"$ref": "#/x-devx-bundled/ref_02f177ed4ef36d758515"
},
{
"$ref": "#/x-devx-bundled/ref_eb4bec06b486e2ceb76c"
},
{
"$ref": "#/x-devx-bundled/ref_e258178e3e59c83f2c9a"
},
{
"$ref": "#/x-devx-bundled/ref_59a42c003a97fcdab712"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"noActivity": {
"$ref": "#/x-devx-bundled/ref_7ad5ac1e2a5096a96273"
},
"paginatedResults": {
"$ref": "#/x-devx-bundled/ref_4343c2f48f88f4bfad94"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_f4dc973b396baa11312d"
}
}
},
"description": "Successful request. Returns a paginated list of subscriptions."
},
"400": {
"$ref": "#/x-devx-bundled/ref_ae89d3d539618a89d2dd"
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"403": {
"$ref": "#/x-devx-bundled/ref_e17edbd5866b60d4beb9"
},
"406": {
"$ref": "#/x-devx-bundled/ref_c791fb405083799347c1"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "List subscriptions",
"tags": [
"Subscriptions"
]
},
"post": {
"description": "Use this method to assign a customer to a payment plan. \n\n**Note:** This method is part of our Repeat Payments feature. To help you understand how this method works with our Payment plans endpoints, go to [Repeat Payments](https://docs.payroc.com/guides/take-payments/repeat-payments). \n\nWhen you create a subscription you need to provide a unique subscriptionId that you use to run follow-on actions: \n\n- [Retrieve Subscription](https://docs.payroc.com/api/schema/repeat-payments/subscriptions/retrieve) - View the details of the subscription.\n- [Update Subscription](https://docs.payroc.com/api/schema/repeat-payments/subscriptions/partially-update) - Update the details of the subscription.\n- [Deactivate Subscription](https://docs.payroc.com/api/schema/repeat-payments/subscriptions/deactivate) - Stop taking payments for the subscription.\n- [Re-activate Subscription](https://docs.payroc.com/api/schema/payments/subscriptions/reactivate) - Start taking payments again for the subscription.\n- [Pay Manual Subscription](https://docs.payroc.com/api/schema/repeat-payments/subscriptions/pay) - Manually collect a payment for the subscription.\n\nThe request includes the following settings:\n- **paymentPlanId** - Unique identifier of the payment plan that the merchant wants to use. If you don't have the paymentPlanId, use our [List Payment Plans](https://docs.payroc.com/api/schema/repeat-payments/payment-plans/list) method to search for the payment plan.\n- **paymentMethod** - Object that contains information about the secure token, which represents the customer's card details or bank account details.\n- **startDate** - Date that you want to start to take payments.\n\nYou can also update the settings that the subscription inherited from the payment plan, for example, you can change the amount for each payment. If you change the settings for the subscription, it doesn't change the settings in the payment plan that it's linked to. \n",
"operationId": "createSubscription",
"parameters": [
{
"$ref": "#/x-devx-bundled/ref_b92d206f2e50ffc4c068"
},
{
"$ref": "#/x-devx-bundled/ref_3f43c40ece7bf219e047"
}
],
"requestBody": {
"content": {
"application/json": {
"examples": {
"createSubscription": {
"$ref": "#/x-devx-bundled/ref_295fbadd8def89ad2675"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_2595b403956d707fcd6b"
}
}
},
"required": true
},
"responses": {
"201": {
"content": {
"application/json": {
"examples": {
"createdSubscription": {
"$ref": "#/x-devx-bundled/ref_0009f5b0f949ead5f25c"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_4c17f383035c3260c513"
}
}
},
"description": "Successful request. We created the subscription.",
"headers": {
"location": {
"$ref": "#/x-devx-bundled/ref_7b13ec5af2d2b1d9f8e7"
}
}
},
"400": {
"content": {
"application/problem+json": {
"examples": {
"idempotentKeyInUse": {
"$ref": "#/x-devx-bundled/ref_3917c6024cc650b3ea83"
},
"idempotentKeyMissing": {
"$ref": "#/x-devx-bundled/ref_d9867eacc8169139adec"
},
"validationError": {
"$ref": "#/x-devx-bundled/ref_2b3621a1c5ae119c6693"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_9477586d4a50bb60f5a4"
}
}
},
"description": "Validation error"
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"403": {
"$ref": "#/x-devx-bundled/ref_e17edbd5866b60d4beb9"
},
"406": {
"$ref": "#/x-devx-bundled/ref_c791fb405083799347c1"
},
"409": {
"$ref": "#/x-devx-bundled/ref_33a47f40f610a3ad4109"
},
"415": {
"$ref": "#/x-devx-bundled/ref_40869c40b438e4591cbc"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "Create subscription",
"tags": [
"Subscriptions"
]
}
},
"/processing-terminals/{processingTerminalId}/subscriptions/{subscriptionId}": {
"get": {
"description": "Use this method to retrieve information about a subscription. \n\nTo retrieve a subscription, you need its subscriptionId. You sent the subscriptionId in the request of the [Create subscription](https://docs.payroc.com/api/schema/repeat-payments/subscriptions/create) method. \n\n**Note:** If you don't have the subscriptionId, use our [List subscriptions](https://docs.payroc.com/api/schema/repeat-payments/subscriptions/list) method to search for the subscription. \n\nOur gateway returns information about the following for the subscription: \n\n-\tPayment plan the subscription is linked to. \n-\tSecure token that represents cardholder’s payment details. \n-\tCurrent state of the subscription, including its status, next due date, and invoices. \n-\tFees for setup and the cost of the recurring order. \n-\tSubscription length, end date, and frequency. \n\nWe also return the paymentPlanId and the secureTokenId, which you can use to perform follow-on actions. \n",
"operationId": "getSubscription",
"parameters": [
{
"$ref": "#/x-devx-bundled/ref_3f43c40ece7bf219e047"
},
{
"$ref": "#/x-devx-bundled/ref_46c3ab48fafb105050ce"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"subscriptionWithConvenienceFee": {
"$ref": "#/x-devx-bundled/ref_89fcab83adb061ef2d38"
},
"subscriptionWithSurcharge": {
"$ref": "#/x-devx-bundled/ref_0009f5b0f949ead5f25c"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_4c17f383035c3260c513"
}
}
},
"description": "Successful request. Returns the requested subscription."
},
"400": {
"$ref": "#/x-devx-bundled/ref_ae89d3d539618a89d2dd"
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"403": {
"$ref": "#/x-devx-bundled/ref_e17edbd5866b60d4beb9"
},
"404": {
"$ref": "#/x-devx-bundled/ref_49bf9231904bbd9aa1c0"
},
"406": {
"$ref": "#/x-devx-bundled/ref_c791fb405083799347c1"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "Retrieve subscription",
"tags": [
"Subscriptions"
]
},
"patch": {
"description": "Use this method to partially update a subscription. Structure your request to follow the [RFC 6902](https://datatracker.ietf.org/doc/html/rfc6902) standard. \n\nTo update a subscription, you need its subscriptionId, which you sent in the request of the [Create subscription](https://docs.payroc.com/api/schema/repeat-payments/subscriptions/create) method. \n\n**Note:** If you don't have the subscriptionId, use our [List subscriptions](https://docs.payroc.com/api/schema/repeat-payments/subscriptions/list) method to search for the payment. \n\nYou can update all of the properties of the subscription except for the following: \n\n**Can't delete** \n- recurringOrder\n- description\n- name\n\n**Can't perform any PATCH operation** \n- currentState\n- type\n- frequency\n- paymentPlan\n",
"operationId": "updateSubscription",
"parameters": [
{
"$ref": "#/x-devx-bundled/ref_b92d206f2e50ffc4c068"
},
{
"$ref": "#/x-devx-bundled/ref_3f43c40ece7bf219e047"
},
{
"$ref": "#/x-devx-bundled/ref_46c3ab48fafb105050ce"
}
],
"requestBody": {
"content": {
"application/json": {
"examples": {
"partiallyUpdateSubscriptionAddRequest": {
"$ref": "#/x-devx-bundled/ref_6c2e65220549847424ca"
},
"partiallyUpdateSubscriptionCopyRequest": {
"$ref": "#/x-devx-bundled/ref_8beaaf9977f01c51e61e"
},
"partiallyUpdateSubscriptionMoveRequest": {
"$ref": "#/x-devx-bundled/ref_7cad9e45de174d69d018"
},
"partiallyUpdateSubscriptionRealisticRequest": {
"$ref": "#/x-devx-bundled/ref_683a00d6631f2fb3d0fc"
},
"partiallyUpdateSubscriptionRemoveRequest": {
"$ref": "#/x-devx-bundled/ref_6d84754d235eee5ffb8f"
},
"partiallyUpdateSubscriptionReplaceRequest": {
"$ref": "#/x-devx-bundled/ref_9678c1bcb34694611388"
},
"partiallyUpdateSubscriptionTestRequest": {
"$ref": "#/x-devx-bundled/ref_d9c7a4f1f108f5d16234"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_83c73ee340defd8c776d"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"partiallyUpdateSubscriptionAddResponse": {
"$ref": "#/x-devx-bundled/ref_9f038e5a45c70c75cf2a"
},
"partiallyUpdateSubscriptionCopyResponse": {
"$ref": "#/x-devx-bundled/ref_e40902e1b8cdc2f5d9d0"
},
"partiallyUpdateSubscriptionMoveResponse": {
"$ref": "#/x-devx-bundled/ref_206c1041aef5b55a3593"
},
"partiallyUpdateSubscriptionRealisticResponse": {
"$ref": "#/x-devx-bundled/ref_4258b3fd029fd38ebdeb"
},
"partiallyUpdateSubscriptionRemoveResponse": {
"$ref": "#/x-devx-bundled/ref_bda909a2af1f621a8dec"
},
"partiallyUpdateSubscriptionReplaceResponse": {
"$ref": "#/x-devx-bundled/ref_1011d61d1eb23132f52d"
},
"partiallyUpdateSubscriptionTestResponse": {
"$ref": "#/x-devx-bundled/ref_89dbf015744cfdf80ef7"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_4c17f383035c3260c513"
}
}
},
"description": "Successful request. We have updated the subscription."
},
"400": {
"content": {
"application/problem+json": {
"examples": {
"idempotentKeyInUse": {
"$ref": "#/x-devx-bundled/ref_3917c6024cc650b3ea83"
},
"idempotentKeyMissing": {
"$ref": "#/x-devx-bundled/ref_d9867eacc8169139adec"
},
"validationError": {
"$ref": "#/x-devx-bundled/ref_2b3621a1c5ae119c6693"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_9477586d4a50bb60f5a4"
}
}
},
"description": "Validation error"
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"403": {
"$ref": "#/x-devx-bundled/ref_e17edbd5866b60d4beb9"
},
"404": {
"$ref": "#/x-devx-bundled/ref_49bf9231904bbd9aa1c0"
},
"406": {
"$ref": "#/x-devx-bundled/ref_c791fb405083799347c1"
},
"409": {
"$ref": "#/x-devx-bundled/ref_33a47f40f610a3ad4109"
},
"415": {
"$ref": "#/x-devx-bundled/ref_40869c40b438e4591cbc"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "Partially update subscription",
"tags": [
"Subscriptions"
]
}
},
"/processing-terminals/{processingTerminalId}/subscriptions/{subscriptionId}/deactivate": {
"post": {
"description": "Use this method to deactivate a subscription. \n\nTo deactivate a subscription, you need its subscriptionId, which you sent in the request of the [Create Subscription](https://docs.payroc.com/api/schema/repeat-payments/subscriptions/create) method. \n\n**Note:** If you don't have the subscriptionId, use our [List Subscriptions](https://docs.payroc.com/api/schema/repeat-payments/subscriptions/list) method to search for the subscription. \n\nIf your request is successful, our gateway stops taking payments from the customer. \n\nTo reactivate the subscription, use our [Reactivate Subscription](https://docs.payroc.com/api/schema/payments/subscriptions/reactivate) method.\n",
"operationId": "deactivateSubscription",
"parameters": [
{
"$ref": "#/x-devx-bundled/ref_3f43c40ece7bf219e047"
},
{
"$ref": "#/x-devx-bundled/ref_46c3ab48fafb105050ce"
}
],
"responses": {
"200": {
"content": {
"application/problem+json": {
"examples": {
"deactivateSubscriptionResponse": {
"$ref": "#/x-devx-bundled/ref_37759ae8dd5a8fe25362"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_4c17f383035c3260c513"
}
}
},
"description": "Successful request. We deactivated the subscription."
},
"400": {
"$ref": "#/x-devx-bundled/ref_ae89d3d539618a89d2dd"
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"403": {
"$ref": "#/x-devx-bundled/ref_e17edbd5866b60d4beb9"
},
"404": {
"$ref": "#/x-devx-bundled/ref_49bf9231904bbd9aa1c0"
},
"406": {
"$ref": "#/x-devx-bundled/ref_c791fb405083799347c1"
},
"409": {
"$ref": "#/x-devx-bundled/ref_33a47f40f610a3ad4109"
},
"415": {
"$ref": "#/x-devx-bundled/ref_40869c40b438e4591cbc"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "Deactivate subscription",
"tags": [
"Subscriptions"
]
}
},
"/processing-terminals/{processingTerminalId}/subscriptions/{subscriptionId}/pay": {
"post": {
"description": "Use this method to manually collect a payment linked to a subscription. You can manually collect a payment only if the merchant chose not to let our gateway automatically collect each payment. \n\nTo manually collect a payment, you need the subscriptionId of the subscription that's linked to the payment. You sent the subscriptionId in the request of the [Create Subscription](https://docs.payroc.com/api/schema/repeat-payments/subscriptions/create) method. \n\n**Note:** If you don't have the subscriptionId, use our [List Subscriptions](https://docs.payroc.com/api/schema/repeat-payments/subscriptions/list) method to search for the subscription. \n\nThe request includes an order object that contains information about the amount that you want to collect. \n\nIn the response, our gateway returns information about the payment and a paymentId. You can use the paymentId in follow-on actions with the [Payments](https://docs.payroc.com/api/schema/card-payments/payments) endpoints or [Bank Transfer Payments](https://docs.payroc.com/api/schema/bank-transfer-payments/payments) endpoints. \n",
"operationId": "paySubscription",
"parameters": [
{
"$ref": "#/x-devx-bundled/ref_b92d206f2e50ffc4c068"
},
{
"$ref": "#/x-devx-bundled/ref_3f43c40ece7bf219e047"
},
{
"$ref": "#/x-devx-bundled/ref_46c3ab48fafb105050ce"
}
],
"requestBody": {
"content": {
"application/json": {
"examples": {
"payManualSubscriptionRequest": {
"$ref": "#/x-devx-bundled/ref_1e958b8002425b1bcda7"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_bcdb0bb281250c51203c"
}
}
},
"required": true
},
"responses": {
"201": {
"content": {
"application/json": {
"examples": {
"payManualSubscriptionResponse": {
"$ref": "#/x-devx-bundled/ref_254febbc2ea11d938a36"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_4d8895b9694561e70dfb"
}
}
},
"description": "Successful request. We have processed the payment for the subscription.",
"headers": {
"location": {
"$ref": "#/x-devx-bundled/ref_7b13ec5af2d2b1d9f8e7"
}
}
},
"400": {
"content": {
"application/problem+json": {
"examples": {
"idempotentKeyInUse": {
"$ref": "#/x-devx-bundled/ref_3917c6024cc650b3ea83"
},
"idempotentKeyMissing": {
"$ref": "#/x-devx-bundled/ref_d9867eacc8169139adec"
},
"validationError": {
"$ref": "#/x-devx-bundled/ref_2b3621a1c5ae119c6693"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_9477586d4a50bb60f5a4"
}
}
},
"description": "Validation error"
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"403": {
"$ref": "#/x-devx-bundled/ref_e17edbd5866b60d4beb9"
},
"404": {
"$ref": "#/x-devx-bundled/ref_49bf9231904bbd9aa1c0"
},
"406": {
"$ref": "#/x-devx-bundled/ref_c791fb405083799347c1"
},
"409": {
"$ref": "#/x-devx-bundled/ref_33a47f40f610a3ad4109"
},
"415": {
"$ref": "#/x-devx-bundled/ref_40869c40b438e4591cbc"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "Pay manual subscription",
"tags": [
"Subscriptions"
]
}
},
"/processing-terminals/{processingTerminalId}/subscriptions/{subscriptionId}/reactivate": {
"post": {
"description": "Use this method to reactivate a subscription. \n\nTo reactivate a subscription, you need its subscriptionId, which you sent in the request of the [Create Subscription](https://docs.payroc.com/api/schema/repeat-payments/subscriptions/create) method. \n\n**Note:** If you don't have the subscriptionId, use our [List Subscriptions](https://docs.payroc.com/api/schema/repeat-payments/subscriptions/list) method to search for the subscription. \n\nIf your request is successful, our gateway restarts taking payments from the customer. \n\nTo deactivate the subscription, use our [Deactivate Subscription](https://docs.payroc.com/api/schema/repeat-payments/subscriptions/deactivate) method.\n",
"operationId": "reactivateSubscription",
"parameters": [
{
"$ref": "#/x-devx-bundled/ref_3f43c40ece7bf219e047"
},
{
"$ref": "#/x-devx-bundled/ref_46c3ab48fafb105050ce"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"subscriptionWithConvenienceFee": {
"$ref": "#/x-devx-bundled/ref_89fcab83adb061ef2d38"
},
"subscriptionWithSurcharge": {
"$ref": "#/x-devx-bundled/ref_0009f5b0f949ead5f25c"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_4c17f383035c3260c513"
}
}
},
"description": "Successful request. We re-activated the subscription."
},
"400": {
"$ref": "#/x-devx-bundled/ref_ae89d3d539618a89d2dd"
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"403": {
"$ref": "#/x-devx-bundled/ref_e17edbd5866b60d4beb9"
},
"404": {
"$ref": "#/x-devx-bundled/ref_49bf9231904bbd9aa1c0"
},
"406": {
"$ref": "#/x-devx-bundled/ref_c791fb405083799347c1"
},
"409": {
"$ref": "#/x-devx-bundled/ref_33a47f40f610a3ad4109"
},
"415": {
"$ref": "#/x-devx-bundled/ref_40869c40b438e4591cbc"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "Re-activate subscription",
"tags": [
"Subscriptions"
]
}
},
"/refund-instructions/{refundInstructionId}": {
"delete": {
"description": "Use this method to cancel a refund instruction. \n\nYou can cancel a refund instruction only if its status is `inProgress`. To retrieve the status of a refund instruction, use our [Retrieve Refund Instruction](https://docs.payroc.com/api/schema/payroc-cloud/refund-instructions/retrieve) method. \n\nTo cancel a refund instruction, you need its refundInstructionId. Our gateway returned the refundInstructionId in the response of the [Submit Refund Instruction](https://docs.payroc.com/api/schema/payroc-cloud/refund-instructions/submit) method. \n",
"operationId": "deleteRefundInstruction",
"parameters": [
{
"$ref": "#/x-devx-bundled/ref_3a43baae7c09cbda0cc5"
}
],
"responses": {
"204": {
"description": "Successful request. We canceled the refund instruction."
},
"400": {
"$ref": "#/x-devx-bundled/ref_ae89d3d539618a89d2dd"
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"403": {
"$ref": "#/x-devx-bundled/ref_e17edbd5866b60d4beb9"
},
"404": {
"$ref": "#/x-devx-bundled/ref_49bf9231904bbd9aa1c0"
},
"406": {
"$ref": "#/x-devx-bundled/ref_c791fb405083799347c1"
},
"409": {
"content": {
"application/problem+json": {
"examples": {
"refundInstructionCompleted": {
"$ref": "#/x-devx-bundled/ref_3eb3e69e2928ecc23241"
},
"refundInstructionFailed": {
"$ref": "#/x-devx-bundled/ref_59d2fac2d442aa906a28"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_478798693738e1bfadb1"
}
}
},
"description": "Conflict"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "Cancel refund instruction",
"tags": [
"Refund instructions"
]
},
"get": {
"description": "Use this method to retrieve information about a refund instruction. \n\nTo retrieve a refund instruction, you need its refundInstructionId. Our gateway returned the refundInstructionId in the response of the [Submit Refund Instruction](https://docs.payroc.com/api/schema/payroc-cloud/refund-instructions/submit) method. \n\nOur gateway returns the status of the refund instruction. If the payment device completed the refund instruction, the response also includes a link to the refund.\n",
"operationId": "getRefundInstruction",
"parameters": [
{
"$ref": "#/x-devx-bundled/ref_3a43baae7c09cbda0cc5"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"retrieveRefundInstructionResponse": {
"$ref": "#/x-devx-bundled/ref_33829c4d66f20fb157cc"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_8625c84fd7dc6d8a6045"
}
}
},
"description": "Successful request. Returns the current status of the requested refund instruction."
},
"400": {
"$ref": "#/x-devx-bundled/ref_ae89d3d539618a89d2dd"
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"403": {
"$ref": "#/x-devx-bundled/ref_e17edbd5866b60d4beb9"
},
"404": {
"$ref": "#/x-devx-bundled/ref_49bf9231904bbd9aa1c0"
},
"406": {
"$ref": "#/x-devx-bundled/ref_c791fb405083799347c1"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "Retrieve refund instruction",
"tags": [
"Refund instructions"
]
}
},
"/refunds": {
"get": {
"description": "Use this method to return a [paginated](https://docs.payroc.com/api/pagination) list of refunds. \n\n**Note:** If you want to view the details of a specific refund and you have its refundId, use our [Retrieve Refund](https://docs.payroc.com/api/schema/card-payments/refunds/retrieve) method. \n\nUse query parameters to filter the list of results that we return, for example, to search for refunds for a customer, a tender type, or a date range.\nOur gateway returns the following information about each refund in the list: \n- Order details, including the refund amount and when we processed the refund.\n- Payment card details, including the masked card number, expiry date, and payment method.\n- Cardholder details, including their contact information and shipping address. \n\nFor referenced refunds, our gateway also returns details about the payment that the refund is linked to.\n",
"operationId": "listRefunds",
"parameters": [
{
"$ref": "#/x-devx-bundled/ref_43adc899006f90cf2a05"
},
{
"$ref": "#/x-devx-bundled/ref_ceeff4dfd8c3b98b1530"
},
{
"$ref": "#/x-devx-bundled/ref_5ca0a24abea9be402684"
},
{
"$ref": "#/x-devx-bundled/ref_9a60d3164ade65bcdbbe"
},
{
"$ref": "#/x-devx-bundled/ref_1055036baa52c3364292"
},
{
"$ref": "#/x-devx-bundled/ref_0685c770b4b5d061663d"
},
{
"$ref": "#/x-devx-bundled/ref_be112c52713ae6148591"
},
{
"$ref": "#/x-devx-bundled/ref_c4591cd9ac15c900cf09"
},
{
"$ref": "#/x-devx-bundled/ref_334757e333e1472fe694"
},
{
"$ref": "#/x-devx-bundled/ref_f2f878b62955a67eeadf"
},
{
"$ref": "#/x-devx-bundled/ref_62193920a3f6b209f7e3"
},
{
"$ref": "#/x-devx-bundled/ref_310c008ff9cb41a59c8a"
},
{
"$ref": "#/x-devx-bundled/ref_eb4bec06b486e2ceb76c"
},
{
"$ref": "#/x-devx-bundled/ref_e258178e3e59c83f2c9a"
},
{
"$ref": "#/x-devx-bundled/ref_59a42c003a97fcdab712"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"noActivity": {
"$ref": "#/x-devx-bundled/ref_7ad5ac1e2a5096a96273"
},
"paginatedResults": {
"$ref": "#/x-devx-bundled/ref_2ff3dcfd5eef52a50a9b"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_e205c60b66e51fa053bf"
}
}
},
"description": "Successful request. Returns a paginated list of refunds."
},
"400": {
"$ref": "#/x-devx-bundled/ref_ae89d3d539618a89d2dd"
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"403": {
"$ref": "#/x-devx-bundled/ref_e17edbd5866b60d4beb9"
},
"406": {
"$ref": "#/x-devx-bundled/ref_c791fb405083799347c1"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "List refunds",
"tags": [
"Refunds"
]
},
"post": {
"description": "Use this method to create an unreferenced refund. An unreferenced refund is a refund that isn't linked to a payment. \n\n**Note:** If you have the paymentId of the payment you want to refund, use our [Refund Payment](https://docs.payroc.com/api/schema/card-payments/refunds/create-referenced-refund) method. If you use our Refund Payment method, our gateway sends the refund amount to the customer's original payment method and links the refund to the payment. \n\nIn the request, you must provide the customer's payment details and the refund amount. \n\nIn the response, our gateway returns information about the refund and a refundId, which you need for the following methods: \n\n- [Retrieve refund](https://docs.payroc.com/api/schema/card-payments/refunds/retrieve) - View the details of the refund. \n- [Adjust refund](https://docs.payroc.com/api/schema/card-payments/refunds/adjust) - Update the details of the refund. \n- [Reverse refund](https://docs.payroc.com/api/schema/card-payments/refunds/reverse-refund) - Cancel the refund if it's in an open batch. \n",
"operationId": "unreferencedRefund",
"parameters": [
{
"$ref": "#/x-devx-bundled/ref_b92d206f2e50ffc4c068"
}
],
"requestBody": {
"content": {
"application/json": {
"examples": {
"refund": {
"$ref": "#/x-devx-bundled/ref_d9295fdced72f843ce0f"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_565ad869517cae1702cb"
}
}
},
"required": true
},
"responses": {
"201": {
"content": {
"application/json": {
"examples": {
"refund": {
"$ref": "#/x-devx-bundled/ref_59da30985adac116998a"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_0a2bb17e6e2a6ad0a66f"
}
}
},
"description": "Successful request. We processed the refund.",
"headers": {
"location": {
"$ref": "#/x-devx-bundled/ref_7b13ec5af2d2b1d9f8e7"
}
}
},
"400": {
"content": {
"application/problem+json": {
"examples": {
"idempotentKeyInUse": {
"$ref": "#/x-devx-bundled/ref_3917c6024cc650b3ea83"
},
"idempotentKeyMissing": {
"$ref": "#/x-devx-bundled/ref_d9867eacc8169139adec"
},
"validationError": {
"$ref": "#/x-devx-bundled/ref_2b3621a1c5ae119c6693"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_9477586d4a50bb60f5a4"
}
}
},
"description": "Validation error"
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"403": {
"$ref": "#/x-devx-bundled/ref_e17edbd5866b60d4beb9"
},
"406": {
"$ref": "#/x-devx-bundled/ref_c791fb405083799347c1"
},
"409": {
"$ref": "#/x-devx-bundled/ref_33a47f40f610a3ad4109"
},
"415": {
"$ref": "#/x-devx-bundled/ref_40869c40b438e4591cbc"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "Create unreferenced refund",
"tags": [
"Refunds"
]
}
},
"/refunds/{refundId}": {
"get": {
"description": "Use this method to retrieve information about a refund. \n\nTo retrieve a refund, you need its refundId. Our gateway returned the refundId in the response of the [Refund Payment](https://docs.payroc.com/api/schema/card-payments/refunds/create-referenced-refund) method or the [Create Refund](https://docs.payroc.com/api/schema/card-payments/refunds/create-unreferenced-refund) method. \n\n**Note:** If you don't have the refundId, use our [List Refunds](https://docs.payroc.com/api/schema/card-payments/refunds/list) method to search for the refund. \n\nOur gateway returns the following information about the refund: \n- Order details, including the refund amount and when we processed the refund.\n- Payment card details, including the masked card number, expiry date, and payment method.\n- Cardholder details, including their contact information and shipping address. \n\nIf the refund is a referenced refund, our gateway also returns details about the payment that the refund is linked to.\n",
"operationId": "getRefund",
"parameters": [
{
"$ref": "#/x-devx-bundled/ref_aba32470cfc5f673a3ca"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"createUnreferencedRefundResponse": {
"$ref": "#/x-devx-bundled/ref_59da30985adac116998a"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_0a2bb17e6e2a6ad0a66f"
}
}
},
"description": "Successful request. Returns the specific refund."
},
"400": {
"$ref": "#/x-devx-bundled/ref_ae89d3d539618a89d2dd"
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"403": {
"$ref": "#/x-devx-bundled/ref_e17edbd5866b60d4beb9"
},
"404": {
"$ref": "#/x-devx-bundled/ref_49bf9231904bbd9aa1c0"
},
"406": {
"$ref": "#/x-devx-bundled/ref_c791fb405083799347c1"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "Retrieve refund",
"tags": [
"Refunds"
]
}
},
"/refunds/{refundId}/adjust": {
"post": {
"description": "Use this method to adjust a refund in an open batch. \n\nTo adjust a refund, you need its refundId. Our gateway returned the refundId in the response of the [Refund Payment](https://docs.payroc.com/api/schema/card-payments/refunds/create-referenced-refund) method or the [Create Refund](https://docs.payroc.com/api/schema/card-payments/refunds/create-unreferenced-refund) method. \n\n**Note:** If you don’t have the refundId, use our [List Refunds](https://docs.payroc.com/api/schema/card-payments/refunds/list) method to search for the refund. \n\nYou can adjust the following details of the refund:\n- Customer details, including shipping address and contact information.\n- Status of the refund. \n\nOur gateway returns information about the adjusted refund, including:\n- Order details, including the refund amount and when we processed the refund.\n- Payment card details, including the masked card number, expiry date, and payment method.\n- Cardholder details, including their contact information and shipping address. \n\nIf the refund is a referenced refund, our gateway also returns details about the payment that the refund is linked to.\n",
"operationId": "adjustRefund",
"parameters": [
{
"$ref": "#/x-devx-bundled/ref_b92d206f2e50ffc4c068"
},
{
"$ref": "#/x-devx-bundled/ref_aba32470cfc5f673a3ca"
}
],
"requestBody": {
"content": {
"application/json": {
"examples": {
"refundRequest": {
"$ref": "#/x-devx-bundled/ref_8177505bb0d79df1e279"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_0d2d04cca3f7442ed518"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"refundResponse": {
"$ref": "#/x-devx-bundled/ref_ed868a8491d301a0b2c9"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_0a2bb17e6e2a6ad0a66f"
}
}
},
"description": "Successful request. We updated the refund."
},
"400": {
"content": {
"application/problem+json": {
"examples": {
"idempotentKeyInUse": {
"$ref": "#/x-devx-bundled/ref_3917c6024cc650b3ea83"
},
"idempotentKeyMissing": {
"$ref": "#/x-devx-bundled/ref_d9867eacc8169139adec"
},
"validationError": {
"$ref": "#/x-devx-bundled/ref_2b3621a1c5ae119c6693"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_9477586d4a50bb60f5a4"
}
}
},
"description": "Validation error"
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"403": {
"$ref": "#/x-devx-bundled/ref_e17edbd5866b60d4beb9"
},
"404": {
"$ref": "#/x-devx-bundled/ref_49bf9231904bbd9aa1c0"
},
"406": {
"$ref": "#/x-devx-bundled/ref_c791fb405083799347c1"
},
"409": {
"$ref": "#/x-devx-bundled/ref_33a47f40f610a3ad4109"
},
"415": {
"$ref": "#/x-devx-bundled/ref_40869c40b438e4591cbc"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "Adjust refund",
"tags": [
"Refunds"
]
}
},
"/refunds/{refundId}/reverse": {
"post": {
"description": "Use this method to cancel a refund in an open batch. \n\nTo cancel a refund, you need its refundId. Our gateway returned the refundId in the response of the [Refund Payment](https://docs.payroc.com/api/schema/card-payments/refunds/create-referenced-refund) or [Create Refund](https://docs.payroc.com/api/schema/card-payments/refunds/create-unreferenced-refund) method. \n\n**Note:** If you don’t have the refundId, use our [List Refunds](https://docs.payroc.com/api/schema/card-payments/refunds/list) method to search for the refund. \n\nIf your request is successful, the gateway removes the refund from the merchant’s open batch and no funds are returned to the cardholder’s account.\n",
"operationId": "reverseRefund",
"parameters": [
{
"$ref": "#/x-devx-bundled/ref_b92d206f2e50ffc4c068"
},
{
"$ref": "#/x-devx-bundled/ref_aba32470cfc5f673a3ca"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"refundResponse": {
"$ref": "#/x-devx-bundled/ref_2343caaf188e4a706e44"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_0a2bb17e6e2a6ad0a66f"
}
}
},
"description": "Successful request. We voided the refund."
},
"400": {
"content": {
"application/problem+json": {
"examples": {
"idempotentKeyInUse": {
"$ref": "#/x-devx-bundled/ref_3917c6024cc650b3ea83"
},
"idempotentKeyMissing": {
"$ref": "#/x-devx-bundled/ref_d9867eacc8169139adec"
},
"validationError": {
"$ref": "#/x-devx-bundled/ref_2b3621a1c5ae119c6693"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_9477586d4a50bb60f5a4"
}
}
},
"description": "Validation error"
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"403": {
"$ref": "#/x-devx-bundled/ref_e17edbd5866b60d4beb9"
},
"404": {
"$ref": "#/x-devx-bundled/ref_49bf9231904bbd9aa1c0"
},
"406": {
"$ref": "#/x-devx-bundled/ref_c791fb405083799347c1"
},
"409": {
"$ref": "#/x-devx-bundled/ref_33a47f40f610a3ad4109"
},
"415": {
"$ref": "#/x-devx-bundled/ref_40869c40b438e4591cbc"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "Reverse refund",
"tags": [
"Refunds"
]
}
},
"/signature-instructions/{signatureInstructionId}": {
"delete": {
"description": "Use this method to cancel a signature instruction. \n\nTo cancel a signature instruction, you need its signatureInstructionId. Our gateway returned the signatureInstructionId in the response of the [Submit signature instruction](https://docs.payroc.com/api/schema/payroc-cloud/signature-instructions/submit) method.\n",
"operationId": "deleteSignatureInstruction",
"parameters": [
{
"$ref": "#/x-devx-bundled/ref_eca55e69eabf5f90e327"
}
],
"responses": {
"204": {
"description": "Successful request. We canceled the signature instruction."
},
"400": {
"$ref": "#/x-devx-bundled/ref_ae89d3d539618a89d2dd"
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"403": {
"$ref": "#/x-devx-bundled/ref_e17edbd5866b60d4beb9"
},
"404": {
"$ref": "#/x-devx-bundled/ref_49bf9231904bbd9aa1c0"
},
"406": {
"$ref": "#/x-devx-bundled/ref_c791fb405083799347c1"
},
"409": {
"content": {
"application/problem+json": {
"examples": {
"signatureInstructionCompleted": {
"$ref": "#/x-devx-bundled/ref_5c3135eefcea7ae15c9c"
},
"signatureInstructionFailed": {
"$ref": "#/x-devx-bundled/ref_0678331d0efb6f01fb11"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_478798693738e1bfadb1"
}
}
},
"description": "Conflict"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "Cancel signature instruction",
"tags": [
"Signature instructions"
]
},
"get": {
"description": "Use this method to retrieve information about a signature instruction. \n\nTo retrieve a signature instruction, you need its signatureInstructionId. Our gateway returned the signatureInstructionId in the response of the [Submit Signature Instruction](https://docs.payroc.com/api/schema/payroc-cloud/signature-instructions/submit) method. \n\nOur gateway returns the status of the instruction. If the payment device completed the instruction, the response also includes a link to retrieve the signature.\n",
"operationId": "getSignatureInstruction",
"parameters": [
{
"$ref": "#/x-devx-bundled/ref_eca55e69eabf5f90e327"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"retrieveSignatureInstructionResponse": {
"$ref": "#/x-devx-bundled/ref_70db04b69eb195758e31"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_93badc2c64529eef6d80"
}
}
},
"description": "Successful request. Returns the signature instruction."
},
"400": {
"$ref": "#/x-devx-bundled/ref_ae89d3d539618a89d2dd"
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"403": {
"$ref": "#/x-devx-bundled/ref_e17edbd5866b60d4beb9"
},
"404": {
"$ref": "#/x-devx-bundled/ref_49bf9231904bbd9aa1c0"
},
"406": {
"$ref": "#/x-devx-bundled/ref_c791fb405083799347c1"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "Retrieve signature instruction",
"tags": [
"Signature instructions"
]
}
},
"/signatures/{signatureId}": {
"get": {
"description": "Use this method to retrieve a signature that a payment device captured using Payroc Cloud. \n\nOur gateway returns the following information about the signature:\n- Image of the signature\n- Format of the image\n- Date that the device captured the image\n",
"operationId": "retrieveSignature",
"parameters": [
{
"$ref": "#/x-devx-bundled/ref_78f791814858a9abb9ae"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"signature": {
"$ref": "#/x-devx-bundled/ref_97b71715757430566ace"
}
},
"schema": {
"properties": {
"contentType": {
"description": "MIME type that indicates the format of the image file.",
"example": "image/png",
"type": "string"
},
"createdOn": {
"description": "Date that the device captured the signature. The format of this value is **YYYY-MM-DD**.",
"example": "2024-07-02",
"format": "date",
"type": "string"
},
"processingTerminalId": {
"description": "Unique identifier of the terminal that the signature is linked to.",
"example": "1234001",
"type": "string"
},
"signature": {
"description": "Image data for the signature. Our gateway returns the signature as a Base64-encoded value.",
"example": "iVBORw0KGgoAAAANSUhEUgAAAoAAAAHgCAYAAAA10dzkAAAABHNCSVQICAgIfAhkiAAAAAlwSFlzAAALEgAACxIB0t1+/AAAADh0RVh0U29mdHdhcmUAbWF0cGxvdGxpYiB2ZXJzaW9uMy4xLjMsIGh0dHA6Ly9tYXRwbG90bGliLm9yZy+AADFEAAAgAElEQVR4nO3df5DkVZ3/8c+7s",
"type": "string"
},
"signatureId": {
"description": "Unique identifier that we assigned to the signature.",
"example": "JDN4ILZB0T",
"type": "string"
}
},
"type": "object"
}
}
},
"description": "Successful request. Returns the signature."
},
"400": {
"$ref": "#/x-devx-bundled/ref_ae89d3d539618a89d2dd"
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"403": {
"$ref": "#/x-devx-bundled/ref_e17edbd5866b60d4beb9"
},
"404": {
"$ref": "#/x-devx-bundled/ref_49bf9231904bbd9aa1c0"
},
"406": {
"$ref": "#/x-devx-bundled/ref_c791fb405083799347c1"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "Retrieve signature",
"tags": [
"Signatures"
]
}
},
"/terminal-orders/{terminalOrderId}": {
"get": {
"description": "Use this method to retrieve information about a terminal order. \n\nTo retrieve a terminal order, you need it's terminalOrderId. Our gateway returned the terminalOrderId in the response of the [Create Terminal Order](https://docs.payroc.com/api/schema/boarding/processing-accounts/create-terminal-order) method. \n\n**Note**: If you don't have the terminalOrderId, use our [List Terminal Orders](https://docs.payroc.com/api/schema/boarding/processing-accounts/list-terminal-orders) method to search for the terminal order. \n\nOur gateway returns the following information about the terminal order: \n- Status of the order \n- Items in the order \n- Training provider \n- Shipping information \n\n**Note**: You can subscribe to our terminalOrder.status.changed event to get notifications when we update the status of a terminal order. For more information about how to subscribe to events, go to [Events Subscriptions](https://docs.payroc.com/guides/board-merchants/event-subscriptions). \n",
"operationId": "getTerminalOrder",
"parameters": [
{
"$ref": "#/x-devx-bundled/ref_7115d17448ae36aa6f18"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"retrieveTerminalOrderResponse": {
"$ref": "#/x-devx-bundled/ref_b0282f068ebbc85b31df"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_965109f2a9a48b5186c7"
}
}
},
"description": "Successful request. Returns the terminal order."
},
"400": {
"$ref": "#/x-devx-bundled/ref_ae89d3d539618a89d2dd"
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"403": {
"$ref": "#/x-devx-bundled/ref_e17edbd5866b60d4beb9"
},
"404": {
"$ref": "#/x-devx-bundled/ref_49bf9231904bbd9aa1c0"
},
"406": {
"$ref": "#/x-devx-bundled/ref_c791fb405083799347c1"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "Retrieve terminal order",
"tags": [
"Terminal orders"
]
}
},
"/transactions": {
"get": {
"description": "Use this method to return a paginated list of your merchants’ transactions. \n\n**Note:** If you want to view the details of a specific transaction and you have its transactionId, use our [Retrieve Transaction](https://docs.payroc.com/api/schema/reporting/settlement/retrieve-transaction) method. \n\nUse query parameters to filter the list of results that we return, for example, to search for transactions for a specific merchant. \n\n> **Important:** You must provide a value for either the date query parameter or the batchId query parameter. \n\nOur gateway returns the following information about each transaction in the list: \n\n-\tMerchant and processing account that ran the transaction. \n-\tTransaction type, date, amount, and the payment method that the customer used. \n-\tBatch that contains the transaction, and authorization details for the transaction. \n-\tProcessor that settled the transaction and the ACH deposit containing the transaction. \n",
"operationId": "getTransactions",
"parameters": [
{
"$ref": "#/x-devx-bundled/ref_eb4bec06b486e2ceb76c"
},
{
"$ref": "#/x-devx-bundled/ref_e258178e3e59c83f2c9a"
},
{
"$ref": "#/x-devx-bundled/ref_59a42c003a97fcdab712"
},
{
"$ref": "#/x-devx-bundled/ref_c44068086d1083ebf58a"
},
{
"$ref": "#/x-devx-bundled/ref_39b2977516ad960a5b10"
},
{
"$ref": "#/x-devx-bundled/ref_ea59515d841f46f0d0e1"
},
{
"$ref": "#/x-devx-bundled/ref_da83b3b247e47a3a0932"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"noActivity": {
"$ref": "#/x-devx-bundled/ref_7ad5ac1e2a5096a96273"
},
"paginatedList": {
"$ref": "#/x-devx-bundled/ref_ee82e5cfe4fc68200074"
}
},
"schema": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_f9d963d00740bbe00c9e"
},
{
"properties": {
"data": {
"description": "Array of transaction objects.",
"items": {
"$ref": "#/x-devx-bundled/ref_d6a1eaa6dc26dc07f865"
},
"type": "array"
}
},
"required": [
"data"
],
"type": "object"
}
],
"type": "object"
}
}
},
"description": "Successful request. Returns a paginated list of transactions."
},
"400": {
"content": {
"application/problem+json": {
"examples": {
"paginationError": {
"$ref": "#/x-devx-bundled/ref_b394dd97f528cb101adf"
},
"parameterError": {
"$ref": "#/x-devx-bundled/ref_33e366b095d33923fb79"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_9477586d4a50bb60f5a4"
}
}
},
"description": "Validation error"
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"403": {
"$ref": "#/x-devx-bundled/ref_e17edbd5866b60d4beb9"
},
"406": {
"$ref": "#/x-devx-bundled/ref_c791fb405083799347c1"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "List transactions",
"tags": [
"Settlement"
]
}
},
"/transactions/{transactionId}": {
"get": {
"description": "Use this method to retrieve information about a transaction. \n\n**Note:** To retrieve a transaction, you need its transactionId. If you don't have the transactionId, use our [List Transactions](https://docs.payroc.com/api/schema/reporting/settlement/list-transactions) method to search for the transaction. \n\nOur gateway returns the following information about the transaction: \n\n-\tMerchant and processing account that ran the transaction. \n-\tTransaction type, date, amount, and the payment method that the customer used. \n-\tBatch that contains the transaction, and authorization details for the transaction. \n-\tProcessor that settled the transaction and the ACH deposit containing the transaction. \n",
"operationId": "gettransaction",
"parameters": [
{
"$ref": "#/x-devx-bundled/ref_8f713db43a6183e37a14"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"retrieveTransactionResponse": {
"$ref": "#/x-devx-bundled/ref_3aa89aa0e868ef0b24d4"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_d6a1eaa6dc26dc07f865"
}
}
},
"description": "Successful request. Returns the requested transaction."
},
"400": {
"content": {
"application/problem+json": {
"examples": {
"transactionIdError": {
"$ref": "#/x-devx-bundled/ref_e7cf09f3bd34113e7f73"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_9477586d4a50bb60f5a4"
}
}
},
"description": "Validation error"
},
"401": {
"$ref": "#/x-devx-bundled/ref_d8cd14845770b321a0d8"
},
"403": {
"$ref": "#/x-devx-bundled/ref_e17edbd5866b60d4beb9"
},
"404": {
"$ref": "#/x-devx-bundled/ref_49bf9231904bbd9aa1c0"
},
"406": {
"$ref": "#/x-devx-bundled/ref_c791fb405083799347c1"
},
"500": {
"$ref": "#/x-devx-bundled/ref_283b52ea9b7aa2800220"
}
},
"summary": "Retrieve transaction",
"tags": [
"Settlement"
]
}
}
},
"security": [
{
"bearerAuth": []
}
],
"servers": [
{
"description": "Production",
"url": "https://api.payroc.com/v1"
},
{
"description": "UAT",
"url": "https://api.uat.payroc.com/v1"
}
],
"tags": [
{
"description": "An Apple Pay session authenticates the merchant's domain with Apple. After you start an Apple Pay session, you can use the Apple Pay JS API to retrieve the cardholder's encrypted payment details.",
"name": "Apple Pay session"
},
{
"description": "Upload files as attachments.",
"name": "Attachments"
},
{
"description": "Validate bank account information.",
"name": "Bank accounts"
},
{
"description": "Take bank-transfer payments.",
"name": "Bank transfer payments"
},
{
"description": "Return payments to customers' bank accounts.",
"name": "Bank transfer refunds"
},
{
"description": "Validate card information.",
"name": "Cards"
},
{
"description": "Retrieve closed-loop read data.",
"name": "Closed-loop reads"
},
{
"description": "Individuals who serve as points of contact for the business.",
"name": "Contacts"
},
{
"description": "Offer dynamic currency conversion to customers.",
"name": "Currency conversion"
},
{
"description": "Manage devices.",
"name": "Devices"
},
{
"description": "Create an event subscription so that we notify you when certain events occur, for example, when we change the status of a processing account. \nWhen you subscribe to an event, provide the following information: \n - **Event type** - The events that we should notify you about. You can subscribe to more than one event within the same request. For a list of events that you can subscribe to, go to [Events](https://docs.payroc.com/knowledge/basic-concepts/events). \n - **Notification method** - The endpoint that we send a notification to if an event occurs. We send notifications by webhook request. \n - **Event status** - The status of the event subscription. \n - **Support email address** - Email address that we contact if we can't deliver notifications. \n
\nUse our event subscriptions endpoint to do the following: \n- [**Create event subscription**](https://docs.payroc.com/api/schema/notifications/event-subscriptions/create) - Subscribe to receive notifications when events occur. \n- [**Update event subscription**](https://docs.payroc.com/api/schema/notifications/event-subscriptions/update) - Change the details of an event subscription, for example, to receive notifications for an additional event. \n- [**Partially update an event subscription**](https://docs.payroc.com/api/schema/notifications/event-subscriptions/partially-update) - Change values of an existing event subscription. \n- [**Retrieve an event subscription**](https://docs.payroc.com/api/schema/notifications/event-subscriptions/retrieve) - Retrieve all the information that we stored in an event subscription. \n- [**List event subscriptions**](https://docs.payroc.com/api/schema/notifications/event-subscriptions/list) - Retrieve a list of all event subscriptions associated with the ISV's account. \n- [**Delete event subscription**](https://docs.payroc.com/api/schema/notifications/event-subscriptions/delete)\n",
"name": "Event Subscriptions"
},
{
"description": "Financial accounts associated with entities.",
"name": "Funding accounts"
},
{
"description": "Activity associated with a payfac account.",
"name": "Funding activity"
},
{
"description": "Instructions on how to split fund between recipients.",
"name": "Funding instructions"
},
{
"description": "Entities that can receive funding but not take payments",
"name": "Funding recipients"
},
{
"description": "Create a Hosted Fields session.",
"name": "Hosted Fields"
},
{
"description": "A merchant platform is an entity that represents a business and includes its legal information and all processing accounts.
\nAfter you create a merchant platform for a business, you can do the following: \n - [Create and add an additional processing account to a merchant platform.](https://docs.payroc.com/api/schema/boarding/merchant-platforms/create-processing-account) \n - [Retrieve a merchant platform.](https://docs.payroc.com/api/schema/boarding/merchant-platforms/retrieve) \n - [Retrieve a list of merchant platforms.](https://docs.payroc.com/api/schema/boarding/merchant-platforms/list) \n - [Retrieve a list of open processing accounts that are linked to a merchant platform.](https://docs.payroc.com/api/schema/boarding/merchant-platforms/list-processing-accounts) \n \n \nFor more information about boarding a merchant, go to our [Board a merchant](https://docs.payroc.com/guides/board-merchants/boarding) guide.\n",
"name": "Merchant platforms"
},
{
"description": "Individuals who own or control the business.",
"name": "Owners"
},
{
"description": "Submit instructions for initiating payments on physical devices running semi-integrated apps.",
"name": "Payment instructions"
},
{
"description": "Retrieve payment intents.",
"name": "Payment intents"
},
{
"description": "Create and share payment links.",
"name": "Payment links"
},
{
"description": "Create and manage payment plans.",
"name": "Payment plans"
},
{
"description": "Take card payments.",
"name": "Payments"
},
{
"description": "Create and manage pricing intents.",
"name": "Pricing intents"
},
{
"description": "Create and manage processing accounts.",
"name": "Processing accounts"
},
{
"description": "Retrieve processing terminals",
"name": "Processing terminals"
},
{
"description": "Submit instructions for initiating refunds on physical devices running semi-integrated apps.",
"name": "Refund instructions"
},
{
"description": "Return payments to customers.",
"name": "Refunds"
},
{
"description": "Save customers' payment details.",
"name": "Secure tokens"
},
{
"description": "Settlement information",
"name": "Settlement"
},
{
"description": "Submit instructions for capturing signatures on physical devices running semi-integrated apps.",
"name": "Signature instructions"
},
{
"description": "Retrieve signatures.",
"name": "Signatures"
},
{
"description": "Create temporary single-use tokens.",
"name": "Single use tokens"
},
{
"description": "Subscribe customers to payment plans.",
"name": "Subscriptions"
},
{
"description": "Place and retrieve terminal orders.",
"name": "Terminal orders"
},
{
"description": "Manage end-of-day settlements.",
"name": "Terminal settlements"
}
],
"x-tagGroups": [
{
"name": "Attachments",
"tags": [
"Attachments"
]
},
{
"name": "Boarding",
"tags": [
"Contacts",
"Devices",
"Merchant platforms",
"Owners",
"Pricing intents",
"Processing accounts",
"Processing terminals",
"Terminal orders",
"Payment intents"
]
},
{
"name": "Payroc Cloud",
"tags": [
"Payment instructions",
"Refund instructions",
"Signature instructions"
]
},
{
"name": "Payments",
"tags": [
"Apple Pay session",
"Bank accounts",
"Bank transfer payments",
"Bank transfer refunds",
"Cards",
"Closed-loop reads",
"Currency conversion",
"Hosted Fields",
"Payments",
"Payment links",
"Payment plans",
"Refunds",
"Secure tokens",
"Signatures",
"Single use tokens",
"Subscriptions",
"Terminal settlements"
]
},
{
"name": "Funding",
"tags": [
"Funding accounts",
"Funding instructions",
"Funding recipients",
"Funding activity"
]
},
{
"name": "Reporting",
"tags": [
"Settlement"
]
},
{
"name": "Notifications",
"tags": [
"Event Subscriptions"
]
}
],
"x-devx-bundled": {
"ref_0009f5b0f949ead5f25c": {
"description": "Subscription with surcharge",
"summary": "Subscription with surcharge",
"value": {
"currency": "USD",
"currentState": {
"nextDueDate": "2024-08-02",
"outstandingInvoices": 3,
"paidInvoices": 0,
"status": "active"
},
"customFields": [
{
"name": "yourCustomField",
"value": "abc123"
}
],
"description": "Premium Club subscription",
"endDate": "2025-07-01",
"frequency": "monthly",
"length": 12,
"name": "Premium Club",
"pauseCollectionFor": 0,
"paymentPlan": {
"link": {
"href": "https://api.payroc.com/v1/processing-terminals/1234001/payment-plans/PlanRef8765",
"method": "GET",
"rel": "self"
},
"name": "Monthly Premium Club subscription",
"paymentPlanId": "PlanRef8765"
},
"processingTerminalId": "1234001",
"recurringOrder": {
"amount": 4999,
"breakdown": {
"subtotal": 4347,
"surcharge": {
"amount": 217,
"percentage": 5
},
"taxes": [
{
"name": "Sales Tax",
"rate": 5
}
]
},
"description": "Premium Club subscription"
},
"secureToken": {
"customerName": "Sarah Hazel Hopper",
"link": {
"href": "https://api.payroc.com/v1/processing-terminals/1234001/secure-tokens/MREF_abc1de23-f4a5-6789-bcd0-12e345678901fa",
"method": "GET",
"rel": "self"
},
"secureTokenId": "MREF_abc1de23-f4a5-6789-bcd0-12e345678901fa",
"status": "notValidated",
"token": "296753123456"
},
"setupOrder": {
"amount": 4999,
"breakdown": {
"subtotal": 4347,
"surcharge": {
"amount": 217,
"percentage": 5
},
"taxes": [
{
"name": "Sales Tax",
"rate": 5
}
]
},
"description": "Initial setup fee for Premium Club subscription",
"orderId": "OrderRef6543"
},
"startDate": "2024-07-02",
"subscriptionId": "SubRef7654",
"type": "automatic"
}
},
"ref_0064ca7c922c5bfd664c": {
"description": "Create a pricing intent.",
"summary": "Tiered 6",
"value": {
"base": {
"addressVerification": 5,
"annualFee": {
"amount": 9900,
"billInMonth": "june"
},
"batch": 1500,
"chargeback": 2500,
"earlyTermination": 57500,
"maintenance": 500,
"minimum": 100,
"pciNonCompliance": 4995,
"platinumSecurity": {
"billingFrequency": "monthly"
},
"regulatoryAssistanceProgram": 15,
"retrieval": 1500,
"voiceAuthorization": 95
},
"country": "US",
"gateway": {
"fees": {
"monthly": 2000,
"perDeviceMonthly": 10,
"perTransaction": 2000,
"setup": 5000
}
},
"key": "Your-Unique-Identifier",
"metadata": {
"yourCustomField": "abc123"
},
"processor": {
"ach": {
"fees": {
"accountVerification": 10,
"batch": 5,
"discountRateAbove10000": 1,
"discountRateUnder10000": 0.5,
"monthlyMinimum": 500,
"returns": 400,
"statement": 250,
"transaction": 50,
"unauthorizedReturn": 500
}
},
"card": {
"fees": {
"amex": {
"midQualRate": {
"transaction": 0,
"volume": 1.75
},
"nonQualRate": {
"transaction": 0,
"volume": 3.84
},
"qualifiedRate": {
"transaction": 0,
"volume": 1.39
},
"type": "optBlue"
},
"mastercardVisaDiscover": {
"midQualRate": {
"transaction": 0,
"volume": 1.75
},
"nonQualRate": {
"transaction": 0,
"volume": 3.84
},
"premiumRate": {
"transaction": 5,
"volume": 1.9
},
"qualifiedRate": {
"transaction": 0,
"volume": 1.39
},
"regulatedCheckCard": {
"transaction": 5,
"volume": 1.25
},
"unregulatedCheckCard": {
"transaction": 5,
"volume": 1.45
}
}
},
"planType": "tiered6"
}
},
"services": [
{
"enabled": true,
"name": "hardwareAdvantagePlan"
}
],
"version": "5.2"
}
},
"ref_01a894a1ad862c50b69d": {
"properties": {
"autoCapture": {
"default": true,
"description": "Indicates if we should automatically capture the payment amount. \n\n- `true` - Run a sale and automatically capture the transaction.\n- `false`- Run a pre-authorization and capture the transaction later. \n \n**Note:** If you send `false` and the terminal doesn't support pre-authorization, we set the transaction's status to pending. The merchant must capture the transaction to take payment from the customer.\n",
"example": true,
"type": "boolean"
},
"channel": {
"description": "Channel that the merchant used to receive the payment details.",
"enum": [
"pos",
"web",
"moto"
],
"example": "web",
"type": "string"
},
"credentialOnFile": {
"$ref": "#/x-devx-bundled/ref_ef5e9a924c7ad31c29ce"
},
"customFields": {
"description": "Array of customField objects.\n",
"items": {
"$ref": "#/x-devx-bundled/ref_91509fee696e20aa30f2"
},
"type": "array"
},
"customer": {
"$ref": "#/x-devx-bundled/ref_1674621e10fb2f321406"
},
"ipAddress": {
"$ref": "#/x-devx-bundled/ref_da456c8e931765f569e4"
},
"offlineProcessing": {
"$ref": "#/x-devx-bundled/ref_e280ad413a994c0b7ccc"
},
"operator": {
"description": "Operator who ran the transaction.",
"example": "Jane",
"maxLength": 50,
"minLength": 0,
"type": "string"
},
"order": {
"$ref": "#/x-devx-bundled/ref_d27c21dc4044d83a551b"
},
"paymentMethod": {
"description": "Polymorphic object that contains payment details. \n\nThe value of the type parameter determines which variant you should use: \n-\t`card` - Payment card details\n-\t`secureToken` - Secure token details\n-\t`digitalWallet` - Digital wallet details\n-\t`singleUseToken` - Single-use token details\n",
"discriminator": {
"mapping": {
"card": "../../../common/schemas/transaction/payment-method-v1.yaml#/components/schemas/cardPayload",
"digitalWallet": "../../../common/schemas/transaction/payment-method-v1.yaml#/components/schemas/digitalWalletPayload",
"secureToken": "../../../common/schemas/transaction/payment-method-v1.yaml#/components/schemas/secureTokenPayload",
"singleUseToken": "../../../common/schemas/transaction/payment-method-v1.yaml#/components/schemas/singleUseTokenPayload"
},
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/x-devx-bundled/ref_d7a78654a15a2c87ffaa"
},
{
"$ref": "#/x-devx-bundled/ref_8a84ce450c6452ba8861"
},
{
"$ref": "#/x-devx-bundled/ref_f4b6c313f736a4a4eef8"
},
{
"$ref": "#/x-devx-bundled/ref_9c8bcc4b28365a7b7f70"
}
],
"type": "object"
},
"processAsSale": {
"default": false,
"description": "Indicates if we should immediately settle the sale transaction. The merchant cannot adjust the transaction if we immediately settle it. \n\n**Note:** If the value for **processAsSale** is `true`, the gateway ignores the value in **autoCapture**.\n",
"example": false,
"type": "boolean"
},
"processingTerminalId": {
"description": "Unique identifier that we assigned to the terminal.",
"example": "1234001",
"maxLength": 50,
"minLength": 4,
"type": "string"
},
"threeDSecure": {
"description": "Polymorphic object that contains authentication information from 3-D Secure. \n\nThe value of the serviceProvider parameter determines which variant you should use: \n-\t`gateway` - Use our gateway to run a 3-D Secure check.\n-\t`thirdParty` - Use a third party to run a 3-D Secure check.\n",
"discriminator": {
"mapping": {
"gateway": "../../../common/schemas/transaction/three-d-secure-v1.yaml#/components/schemas/gatewayThreeDSecure",
"thirdParty": "../../../common/schemas/transaction/three-d-secure-v1.yaml#/components/schemas/thirdPartyThreeDSecure"
},
"propertyName": "serviceProvider"
},
"oneOf": [
{
"$ref": "#/x-devx-bundled/ref_28d1459a8daa1b3d6ae5"
},
{
"$ref": "#/x-devx-bundled/ref_eea40aa5ad1960d5cfae"
}
],
"type": "object"
}
},
"required": [
"channel",
"order",
"paymentMethod",
"processingTerminalId"
],
"type": "object"
},
"ref_01f55c7b2d1709665555": {
"description": "Object that contains information about the processor fees.",
"properties": {
"transaction": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_109fe7e5f018de7ee04b"
}
],
"description": "Fee for each transaction. The value is in the currency's lowest denomination, for example, cents."
},
"volume": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_d3797fc41828d98b6e34"
}
],
"description": "Percentage of total transaction amount that the processor charges the merchant."
}
},
"title": "Processor Fee",
"type": "object"
},
"ref_02bc8dae9d717a1f1e16": {
"description": "The value for the processor in the request is not recognized.",
"summary": "Unrecognized processor",
"value": {
"detail": "Your request contained an unrecognized processor.",
"errors": [
{
"detail": "Unrecognized processor.",
"message": "The value provided is not a recognized processor. Send a value of 'tsys' or 'fiserv'.",
"parameter": "processingAccounts[0].processor"
}
],
"status": 400,
"title": "One or more validation errors occurred.",
"type": "https://docs.payroc.com/api/errors#bad-request"
}
},
"ref_02f177ed4ef36d758515": {
"description": "Format: `YYYY-MM-DD` \nFilter subscriptions by the date that the next payment is collected.\n",
"examples": {
"example": {
"value": "2024-08-01"
}
},
"in": "query",
"name": "nextDueDate",
"schema": {
"format": "date",
"type": "string"
}
},
"ref_03121a5c54d7fd9b8c46": {
"properties": {
"detail": {
"description": "Explanation of the problem",
"example": "You do not have the required permissions to perform this action",
"type": "string"
},
"status": {
"description": "Http status code",
"example": 401,
"type": "integer"
},
"title": {
"description": "Short description of the issue.",
"example": "Not Authorized",
"type": "string"
},
"type": {
"description": "URI reference identifying the problem type",
"example": "https://docs.payroc.com/api/errors#not-authorized",
"type": "string"
}
},
"required": [
"type",
"title",
"status",
"detail"
],
"type": "object"
},
"ref_0331fceeaf098c1c9e92": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_31d3b813b1b175136a5f"
},
{
"properties": {
"taxes": {
"description": "Array of tax objects.",
"items": {
"$ref": "#/x-devx-bundled/ref_a52bfba93be1ce659766"
},
"type": "array"
}
},
"type": "object"
}
],
"description": "Object that contains information about the taxes to apply to the transaction.\n",
"required": [
"subtotal"
],
"type": "object"
},
"ref_0378dbfda3aaeccfef2d": {
"description": "Bank Transfer Payment",
"summary": "Bank Transfer Payment",
"value": {
"count": 2,
"data": [
{
"bankAccount": {
"accountNumber": "*******3159",
"institutionNumber": "543",
"nameOnAccount": "Sarah Hazel Hopper",
"transitNumber": "76543",
"type": "pad"
},
"customer": {
"contactMethods": [
{
"type": "email",
"value": "sarah.hopper@example.com"
}
],
"notificationLanguage": "en"
},
"order": {
"amount": 4999,
"breakdown": {
"subtotal": 4347,
"taxes": [
{
"amount": 217,
"name": "Sales Tax",
"rate": 5
}
],
"tip": {
"amount": 435,
"percentage": 10,
"type": "percentage"
}
},
"currency": "USD",
"dateTime": "2024-07-02T15:30:00Z",
"description": "Large Pepperoni Pizza",
"orderId": "OrderRef6543"
},
"paymentId": "M2MJOG6O2Y",
"processingTerminalId": "1234001",
"transactionResult": {
"authorizedAmount": 4999,
"currency": "USD",
"responseCode": "A",
"status": "ready",
"type": "payment"
}
},
{
"bankAccount": {
"accountNumber": "*******7890",
"institutionNumber": "543",
"nameOnAccount": "Sarah Hazel Hopper",
"transitNumber": "76543",
"type": "pad"
},
"customFields": [
{
"name": "yourCustomField",
"value": "abc123"
}
],
"customer": {
"contactMethods": [
{
"type": "email",
"value": "sarah.hopper@example.com"
}
],
"notificationLanguage": "en"
},
"order": {
"amount": 3999,
"breakdown": {
"subtotal": 3477,
"taxes": [
{
"amount": 174,
"name": "Sales Tax",
"rate": 5
}
],
"tip": {
"amount": 348,
"percentage": 10,
"type": "percentage"
}
},
"currency": "USD",
"dateTime": "2024-07-02T15:30:00Z",
"description": "test",
"orderId": "OrderRef7654"
},
"paymentId": "E29U8OU8Q4",
"processingTerminalId": "1234001",
"transactionResult": {
"authorizedAmount": 3999,
"currency": "USD",
"responseCode": "A",
"status": "ready",
"type": "payment"
}
}
],
"hasMore": true,
"limit": 2,
"links": [
{
"href": "https://api.payroc.com/v1/bank-transfer-payments?limit=2&processingTerminalId=1234001&after=E29U8OU8Q4",
"method": "get",
"rel": "next"
},
{
"href": "https://api.payroc.com/v1//bank-transfer-payments?limit=2&processingTerminalId=1234001&before=M2MJOG6O2Y",
"method": "get",
"rel": "previous"
}
]
}
},
"ref_0476f87aaec738b51c8e": {
"description": "Object that contains the customer's card details.",
"properties": {
"cardNumber": {
"description": "Primary account number of the customer's card.",
"example": "4539858876047062",
"maxLength": 19,
"minLength": 12,
"type": "string"
},
"cardType": {
"description": "Card brand of the card, for example, Visa.",
"type": "string"
},
"cardholderName": {
"description": "Cardholder's name.",
"example": "Sarah Hazel Hopper",
"maxLength": 50,
"minLength": 1,
"type": "string"
},
"currency": {
"$ref": "#/x-devx-bundled/ref_5c51a0e852c4baa940d0"
},
"debit": {
"description": "Indicates if the card is a debit card.",
"type": "boolean"
},
"expiryDate": {
"description": "Expiry date of the customer's card.",
"example": "1230",
"pattern": "[0-9]{4}",
"type": "string"
},
"surcharging": {
"$ref": "#/x-devx-bundled/ref_4dd307ea31db18202b97"
},
"type": {
"description": "Type of payment.",
"enum": [
"card"
],
"example": "card",
"type": "string"
}
},
"required": [
"type",
"cardholderName",
"cardNumber"
],
"title": "Card",
"type": "object"
},
"ref_049dcd8f29853ec0de7d": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_3a6cea3ae4d5bf94543f"
},
{
"properties": {
"convenienceFee": {
"$ref": "#/x-devx-bundled/ref_73ccf7ffa65b9a82668c"
},
"dutyAmount": {
"description": "Amount of duties or fees that apply to the order. The value is in the currency's lowest denomination, for example, cents.\n\nRequired for [Level 3 and CEDP transactions](https://docs.payroc.com/knowledge/card-payments/enhanced-data).\n",
"example": 0,
"format": "int64",
"type": "integer"
},
"freightAmount": {
"description": "Amount for shipping in the currency's lowest denomination, for example, cents.\n\nRequired for [Level 3 and CEDP transactions](https://docs.payroc.com/knowledge/card-payments/enhanced-data).\n",
"example": 0,
"format": "int64",
"type": "integer"
},
"items": {
"description": "Array of objects that contain information about each item that the customer purchased.\n\nContains parameters required for [Level 3 and CEDP transactions](https://docs.payroc.com/knowledge/card-payments/enhanced-data).\n",
"items": {
"$ref": "#/x-devx-bundled/ref_33de603adc39427fa180",
"description": "Array of 'lineItem' objects. Each object contains information about the items in the transaction."
},
"type": "array"
}
},
"type": "object"
}
],
"description": "Object that contains information about the breakdown of the transaction.\n\nContains parameters required for [Level 2, Level 3, and CEDP transactions](https://docs.payroc.com/knowledge/card-payments/enhanced-data).\n",
"required": [
"subtotal"
],
"type": "object"
},
"ref_04eec39981f6e77f8e6b": {
"description": "Unique identifier that we assigned to the processing account.",
"examples": {
"example": {
"value": "38765"
}
},
"in": "path",
"name": "processingAccountId",
"required": true,
"schema": {
"type": "string"
}
},
"ref_05105d02b9d70ef97d64": {
"description": "An addendum entry is missing fields that are required, for example, cloverMerchantProcessingAmendment entry must include lineItems.",
"summary": "Addendum missing required fields",
"value": {
"detail": "Your request contained an addendum entry that is missing required fields.",
"errors": [
{
"detail": "Missing required field.",
"message": "lineItems is required for addendum type cloverMerchantProcessingAmendment.",
"parameter": "processingAccounts[0].addendums[0].lineItems"
}
],
"status": 400,
"title": "One or more validation errors occurred.",
"type": "https://docs.payroc.com/api/errors#bad-request"
}
},
"ref_060ac11e14a755a9a144": {
"description": "Update the details of a funding account associated with a funding recipient.",
"summary": "Update funding account",
"value": {
"metadata": {
"responsiblePerson": "Jane Doe"
},
"nameOnAccount": "Fred Nerk",
"paymentMethods": [
{
"type": "ach",
"value": {
"accountNumber": "987654321",
"routingNumber": "123123123"
}
}
],
"type": "savings",
"use": "credit"
}
},
"ref_062e3c457eb4c3dc83dd": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_f9d963d00740bbe00c9e"
},
{
"properties": {
"data": {
"description": "Array of paymentPlan objects.",
"items": {
"$ref": "#/x-devx-bundled/ref_c80128c537381f745ab9"
},
"type": "array"
}
},
"type": "object"
}
],
"required": [
"count",
"data",
"hasMore",
"limit"
],
"type": "object"
},
"ref_0678331d0efb6f01fb11": {
"description": "Signature instruction failed",
"summary": "Signature instruction failed",
"value": {
"detail": "You cannot cancel this resource in its current state",
"errors": [
{
"message": "Failed instruction cannot be canceled",
"parameter": "signatureInstructionId"
}
],
"status": 409,
"title": "Cannot be canceled",
"type": "https://docs.payroc.com/api/errors#cannot-be-canceled"
}
},
"ref_0685c770b4b5d061663d": {
"description": "Filter refunds by the last four digits of the card number.",
"examples": {
"example": {
"value": "7062"
}
},
"in": "query",
"name": "last4",
"schema": {
"pattern": "[0-9]{4}",
"type": "string"
}
},
"ref_06f5be23d6297306e3c5": {
"description": "Unique identifier that we assigned to the funding instruction.",
"examples": {
"example": {
"value": 64643131
}
},
"in": "path",
"name": "instructionId",
"required": true,
"schema": {
"type": "integer"
}
},
"ref_076d4ba29a457ae4ea8d": {
"properties": {
"address": {
"description": "Polymorphic object that contains address information for a funding recipient.",
"oneOf": [
{
"$ref": "#/x-devx-bundled/ref_51baeef3d490d18ab4d6"
}
],
"type": "object"
},
"charityId": {
"description": "Government identifier of the charity.",
"type": "string"
},
"contactMethods": {
"description": "Array of polymorphic objects, which contain contact information. \n\n**Note:** You must provide an email address.\n\nThe value of the type parameter determines which variant you should use: \n-\t`email` - Email address \n-\t`phone` - Phone number\n-\t`mobile` - Mobile number\n-\t`fax` - Fax number\n",
"example": [
{
"type": "email",
"value": "jane.doe@example.com"
}
],
"items": {
"$ref": "#/x-devx-bundled/ref_7960ea97dd5f79b93ae4"
},
"minItems": 1,
"type": "array"
},
"createdDate": {
"example": "2024-07-02T15:30:00+00:00",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"doingBusinessAs": {
"description": "Trading name of the business or organization.",
"type": "string"
},
"fundingAccounts": {
"description": "Array of fundingAccount objects that you can use to add funding accounts to the funding recipient.",
"items": {
"$ref": "#/x-devx-bundled/ref_9a102086f05b94adac7a"
},
"minItems": 1,
"type": "array"
},
"lastModifiedDate": {
"example": "2024-07-02T15:30:00+00:00",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"metadata": {
"additionalProperties": {
"type": "string"
},
"description": "[Metadata](https://docs.payroc.com/api/metadata) object you can use to include custom data with your request.",
"example": {
"yourCustomField": "abc123"
},
"type": "object"
},
"owners": {
"description": "Array of owner objects. Each object contains information about an individual who owns or manages the funding recipient.",
"items": {
"$ref": "#/x-devx-bundled/ref_d8267a8278910c858c37"
},
"minItems": 1,
"type": "array"
},
"recipientId": {
"example": 1,
"readOnly": true,
"type": "integer"
},
"recipientType": {
"description": "Type or legal structure of the funding recipient.",
"enum": [
"privateCorporation",
"publicCorporation",
"nonProfit",
"government",
"privateLlc",
"publicLlc",
"privatePartnership",
"publicPartnership",
"soleProprietor"
],
"example": "privateCorporation",
"type": "string"
},
"status": {
"enum": [
"approved",
"rejected",
"pending"
],
"example": "approved",
"readOnly": true,
"type": "string"
},
"taxId": {
"description": "Employer identification number (EIN) or Social Security number (SSN).",
"example": "123456789",
"type": "string"
}
},
"required": [
"address",
"contactMethods",
"recipientType",
"taxId",
"owners",
"fundingAccounts",
"doingBusinessAs"
],
"title": "create funding recipient",
"type": "object"
},
"ref_07e4918a9e731c6dae85": {
"description": "You do not have the required permission",
"summary": "Forbidden",
"value": {
"detail": "You do not have the required permissions to perform this action",
"instance": "https://api.payroc.com/v1/exampleResource/3",
"resource": "exampleResource",
"status": 403,
"title": "Forbidden",
"type": "https://docs.payroc.com/api/errors#forbidden"
}
},
"ref_080cc40e493d508bee9e": {
"description": "Object that contains information about the card.",
"properties": {
"cardNumber": {
"description": "Masked card number. Our gateway shows only the first six digits and the last four digits of the card number, for example, 548010******5929.",
"example": "453985******7062",
"maxLength": 19,
"minLength": 12,
"type": "string"
},
"country": {
"description": "Country of the issuing bank. The value for the country follows the [ISO-3166-1](https://www.iso.org/iso-3166-country-codes.html) standard.",
"example": "US",
"format": "iso-3166-1",
"type": "string"
},
"currency": {
"$ref": "#/x-devx-bundled/ref_5c51a0e852c4baa940d0"
},
"debit": {
"description": "Indicates if the card is a debit card.",
"example": false,
"type": "boolean"
},
"healthcare": {
"description": "Indicates if the card is linked to a Flexible Spending Account (FSA) or a Health Savings Account (HSA). The value is one of the following:\n - `true` - Card is linked to an FSA or an HSA.\n - `false` - Card isn't linked to an FSA or an HSA.\n",
"example": false,
"type": "boolean"
},
"surcharging": {
"$ref": "#/x-devx-bundled/ref_4dd307ea31db18202b97"
},
"type": {
"description": "Card brand of the card, for example, Visa.",
"example": "Visa",
"type": "string"
}
},
"readOnly": true,
"required": [
"type",
"cardNumber"
],
"type": "object"
},
"ref_08466de59d13fe2751af": {
"description": "Secure token after we updated the customer's name and payment details.",
"summary": "Update secure token",
"value": {
"customFields": [
{
"name": "yourCustomField",
"value": "abc123"
}
],
"customer": {
"billingAddress": {
"address1": "1 Example Ave.",
"address2": "Example Address Line 2",
"address3": "Example Address Line 3",
"city": "Chicago",
"country": "US",
"postalCode": "60056",
"state": "Illinois"
},
"contactMethods": [
{
"type": "email",
"value": "sarah.hopper@example.com"
}
],
"dateOfBirth": "1990-07-15",
"firstName": "Sarah",
"lastName": "Reed",
"notificationLanguage": "en",
"referenceNumber": "Customer-12",
"shippingAddress": {
"address": {
"address1": "1 Example Ave.",
"address2": "Example Address Line 2",
"address3": "Example Address Line 3",
"city": "Chicago",
"country": "US",
"postalCode": "60056",
"state": "Illinois"
},
"recipientName": "Sarah Reed"
}
},
"mitAgreement": "unscheduled",
"processingTerminalId": "1234001",
"secureTokenId": "MREF_abc1de23-f4a5-6789-bcd0-12e345678901fa",
"source": {
"cardNumber": "453985******7062",
"cardholderName": "Sarah Reed",
"expiryDate": "1230",
"type": "card"
},
"status": "notValidated",
"token": "296753123456"
}
},
"ref_089d247e655158a8093a": {
"description": "Object that contains information about the progress of the payment instruction for a MiFare card.",
"summary": "Payment instruction for MiFare card",
"value": {
"link": {
"href": "https://api.payroc.com/v1/closed-loop-reads/KEO45MAC1U",
"method": "GET",
"rel": "closed-loop-read"
},
"paymentInstructionId": "a37439165d134678a9100ebba3b29597",
"status": "completed"
}
},
"ref_08a2598fddfe444f3098": {
"description": "Filter batches by the date that they were submitted. The format of this value is **YYYY-MM-DD**.",
"examples": {
"example": {
"value": "2027-07-02"
}
},
"in": "query",
"name": "date",
"required": true,
"schema": {
"format": "date",
"type": "string"
}
},
"ref_09c9d9c155676d1e101d": {
"description": "Object that contains the signature for the transaction. \n**Note:** If the merchant previously added a signature to the transaction, they can’t adjust or delete the signature.\n",
"properties": {
"cardholderSignature": {
"description": "Cardholder’s signature. For more information about the format of the signature, see Special Fields and Parameters.",
"example": "a1b1c012345678a000b000c0012345d0e0f010g10061a031i001j071k0a1b0c1d0e1234567890120f1g0h1i0j1k0a1b0123451c012d0e1f0g1h0i1j123k1a1b1c1d1e1f1g123h1i1j1k1a1b1c1d1e1f1g123h123i1j123k12340a120a12345b012c0123012d0d1e0f1g0h1i123j123k10000",
"type": "string"
},
"type": {
"description": "Type of adjustment.",
"enum": [
"signature"
],
"example": "signature",
"type": "string"
}
},
"required": [
"type",
"cardholderSignature"
],
"title": "signature",
"type": "object"
},
"ref_0a288d7a7d1bbdc66d5d": {
"description": "Unique identifier that we assigned to the payment intent.",
"example": "1452",
"in": "path",
"name": "paymentIntentId",
"required": true,
"schema": {
"type": "string"
}
},
"ref_0a2bb17e6e2a6ad0a66f": {
"description": "Object that contains information about the retrieved refund.",
"properties": {
"card": {
"$ref": "#/x-devx-bundled/ref_5acdcf065560ed15cf74"
},
"customFields": {
"description": "Array of customField objects.\n",
"items": {
"$ref": "#/x-devx-bundled/ref_91509fee696e20aa30f2"
},
"type": "array"
},
"customer": {
"$ref": "#/x-devx-bundled/ref_5698b09ff5e98efedc02"
},
"operator": {
"description": "Operator who requested the refund.",
"example": "Jane",
"maxLength": 50,
"minLength": 0,
"type": "string"
},
"order": {
"$ref": "#/x-devx-bundled/ref_6f025c42b03b33927339"
},
"payment": {
"$ref": "#/x-devx-bundled/ref_55cbf93e50dd5644578a",
"description": "Object that contains information about the payment that the refund is linked to. \n\n**Note:** We don't return this object for unreferenced refunds. \n"
},
"processingTerminalId": {
"description": "Unique identifier that we assigned to the terminal.",
"example": "1234001",
"maxLength": 50,
"minLength": 4,
"type": "string"
},
"refundId": {
"description": "Unique identifier that our gateway assigned to the refund.",
"example": "CD3HN88U9F",
"maxLength": 10,
"minLength": 10,
"type": "string"
},
"supportedOperations": {
"$ref": "#/x-devx-bundled/ref_bba41f5c84235f2c1871"
},
"transactionResult": {
"$ref": "#/x-devx-bundled/ref_68f95191b4389dc629cb"
}
},
"required": [
"card",
"order",
"processingTerminalId",
"refundId",
"transactionResult"
],
"type": "object"
},
"ref_0a6bd7f4cbca22d74320": {
"summary": "Retrieve ACH deposit",
"value": {
"achAdjustment": 1000,
"achDate": "2024-07-02",
"achDepositId": 99,
"associationDate": "2024-07-02",
"dailyFees": 1000,
"heldSales": 1000,
"holdback": 1000,
"links": [
{
"href": "https://api.payroc.com/v1/ach-deposit-fees?achDepositId=99&merchantId=4525644354",
"method": "get",
"rel": "achDepositFees"
}
],
"merchant": {
"doingBusinessAs": "Pizza Doe",
"link": {
"href": "https://api.payroc.com/v1/processing-accounts/38765",
"method": "get",
"rel": "processingAccount"
},
"merchantId": "4525644354",
"processingAccountId": 38765
},
"netAmount": 36500,
"paymentDate": "2024-07-02",
"reserveRelease": 500,
"returns": 10000,
"sales": 50000,
"transactions": 10
}
},
"ref_0af00846def2cd349cd2": {
"description": "Object that contains information about the secure token.",
"properties": {
"customerName": {
"description": "Customer's name.",
"example": "Sarah Hazel Hopper",
"maxLength": 50,
"minLength": 1,
"type": "string"
},
"link": {
"$ref": "#/x-devx-bundled/ref_27e6d0e095fb23cba669"
},
"secureTokenId": {
"description": "Unique identifier that the merchant assigned to the secure token.",
"example": "MREF_abc1de23-f4a5-6789-bcd0-12e345678901fa",
"maxLength": 200,
"minLength": 1,
"type": "string"
},
"status": {
"description": "Status of the customer's bank account. The processor performs a security check on the customer's bank account and returns the status of the account. \n**Note:** Depending on the merchant's account settings, this feature may be unavailable.\n",
"enum": [
"notValidated",
"cvvValidated",
"validationFailed",
"issueNumberValidated",
"cardNumberValidated",
"bankAccountValidated"
],
"example": "cvvValidated",
"type": "string"
},
"token": {
"description": "Token that the merchant can use in future transactions to represent the customer's payment details. The token: \n- Begins with the six-digit identification number **296753**. \n- Contains up to 12 digits. \n- Contains a single check digit that we calculate using the Luhn algorithm. \n",
"example": "296753123456",
"maxLength": 19,
"minLength": 12,
"type": "string"
}
},
"required": [
"customerName",
"secureTokenId",
"status",
"token"
],
"type": "object"
},
"ref_0b0239b0eccb01bab7f7": {
"description": "Unique identifier of the payment that the merchant wants to retrieve.",
"examples": {
"example": {
"value": "M2MJOG6O2Y"
}
},
"in": "path",
"name": "paymentId",
"required": true,
"schema": {
"maxLength": 10,
"minLength": 10,
"type": "string"
}
},
"ref_0c4c5cb0b4eeef5fb143": {
"description": "Event subscription after removing a metadata field.",
"summary": "Update event subscription: remove",
"value": {
"enabled": true,
"eventTypes": [
"processingAccount.status.changed"
],
"id": 2565435189324,
"metadata": {},
"notifications": [
{
"secret": "**********oP3456",
"supportEmailAddress": "jane.doe@example.com",
"type": "webhook",
"uri": "https://my-server/notification/endpoint"
}
],
"status": "registered"
}
},
"ref_0d196bd1023e19b5208b": {
"description": "Event subscription after replacing the enabled value.",
"summary": "Update event subscription: replace",
"value": {
"enabled": true,
"eventTypes": [
"processingAccount.status.changed"
],
"id": 2565435189324,
"metadata": {
"yourCustomField": "abc123"
},
"notifications": [
{
"secret": "**********oP3456",
"supportEmailAddress": "jane.doe@example.com",
"type": "webhook",
"uri": "https://my-server/notification/endpoint"
}
],
"status": "registered"
}
},
"ref_0d2180a6aea8b0cb280c": {
"description": "Retrieve a specific owner.",
"summary": "Retrieve owner",
"value": {
"address": {
"address1": "1 Example Ave.",
"address2": "Example Address Line 2",
"address3": "Example Address Line 3",
"city": "Chicago",
"country": "US",
"postalCode": "60056",
"state": "Illinois"
},
"contactMethods": [
{
"type": "email",
"value": "jane.doe@example.com"
}
],
"dateOfBirth": "1964-03-22",
"firstName": "Jane",
"identifiers": [
{
"type": "nationalId",
"value": "xxxxx4320"
}
],
"lastName": "Doe",
"middleName": "Helen",
"ownerId": 4564,
"relationship": {
"equityPercentage": 48.5,
"isAuthorizedSignatory": false,
"isControlProng": true,
"title": "CFO"
}
}
},
"ref_0d2d04cca3f7442ed518": {
"description": "Object that contains information about the adjustment to the refund.",
"properties": {
"adjustments": {
"description": "Array of polymorphic objects that contain information about adjustments to the refund. \n\nThe value of the type parameter determines which variant you should use: \n-\t`status` - Status of the transaction.\n-\t`customer` - Customer's contact information and shipping address.\n",
"items": {
"discriminator": {
"mapping": {
"customer": "../../../common/schemas/transaction/transaction-adjustment-v1.yaml#/components/schemas/customerAdjustment",
"status": "../../../common/schemas/transaction/transaction-adjustment-v1.yaml#/components/schemas/statusAdjustment"
},
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/x-devx-bundled/ref_df709214365c028258ee"
},
{
"$ref": "#/x-devx-bundled/ref_d7c593c600b95328ff30"
}
]
},
"type": "array",
"uniqueItems": true
},
"operator": {
"description": "Operator who requested the adjustment to the refund.",
"example": "Jane",
"maxLength": 50,
"minLength": 0,
"type": "string"
}
},
"required": [
"adjustments"
],
"type": "object"
},
"ref_0d2f883617ee5b39f1e1": {
"description": "Filter by the last four digits of the card or account number.",
"examples": {
"example": {
"value": "7062"
}
},
"in": "query",
"name": "last4",
"schema": {
"pattern": "[0-9]{4}",
"type": "string"
}
},
"ref_0dc3afc11188caa4b25b": {
"description": "Create the first payment in a recurring series using a secure token.",
"summary": "Card sale with secure token and is the first payment in a series",
"value": {
"card": {
"cardNumber": "453985******7062",
"cardholderName": "Sarah Hopper",
"entryMethod": "keyed",
"expiryDate": "1230",
"secureToken": {
"customerName": "Sarah Hopper",
"link": {
"href": "https://api.payroc.com/v1/processing-terminals/1234001/secure-tokens/MREF_abc1de23-f4a5-6789-bcd0-12e345678901fa",
"method": "GET",
"rel": "self"
},
"secureTokenId": "MREF_abc1de23-f4a5-6789-bcd0-12e345678901fa",
"status": "notValidated",
"token": "296753123456"
},
"securityChecks": {
"avsResult": "Y"
},
"type": "Visa Credit"
},
"customFields": [
{
"name": "yourCustomField",
"value": "abc123"
}
],
"customer": {
"billingAddress": {
"address1": "1 Example Ave.",
"address2": "Example Address Line 2",
"address3": "Example Address Line 3",
"city": "Chicago",
"country": "US",
"postalCode": "60056",
"state": "Illinois"
},
"firstName": "Sarah",
"lastName": "Hopper",
"shippingAddress": {
"address": {
"address1": "1 Example Ave.",
"address2": "Example Address Line 2",
"address3": "Example Address Line 3",
"city": "Chicago",
"country": "US",
"postalCode": "60056",
"state": "Illinois"
},
"recipientName": "Sarah Hopper"
}
},
"operator": "Jane",
"order": {
"amount": 4999,
"currency": "USD",
"dateTime": "2024-07-02T15:30:00Z",
"description": "Pizza Doe #1234 - Dinner",
"orderId": "OrderRef6543",
"standingInstructions": {
"processingModel": "recurring",
"sequence": "first"
}
},
"paymentId": "M2MJOG6O2Y",
"processingTerminalId": "1234001",
"supportedOperations": [
"fullyReverse",
"setAsPending"
],
"transactionResult": {
"approvalCode": "OK3",
"authorizedAmount": 4999,
"cardSchemeReferenceId": "ABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890",
"currency": "USD",
"responseCode": "A",
"responseMessage": "OK3",
"status": "ready",
"type": "sale"
}
}
},
"ref_0e07938f865866b952e7": {
"description": "Object that contains information about the current status of the dispute.",
"properties": {
"disputeStatusId": {
"description": "Unique identifier that we assigned to the status of the dispute.",
"example": 12345,
"type": "integer"
},
"status": {
"description": "Status of the dispute. \n\n**Note:** If you want to view the status history of the dispute, use our [List Dispute Statuses](https://docs.payroc.com/api/schema/reporting/settlement/list-disputes-statuses) method. \n",
"enum": [
"prearbitrationInProcess",
"prearbitrationAccepted",
"prearbitrationDeclined",
"arbitrationFiledWithCardBand",
"arbitrationFundsToBeReturned",
"arbitrationLost",
"arbitrationSettledPartialAmount",
"precomplianceInProcess",
"precomplianceAccepted",
"precomplianceDeclined",
"complianceFiledWithCardBand",
"complianceLost",
"complianceSettledPartialAmount",
"invalid",
"issuerReversal",
"new",
"rejected",
"representmentInProgress",
"representmentFailed",
"representmentPaid",
"representmentReceived",
"stand"
],
"type": "string"
},
"statusDate": {
"description": "Date that the status of the dispute was last changed. The format of this value is **YYYY-MM-DD**.",
"example": "2024-02-01",
"format": "date",
"type": "string"
}
},
"title": "dispute status",
"type": "object"
},
"ref_0f05902499b8df71219f": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_f9d963d00740bbe00c9e"
},
{
"properties": {
"data": {
"description": "Array of contact objects.",
"items": {
"$ref": "#/x-devx-bundled/ref_df1dbb6190ccee505722"
},
"type": "array"
}
},
"type": "object"
}
],
"title": "paginated Contacts",
"type": "object"
},
"ref_0f141912e7871a73611a": {
"description": "Unique identifier that the merchant assigned to the secure token.",
"examples": {
"example": {
"value": "MREF_abc1de23-f4a5-6789-bcd0-12e345678901fa"
}
},
"in": "query",
"name": "secureTokenId",
"schema": {
"maxLength": 200,
"minLength": 1,
"type": "string"
}
},
"ref_0f614eff4d27ca486267": {
"description": "Retrieve a specific processing terminal.",
"summary": "Retrieve processing terminal",
"value": {
"applicationSettings": {
"clerkPrompt": false,
"invoiceNumberPrompt": true
},
"batchClosure": {
"batchCloseTime": "23:40",
"batchCloseType": "automatic"
},
"devices": [
{
"communicationType": "bluetooth",
"manufacturer": "Ingenico",
"model": "Axium Dx4000 Tsys",
"serialNumber": "DX400-1234"
}
],
"features": {
"ebt": {
"ebtType": "foodStamp",
"enabled": true,
"fnsNumber": "3456789"
},
"enhancedProcessing": {
"enabled": true,
"shippingAddressMode": "fullAddress",
"transactionDataLevel": "level2"
},
"offlinePayments": true,
"paymentLinks": {
"enabled": true,
"footerNotes": "Thank you for your business.",
"logoUrl": "https://www.example.com/logo.png"
},
"pinDebitCashback": false,
"preAuthorizations": true,
"recurringPayments": true,
"tips": {
"enabled": false
}
},
"gateway": {
"gateway": "payroc",
"terminalTemplateId": "Roc Services_DX8000"
},
"processingTerminalId": "011234001",
"program": "Payroc Cloud",
"receiptNotifications": {
"emailReceipt": true,
"smsReceipt": false
},
"security": {
"avsLevel": "fullAddress",
"avsPrompt": true,
"cvvPrompt": true,
"tokenization": false
},
"status": "active",
"taxes": [
{
"taxLabel": "Sales Tax",
"taxRate": 6
}
],
"timezone": "Pacific/Midway"
}
},
"ref_0f813605d6f1b2a63bdb": {
"description": "Object that contains information about a single-use payment link.",
"properties": {
"assets": {
"$ref": "#/x-devx-bundled/ref_cbb0638a40224bf482e1"
},
"authType": {
"description": "Type of transaction.",
"enum": [
"sale",
"preAuthorization"
],
"example": "sale",
"type": "string"
},
"createdOn": {
"description": "Date that the merchant created the link. The format of this value is **YYYY-MM-DD**.",
"example": "2024-07-02",
"format": "date",
"readOnly": true,
"type": "string"
},
"credentialOnFile": {
"$ref": "#/x-devx-bundled/ref_30c7e63fc155b2e36fdd"
},
"customLabels": {
"description": "Array of customLabel objects. \n**Note:** You can change the label of the payment button only.\n",
"items": {
"$ref": "#/x-devx-bundled/ref_4bf052e2a8fd0985ca08"
},
"type": "array",
"uniqueItems": true
},
"expiresOn": {
"description": "Last date that the customer can use the payment link. The format of this value is **YYYY-MM-DD**.",
"example": "2024-08-02",
"format": "date",
"type": "string"
},
"merchantReference": {
"description": "Unique identifier that the merchant assigned to the payment.",
"example": "LinkRef7654",
"maxLength": 48,
"minLength": 1,
"type": "string"
},
"order": {
"$ref": "#/x-devx-bundled/ref_ac1dd76e32ce419051f4"
},
"paymentLinkId": {
"description": "Unique identifier that we assigned to the payment link.",
"example": "CKHP6VVWYT",
"maxLength": 10,
"minLength": 10,
"readOnly": true,
"type": "string"
},
"paymentMethods": {
"description": "Payment methods that the merchant accepts. \n**Note:** If the payment is a pre-authorization, the customer must pay by card.\n",
"example": [
"card"
],
"items": {
"enum": [
"card",
"bankTransfer"
],
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"status": {
"description": "Status of the payment link. The value is one of the following:\n- `active` - Payment link is active.\n- `completed` - Customer has paid.\n- `deactivated` - Merchant has deactivated the link.\n- `expired` - Payment link has expired.\n",
"enum": [
"active",
"completed",
"deactivated",
"expired"
],
"example": "active",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Type of link. The merchant can use this link for only one payment.",
"enum": [
"singleUse"
],
"example": "singleUse",
"type": "string"
}
},
"required": [
"type",
"order",
"authType",
"expiresOn",
"paymentMethods",
"merchantReference"
],
"title": "singleUse",
"type": "object"
},
"ref_0ff3e9c7dbd0e2c9610e": {
"description": "Object that contains information about RewardPayChoice.",
"properties": {
"fees": {
"description": "Object that contains information about the fees.",
"properties": {
"credit": {
"description": "Object that contains information about fees for credit transactions.",
"properties": {
"cardChargePercentage": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_d3797fc41828d98b6e34"
}
],
"default": 3,
"description": "Percentage of the total transaction amount that the processor charges the cardholder.",
"readOnly": true,
"type": "number"
},
"merchantChargePerTransaction": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_109fe7e5f018de7ee04b"
}
],
"description": "Fee for each transaction. The value is in the currency's lowest denomination, for example, cents."
},
"merchantChargePercentage": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_d3797fc41828d98b6e34"
}
],
"default": 0.9,
"description": "Percentage of the total transaction amount that the processor charges the merchant.",
"readOnly": true,
"type": "number"
},
"tips": {
"description": "Indicates how the merchant manages tips.",
"enum": [
"noTips",
"tipPrompt",
"tipAdjust"
],
"type": "string"
}
},
"type": "object"
},
"debit": {
"description": "Object that contains information about fees for debit transactions.",
"properties": {
"option": {
"description": "Indicates if debit transactions should be charged at interchange plus or flat rate pricing.",
"enum": [
"interchangePlus",
"flatRate"
],
"type": "string"
},
"transaction": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_109fe7e5f018de7ee04b"
}
],
"description": "Fee for each transaction. The value is in the currency's lowest denomination, for example, cents."
},
"volume": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_d3797fc41828d98b6e34"
}
],
"description": "Percentage of the total transaction that the processor charges the merchant."
}
},
"required": [
"volume",
"transaction"
]
},
"monthlySubscription": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_109fe7e5f018de7ee04b"
}
],
"description": "Fee for the monthly subscription for the processing plan. The value is in the currency's lowest denomination, for example, cents."
},
"specialityCards": {
"$ref": "#/x-devx-bundled/ref_ca2b35d2127e00c3b179"
}
},
"required": [
"monthlySubscription",
"debit",
"credit"
],
"type": "object"
},
"planType": {
"description": "Type of processing plan.",
"enum": [
"rewardPayChoice"
],
"type": "string"
}
},
"required": [
"planType",
"fees"
],
"title": "RewardPayChoice Plan",
"type": "object"
},
"ref_0ff6e6363362a158bcfc": {
"description": "Payment",
"summary": "Card Payment",
"value": {
"channel": "web",
"customFields": [
{
"name": "yourCustomField",
"value": "abc123"
}
],
"customer": {
"billingAddress": {
"address1": "1 Example Ave.",
"address2": "Example Address Line 2",
"address3": "Example Address Line 3",
"city": "Chicago",
"country": "US",
"postalCode": "60056",
"state": "Illinois"
},
"firstName": "Sarah",
"lastName": "Hopper",
"shippingAddress": {
"address": {
"address1": "1 Example Ave.",
"address2": "Example Address Line 2",
"address3": "Example Address Line 3",
"city": "Chicago",
"country": "US",
"postalCode": "60056",
"state": "Illinois"
},
"recipientName": "Sarah Hopper"
}
},
"operator": "Jane",
"order": {
"amount": 4999,
"currency": "USD",
"description": "Large Pepperoni Pizza",
"orderId": "OrderRef6543"
},
"paymentMethod": {
"cardDetails": {
"entryMethod": "keyed",
"keyedData": {
"cardNumber": "4539858876047062",
"dataFormat": "plainText",
"device": {
"model": "paxA80",
"serialNumber": "WPC202833004712"
},
"expiryDate": "1230"
}
},
"type": "card"
},
"processingTerminalId": "1234001"
}
},
"ref_1011d61d1eb23132f52d": {
"description": "Subscription after we replaced the amount of the recurring order.",
"summary": "Update subscription: replace",
"value": {
"currency": "USD",
"currentState": {
"nextDueDate": "2024-08-02",
"outstandingInvoices": 3,
"paidInvoices": 0,
"status": "active"
},
"customFields": [
{
"name": "yourCustomField",
"value": "abc123"
}
],
"description": "Premium Club subscription",
"endDate": "2025-07-01",
"frequency": "monthly",
"length": 12,
"name": "Premium Club",
"pauseCollectionFor": 0,
"paymentPlan": {
"link": {
"href": "https://api.payroc.com/v1/processing-terminals/1234001/payment-plans/PlanRef8765",
"method": "GET",
"rel": "self"
},
"name": "Monthly Premium Club subscription",
"paymentPlanId": "PlanRef8765"
},
"processingTerminalId": "1234001",
"recurringOrder": {
"amount": 3999,
"breakdown": {
"subtotal": 4347,
"surcharge": {
"amount": 217,
"percentage": 5
},
"taxes": [
{
"name": "Sales Tax",
"rate": 5
}
]
},
"description": "Premium Club subscription"
},
"secureToken": {
"customerName": "Sarah Hazel Hopper",
"link": {
"href": "https://api.payroc.com/v1/processing-terminals/1234001/secure-tokens/MREF_abc1de23-f4a5-6789-bcd0-12e345678901fa",
"method": "GET",
"rel": "self"
},
"secureTokenId": "MREF_abc1de23-f4a5-6789-bcd0-12e345678901fa",
"status": "notValidated",
"token": "296753123456"
},
"setupOrder": {
"amount": 4999,
"breakdown": {
"subtotal": 4347,
"surcharge": {
"amount": 217,
"percentage": 5
},
"taxes": [
{
"name": "Sales Tax",
"rate": 5
}
]
},
"description": "Initial setup fee for Premium Club subscription",
"orderId": "OrderRef6543"
},
"startDate": "2024-07-02",
"subscriptionId": "SubRef7654",
"type": "automatic"
}
},
"ref_1046806ef63d4413b658": {
"description": "Unique identifier that we assigned to the pricing intent.",
"examples": {
"example": {
"value": "5"
}
},
"in": "path",
"name": "pricingIntentId",
"required": true,
"schema": {
"type": "string"
}
},
"ref_1055036baa52c3364292": {
"description": "Filter refunds by the first six digits of the card number.",
"examples": {
"example": {
"value": "453985"
}
},
"in": "query",
"name": "first6",
"schema": {
"pattern": "[0-9]{6}",
"type": "string"
}
},
"ref_109fe7e5f018de7ee04b": {
"minimum": 0,
"type": "integer"
},
"ref_10bf124ff96e7a81434e": {
"description": "Object that contains information about the transaction.",
"properties": {
"subtotal": {
"description": "Total amount of the transaction before tax and tip. The value is in the currency's lowest denomination, for example, cents.",
"example": 4500,
"format": "int64",
"type": "integer"
},
"tip": {
"$ref": "#/x-devx-bundled/ref_90d04e11e8f10457c837",
"description": "Object that contains tip information for the transaction."
}
},
"required": [
"subtotal"
],
"type": "object"
},
"ref_10d667ba338f4f03a5cd": {
"description": "List of funding accounts associated with a processing account.",
"summary": "List of funding accounts",
"value": [
{
"createdDate": "2024-07-02T12:00:00.000+00:00",
"fundingAccountId": 123,
"lastModifiedDate": "2024-07-02T12:00:00.000+00:00",
"links": [
{
"href": "https://api.payroc.com/v1/processing-accounts/38765",
"method": "get",
"rel": "parent"
}
],
"metadata": {
"yourCustomField": "abc123"
},
"nameOnAccount": "Jane Doe",
"paymentMethods": [
{
"type": "ach",
"value": {
"accountNumber": "******7890",
"routingNumber": "*****6789"
}
}
],
"status": "approved",
"type": "checking",
"use": "creditAndDebit"
},
{
"createdDate": "2024-07-02T12:00:00.000+00:00",
"fundingAccountId": 124,
"lastModifiedDate": "2024-07-02T12:00:00.000+00:00",
"links": [
{
"href": "https://api.payroc.com/v1/processing-accounts/38765",
"method": "get",
"rel": "parent"
}
],
"metadata": {
"yourCustomField": "abc123"
},
"nameOnAccount": "Jane Doe",
"paymentMethods": [
{
"type": "ach",
"value": {
"accountNumber": "******3491",
"routingNumber": "*****8725"
}
}
],
"status": "pending",
"type": "checking",
"use": "creditAndDebit"
}
]
},
"ref_110d5c260cf5acafc170": {
"description": "Filter results by the customer's email address.",
"examples": {
"example": {
"value": "sarah.hopper@example.com"
}
},
"in": "query",
"name": "recipientEmail",
"schema": {
"maxLength": 128,
"minLength": 6,
"type": "string"
}
},
"ref_11d707376cd301bb2c48": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_ec10c8ff2f2642ded7ca"
},
{
"properties": {
"breakdown": {
"$ref": "#/x-devx-bundled/ref_3ab18b72178aebd31e74"
}
},
"type": "object"
}
],
"type": "object"
},
"ref_1215d80bbdda31621a4a": {
"additionalProperties": false,
"description": "Telehealth Attestation for merchants that provide telehealth services.",
"properties": {
"type": {
"const": "telehealthV1",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"ref_12539077028451b8ba4f": {
"description": "Move operation relocates a value from one location to another.",
"summary": "Update secure token: move",
"value": [
{
"from": "/customFields/0",
"op": "move",
"path": "/customFields/1"
}
]
},
"ref_12ecf6130480ac459b2d": {
"properties": {
"card": {
"description": "Polymorphic object that contains payment details.",
"discriminator": {
"mapping": {
"card": "../../../common/schemas/transaction/payment-method-v1.yaml#/components/schemas/cardPayload"
},
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/x-devx-bundled/ref_d7a78654a15a2c87ffaa"
}
],
"type": "object"
},
"customer": {
"$ref": "#/x-devx-bundled/ref_1674621e10fb2f321406"
},
"operator": {
"description": "Operator who requested to verify the card.",
"example": "Jane",
"maxLength": 50,
"minLength": 0,
"type": "string"
},
"processingTerminalId": {
"description": "Unique identifier that we assigned to the terminal.",
"example": "1234001",
"maxLength": 50,
"minLength": 4,
"type": "string"
}
},
"required": [
"card",
"processingTerminalId"
],
"type": "object"
},
"ref_131240e23a2ae006742f": {
"description": "Replace operation updates an existing value.",
"summary": "Update payment plan: replace",
"value": [
{
"op": "replace",
"path": "/frequency",
"value": "yearly"
}
]
},
"ref_1381eacf966cbfd0f303": {
"properties": {
"card": {
"$ref": "#/x-devx-bundled/ref_9ab219963d0de56b1c4a"
},
"operator": {
"description": "Operator who requested to verify the card.",
"example": "Jane",
"maxLength": 50,
"minLength": 0,
"type": "string"
},
"processingTerminalId": {
"description": "Unique identifier that we assigned to the terminal.",
"example": "1234001",
"maxLength": 50,
"minLength": 4,
"type": "string"
},
"transactionResult": {
"$ref": "#/x-devx-bundled/ref_68f95191b4389dc629cb"
},
"verified": {
"description": "Indicates if the card details are valid: \n\n- `true` - Card details are valid.\n- `false` - Card details are not valid.\n",
"example": true,
"type": "boolean"
}
},
"required": [
"processingTerminalId",
"verified"
],
"type": "object"
},
"ref_139c6fc55dfb6af1864a": {
"description": "Payment plan after we removed the description.",
"summary": "Update payment plan: remove",
"value": {
"currency": "USD",
"customFieldNames": [
"yourCustomField"
],
"frequency": "monthly",
"length": 12,
"name": "Premium Club",
"onDelete": "complete",
"onUpdate": "continue",
"paymentPlanId": "PlanRef8765",
"processingTerminalId": "1234001",
"recurringOrder": {
"amount": 4999,
"breakdown": {
"subtotal": 4347,
"taxes": [
{
"name": "Sales Tax",
"rate": 5
}
]
},
"description": "Monthly Premium Club subscription"
},
"setupOrder": {
"amount": 4999,
"breakdown": {
"subtotal": 4347,
"taxes": [
{
"name": "Sales Tax",
"rate": 5
}
]
},
"description": "Initial setup fee for Premium Club subscription"
},
"type": "automatic"
}
},
"ref_13c415d839c305766788": {
"summary": "Paginated disputes",
"value": {
"count": 1,
"data": [
{
"authorizationCode": "574254",
"card": {
"avsRequest": true,
"avsResponse": "",
"cardNumber": "12456**********4124",
"cvvPresenceIndicator": true,
"type": "visa"
},
"createdDate": "2024-07-02",
"currency": "USD",
"currentStatus": {
"disputeStatusId": 123,
"link": {
"href": "https://api.payroc.com/v1/disputes/65/statuses",
"method": "get",
"rel": "statuses"
},
"status": "new",
"statusDate": "2024-07-02"
},
"description": "",
"disputeAmount": 1000,
"disputeId": 65,
"disputeType": "firstDispute",
"feeAmount": 100,
"firstDispute": true,
"lastModifiedDate": "2024-07-02",
"merchant": {
"doingBusinessAs": "Pizza Doe",
"link": {
"href": "https://api.payroc.com/v1/processing-accounts/38765",
"method": "get",
"rel": "merchant"
},
"merchantId": "4525644354",
"processingAccountId": 38765
},
"receivedDate": "2024-07-02",
"referenceNumber": "35435435",
"transaction": {
"amount": 100,
"date": "2024-07-02",
"entryMethod": "swiped",
"link": {
"href": "https://api.payroc.com/v1/transactions/12345",
"method": "get",
"rel": "transaction"
},
"transactionId": 12345,
"type": "capture"
}
}
],
"hasMore": false,
"limit": 2,
"links": [
{
"href": "https://api.payroc.com/v1/disputes?before=65&limit=2&date=2024-07-02",
"method": "get",
"rel": "previous"
}
]
}
},
"ref_13de814984ebc32d2e47": {
"description": "Tip settings",
"properties": {
"enabled": {
"description": "Indicates if the terminal can accept tips.",
"type": "boolean"
},
"suggestedTips": {
"description": "Object that contains up to three tip amounts that the terminal displays during a sale.",
"properties": {
"enabled": {
"description": "Indicates if the terminal displays tip amounts during a sale.",
"type": "boolean"
},
"tipPercentages": {
"description": "Array of the tip amounts that the terminal displays during a sale.",
"items": {
"type": "string"
},
"maxItems": 3,
"type": "array"
}
},
"type": "object"
},
"tipAdjust": {
"description": "Indicates if a clerk can adjust a tip after the customer completes the sale.",
"type": "boolean"
},
"tipPrompt": {
"description": "Indicates if the terminal prompts for tips.",
"type": "boolean"
}
},
"required": [
"enabled"
],
"type": "object"
},
"ref_13e96b9f11d47b95852d": {
"properties": {
"transaction": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_109fe7e5f018de7ee04b"
}
],
"description": "Fee for each transaction. The value is in the currency's lowest denomination, for example, cents."
},
"type": {
"description": "Type of American Express program.",
"enum": [
"direct"
],
"type": "string"
}
},
"required": [
"type",
"transaction"
],
"title": "direct",
"type": "object"
},
"ref_142bc03c19d01d9629ce": {
"description": "Polymorphic object that contains information about the single-use token.",
"discriminator": {
"mapping": {
"singleUseToken": "#/components/schemas/singleUseTokenAccountUpdate"
},
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/x-devx-bundled/ref_714d26764eda6aed1ff1"
}
]
},
"ref_142be7cd484c5802cb79": {
"description": "Filter results by transaction type.",
"examples": {
"example": {
"value": [
"payment"
]
}
},
"in": "query",
"name": "type",
"schema": {
"items": {
"enum": [
"payment",
"accountVerification"
],
"type": "string"
},
"type": "array"
}
},
"ref_143db3de56b4d4e7e9c2": {
"description": "Object that contains information about the base fees.",
"properties": {
"createdDate": {
"description": "Date and time that we received your request to create the pricing intent. We return this value in the [ISO-8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
"example": "2024-07-02T09:00:00Z",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"id": {
"description": "Unique identifier of the pricing intent.",
"readOnly": true,
"type": "string"
},
"key": {
"description": "Unique identifier that you can assign to the pricing intent for your own records.",
"type": "string"
},
"lastUpdatedDate": {
"description": "Date and time that the pricing intent was last modified. We return this value in the [ISO-8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
"example": "2024-07-02T09:00:00Z",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"metadata": {
"additionalProperties": {
"type": "string"
},
"description": "[Metadata](https://docs.payroc.com/api/metadata) object that contains your custom data.",
"example": {
"yourCustomField": "abc123"
},
"type": "object"
},
"status": {
"description": "Status of the pricing intent. The value can be one of the following:\n- `active` - We have approved the pricing intent.\n- `pendingReview` - We have not yet reviewed the pricing intent.\n- `rejected` - We have rejected the pricing intent.\n",
"enum": [
"active",
"pendingReview",
"rejected"
],
"readOnly": true,
"type": "string"
}
},
"required": [
"key"
],
"title": "base pricing intent",
"type": "object"
},
"ref_147d3bc5742cd6354104": {
"description": "Payment link after we moved a custom label to a different position in the array.",
"summary": "Update payment link: move",
"value": {
"assets": {
"paymentButton": "SUPPORT US\n",
"paymentUrl": "https://payments.payroc.com/merchant/pay-by-link?token=02ada211-ff51-4845-b0b5-e685aeb4b19d"
},
"authType": "sale",
"createdOn": "2024-09-24",
"customLabels": [
{
"element": "paymentButton",
"label": "SUPPORT US"
}
],
"merchantReference": "LinkRef6543",
"order": {
"charge": {
"currency": "USD",
"type": "prompt"
},
"description": "Pie It Forward charitable trust donation"
},
"paymentLinkId": "JZURRJBUPS",
"paymentMethods": [
"card",
"bankTransfer"
],
"status": "active",
"type": "multiUse"
}
},
"ref_14920c978ef4664c1ec1": {
"description": "Polymorphic object that contains information about how we captured the owner's signature. \n\nThe value of the type parameter determines which variant you should use:\n-\t`requestedViaDirectLink` - Request signature using a link.\n-\t`requestedViaEmail` - Request signature by email.\n",
"discriminator": {
"mapping": {
"requestedViaDirectLink": "#/components/schemas/signatureByDirectLink",
"requestedViaEmail": "#/components/schemas/signatureByEmail"
},
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/x-devx-bundled/ref_fcc3ce73949c1562a8cf"
},
{
"$ref": "#/x-devx-bundled/ref_958403d3a1e8d9035c0d"
}
],
"type": "object"
},
"ref_14fab24aef7cf31d79a1": {
"summary": "Apple Pay Payment",
"value": {
"card": {
"cardNumber": "500165******0000",
"entryMethod": "keyed",
"expiryDate": "0328",
"securityChecks": {
"avsResult": "U"
},
"type": "MasterCard"
},
"operator": "Jane",
"order": {
"amount": 4999,
"currency": "USD",
"dateTime": "2024-07-02T15:30:00Z",
"description": "Card Transaction (APPLE)",
"orderId": "1234567890W"
},
"paymentId": "J9VULKIKFP",
"processingTerminalId": "1234001",
"supportedOperations": [
"capture",
"fullyReverse",
"partiallyReverse",
"incrementAuthorization",
"adjustTip",
"setAsPending"
],
"transactionResult": {
"approvalCode": "OK3",
"authorizedAmount": 4999,
"currency": "USD",
"processorResponseCode": "00",
"responseCode": "A",
"responseMessage": "APPROVAL",
"status": "ready",
"type": "sale"
}
}
},
"ref_157b8aec350ce5596632": {
"description": "Polymorphic object that contains tax details.\n\nThe value of the type parameter determines which variant you should use:\n-\t`amount` - Tax is a fixed amount.\n-\t`rate` - Tax is a percentage.\n\nRequired for [Level 2, Level 3, and CEDP transactions](https://docs.payroc.com/knowledge/card-payments/enhanced-data).\n",
"discriminator": {
"mapping": {
"amount": "#/components/schemas/taxAmount",
"rate": "#/components/schemas/taxRate"
},
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/x-devx-bundled/ref_a2f5c84fd4924158737d"
},
{
"$ref": "#/x-devx-bundled/ref_a52bfba93be1ce659766"
}
],
"type": "object"
},
"ref_15f114d485c46156439d": {
"description": "Filter by the name of the payment plan.",
"examples": {
"example": {
"value": "Premium%20Club"
}
},
"in": "query",
"name": "paymentPlan",
"schema": {
"maxLength": 128,
"minLength": 1,
"type": "string"
}
},
"ref_160441a54125204b4701": {
"description": "We couldn't resend the email to the merchant because you didn't originally choose to send the information by email.",
"summary": "Not requested by email",
"value": {
"detail": "You can use the Reminders endpoint only for documentation that we sent by email.",
"status": 400,
"title": "Not requested by email",
"type": "https://docs.payroc.com/api/errors#not-requested-by-email"
}
},
"ref_160ac044e8ca8da9e82c": {
"description": "BIN lookup",
"summary": "BIN lookup",
"value": {
"card": {
"cardDetails": {
"cardholderName": "Sarah Hazel Hopper",
"cardholderSignature": "a1b1c012345678a000b000c0012345d0e0f010g10061a031i001j071k0a1b0c1d0e1234567890120f1g0h1i0j1k0a1b0123451c012d0e1f0g1h0i1j123k1a1b1c1d1e1f1g123h1i1j1k1a1b1c1d1e1f1g123h123i1j123k12340a120a12345b012c0123012d0d1e0f1g0h1i123j123k10000",
"entryMethod": "keyed",
"keyedData": {
"cardNumber": "4539858876047062",
"dataFormat": "plainText",
"expiryDate": "1230"
}
},
"type": "card"
},
"processingTerminalId": "1234001"
}
},
"ref_162eec4b493b189ca496": {
"description": "Filter by activity after a specific date. Send a value in **YYYY-MM-DD** format.",
"examples": {
"example": {
"value": "2024-07-02"
}
},
"in": "query",
"name": "dateFrom",
"required": true,
"schema": {
"format": "date",
"type": "string"
}
},
"ref_16560a085e477303e24b": {
"description": "Filter results by refunds that the merchant ran after a specific date. The value follows the [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) standard.",
"examples": {
"example": {
"value": "2024-07-01T00:00:00Z"
}
},
"in": "query",
"name": "dateFrom",
"schema": {
"format": "date-time",
"type": "string"
}
},
"ref_16714e0921c52a5403e4": {
"description": "Terminal order",
"summary": "Terminal order",
"value": {
"createdDate": "2024-07-02T12:00:00.000+00:00",
"lastModifiedDate": "2024-07-02T12:00:00.000+00:00",
"orderItems": [
{
"deviceCondition": "new",
"solutionQuantity": 1,
"solutionSetup": {
"applicationSettings": {
"clerkPrompt": false,
"security": {
"keyedSalePassword": false,
"refundPassword": true,
"reversalPassword": true
}
},
"batchClosure": {
"batchCloseTime": "23:40",
"batchCloseType": "automatic"
},
"deviceSettings": {
"communicationType": "wifi",
"numberOfMobileUsers": 2
},
"gatewaySettings": {
"merchantPortfolioId": "Example Corp",
"merchantTemplateId": "Example Corp Merchant Template",
"terminalTemplateId": "Example Corp Terminal Template",
"userTemplateId": "Example Corp User Template"
},
"industryTemplateId": "Retail",
"receiptNotifications": {
"emailReceipt": true,
"smsReceipt": false
},
"taxes": [
{
"taxLabel": "Sales Tax",
"taxRate": 6
}
],
"timezone": "America/Chicago",
"tips": {
"enabled": false
},
"tokenization": true
},
"solutionTemplateId": "Roc Services_DX8000",
"type": "solution"
}
],
"shipping": {
"address": {
"addressLine1": "1 Example Ave.",
"addressLine2": "Example Address Line 2",
"businessName": "Example Corp",
"city": "Chicago",
"email": "jane.doe@example.com",
"phone": "2025550164",
"postalCode": "60056",
"recipientName": "Jane Doe",
"state": "Illinois"
},
"preferences": {
"method": "nextDay",
"saturdayDelivery": true
}
},
"status": "open",
"terminalOrderId": "2346",
"trainingProvider": "payroc"
}
},
"ref_1674621e10fb2f321406": {
"description": "Object that contains the customer's contact details and address information.\n\nContains parameters required for [Level 2, Level 3, and CEDP transactions](https://docs.payroc.com/knowledge/card-payments/enhanced-data).\n",
"properties": {
"billingAddress": {
"$ref": "#/x-devx-bundled/ref_51baeef3d490d18ab4d6",
"description": "Object that contains information about the address that the card is registered to."
},
"contactMethods": {
"description": "Array of polymorphic objects, which contain contact information. \n\nThe value of the type parameter determines which variant you should use: \n-\t`email` - Email address \n-\t`phone` - Phone number\n-\t`mobile` - Mobile number\n-\t`fax` - Fax number\n",
"items": {
"$ref": "#/x-devx-bundled/ref_7960ea97dd5f79b93ae4"
},
"type": "array",
"uniqueItems": true
},
"dateOfBirth": {
"description": "Customer's date of birth. The format for this value is **YYYY-MM-DD**.",
"example": "1990-07-15",
"format": "date",
"type": "string"
},
"firstName": {
"description": "Customer's first name.",
"example": "Sarah",
"maxLength": 60,
"minLength": 0,
"type": "string"
},
"lastName": {
"description": "Customer's last name.",
"example": "Hopper",
"maxLength": 60,
"minLength": 0,
"type": "string"
},
"notificationLanguage": {
"description": "Language that the customer uses for notifications. This code follows the [ISO 639-1](https://www.iso.org/iso-639-language-code) alpha-2 standard. \n",
"enum": [
"en",
"fr"
],
"example": "en",
"format": "iso-639-1",
"maxLength": 2,
"minLength": 2,
"type": "string"
},
"referenceNumber": {
"description": "Identifier of the transaction, also known as a customer code.\n\nFor requests, you must send a value for **referenceNumber** if the customer provides one.\n\nRequired for [Level 2, Level 3, and CEDP transactions](https://docs.payroc.com/knowledge/card-payments/enhanced-data).\n",
"example": "CustomerCode234567",
"maxLength": 48,
"minLength": 0,
"type": "string"
},
"shippingAddress": {
"$ref": "#/x-devx-bundled/ref_6390b31795ee298ddaec"
}
},
"type": "object"
},
"ref_1676b2d018f8f9b3160a": {
"description": "Unique identifier that we assigned to the owner.",
"examples": {
"example": {
"value": 4564
}
},
"in": "path",
"name": "ownerId",
"required": true,
"schema": {
"type": "integer"
}
},
"ref_1692c517eaa8450a6234": {
"description": "Payment Plan",
"summary": "Payment Plan",
"value": {
"currency": "USD",
"customFieldNames": [
"yourCustomField"
],
"description": "Monthly Premium Club subscription",
"frequency": "monthly",
"length": 12,
"name": "Premium Club",
"onDelete": "complete",
"onUpdate": "continue",
"paymentPlanId": "PlanRef8765",
"recurringOrder": {
"amount": 4999,
"breakdown": {
"subtotal": 4347,
"taxes": [
{
"name": "Sales Tax",
"rate": 5
}
]
},
"description": "Monthly Premium Club subscription"
},
"setupOrder": {
"amount": 4999,
"breakdown": {
"subtotal": 4347,
"taxes": [
{
"name": "Sales Tax",
"rate": 5
}
]
},
"description": "Initial setup fee for Premium Club subscription"
},
"type": "automatic"
}
},
"ref_16ee05144593b91396cb": {
"description": "Active multi-use payment link.",
"summary": "Payment Link",
"value": {
"assets": {
"paymentButton": "SUPPORT US\n",
"paymentUrl": "https://payments.payroc.com/merchant/pay-by-link?token=02ada211-ff51-4845-b0b5-e685aeb4b19d"
},
"authType": "sale",
"createdOn": "2024-09-24",
"customLabels": [
{
"element": "paymentButton",
"label": "SUPPORT US"
}
],
"merchantReference": "LinkRef6543",
"order": {
"charge": {
"currency": "USD",
"type": "prompt"
},
"description": "Pie It Forward charitable trust donation"
},
"paymentLinkId": "JZURRJBUPS",
"paymentMethods": [
"card",
"bankTransfer"
],
"status": "active",
"type": "multiUse"
}
},
"ref_173edad0bb113303f045": {
"default": "tsys",
"description": "Processor that authorizes and settles transactions for the processing account.\n\n**Note:** We recommend that you include a value for the processor parameter and not rely on the default value.\n",
"enum": [
"tsys",
"fiserv"
],
"example": "tsys",
"type": "string"
},
"ref_174073fb4a8caae28863": {
"summary": "Funding instruction",
"value": {
"createdDate": "2024-07-02T15:30:00Z",
"instructionId": 64643131,
"lastModifiedDate": "2024-07-02T15:30:00Z",
"merchants": [
{
"link": {
"href": "https://api.payroc.com/v1/processing-accounts/4525644354",
"method": "get",
"rel": "merchant"
},
"merchantId": "4525644354",
"recipients": [
{
"amount": {
"currency": "USD",
"value": 120000
},
"fundingAccountId": 123,
"link": {
"href": "https://api.payroc.com/v1/funding-accounts/123",
"method": "get",
"rel": "fundingAccount"
},
"metadata": {
"yourCustomField": "abc123"
},
"paymentMethod": "ACH",
"status": "accepted"
}
]
}
],
"metadata": {
"yourCustomField": "abc123"
},
"status": "accepted"
}
},
"ref_1794e8f5d9df0ea00937": {
"properties": {
"midQualRate": {
"$ref": "#/x-devx-bundled/ref_01f55c7b2d1709665555",
"description": "Object that contains the fees for a mid-qualified transaction."
},
"nonQualRate": {
"$ref": "#/x-devx-bundled/ref_01f55c7b2d1709665555",
"description": "Object that contains the fees for a non-qualified transaction."
},
"qualifiedRate": {
"$ref": "#/x-devx-bundled/ref_01f55c7b2d1709665555",
"description": "Object that contains the fees for a qualified transaction."
},
"type": {
"description": "Type of American Express program.",
"enum": [
"optBlue"
],
"type": "string"
}
},
"required": [
"type",
"qualifiedRate",
"midQualRate",
"nonQualRate"
],
"title": "optBlue",
"type": "object"
},
"ref_180b93cfd401848a2c1b": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_360be5d7e0853d272f75"
},
{
"properties": {
"breakdown": {
"$ref": "#/x-devx-bundled/ref_c545049e00b6d34db3b8"
}
},
"type": "object"
}
],
"description": "Object that contains information about the payment.",
"type": "object"
},
"ref_181b399a0b28f6afb5a3": {
"description": "Create a single-use token. The token expires after 30 minutes.",
"summary": "Create single-use token",
"value": {
"channel": "web",
"operator": "Jane",
"source": {
"cardDetails": {
"cardholderName": "Sarah Hazel Hopper",
"entryMethod": "keyed",
"keyedData": {
"cardNumber": "4539858876047062",
"cvv": "234",
"dataFormat": "plainText",
"expiryDate": "1230"
}
},
"type": "card"
}
}
},
"ref_18649c5e5a02aae46fe7": {
"description": "Payment link sharing event",
"summary": "Share a payment link",
"value": {
"dateTime": "2024-07-02T15:30:00Z",
"message": "Dear Sarah,\n\nYou can pay for your order via the link below.\n",
"recipients": [
{
"email": "sarah.hopper@example.com",
"name": "Sarah Hazel Hopper"
}
],
"sharingEventId": "GTZH5WVXK9",
"sharingMethod": "email"
}
},
"ref_189f0093666f2903bc12": {
"in": "query",
"name": "toDateTime",
"schema": {
"description": "Filter by terminal orders created before a specific date. The date format follows the [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html).",
"example": "2024-12-08T11:00:00.000Z",
"format": "date-time",
"type": "string"
}
},
"ref_192143ce438ffb4a184e": {
"description": "Single-use payment link that we created.",
"summary": "Single-use payment link",
"value": {
"assets": {
"paymentButton": "PAY NOW\n",
"paymentUrl": "https://payments.payroc.com/merchant/pay-by-link?token=7c2fc08c-cb0e-44ba-8bcd-cf6de6eb3206"
},
"authType": "sale",
"createdOn": "2024-07-24",
"customLabels": [
{
"element": "paymentButton",
"label": "PAY NOW"
}
],
"expiresOn": "2024-08-02",
"merchantReference": "LinkRef7654",
"order": {
"charge": {
"amount": 4999,
"currency": "USD",
"type": "preset"
},
"description": "Large Pepperoni Pizza",
"orderId": "OrderRef7654"
},
"paymentLinkId": "CKHP6VVWYT",
"paymentMethods": [
"card"
],
"status": "active",
"type": "singleUse"
}
},
"ref_1984086edf68a329c63d": {
"description": "Remove operation deletes a value from the payment plan.",
"summary": "Update payment plan: remove",
"value": [
{
"op": "remove",
"path": "/description"
}
]
},
"ref_19a8e307cfe221c92341": {
"description": "Filter results by the link's expiry date. Send a value in **YYYY-MM-DD** format.",
"examples": {
"example": {
"value": "2024-08-02"
}
},
"in": "query",
"name": "expiresOn",
"schema": {
"format": "date",
"type": "string"
}
},
"ref_1a3439d8d471f6290741": {
"description": "Payment link after we copied the order description to the merchant reference.",
"summary": "Update payment link: copy",
"value": {
"assets": {
"paymentButton": "SUPPORT US\n",
"paymentUrl": "https://payments.payroc.com/merchant/pay-by-link?token=02ada211-ff51-4845-b0b5-e685aeb4b19d"
},
"authType": "sale",
"createdOn": "2024-09-24",
"customLabels": [
{
"element": "paymentButton",
"label": "SUPPORT US"
}
],
"merchantReference": "Pie It Forward charitable trust donation",
"order": {
"charge": {
"currency": "USD",
"type": "prompt"
},
"description": "Pie It Forward charitable trust donation"
},
"paymentLinkId": "JZURRJBUPS",
"paymentMethods": [
"card",
"bankTransfer"
],
"status": "active",
"type": "multiUse"
}
},
"ref_1a4c99efee44a7a21c17": {
"description": "A Patch Remove Operation.",
"properties": {
"op": {
"description": "`remove` operation.",
"enum": [
"remove"
],
"type": "string"
},
"path": {
"description": "Location of the value that you want to remove.\nThe format for this value is JSON Pointer.\n",
"type": "string"
}
},
"required": [
"op",
"path"
],
"title": "Patch Remove Operation",
"type": "object"
},
"ref_1a4f881ca24e9232b696": {
"description": "Object that contains information about the batch. If we can't match a dispute to a batch, we don't return 'batch' object.",
"properties": {
"batchId": {
"description": "Unique identifier of the batch.",
"example": 1234,
"type": "integer"
},
"cycle": {
"description": "Indicates the cycle that contains the batch.",
"example": "am",
"type": "string"
},
"date": {
"description": "Date that the merchant submitted the batch.",
"example": "2024-07-02",
"format": "date",
"type": "string"
},
"link": {
"$ref": "#/x-devx-bundled/ref_27e6d0e095fb23cba669"
}
},
"title": "batch summary",
"type": [
"object",
"null"
]
},
"ref_1b32e7b68330cf3a0901": {
"properties": {
"transaction": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_109fe7e5f018de7ee04b"
}
],
"description": "Fee for each transaction. The value is in the currency's lowest denomination, for example, cents."
},
"type": {
"description": "Type of American Express program.",
"enum": [
"direct"
],
"type": "string"
}
},
"required": [
"type",
"transaction"
],
"title": "direct",
"type": "object"
},
"ref_1b72ad544bfe7951ee5d": {
"properties": {
"orderItems": {
"description": "Array of order items. Provide a minimum of 1 order item and a maximum of 20 order items.",
"items": {
"$ref": "#/x-devx-bundled/ref_a3961e92072a91d3c0d1"
},
"maxItems": 20,
"minItems": 1,
"type": "array"
},
"paymentIntent": {
"$ref": "#/x-devx-bundled/ref_48411fa0892bdae41e27"
},
"shipping": {
"$ref": "#/x-devx-bundled/ref_b6329324bae9fba46ed8"
},
"trainingProvider": {
"$ref": "#/x-devx-bundled/ref_6529a021f62f98e435d3"
}
},
"required": [
"orderItems"
],
"type": "object"
},
"ref_1c54aece4f1b17738900": {
"description": "Filter results by payments that the merchant ran before a specific date. The value follows the [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) standard.",
"examples": {
"example": {
"value": "2024-07-31T23:59:59Z"
}
},
"in": "query",
"name": "dateTo",
"schema": {
"format": "date-time",
"type": "string"
}
},
"ref_1d27536e303131535b26": {
"description": "Object that contains information about the progress of the refund instruction.",
"summary": "Refund instruction",
"value": {
"link": {
"href": "https://api.payroc.com/v1/refund-instructions/a37439165d134678a9100ebba3b29597",
"method": "GET",
"rel": "self"
},
"refundInstructionId": "a37439165d134678a9100ebba3b29597",
"status": "inProgress"
}
},
"ref_1e958b8002425b1bcda7": {
"description": "Subscription manual payment",
"summary": "Subscription manual payment",
"value": {
"operator": "Jane",
"order": {
"amount": 4999,
"description": "Monthly Premium Club subscription",
"orderId": "OrderRef6543"
}
}
},
"ref_1ed5f3fe0b142fc6e27a": {
"summary": "Retrieve funding instruction",
"value": {
"createdDate": "2024-07-02T15:30:00Z",
"instructionId": 64643131,
"lastModifiedDate": "2024-07-02T15:30:00Z",
"merchants": [
{
"link": {
"href": "https://api.payroc.com/v1/processing-accounts/4525644354",
"method": "get",
"rel": "merchant"
},
"merchantId": "4525644354",
"recipients": [
{
"amount": {
"currency": "USD",
"value": 120000
},
"fundingAccountId": 123,
"link": {
"href": "https://api.payroc.com/v1/funding-accounts/123",
"method": "get",
"rel": "fundingAccount"
},
"metadata": {
"yourCustomField": "abc123"
},
"paymentMethod": "ACH",
"status": "funded"
}
]
}
],
"metadata": {
"yourCustomField": "abc123"
},
"status": "completed"
}
},
"ref_1fc34136cbdb8c5e933b": {
"description": "Create session request.",
"summary": "Create session",
"value": {
"libVersion": "1.1.0.123456",
"scenario": "payment"
}
},
"ref_2032b83df64d6f876909": {
"description": "Your identity could not be verified",
"summary": "Not Authorized",
"value": {
"detail": "Your identity could not be verified",
"status": 401,
"title": "Not Authorized",
"type": "https://docs.payroc.com/api/errors#not-authorized"
}
},
"ref_20646294913264a3c1a0": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_a38a839aab4628df3f20"
},
{
"properties": {
"breakdown": {
"$ref": "#/x-devx-bundled/ref_61195d3ba563471558fa"
}
},
"type": "object"
}
],
"description": "Object that contains information about the cost of each payment.\n",
"type": "object"
},
"ref_206c1041aef5b55a3593": {
"description": "Subscription after we moved the custom field. The array contains only one entry, so the order of the entries doesn't change.\n",
"summary": "Update subscription: move",
"value": {
"currency": "USD",
"currentState": {
"nextDueDate": "2024-08-02",
"outstandingInvoices": 3,
"paidInvoices": 0,
"status": "active"
},
"customFields": [
{
"name": "yourCustomField",
"value": "abc123"
}
],
"description": "Premium Club subscription",
"endDate": "2025-07-01",
"frequency": "monthly",
"length": 12,
"name": "Premium Club",
"pauseCollectionFor": 0,
"paymentPlan": {
"link": {
"href": "https://api.payroc.com/v1/processing-terminals/1234001/payment-plans/PlanRef8765",
"method": "GET",
"rel": "self"
},
"name": "Monthly Premium Club subscription",
"paymentPlanId": "PlanRef8765"
},
"processingTerminalId": "1234001",
"recurringOrder": {
"amount": 4999,
"breakdown": {
"subtotal": 4347,
"surcharge": {
"amount": 217,
"percentage": 5
},
"taxes": [
{
"name": "Sales Tax",
"rate": 5
}
]
},
"description": "Premium Club subscription"
},
"secureToken": {
"customerName": "Sarah Hazel Hopper",
"link": {
"href": "https://api.payroc.com/v1/processing-terminals/1234001/secure-tokens/MREF_abc1de23-f4a5-6789-bcd0-12e345678901fa",
"method": "GET",
"rel": "self"
},
"secureTokenId": "MREF_abc1de23-f4a5-6789-bcd0-12e345678901fa",
"status": "notValidated",
"token": "296753123456"
},
"setupOrder": {
"amount": 4999,
"breakdown": {
"subtotal": 4347,
"surcharge": {
"amount": 217,
"percentage": 5
},
"taxes": [
{
"name": "Sales Tax",
"rate": 5
}
]
},
"description": "Initial setup fee for Premium Club subscription",
"orderId": "OrderRef6543"
},
"startDate": "2024-07-02",
"subscriptionId": "SubRef7654",
"type": "automatic"
}
},
"ref_209438ddfe4e1d353487": {
"description": "Example of a created event subscription.",
"summary": "Create event subscription with metadata",
"value": {
"enabled": true,
"eventTypes": [
"processingAccount.status.changed"
],
"id": 2565435189324,
"metadata": {
"responsiblePerson": "Jane Doe"
},
"notifications": [
{
"secret": "**********oP3456",
"supportEmailAddress": "jane.doe@example.com",
"type": "webhook",
"uri": "https://my-server/notification/endpoint"
}
],
"status": "registered"
}
},
"ref_20bd6f7961f9beaf2021": {
"description": "Test operation validates that a value at the target location equals the specified value.",
"summary": "Update payment plan: test",
"value": [
{
"op": "test",
"path": "/currency",
"value": "USD"
}
]
},
"ref_210fbadc5eb6d4079f9a": {
"description": "Object that contains information about a multi-use payment link.",
"properties": {
"assets": {
"$ref": "#/x-devx-bundled/ref_cbb0638a40224bf482e1"
},
"authType": {
"description": "Type of transaction.",
"enum": [
"sale",
"preAuthorization"
],
"example": "sale",
"type": "string"
},
"createdOn": {
"description": "Date that the merchant created the link. The format of this value is **YYYY-MM-DD**.",
"example": "2024-07-02",
"format": "date",
"readOnly": true,
"type": "string"
},
"credentialOnFile": {
"$ref": "#/x-devx-bundled/ref_30c7e63fc155b2e36fdd"
},
"customLabels": {
"description": "Array of customLabel objects. \n**Note:** You can change the label of the payment button only.\n",
"items": {
"$ref": "#/x-devx-bundled/ref_4bf052e2a8fd0985ca08"
},
"type": "array",
"uniqueItems": true
},
"expiresOn": {
"description": "Last date that the customer can use the payment link. The format of this value is **YYYY-MM-DD**. \n**Note:** If you don't provide an expiration date, the default expiration period applies. You can change the default expiration period on the Self-Care Portal. \n",
"example": "2024-08-02",
"format": "date",
"type": "string"
},
"merchantReference": {
"description": "Unique identifier that the merchant assigned to the payment.",
"example": "LinkRef6543",
"maxLength": 48,
"minLength": 1,
"type": "string"
},
"order": {
"$ref": "#/x-devx-bundled/ref_9bfdca27bc73df647bb9"
},
"paymentLinkId": {
"description": "Unique identifier that we assigned to the payment link.",
"example": "JZURRJBUPS",
"maxLength": 10,
"minLength": 10,
"readOnly": true,
"type": "string"
},
"paymentMethods": {
"description": "Payment methods that the merchant accepts. \n**Note:** If a payment is a pre-authorization, the customer must pay by card.\n",
"example": [
"card"
],
"items": {
"enum": [
"card",
"bankTransfer"
],
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"status": {
"description": "Status of the payment link. The value is one of the following:\n- `active` - Payment link is active.\n- `completed` - Customer has paid.\n- `deactivated` - Merchant has deactivated the link.\n- `expired` - Payment link has expired.\n",
"enum": [
"active",
"completed",
"deactivated",
"expired"
],
"example": "active",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Type of link. The merchant can use a multi-use link to take multiple payments.\n",
"enum": [
"multiUse"
],
"example": "multiUse",
"type": "string"
}
},
"required": [
"type",
"order",
"authType",
"paymentMethods",
"merchantReference"
],
"title": "multiUse",
"type": "object"
},
"ref_214544c04ba3708ed212": {
"properties": {
"addendums": {
"description": "Array of polymorphic addendumEntry objects. Each object indicates the additional form that we sent to the merchant with the Merchant Processing Agreement (MPA).\n\nThe value of the type parameter determines which variant you should use.\n",
"items": {
"$ref": "#/x-devx-bundled/ref_80b2e9c15cc43d211038"
},
"readOnly": true,
"type": "array"
},
"address": {
"description": "Polymorphic object that contains address information for the processing account.",
"oneOf": [
{
"$ref": "#/x-devx-bundled/ref_51baeef3d490d18ab4d6"
}
],
"type": "object"
},
"businessStartDate": {
"description": "Date that the business was established. The format of the value is **YYYY-MM-DD**.",
"example": "2020-01-01",
"format": "date",
"type": "string"
},
"businessType": {
"description": "Type of business.",
"enum": [
"retail",
"restaurant",
"internet",
"moto",
"lodging",
"notForProfit"
],
"example": "restaurant",
"type": "string"
},
"categoryCode": {
"description": "Merchant Category Code (MCC) for the type of business.",
"example": 5999,
"format": "int32",
"maxLength": 4,
"type": "integer"
},
"contactMethods": {
"description": "Array of polymorphic objects, which contain contact information. \n\n**Note:** You must provide an email address.\n\nThe value of the type parameter determines which variant you should use: \n-\t`email` - Email address\n-\t`phone` - Phone number\n-\t`mobile` - Mobile number\n-\t`fax` - Fax number\n",
"items": {
"$ref": "#/x-devx-bundled/ref_7960ea97dd5f79b93ae4"
},
"minItems": 1,
"type": "array"
},
"contacts": {
"description": "Array of contact objects.",
"items": {
"properties": {
"contactId": {
"description": "Unique identifier of the contact.",
"example": 1543,
"type": "integer"
},
"firstName": {
"description": "Contact's first name.",
"example": "Jane",
"type": "string"
},
"lastName": {
"description": "Contact's last name.",
"example": "Doe",
"type": "string"
},
"link": {
"description": "Object that contains HATEOAS links for the contact.",
"properties": {
"href": {
"description": "Link to the resource.",
"example": "https://api.payroc.com/v1/contacts/1543",
"type": "string"
},
"method": {
"description": "HTTP method you can use to retrieve the resource.",
"example": "get",
"type": "string"
},
"rel": {
"description": "Relationship to the parent resource.",
"example": "contact",
"type": "string"
}
},
"type": "object"
}
},
"title": "contact",
"type": "object"
},
"readOnly": true,
"type": "array"
},
"createdDate": {
"description": "Date and time that we received your request to create the processing account in our system.",
"example": "2024-07-02T12:00:00.000+00:00",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"doingBusinessAs": {
"description": "Trading name of the business.",
"example": "Pizza Doe",
"maxLength": 100,
"type": "string"
},
"funding": {
"$ref": "#/x-devx-bundled/ref_68be72132e3ddb55341d"
},
"lastModifiedDate": {
"description": "Date and time that the processing account was last modified.",
"example": "2024-07-02T12:00:00.000+00:00",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"links": {
"description": "Array of useful links related to your request.",
"example": [],
"items": {
"$ref": "#/x-devx-bundled/ref_27e6d0e095fb23cba669"
},
"type": "array"
},
"merchandiseOrServiceSold": {
"description": "Description of the services or merchandise sold by the business.",
"example": "Pizza",
"maxLength": 125,
"type": "string"
},
"metadata": {
"additionalProperties": {
"type": "string"
},
"description": "Object that you can send to include custom data in the request. For more information about how to use metadata, go to [Metadata](https://docs.payroc.com/api/metadata).",
"example": {
"customerId": "2345"
},
"type": "object"
},
"owners": {
"description": "Object that contains information about the owners of the business.",
"items": {
"properties": {
"firstName": {
"description": "Owner's first name.",
"example": "Jane",
"type": "string"
},
"lastName": {
"description": "Owner's last name.",
"example": "Doe",
"type": "string"
},
"link": {
"description": "HATEOAS links to the owners of the processing account.",
"properties": {
"href": {
"description": "URL of the target resource.",
"example": "https://api.payroc.com/v1/owners/1543",
"type": "string"
},
"method": {
"description": "HTTP method that you need to use with the target resource.",
"example": "get",
"type": "string"
},
"rel": {
"description": "Indicates the relationship between the current resource and the target resource.",
"example": "owner",
"type": "string"
}
},
"type": "object"
},
"ownerId": {
"description": "Unique identifier of the owner.",
"example": 4564,
"type": "integer"
}
},
"title": "owner",
"type": "object"
},
"readOnly": true,
"type": "array"
},
"pricing": {
"description": "Object that HATEOAS links to the pricing information that we apply to the processing account.",
"properties": {
"link": {
"description": "Object that contains HATEOAS links to the pricing information for the processing account.",
"properties": {
"href": {
"description": "URL of the target resource.",
"example": "https://api.payroc.com/v1/processing-accounts/38765/pricing",
"type": "string"
},
"method": {
"description": "HTTP method that you need to use with the target resource.",
"example": "get",
"type": "string"
},
"rel": {
"description": "Indicates the relationship between the current resource and the target resource.",
"example": "pricing",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"processing": {
"$ref": "#/x-devx-bundled/ref_8e9a7990c0c3fd2327dc"
},
"processingAccountId": {
"description": "Unique identifier of the processing account.",
"example": "38765",
"readOnly": true,
"type": "string"
},
"processor": {
"$ref": "#/x-devx-bundled/ref_173edad0bb113303f045"
},
"signature": {
"$ref": "#/x-devx-bundled/ref_14920c978ef4664c1ec1"
},
"status": {
"description": "Status of the processing account. \n- `entered` - We have received information about the account, but we have not yet reviewed it. \n- `pending` - We have reviewed the information about the account, but we have not yet approved it. \n- `approved` - We have approved the account for processing transactions and funding. \n- `subjectTo` - We have approved the account, but we are waiting on further information. \n- `dormant` - Account is closed for a period. \n- `nonProcessing` - We have approved the account, but the merchant has not yet run a transaction. \n- `rejected` - We rejected the application for the processing account. \n- `terminated` - Processing account is closed. \n- `cancelled` - Merchant withdrew the application for the processing account. \n**Note**: You can subscribe to our processingAccount.status.changed event to get notifications when we change the status of a processing account. For more information about how to subscribe to events, go to [Event Subscriptions](https://docs.payroc.com/guides/board-merchants/event-subscriptions).\n",
"enum": [
"entered",
"pending",
"approved",
"subjectTo",
"dormant",
"nonProcessing",
"rejected",
"terminated",
"cancelled"
],
"example": "entered",
"readOnly": true,
"type": "string"
},
"timezone": {
"$ref": "#/x-devx-bundled/ref_f6e10cfc48a2f2c041b3"
},
"website": {
"description": "Website address of the business.",
"example": "www.example.com",
"maxLength": 128,
"type": "string"
}
},
"required": [
"doingBusinessAs",
"owners",
"merchandiseOrServiceSold",
"timezone",
"address",
"contactMethods",
"processing",
"funding",
"pricing",
"signature",
"addendums"
],
"type": "object"
},
"ref_21823b96a22cc3523dce": {
"description": "List of funding accounts.",
"summary": "List of funding accounts",
"value": [
{
"createdDate": "2024-07-02T15:30:00+00:00",
"fundingAccountId": 123,
"lastModifiedDate": "2024-07-02T15:30:00+00:00",
"links": [
{
"href": "https://api.payroc.com/v1/funding-recipients/234",
"method": "get",
"rel": "parent"
}
],
"metadata": {
"yourCustomField": "abc123"
},
"nameOnAccount": "Jane Doe",
"paymentMethods": [
{
"type": "ach",
"value": {
"accountNumber": "******7890",
"routingNumber": "*****6789"
}
}
],
"status": "approved",
"type": "checking",
"use": "credit"
},
{
"createdDate": "2024-07-02T15:30:00+00:00",
"fundingAccountId": 124,
"lastModifiedDate": "2024-07-02T15:30:00+00:00",
"links": [
{
"href": "https://api.payroc.com/v1/funding-recipients/235",
"method": "get",
"rel": "parent"
}
],
"metadata": {
"yourCustomField": "abc123"
},
"nameOnAccount": "Jane Doe",
"paymentMethods": [
{
"type": "ach",
"value": {
"accountNumber": "******3491",
"routingNumber": "*****8725"
}
}
],
"status": "pending",
"type": "checking",
"use": "debit"
}
]
},
"ref_2193dd0fa84b6ecfcf2e": {
"description": "Filter results by the unique identifier that the merchant assigned to the payment link.",
"examples": {
"example": {
"value": "LinkRef6543"
}
},
"in": "query",
"name": "merchantReference",
"schema": {
"maxLength": 48,
"minLength": 1,
"type": "string"
}
},
"ref_21ee02f5a5fca430005f": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_10bf124ff96e7a81434e"
}
],
"description": "Object that contains information about the transaction.",
"properties": {
"taxes": {
"description": "Array of tax objects.",
"items": {
"$ref": "#/x-devx-bundled/ref_a52bfba93be1ce659766"
},
"type": "array"
}
},
"required": [
"subtotal"
],
"type": "object"
},
"ref_21f616026feedfb1f92c": {
"description": "Object that contains information about card verification and security checks.",
"properties": {
"avsResult": {
"description": "Indicates if the address that the customer provided in the request matches the address linked to the card.\n\n- `Y` – The address in the request matches the address linked to the card. \n- `N` – The address in the request doesn’t match the address linked to the card. \n- `A` – The street address matches, but ZIP code or postal code doesn’t match. \n- `Z` - The ZIP code or postal code matches, but street address doesn’t match. \n- `U` – The address information is unavailable. \n- `G` – The issuer or card brand doesn’t support the Address Verification Service (AVS). \n- `R` – The AVS is currently unavailable. Try again later. \n- `S` – There was no AVS data in the request, or it was sent in the wrong format. \n- `F` - For UK addresses, the address in the request matches the address linked to the card. \n- `W` – For US addresses, the nine-digit ZIP code or postal code in the request matches the address linked to the card but the street address doesn’t. \n- `X` – For US addresses, the nine-digit ZIP code or postal code and the street address matches the address linked to the card. \n \n**Note:** Our gateway doesn’t automatically decline transactions when the address doesn’t match the address linked to the card, \nunless the merchant selects this setting in their account.\n",
"enum": [
"Y",
"A",
"Z",
"N",
"U",
"R",
"G",
"S",
"F",
"W",
"X"
],
"example": "Y",
"type": "string"
},
"cvvResult": {
"description": "Indicates if the card verification value (CVV) that the customer provided in the request matches the CVV on the card. \n- `M` – The CVV matches the card’s CVV. \n- `N` – The CVV doesn’t match the card’s CVV. \n- `P` – The CVV wasn’t processed. \n- `U` – The CVV isn’t registered. \n\n**Note:** Our gateway doesn’t automatically decline transactions when the CVV doesn’t match the card’s CVV, unless the merchant selects this setting in their account.\n",
"enum": [
"M",
"N",
"P",
"U"
],
"example": "M",
"type": "string"
}
},
"type": "object"
},
"ref_224f0933b0049b6a323c": {
"description": "Filter by activity before a specific date. Send a value in **YYYY-MM-DD** format.",
"examples": {
"example": {
"value": "2024-07-03"
}
},
"in": "query",
"name": "dateTo",
"required": true,
"schema": {
"format": "date",
"type": "string"
}
},
"ref_2334f7c0d1cd64614f53": {
"description": "Object that contains information about U.S. pricing intents for Merchant Processing Agreement (MPA) 5.2.",
"properties": {
"base": {
"$ref": "#/x-devx-bundled/ref_907e700f9ba048d64683"
},
"country": {
"description": "Two-digit code for the country that the pricing intent applies to. The format follows the [ISO-3166-1](https://www.iso.org/iso-3166-country-codes.html) standard.",
"enum": [
"US"
],
"example": "US",
"type": "string"
},
"gateway": {
"$ref": "#/x-devx-bundled/ref_eb26de9bfde8d7a22231"
},
"processor": {
"description": "Object that contains information about U.S. processor fees.",
"properties": {
"ach": {
"$ref": "#/x-devx-bundled/ref_3e611d2ed3e542a2cf3f"
},
"card": {
"description": "Object that contains information about card fees.",
"discriminator": {
"mapping": {
"consumerChoice": "#/components/schemas/consumerChoice",
"flatRate": "#/components/schemas/flatRate",
"interchangePlus": "#/components/schemas/interchangePlusUs5.2",
"interchangePlusPlus": "#/components/schemas/interchangePlusPlusUs5.2",
"rewardPayChoice": "#/components/schemas/rewardPayChoice",
"tiered3": "#/components/schemas/tiered3",
"tiered4": "#/components/schemas/tiered4",
"tiered6": "#/components/schemas/tiered6"
},
"propertyName": "planType"
},
"oneOf": [
{
"$ref": "#/x-devx-bundled/ref_5b962e147e5363de386e"
},
{
"$ref": "#/x-devx-bundled/ref_99e34e4543d5d9950f40"
},
{
"$ref": "#/x-devx-bundled/ref_af9f49bdb6f99196dce8"
},
{
"$ref": "#/x-devx-bundled/ref_f27ff73f6b39cb7ab2df"
},
{
"$ref": "#/x-devx-bundled/ref_f7eeb7b4e577c65a5900"
},
{
"$ref": "#/x-devx-bundled/ref_9d1ed3f4f2a6515925b3"
},
{
"$ref": "#/x-devx-bundled/ref_4730198900b1c56ebd04"
},
{
"$ref": "#/x-devx-bundled/ref_0ff3e9c7dbd0e2c9610e"
}
],
"type": "object"
}
},
"title": "US processor fees",
"type": "object"
},
"services": {
"$ref": "#/x-devx-bundled/ref_cfe1adbe0a054ebe6791"
},
"version": {
"description": "Version of the MPA.",
"enum": [
"5.2"
],
"type": "string"
}
},
"required": [
"country",
"version",
"base"
],
"title": "US pricing agreement version 5.2",
"type": "object"
},
"ref_2343caaf188e4a706e44": {
"description": "Reverse Refund",
"summary": "Reverse Refund",
"value": {
"card": {
"cardNumber": "453985******7062",
"entryMethod": "keyed",
"expiryDate": "1230",
"type": "Visa Credit"
},
"customFields": [
{
"name": "yourCustomField",
"value": "abc123"
}
],
"order": {
"amount": 4999,
"currency": "USD",
"dateTime": "2024-07-02T15:30:00Z",
"description": "Refund for order OrderRef6543",
"orderId": "OrderRef6543"
},
"processingTerminalId": "1234001",
"refundId": "CD3HN88U9F",
"transactionResult": {
"approvalCode": "000000",
"authorizedAmount": -4999,
"currency": "USD",
"responseCode": "A",
"responseMessage": "APPROVAL",
"status": "reversal",
"type": "refund"
}
}
},
"ref_24a38a2bbccf921f1090": {
"description": "Create a pre-authorization",
"summary": "Create a pre-authorization",
"value": {
"autoCapture": false,
"channel": "web",
"customFields": [
{
"name": "yourCustomField",
"value": "abc123"
}
],
"customer": {
"billingAddress": {
"address1": "1 Example Ave.",
"address2": "Example Address Line 2",
"address3": "Example Address Line 3",
"city": "Chicago",
"country": "US",
"postalCode": "60056",
"state": "Illinois"
},
"firstName": "Sarah",
"lastName": "Hopper",
"shippingAddress": {
"address": {
"address1": "1 Example Ave.",
"address2": "Example Address Line 2",
"address3": "Example Address Line 3",
"city": "Chicago",
"country": "US",
"postalCode": "60056",
"state": "Illinois"
},
"recipientName": "Sarah Hopper"
}
},
"operator": "Jane",
"order": {
"amount": 9999,
"currency": "USD",
"description": "Large Pepperoni Pizza",
"orderId": "OrderRef6543"
},
"paymentMethod": {
"cardDetails": {
"entryMethod": "keyed",
"keyedData": {
"cardNumber": "4539858876047062",
"dataFormat": "plainText",
"device": {
"model": "paxA80",
"serialNumber": "WPC202833004712"
},
"expiryDate": "1230"
}
},
"type": "card"
},
"processAsSale": false,
"processingTerminalId": "1234001"
}
},
"ref_24e1f4e8993b8fe696fe": {
"summary": "Retrieved batch",
"value": {
"batchId": 65,
"createdDate": "2024-07-02",
"currency": "USD",
"date": "2024-07-02",
"heldAmount": 0,
"lastModifiedDate": "2024-07-02",
"links": [
{
"href": "https://api.payroc.com/v1/transactions?batchId=65",
"method": "get",
"rel": "transactions"
},
{
"href": "https://api.payroc.com/v1/authorizations?batchId=65",
"method": "get",
"rel": "authorizations"
}
],
"merchant": {
"doingBusinessAs": "Pizza Doe",
"link": {
"href": "https://api.payroc.com/v1/processing-accounts/38765",
"method": "get",
"rel": "processingAccount"
},
"merchantId": "4525644354",
"processingAccountId": 38765
},
"returnAmount": 0,
"saleAmount": 100,
"transactionCount": 10
}
},
"ref_254febbc2ea11d938a36": {
"description": "Subscription manual payment",
"summary": "Subscription manual payment",
"value": {
"currentState": {
"nextDueDate": "2024-08-02",
"outstandingInvoices": 2,
"paidInvoices": 1,
"status": "active"
},
"customFields": [
{
"name": "yourCustomField",
"value": "abc123"
}
],
"payment": {
"amount": 4999,
"currency": "USD",
"dateTime": "2024-07-02T15:30:00Z",
"link": {
"href": "https://api.payroc.com/v1/bank-transfer-payments/M2MJOG6O2Y",
"method": "GET",
"rel": "self"
},
"paymentId": "M2MJOG6O2Y",
"responseCode": "A",
"responseMessage": "Transaction approved",
"status": "ready"
},
"processingTerminalId": "1234001",
"secureToken": {
"customerName": "Sarah Hazel Hopper",
"link": {
"href": "https://api.payroc.com/v1/processing-terminals/1234001/secure-tokens/MREF_abc1de23-f4a5-6789-bcd0-12e345678901fa",
"method": "GET",
"rel": "self"
},
"secureTokenId": "MREF_abc1de23-f4a5-6789-bcd0-12e345678901fa",
"status": "notValidated",
"token": "296753123456"
},
"subscriptionId": "SubRef7654"
}
},
"ref_2595b403956d707fcd6b": {
"properties": {
"customFields": {
"description": "Array of customField objects.\n",
"items": {
"$ref": "#/x-devx-bundled/ref_91509fee696e20aa30f2"
},
"type": "array"
},
"description": {
"description": "Description of the subscription. \nThis value replaces the description inherited from the payment plan.\n",
"example": "Monthly Premium Club subscription. Two large pizzas free per month, and exclusive member discounts.",
"maxLength": 128,
"minLength": 1,
"type": "string"
},
"endDate": {
"description": "Format: **YYYY-MM-DD** \nSubscription's end date. \n**Note:** If you provide values for both **length** and **endDate**, \nour gateway uses the value for **endDate** to determine when the subscription should end.\n",
"example": "2025-05-02",
"format": "date",
"type": "string"
},
"length": {
"description": "Total number of billing cycles. To indicate that the subscription should run indefinitely, send a value of `0`.\nThis value replaces the **length** inherited from the payment plan. \n**Note:** If you provide values for both **length** and **endDate**, \nour gateway uses the value for **endDate** to determine when the subscription should end.\n",
"example": 12,
"format": "int32",
"minimum": 0,
"type": "integer"
},
"name": {
"description": "Name of the subscription. \nThis value replaces the name inherited from the payment plan.\n",
"example": "Premium Club",
"maxLength": 128,
"minLength": 5,
"type": "string"
},
"pauseCollectionFor": {
"description": "Number of billing cycles that the merchant wants to pause payments for. \nFor example, if the merchant wants to offer a free trial period.\n",
"example": 0,
"format": "int32",
"type": "integer"
},
"paymentMethod": {
"description": "Polymorphic object that contains information about the secure token.",
"discriminator": {
"mapping": {
"secureToken": "../../../common/schemas/transaction/payment-method-v1.yaml#/components/schemas/secureTokenPayload"
},
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/x-devx-bundled/ref_8a84ce450c6452ba8861"
}
],
"type": "object"
},
"paymentPlanId": {
"description": "Unique identifier that the merchant assigned to the payment plan.",
"example": "PlanRef8765",
"maxLength": 48,
"minLength": 1,
"type": "string"
},
"recurringOrder": {
"$ref": "#/x-devx-bundled/ref_6815ca44ec34bb6198b0"
},
"setupOrder": {
"$ref": "#/x-devx-bundled/ref_c09c4c9e197fda20d9e7"
},
"startDate": {
"description": "Format: **YYYY-MM-DD** \nSubscription's start date.\n",
"example": "2024-05-02",
"format": "date",
"type": "string"
},
"subscriptionId": {
"description": "Unique identifier that the merchant assigns to the subscription.",
"example": "SubRef7654",
"maxLength": 48,
"minLength": 1,
"type": "string"
}
},
"required": [
"paymentMethod",
"paymentPlanId",
"startDate",
"subscriptionId"
],
"type": "object"
},
"ref_25d3a2d160d559fe0850": {
"description": "Funding account that we created and added to the funding recipient.",
"summary": "Create funding account",
"value": {
"createdDate": "2024-07-02T15:30:00+00:00",
"fundingAccountId": 123,
"lastModifiedDate": "2024-07-02T15:30:00+00:00",
"links": [
{
"href": "https://api.payroc.com/v1/funding-recipients/234",
"method": "get",
"rel": "parent"
}
],
"metadata": {
"responsiblePerson": "Jane Doe"
},
"nameOnAccount": "Fred Nerk",
"paymentMethods": [
{
"type": "ach",
"value": {
"accountNumber": "******4321",
"routingNumber": "*****3123"
}
}
],
"status": "pending",
"type": "savings",
"use": "credit"
}
},
"ref_26e232823eb4af447e3b": {
"summary": "Paginated authorizations",
"value": {
"count": 1,
"data": [
{
"authorizationId": 65,
"authorizationResponse": "successful",
"batch": {
"batchId": 12,
"cycle": "am",
"date": "2024-07-02",
"link": {
"href": "https://api.payroc.com/v1/batches/12",
"method": "get",
"rel": "batch"
}
},
"card": {
"avsRequest": true,
"avsResponse": "Y",
"cardNumber": "12456**********4124",
"cvvPresenceIndicator": true,
"type": "visa"
},
"createdDate": "2024-07-02",
"currency": "USD",
"lastModifiedDate": "2024-07-02",
"merchant": {
"doingBusinessAs": "Pizza Doe",
"link": {
"href": "https://api.payroc.com/v1/processing-accounts/38765",
"method": "get",
"rel": "processingAccount"
},
"merchantId": "4525644354",
"processingAccountId": 38765
},
"preauthorizationRequestAmount": 10000,
"transaction": {
"amount": 100,
"date": "2024-07-02",
"entryMethod": "swiped",
"link": {
"href": "https://api.payroc.com/v1/transactions/12345",
"method": "get",
"rel": "transaction"
},
"transactionId": 12345,
"type": "capture"
}
}
],
"hasMore": false,
"limit": 2,
"links": [
{
"href": "https://api.payroc.com/v1/authorizations?before=65&limit=2&date=2024-07-02",
"method": "get",
"rel": "previous"
}
]
}
},
"ref_26f07dc17d5d0565bae2": {
"description": "Filter results by the accountholder's name.",
"examples": {
"example": {
"value": "Sarah%20Hazel%20Hopper"
}
},
"in": "query",
"name": "nameOnAccount",
"schema": {
"maxLength": 50,
"minLength": 1,
"type": "string"
}
},
"ref_27d1b319aaf3d8f75f65": {
"description": "Add an additional owner to a funding recipient.",
"summary": "Create funding recipient owner",
"value": {
"address": {
"address1": "2 Example Ave.",
"city": "Chicago",
"country": "US",
"postalCode": "60056",
"state": "Illinois"
},
"contactMethods": [
{
"type": "email",
"value": "fred.nerk@example.com"
},
{
"type": "phone",
"value": "2025550110"
}
],
"dateOfBirth": "1980-01-19",
"firstName": "Fred",
"identifiers": [
{
"type": "nationalId",
"value": "000-00-9876"
}
],
"lastName": "Nerk",
"middleName": "Jim",
"relationship": {
"equityPercentage": 51.5,
"isAuthorizedSignatory": true,
"isControlProng": false,
"title": "CEO"
}
}
},
"ref_27e6c97d2efec1f915a5": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_3147c722e948ca9d06ad"
},
{
"properties": {
"amount": {
"description": "The total amount in the currency's lowest denomination. For example, cents.",
"example": 4999,
"format": "int64",
"type": "integer"
},
"currency": {
"$ref": "#/x-devx-bundled/ref_5c51a0e852c4baa940d0"
},
"dateTime": {
"description": "The processing date and time of the transaction represented as per [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) standard.",
"example": "2024-07-02T15:30:00Z",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"description": {
"description": "A brief description of the transaction.",
"example": "Pizza Doe #1234 - Dinner",
"maxLength": 256,
"minLength": 1,
"type": "string"
},
"orderId": {
"description": "Unique identifier that the merchant assigns to the transaction.",
"example": "OrderRef6543",
"maxLength": 24,
"minLength": 1,
"type": "string"
}
},
"type": "object"
}
],
"description": "Object that contains information about the transaction.",
"required": [
"amount",
"currency",
"orderId"
],
"type": "object"
},
"ref_27e6d0e095fb23cba669": {
"description": "Object that contains HATEOAS links for the resource.",
"example": {
"href": "",
"method": "get",
"rel": "previous"
},
"properties": {
"href": {
"description": "URL of the target resource.",
"type": "string"
},
"method": {
"description": "HTTP method that you need to use with the target resource.",
"type": "string"
},
"rel": {
"description": "Indicates the relationship between the current resource and the target resource.",
"type": "string"
}
},
"readOnly": true,
"required": [
"href",
"method",
"rel"
],
"type": "object"
},
"ref_2814f083a1062466f4a7": {
"description": "Payment instruction failed",
"summary": "Payment instruction failed",
"value": {
"detail": "You cannot cancel this resource in its current state",
"errors": [
{
"message": "Failed instruction cannot be canceled",
"parameter": "paymentInstructionId"
}
],
"status": 409,
"title": "Cannot be canceled",
"type": "https://docs.payroc.com/api/errors#cannot-be-canceled"
}
},
"ref_2815804b038ded2dca60": {
"description": "Time zone of the terminal. \n**Note**: If you don't send a value for this parameter, we use the time zone of the processing account.\n",
"enum": [
"Pacific/Midway",
"Pacific/Honolulu",
"America/Anchorage",
"America/Los_Angeles",
"America/Denver",
"America/Phoenix",
"America/Chicago",
"America/Indiana/Indianapolis",
"America/New_York"
],
"example": "America/Chicago",
"maxLength": 28,
"type": "string"
},
"ref_283b52ea9b7aa2800220": {
"content": {
"application/problem+json": {
"examples": {
"apiError": {
"$ref": "#/x-devx-bundled/ref_63c2d7145a59d4c533c3"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_47fa8782801d5d623bee"
}
}
},
"description": "An error has occured"
},
"ref_283ef553782c41aae434": {
"description": "Payment plan after we applied the requested changes.",
"summary": "Update payment plan",
"value": {
"currency": "USD",
"customFieldNames": [
"yourCustomField"
],
"description": "Monthly Premium Club subscription",
"frequency": "yearly",
"length": 12,
"name": "Premium Club",
"onDelete": "complete",
"onUpdate": "continue",
"paymentPlanId": "PlanRef8765",
"processingTerminalId": "1234001",
"recurringOrder": {
"amount": 4999,
"breakdown": {
"subtotal": 4347,
"taxes": [
{
"name": "Sales Tax",
"rate": 5
}
]
},
"description": "Monthly Premium Club subscription"
},
"setupOrder": {
"amount": 2999,
"breakdown": {
"subtotal": 4347,
"taxes": [
{
"name": "Sales Tax",
"rate": 5
}
]
},
"description": "Initial setup fee for Premium Club subscription"
},
"type": "automatic"
}
},
"ref_286c4ce529563a5dbc40": {
"properties": {
"amount": {
"description": "Amount of the payment that the merchant wants to reverse. The value is in the currency’s lowest denomination, for example, cents. \n**Note:** If the merchant doesn’t send an amount, we reverse the total amount of the transaction.\n",
"format": "int64",
"type": "integer"
},
"operator": {
"description": "Operator who reversed the payment.",
"maxLength": 50,
"minLength": 0,
"type": "string"
}
},
"type": "object"
},
"ref_28af77069da9ddbc9a01": {
"description": "One or more validation errors occurred",
"summary": "Bad Request",
"value": {
"detail": "One or more validation errors occurred, see error section for more info",
"errors": [
{
"detail": "invalid value",
"message": "Expected integer, got abc",
"parameter": "achDepositId"
}
],
"status": 400,
"title": "Bad request",
"type": "https://docs.payroc.com/api/errors#bad-request"
}
},
"ref_28d1459a8daa1b3d6ae5": {
"description": "Object that contains the 3-D Secure information from our gateway.",
"properties": {
"mpiReference": {
"description": "Reference that our gateway assigned to the 3-D Secure authentication response.",
"example": "MPI45678901234567890",
"maxLength": 20,
"minLength": 20,
"type": "string"
},
"serviceProvider": {
"description": "Provider of your 3-D Secure protocol.",
"enum": [
"gateway"
],
"example": "gateway",
"type": "string"
}
},
"required": [
"serviceProvider",
"mpiReference"
],
"title": "gateway",
"type": "object"
},
"ref_292e08bfbecddaecee9e": {
"description": "Convert a single-use token to a secure token when running a card sale.",
"summary": "Card sale with single-use token that we convert to a secure token",
"value": {
"card": {
"cardNumber": "453985******7062",
"cardholderName": "Sarah Hopper",
"entryMethod": "keyed",
"expiryDate": "1230",
"secureToken": {
"customerName": "Sarah Hopper",
"link": {
"href": "https://api.payroc.com/v1/processing-terminals/1234001/secure-tokens/MREF_abc1de23-f4a5-6789-bcd0-12e345678901fa",
"method": "GET",
"rel": "self"
},
"secureTokenId": "MREF_abc1de23-f4a5-6789-bcd0-12e345678901fa",
"status": "notValidated",
"token": "296753123456"
},
"securityChecks": {
"avsResult": "Y",
"cvvResult": "M"
},
"type": "Visa Credit"
},
"customFields": [
{
"name": "yourCustomField",
"value": "abc123"
}
],
"customer": {
"billingAddress": {
"address1": "1 Example Ave.",
"address2": "Example Address Line 2",
"address3": "Example Address Line 3",
"city": "Chicago",
"country": "US",
"postalCode": "60056",
"state": "Illinois"
},
"firstName": "Sarah",
"lastName": "Hopper",
"shippingAddress": {
"address": {
"address1": "1 Example Ave.",
"address2": "Example Address Line 2",
"address3": "Example Address Line 3",
"city": "Chicago",
"country": "US",
"postalCode": "60056",
"state": "Illinois"
},
"recipientName": "Sarah Hopper"
}
},
"operator": "Jane",
"order": {
"amount": 4999,
"currency": "USD",
"dateTime": "2024-07-02T15:30:00Z",
"description": "Large Pepperoni Pizza",
"orderId": "OrderRef6543"
},
"paymentId": "M2MJOG6O2Y",
"processingTerminalId": "1234001",
"supportedOperations": [
"capture",
"fullyReverse",
"partiallyReverse",
"incrementAuthorization",
"adjustTip",
"setAsPending"
],
"transactionResult": {
"approvalCode": "OK3",
"authorizedAmount": 4999,
"cardSchemeReferenceId": "ABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890",
"currency": "USD",
"responseCode": "A",
"responseMessage": "OK3",
"status": "ready",
"type": "sale"
}
}
},
"ref_293e87b51ba5db0b6d53": {
"description": "Secure token after we updated the account details from a single-use token.",
"summary": "Update account details",
"value": {
"customFields": [
{
"name": "yourCustomField",
"value": "abc123"
}
],
"customer": {
"billingAddress": {
"address1": "1 Example Ave.",
"address2": "Example Address Line 2",
"address3": "Example Address Line 3",
"city": "Chicago",
"country": "US",
"postalCode": "60056",
"state": "Illinois"
},
"contactMethods": [
{
"type": "email",
"value": "sarah.hopper@example.com"
}
],
"dateOfBirth": "1990-07-15",
"firstName": "Sarah",
"lastName": "Hopper",
"notificationLanguage": "en",
"referenceNumber": "Customer-12",
"shippingAddress": {
"address": {
"address1": "1 Example Ave.",
"address2": "Example Address Line 2",
"address3": "Example Address Line 3",
"city": "Chicago",
"country": "US",
"postalCode": "60056",
"state": "Illinois"
},
"recipientName": "Sarah Hopper"
}
},
"mitAgreement": "unscheduled",
"processingTerminalId": "1234001",
"secureTokenId": "MREF_abc1de23-f4a5-6789-bcd0-12e345678901fa",
"source": {
"cardNumber": "453985******7062",
"cardholderName": "Sarah Hazel Hopper",
"expiryDate": "1230",
"type": "card"
},
"status": "notValidated",
"token": "296753123456"
}
},
"ref_295fbadd8def89ad2675": {
"description": "Subscription with surcharge",
"summary": "Subscription with surcharge",
"value": {
"description": "Premium Club subscription",
"endDate": "2025-07-01",
"length": 12,
"name": "Premium Club",
"pauseCollectionFor": 0,
"paymentMethod": {
"token": "296753123456",
"type": "secureToken"
},
"paymentPlanId": "PlanRef8765",
"recurringOrder": {
"amount": 4999,
"breakdown": {
"subtotal": 4347,
"taxes": [
{
"name": "Sales Tax",
"rate": 5,
"type": "rate"
}
]
},
"description": "Monthly Premium Club subscription"
},
"setupOrder": {
"amount": 4999,
"description": "Initial setup fee for Premium Club subscription",
"orderId": "OrderRef6543"
},
"startDate": "2024-07-02",
"subscriptionId": "SubRef7654"
}
},
"ref_298348ccdbe167891cea": {
"description": "The tax ID supplied is already in use.",
"summary": "Tax ID in use",
"value": {
"detail": "The tax ID that you supplied is already in use. Supply a unique tax ID",
"status": 409,
"title": "Tax ID already in use",
"type": "https://docs.payroc.com/api/errors#tax-id-in-use"
}
},
"ref_29b4dc1e4e86986370be": {
"description": "Start a session with Apple to accept a payment with Apple Pay.",
"summary": "Apple Pay session",
"value": {
"appleDomainId": "DUHDZJHGYY",
"appleValidationUrl": "https://apple-pay-gateway.apple.com/paymentservices/startSession"
}
},
"ref_2af9c6993f8d5a424f9e": {
"properties": {
"amount": {
"default": 1295,
"description": "Fee for Platinum Security. The value is in the currency's lowest denomination, for example, cents.",
"example": 1295,
"type": "integer"
},
"billingFrequency": {
"description": "Indicates whether we bill your account monthly or annually.",
"enum": [
"monthly"
],
"type": "string"
}
},
"required": [
"billingFrequency"
],
"title": "monthly",
"type": "object"
},
"ref_2b34b6058854a07b6289": {
"properties": {
"transaction": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_109fe7e5f018de7ee04b"
}
],
"description": "Fee for each transaction. The value is in the currency's lowest denomination, for example, cents."
},
"type": {
"description": "Type of American Express program.",
"enum": [
"direct"
],
"type": "string"
}
},
"required": [
"type",
"transaction"
],
"title": "direct",
"type": "object"
},
"ref_2b3621a1c5ae119c6693": {
"description": "One or more validation errors occurred",
"summary": "Bad Request",
"value": {
"detail": "One or more validation errors occurred, see error section for more info",
"errors": [
{
"detail": "invalid date",
"message": "Expected time, got '' for start_time",
"parameter": "start_time"
}
],
"status": 400,
"title": "Bad request",
"type": "https://docs.payroc.com/api/errors#bad-request"
}
},
"ref_2b731996ac4e1475cf38": {
"description": "Create a pricing intent.",
"summary": "Create pricing intent",
"value": {
"base": {
"addressVerification": 5,
"annualFee": {
"amount": 9900,
"billInMonth": "june"
},
"batch": 1500,
"chargeback": 2500,
"earlyTermination": 57500,
"maintenance": 500,
"minimum": 100,
"pciNonCompliance": 4995,
"platinumSecurity": {
"billingFrequency": "monthly"
},
"regulatoryAssistanceProgram": 15,
"retrieval": 1500,
"voiceAuthorization": 95
},
"country": "US",
"gateway": {
"fees": {
"monthly": 2000,
"perDeviceMonthly": 10,
"perTransaction": 2000,
"setup": 5000
}
},
"key": "Your-Unique-Identifier",
"metadata": {
"yourCustomField": "abc123"
},
"processor": {
"ach": {
"fees": {
"accountVerification": 10,
"batch": 5,
"discountRateAbove10000": 10,
"discountRateUnder10000": 5.25,
"monthlyMinimum": 20000,
"returns": 400,
"statement": 800,
"transaction": 50,
"unauthorizedReturn": 1999
}
},
"card": {
"fees": {
"amex": {
"transaction": 5,
"type": "optBlue",
"volume": 1.25
},
"electronicBenefitsTransfer": {
"transaction": 10
},
"mastercardVisaDiscover": {
"transaction": 5,
"volume": 1.25
},
"pinDebit": {
"additionalDiscount": 1.25,
"monthlyAccess": 1200,
"transaction": 10
},
"specialityCards": {
"transaction": 10
}
},
"planType": "interchangePlus"
}
},
"services": [
{
"enabled": true,
"name": "hardwareAdvantagePlan"
}
],
"version": "5.2"
}
},
"ref_2c0da1d78400d9a0cf32": {
"description": "Payment plan after the test operation. A test operation asserts a value, so the payment plan doesn't change.\n",
"summary": "Update payment plan: test",
"value": {
"currency": "USD",
"customFieldNames": [
"yourCustomField"
],
"description": "Monthly Premium Club subscription",
"frequency": "monthly",
"length": 12,
"name": "Premium Club",
"onDelete": "complete",
"onUpdate": "continue",
"paymentPlanId": "PlanRef8765",
"processingTerminalId": "1234001",
"recurringOrder": {
"amount": 4999,
"breakdown": {
"subtotal": 4347,
"taxes": [
{
"name": "Sales Tax",
"rate": 5
}
]
},
"description": "Monthly Premium Club subscription"
},
"setupOrder": {
"amount": 4999,
"breakdown": {
"subtotal": 4347,
"taxes": [
{
"name": "Sales Tax",
"rate": 5
}
]
},
"description": "Initial setup fee for Premium Club subscription"
},
"type": "automatic"
}
},
"ref_2c771c635a39c1d2ba57": {
"description": "Object that contains the fees for EBT transactions.",
"properties": {
"transaction": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_109fe7e5f018de7ee04b"
}
],
"description": "Fee for each transaction. The value is in the currency's lowest denomination, for example, cents."
}
},
"required": [
"transaction"
],
"type": "object"
},
"ref_2cab84ef08bff0d773e2": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_10bf124ff96e7a81434e"
}
],
"description": "Object that contains information about the transaction.",
"properties": {
"taxes": {
"description": "Array of tax objects.",
"items": {
"$ref": "#/x-devx-bundled/ref_ff9e53b467436d074a75"
},
"type": "array"
}
},
"required": [
"subtotal"
],
"type": "object"
},
"ref_2cb9a51f12a0448ec194": {
"description": "Object that contains information about plain-text swiped card data.",
"properties": {
"dataFormat": {
"description": "Indicates the method the customer’s card data is encrypted.\nSend swiped card data in encrypted format or `plainText` format.\n",
"enum": [
"plainText"
],
"example": "plainText",
"type": "string"
},
"device": {
"$ref": "#/x-devx-bundled/ref_32a04596e26026b47268"
},
"fallback": {
"description": "Indicates that this is a fallback transaction. For example, if there was a technical issue with the chip on the customer's card and the merchant then swiped the card.",
"example": true,
"type": "boolean"
},
"fallbackReason": {
"description": "Reason for the fallback.",
"enum": [
"technical",
"repeatFallback",
"emptyCandidateList"
],
"example": "technical",
"type": "string"
},
"trackData": {
"description": "Customer’s card data from the swiped transaction.",
"example": "1234567890123456789012345678901234567890",
"maxLength": 256,
"minLength": 16,
"type": "string"
}
},
"required": [
"dataFormat",
"device",
"trackData"
],
"title": "plainText",
"type": "object"
},
"ref_2d8cb91e6a2384abffc7": {
"content": {
"application/problem+json": {
"examples": {
"payloadTooLarge": {
"$ref": "#/x-devx-bundled/ref_449c2c080ce6361c32b6"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_83e8963b8ade74847630"
}
}
},
"description": "Payload too large"
},
"ref_2da15af34cb3b5834e40": {
"description": "Secure token after we copied the customer's first name over their last name.",
"summary": "Update secure token: copy",
"value": {
"customFields": [
{
"name": "yourCustomField",
"value": "abc123"
}
],
"customer": {
"billingAddress": {
"address1": "1 Example Ave.",
"address2": "Example Address Line 2",
"address3": "Example Address Line 3",
"city": "Chicago",
"country": "US",
"postalCode": "60056",
"state": "Illinois"
},
"contactMethods": [
{
"type": "email",
"value": "sarah.hopper@example.com"
}
],
"dateOfBirth": "1990-07-15",
"firstName": "Sarah",
"lastName": "Sarah",
"notificationLanguage": "en",
"referenceNumber": "Customer-12",
"shippingAddress": {
"address": {
"address1": "1 Example Ave.",
"address2": "Example Address Line 2",
"address3": "Example Address Line 3",
"city": "Chicago",
"country": "US",
"postalCode": "60056",
"state": "Illinois"
},
"recipientName": "Sarah Hopper"
}
},
"mitAgreement": "unscheduled",
"processingTerminalId": "1234001",
"secureTokenId": "MREF_abc1de23-f4a5-6789-bcd0-12e345678901fa",
"source": {
"cardNumber": "453985******7062",
"cardholderName": "Sarah Hazel Hopper",
"expiryDate": "1230",
"type": "card"
},
"status": "notValidated",
"token": "296753123456"
}
},
"ref_2e353a00051ad58aa9b8": {
"description": "Filter by the last four digits of the card or account number.",
"examples": {
"example": {
"value": "7062"
}
},
"in": "query",
"name": "last4",
"schema": {
"pattern": "[0-9]{4}",
"type": "string"
}
},
"ref_2e70e7dd6cd1784afd3a": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_f9d963d00740bbe00c9e"
},
{
"properties": {
"data": {
"description": "Array of device objects. Each object contains information about a device.",
"items": {
"properties": {
"createdDate": {
"description": "Date and time that our gateway added the device to our systems. Our gateway returns this value in the [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
"example": "2024-01-01T12:00:00.000+00:00",
"format": "date-time",
"type": "string"
},
"deactivatedDate": {
"description": "Date and time that we deactivated the device. Our gateway returns this value in the [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.\n\n**Note:** If the device is active, our gateway doesn't return a value for `deactivatedDate`.\n",
"example": "2024-06-01T12:00:00Z",
"format": "date-time",
"type": "string"
},
"deviceId": {
"description": "Unique identifier that we assigned to the device.",
"example": "H7KPQ2M4XN",
"type": "string"
},
"deviceType": {
"description": "Object that contains information about the device.",
"properties": {
"manufacturer": {
"description": "Company that manufactured the device.",
"example": "idtech",
"type": "string"
},
"model": {
"description": "Model or type of the device.",
"example": "idtechKioskV",
"type": "string"
}
},
"type": "object"
},
"ksi": {
"description": "Key serial identifier (KSI) of the device.",
"example": "FFFF5B0991ABCD01",
"type": "string"
},
"lastTransaction": {
"description": "Object that contains information about the last transaction that the device processed.",
"properties": {
"dateTime": {
"description": "Date and time that the processing terminal processed the last transaction. Our gateway returns this value in the [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
"example": "2024-07-02T15:30:00.000+00:00",
"format": "date-time",
"type": "string"
},
"orderId": {
"description": "Unique identifier that the merchant assigned to the order.",
"example": "OrderRef6543",
"type": "string"
},
"processingTerminalId": {
"description": "Unique identifier that we assigned to the processing terminal.",
"example": "1234001",
"type": "string"
}
},
"type": "object"
},
"links": {
"items": {
"$ref": "#/x-devx-bundled/ref_27e6d0e095fb23cba669"
},
"readOnly": true,
"type": "array"
},
"serialNumber": {
"description": "Serial number of the device.",
"example": "1850010868",
"type": "string"
},
"tender": {
"description": "Payment methods accepted by the device. \n\n- `creditDebit` – Credit and debit card payments. \n- `ebt` – Electronic Benefit Transfer (EBT) payments. \n",
"enum": [
"creditDebit",
"ebt"
],
"example": "ebt",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
],
"required": [
"count",
"data",
"hasMore",
"limit"
],
"type": "object"
},
"ref_2f7f66a1f273572e1bdd": {
"additionalProperties": false,
"description": "Installment Payments, Loans, or Lease Questionnaire/Attestation for merchants that offer installment payments, loans, or leases.",
"properties": {
"type": {
"const": "installmentPaymentsV1",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"ref_2f94b2465c1e3956dcf6": {
"description": "KYC check failed",
"summary": "KYC check failed",
"value": {
"detail": "Entity has been rejected due to failing KYC checks",
"status": 400,
"title": "Failed KYC Checks",
"type": "https://docs.payroc.com/api/errors#kyc-check-failed"
}
},
"ref_2fd09ba629b748a2894a": {
"description": "Your request included more than one owner as the control prong. You can set only one owner as the control prong.",
"summary": "Too many control prongs",
"value": {
"detail": "You can set only one owner as the control prong",
"status": 400,
"title": "Too many control prongs",
"type": "https://docs.payroc.com/api/errors#too-many-control-prongs"
}
},
"ref_2ff3dcfd5eef52a50a9b": {
"description": "Paginated Refund",
"summary": "Paginated Refund",
"value": {
"count": 2,
"data": [
{
"card": {
"cardNumber": "453985******7062",
"entryMethod": "keyed",
"expiryDate": "1230",
"type": "Visa Credit"
},
"order": {
"amount": 4999,
"currency": "USD",
"dateTime": "2024-07-02T15:30:00Z",
"description": "Refund for order OrderRef6543",
"orderId": "OrderRef6543"
},
"processingTerminalId": "1234001",
"refundId": "CD3HN88U9F",
"transactionResult": {
"approvalCode": "000000",
"authorizedAmount": -4999,
"currency": "USD",
"responseCode": "A",
"responseMessage": "APPROVAL",
"status": "ready",
"type": "refund"
}
},
{
"card": {
"cardNumber": "500165******0000",
"entryMethod": "keyed",
"expiryDate": "0328",
"type": "MasterCard"
},
"customFields": [
{
"name": "yourCustomField",
"value": "abc123"
}
],
"order": {
"amount": 3999,
"currency": "USD",
"dateTime": "2024-07-02T15:30:00Z",
"description": "Refund for order OrderRef7654",
"orderId": "OrderRef7654"
},
"processingTerminalId": "1234001",
"refundId": "B6ZOFZNVOP",
"transactionResult": {
"approvalCode": "000000",
"authorizedAmount": -3999,
"currency": "USD",
"responseCode": "A",
"responseMessage": "APPROVAL",
"status": "reversal",
"type": "refund"
}
}
],
"hasMore": true,
"limit": 2,
"links": [
{
"href": "https://api.payroc.com/v1/refunds?processingTerminalId=1234001&limit=2&after=B6ZOFZNVOP",
"method": "get",
"rel": "next"
},
{
"href": "https://api.payroc.com/v1/refunds?processingTerminalId=1234001&limit=2&before=CD3HN88U9F",
"method": "get",
"rel": "previous"
}
]
}
},
"ref_305dbe8e7f7fb88c4ebf": {
"description": "Object that contains information about the plain-text card data for keyed transactions.",
"properties": {
"cardNumber": {
"description": "Customer’s card number.",
"example": "4539858876047062",
"maxLength": 19,
"minLength": 12,
"type": "string"
},
"cvv": {
"description": "Security code of the customer’s card.",
"example": "234",
"pattern": "[0-9]{3,4}",
"type": "string"
},
"dataFormat": {
"description": "Indicates the data format of the customer’s card data.\n-\t`plainText` – Data is not truncated and shows the raw data.\n-\t`fullyEncrypted` – Data is truncated to show only the first digit of the customer’s account number.\n-\t`partiallyEncrypted` – Data is truncated to show only the first six digits and the last four digits of the customer’s card number.\n",
"enum": [
"plainText"
],
"example": "plainText",
"type": "string"
},
"device": {
"$ref": "#/x-devx-bundled/ref_32a04596e26026b47268"
},
"expiryDate": {
"description": "Expiry date of the customer’s card. \n**Note:** We require you to send an expiry date for most BIN lookups and electronic voucher transactions.\n",
"example": "1230",
"pattern": "[0-9]{4}",
"type": "string"
},
"issueNumber": {
"description": "Issue number of the customer’s card.",
"example": "78",
"pattern": "[0-9]{1,2}",
"type": "string"
}
},
"required": [
"dataFormat",
"cardNumber"
],
"title": "plainText",
"type": "object"
},
"ref_30c7e63fc155b2e36fdd": {
"description": "Object that contains information about saving the customer’s payment details.",
"properties": {
"mitAgreement": {
"default": "unscheduled",
"description": "Indicates how the merchant can use the customer’s card details, as agreed by the customer: \n\n- `unscheduled` - Transactions for a fixed or variable amount that are run at a certain pre-defined event. \n- `recurring` - Transactions for a fixed amount that are run at regular intervals, for example, monthly. Recurring transactions don’t have a fixed duration and run until the customer cancels the agreement. \n- `installment` - Transactions for a fixed amount that are run at regular intervals, for example, monthly. Installment transactions have a fixed duration. \n \n**Note:** If you send a value for **mitAgreement**, you must send the **standingInstructions** object in the **paymentOrder** object.\n",
"enum": [
"unscheduled",
"recurring",
"installment"
],
"example": "recurring",
"type": "string"
},
"tokenize": {
"description": "Indicates if our gateway should tokenize the customer’s payment details as part of the transaction.",
"example": true,
"type": "boolean"
}
},
"type": "object"
},
"ref_310c008ff9cb41a59c8a": {
"description": "Date the transaction was settled.",
"examples": {
"example": {
"value": "2024-07-02"
}
},
"in": "query",
"name": "settlementDate",
"schema": {
"format": "date",
"type": "string"
}
},
"ref_3123aae2343c4cee5777": {
"properties": {
"customFields": {
"description": "Array of customField objects.\n",
"items": {
"$ref": "#/x-devx-bundled/ref_91509fee696e20aa30f2"
},
"type": "array"
},
"customer": {
"$ref": "#/x-devx-bundled/ref_99ef61275025cb524caf"
},
"order": {
"$ref": "#/x-devx-bundled/ref_f640737cfbed9624abf9"
},
"processingTerminalId": {
"description": "Unique identifier that we assigned to the terminal.",
"example": "52d9b7f7-3b39-4cd6-9acb-1050f8593ec6",
"maxLength": 50,
"minLength": 4,
"type": "string"
},
"refundMethod": {
"description": "Polymorphic object that contains payment details for the refund. \n\nThe value of the type parameter determines which variant you should use: \n-\t`ach` - Automated Clearing House (ACH) details\n-\t`secureToken` - Secure token details\n",
"discriminator": {
"mapping": {
"ach": "../../../common/schemas/transaction/payment-method-v1.yaml#/components/schemas/achPayload",
"secureToken": "../../../common/schemas/transaction/payment-method-v1.yaml#/components/schemas/secureTokenPayload"
},
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/x-devx-bundled/ref_c799d35ea53644eec4e6"
},
{
"$ref": "#/x-devx-bundled/ref_8a84ce450c6452ba8861"
}
],
"type": "object"
}
},
"required": [
"order",
"processingTerminalId",
"refundMethod"
],
"type": "object"
},
"ref_3147c722e948ca9d06ad": {
"description": "Object that contains details about the transaction.",
"properties": {
"amount": {
"description": "Total amount of the transaction. The value is in the currency’s lowest denomination, for example, cents.",
"example": 2899,
"format": "int64",
"type": "integer"
},
"currency": {
"$ref": "#/x-devx-bundled/ref_5c51a0e852c4baa940d0"
},
"dateTime": {
"description": "Date and time that the processor processed the transaction. Our gateway returns this value in the [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
"example": "2024-07-02T15:30:00Z",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"description": {
"description": "Description of the transaction.",
"example": "Pizza Doe #1234 - Dinner",
"maxLength": 1024,
"minLength": 0,
"type": "string"
},
"orderId": {
"description": "Unique identifier that the merchant assigns to the transaction.",
"example": "OrderRef6543",
"maxLength": 24,
"minLength": 1,
"type": "string"
}
},
"required": [
"amount",
"currency",
"orderId"
],
"type": "object"
},
"ref_31d3b813b1b175136a5f": {
"properties": {
"convenienceFee": {
"$ref": "#/x-devx-bundled/ref_73ccf7ffa65b9a82668c"
},
"subtotal": {
"description": "Total amount for the transaction before tax. The value is in the currency's lowest denomination, for example, cents.",
"example": 4500,
"format": "int64",
"type": "integer"
}
},
"required": [
"subtotal"
],
"type": "object"
},
"ref_31d65dcf82420e739468": {
"description": "Type of address.",
"properties": {
"type": {
"default": "legalAddress",
"description": "Type of address.",
"enum": [
"legalAddress"
],
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"ref_3200994f911b36ba58d7": {
"description": "Payment link is unchanged because the test operation only asserts that a value matches.",
"summary": "Update payment link: test",
"value": {
"assets": {
"paymentButton": "PAY NOW\n",
"paymentUrl": "https://payments.payroc.com/merchant/pay-by-link?token=7c2fc08c-cb0e-44ba-8bcd-cf6de6eb3206"
},
"authType": "sale",
"createdOn": "2024-07-24",
"customLabels": [
{
"element": "paymentButton",
"label": "PAY NOW"
}
],
"expiresOn": "2024-08-02",
"merchantReference": "LinkRef7654",
"order": {
"charge": {
"amount": 4999,
"currency": "USD",
"type": "preset"
},
"description": "Large Pepperoni Pizza",
"orderId": "OrderRef7654"
},
"paymentLinkId": "CKHP6VVWYT",
"paymentMethods": [
"card"
],
"status": "active",
"type": "singleUse"
}
},
"ref_32724c841d41813a03f6": {
"description": "Object that contains information about the encrypted card data for keyed transactions.",
"properties": {
"dataFormat": {
"description": "Indicates the data format of the customer’s card data.\n-\t`plainText` – Data is not truncated and shows the raw data.\n-\t`fullyEncrypted` – Data is truncated to show only the first digit of the customer’s account number.\n-\t`partiallyEncrypted` – Data is truncated to show only the first six digits and the last four digits of the customer’s card number.\n",
"enum": [
"fullyEncrypted"
],
"example": "fullyEncrypted",
"type": "string"
},
"device": {
"$ref": "#/x-devx-bundled/ref_9b532b6dac98bf9563ff"
},
"encryptedData": {
"description": "Encrypted card data.",
"example": "A1B2C3D4E5F67890ABCD1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF",
"format": "hexadecimal",
"maxLength": 2147483647,
"minLength": 1,
"type": "string"
},
"firstDigitOfPan": {
"description": "First digit of the customer’s card number.",
"example": "4",
"maxLength": 1,
"minLength": 1,
"type": "string"
}
},
"required": [
"dataFormat",
"device",
"encryptedData"
],
"title": "fullyEncrypted",
"type": "object"
},
"ref_32a04596e26026b47268": {
"description": "Object that contains information about the physical device the merchant used to capture the customer’s card details.",
"properties": {
"category": {
"default": "attended",
"description": "Indicates if the device is attended or unattended.",
"enum": [
"attended",
"unattended"
],
"example": "attended",
"type": "string"
},
"config": {
"$ref": "#/x-devx-bundled/ref_b8cdc1351709808de954"
},
"firmwareVersion": {
"description": "Firmware version of the physical device.",
"example": "v1.2.3",
"type": "string"
},
"model": {
"description": "Model of the device that the merchant used to process the transaction.",
"enum": [
"bbposChp",
"bbposChp2x",
"bbposChp3x",
"bbposRambler",
"bbposWp",
"bbposWp2",
"bbposWp3",
"genericCtlsMsr",
"genericMsr",
"idtechAugusta",
"idtechMinismart",
"idtechSredkey",
"idtechVp3300",
"idtechVp5300",
"idtechVp6300",
"idtechVp6800",
"ingenicoAxiumDx4000",
"ingenicoAxiumDx8000",
"ingenicoAxiumEx8000",
"ingenicoIct220",
"ingenicoIpp320",
"ingenicoIpp350",
"ingenicoIuc285",
"ingenicoL3000",
"ingenicoL7000",
"ingenicoS2000",
"ingenicoS3000",
"ingenicoS4000",
"ingenicoS5000",
"ingenicoS7000",
"paxA80",
"paxA920",
"paxA920Pro",
"paxA920Max",
"paxE500",
"paxE700",
"paxE800",
"paxIm30",
"uic680",
"uicBezel8"
],
"example": "paxA920",
"type": "string"
},
"serialNumber": {
"description": "Serial number of the physical device.",
"example": "1850010868",
"maxLength": 64,
"minLength": 1,
"type": "string"
}
},
"required": [
"model",
"serialNumber"
],
"type": "object"
},
"ref_32b762f183bf0f0317c8": {
"description": "Retrieve a specific processing account.",
"summary": "Retrieve processing account",
"value": {
"addendums": [],
"address": {
"address1": "1 Example Ave.",
"address2": "Example Address Line 2",
"address3": "Example Address Line 3",
"city": "Chicago",
"country": "US",
"postalCode": "60056",
"state": "Illinois"
},
"businessStartDate": "2020-01-01",
"businessType": "restaurant",
"categoryCode": 5999,
"contactMethods": [
{
"type": "email",
"value": "jane.doe@example.com"
}
],
"contacts": [
{
"contactId": 1543,
"firstName": "Jane",
"lastName": "Doe",
"link": {
"href": "https://api.payroc.com/v1/contacts/1543",
"method": "get",
"rel": "contact"
}
}
],
"createdDate": "2024-07-02T12:00:00.000+00:00",
"doingBusinessAs": "Pizza Doe",
"funding": {
"acceleratedFundingFee": 1999,
"dailyDiscount": false,
"fundingAccounts": [
{
"fundingAccountId": 123,
"link": {
"href": "https://api.payroc.com/v1/funding-accounts/123",
"method": "get",
"rel": "fundingAccount"
},
"status": "pending"
}
],
"fundingSchedule": "nextday",
"status": "enabled"
},
"lastModifiedDate": "2024-07-02T12:00:00.000+00:00",
"merchandiseOrServiceSold": "Pizza",
"metadata": {
"customerId": "2345"
},
"owners": [
{
"firstName": "Jane",
"lastName": "Doe",
"link": {
"href": "https://api.payroc.com/v1/owners/1543",
"method": "get",
"rel": "owner"
},
"ownerId": 4564
}
],
"pricing": {
"link": {
"href": "https://api.payroc.com/v1/processing-accounts/38765/pricing",
"method": "get",
"rel": "pricing"
}
},
"processing": {
"ach": {
"estimatedMonthlyTransactions": 3000,
"limits": {
"dailyDeposit": 200000,
"monthlyDeposit": 6000000,
"singleTransaction": 10000
},
"naics": "5812",
"previouslyTerminatedForAch": false,
"refunds": {
"refundPolicyUrl": "http://www.example.com/refunds",
"writtenRefundPolicy": true
},
"transactionTypes": [
"prearrangedPayment",
"other"
],
"transactionTypesOther": "recurringBilling"
},
"cardAcceptance": {
"cardsAccepted": [
"visa",
"mastercard"
],
"debitOnly": false,
"hsaFsa": false,
"specialityCards": {
"americanExpressDirect": {
"enabled": true,
"merchantNumber": "abc1234567"
},
"electronicBenefitsTransfer": {
"enabled": true,
"fnsNumber": "6789012"
},
"other": {
"fleetMerchantId": "abc1234567",
"voyagerMerchantId": "abc1234567",
"wexMerchantNumber": "abc1234567"
}
}
},
"isSeasonal": true,
"merchantId": "444412365478965",
"monthlyAmounts": {
"average": 50000,
"highest": 100000
},
"monthsOfOperation": [
"jan",
"feb"
],
"transactionAmounts": {
"average": 5000,
"highest": 10000
},
"volumeBreakdown": {
"cardPresent": 77,
"ecommerce": 20,
"mailOrTelephone": 3
}
},
"processingAccountId": "38765",
"processor": "tsys",
"signature": {
"link": {
"href": "https://us.agreementexpress.net/mv2/viewer2.jsp?docId=00000000-0000-0000-0000-000000000000",
"method": "get",
"rel": "agreement"
},
"type": "requestedViaDirectLink"
},
"status": "approved",
"timezone": "America/Chicago",
"website": "www.example.com"
}
},
"ref_32bae5e693f8a11675b7": {
"description": "Create a single-use payment link.",
"summary": "Single-use payment link",
"value": {
"authType": "sale",
"customLabels": [
{
"element": "paymentButton",
"label": "PAY NOW"
}
],
"expiresOn": "2024-08-02",
"merchantReference": "LinkRef7654",
"order": {
"charge": {
"amount": 4999,
"currency": "USD",
"type": "preset"
},
"description": "Large Pepperoni Pizza",
"orderId": "OrderRef7654"
},
"paymentMethods": [
"card"
],
"type": "singleUse"
}
},
"ref_32d9784fa4b18a444793": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_f9d963d00740bbe00c9e"
},
{
"properties": {
"data": {
"description": "Array of fundingAccount objects.",
"items": {
"$ref": "#/x-devx-bundled/ref_9a102086f05b94adac7a"
},
"type": "array"
}
},
"required": [
"data"
],
"type": "object"
}
],
"title": "paginated funding accounts",
"type": "object"
},
"ref_32eaece5951b6d65379a": {
"description": "Fx-Rate",
"summary": "Fx-Rate",
"value": {
"baseAmount": 10000,
"baseCurrency": "EUR",
"cardInfo": {
"cardNumber": "453985******7062",
"type": "MASTERCARD"
},
"dccOffer": {
"fxAmount": 16125,
"fxCurrency": "JPY",
"fxCurrencyCode": "392",
"fxCurrencyExponent": 0,
"fxRate": 161.2542,
"markup": 3,
"offerReference": "3396977e-40b9-4b26-8a3f-c25bc1280ee2",
"provider": "DCC Provider Inc.",
"source": "European Central Bank"
},
"inquiryResult": {
"dccOffered": true
},
"operator": "Jane",
"processingTerminalId": "1234001"
}
},
"ref_332dff3df47ae1e824ea": {
"description": "Object that contains information about the breakdown of the transaction.",
"properties": {
"cashbackAmount": {
"description": "Amount of cashback for the transaction.",
"example": 0,
"format": "int64",
"type": "integer"
},
"dualPricing": {
"$ref": "#/x-devx-bundled/ref_cf9674a1156522156212",
"description": "Object that contains dual pricing information for the transaction."
},
"healthcareExpenses": {
"description": "Array of healthcareExpense objects that contain information about healthcare expenses.",
"items": {
"$ref": "#/x-devx-bundled/ref_622c8816a3233c2ac472"
},
"type": "array",
"uniqueItems": true
},
"subtotal": {
"description": "Amount of the transaction before tax and fees. The value is in the currency’s lowest denomination, for example, cents.\n\nRequired for [Level 2, Level 3, and CEDP transactions](https://docs.payroc.com/knowledge/card-payments/enhanced-data).\n",
"example": 2899,
"format": "int64",
"type": "integer"
},
"surcharge": {
"$ref": "#/x-devx-bundled/ref_d77d570c70a1a1c56a40",
"description": "Object that contains surcharge information for the transaction."
},
"tip": {
"$ref": "#/x-devx-bundled/ref_90d04e11e8f10457c837",
"description": "Object that contains tip information for the transaction."
}
},
"required": [
"subtotal"
],
"type": "object"
},
"ref_334757e333e1472fe694": {
"description": "Filter by refunds processed after a specific date. The date format follows the ISO 8601 standard.",
"examples": {
"example": {
"value": "2024-07-01T15:30:00Z"
}
},
"in": "query",
"name": "dateFrom",
"schema": {
"format": "date-time",
"type": "string"
}
},
"ref_33829c4d66f20fb157cc": {
"description": "Object that contains information about the progress of the refund instruction.",
"summary": "Refund instruction",
"value": {
"link": {
"href": "https://api.payroc.com/v1/refunds/CD3HN88U9F",
"method": "GET",
"rel": "refund"
},
"refundInstructionId": "a37439165d134678a9100ebba3b29597",
"status": "completed"
}
},
"ref_33a47f40f610a3ad4109": {
"content": {
"application/problem+json": {
"examples": {
"resourceExists": {
"$ref": "#/x-devx-bundled/ref_a35453ec328edef4593e"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_478798693738e1bfadb1"
}
}
},
"description": "Conflict"
},
"ref_33de603adc39427fa180": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_455786580bede80085f8"
},
{
"properties": {
"taxes": {
"description": "Array of objects that contain information about each tax that applies to the item.\n\nRequired for [Level 3 and CEDP transactions](https://docs.payroc.com/knowledge/card-payments/enhanced-data).\n",
"items": {
"$ref": "#/x-devx-bundled/ref_157b8aec350ce5596632"
},
"type": "array"
}
},
"type": "object"
}
],
"type": "object"
},
"ref_33e366b095d33923fb79": {
"description": "One or more validation errors occurred",
"summary": "Bad Request",
"value": {
"detail": "One or more validation errors occurred, see error section for more info",
"errors": [
{
"detail": "invalid date",
"message": "Expected date, got \"abc\"",
"parameter": "date"
}
],
"status": 400,
"title": "Bad request",
"type": "https://docs.payroc.com/api/errors#bad-request"
}
},
"ref_3436967d00d8bbbdb47f": {
"description": "Unique identifier of the merchant platform that we sent to you when you created the merchant platform.",
"examples": {
"example": {
"value": "12345"
}
},
"in": "path",
"name": "merchantPlatformId",
"required": true,
"schema": {
"type": "string"
}
},
"ref_3460aa5ce7d26ebeac26": {
"description": "Object that contains information about the ACH deposit.",
"properties": {
"achAdjustment": {
"description": "Amount of adjustments that we made to the ACH deposit. We return the value in the currency's lowest denomination, for example, cents.",
"example": 100,
"format": "int64",
"type": "integer"
},
"achDate": {
"description": "Date that we sent the ACH deposit. The format of this value is **YYYY-MM-DD**.",
"example": "2024-07-02",
"format": "date",
"type": "string"
},
"achDepositId": {
"description": "Unique identifier that we assigned to the ACH deposit.",
"example": 99,
"type": "integer"
},
"associationDate": {
"description": "Date that we sent the transactions to the card brands for clearing. The format of this value is **YYYY-MM-DD**.",
"example": "2024-07-02",
"format": "date",
"type": "string"
},
"dailyFees": {
"description": "Amount of fees that were applied to the transactions in the ACH deposit. We return the value in the currency's lowest denomination, for example cents.",
"example": 100,
"format": "int64",
"type": "integer"
},
"heldSales": {
"description": "Amount of funds that we held if the merchant was in full suspense. We return the value in the currency's lowest denomination, for example, cents.",
"example": 100,
"format": "int64",
"type": "integer"
},
"holdback": {
"description": "Amount of funds that we held as reserve from the ACH deposit. We return the value in the currency's lowest denomination, for example, cents.",
"example": 100,
"format": "int64",
"type": "integer"
},
"links": {
"example": [
{
"href": "https://api.payroc.com/v1/ach-deposit-fees?achDepositId=99&merchantId=4525644354",
"method": "get",
"rel": "achDepositFees"
}
],
"items": {
"$ref": "#/x-devx-bundled/ref_27e6d0e095fb23cba669"
},
"type": "array"
},
"merchant": {
"$ref": "#/x-devx-bundled/ref_67c77db80e4fded0ad81"
},
"netAmount": {
"description": "Total amount that we paid the merchant after fees and adjustments. We return the value in the currency's lowest denomination, for example, cents.",
"example": 5000,
"format": "int64",
"type": "integer"
},
"paymentDate": {
"description": "Date that the merchant received the ACH deposit. The format of this value is **YYYY-MM-DD**.",
"example": "2024-07-02",
"format": "date",
"type": "string"
},
"reserveRelease": {
"description": "Amount of funds that we released from holdback. We return the value in the currency's lowest denomination, for example, cents.",
"example": 100,
"format": "int64",
"type": "integer"
},
"returns": {
"description": "Amount of returns in the ACH deposit. We return the value in the currency's lowest denomination, for example, cents.",
"example": 100,
"format": "int64",
"type": "integer"
},
"sales": {
"description": "Amount of sales in the ACH deposit. We return the value in the currency's lowest denomination, for example, cents.",
"example": 5000,
"format": "int64",
"type": "integer"
},
"transactions": {
"description": "Number of transactions in the ACH deposit.",
"example": 20,
"type": "integer"
}
},
"title": "ACH deposit",
"type": "object"
},
"ref_34a8174ecf8111b901e0": {
"summary": "Paginated instructions list",
"value": {
"count": 2,
"data": [
{
"createdDate": "2024-07-02T15:30:00Z",
"instructionId": 64643131,
"lastModifiedDate": "2024-07-02T15:30:00Z",
"link": {
"href": "https://api.payroc.com/v1/funding-instructions/64643131",
"method": "get",
"rel": "fundingInstruction"
},
"merchants": [
{
"link": {
"href": "https://api.payroc.com/v1/processing-accounts/4525644354",
"method": "get",
"rel": "merchant"
},
"merchantId": "4525644354",
"recipients": [
{
"amount": {
"currency": "USD",
"value": 120000
},
"fundingAccountId": 123,
"link": {
"href": "https://api.payroc.com/v1/funding-accounts/123",
"method": "get",
"rel": "fundingAccount"
},
"metadata": {
"yourCustomField": "abc123"
},
"paymentMethod": "ACH",
"status": "funded"
},
{
"amount": {
"currency": "USD",
"value": 50050
},
"fundingAccountId": 124,
"link": {
"href": "https://api.payroc.com/v1/funding-accounts/124",
"method": "get",
"rel": "fundingAccount"
},
"metadata": {
"yourCustomField": "abc123"
},
"paymentMethod": "ACH",
"status": "rejected"
}
]
}
],
"metadata": {
"yourCustomField": "abc123"
},
"status": "completed"
},
{
"createdDate": "2024-07-02T15:30:00Z",
"instructionId": 64643132,
"lastModifiedDate": "2024-07-02T15:30:00Z",
"link": {
"href": "https://api.payroc.com/v1/funding-instructions/64643132",
"method": "get",
"rel": "fundingInstruction"
},
"merchants": [
{
"link": {
"href": "https://api.payroc.com/v1/processing-accounts/4525644354",
"method": "get",
"rel": "merchant"
},
"merchantId": "4525644354",
"recipients": [
{
"amount": {
"currency": "USD",
"value": 5000
},
"fundingAccountId": 123,
"link": {
"href": "https://api.payroc.com/v1/funding-accounts/123",
"method": "get",
"rel": "fundingAccount"
},
"metadata": {
"yourCustomField": "abc123"
},
"paymentMethod": "ACH",
"status": "accepted"
}
]
},
{
"link": {
"href": "https://api.payroc.com/v1/processing-accounts/4525644354",
"method": "get",
"rel": "merchant"
},
"merchantId": "4525644354",
"recipients": [
{
"amount": {
"currency": "USD",
"value": 1000
},
"fundingAccountId": 124,
"link": {
"href": "https://api.payroc.com/v1/funding-accounts/124",
"method": "get",
"rel": "fundingAccount"
},
"metadata": {
"yourCustomField": "abc123"
},
"paymentMethod": "ACH",
"status": "accepted"
}
]
}
],
"metadata": {
"yourCustomField": "abc123"
},
"status": "accepted"
}
],
"hasMore": true,
"limit": 2,
"links": [
{
"href": "https://api.payroc.com/v1/funding-instructions?before=64643131&limit=2&datefrom=2024-07-01&dateto=2024-07-03",
"method": "get",
"rel": "previous"
},
{
"href": "https://api.payroc.com/v1/funding-instructions?after=64643132&limit=2&datefrom=2024-07-01&dateto=2024-07-03",
"method": "get",
"rel": "next"
}
]
}
},
"ref_35f0540a1f531997dbad": {
"description": "Filter by the current status of the subscription.",
"examples": {
"example": {
"value": "active"
}
},
"in": "query",
"name": "status",
"schema": {
"enum": [
"active",
"completed",
"suspended",
"cancelled"
],
"type": "string"
}
},
"ref_35f977ff5a4cbc011b68": {
"description": "Retrieve a list of merchant platforms associated with your account.",
"summary": "Paginated list of merchant platforms",
"value": {
"count": 2,
"data": [
{
"business": {
"addresses": [
{
"address1": "1 Example Ave.",
"address2": "Example Address Line 2",
"address3": "Example Address Line 3",
"city": "Chicago",
"country": "US",
"postalCode": "60056",
"state": "Illinois",
"type": "legalAddress"
}
],
"contactMethods": [
{
"type": "email",
"value": "example-corp@example.com"
},
{
"type": "phone",
"value": "123 456 7890"
}
],
"countryOfOperation": "US",
"name": "Example Corp",
"organizationType": "privateCorporation",
"taxId": "xxxxx6789"
},
"createdDate": "2024-07-02T12:00:00.000+00:00",
"lastModifiedDate": "2024-07-02T12:00:00.000+00:00",
"merchantPlatformId": "12345",
"processingAccounts": [
{
"addendums": [],
"doingBusinessAs": "Pizza Doe",
"link": {
"href": "https://api.payroc.com/v1/processing-accounts/38765",
"method": "get",
"rel": "processingAccount"
},
"processingAccountId": "38765",
"processor": "tsys",
"signature": {
"link": {
"href": "https://us.agreementexpress.net/mv2/viewer2.jsp?docId=00000000-0000-0000-0000-000000000000",
"method": "get",
"rel": "agreement"
},
"type": "requestedViaDirectLink"
},
"status": "pending"
}
]
},
{
"business": {
"addresses": [
{
"address1": "1 Example Ave.",
"address2": "Example Address Line 2",
"address3": "Example Address Line 3",
"city": "Chicago",
"country": "US",
"postalCode": "60056",
"state": "Illinois",
"type": "legalAddress"
}
],
"contactMethods": [
{
"type": "email",
"value": "example-corp@example.com"
},
{
"type": "phone",
"value": "123 456 7890"
}
],
"countryOfOperation": "US",
"name": "Example Corp",
"organizationType": "privateCorporation",
"taxId": "xxxxx6789"
},
"createdDate": "2024-07-02T12:00:00.000+00:00",
"lastModifiedDate": "2024-07-02T12:00:00.000+00:00",
"merchantPlatformId": "12346",
"processingAccounts": [
{
"addendums": [],
"doingBusinessAs": "Doe Hot Dogs",
"link": {
"href": "https://api.payroc.com/v1/processing-accounts/38766",
"method": "get",
"rel": "processingAccount"
},
"processingAccountId": "38766",
"processor": "tsys",
"signature": {
"link": {
"href": "https://us.agreementexpress.net/mv2/viewer2.jsp?docId=00000000-0000-0000-0000-000000000001",
"method": "get",
"rel": "agreement"
},
"type": "requestedViaDirectLink"
},
"status": "pending"
}
]
}
],
"hasMore": true,
"limit": 2,
"links": [
{
"href": "https://api.payroc.com/v1/merchant-platforms?before=12345&limit=2",
"method": "get",
"rel": "previous"
},
{
"href": "https://api.payroc.com/v1/merchant-platforms?after=12346&limit=2",
"method": "get",
"rel": "next"
}
]
}
},
"ref_360be5d7e0853d272f75": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_3147c722e948ca9d06ad"
},
{
"properties": {
"amount": {
"description": "Total amount of the transaction. The value is in the currency’s lowest denomination, for example, cents.",
"example": 4999,
"format": "int64",
"type": "integer"
},
"currency": {
"$ref": "#/x-devx-bundled/ref_5c51a0e852c4baa940d0"
},
"dateTime": {
"description": "Date and time that the processor processed the transaction. Our gateway returns this value in the ISO 8601 format.",
"example": "2024-07-02T15:30:00Z",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"dccOffer": {
"$ref": "#/x-devx-bundled/ref_69d0c405bed69b717603"
},
"description": {
"description": "Description of the transaction.",
"example": "Large Pepperoni Pizza",
"maxLength": 256,
"minLength": 1,
"type": "string"
},
"orderId": {
"description": "Unique identifier that the merchant assigns to the transaction.",
"example": "OrderRef6543",
"maxLength": 24,
"minLength": 1,
"type": "string"
},
"standingInstructions": {
"$ref": "#/x-devx-bundled/ref_9d9755a79f0c7f700c99"
}
},
"type": "object"
}
],
"description": "Object that contains information about the payment.",
"required": [
"amount",
"currency",
"orderId"
],
"type": "object"
},
"ref_365438e6711d2ea8ba95": {
"description": "Remove operation deletes a value from the payment link.",
"summary": "Update payment link: remove",
"value": [
{
"op": "remove",
"path": "/customLabels"
}
]
},
"ref_36928188f6dabc3fb610": {
"description": "Result of verifying a customer's PAD bank account details.",
"summary": "PAD Bank Account Verification",
"value": {
"processingTerminalId": "1234001",
"verified": true
}
},
"ref_369a25ddd2da2be81ec6": {
"summary": "Apple Pay Payment",
"value": {
"channel": "web",
"operator": "Jane",
"order": {
"amount": 4999,
"currency": "USD",
"description": "Card Transaction (APPLE)",
"orderId": "1234567890W"
},
"paymentMethod": {
"encryptedData": "7b2262696c6c696e67436f6e74616374223a7b2266616d696c794e616d65223a22222c22676976656e4e616d65223a22222c2270686f6e6574696346616d696c794e616d65223a22222c2270686f6e65746963476976656e4e616d65223a22227d2c227368697070696e67436f6e74616374223a7b22656d61696c41646472657373223a227465737440646f6d61696e2e636f6d222c2266616d696c794e616d65223a22222c22676976656e4e616d65223a22222c2270686f6e6574696346616d696c794e616d65223a22222c2270686f6e65746963476976656e4e616d65223a22227d2c22746f6b656e223a7b227061796d656e7444617461223a7b2264617461223a2259314b37626731573479755568587473335941627a6150756c384d31795057304c724637734e2f70415950456d3871647969716c6257777356792b7732334c666c74344e6932525a684c2f6a52727563356f69496235537437763248543739682b74702f78517838496b6a5631485354594d747156644c6a413977686379774f654f70326575556d306e56386b50726569564273726a596c355931437a30576371495648595134424e737a4b5876675063686a497a6f4d4b456336425650744c7335777654667a434b51574a496a646b62516161306265685958524b422b7941773872537a6a4a476f3758523061467a414b4e70346c6f436e69484e564838373244504e4a77364b30336e544d69724b37725a615566485356754d477544473348366e4d78336c48436e6b517478764551474771754132676c416434424f427943414976483541566671655173534137776a4459702f494c6c66614e64307469467478344d6235566f6952513249387379384548547670307736667861316973613874636f484855614b32353857486474673d3d222c227369676e6174757265223a224d494147435371475349623344514548417143414d494143415145784454414c42676c67686b67425a514d45416745776741594a4b6f5a496876634e415163424141436767444343412b517767674f4c6f414d434151494343466e596f627971394f504e4d416f4743437147534d343942414d434d486f784c6a417342674e5642414d4d4a5546776347786c4945467763477870593246306157397549456c756447566e636d46306157397549454e4249433067527a4d784a6a416b42674e564241734d485546776347786c49454e6c636e52705a6d6c6a59585270623234675158563061473979615852354d524d77455159445651514b44417042634842735a53424a626d4d754d517377435159445651514745774a56557a4165467730794d5441304d6a41784f544d334d444261467730794e6a41304d546b784f544d324e546c614d4749784b44416d42674e5642414d4d4832566a5979317a62584174596e4a76613256794c584e705a32356656554d304c564e42546b5243543167784644415342674e564241734d43326c505579425465584e305a57317a4d524d77455159445651514b44417042634842735a53424a626d4d754d517377435159445651514745774a56557a425a4d424d4742797147534d34394167454743437147534d34394177454841304941424949772f6176446e50646549437851325a74464575593334716b423357797a344c484e53314a6e6d506a505472336f4769576f7768354d4d39334f6a697157777661766f5a4d445263546f656b516d7a7055624570576a676749524d4949434454414d42674e5648524d4241663845416a41414d42384741315564497751594d42614146435079536352506b2b54764a2b62453969687350364b372f53354c4d45554743437347415155464277454242446b774e7a4131426767724267454642516377415959706148523063446f764c32396a633341755958427762475575593239744c32396a633341774e433168634842735a5746705932457a4d4449776767456442674e5648534145676745554d4949424544434341517747435371475349623359325146415443422f6a4342777759494b77594242515548416749776762594d67624e535a5778705957356a5a5342766269423061476c7a49474e6c636e52705a6d6c6a5958526c49474a35494746756553427759584a306553426863334e316257567a4947466a593256776447467559325567623259676447686c4948526f5a5734675958427762476c6a59574a735a53427a644746755a4746795a4342305a584a7463794268626d5167593239755a476c3061573975637942765a6942316332557349474e6c636e52705a6d6c6a5958526c4948427662476c6a65534268626d51675932567964476c6d61574e6864476c7662694277636d466a64476c6a5a53427a644746305a57316c626e527a4c6a4132426767724267454642516343415259716148523063446f764c33643364793568634842735a53356a623230765932567964476c6d61574e68644756686458526f62334a7064486b764d44514741315564487751744d4373774b61416e6f43574749326830644841364c79396a636d77755958427762475575593239744c3246776347786c59576c6a59544d7559334a734d4230474131556444675157424251434a44414c6d753774526a4758704b5a614b5a3543635949635254414f42674e56485138424166384542414d43423441774477594a4b6f5a496876646a5a415964424149464144414b42676771686b6a4f5051514441674e4841444245416942306f624d6b32304a4a517733544a307851644d53416a5a6f6653413436686358424e69566d4d6c2b386f7749676154615155367631433170532b6659415463574b725778517039594961446551344b63363042354b3259457767674c754d49494364614144416745434167684a62532b2f4f706a616c7a414b42676771686b6a4f50515144416a426e4d527377475159445651514444424a42634842735a5342536232393049454e4249433067527a4d784a6a416b42674e564241734d485546776347786c49454e6c636e52705a6d6c6a59585270623234675158563061473979615852354d524d77455159445651514b44417042634842735a53424a626d4d754d517377435159445651514745774a56557a4165467730784e4441314d4459794d7a51324d7a4261467730794f5441314d4459794d7a51324d7a42614d486f784c6a417342674e5642414d4d4a5546776347786c4945467763477870593246306157397549456c756447566e636d46306157397549454e4249433067527a4d784a6a416b42674e564241734d485546776347786c49454e6c636e52705a6d6c6a59585270623234675158563061473979615852354d524d77455159445651514b44417042634842735a53424a626d4d754d517377435159445651514745774a56557a425a4d424d4742797147534d34394167454743437147534d34394177454841304941425041584559515a31325346315270654a594548647569416f752f656536354e34493338533550684d3162565a6c733172694c516c33594e496b353775676a396468664f694d743275325a7776736a6f4b59542f5645576a6766637767665177526759494b77594242515548415145454f6a41344d4459474343734741515546427a41426869706f644852774f69387662324e7a63433568634842735a53356a6232307662324e7a634441304c5746776347786c636d397664474e685a7a4d77485159445652304f4242594546435079536352506b2b54764a2b62453969687350364b372f53354c4d41384741315564457745422f7751464d414d4241663877487759445652306a42426777466f4155753744656f56677a694a716b69706e65767233727239724c4a4b73774e77594456523066424441774c6a41736f4371674b49596d6148523063446f764c324e7962433568634842735a53356a623230765958427762475679623239305932466e4d79356a636d777744675944565230504151482f42415144416745474d42414743697147534962335932514741673445416755414d416f4743437147534d343942414d43413263414d4751434d447250636f4e5246706d78687673317731624b59722f30462b335a4433564e6f6f362b385a7942586b4b33696669593935745a6e356a56515132506e656e432f6749774d693356524347776f7756336246337a4f4475515a2f305866437768625a5a50786e4a7067684a76565068366652755a7935734a6953466842706b50435a4964414141786767474a4d4949426851494241544342686a42364d5334774c4159445651514444435642634842735a5342426348427361574e6864476c766269424a626e526c5a334a6864476c7662694244515341744945637a4d5359774a4159445651514c44423142634842735a5342445a584a3061575a7059324630615739754945463164476876636d6c30655445544d424547413155454367774b51584277624755675357356a4c6a454c4d416b474131554542684d4356564d4343466e596f627971394f504e4d417347435743475341466c41775143416143426b7a415942676b71686b69473977304243514d784377594a4b6f5a496876634e415163424d42774743537147534962334451454a42544550467730794e4445794d5449784e6a51774d5452614d43674743537147534962334451454a4e4445624d426b774377594a59495a4941575544424149426f516f4743437147534d343942414d434d43384743537147534962334451454a4244456942434335615768366c647944637435626844536b62345835494a612b576f746d6d74344a624c74386949754a6b6a414b42676771686b6a4f50515144416752494d45594349514437637561364c6430697a6148716d5371713747303433476770363467484d6b514e523577757a32736137674968414e44643730585a6639432f412b58774e716a75672b76684c39534c4c4966465159746f6745377842534c774141414141414141222c22686561646572223a7b227075626c69634b657948617368223a225542347255754d6b7044627054564b7448636a6452525a496f643465766562754d4f696b7a4156556441593d222c22657068656d6572616c5075626c69634b6579223a224d466b77457759484b6f5a497a6a3043415159494b6f5a497a6a3044415163445167414557556a70324f663878427449432f354335535349544e443554736f75564c423831464547383847504b7243394e394d753365534e72586c32636564757533552f504f53652f616f75384477556a674e6670584d7831673d3d222c227472616e73616374696f6e4964223a2231363431326566383238303362633133356338333165396235663732376432366165623661616130363364633138353861313562323734386666346636333739227d2c2276657273696f6e223a2245435f7631227d2c227061796d656e744d6574686f64223a7b22646973706c61794e616d65223a224d6173746572436172642031343731222c226e6574776f726b223a224d617374657243617264222c2274797065223a226465626974227d2c227472616e73616374696f6e4964656e746966696572223a2231363431326566383238303362633133356338333165396235663732376432366165623661616130363364633138353861313562323734386666346636333739227d7d",
"serviceProvider": "apple",
"type": "digitalWallet"
},
"processingTerminalId": "1234001"
}
},
"ref_370da86d628188b0917a": {
"description": "Filter by the first six digits of the card number.",
"examples": {
"example": {
"value": "453985"
}
},
"in": "query",
"name": "first6",
"schema": {
"pattern": "[0-9]{6}",
"type": "string"
}
},
"ref_37759ae8dd5a8fe25362": {
"description": "Deactivate a subscription",
"summary": "Deactivate subscription",
"value": {
"currency": "USD",
"currentState": {
"nextDueDate": "2024-08-02",
"outstandingInvoices": 3,
"paidInvoices": 0,
"status": "cancelled"
},
"customFields": [
{
"name": "yourCustomField",
"value": "abc123"
}
],
"description": "Monthly Premium Club subscription",
"endDate": "2025-07-01",
"frequency": "monthly",
"length": 12,
"name": "Premium Club",
"pauseCollectionFor": 0,
"paymentPlan": {
"link": {
"href": "https://api.payroc.com/v1/processing-terminals/1234001/payment-plans/PlanRef8765",
"method": "GET",
"rel": "self"
},
"name": "Monthly Premium Club subscription",
"paymentPlanId": "PlanRef8765"
},
"processingTerminalId": "1234001",
"recurringOrder": {
"amount": 4999,
"breakdown": {
"subtotal": 4347,
"surcharge": {
"amount": 217,
"percentage": 5
},
"taxes": [
{
"name": "Sales Tax",
"rate": 5
}
]
},
"description": "Monthly Premium Club subscription"
},
"secureToken": {
"customerName": "Sarah Hazel Hopper",
"link": {
"href": "https://api.payroc.com/v1/processing-terminals/1234001/secure-tokens/MREF_abc1de23-f4a5-6789-bcd0-12e345678901fa",
"method": "GET",
"rel": "self"
},
"secureTokenId": "MREF_abc1de23-f4a5-6789-bcd0-12e345678901fa",
"status": "notValidated",
"token": "296753123456"
},
"setupOrder": {
"amount": 4999,
"breakdown": {
"subtotal": 4347,
"surcharge": {
"amount": 217,
"percentage": 5
},
"taxes": [
{
"name": "Sales Tax",
"rate": 5
}
]
},
"description": "Initial setup fee for Premium Club subscription",
"orderId": "OrderRef6543"
},
"startDate": "2024-07-02",
"subscriptionId": "SubRef7654",
"type": "automatic"
}
},
"ref_37bcccdc99a0ca8fdad6": {
"description": "We successfully created the merchant platform, but failed to add one or more processing accounts.",
"summary": "Failed processing account",
"value": {
"business": {
"addresses": [
{
"address1": "1 Example Ave.",
"address2": "Example Address Line 2",
"address3": "Example Address Line 3",
"city": "Chicago",
"country": "US",
"postalCode": "60056",
"state": "Illinois",
"type": "legalAddress"
}
],
"contactMethods": [
{
"type": "email",
"value": "jane.doe@example.com"
},
{
"type": "phone",
"value": "555 555 3456"
}
],
"countryOfOperation": "US",
"name": "Example Corp",
"organizationType": "privateCorporation",
"taxId": "xxxxx6789"
},
"createdDate": "2024-07-02T12:00:00.000+00:00",
"lastModifiedDate": "2024-07-02T12:00:00.000+00:00",
"merchantPlatformId": "12346",
"processingAccounts": [
{
"addendums": [],
"doingBusinessAs": "Pizza Doe",
"processor": "tsys",
"status": "failed"
}
]
}
},
"ref_37ddbc3abaadbc5fe0a6": {
"description": "Bank Transfer Payment with ACH payload and token storage",
"summary": "Store Token Bank Transfer Payment",
"value": {
"bankAccount": {
"accountNumber": "****3159",
"nameOnAccount": "Sarah Hazel Hopper",
"routingNumber": "053200983",
"secCode": "web",
"secureToken": {
"customerName": "Sarah Hazel Hopper",
"link": {
"href": "https://api.payroc.com/v1/processing-terminals/1234001/secure-tokens/MREF_abc1de23-f4a5-6789-bcd0-12e345678901fa",
"method": "GET",
"rel": "self"
},
"secureTokenId": "MREF_abc1de23-f4a5-6789-bcd0-12e345678901fa",
"status": "notValidated",
"token": "296753123456"
},
"type": "ach"
},
"customFields": [
{
"name": "yourCustomField",
"value": "abc123"
}
],
"customer": {
"contactMethods": [
{
"type": "email",
"value": "sarah.hopper@example.com"
}
],
"notificationLanguage": "en"
},
"order": {
"amount": 4999,
"breakdown": {
"subtotal": 4347,
"taxes": [
{
"amount": 217,
"name": "Sales Tax",
"rate": 5
}
],
"tip": {
"amount": 435,
"percentage": 10,
"type": "percentage"
}
},
"currency": "USD",
"dateTime": "2024-07-02T15:30:00Z",
"description": "Large Pepperoni Pizza",
"orderId": "OrderRef6543"
},
"paymentId": "M2MJOG6O2Y",
"processingTerminalId": "1234001",
"transactionResult": {
"authorizedAmount": 4999,
"currency": "USD",
"processorResponseCode": "0",
"responseCode": "A",
"responseMessage": "NoError",
"status": "ready",
"type": "payment"
}
}
},
"ref_37fb5700e029d2a6af06": {
"properties": {
"customFields": {
"description": "Array of customField objects.\n",
"items": {
"$ref": "#/x-devx-bundled/ref_91509fee696e20aa30f2"
},
"type": "array"
},
"customer": {
"$ref": "#/x-devx-bundled/ref_1674621e10fb2f321406"
},
"ipAddress": {
"$ref": "#/x-devx-bundled/ref_da456c8e931765f569e4"
},
"mitAgreement": {
"description": "Indicates how the merchant can use the customer's card details, as agreed by the customer: \n\n- `unscheduled` - Transactions for a fixed or variable amount that are run at a certain pre-defined event. \n- `recurring` - Transactions for a fixed amount that are run at regular intervals, for example, monthly. Recurring transactions don't have a fixed duration and run until the customer cancels the agreement. \n- `installment` - Transactions for a fixed amount that are run at regular intervals, for example, monthly. Installment transactions have a fixed duration.\n",
"enum": [
"unscheduled",
"recurring",
"installment"
],
"example": "recurring",
"type": "string"
},
"operator": {
"description": "Operator who saved the customer's payment details.",
"example": "Jane",
"maxLength": 50,
"minLength": 1,
"type": "string"
},
"secureTokenId": {
"description": "Unique identifier that you create for the secure token that represents the customer’s payment details. \n**Note:** If you don't send a value for the secureTokenId, our gateway generates a unique identifier for the token.\n",
"example": "MREF_abc1de23-f4a5-6789-bcd0-12e345678901fa",
"maxLength": 200,
"minLength": 1,
"type": "string"
},
"source": {
"description": "Polymorphic object that contains the payment method to tokenize. \n\nThe value of the type parameter determines which variant you should use: \n-\t`ach` - Automated Clearing House (ACH) details\n-\t`pad` - Pre-authorized debit (PAD) details\n-\t`card` - Payment card details\n-\t`singleUseToken` - Single-use token details\n",
"discriminator": {
"mapping": {
"ach": "../../../common/schemas/transaction/payment-method-v1.yaml#/components/schemas/achPayload",
"card": "../../../common/schemas/transaction/payment-method-v1.yaml#/components/schemas/cardPayload",
"pad": "../../../common/schemas/transaction/payment-method-v1.yaml#/components/schemas/padPayload",
"singleUseToken": "../../../common/schemas/transaction/payment-method-v1.yaml#/components/schemas/singleUseTokenPayload"
},
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/x-devx-bundled/ref_c799d35ea53644eec4e6"
},
{
"$ref": "#/x-devx-bundled/ref_d8468a3993ad87f32e78"
},
{
"$ref": "#/x-devx-bundled/ref_d7a78654a15a2c87ffaa"
},
{
"$ref": "#/x-devx-bundled/ref_9c8bcc4b28365a7b7f70"
}
],
"type": "object"
},
"threeDSecure": {
"description": "Polymorphic object that contains authentication information from 3-D Secure. \n\nThe value of the type parameter determines which variant you should use: \n-\t`gatewayThreeDSecure` - Use our gateway to run a 3-D Secure check.\n-\t`thirdPartyThreeDSecure` - Use a third party to run a 3-D Secure check.\n",
"discriminator": {
"mapping": {
"gatewayThreeDSecure": "../../../common/schemas/transaction/three-d-secure-v1.yaml#/components/schemas/gatewayThreeDSecure",
"thirdPartyThreeDSecure": "../../../common/schemas/transaction/three-d-secure-v1.yaml#/components/schemas/thirdPartyThreeDSecure"
},
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/x-devx-bundled/ref_28d1459a8daa1b3d6ae5"
},
{
"$ref": "#/x-devx-bundled/ref_eea40aa5ad1960d5cfae"
}
],
"type": "object"
}
},
"required": [
"source"
],
"type": "object"
},
"ref_38167371beaf6208ef91": {
"description": "Object that contains information about the authorization.",
"properties": {
"authorizationId": {
"description": "Unique identifier that we assigned to the authorization.",
"example": 12345,
"type": "integer"
},
"authorizationResponse": {
"description": "Response from the issuing bank for the authorization.",
"enum": [
"activityCountLimitExceeded",
"alreadyReversed",
"approved",
"approveVip",
"approveWithId",
"cannotVerifyPin",
"cardAuthenticationFailed",
"cardTypeVerificationError",
"cashRequestExceedsIssuerLimit",
"cashServiceNotAvailable",
"cidVerificationError",
"contactCardIssuer",
"cryptographicFailure",
"dailyThresholdExceeded",
"declineCvv2Failure",
"deny",
"denyAccountCanceled",
"denyClosedMerchant",
"denyNewCardIssued",
"denyPickUpCard",
"destinationCannotBeFoundForRouting",
"doNotHonor",
"duplicateTransmissionDetected",
"error",
"exceedsWithdrawalAmountLimit",
"expiredCard",
"fileTemporarilyUnavailable",
"forceStip",
"formatError",
"forwardToIssuer",
"functionNotSupported",
"honorWithId",
"incorrectCvv",
"incorrectPin",
"ineligibleForResubmission",
"insufficientFunds",
"invalidAccount",
"invalidAccountNumber",
"invalidAmount",
"invalidAuthorizationLifeCycle",
"invalidBillerInformation",
"invalidCardSecurityCode",
"invalidCurrencyCode",
"invalidMerchant",
"invalidResponse",
"invalidTransaction",
"issuerNotAvailable",
"issuerTimeout",
"issuerUnavailable",
"noActionTaken",
"noCardRecord",
"noCheckingAccount",
"noCreditAccount",
"noFinancialImpact",
"noReasonToDecline",
"noSavingsAccount",
"noSuchIssuer",
"partialApproval",
"partialAuthorization",
"pickUpCard",
"pickUpCardSpecialCondition",
"pinChangeRequestDeclined",
"pinCryptographicErrorFound",
"pinEntryTriesExceeded",
"pinNotChanged",
"pleaseCallIssuer",
"reenterTransaction",
"referToCardIssuer",
"referToCardIssuerSpecialCondition",
"restrictedCard",
"reversal",
"reversalDataInconsistent",
"revokeAllAuthorizationsOrder",
"scheduledTransactionstoppedByCardholder",
"securityViolation",
"successful",
"surchargeAmountNotPermitted",
"suspectFraud",
"systemMalfunction",
"transactionAmountExceedsApprovalAmount",
"transactionCannotBeCompleted",
"transactionNotAllowedAtMerchant",
"transactionNotAllowedAtTerminal",
"transactionNotPermitted",
"transactionNotPermittedToCardholder",
"unableToGoOnline",
"unableToLocateRecordInFile",
"unableToVerifyPin",
"unacceptablePin",
"unknown",
"unsafePin"
],
"type": "string"
},
"batch": {
"$ref": "#/x-devx-bundled/ref_1a4f881ca24e9232b696"
},
"card": {
"$ref": "#/x-devx-bundled/ref_6856721f35e105390b4f"
},
"createdDate": {
"description": "Date that we received the authorization. The format of this value is **YYYY-MM-DD**.",
"example": "2024-01-30",
"format": "date",
"type": "string"
},
"currency": {
"description": "Currency of the authorization. The value for the currency follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard.",
"type": "string"
},
"lastModifiedDate": {
"description": "Date that the authorization was last changed. The format of this value is **YYYY-MM-DD**.",
"example": "2024-01-30",
"format": "date",
"type": "string"
},
"merchant": {
"$ref": "#/x-devx-bundled/ref_67c77db80e4fded0ad81"
},
"preauthorizationRequestAmount": {
"description": "Amount that the merchant requested for the authorization. We return the value in the currency's lowest denomination, for example, cents.",
"example": 10000,
"type": "integer"
},
"transaction": {
"$ref": "#/x-devx-bundled/ref_7507ed0fd8805671d1aa"
}
},
"title": "authorization",
"type": "object"
},
"ref_38aead7a2965721bcb7b": {
"description": "Object that contains information about the gateway fees.",
"properties": {
"fees": {
"description": "Object that contains information about the gateway fees.",
"properties": {
"additionalServiceMonthly": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_109fe7e5f018de7ee04b"
}
],
"description": "Monthly fee for additional service. The value is in the currency's lowest denomination, for example, cents."
},
"monthly": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_109fe7e5f018de7ee04b"
}
],
"description": "Monthly fee for the gateway. The value is in the currency's lowest denomination, for example, cents."
},
"perDeviceMonthly": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_109fe7e5f018de7ee04b"
}
],
"description": "Monthly fee for each device. The value is in the currency's lowest denomination, for example, cents."
},
"perTransaction": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_109fe7e5f018de7ee04b"
}
],
"description": "Fee for each transaction. The value is in the currency's lowest denomination, for example, cents."
},
"setup": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_109fe7e5f018de7ee04b"
}
],
"description": "Fee for setting up your account with the gateway. The value is in the currency's lowest denomination, for example, cents."
}
},
"required": [
"monthly",
"setup",
"perTransaction",
"perDeviceMonthly",
"additionalServiceMonthly"
],
"type": "object"
}
},
"required": [
"fees"
],
"title": "gateway fees",
"type": "object"
},
"ref_38c700c5a4360532893e": {
"description": "Card Verification",
"summary": "Card Verification",
"value": {
"card": {
"cardDetails": {
"cardholderName": "Sarah Hazel Hopper",
"cardholderSignature": "a1b1c012345678a000b000c0012345d0e0f010g10061a031i001j071k0a1b0c1d0e1234567890120f1g0h1i0j1k0a1b0123451c012d0e1f0g1h0i1j123k1a1b1c1d1e1f1g123h1i1j1k1a1b1c1d1e1f1g123h123i1j123k12340a120a12345b012c0123012d0d1e0f1g0h1i123j123k10000",
"entryMethod": "keyed",
"keyedData": {
"cardNumber": "4539858876047062",
"dataFormat": "plainText",
"expiryDate": "1230"
}
},
"type": "card"
},
"operator": "Jane",
"processingTerminalId": "1234001"
}
},
"ref_38ddc242f7a6907e5c9c": {
"description": "Object that contains information about Hosted Fields initialization request.",
"properties": {
"libVersion": {
"description": "Version of the Hosted Fields JavaScript library that you are using. \n\nThe current production version is `1.7.0.261471`.\n",
"example": "1.7.0.261471",
"pattern": "^\\d{1,2}.\\d{1,2}.\\d{1,2}(?:-beta)?.\\d+$",
"type": "string"
},
"scenario": {
"description": "Indicates if a merchant wants to take a payment or tokenize a customer's payment details: \n\n- `payment` - The merchant wants to run a sale or run a sale and tokenize in the same transaction. \n- `tokenization` - The merchant wants to save the customer's payment details to take a payment later or to update a customer's payment details that they've already saved. \n",
"enum": [
"payment",
"tokenization"
],
"example": "payment",
"type": "string"
},
"secureTokenId": {
"description": "Unique identifier that represents a customer's payment details. \n\nIf a merchant wants to update a customer's payment details that are linked to a secure token, include the secureTokenId in your request. \n",
"example": "MREF_abc1de23-f4a5-6789-bcd0-12e345678901fa",
"maxLength": 200,
"minLength": 1,
"type": "string"
}
},
"required": [
"libVersion",
"scenario"
],
"title": "Hosted Fields Initialization",
"type": "object"
},
"ref_38fcc3d1658ae8f60f14": {
"description": "Serial number that identifies the merchant’s payment device.",
"examples": {
"example": {
"value": "1850010868"
}
},
"in": "path",
"name": "serialNumber",
"required": true,
"schema": {
"maxLength": 64,
"minLength": 1,
"type": "string"
}
},
"ref_3917c6024cc650b3ea83": {
"description": "Idempotency key in use",
"summary": "Idempotency key in use",
"value": {
"detail": "'Idempotency-Key' is already in use against a different request",
"status": 409,
"title": "Idempotency-Key in use",
"type": "https://docs.payroc.com/api/errors#idempotency-key-in-use"
}
},
"ref_39b2977516ad960a5b10": {
"description": "Filter transactions by the unique identifier of the batch that contains the transaction. \n\nYou must provide either the batchId or the date. \n",
"examples": {
"example": {
"value": 12345
}
},
"in": "query",
"name": "batchId",
"schema": {
"type": "integer"
}
},
"ref_39ea196745f35c0c62a3": {
"description": "Object that contains the fees for PIN-debit transactions.",
"properties": {
"additionalDiscount": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_d3797fc41828d98b6e34"
}
],
"description": "Percentage of additional discount."
},
"monthlyAccess": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_109fe7e5f018de7ee04b"
}
],
"description": "Monthly access fee for using PIN-debit services. The value is in the currency's lowest denomination, for example, cents."
},
"transaction": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_109fe7e5f018de7ee04b"
}
],
"description": "Fee for each transaction. The value is in the currency's lowest denomination, for example, cents."
}
},
"required": [
"additionalDiscount",
"transaction",
"monthlyAccess"
],
"type": "object"
},
"ref_3a384f5c8394f04df42d": {
"description": "Object that contains information about the processing terminal.",
"properties": {
"link": {
"description": "Array of links related to your request. For more information about HATEOAS, go to [Hypermedia as the engine of application state](https://docs.payroc.com/knowledge/basic-concepts/hypermedia-as-the-engine-of-application-state-hateoas).",
"properties": {
"href": {
"description": "URL of the target resource.",
"type": "string"
},
"method": {
"description": "HTTP method that you need to use with the target resource.",
"type": "string"
},
"rel": {
"description": "Indicates the relationship between the current resource and the target resource.",
"type": "string"
}
},
"required": [
"href",
"rel",
"method"
],
"type": "object"
},
"processingTerminalId": {
"description": "Unique identifier that we assigned to the processing terminal.",
"type": "string"
}
},
"required": [
"processingTerminalId",
"link"
],
"type": "object"
},
"ref_3a43baae7c09cbda0cc5": {
"description": "Unique identifier that we assigned to the refund instruction.",
"examples": {
"example": {
"value": "a37439165d134678a9100ebba3b29597"
}
},
"in": "path",
"name": "refundInstructionId",
"required": true,
"schema": {
"maxLength": 36,
"minLength": 1,
"type": "string"
}
},
"ref_3a6cea3ae4d5bf94543f": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_332dff3df47ae1e824ea"
},
{
"properties": {
"taxes": {
"description": "Array of polymorphic tax objects, which contain information about a tax. \n\nThe value of the type parameter determines which variant you should use: \n-\t`amount` - Tax is a fixed amount.\n-\t`rate` - Tax is a percentage.\n\nRequired for [Level 2, Level 3, and CEDP transactions](https://docs.payroc.com/knowledge/card-payments/enhanced-data).\n",
"items": {
"$ref": "#/x-devx-bundled/ref_157b8aec350ce5596632"
},
"type": "array"
}
},
"type": "object"
}
],
"type": "object"
},
"ref_3a74aad80996478553ed": {
"description": "Object that contains information about the cost of each item and the number of items that the merchant wants to order.",
"properties": {
"quantity": {
"description": "Number of units.",
"minimum": 1,
"type": "integer"
},
"totalPrice": {
"description": "Total cost for all devices in this line item, in cents (USD).",
"minimum": 0,
"type": "integer"
}
},
"required": [
"quantity",
"totalPrice"
],
"type": "object"
},
"ref_3aa89aa0e868ef0b24d4": {
"summary": "Retrieve transaction",
"value": {
"amount": 4999,
"authorization": {
"amount": 4999,
"authorizationId": 303101,
"avsResponseCode": "",
"code": "A1B2C3",
"link": {
"href": "https://api.payroc.com/v1/authorizations/303101",
"method": "get",
"rel": "authorization"
}
},
"batch": {
"batchId": 12,
"cycle": "am",
"date": "2024-07-02",
"link": {
"href": "https://api.payroc.com/v1/batches/12",
"method": "get",
"rel": "batch"
}
},
"card": {
"avsRequest": true,
"avsResponse": "",
"cardNumber": "453985******7062",
"cvvPresenceIndicator": true,
"type": "visa"
},
"cashbackAmount": 0,
"createdDate": "2024-07-02",
"currency": "USD",
"date": "2024-07-02",
"entryMethod": "ecommerce",
"interchange": {
"basisPoint": 0,
"transactionFee": 0
},
"lastModifiedDate": "2024-07-02",
"merchant": {
"doingBusinessAs": "Pizza Doe",
"link": {
"href": "https://api.payroc.com/v1/processing-accounts/38765",
"method": "get",
"rel": "processingAccount"
},
"merchantId": "4525644354",
"processingAccountId": 38765
},
"settled": {
"achDate": "2024-07-02",
"achDepositId": 99,
"link": {
"href": "https://api.payroc.com/v1/ach-deposits/99",
"method": "get",
"rel": "achDeposit"
},
"settledBy": "3rd party"
},
"status": "paid",
"transactionId": 442233,
"type": "capture"
}
},
"ref_3ab18b72178aebd31e74": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_7844a2a818521fc56fa4"
},
{
"properties": {
"taxes": {
"description": "Array of tax objects.",
"items": {
"$ref": "#/x-devx-bundled/ref_ff9e53b467436d074a75"
},
"type": "array"
}
},
"type": "object"
}
],
"required": [
"subtotal"
],
"type": "object"
},
"ref_3b22179a595bc4f9519d": {
"description": "Create an ACH payment using a secure token.",
"summary": "Bank transfer payment with a secure token",
"value": {
"bankAccount": {
"accountNumber": "******3491",
"nameOnAccount": "Sarah Hazel Hopper",
"routingNumber": "063100277",
"secCode": "web",
"secureToken": {
"customerName": "Sarah Hazel Hopper",
"link": {
"href": "https://api.payroc.com/v1/processing-terminals/1234001/secure-tokens/MREF_abc1de23-f4a5-6789-bcd0-12e345678901fa",
"method": "GET",
"rel": "self"
},
"secureTokenId": "MREF_abc1de23-f4a5-6789-bcd0-12e345678901fa",
"status": "bankAccountValidated",
"token": "296753123456"
},
"type": "ach"
},
"customFields": [
{
"name": "yourCustomField",
"value": "abc123"
}
],
"customer": {
"contactMethods": [
{
"type": "email",
"value": "sarah.hopper@example.com"
}
]
},
"order": {
"amount": 4999,
"currency": "USD",
"dateTime": "2024-07-02T15:30:00Z",
"description": "Pizza Doe #1234 - Dinner",
"orderId": "OrderRef6543"
},
"paymentId": "E29U8OU8Q4",
"processingTerminalId": "1234001",
"transactionResult": {
"authorizedAmount": 4999,
"currency": "USD",
"responseCode": "P",
"responseMessage": "Pending",
"status": "pending",
"type": "payment"
}
}
},
"ref_3bbb81954426a0605ef3": {
"description": "Object that contains the instructions for initiating a payment on a physical device.",
"properties": {
"autoCapture": {
"default": true,
"description": "Indicates if we should automatically capture the payment amount. \n\n- `true` - Run a sale and automatically capture the transaction.\n- `false`- Run a pre-authorization and capture the transaction later. \n\n**Note:** If you send `false` and the terminal doesn't support pre-authorization, we set the transaction's status to pending. The merchant must capture the transaction to take payment from the customer.\n",
"example": true,
"type": "boolean"
},
"credentialOnFile": {
"$ref": "#/x-devx-bundled/ref_ef5e9a924c7ad31c29ce"
},
"customer": {
"$ref": "#/x-devx-bundled/ref_1674621e10fb2f321406"
},
"customizationOptions": {
"$ref": "#/x-devx-bundled/ref_cbe3ccc50d5ca95e33f7"
},
"ipAddress": {
"$ref": "#/x-devx-bundled/ref_da456c8e931765f569e4"
},
"operator": {
"description": "Operator who initiated the request.",
"example": "Jane",
"maxLength": 50,
"minLength": 0,
"type": "string"
},
"order": {
"$ref": "#/x-devx-bundled/ref_ec2b9fff1c2a6e488cf9"
},
"processAsSale": {
"default": false,
"description": "Indicates if we should immediately settle the sale transaction. The merchant cannot adjust the transaction if we immediately settle it. \n**Note:** If the value for **processAsSale** is `true`, the gateway ignores the value in **autoCapture**.\n",
"example": false,
"type": "boolean"
},
"processingTerminalId": {
"description": "Unique identifier that we assigned to the terminal.",
"example": "1234001",
"maxLength": 50,
"minLength": 4,
"type": "string"
}
},
"required": [
"order",
"processingTerminalId"
],
"type": "object"
},
"ref_3bcfe805ef24017c999a": {
"description": "Add operation adds a new value to an object or array.",
"summary": "Update pricing intent: add",
"value": [
{
"op": "add",
"path": "/services",
"value": {
"enabled": true,
"name": "fraudProtection"
}
}
]
},
"ref_3bf02c1047cc10c95b6d": {
"description": "Owner that we created and added to the funding recipient.",
"summary": "Create funding recipient owner",
"value": {
"address": {
"address1": "2 Example Ave.",
"city": "Chicago",
"country": "US",
"postalCode": "60056",
"state": "Illinois"
},
"contactMethods": [
{
"type": "email",
"value": "fred.nerk@example.com"
},
{
"type": "phone",
"value": "2025550110"
}
],
"dateOfBirth": "1980-01-19",
"firstName": "Fred",
"identifiers": [
{
"type": "nationalId",
"value": "xxxxx9876"
}
],
"lastName": "Nerk",
"middleName": "Jim",
"ownerId": 12346,
"relationship": {
"equityPercentage": 51.5,
"isAuthorizedSignatory": true,
"isControlProng": false,
"title": "CEO"
}
}
},
"ref_3ce26e1f1df00a69bcbf": {
"properties": {
"amount": {
"default": 15540,
"description": "Fee for the Platinum Security, this is returned in the lowest unit of currency. For example, cents.",
"example": 15540,
"type": "integer"
},
"billingFrequency": {
"description": "Indicates whether we bill your account monthly or annually.",
"enum": [
"annual"
],
"type": "string"
}
},
"required": [
"billingFrequency"
],
"title": "annual",
"type": "object"
},
"ref_3ceb0dcb095102350228": {
"description": "One or more values for addendum type are not recognized.",
"summary": "Unrecognized addendum type",
"value": {
"detail": "Your request contained at least one addendum type that our gateway didn't recognize.",
"errors": [
{
"detail": "Unrecognized addendum type.",
"message": "The value you provided is not a recognized addendum type.",
"parameter": "processingAccounts[0].addendums[0].type"
}
],
"status": 400,
"title": "One or more validation errors occurred.",
"type": "https://docs.payroc.com/api/errors#bad-request"
}
},
"ref_3d297ea30d957eeb8369": {
"description": "Object that contains details about EBT transactions.",
"properties": {
"ebtType": {
"description": "Indicates the type of EBT that the terminal supports.",
"enum": [
"foodStamp",
"cash",
"both"
],
"maxLength": 9,
"type": "string"
},
"enabled": {
"description": "Indicates if the terminal accepts Electronic Benefit Transfer (EBT) transactions.",
"type": "boolean"
},
"fnsNumber": {
"description": "Food and Nutritional Service (FNS) number that the government assigns to the merchant to allow them to accept Supplemental Nutrition Assistance Program (SNAP) transactions.",
"maxLength": 7,
"type": "string"
}
},
"required": [
"enabled",
"ebtType"
],
"type": "object"
},
"ref_3e611d2ed3e542a2cf3f": {
"description": "Object that contains the fees for ACH transactions.",
"properties": {
"fees": {
"description": "Object that contains processing fees for ACH transactions.",
"properties": {
"accountVerification": {
"description": "Fee for each account verification. The value is in the currency's lowest denomination, for example, cents.",
"example": 100,
"minimum": 0,
"type": "integer"
},
"batch": {
"description": "Fee for each batch. The value is in the currency's lowest denomination, for example, cents.",
"example": 1000,
"minimum": 0,
"type": "integer"
},
"discountRateAbove10000": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_d3797fc41828d98b6e34"
}
],
"description": "Percentage discount for ACH transfers equal to or more than $10,000."
},
"discountRateUnder10000": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_d3797fc41828d98b6e34"
}
],
"description": "Percentage discount for ACH transfers less than $10,000."
},
"monthlyMinimum": {
"description": "Minimum monthly value of transactions. The value is in the currency's lowest denomination, for example, cents.",
"example": 20000,
"minimum": 0,
"type": "integer"
},
"returns": {
"description": "Fee for each return. The value is in the currency's lowest denomination, for example, cents.",
"example": 400,
"minimum": 0,
"type": "integer"
},
"statement": {
"description": "Fee for each statement. The value is in the currency's lowest denomination, for example, cents.",
"example": 800,
"minimum": 0,
"type": "integer"
},
"transaction": {
"description": "Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.",
"example": 50,
"minimum": 0,
"type": "integer"
},
"unauthorizedReturn": {
"description": "Fee for each unauthorized return. The value is in the currency's lowest denomination, for example, cents.",
"example": 1999,
"minimum": 0,
"type": "integer"
}
},
"required": [
"transaction",
"batch",
"returns",
"unauthorizedReturn",
"statement",
"monthlyMinimum",
"accountVerification",
"discountRateUnder10000",
"discountRateAbove10000"
],
"type": "object"
}
},
"type": "object"
},
"ref_3eb3e69e2928ecc23241": {
"description": "Refund instruction already completed",
"summary": "Refund instruction already completed",
"value": {
"detail": "You cannot cancel this resource in its current state",
"errors": [
{
"message": "Completed instruction cannot be canceled",
"parameter": "refundInstructionId"
}
],
"link": {
"href": "https://api.payroc.com/v1/refunds/M2MJOG6O2Y",
"method": "GET",
"rel": "refund"
},
"status": 409,
"title": "Cannot be canceled",
"type": "https://docs.payroc.com/api/errors#cannot-be-canceled"
}
},
"ref_3f43c40ece7bf219e047": {
"description": "Unique identifier that we assigned to the terminal.",
"examples": {
"example": {
"value": "1234001"
}
},
"in": "path",
"name": "processingTerminalId",
"required": true,
"schema": {
"maxLength": 50,
"minLength": 4,
"type": "string"
}
},
"ref_3fa9fb9b9104e878045a": {
"description": "Replace operation updates an existing value.",
"summary": "Update pricing intent: replace",
"value": [
{
"op": "replace",
"path": "/processor/card/fees/mastercardVisaDiscover/volume",
"value": 1.75
}
]
},
"ref_4052cf0ae88fc0b68fd4": {
"description": "Create an ACH payment using a secure token.",
"summary": "Bank transfer payment with a secure token",
"value": {
"customFields": [
{
"name": "yourCustomField",
"value": "abc123"
}
],
"customer": {
"contactMethods": [
{
"type": "email",
"value": "sarah.hopper@example.com"
}
]
},
"order": {
"amount": 4999,
"currency": "USD",
"description": "Pizza Doe",
"orderId": "OrderRef6543"
},
"paymentMethod": {
"accountType": "checking",
"secCode": "web",
"token": "296753123456",
"type": "secureToken"
},
"processingTerminalId": "1234001"
}
},
"ref_40869c40b438e4591cbc": {
"content": {
"application/problem+json": {
"examples": {
"unsupportedMediaType": {
"$ref": "#/x-devx-bundled/ref_47e5e9a6185bf5a535c6"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_4c26579476cd11b4cfc5"
}
}
},
"description": "Unsupported media type"
},
"ref_408c032a9e6bad0d9e05": {
"description": "Test operation validates that a value at the target location equals the specified value.",
"summary": "Update payment link: test",
"value": [
{
"op": "test",
"path": "/type",
"value": "singleUse"
}
]
},
"ref_40d41a554fd923076429": {
"description": "Object that contains information about the customer and their shipping address.",
"properties": {
"address": {
"$ref": "#/x-devx-bundled/ref_ec3e38e8e442656fe694"
},
"recipientName": {
"description": "Recipient's name.",
"example": "Sarah Hopper",
"maxLength": 50,
"minLength": 0,
"type": "string"
}
},
"type": "object"
},
"ref_41718efbbf91b6e633ec": {
"description": "Filter results by the date that the dispute was submitted.",
"examples": {
"example": {
"value": "2024-07-02"
}
},
"in": "query",
"name": "date",
"required": true,
"schema": {
"format": "date",
"type": "string"
}
},
"ref_41a0012cedf970a13c0a": {
"description": "Use this method to order and configure terminals for a processing account. When you create an order, you specify the gateway settings, device settings, and application settings for the terminals. \n**Note**: You need the ID of the merchant's processing account before you can create an order. If you don't know the processingAccountId, go to [Retrieve a Merchant Platform.](https://docs.payroc.com/api/schema/boarding/merchant-platforms/retrieve)\n",
"summary": "Terminal order",
"value": {
"orderItems": [
{
"deviceCondition": "new",
"solutionQuantity": 1,
"solutionSetup": {
"applicationSettings": {
"clerkPrompt": false,
"security": {
"keyedSalePassword": false,
"refundPassword": true,
"reversalPassword": true
}
},
"batchClosure": {
"batchCloseTime": "23:40",
"batchCloseType": "automatic"
},
"deviceSettings": {
"communicationType": "wifi",
"numberOfMobileUsers": 2
},
"gatewaySettings": {
"merchantPortfolioId": "Company Ltd",
"merchantTemplateId": "Company Ltd Merchant Template",
"terminalTemplateId": "Company Ltd Terminal Template",
"userTemplateId": "Company Ltd User Template"
},
"industryTemplateId": "Retail",
"receiptNotifications": {
"emailReceipt": true,
"smsReceipt": false
},
"taxes": [
{
"taxLabel": "Sales Tax",
"taxRate": 6
}
],
"timezone": "America/Chicago",
"tips": {
"enabled": false
},
"tokenization": true
},
"solutionTemplateId": "Roc Services_DX8000",
"type": "solution"
}
],
"paymentIntent": {
"costBreakdown": {
"items": [
{
"name": "dx8000",
"quantity": 1,
"unitCost": 4999
}
],
"shippingCost": 599
},
"payment": {
"frequency": {
"type": "singlePayment"
},
"method": "hostedPaymentPage",
"payer": "merchant"
},
"paymentIntentType": "purchase",
"subTotal": 5598
},
"shipping": {
"address": {
"addressLine1": "1 Example Ave.",
"addressLine2": "Example Address Line 2",
"businessName": "Company Ltd",
"city": "Chicago",
"email": "example@mail.com",
"phone": "2025550164",
"postalCode": "60056",
"recipientName": "Sarah Hopper",
"state": "Illinois"
},
"preferences": {
"method": "nextDay",
"saturdayDelivery": true
}
},
"trainingProvider": "payroc"
}
},
"ref_42257c2e1171733db046": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_eb68f2c28371d61b1260"
},
{
"properties": {
"premiumRate": {
"$ref": "#/x-devx-bundled/ref_01f55c7b2d1709665555",
"description": "Object that contains the fees for a premium rate transaction."
}
},
"required": [
"premiumRate"
],
"type": "object"
}
],
"type": "object"
},
"ref_4258b3fd029fd38ebdeb": {
"description": "Subscription after we applied the requested changes.",
"summary": "Update subscription",
"value": {
"currency": "USD",
"currentState": {
"nextDueDate": "2024-08-02",
"outstandingInvoices": 3,
"paidInvoices": 0,
"status": "active"
},
"customFields": [
{
"name": "yourCustomField",
"value": "abc123"
}
],
"description": "Premium Club subscription",
"endDate": "2025-07-01",
"frequency": "yearly",
"length": 12,
"name": "Premium Club",
"pauseCollectionFor": 0,
"paymentPlan": {
"link": {
"href": "https://api.payroc.com/v1/processing-terminals/1234001/payment-plans/PlanRef8765",
"method": "GET",
"rel": "self"
},
"name": "Monthly Premium Club subscription",
"paymentPlanId": "PlanRef8765"
},
"processingTerminalId": "1234001",
"recurringOrder": {
"amount": 2999,
"breakdown": {
"subtotal": 4347,
"surcharge": {
"amount": 217,
"percentage": 5
},
"taxes": [
{
"name": "Sales Tax",
"rate": 5
}
]
},
"description": "Premium Club subscription"
},
"secureToken": {
"customerName": "Sarah Hazel Hopper",
"link": {
"href": "https://api.payroc.com/v1/processing-terminals/1234001/secure-tokens/MREF_abc1de23-f4a5-6789-bcd0-12e345678901fa",
"method": "GET",
"rel": "self"
},
"secureTokenId": "MREF_abc1de23-f4a5-6789-bcd0-12e345678901fa",
"status": "notValidated",
"token": "296753123456"
},
"setupOrder": {
"amount": 2999,
"breakdown": {
"subtotal": 4347,
"surcharge": {
"amount": 217,
"percentage": 5
},
"taxes": [
{
"name": "Sales Tax",
"rate": 5
}
]
},
"description": "Initial setup fee for Premium Club subscription",
"orderId": "OrderRef6543"
},
"startDate": "2024-07-02",
"subscriptionId": "SubRef7654",
"type": "automatic"
}
},
"ref_42c25495328c9289df3b": {
"description": "Object that contains information about the payment that you want to refund.",
"properties": {
"amount": {
"description": "Total amount of the refund. The value is in the currency's lowest denomination, for example, cents.",
"example": 4999,
"format": "int64",
"type": "integer"
},
"description": {
"description": "Description of the refund.",
"example": "Refund for order OrderRef6543",
"maxLength": 100,
"minLength": 1,
"type": "string"
}
},
"required": [
"amount",
"description"
],
"type": "object"
},
"ref_43021934074700baba3c": {
"description": "Filter results by the last four digits of the account number.",
"examples": {
"example": {
"value": "7890"
}
},
"in": "query",
"name": "last4",
"schema": {
"pattern": "[0-9]{4}",
"type": "string"
}
},
"ref_4343c2f48f88f4bfad94": {
"description": "Example of Paginated Subscription",
"summary": "Paginated Subscription",
"value": {
"count": 2,
"data": [
{
"currency": "USD",
"currentState": {
"nextDueDate": "2024-08-02",
"outstandingInvoices": 11,
"paidInvoices": 1,
"status": "active"
},
"description": "Monthly Premium Club subscription",
"endDate": "2025-08-01",
"frequency": "monthly",
"length": 0,
"name": "Premium Club",
"pauseCollectionFor": 0,
"paymentPlan": {
"link": {
"href": "https://api.payroc.com/v1/processing-terminals/1234001/payment-plans/PlanRef8765",
"method": "GET",
"rel": "self"
},
"name": "Monthly Premium Club subscription",
"paymentPlanId": "PlanRef8765"
},
"processingTerminalId": "1234001",
"recurringOrder": {
"amount": 4999
},
"secureToken": {
"customerName": "Sarah Hazel Hopper",
"link": {
"href": "https://api.payroc.com/v1/processing-terminals/1234001/secure-tokens/MREF_abc1de23-f4a5-6789-bcd0-12e345678901fa",
"method": "GET",
"rel": "self"
},
"secureTokenId": "MREF_abc1de23-f4a5-6789-bcd0-12e345678901fa",
"status": "notValidated",
"token": "296753123456"
},
"setupOrder": {
"amount": 4999,
"description": "Initial setup fee for Premium Club subscription",
"orderId": "OrderRef6543"
},
"startDate": "2024-07-02",
"subscriptionId": "SubRef7654",
"type": "automatic"
},
{
"currency": "USD",
"currentState": {
"nextDueDate": "2024-04-11",
"outstandingInvoices": 11,
"paidInvoices": 1,
"status": "active"
},
"customFields": [
{
"name": "yourCustomField",
"value": "abc123"
}
],
"description": "Pie It Forward charitable trust donation",
"endDate": "2024-07-02",
"frequency": "yearly",
"length": 0,
"name": "Pie It Forward",
"pauseCollectionFor": 0,
"paymentPlan": {
"link": {
"href": "https://api.payroc.com/v1/processing-terminals/1234001/payment-plans/PlanRef7654",
"method": "GET",
"rel": "self"
},
"name": "Pie it Forward charitable trust donation",
"paymentPlanId": "PlanRef7654"
},
"processingTerminalId": "1234001",
"recurringOrder": {
"amount": 3999
},
"secureToken": {
"customerName": "Sarah Hazel Hopper",
"link": {
"href": "https://api.payroc.com/v1/processing-terminals/1234001/secure-tokens/MREF_abc1de23-f4a5-6789-bcd0-12e345678901fa",
"method": "GET",
"rel": "self"
},
"secureTokenId": "MREF_abc1de23-f4a5-6789-bcd0-12e345678901fa",
"status": "notValidated",
"token": "296753123456"
},
"setupOrder": {
"amount": 3999,
"orderId": "OrderRef7654"
},
"startDate": "2024-07-02",
"subscriptionId": "SubRef8543",
"type": "automatic"
}
],
"hasMore": true,
"limit": 2,
"links": [
{
"href": "https://api.payroc.com/v1/processing-terminals/1234001/subscriptions?limit=2&after=SubRef8543",
"method": "get",
"rel": "next"
},
{
"href": "https://api.payroc.com/v1/processing-terminals/1234001/subscriptions?limit=2&before=SubRef7654",
"method": "get",
"rel": "previous"
}
]
}
},
"ref_4397ef6127818bc94ba5": {
"description": "Object that contains information about the unencrypted PIN details.",
"properties": {
"dataFormat": {
"description": "Indicates the format of the PIN data.",
"enum": [
"raw"
],
"example": "raw",
"type": "string"
},
"pin": {
"description": "Customer’s unencrypted PIN.",
"example": "4422",
"maxLength": 2147483647,
"minLength": 1,
"type": "string"
}
},
"required": [
"dataFormat",
"pin"
],
"title": "raw",
"type": "object"
},
"ref_43adc899006f90cf2a05": {
"description": "Filter by terminal ID.",
"examples": {
"example": {
"value": "1234001"
}
},
"in": "query",
"name": "processingTerminalId",
"schema": {
"maxLength": 50,
"minLength": 4,
"type": "string"
}
},
"ref_43f30bf2d87d182bd302": {
"description": "Payment link after we replaced its expiry date.",
"summary": "Partially update payment link",
"value": {
"assets": {
"paymentButton": "SUPPORT US\n",
"paymentUrl": "https://payments.payroc.com/merchant/pay-by-link?token=02ada211-ff51-4845-b0b5-e685aeb4b19d"
},
"authType": "sale",
"createdOn": "2024-09-24",
"customLabels": [
{
"element": "paymentButton",
"label": "SUPPORT US"
}
],
"expiresOn": "2024-10-25",
"merchantReference": "LinkRef6543",
"order": {
"charge": {
"currency": "USD",
"type": "prompt"
},
"description": "Pie It Forward charitable trust donation"
},
"paymentLinkId": "JZURRJBUPS",
"paymentMethods": [
"card",
"bankTransfer"
],
"status": "active",
"type": "multiUse"
}
},
"ref_43f62b6723bf993b5ac0": {
"description": "Representment Bank Transfer Payment",
"summary": "Representment Bank Transfer Payment",
"value": {
"paymentMethod": {
"accountNumber": "11101010",
"accountType": "checking",
"nameOnAccount": "Sarah Hopper",
"routingNumber": "053200983",
"secCode": "tel",
"type": "ach"
}
}
},
"ref_4408bb5b0b11519db114": {
"description": "Object that contains information about RewardPay.",
"properties": {
"fees": {
"description": "Object that contains information about the fees.",
"properties": {
"cardChargePercentage": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_d3797fc41828d98b6e34"
}
],
"default": 3,
"description": "Percentage of the total transaction amount that the processor charges the cardholder.",
"readOnly": true,
"type": "number"
},
"merchantChargePercentage": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_d3797fc41828d98b6e34"
}
],
"default": 0.9,
"description": "Percentage of the total transaction amount that the processor charges the merchant.",
"readOnly": true,
"type": "number"
},
"monthlySubscription": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_109fe7e5f018de7ee04b"
}
],
"description": "Fee for the monthly subscription for the processing plan. The value is in the currency's lowest denomination, for example, cents."
},
"specialityCards": {
"$ref": "#/x-devx-bundled/ref_ca2b35d2127e00c3b179"
},
"tips": {
"description": "Indicates how the merchant manages tips.",
"enum": [
"noTips",
"tipPrompt",
"tipAdjust"
],
"type": "string"
},
"transaction": {
"default": 15,
"description": "Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.",
"readOnly": true,
"type": "integer"
}
},
"required": [
"monthlySubscription",
"tips"
],
"type": "object"
},
"planType": {
"description": "Type of processing plan.",
"enum": [
"rewardPay"
],
"type": "string"
}
},
"required": [
"planType",
"fees"
],
"title": "RewardPay Plan",
"type": "object"
},
"ref_4417d20cfb0a581b592e": {
"description": "New merchant platform created with addendums appended to the Merchant Processing Agreement.",
"summary": "Create merchant platform with addendums",
"value": {
"business": {
"addresses": [
{
"address1": "1 Example Ave.",
"address2": "Example Address Line 2",
"address3": "Example Address Line 3",
"city": "Chicago",
"country": "US",
"postalCode": "60056",
"state": "Illinois",
"type": "legalAddress"
}
],
"contactMethods": [
{
"type": "email",
"value": "jane.doe@example.com"
}
],
"countryOfOperation": "US",
"name": "Example Corp",
"organizationType": "privateCorporation",
"taxId": "xxxxx6789"
},
"createdDate": "2024-07-02T12:00:00.000+00:00",
"lastModifiedDate": "2024-07-02T12:00:00.000+00:00",
"merchantPlatformId": "12345",
"processingAccounts": [
{
"addendums": [
{
"type": "telehealthV1"
},
{
"type": "firearmsV1"
}
],
"doingBusinessAs": "Pizza Doe",
"link": {
"href": "https://api.payroc.com/v1/processing-accounts/38765",
"method": "get",
"rel": "processingAccount"
},
"processingAccountId": "38765",
"processor": "tsys",
"signature": {
"link": {
"href": "https://us.agreementexpress.net/mv2/viewer2.jsp?docId=00000000-0000-0000-0000-000000000000",
"method": "get",
"rel": "agreement"
},
"type": "requestedViaDirectLink"
},
"status": "pending"
}
]
}
},
"ref_44412a5fc0ef6c3b3f73": {
"description": "Event subscription after adding a new event type.",
"summary": "Update event subscription: add",
"value": {
"enabled": true,
"eventTypes": [
"processingAccount.status.changed",
"terminalOrder.status.changed"
],
"id": 2565435189324,
"metadata": {
"yourCustomField": "abc123"
},
"notifications": [
{
"secret": "**********oP3456",
"supportEmailAddress": "jane.doe@example.com",
"type": "webhook",
"uri": "https://my-server/notification/endpoint"
}
],
"status": "registered"
}
},
"ref_4464dcd514df15e8a3c4": {
"description": "Funding accounts restricted. You can not have any more than two funding accounts attached to this entity",
"summary": "Funding accounts limit reached",
"value": {
"detail": "You can not have any more than two funding accounts attached to this entity",
"status": 400,
"title": "Funding accounts limit reached",
"type": "https://docs.payroc.com/api/errors#funding-accounts-limit-reached"
}
},
"ref_449c2c080ce6361c32b6": {
"description": "The payload submitted is too large",
"summary": "Payload too large",
"value": {
"detail": "The payload submitted is too large",
"status": 413,
"title": "Payload too large",
"type": "https://docs.payroc.com/api/errors#payload-too-large"
}
},
"ref_44f6cabb0f45caf9bc65": {
"properties": {
"business": {
"$ref": "#/x-devx-bundled/ref_b96bfccc904b67e0050e"
},
"metadata": {
"additionalProperties": {
"type": "string"
},
"description": "Object that you can send to include custom data in the request.",
"example": {
"customerId": "2345"
},
"type": "object"
},
"processingAccounts": {
"description": "Array of processingAccounts objects.",
"items": {
"$ref": "#/x-devx-bundled/ref_892cf73eb4222b64e3e5"
},
"minItems": 1,
"type": "array"
}
},
"required": [
"business",
"processingAccounts"
],
"title": "create merchant platform",
"type": "object"
},
"ref_455786580bede80085f8": {
"description": "List of line items.\n\nContains parameters required for [Level 3 and CEDP transactions](https://docs.payroc.com/knowledge/card-payments/enhanced-data).\n",
"properties": {
"commodityCode": {
"description": "Commodity code of the item.\n\nRequired for [Level 3 and CEDP transactions](https://docs.payroc.com/knowledge/card-payments/enhanced-data).\n",
"example": "5812-0111",
"maxLength": 45,
"minLength": 0,
"type": "string"
},
"description": {
"description": "Description of the item.\n\nRequired for [Level 3 and CEDP transactions](https://docs.payroc.com/knowledge/card-payments/enhanced-data).\n",
"example": "Large Pepperoni Pizza",
"maxLength": 250,
"minLength": 0,
"type": "string"
},
"discountRate": {
"description": "Discount rate that the merchant applies to the item.\n\nRequired for [Level 3 and CEDP transactions](https://docs.payroc.com/knowledge/card-payments/enhanced-data).\n",
"example": 5,
"exclusiveMinimum": 0,
"format": "double",
"type": "number",
"x-fern-type-hint": "decimal"
},
"productCode": {
"description": "Product code of the item.\n\nRequired for [Level 3 and CEDP transactions](https://docs.payroc.com/knowledge/card-payments/enhanced-data).\n",
"example": "PZA-001-LG",
"maxLength": 45,
"minLength": 0,
"type": "string"
},
"quantity": {
"description": "Number of units.\n\nRequired for [Level 3 and CEDP transactions](https://docs.payroc.com/knowledge/card-payments/enhanced-data).\n",
"example": 1,
"exclusiveMinimum": 0,
"format": "double",
"type": "number",
"x-fern-type-hint": "decimal"
},
"unitOfMeasure": {
"$ref": "#/x-devx-bundled/ref_efc30f89a824cd57f874",
"description": "Unit of measurement for the item.\n\nRequired for [Level 3 and CEDP transactions](https://docs.payroc.com/knowledge/card-payments/enhanced-data). Also required for Level 2 (American Express only).\n"
},
"unitPrice": {
"description": "Price of each unit.\n\nRequired for [Level 3 and CEDP transactions](https://docs.payroc.com/knowledge/card-payments/enhanced-data).\n",
"example": 2709,
"exclusiveMinimum": 0,
"format": "int64",
"type": "integer"
}
},
"required": [
"quantity",
"unitPrice"
],
"type": "object"
},
"ref_45926d9e37fe15bd34c3": {
"description": "Example of a patched event subscription.",
"summary": "Partially update event subscription",
"value": {
"enabled": false,
"eventTypes": [
"processingAccount.status.changed"
],
"id": 2565435189324,
"metadata": {
"yourCustomField": "abc123"
},
"notifications": [
{
"secret": "**********oP3456",
"supportEmailAddress": "jane.doe@example.com",
"type": "webhook",
"uri": "https://my-server/notification/endpoint"
}
],
"status": "registered"
}
},
"ref_45e14bbffce42c49117b": {
"description": "Create a pricing intent.",
"summary": "Interchange Plus Plus",
"value": {
"base": {
"addressVerification": 5,
"annualFee": {
"amount": 9900,
"billInMonth": "june"
},
"batch": 1500,
"chargeback": 2500,
"earlyTermination": 57500,
"maintenance": 500,
"minimum": 100,
"pciNonCompliance": 4995,
"platinumSecurity": {
"billingFrequency": "monthly"
},
"regulatoryAssistanceProgram": 15,
"retrieval": 1500,
"voiceAuthorization": 95
},
"country": "US",
"key": "Your-Unique-Identifier",
"metadata": {
"yourCustomField": "abc123"
},
"processor": {
"ach": {
"fees": {
"accountVerification": 10,
"batch": 5,
"discountRateAbove10000": 1,
"discountRateUnder10000": 0.5,
"monthlyMinimum": 500,
"returns": 400,
"statement": 250,
"transaction": 50,
"unauthorizedReturn": 500
}
},
"card": {
"fees": {
"amex": {
"midQualRate": {
"transaction": 10,
"volume": 0.75
},
"nonQualRate": {
"transaction": 10,
"volume": 0.75
},
"qualifiedRate": {
"transaction": 10,
"volume": 0.5
},
"type": "optBlue"
},
"electronicBenefitsTransfer": {
"transaction": 10
},
"mastercardVisaDiscover": {
"midQualRate": {
"transaction": 10,
"volume": 0.35
},
"nonQualRate": {
"transaction": 10,
"volume": 0.35
},
"qualifiedRate": {
"transaction": 10,
"volume": 0.35
}
},
"pinDebit": {
"additionalDiscount": 1.25,
"monthlyAccess": 1200,
"transaction": 10
},
"specialityCards": {
"transaction": 10
}
},
"planType": "interchangePlusPlus"
}
},
"services": [
{
"enabled": true,
"name": "hardwareAdvantagePlan"
}
],
"version": "5.2"
}
},
"ref_4603625cf4689f36173f": {
"description": "One or more validation errors occurred.",
"summary": "Bad request",
"value": {
"detail": "One or more validation errors occurred, see error section for more info.",
"errors": [
{
"detail": "invalid date",
"message": "Expected date, got \"abc\"",
"parameter": "datefrom"
}
],
"status": 400,
"title": "Bad request",
"type": "https://docs.payroc.com/api/errors#bad-request"
}
},
"ref_462955d95507e451c10a": {
"description": "Filter payments by the first six digits of the card number that the customer used in the transaction.",
"examples": {
"example": {
"value": "453985"
}
},
"in": "query",
"name": "first6",
"schema": {
"pattern": "[0-9]{6}",
"type": "string"
}
},
"ref_469616a334f866d76d69": {
"description": "Filter payments by the cardholder’s name.",
"examples": {
"example": {
"value": "Sarah%20Hazel%20Hopper"
}
},
"in": "query",
"name": "cardholderName",
"schema": {
"maxLength": 50,
"minLength": 1,
"type": "string"
}
},
"ref_46c3ab48fafb105050ce": {
"description": "Unique identifier that the merchant assigned to the subscription.",
"examples": {
"example": {
"value": "SubRef7654"
}
},
"in": "path",
"name": "subscriptionId",
"required": true,
"schema": {
"maxLength": 48,
"minLength": 1,
"type": "string"
}
},
"ref_46f3efe4ed2468aa9af1": {
"description": "Object that contains information about the encrypted swiped card data.",
"properties": {
"dataFormat": {
"description": "Format of the card data.",
"enum": [
"encrypted"
],
"example": "encrypted",
"type": "string"
},
"device": {
"$ref": "#/x-devx-bundled/ref_9b532b6dac98bf9563ff"
},
"encryptedData": {
"description": "Encrypted data received from the magnetic stripe reader.",
"example": "A1B2C3D4E5F67890ABCD1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF",
"format": "hexadecimal",
"maxLength": 2147483647,
"minLength": 1,
"type": "string"
},
"fallback": {
"description": "Indicates that this is a fallback transaction. For example, if there was a technical issue with the chip on the customer's card and the merchant then swiped the card.",
"example": true,
"type": "boolean"
},
"fallbackReason": {
"description": "Reason for the fallback.",
"enum": [
"technical",
"repeatFallback",
"emptyCandidateList"
],
"example": "technical",
"type": "string"
},
"firstDigitOfPan": {
"description": "First digit of the of the card number.",
"example": "4",
"maxLength": 1,
"minLength": 1,
"type": "string"
}
},
"required": [
"dataFormat",
"device",
"encryptedData"
],
"title": "encrypted",
"type": "object"
},
"ref_4730198900b1c56ebd04": {
"description": "Object that contains information about ConsumerChoice.",
"properties": {
"fees": {
"description": "Object that contains information about the fees.",
"properties": {
"electronicBenefitsTransfer": {
"$ref": "#/x-devx-bundled/ref_2c771c635a39c1d2ba57"
},
"merchantChargePercentage": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_d3797fc41828d98b6e34"
}
],
"description": "Percentage of the total transaction amount that the processor charges the merchant.",
"format": "double",
"type": "number",
"x-fern-type-hint": "decimal"
},
"monthlySubscription": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_109fe7e5f018de7ee04b"
}
],
"description": "Fee for the monthly subscription for the processing plan. The value is in the currency's lowest denomination, for example, cents."
},
"pinDebit": {
"$ref": "#/x-devx-bundled/ref_39ea196745f35c0c62a3"
},
"specialityCards": {
"$ref": "#/x-devx-bundled/ref_ca2b35d2127e00c3b179"
},
"volume": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_d3797fc41828d98b6e34"
}
],
"description": "Merchant-authorized percentage on non-cash transactions."
}
},
"required": [
"monthlySubscription",
"volume"
],
"type": "object"
},
"planType": {
"description": "Type of processing plan.",
"enum": [
"consumerChoice"
],
"type": "string"
}
},
"required": [
"planType",
"fees"
],
"title": "Consumer Choice Plan",
"type": "object"
},
"ref_478798693738e1bfadb1": {
"properties": {
"detail": {
"description": "Explanation of the problem",
"example": "The resource you attempted to create already exists",
"type": "string"
},
"errors": {
"items": {
"properties": {
"detail": {
"description": "Short detail of the validation errors",
"example": "invalid date",
"type": "string"
},
"message": {
"description": "Error message",
"example": "Expected time, got '' for start_time",
"type": "string"
},
"parameter": {
"description": "The parameter or field causing the issues",
"example": "start_time",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"instance": {
"description": "Resource path to the existing resource",
"example": "https://api.payroc.com/v1/example/3",
"type": "string"
},
"link": {
"$ref": "#/x-devx-bundled/ref_27e6d0e095fb23cba669"
},
"status": {
"description": "Http status code",
"example": 409,
"type": "integer"
},
"title": {
"description": "Short description of the issue.",
"example": "Resource already exists",
"type": "string"
},
"type": {
"description": "URI reference identifying the problem type",
"example": "https://docs.payroc.com/api/errors#resource-already-exists",
"type": "string"
}
},
"required": [
"type",
"title",
"status",
"detail"
],
"type": "object"
},
"ref_47e5e9a6185bf5a535c6": {
"description": "The payload is in an unsupported format.",
"summary": "Unsupported media type",
"value": {
"detail": "You submitted a payload in an unsupported format",
"status": 415,
"title": "Unsupported media type",
"type": "https://docs.payroc.com/api/errors#unsupported-media-type"
}
},
"ref_47fa8782801d5d623bee": {
"properties": {
"detail": {
"description": "Explanation of the problem",
"example": "Unable to process your request at this time",
"type": "string"
},
"errors": {
"items": {
"properties": {
"message": {
"description": "Error message",
"example": "Service offline",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"status": {
"description": "Http status code",
"example": 500,
"type": "integer"
},
"title": {
"description": "Short description of the issue.",
"example": "Api error",
"type": "string"
},
"type": {
"description": "URI reference identifying the problem type",
"example": "https://docs.payroc.com/api/errors#api-error",
"type": "string"
}
},
"required": [
"type",
"title",
"status",
"detail"
],
"type": "object"
},
"ref_4815ca9859cd3076cb7c": {
"description": "Test operation validates that a value at the target location equals the specified value.",
"summary": "Update pricing intent: test",
"value": [
{
"op": "test",
"path": "/country",
"value": "US"
}
]
},
"ref_48411fa0892bdae41e27": {
"description": "Polymorphic object that contains information about who pays for the terminal order and how they are paying for it.",
"discriminator": {
"mapping": {
"purchase": "#/components/schemas/purchase"
},
"propertyName": "paymentIntentType"
},
"oneOf": [
{
"$ref": "#/x-devx-bundled/ref_52ea3073e3a03e7c1eb3"
}
],
"type": "object"
},
"ref_484be455c52965692b06": {
"description": "Filter results by the user that entered the amount. Send one of the following values:\n- prompt - Customer entered the amount.\n- preset - Merchant entered the amount.\n",
"examples": {
"example": {
"value": "prompt"
}
},
"in": "query",
"name": "chargeType",
"schema": {
"enum": [
"preset",
"prompt"
],
"type": "string"
}
},
"ref_4887d00cb91f7c43ee62": {
"description": "Payment Plan",
"summary": "Payment Plan",
"value": {
"currency": "USD",
"customFieldNames": [
"yourCustomField"
],
"description": "Monthly Premium Club subscription",
"frequency": "monthly",
"length": 12,
"name": "Premium Club",
"onDelete": "complete",
"onUpdate": "continue",
"paymentPlanId": "PlanRef8765",
"processingTerminalId": "1234001",
"recurringOrder": {
"amount": 4999,
"breakdown": {
"subtotal": 4347,
"taxes": [
{
"name": "Sales Tax",
"rate": 5
}
]
},
"description": "Monthly Premium Club subscription"
},
"setupOrder": {
"amount": 4999,
"breakdown": {
"subtotal": 4347,
"taxes": [
{
"name": "Sales Tax",
"rate": 5
}
]
},
"description": "Initial setup fee for Premium Club subscription"
},
"type": "automatic"
}
},
"ref_48f636cd57461cc98031": {
"summary": "Masked funding account example.",
"value": {
"createdDate": "2024-07-02T15:30:00+00:00",
"fundingAccountId": 123,
"lastModifiedDate": "2024-07-02T15:30:00+00:00",
"links": [
{
"href": "https://api.payroc.com/v1/processing-accounts/4525644354",
"method": "get",
"rel": "parent"
}
],
"metadata": {
"yourCustomField": "abc123"
},
"nameOnAccount": "Jane Doe",
"paymentMethods": [
{
"type": "ach",
"value": {
"accountNumber": "******7890",
"routingNumber": "*****6789"
}
}
],
"status": "pending",
"type": "checking",
"use": "credit"
}
},
"ref_49bf9231904bbd9aa1c0": {
"content": {
"application/problem+json": {
"examples": {
"notFound": {
"$ref": "#/x-devx-bundled/ref_9999b37089d453ef5f5f"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_9cd983fda49001e08d81"
}
}
},
"description": "Resource not found"
},
"ref_4a11108147084e09940d": {
"description": "One or more validation errors occurred.",
"summary": "Bad request",
"value": {
"detail": "One or more validation errors occurred, see error section for more info",
"errors": [
{
"detail": "invalid date",
"message": "Expected date, got \\\"abc\\\"",
"parameter": "datefrom"
}
],
"status": 400,
"title": "Bad request",
"type": "https://docs.payroc.com/api/errors#bad-request"
}
},
"ref_4a7b91fc0a7e14e78dfc": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_97210cf49ae4a58b7540"
},
{
"properties": {
"paymentInstructionId": {
"description": "Unique identifier that we assigned to the payment instruction.",
"example": "a37439165d134678a9100ebba3b29597",
"maxLength": 36,
"minLength": 1,
"type": "string"
}
},
"type": "object"
}
],
"required": [
"paymentInstructionId",
"status"
],
"type": "object"
},
"ref_4afcb7f0fde89d0dc39f": {
"description": "Paginated Bank Transfer Unreferenced Refund",
"summary": "Paginated Bank Transfer Unreferenced Refund",
"value": {
"count": 2,
"data": [
{
"bankAccount": {
"accountNumber": "****3159",
"nameOnAccount": "Sarah Hazel Hopper",
"routingNumber": "*****0277",
"secCode": "web",
"type": "ach"
},
"customer": {
"contactMethods": [
{
"type": "email",
"value": "sarah.hopper@example.com"
}
],
"notificationLanguage": "en"
},
"order": {
"amount": 4999,
"currency": "USD",
"dateTime": "2024-07-02T15:30:00Z",
"description": "refund example",
"orderId": "OrderRef6543"
},
"processingTerminalId": "1234001",
"refundId": "CD3HN88U9F",
"transactionResult": {
"authorizedAmount": -4999,
"currency": "USD",
"processorResponseCode": "0",
"responseCode": "A",
"responseMessage": "NoError",
"status": "ready",
"type": "unreferencedRefund"
}
},
{
"bankAccount": {
"accountNumber": "****3159",
"nameOnAccount": "Sarah Hazel Hopper",
"routingNumber": "*****0277",
"secCode": "web",
"type": "ach"
},
"customFields": [
{
"name": "yourCustomField",
"value": "abc123"
}
],
"customer": {
"contactMethods": [
{
"type": "email",
"value": "sarah.hopper@example.com"
}
],
"notificationLanguage": "en"
},
"order": {
"amount": 3999,
"currency": "USD",
"dateTime": "2024-07-02T15:30:00Z",
"description": "Refund for order OrderRef7654",
"orderId": "OrderRef7654"
},
"processingTerminalId": "1234001",
"refundId": "B6ZOFZNVOP",
"transactionResult": {
"authorizedAmount": -3999,
"currency": "USD",
"processorResponseCode": "0",
"responseCode": "A",
"responseMessage": "NoError",
"status": "ready",
"type": "unreferencedRefund"
}
}
],
"hasMore": true,
"limit": 2,
"links": [
{
"href": "https://api.payroc.com/v1/bank-transfer-refunds?limit=2&processingTerminalId=1234001&after=B6ZOFZNVOP",
"method": "get",
"rel": "next"
},
{
"href": "https://api.payroc.com/v1/bank-transfer-refunds?processingTerminalId=1234001&limit=2&before=CD3HN88U9F",
"method": "get",
"rel": "previous"
}
]
}
},
"ref_4b3a055024c05d126044": {
"description": "Submit an instruction for initiating a refund on a physical device.",
"summary": "Refund instruction",
"value": {
"customizationOptions": {
"entryMethod": "manualEntry"
},
"operator": "Jane",
"order": {
"amount": 4999,
"currency": "USD",
"description": "Refund for order OrderRef6543",
"orderId": "OrderRef6543"
},
"processingTerminalId": "1234001"
}
},
"ref_4b7a26467bd32e0d5fa8": {
"properties": {
"enabled": {
"description": "Indicates if we should notify you when the event occurs. The value is one of the following: \n- `true` - We notify you when the event occurs. \n- `false` - We don't notify you when the event occurs. \n",
"example": true,
"type": "boolean"
},
"eventTypes": {
"description": "Array of events that you want to subscribe to. For a list of events, go to [Events List](https://docs.payroc.com/knowledge/events/events-list).",
"example": [
"processingAccount.status.changed"
],
"items": {
"minLength": 1,
"type": "string"
},
"type": "array"
},
"id": {
"description": "Unique identifier that we assigned to the event subscription.",
"example": 2565435189324,
"format": "int64",
"readOnly": true,
"type": "integer"
},
"metadata": {
"description": "Object that you can send to include custom data in the request. For more information about how to use metadata, go to [Metadata](https://docs.payroc.com/api/metadata).",
"example": {
"yourCustomField": "abc123"
},
"type": "object"
},
"notifications": {
"description": "Array of polymorphic notification objects that contain information about how we contact you when an event occurs.",
"items": {
"$ref": "#/x-devx-bundled/ref_d67787cf05a5b220dc42"
},
"type": "array"
},
"status": {
"description": "Status of the subscription. We return one of the following values: \n- `registered` - You have set up the subscription, and we will notify you when an event occurs. \n- `suspended` - We have deactivated the event subscription, and we won't notify you when an event occurs. \n- `failed` - We couldn't contact your URI endpoint. We email the supportEmailAddress. \n",
"enum": [
"registered",
"suspended",
"failed"
],
"example": "registered",
"readOnly": true,
"type": "string"
}
},
"required": [
"enabled",
"eventTypes",
"notifications"
],
"title": "Event Subscription",
"type": "object"
},
"ref_4b7bb203f9ff456d5d10": {
"description": "Object that contains information about the progress of the payment instruction.",
"summary": "Payment Instruction",
"value": {
"link": {
"href": "https://api.payroc.com/v1/payment-instructions/a37439165d134678a9100ebba3b29597",
"method": "GET",
"rel": "self"
},
"paymentInstructionId": "a37439165d134678a9100ebba3b29597",
"status": "inProgress"
}
},
"ref_4bc30f329291c16d15f6": {
"description": "Update an event subscription",
"summary": "Update event subscription",
"value": {
"enabled": true,
"eventTypes": [
"processingAccount.status.changed"
],
"metadata": {
"yourCustomField": "abc123"
},
"notifications": [
{
"secret": "aBcD1234eFgH5678iJkL9012mNoP3456",
"supportEmailAddress": "jane.doe@example.com",
"type": "webhook",
"uri": "https://my-server/notification/endpoint"
}
]
}
},
"ref_4bf052e2a8fd0985ca08": {
"description": "Object that contains the information for the custom label.",
"properties": {
"element": {
"description": "Element that you want to provide a custom label for.",
"enum": [
"paymentButton"
],
"example": "paymentButton",
"type": "string"
},
"label": {
"description": "Custom label to display on the element.",
"example": "SUPPORT US",
"maxLength": 24,
"minLength": 1,
"type": "string"
}
},
"type": "object"
},
"ref_4c16ec99a0cf81f8e16d": {
"description": "Object that contains the terminal's host configuration.",
"properties": {
"configuration": {
"description": "Polymorphic object that contains the host processor configuration.",
"discriminator": {
"mapping": {
"tsys": "#/components/schemas/tsys"
},
"propertyName": "processor"
},
"oneOf": [
{
"$ref": "#/x-devx-bundled/ref_a1ad866dd55174d62fc4"
}
]
},
"processingAccountId": {
"description": "Unique identifier that we assigned to the processing account.",
"example": "23451",
"type": "string"
},
"processingTerminalId": {
"description": "Unique identifier that our gateway assigned to the terminal.",
"example": "0123451001",
"type": "string"
}
},
"required": [
"processingTerminalId",
"configuration"
],
"type": "object"
},
"ref_4c17f383035c3260c513": {
"properties": {
"currency": {
"$ref": "#/x-devx-bundled/ref_5c51a0e852c4baa940d0"
},
"currentState": {
"$ref": "#/x-devx-bundled/ref_d4a82d501fc873246869"
},
"customFields": {
"description": "Array of customField objects.\n",
"items": {
"$ref": "#/x-devx-bundled/ref_91509fee696e20aa30f2"
},
"type": "array"
},
"description": {
"description": "Description of the subscription.",
"example": "Monthly Premium Club subscription. Two large pizzas free per month, and exclusive member discounts.",
"maxLength": 128,
"minLength": 1,
"type": "string"
},
"endDate": {
"description": "Format: **YYYY-MM-DD** \nSubscription's end date. \n**Note:** If you provide values for both **length** and **endDate**, \nour gateway uses the value for **endDate** to determine when the subscription should end. \n",
"example": "2025-05-02",
"format": "date",
"type": "string"
},
"frequency": {
"description": "Indicates how often the merchant or the terminal collects a payment from the customer.",
"enum": [
"weekly",
"fortnightly",
"monthly",
"quarterly",
"yearly"
],
"example": "monthly",
"type": "string"
},
"length": {
"description": "Total number of billing cycles. To indicate that the subscription should run indefinitely, send a value of `0`. This value replaces the **length** inherited from the payment plan. \n**Note:** If you provide values for both **length** and **endDate**, our gateway uses the value for **endDate** to determine when the subscription should end.\n",
"example": 12,
"format": "int32",
"minimum": 0,
"type": "integer"
},
"name": {
"description": "Name of the subscription.",
"example": "Premium Club",
"maxLength": 128,
"minLength": 5,
"type": "string"
},
"pauseCollectionFor": {
"description": "Number of billing cycles that the merchant wants to pause payments for. \nFor example, if the merchant wants to offer a free trial period.\n",
"example": 0,
"format": "int32",
"minimum": 0,
"type": "integer"
},
"paymentPlan": {
"$ref": "#/x-devx-bundled/ref_92b77a0b37393e88b84c"
},
"processingTerminalId": {
"description": "Unique identifier of the terminal that the subscription is linked to.",
"example": "1234001",
"maxLength": 50,
"minLength": 4,
"type": "string"
},
"recurringOrder": {
"$ref": "#/x-devx-bundled/ref_20646294913264a3c1a0"
},
"secureToken": {
"$ref": "#/x-devx-bundled/ref_0af00846def2cd349cd2"
},
"setupOrder": {
"$ref": "#/x-devx-bundled/ref_571bf5eca14a53be5ae4"
},
"startDate": {
"description": "Format: **YYYY-MM-DD** \nSubscription's start date.\n",
"example": "2024-05-02",
"format": "date",
"type": "string"
},
"subscriptionId": {
"description": "Unique identifier that the merchant assigned to the subscription.",
"example": "SubRef7654",
"maxLength": 48,
"minLength": 1,
"type": "string"
},
"type": {
"description": "How the merchant takes the payment from the customer’s account. \n- `manual` – The merchant manually collects payments from the customer. \n- `automatic` – The terminal automatically collects payments from the customer.\n",
"enum": [
"manual",
"automatic"
],
"example": "automatic",
"type": "string"
}
},
"required": [
"subscriptionId",
"processingTerminalId",
"paymentPlan",
"secureToken",
"name",
"currency",
"currentState",
"startDate",
"type",
"frequency"
],
"type": "object"
},
"ref_4c26579476cd11b4cfc5": {
"properties": {
"detail": {
"description": "Explanation of the problem",
"example": "You submitted a payload in an unsupported format.",
"type": "string"
},
"status": {
"description": "Http status code",
"example": 415,
"type": "integer"
},
"title": {
"description": "Short description of the issue.",
"example": "Unsupported media type",
"type": "string"
},
"type": {
"description": "URI reference identifying the problem type",
"example": "https://docs.payroc.com/api/errors#unsupported-media-type",
"type": "string"
}
},
"required": [
"type",
"title",
"status",
"detail"
],
"type": "object"
},
"ref_4c7c5de1cea50ef531e3": {
"description": "Wrapper for the content that Apple returns after starting the Apple Pay session.",
"summary": "Apple Pay session",
"value": {
"startSessionResponse": "{\n \"epochTimestamp\": 1736264582447,\n \"expiresAt\": 1736268182447,\n \"merchantSessionIdentifier\": \"SSHE464E2B91B714F18BFD19D46D0F582BF_916523AAED1343F5BC5815E12BEE9250AFFDC1A17C46B0DE5A943F0F94927C24\",\n \"nonce\": \"e5775127\",\n \"merchantIdentifier\": \"BFB110EE83BE2AF4AA7468926C926CCFC57F4A541CCE6E7F3BEFD05002ECE503\",\n \"domainName\": \"store.com\",\n \"displayName\": \"Store One\",\n \"signature\": \"a1b1c012345678a000b000c0012345d0e0f010g10061a031i001j071k0a1b0c1d0e1234567890120f1g0h1i0j1k0a1b0123451c012d0e1f0g1h0i1j123k1a1b1c1d1e1f1g123h1i1j1k1a1b1c1d1e1f1g123h123i1j123k12340a120a12345b012c0123012d0d1e0f1g0h1i123j123k10000\",\n \"operationalAnalyticsIdentifier\": \"Store One:BFB110EE83BE2AF4AA7468926C926CCFC57F4A541CCE6E7F3BEFD05002ECE503\",\n \"retries\": 0,\n \"pspId\": \"17D4AAA8D9357D26D771ABA0DAA0B9D3BB462AD1585492E1FE688AF8BB9558E5\"\n}\n"
}
},
"ref_4c7d7df93d7361f18712": {
"description": "Create a processing account with addendums appended to the Merchant Processing Agreement.",
"summary": "Create processing account with addendums",
"value": {
"addendums": [
{
"type": "telehealthV1"
},
{
"type": "firearmsV1"
}
],
"address": {
"address1": "1 Example Ave.",
"address2": "Example Address Line 2",
"address3": "Example Address Line 3",
"city": "Chicago",
"country": "US",
"postalCode": "60056",
"state": "Illinois"
},
"businessStartDate": "2020-01-01",
"businessType": "restaurant",
"categoryCode": 5999,
"contactMethods": [
{
"type": "email",
"value": "jane.doe@example.com"
}
],
"doingBusinessAs": "Pizza Doe",
"funding": {
"acceleratedFundingFee": 1999,
"dailyDiscount": false,
"fundingAccounts": [
{
"metadata": {
"yourCustomField": "abc123"
},
"nameOnAccount": "Jane Doe",
"paymentMethods": [
{
"type": "ach",
"value": {
"accountNumber": "1234567890",
"routingNumber": "123456789"
}
}
],
"type": "checking",
"use": "creditAndDebit"
}
],
"fundingSchedule": "nextday"
},
"merchandiseOrServiceSold": "Pizza",
"metadata": {
"customerId": "2345"
},
"owners": [
{
"address": {
"address1": "1 Example Ave.",
"address2": "Example Address Line 2",
"address3": "Example Address Line 3",
"city": "Chicago",
"country": "US",
"postalCode": "60056",
"state": "Illinois"
},
"contactMethods": [
{
"type": "email",
"value": "jane.doe@example.com"
}
],
"dateOfBirth": "1964-03-22",
"firstName": "Jane",
"identifiers": [
{
"type": "nationalId",
"value": "000-00-4320"
}
],
"lastName": "Doe",
"middleName": "Helen",
"relationship": {
"equityPercentage": 51.5,
"isAuthorizedSignatory": false,
"isControlProng": true,
"title": "CFO"
}
}
],
"pricing": {
"pricingIntentId": "6123",
"type": "intent"
},
"processing": {
"monthlyAmounts": {
"average": 50000,
"highest": 100000
},
"transactionAmounts": {
"average": 5000,
"highest": 10000
},
"volumeBreakdown": {
"cardPresent": 77,
"ecommerce": 20,
"mailOrTelephone": 3
}
},
"processor": "tsys",
"signature": {
"type": "requestedViaDirectLink"
},
"timezone": "America/Chicago",
"website": "www.example.com"
}
},
"ref_4ce7328eee513fc70eea": {
"description": "Copy operation duplicates a value from one location to another.",
"summary": "Update event subscription: copy",
"value": [
{
"from": "/notifications/0/uri",
"op": "copy",
"path": "/metadata/webhookBackup"
}
]
},
"ref_4d097caef54b1645d917": {
"description": "Bank Transfer Unreferenced Refund",
"summary": "Bank Transfer Unreferenced Refund",
"value": {
"bankAccount": {
"accountNumber": "****7890",
"nameOnAccount": "Sarah Hazel Hopper",
"routingNumber": "*****6789",
"secCode": "web",
"type": "ach"
},
"customFields": [
{
"name": "yourCustomField",
"value": "abc123"
}
],
"customer": {
"contactMethods": [
{
"type": "email",
"value": "sarah.hopper@example.com"
}
],
"notificationLanguage": "en"
},
"order": {
"amount": 4999,
"currency": "USD",
"dateTime": "2024-07-02T15:30:00Z",
"description": "Refund for order OrderRef6543",
"orderId": "OrderRef6543"
},
"processingTerminalId": "1234001",
"refundId": "CD3HN88U9F",
"transactionResult": {
"authorizedAmount": -4999,
"currency": "USD",
"processorResponseCode": "0",
"responseCode": "A",
"responseMessage": "NoError",
"status": "ready",
"type": "unreferencedRefund"
}
}
},
"ref_4d4e2c710777ba68dcf1": {
"properties": {
"method": {
"description": "Method of payment for the terminal order. The value is one of the following: \n- `accountOnFile` - We use the sales partner's account details that we have stored to pay for the order. \n- `residualOffset` - We use the sales partner's residuals to pay for the order. \n",
"enum": [
"accountOnFile",
"residualOffset"
],
"example": "accountOnFile",
"maxLength": 17,
"type": "string"
},
"payer": {
"description": "Indicates who is paying for the terminal order. Send a value of `salesPartner`.",
"enum": [
"salesPartner"
],
"example": "salesPartner",
"maxLength": 12,
"type": "string"
}
},
"required": [
"payer",
"method"
],
"type": "object"
},
"ref_4d8895b9694561e70dfb": {
"properties": {
"currentState": {
"$ref": "#/x-devx-bundled/ref_d4a82d501fc873246869"
},
"customFields": {
"description": "Array of customField objects.\n",
"items": {
"$ref": "#/x-devx-bundled/ref_91509fee696e20aa30f2"
},
"type": "array"
},
"payment": {
"$ref": "#/x-devx-bundled/ref_55cbf93e50dd5644578a",
"description": "Object that contains information about a manual payment that the customer made to a subscription."
},
"processingTerminalId": {
"description": "Unique identifier of the terminal that the subscription is linked to.",
"example": "1234001",
"type": "string"
},
"secureToken": {
"$ref": "#/x-devx-bundled/ref_0af00846def2cd349cd2"
},
"subscriptionId": {
"description": "Unique identifier that the merchant assigned to the subscription.",
"example": "SubRef7654",
"type": "string"
}
},
"required": [
"subscriptionId",
"processingTerminalId",
"payment",
"secureToken",
"currentState"
],
"type": "object"
},
"ref_4dc72a3a5d43b92f74b4": {
"properties": {
"amount": {
"description": "Transaction amount that you send to check the surcharge amount. The value is in the currency's lowest denomination, for example, cents.",
"exclusiveMinimum": 0,
"format": "int64",
"type": "integer"
},
"card": {
"description": "Polymorphic object that contains payment details. \n\nThe value of the type parameter determines which variant you should use: \n-\t`card` - Payment card details\n-\t`cardBin` - Bank identification number (BIN) of the payment card\n-\t`secureToken` - Secure token details\n-\t`digitalWallet` - Digital wallet details\n",
"discriminator": {
"mapping": {
"card": "../../../common/schemas/transaction/payment-method-v1.yaml#/components/schemas/cardPayload",
"cardBin": "../../../common/schemas/transaction/payment-method-v1.yaml#/components/schemas/cardBinPayload",
"digitalWallet": "../../../common/schemas/transaction/payment-method-v1.yaml#/components/schemas/digitalWalletPayload",
"secureToken": "../../../common/schemas/transaction/payment-method-v1.yaml#/components/schemas/secureTokenPayload"
},
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/x-devx-bundled/ref_d7a78654a15a2c87ffaa"
},
{
"$ref": "#/x-devx-bundled/ref_9639de5a23f5cb51b2bb"
},
{
"$ref": "#/x-devx-bundled/ref_8a84ce450c6452ba8861"
},
{
"$ref": "#/x-devx-bundled/ref_f4b6c313f736a4a4eef8"
}
],
"type": "object"
},
"currency": {
"$ref": "#/x-devx-bundled/ref_5c51a0e852c4baa940d0"
},
"processingTerminalId": {
"description": "Unique identifier that we assigned to the terminal. \n\nWe recommend that you include the `processingTerminalId` to make sure that we return the correct surcharge information for the terminal. \n",
"example": "1234001",
"maxLength": 50,
"minLength": 4,
"type": "string"
}
},
"required": [
"card"
],
"type": "object"
},
"ref_4dd0a7bded1cced57558": {
"description": "Object that contains information about U.S. pricing intents for Merchant Processing Agreement (MPA) 4.0.",
"properties": {
"base": {
"$ref": "#/x-devx-bundled/ref_de4079f49a6978acc1bf"
},
"country": {
"description": "Two-digit code for the country that the pricing intent applies to. The format follows the [ISO-3166-1](https://www.iso.org/iso-3166-country-codes.html) standard.",
"enum": [
"US"
],
"type": "string"
},
"gateway": {
"$ref": "#/x-devx-bundled/ref_38aead7a2965721bcb7b"
},
"processor": {
"description": "Object that contains information about U.S. processor fees.",
"properties": {
"ach": {
"$ref": "#/x-devx-bundled/ref_3e611d2ed3e542a2cf3f"
},
"card": {
"description": "Polymorphic object that contains fees for card transactions. \n\nThe value of the planType field determines which variant you should use: \n-\t`interchangePlus` - Interchange + pricing\n-\t`interchangePlusTiered3` - Interchange pricing with three tiers\n-\t`tiered3` - Three-tiered pricing \n-\t`tiered4` - Four-tiered pricing\n-\t`tiered6` - Six-tiered pricing\n-\t`flatRate` - Flat rate pricing\n-\t`consumerChoice` - ConsumerChoice \n-\t`rewardPay` - RewardPay\n-\t`rewardPayChoice` - RewardPayChoice\n",
"discriminator": {
"mapping": {
"consumerChoice": "#/components/schemas/consumerChoice",
"flatRate": "#/components/schemas/flatRate",
"interchangePlus": "#/components/schemas/interchangePlus",
"interchangePlusTiered3": "#/components/schemas/interchangePlusTiered3",
"rewardPay": "#/components/schemas/rewardPay",
"rewardPayChoice": "#/components/schemas/rewardPayChoice",
"tiered3": "#/components/schemas/tiered3",
"tiered4": "#/components/schemas/tiered4",
"tiered6": "#/components/schemas/tiered6"
},
"propertyName": "planType"
},
"oneOf": [
{
"$ref": "#/x-devx-bundled/ref_8dedab7d683c1741ba7a"
},
{
"$ref": "#/x-devx-bundled/ref_864bd057ab1a89a2d83d"
},
{
"$ref": "#/x-devx-bundled/ref_af9f49bdb6f99196dce8"
},
{
"$ref": "#/x-devx-bundled/ref_f27ff73f6b39cb7ab2df"
},
{
"$ref": "#/x-devx-bundled/ref_f7eeb7b4e577c65a5900"
},
{
"$ref": "#/x-devx-bundled/ref_9d1ed3f4f2a6515925b3"
},
{
"$ref": "#/x-devx-bundled/ref_4730198900b1c56ebd04"
},
{
"$ref": "#/x-devx-bundled/ref_4408bb5b0b11519db114"
},
{
"$ref": "#/x-devx-bundled/ref_0ff3e9c7dbd0e2c9610e"
}
],
"type": "object"
}
},
"title": "US processor fees",
"type": "object"
},
"version": {
"description": "Version of the MPA.",
"enum": [
"4.0"
],
"type": "string"
}
},
"required": [
"country",
"version",
"base"
],
"title": "US pricing agreement version 4.0",
"type": "object"
},
"ref_4dd307ea31db18202b97": {
"description": "Object that contains surcharge information. Our gateway returns this object only if the merchant adds a surcharge to transactions.",
"properties": {
"allowed": {
"description": "Indicates if the merchant can add a surcharge when the customer uses this card.",
"example": true,
"type": "boolean"
},
"amount": {
"description": "Surcharge amount to add to the transaction. \n**Note:** Our gateway returns the surcharge amount only if you include a transaction amount in the request.\n",
"example": 87,
"exclusiveMinimum": 0,
"format": "int64",
"type": "integer"
},
"disclosure": {
"description": "Statement that informs the customer about the surcharge fee.",
"example": "A 3% surcharge is applied to cover processing fees.",
"type": "string"
},
"percentage": {
"description": "Surcharge rate that the merchant configures on their account.",
"example": 3,
"exclusiveMinimum": 0,
"format": "double",
"maximum": 100,
"type": "number",
"x-fern-type-hint": "decimal"
}
},
"required": [
"allowed"
],
"type": "object"
},
"ref_4e2978844bcac27ec794": {
"description": "Object that contains information about the instruction request to initiate a refund on a payment device.",
"properties": {
"customer": {
"$ref": "#/x-devx-bundled/ref_1674621e10fb2f321406"
},
"customizationOptions": {
"$ref": "#/x-devx-bundled/ref_cbe3ccc50d5ca95e33f7"
},
"ipAddress": {
"$ref": "#/x-devx-bundled/ref_da456c8e931765f569e4"
},
"operator": {
"description": "Operator who initiated the request.",
"example": "Jane",
"maxLength": 50,
"minLength": 0,
"type": "string"
},
"order": {
"$ref": "#/x-devx-bundled/ref_90c4c124dcdf72f36511"
},
"processingTerminalId": {
"description": "Unique identifier that we assigned to the terminal.",
"example": "1234001",
"maxLength": 50,
"minLength": 4,
"type": "string"
}
},
"required": [
"order",
"processingTerminalId"
],
"type": "object"
},
"ref_4e9a6ec939cc1e1b4a7e": {
"description": "Secure token after we replaced the customer's last name.",
"summary": "Update secure token: replace",
"value": {
"customFields": [
{
"name": "yourCustomField",
"value": "abc123"
}
],
"customer": {
"billingAddress": {
"address1": "1 Example Ave.",
"address2": "Example Address Line 2",
"address3": "Example Address Line 3",
"city": "Chicago",
"country": "US",
"postalCode": "60056",
"state": "Illinois"
},
"contactMethods": [
{
"type": "email",
"value": "sarah.hopper@example.com"
}
],
"dateOfBirth": "1990-07-15",
"firstName": "Sarah",
"lastName": "Reed",
"notificationLanguage": "en",
"referenceNumber": "Customer-12",
"shippingAddress": {
"address": {
"address1": "1 Example Ave.",
"address2": "Example Address Line 2",
"address3": "Example Address Line 3",
"city": "Chicago",
"country": "US",
"postalCode": "60056",
"state": "Illinois"
},
"recipientName": "Sarah Hopper"
}
},
"mitAgreement": "unscheduled",
"processingTerminalId": "1234001",
"secureTokenId": "MREF_abc1de23-f4a5-6789-bcd0-12e345678901fa",
"source": {
"cardNumber": "453985******7062",
"cardholderName": "Sarah Hazel Hopper",
"expiryDate": "1230",
"type": "card"
},
"status": "notValidated",
"token": "296753123456"
}
},
"ref_4f1168aea7266bb9a5d7": {
"properties": {
"scope": {
"description": "Location of the visual asset.",
"enum": [
"logo",
"idleScreen"
],
"example": "logo",
"type": "string"
},
"type": {
"description": "Format of the visual asset.",
"enum": [
"image"
],
"example": "image",
"type": "string"
},
"url": {
"description": "URL of the visual asset.",
"example": "https://www.example.com/visual-asset.png",
"type": "string"
}
},
"required": [
"type",
"scope",
"url"
],
"type": "object"
},
"ref_4facb7432bb90af0e910": {
"description": "Object that contains the fees for the Roc Services gateway.",
"properties": {
"fees": {
"description": "Object that contains the Roc Services fee amounts.",
"properties": {
"monthly": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_109fe7e5f018de7ee04b"
}
],
"description": "Monthly fee for Roc Services. The value is in the currency's lowest denomination, for example, cents."
}
},
"required": [
"monthly"
],
"type": "object"
},
"name": {
"description": "Name of the service.",
"enum": [
"rocServicesProcessing"
],
"example": "rocServicesProcessing",
"type": "string"
}
},
"required": [
"name",
"fees"
],
"type": "object"
},
"ref_4fdd06abb7b34e50e5f6": {
"description": "You do not have enough funds to complete the request.",
"summary": "Insufficient funds",
"value": {
"detail": "You do not have the required funds to complete this transaction",
"status": 400,
"title": "Insufficient funds",
"type": "https://docs.payroc.com/api/errors#insufficient-funds"
}
},
"ref_500acc5a8f54cd3372c1": {
"description": "Device Paginated List",
"summary": "Device",
"value": {
"count": 2,
"data": [
{
"createdDate": "2024-01-15T10:20:30.000+00:00",
"deviceId": "H7KPQ2M4XN",
"deviceType": {
"manufacturer": "idtech",
"model": "idtechKioskV"
},
"ksi": "FFFF5B0991ABCD01",
"lastTransaction": {
"dateTime": "2024-06-15T14:25:00.000+00:00",
"orderId": "OrderRef6543",
"processingTerminalId": "1234001"
},
"serialNumber": "1850010868",
"tender": "creditDebit"
},
{
"createdDate": "2023-02-20T11:30:40.000+00:00",
"deactivatedDate": "2024-05-10T09:15:00Z",
"deviceId": "R3TZB9WY6L",
"deviceType": {
"manufacturer": "pax",
"model": "paxA80"
},
"ksi": "FFFF5B0991ABCD02",
"lastTransaction": {
"dateTime": "2024-05-09T16:45:00.000+00:00",
"orderId": "OrderRef7654",
"processingTerminalId": "1234001"
},
"serialNumber": "WPC202833004712",
"tender": "ebt"
}
],
"hasMore": true,
"limit": 2,
"links": [
{
"href": "https://api.payroc.com/v1/devices?limit=2&after=R3TZB9WY6L",
"method": "get",
"rel": "next"
},
{
"href": "https://api.payroc.com/v1/devices?limit=2&before=H7KPQ2M4XN",
"method": "get",
"rel": "previous"
}
]
}
},
"ref_5044f4bf170b9c7bac4a": {
"description": "URI reference to created resource",
"schema": {
"type": "string"
}
},
"ref_50544b326de9b86839df": {
"description": "Object that contains information about the owner's relationship to the business.",
"properties": {
"equityPercentage": {
"default": 0,
"description": "Percentage equity stake that the owner holds in the business.",
"example": 48.5,
"format": "percentage",
"type": "number"
},
"isAuthorizedSignatory": {
"description": "Indicates if the owner is an authorized signatory.",
"example": false,
"type": "boolean"
},
"isControlProng": {
"description": "Indicates if the owner is a control prong. You can identify only one control prong for a business.",
"example": true,
"type": "boolean"
},
"title": {
"description": "Owner's job title.",
"example": "CFO",
"type": "string"
}
},
"required": [
"isControlProng"
],
"title": "Owner relationship",
"type": "object"
},
"ref_5055b13d53a7203177a7": {
"description": "Refund Payment",
"summary": "Refund Payment",
"value": {
"amount": 4999,
"description": "Refund for order OrderRef6543"
}
},
"ref_50c6f808250ff4a84ea9": {
"description": "Bank Account Verification Request for PAD",
"summary": "PAD Bank Account Verification",
"value": {
"bankAccount": {
"accountNumber": "1234567890",
"accountType": "checking",
"institutionNumber": "543",
"nameOnAccount": "Sarah Hazel Hopper",
"transitNumber": "76543",
"type": "pad"
},
"processingTerminalId": "1234001"
}
},
"ref_512556cc226fd696bef9": {
"description": "Convert a single-use token to a secure token when running a bank transfer sale.",
"summary": "Bank transfer sale with single-use token that we convert to a secure token",
"value": {
"credentialOnFile": {
"secureTokenId": "MREF_abc1de23-f4a5-6789-bcd0-12e345678901fa",
"tokenize": true
},
"customFields": [
{
"name": "yourCustomField",
"value": "abc123"
}
],
"customer": {
"contactMethods": [
{
"type": "email",
"value": "sarah.hopper@example.com"
}
],
"notificationLanguage": "en"
},
"order": {
"amount": 4999,
"currency": "USD",
"description": "Large Pepperoni Pizza",
"orderId": "OrderRef6543"
},
"paymentMethod": {
"accountType": "checking",
"secCode": "web",
"token": "abcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890",
"type": "singleUseToken"
},
"processingTerminalId": "1234001"
}
},
"ref_51455fa42a9b093dc3db": {
"description": "Copy operation duplicates a value from one location to another.",
"summary": "Update payment plan: copy",
"value": [
{
"from": "/name",
"op": "copy",
"path": "/description"
}
]
},
"ref_5170561f048f13dd2a04": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_f9d963d00740bbe00c9e"
},
{
"properties": {
"data": {
"description": "Array of polymorphic objects that contain information about how the merchant shared a payment link.",
"items": {
"oneOf": [
{
"$ref": "#/x-devx-bundled/ref_c808d1e5154b0c70f97a"
}
],
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
],
"required": [
"count",
"data",
"hasMore",
"limit"
],
"type": "object"
},
"ref_51baeef3d490d18ab4d6": {
"description": "Object that contains information about the address.",
"properties": {
"address1": {
"description": "Address line 1.",
"example": "1 Example Ave.",
"maxLength": 150,
"type": "string"
},
"address2": {
"description": "Address line 2.",
"example": "Example Address Line 2",
"maxLength": 150,
"type": "string"
},
"address3": {
"description": "Address line 3.",
"example": "Example Address Line 3",
"maxLength": 150,
"type": "string"
},
"city": {
"description": "City.",
"example": "Chicago",
"maxLength": 50,
"type": "string"
},
"country": {
"description": "Two-digit country code for the country that the business operates in. The format follows the [ISO-3166-1](https://www.iso.org/iso-3166-country-codes.html) standard.",
"example": "US",
"maxLength": 2,
"minLength": 2,
"type": "string"
},
"postalCode": {
"description": "Zip code or postal code.",
"example": "60056",
"maxLength": 10,
"type": "string"
},
"state": {
"description": "Name of the state or state abbreviation.",
"example": "Illinois",
"maxLength": 50,
"type": "string"
}
},
"required": [
"city",
"country",
"address1",
"postalCode",
"state"
],
"title": "address",
"type": "object"
},
"ref_51e918dea70bea67fcf8": {
"description": "Processing account created with addendums appended to the Merchant Processing Agreement.",
"summary": "Create processing account with addendums",
"value": {
"addendums": [
{
"type": "telehealthV1"
},
{
"type": "firearmsV1"
}
],
"address": {
"address1": "1 Example Ave.",
"address2": "Example Address Line 2",
"address3": "Example Address Line 3",
"city": "Chicago",
"country": "US",
"postalCode": "60056",
"state": "Illinois"
},
"businessStartDate": "2020-01-01",
"businessType": "restaurant",
"categoryCode": 5999,
"contactMethods": [
{
"type": "email",
"value": "jane.doe@example.com"
}
],
"contacts": [
{
"contactId": 1543,
"firstName": "Jane",
"lastName": "Doe",
"link": {
"href": "https://api.payroc.com/v1/contacts/1543",
"method": "get",
"rel": "contact"
}
}
],
"createdDate": "2024-07-02T12:00:00.000+00:00",
"doingBusinessAs": "Pizza Doe",
"funding": {
"acceleratedFundingFee": 1999,
"dailyDiscount": false,
"fundingAccounts": [
{
"fundingAccountId": 123,
"link": {
"href": "https://api.payroc.com/v1/funding-accounts/123",
"method": "get",
"rel": "fundingAccount"
},
"status": "pending"
}
],
"fundingSchedule": "nextday",
"status": "enabled"
},
"lastModifiedDate": "2024-07-02T12:00:00.000+00:00",
"merchandiseOrServiceSold": "Pizza",
"metadata": {
"customerId": "2345"
},
"owners": [
{
"firstName": "Jane",
"lastName": "Doe",
"link": {
"href": "https://api.payroc.com/v1/owners/4564",
"method": "get",
"rel": "owner"
},
"ownerId": 4564
}
],
"pricing": {
"link": {
"href": "https://api.payroc.com/v1/processing-accounts/38765/pricing",
"method": "get",
"rel": "pricing"
}
},
"processing": {
"monthlyAmounts": {
"average": 50000,
"highest": 100000
},
"transactionAmounts": {
"average": 5000,
"highest": 10000
},
"volumeBreakdown": {
"cardPresent": 77,
"ecommerce": 20,
"mailOrTelephone": 3
}
},
"processingAccountId": "38765",
"processor": "tsys",
"signature": {
"link": {
"href": "https://us.agreementexpress.net/mv2/viewer2.jsp?docId=00000000-0000-0000-0000-000000000000",
"method": "get",
"rel": "agreement"
},
"type": "requestedViaDirectLink"
},
"status": "entered",
"timezone": "America/Chicago",
"website": "www.example.com"
}
},
"ref_5211ee5be47c335f4b2e": {
"description": "Object that contains information about encrypted PIN details.",
"properties": {
"dataFormat": {
"description": "Indicates the format of the PIN data.",
"enum": [
"dukpt"
],
"example": "dukpt",
"type": "string"
},
"pin": {
"description": "Encrypted PIN. \n**Note:** PIN is encrypted using the DUKPT scheme.\n",
"example": "A1B2C3D4E5F67890ABCD1234567890ABCDEF",
"format": "hexadecimal",
"maxLength": 2147483647,
"minLength": 1,
"type": "string"
},
"pinKsn": {
"description": "Key serial number.",
"example": "1234567890ABCDEF1234",
"format": "hexadecimal",
"maxLength": 20,
"minLength": 20,
"type": "string"
}
},
"required": [
"dataFormat",
"pin",
"pinKsn"
],
"title": "dukpt",
"type": "object"
},
"ref_522a943067adee09f936": {
"description": "Payment that we captured.",
"summary": "Payment capture",
"value": {
"card": {
"cardNumber": "453985******7062",
"entryMethod": "keyed",
"expiryDate": "1230",
"securityChecks": {
"avsResult": "Y",
"cvvResult": "M"
},
"type": "MasterCard"
},
"customFields": [
{
"name": "yourCustomField",
"value": "abc123"
}
],
"customer": {
"billingAddress": {
"address1": "1 Example Ave.",
"address2": "Example Address Line 2",
"address3": "Example Address Line 3",
"city": "Chicago",
"country": "US",
"postalCode": "60056",
"state": "Illinois"
},
"firstName": "Sarah",
"lastName": "Hopper",
"shippingAddress": {
"address": {
"address1": "1 Example Ave.",
"address2": "Example Address Line 2",
"address3": "Example Address Line 3",
"city": "Chicago",
"country": "US",
"postalCode": "60056",
"state": "Illinois"
},
"recipientName": "Sarah Hopper"
}
},
"operator": "Jane",
"order": {
"amount": 4999,
"currency": "USD",
"dateTime": "2024-07-02T15:30:00Z",
"description": "Large Pepperoni Pizza",
"orderId": "OrderRef6543"
},
"paymentId": "M2MJOG6O2Y",
"processingTerminalId": "1234001",
"supportedOperations": [
"capture",
"fullyReverse",
"partiallyReverse",
"incrementAuthorization",
"adjustTip",
"setAsPending"
],
"transactionResult": {
"approvalCode": "OK3",
"authorizedAmount": 4999,
"currency": "USD",
"responseCode": "A",
"responseMessage": "OK3",
"status": "ready",
"type": "sale"
}
}
},
"ref_52512ed7a070cd51d20e": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_f9d963d00740bbe00c9e"
},
{
"properties": {
"data": {
"description": "Array of processingAccount objects.",
"items": {
"$ref": "#/x-devx-bundled/ref_214544c04ba3708ed212"
},
"type": "array"
}
},
"type": "object"
}
],
"title": "paginated processing accounts",
"type": "object"
},
"ref_52be224302e47215ddfc": {
"description": "Retrieve owners associated with a processing account.",
"summary": "Paginated list of processing account owners",
"value": {
"count": 2,
"data": [
{
"address": {
"address1": "1 Example Ave.",
"address2": "Example Address Line 2",
"address3": "Example Address Line 3",
"city": "Chicago",
"country": "US",
"postalCode": "60056",
"state": "Illinois"
},
"contactMethods": [
{
"type": "email",
"value": "jane.doe@example.com"
},
{
"type": "phone",
"value": "2025550164"
}
],
"dateOfBirth": "1964-03-22",
"firstName": "Jane",
"identifiers": [
{
"type": "nationalId",
"value": "xxxxx4320"
}
],
"lastName": "Doe",
"middleName": "Helen",
"ownerId": 4564,
"relationship": {
"equityPercentage": 48.5,
"isAuthorizedSignatory": false,
"isControlProng": true,
"title": "CFO"
}
},
{
"address": {
"address1": "2 Example Ave.",
"address2": "Example Address Line 2",
"address3": "Example Address Line 3",
"city": "Chicago",
"country": "US",
"postalCode": "60056",
"state": "Illinois"
},
"contactMethods": [
{
"type": "email",
"value": "fred.nerk@example.com"
}
],
"dateOfBirth": "1980-01-19",
"firstName": "Fred",
"identifiers": [
{
"type": "nationalId",
"value": "xxxxx9876"
}
],
"lastName": "Nerk",
"middleName": "Jim",
"ownerId": 12346,
"relationship": {
"equityPercentage": 51.5,
"isAuthorizedSignatory": true,
"isControlProng": false,
"title": "CEO"
}
}
],
"hasMore": true,
"limit": 2,
"links": [
{
"href": "https://api.payroc.com/v1/processing-accounts/38765/owners?before=4564&limit=2",
"method": "get",
"rel": "previous"
},
{
"href": "https://api.payroc.com/v1/processing-accounts/38765/owners?after=12346&limit=2",
"method": "get",
"rel": "next"
}
]
}
},
"ref_52ea3073e3a03e7c1eb3": {
"properties": {
"costBreakdown": {
"description": "Object that contains information about the items in the terminal order and the cost of the items.",
"properties": {
"customCharges": {
"description": "Object that contains additional charges for the terminal order.",
"items": {
"properties": {
"name": {
"description": "Name of the charge.",
"example": "Setup Fee",
"maxLength": 50,
"minLength": 1,
"type": "string"
},
"value": {
"description": "Cost of the charge. The value is in the currency’s lowest denomination, for example, cents.",
"example": 4999,
"maximum": 999999,
"minimum": 0,
"type": "integer"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"maxItems": 10,
"minItems": 1,
"type": "array"
},
"items": {
"description": "Array of items objects.",
"items": {
"properties": {
"name": {
"description": "Name or brief description of the item.",
"example": "Terminal",
"maxLength": 50,
"minLength": 1,
"type": "string"
},
"quantity": {
"description": "Quantity of the item in the order.",
"example": 1,
"minimum": 1,
"type": "integer"
},
"unitCost": {
"description": "Cost of the item. The value is in the currency’s lowest denomination, for example, cents.",
"example": 4999,
"maximum": 999999,
"minimum": 0,
"type": "integer"
}
},
"required": [
"name",
"quantity",
"unitCost"
],
"type": "object"
},
"maxItems": 50,
"minItems": 1,
"type": "array"
},
"shippingCost": {
"description": "Cost of shipping the terminal order. The value is in the currency’s lowest denomination, for example, cents.",
"example": 1999,
"maximum": 999999,
"minimum": 0,
"type": "integer"
}
},
"required": [
"items"
],
"type": "object"
},
"payment": {
"description": "Polymorphic object that contains information about how the payer is paying for the terminal order. \n\nThe value of the payer field determines which variant you should use: \n- `merchant` - Merchant pays for the terminal.\n- `partner` - Partner pays for the terminal.\n",
"discriminator": {
"mapping": {
"merchant": "#/components/schemas/merchant",
"partner": "#/components/schemas/partner"
},
"propertyName": "payer"
},
"oneOf": [
{
"$ref": "#/x-devx-bundled/ref_fc8f7663e04a5c1c54b8"
},
{
"$ref": "#/x-devx-bundled/ref_4d4e2c710777ba68dcf1"
}
],
"type": "object"
},
"paymentIntentType": {
"description": "Type of payment intent.",
"enum": [
"purchase"
],
"example": "purchase",
"maxLength": 8,
"type": "string"
},
"subTotal": {
"description": "Total amount of the terminal order before tax. The value is in the currency’s lowest denomination, for example, cents. \n**Note**: You must send a value for this parameter if the payer is `merchant`.\n",
"example": 4999,
"maximum": 999999,
"minimum": 0,
"type": "integer"
},
"tax": {
"description": "Object that contains the tax information for the terminal order.",
"properties": {
"isTaxExempt": {
"default": false,
"description": "Indicates if the terminal order is tax exempt. The default value is `false`. \n\n**Note**: If you send a value of `false`, send a value for the taxAmount parameter.\n",
"example": true,
"type": "boolean"
},
"taxAmount": {
"description": "Amount of tax for the terminal order. The value is in the currency’s lowest denomination, for example, cents.",
"example": 217,
"maximum": 999999,
"minimum": 0,
"type": "integer"
}
},
"type": "object"
}
},
"required": [
"paymentIntentType",
"payment"
],
"type": "object"
},
"ref_5318f22f1b577e653c08": {
"description": "Object that contains information about the initial cost that a customer pays to set up the subscription.",
"properties": {
"amount": {
"description": "Total amount for the transaction. The value is in the currency's lowest denomination, for example, cents.
\n
**Important:** Do not add the surcharge to the amount parameter in the request. If the transaction is eligible for surcharging, our gateway adds the surcharge to the amount in the request, and then returns the updated amount in the response.\n",
"example": 4999,
"exclusiveMinimum": 0,
"format": "int64",
"maximum": 999999999999,
"type": "integer"
},
"description": {
"description": "Description of the transaction.",
"example": "Monthly Premium Club subscription",
"maxLength": 1024,
"minLength": 1,
"type": "string"
},
"orderId": {
"description": "Unique identifier that the merchant assigns to the transaction.",
"example": "OrderRef6543",
"maxLength": 24,
"minLength": 1,
"type": "string"
}
},
"type": "object"
},
"ref_53394fbdfe65e9c5ea22": {
"description": "Filter by funding instructions sent before a specific date. Send a value in **YYYY-MM-DD** format.",
"examples": {
"example": {
"value": "2024-07-03"
}
},
"in": "query",
"name": "dateTo",
"required": true,
"schema": {
"format": "date",
"type": "string"
}
},
"ref_550e89c1ff5ee1a9194c": {
"description": "A Patch Replace Operation.",
"properties": {
"op": {
"description": "`replace` operation.",
"enum": [
"replace"
],
"type": "string"
},
"path": {
"description": "Location of the value that you want to replace.\nThe format for this value is JSON Pointer.\n",
"type": "string"
},
"value": {
"description": "Value that you want to use as the replacement."
}
},
"required": [
"op",
"path",
"value"
],
"title": "Patch Replace Operation",
"type": "object"
},
"ref_558a709ae7ced0d8495a": {
"description": "Bank Transfer Unreferenced Refund",
"summary": "Bank Transfer Unreferenced Refund",
"value": {
"bankAccount": {
"accountNumber": "****3159",
"nameOnAccount": "Sarah Hazel Hopper",
"routingNumber": "*****0277",
"secCode": "web",
"type": "ach"
},
"customFields": [
{
"name": "yourCustomField",
"value": "abc123"
}
],
"customer": {
"contactMethods": [
{
"type": "email",
"value": "sarah.hopper@example.com"
}
],
"notificationLanguage": "en"
},
"order": {
"amount": 4999,
"currency": "USD",
"dateTime": "2024-07-02T15:30:00Z",
"description": "Refund for order OrderRef6543",
"orderId": "OrderRef6543"
},
"processingTerminalId": "1234001",
"refundId": "CD3HN88U9F",
"transactionResult": {
"authorizedAmount": -4999,
"currency": "USD",
"processorResponseCode": "0",
"responseCode": "A",
"responseMessage": "NoError",
"status": "reversal",
"type": "unreferencedRefund"
}
}
},
"ref_55cbf93e50dd5644578a": {
"description": "Object that contains information about a payment.",
"properties": {
"amount": {
"description": "Amount of the payment. This value is in the currency’s lowest denomination, for example, cents.",
"example": 4999,
"format": "int64",
"type": "integer"
},
"currency": {
"$ref": "#/x-devx-bundled/ref_5c51a0e852c4baa940d0"
},
"dateTime": {
"description": "Date and time that the payment was processed.",
"example": "2024-07-02T15:30:00Z",
"format": "date-time",
"type": "string"
},
"link": {
"$ref": "#/x-devx-bundled/ref_27e6d0e095fb23cba669"
},
"paymentId": {
"description": "Unique identifier of the payment.",
"example": "M2MJOG6O2Y",
"maxLength": 10,
"minLength": 10,
"type": "string"
},
"responseCode": {
"description": "Response from the processor. \n- `A` - The processor approved the transaction. \n- `D` - The processor declined the transaction. \n- `E` - The processor received the transaction but will process the transaction later. \n- `P` - The processor authorized a portion of the original amount of the transaction. \n- `R` - The issuer declined the transaction and indicated that the customer should contact their bank. \n- `C` - The issuer declined the transaction and indicated that the merchant should keep the card as it was reported lost or stolen.\n",
"enum": [
"A",
"D",
"E",
"P",
"R",
"C"
],
"example": "A",
"type": "string"
},
"responseMessage": {
"description": "Response description from the processor.",
"example": "Transaction approved",
"maxLength": 48,
"minLength": 1,
"type": "string"
},
"status": {
"description": "Current status of the payment.",
"enum": [
"ready",
"pending",
"declined",
"complete",
"referral",
"pickup",
"reversal",
"returned",
"admin",
"expired",
"accepted"
],
"example": "complete",
"type": "string"
}
},
"required": [
"amount",
"currency",
"dateTime",
"paymentId",
"status",
"responseCode"
],
"type": "object"
},
"ref_565ad869517cae1702cb": {
"description": "Refund a payment that is not linked to a previous transaction. Unreferenced refunds are available only on certain accounts.",
"properties": {
"channel": {
"description": "Channel that the merchant used to request the refund.",
"enum": [
"pos",
"moto"
],
"example": "pos",
"type": "string"
},
"customFields": {
"description": "Array of customField objects.\n",
"items": {
"$ref": "#/x-devx-bundled/ref_91509fee696e20aa30f2"
},
"type": "array"
},
"customer": {
"$ref": "#/x-devx-bundled/ref_1674621e10fb2f321406"
},
"ipAddress": {
"$ref": "#/x-devx-bundled/ref_da456c8e931765f569e4"
},
"operator": {
"description": "Operator who initiated the request.",
"example": "Jane",
"maxLength": 50,
"minLength": 0,
"type": "string"
},
"order": {
"$ref": "#/x-devx-bundled/ref_6f025c42b03b33927339"
},
"processingTerminalId": {
"description": "Unique identifier that we assigned to the terminal.",
"example": "1234001",
"maxLength": 50,
"minLength": 4,
"type": "string"
},
"refundMethod": {
"description": "Polymorphic object that contains information about the payment method that the merchant uses to refund the customer. \n\nThe value of the type parameter determines which variant you should use:\n-\t`card` - Payment card details\n-\t`secureToken` - Secure token details\n",
"discriminator": {
"mapping": {
"card": "../../../common/schemas/transaction/payment-method-v1.yaml#/components/schemas/cardPayload",
"secureToken": "../../../common/schemas/transaction/payment-method-v1.yaml#/components/schemas/secureTokenPayload"
},
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/x-devx-bundled/ref_d7a78654a15a2c87ffaa"
},
{
"$ref": "#/x-devx-bundled/ref_8a84ce450c6452ba8861"
}
],
"type": "object"
}
},
"required": [
"channel",
"order",
"processingTerminalId",
"refundMethod"
],
"type": "object"
},
"ref_5698b09ff5e98efedc02": {
"description": "Object that contains the customer's contact details and address information.",
"properties": {
"billingAddress": {
"$ref": "#/x-devx-bundled/ref_ec3e38e8e442656fe694",
"description": "Object that contains information about the address that the card is registered to."
},
"contactMethods": {
"description": "Array of polymorphic objects, which contain contact information. \n\nThe value of the type parameter determines which variant you should use: \n-\t`email` - Email address \n-\t`phone` - Phone number\n-\t`mobile` - Mobile number\n-\t`fax` - Fax number\n",
"items": {
"$ref": "#/x-devx-bundled/ref_7960ea97dd5f79b93ae4"
},
"type": "array",
"uniqueItems": true
},
"dateOfBirth": {
"description": "Customer's date of birth. The format for this value is **YYYY-MM-DD**.",
"example": "1990-07-15",
"format": "date",
"type": "string"
},
"firstName": {
"description": "Customer's first name.",
"example": "Sarah",
"maxLength": 60,
"minLength": 0,
"type": "string"
},
"lastName": {
"description": "Customer's last name.",
"example": "Hopper",
"maxLength": 60,
"minLength": 0,
"type": "string"
},
"notificationLanguage": {
"description": "Language that the customer uses for notifications. This code follows the [ISO 639-1](https://www.iso.org/iso-639-language-code) alpha-2 standard. \n",
"enum": [
"en",
"fr"
],
"example": "en",
"format": "iso-639-1",
"maxLength": 2,
"minLength": 2,
"type": "string"
},
"referenceNumber": {
"description": "Identifier of the transaction, also known as a customer code. \n\nFor requests, you must send a value for **referenceNumber** if the customer provides one. \n",
"example": "CustomerCode234567",
"maxLength": 48,
"minLength": 0,
"type": "string"
},
"shippingAddress": {
"$ref": "#/x-devx-bundled/ref_40d41a554fd923076429"
}
},
"type": "object"
},
"ref_56fb59ea73f456ce6c1e": {
"description": "Filter results by the unique identifier that we assigned to the terminal.",
"examples": {
"example": {
"value": "1234001"
}
},
"in": "query",
"name": "processingTerminalId",
"required": true,
"schema": {
"maxLength": 50,
"minLength": 4,
"type": "string"
}
},
"ref_571bf5eca14a53be5ae4": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_5318f22f1b577e653c08"
},
{
"properties": {
"breakdown": {
"$ref": "#/x-devx-bundled/ref_61195d3ba563471558fa"
}
},
"type": "object"
}
],
"type": "object"
},
"ref_57317f96ab7baac16ed9": {
"summary": "Paginated funding accounts",
"value": {
"count": 2,
"data": [
{
"createdDate": "2024-07-02T15:30:00+00:00",
"fundingAccountId": 123,
"lastModifiedDate": "2024-07-02T15:30:00+00:00",
"links": [
{
"href": "https://api.payroc.com/v1/processing-accounts/4525644354",
"method": "get",
"rel": "parent"
}
],
"metadata": {
"yourCustomField": "abc123"
},
"nameOnAccount": "Jane Doe",
"paymentMethods": [
{
"type": "ach",
"value": {
"accountNumber": "******7890",
"routingNumber": "*****6789"
}
}
],
"status": "approved",
"type": "checking",
"use": "credit"
},
{
"createdDate": "2024-07-02T15:30:00+00:00",
"fundingAccountId": 124,
"lastModifiedDate": "2024-07-02T15:30:00+00:00",
"links": [
{
"href": "https://api.payroc.com/v1/funding-recipients/234",
"method": "get",
"rel": "parent"
}
],
"metadata": {
"yourCustomField": "abc123"
},
"nameOnAccount": "Jane Doe",
"paymentMethods": [
{
"type": "ach",
"value": {
"accountNumber": "******3491",
"routingNumber": "*****8725"
}
}
],
"status": "pending",
"type": "checking",
"use": "debit"
}
],
"hasMore": true,
"limit": 2,
"links": [
{
"href": "https://api.payroc.com/v1/funding-accounts?before=123&limit=2",
"method": "get",
"rel": "previous"
},
{
"href": "https://api.payroc.com/v1/funding-accounts?after=124&limit=2",
"method": "get",
"rel": "next"
}
]
}
},
"ref_57830f2b2eee9f04ad45": {
"properties": {
"type": {
"description": "Type of closed-loop card.",
"enum": [
"mifare"
],
"example": "mifare",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"ref_57a1ebd7dd882416e71e": {
"description": "Resource cannot be modified.",
"summary": "Cannot be modified",
"value": {
"detail": "You cannot modify this resource in its current state",
"status": 409,
"title": "Cannot be modified",
"type": "https://docs.payroc.com/api/errors#cannot-be-modified"
}
},
"ref_583e2413d26b1ecd5dc2": {
"description": "A JSON Patch operation as defined by RFC 6902.",
"discriminator": {
"mapping": {
"add": "#/components/schemas/patchAdd",
"copy": "#/components/schemas/patchCopy",
"move": "#/components/schemas/patchMove",
"remove": "#/components/schemas/patchRemove",
"replace": "#/components/schemas/patchReplace",
"test": "#/components/schemas/patchTest"
},
"propertyName": "op"
},
"oneOf": [
{
"$ref": "#/x-devx-bundled/ref_b8699e96d2925dd30c72"
},
{
"$ref": "#/x-devx-bundled/ref_1a4c99efee44a7a21c17"
},
{
"$ref": "#/x-devx-bundled/ref_550e89c1ff5ee1a9194c"
},
{
"$ref": "#/x-devx-bundled/ref_cac3c05e321e27a01669"
},
{
"$ref": "#/x-devx-bundled/ref_de9d7aba9da94ce2b1c4"
},
{
"$ref": "#/x-devx-bundled/ref_83c0763f601c84e43200"
}
],
"title": "Patch Operation"
},
"ref_586da9478dd65b412201": {
"description": "Object that contains information about a return.",
"properties": {
"closed": {
"description": "Indicates whether the merchant accepted an alternative payment method to complete the payment.",
"example": false,
"type": "boolean"
},
"date": {
"description": "The date that the check was returned.",
"example": "2024-07-02",
"format": "date",
"type": "string"
},
"link": {
"$ref": "#/x-devx-bundled/ref_27e6d0e095fb23cba669"
},
"paymentId": {
"description": "Unique identifier that our gateway assigned to the payment.",
"example": "M2MJOG6O2Y",
"maxLength": 10,
"minLength": 10,
"type": "string"
},
"represented": {
"description": "Indicates whether the return has been re-presented.",
"example": false,
"type": "boolean"
},
"returnCode": {
"description": "The NACHA return code.",
"example": "R11",
"type": "string"
},
"returnReason": {
"description": "The reason why the check was returned.",
"example": "Customer advises not authorized",
"type": "string"
}
},
"required": [
"date",
"paymentId",
"represented",
"closed",
"returnCode",
"returnReason"
],
"type": "object"
},
"ref_58b532704ca76eef45cb": {
"description": "New merchant platform created for a Fiserv-bound merchant. The Clover Merchant Processing Amendment addendum is appended to the Merchant Processing Agreement with equipment line-item pre-fill data.",
"summary": "Create Fiserv merchant platform with Clover Merchant Processing Amendment",
"value": {
"business": {
"addresses": [
{
"address1": "1 Example Ave.",
"address2": "Example Address Line 2",
"address3": "Example Address Line 3",
"city": "Chicago",
"country": "US",
"postalCode": "60056",
"state": "Illinois",
"type": "legalAddress"
}
],
"contactMethods": [
{
"type": "email",
"value": "jane.doe@example.com"
}
],
"countryOfOperation": "US",
"name": "Example Corp",
"organizationType": "privateCorporation",
"taxId": "xxxxx6789"
},
"createdDate": "2024-07-02T12:00:00.000+00:00",
"lastModifiedDate": "2024-07-02T12:00:00.000+00:00",
"merchantPlatformId": "12347",
"processingAccounts": [
{
"addendums": [
{
"lineItems": {
"cloverCashDrawer": {
"quantity": 2,
"totalPrice": 19800
},
"cloverSoloPosSystem": {
"quantity": 1,
"totalPrice": 149900
}
},
"type": "cloverMerchantProcessingAmendmentV1"
}
],
"doingBusinessAs": "Pizza Doe",
"link": {
"href": "https://api.payroc.com/v1/processing-accounts/38768",
"method": "get",
"rel": "processingAccount"
},
"processingAccountId": "38768",
"processor": "fiserv",
"signature": {
"link": {
"href": "https://us.agreementexpress.net/mv2/viewer2.jsp?docId=00000000-0000-0000-0000-000000000000",
"method": "get",
"rel": "agreement"
},
"type": "requestedViaDirectLink"
},
"status": "pending"
}
]
}
},
"ref_597d3524aa5e3d0750d8": {
"description": "Create a processing account for a Fiserv-bound merchant with no Clover devices.",
"summary": "Create Fiserv processing account",
"value": {
"address": {
"address1": "1 Example Ave.",
"address2": "Example Address Line 2",
"address3": "Example Address Line 3",
"city": "Chicago",
"country": "US",
"postalCode": "60056",
"state": "Illinois"
},
"businessStartDate": "2020-01-01",
"businessType": "restaurant",
"categoryCode": 5999,
"contactMethods": [
{
"type": "email",
"value": "jane.doe@example.com"
}
],
"doingBusinessAs": "Pizza Doe",
"funding": {
"acceleratedFundingFee": 1999,
"dailyDiscount": false,
"fundingAccounts": [
{
"metadata": {
"yourCustomField": "abc123"
},
"nameOnAccount": "Jane Doe",
"paymentMethods": [
{
"type": "ach",
"value": {
"accountNumber": "1234567890",
"routingNumber": "123456789"
}
}
],
"type": "checking",
"use": "creditAndDebit"
}
],
"fundingSchedule": "nextday"
},
"merchandiseOrServiceSold": "Pizza",
"metadata": {
"customerId": "2345"
},
"owners": [
{
"address": {
"address1": "1 Example Ave.",
"address2": "Example Address Line 2",
"address3": "Example Address Line 3",
"city": "Chicago",
"country": "US",
"postalCode": "60056",
"state": "Illinois"
},
"contactMethods": [
{
"type": "email",
"value": "jane.doe@example.com"
}
],
"dateOfBirth": "1964-03-22",
"firstName": "Jane",
"identifiers": [
{
"type": "nationalId",
"value": "000-00-4320"
}
],
"lastName": "Doe",
"middleName": "Helen",
"relationship": {
"equityPercentage": 51.5,
"isAuthorizedSignatory": false,
"isControlProng": true,
"title": "CFO"
}
}
],
"pricing": {
"pricingIntentId": "6123",
"type": "intent"
},
"processing": {
"monthlyAmounts": {
"average": 50000,
"highest": 100000
},
"transactionAmounts": {
"average": 5000,
"highest": 10000
},
"volumeBreakdown": {
"cardPresent": 77,
"ecommerce": 20,
"mailOrTelephone": 3
}
},
"processor": "fiserv",
"signature": {
"type": "requestedViaDirectLink"
},
"timezone": "America/Chicago",
"website": "www.example.com"
}
},
"ref_598cfb3afda24a016a26": {
"description": "Filter results by the settlement status.",
"examples": {
"example": {
"value": "settled"
}
},
"in": "query",
"name": "settlementState",
"schema": {
"enum": [
"settled",
"unsettled"
],
"type": "string"
}
},
"ref_59a42c003a97fcdab712": {
"description": "Limit the maximum number of results that we return for each page.",
"examples": {
"example": {
"value": 25
}
},
"in": "query",
"name": "limit",
"schema": {
"default": 10,
"maximum": 100,
"type": "integer"
}
},
"ref_59d2fac2d442aa906a28": {
"description": "Refund instruction failed",
"summary": "Refund instruction failed",
"value": {
"detail": "You cannot cancel this resource in its current state",
"errors": [
{
"message": "Failed instruction cannot be canceled",
"parameter": "refundInstructionId"
}
],
"status": 409,
"title": "Cannot be canceled",
"type": "https://docs.payroc.com/api/errors#cannot-be-canceled"
}
},
"ref_59da30985adac116998a": {
"description": "Refund",
"summary": "Refund",
"value": {
"card": {
"cardNumber": "453985******7062",
"entryMethod": "keyed",
"expiryDate": "1230",
"type": "Visa Credit"
},
"customFields": [
{
"name": "yourCustomField",
"value": "abc123"
}
],
"order": {
"amount": 4999,
"currency": "USD",
"dateTime": "2024-07-02T15:30:00Z",
"description": "Refund for order OrderRef6543",
"orderId": "OrderRef6543"
},
"processingTerminalId": "1234001",
"refundId": "CD3HN88U9F",
"transactionResult": {
"approvalCode": "000000",
"authorizedAmount": -4999,
"currency": "USD",
"responseCode": "A",
"responseMessage": "OK5",
"status": "ready",
"type": "refund"
}
}
},
"ref_59f945de11366ab1ba9f": {
"description": "Unique identifier that we assigned to the closed-loop read.",
"examples": {
"example": {
"value": "JDN4ILZB0T"
}
},
"in": "path",
"name": "closedLoopReadId",
"required": true,
"schema": {
"maxLength": 10,
"minLength": 10,
"type": "string"
}
},
"ref_5a22509861c42e65faff": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_f9d963d00740bbe00c9e"
},
{
"properties": {
"data": {
"description": "Array of refund transactions.",
"items": {
"$ref": "#/x-devx-bundled/ref_ac099976d4eaf2dbdeec"
},
"type": "array"
}
},
"type": "object"
}
],
"required": [
"count",
"data",
"hasMore",
"limit"
],
"type": "object"
},
"ref_5a29f67f5e5f798760db": {
"description": "Unique identifier that we assigned to the payment instruction.",
"examples": {
"example": {
"value": "e743a9165d134678a9100ebba3b29597"
}
},
"in": "path",
"name": "paymentInstructionId",
"required": true,
"schema": {
"maxLength": 36,
"minLength": 1,
"type": "string"
}
},
"ref_5a3ff2fba2045fc11a6c": {
"properties": {
"baseAmount": {
"description": "Total amount of the transaction in the merchant’s currency. The value is in the currency’s lowest denomination, for example, cents.",
"exclusiveMinimum": 0,
"format": "int64",
"type": "integer"
},
"baseCurrency": {
"$ref": "#/x-devx-bundled/ref_5c51a0e852c4baa940d0"
},
"channel": {
"description": "Channel that the merchant used to receive payment details for the transaction.",
"enum": [
"pos",
"web",
"moto"
],
"example": "pos",
"type": "string"
},
"operator": {
"description": "Operator who ran the transaction.",
"example": "Jane",
"maxLength": 50,
"minLength": 1,
"type": "string"
},
"paymentMethod": {
"description": "Polymorphic object that contains payment details. \n\nThe value of the type parameter determines which variant you should use: \n-\t`card` - Payment card details\n-\t`secureToken` - Secure token details\n-\t`digitalWallet` - Digital wallet details\n",
"discriminator": {
"mapping": {
"card": "../../../common/schemas/transaction/payment-method-v1.yaml#/components/schemas/cardPayload",
"digitalWallet": "../../../common/schemas/transaction/payment-method-v1.yaml#/components/schemas/digitalWalletPayload",
"secureToken": "../../../common/schemas/transaction/payment-method-v1.yaml#/components/schemas/secureTokenPayload"
},
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/x-devx-bundled/ref_d7a78654a15a2c87ffaa"
},
{
"$ref": "#/x-devx-bundled/ref_8a84ce450c6452ba8861"
},
{
"$ref": "#/x-devx-bundled/ref_f4b6c313f736a4a4eef8"
}
],
"type": "object"
},
"processingTerminalId": {
"description": "Unique identifier that we assigned to the terminal.",
"example": "1234001",
"maxLength": 50,
"minLength": 4,
"type": "string"
}
},
"required": [
"baseAmount",
"baseCurrency",
"channel",
"paymentMethod",
"processingTerminalId"
],
"type": "object"
},
"ref_5ac2012c6011db9c1f88": {
"description": "Object that contains information about the initial cost that a customer pays to set up the subscription.",
"properties": {
"amount": {
"description": "Total amount before surcharges. The value is in the currency's lowest denomination, for example, cents.",
"example": 4999,
"exclusiveMinimum": 0,
"format": "int64",
"maximum": 999999999999,
"type": "integer"
},
"description": {
"description": "Description of the transaction.",
"example": "Initial setup fee for Premium Club subscription",
"maxLength": 1024,
"minLength": 1,
"type": "string"
}
},
"type": "object"
},
"ref_5acdcf065560ed15cf74": {
"description": "Object that contains the details of the payment card.",
"properties": {
"balances": {
"description": "Array of cardBalance objects. Our gateway returns this array only when the customer uses an Electronic Benefit Transfer (EBT) card.",
"example": [
{
"amount": 50000,
"benefitCategory": "cash",
"currency": "USD"
},
{
"amount": 10000,
"benefitCategory": "foodStamp",
"currency": "USD"
}
],
"items": {
"$ref": "#/x-devx-bundled/ref_86018b50b59b772c6408"
},
"type": "array"
},
"cardNumber": {
"description": "Masked card number. Our gateway shows only the first six digits and the last four digits of the card number, for example, 500165******0000.\n",
"example": "453985******7062",
"maxLength": 19,
"minLength": 12,
"type": "string"
},
"cardholderName": {
"description": "Cardholder’s name.",
"example": "Sarah Hazel Hopper",
"maxLength": 50,
"minLength": 1,
"type": "string"
},
"cardholderSignature": {
"description": "Cardholder’s signature.",
"example": "a1b1c012345678a000b000c0012345d0e0f010g10061a031i001j071k0a1b0c1d0e1234567890120f1g0h1i0j1k0a1b0123451c012d0e1f0g1h0i1j123k1a1b1c1d1e1f1g123h1i1j1k1a1b1c1d1e1f1g123h123i1j123k12340a120a12345b012c0123012d0d1e0f1g0h1i123j123k10000",
"type": "string"
},
"emvTags": {
"description": "Array of emvTag objects.",
"example": [
{
"hex": "9F36",
"value": "001234"
},
{
"hex": "5F2A",
"value": "0840"
}
],
"items": {
"$ref": "#/x-devx-bundled/ref_7f2c023fc705cc690639"
},
"type": "array",
"uniqueItems": true
},
"entryMethod": {
"description": "Method that the device used to capture the card details.",
"enum": [
"icc",
"keyed",
"swiped",
"swipedFallback",
"contactlessIcc",
"contactlessMsr"
],
"example": "contactlessIcc",
"type": "string"
},
"expiryDate": {
"description": "Expiry date of the customer's card. The format is in **MMYY**.",
"example": "0725",
"pattern": "[0-9]{4}",
"type": "string"
},
"secureToken": {
"$ref": "#/x-devx-bundled/ref_0af00846def2cd349cd2"
},
"securityChecks": {
"$ref": "#/x-devx-bundled/ref_21f616026feedfb1f92c"
},
"type": {
"description": "Card brand that the card is linked to. For example, Visa.",
"example": "Visa",
"type": "string"
}
},
"required": [
"cardNumber",
"expiryDate",
"type"
],
"type": "object"
},
"ref_5ad699da95aecdeeae2d": {
"properties": {
"bankAccount": {
"description": "Polymorphic object that contains bank account information. \n\nThe value of the type field determines which variant you should use: \n-\t`ach` - Automated Clearing House (ACH) details\n-\t`pad` - Pre-authorized debit (PAD) details\n",
"discriminator": {
"mapping": {
"ach": "../../../common/schemas/transaction/payment-method-v1.yaml#/components/schemas/achPayload",
"pad": "../../../common/schemas/transaction/payment-method-v1.yaml#/components/schemas/padPayload"
},
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/x-devx-bundled/ref_c799d35ea53644eec4e6"
},
{
"$ref": "#/x-devx-bundled/ref_d8468a3993ad87f32e78"
}
],
"type": "object"
},
"processingTerminalId": {
"description": "Unique identifier that we assigned to the terminal.",
"example": "1234001",
"maxLength": 50,
"minLength": 4,
"type": "string"
}
},
"required": [
"processingTerminalId",
"bankAccount"
],
"type": "object"
},
"ref_5b962e147e5363de386e": {
"description": "Object that contains information about Interchange Plus.",
"properties": {
"fees": {
"description": "Object that contains information about the fees.",
"properties": {
"amex": {
"description": "Object that contains the fees for American Express transactions.",
"discriminator": {
"mapping": {
"direct": "#/components/schemas/interchangePlusAmexDirect",
"optBlue": "#/components/schemas/interchangePlusAmexOptBlue"
},
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/x-devx-bundled/ref_8525343432030fe67b60"
},
{
"$ref": "#/x-devx-bundled/ref_2b34b6058854a07b6289"
}
]
},
"electronicBenefitsTransfer": {
"$ref": "#/x-devx-bundled/ref_2c771c635a39c1d2ba57"
},
"mastercardVisaDiscover": {
"$ref": "#/x-devx-bundled/ref_01f55c7b2d1709665555",
"description": "Object that contains the fees for Mastercard, Visa, and Discover transactions."
},
"pinDebit": {
"$ref": "#/x-devx-bundled/ref_39ea196745f35c0c62a3"
},
"specialityCards": {
"$ref": "#/x-devx-bundled/ref_ca2b35d2127e00c3b179"
}
},
"required": [
"mastercardVisaDiscover"
],
"type": "object"
},
"planType": {
"description": "Type of processing plan.",
"enum": [
"interchangePlus"
],
"example": "interchangePlus",
"type": "string"
}
},
"required": [
"planType",
"fees"
],
"title": "Interchange Plus Plan",
"type": "object"
},
"ref_5bdee1909a4721a11ce5": {
"description": "Object that contains the instructions for capturing a signature on a physical device.",
"properties": {
"processingTerminalId": {
"description": "Unique identifier that we assigned to the terminal.",
"example": "1234001",
"maxLength": 50,
"minLength": 4,
"type": "string"
}
},
"required": [
"processingTerminalId"
],
"type": "object"
},
"ref_5c3135eefcea7ae15c9c": {
"description": "Signature instruction already completed",
"summary": "Signature instruction already completed",
"value": {
"detail": "You cannot cancel this resource in its current state",
"errors": [
{
"message": "Completed instruction cannot be canceled",
"parameter": "signatureInstructionId"
}
],
"link": {
"href": "https://api.payroc.com/v1/signatures/M2MJOG6O2Y",
"method": "GET",
"rel": "signature"
},
"status": 409,
"title": "Cannot be canceled",
"type": "https://docs.payroc.com/api/errors#cannot-be-canceled"
}
},
"ref_5c46dfd7d417f370f5b9": {
"properties": {
"midQualRate": {
"$ref": "#/x-devx-bundled/ref_01f55c7b2d1709665555",
"description": "Object that contains the fees for a mid-qualified transaction."
},
"nonQualRate": {
"$ref": "#/x-devx-bundled/ref_01f55c7b2d1709665555",
"description": "Object that contains the fees for a non-qualified transaction."
},
"qualifiedRate": {
"$ref": "#/x-devx-bundled/ref_01f55c7b2d1709665555",
"description": "Object that contains the fees for a qualified transaction."
},
"type": {
"description": "Type of American Express program.",
"enum": [
"optBlue"
],
"type": "string"
}
},
"required": [
"type",
"qualifiedRate",
"midQualRate",
"nonQualRate"
],
"title": "optBlue",
"type": "object"
},
"ref_5c51a0e852c4baa940d0": {
"description": "Currency of the transaction. The value for the currency follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard.",
"enum": [
"AED",
"AFN",
"ALL",
"AMD",
"ANG",
"AOA",
"ARS",
"AUD",
"AWG",
"AZN",
"BAM",
"BBD",
"BDT",
"BGN",
"BHD",
"BIF",
"BMD",
"BND",
"BOB",
"BOV",
"BRL",
"BSD",
"BTN",
"BWP",
"BYR",
"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",
"LTL",
"LVL",
"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",
"SLL",
"SOS",
"SRD",
"SSP",
"STD",
"STN",
"SVC",
"SYP",
"SZL",
"THB",
"TJS",
"TMT",
"TND",
"TOP",
"TRY",
"TTD",
"TWD",
"TZS",
"UAH",
"UGX",
"USD",
"USN",
"USS",
"UYI",
"UYU",
"UZS",
"VEF",
"VES",
"VND",
"VUV",
"WST",
"XAF",
"XCD",
"XOF",
"XPF",
"YER",
"ZAR",
"ZMW",
"ZWL"
],
"example": "USD",
"type": "string"
},
"ref_5ca0a24abea9be402684": {
"description": "Filter refunds by the operator who initiated the request.",
"examples": {
"example": {
"value": "Jane"
}
},
"in": "query",
"name": "operator",
"schema": {
"maxLength": 50,
"minLength": 1,
"type": "string"
}
},
"ref_5cbe2263a9f2282f6a63": {
"description": "Create a processing account with the Roc Giving Addendum appended to the Merchant Processing Agreement.",
"summary": "Create a processing account with Roc Giving Addendum",
"value": {
"addendums": [
{
"accountAdminContact": {
"emailAddress": "jane.doe@example.com",
"firstName": "Jane",
"lastName": "Doe",
"phone": "2025550164"
},
"autoCloseTime": "23:40",
"donorSupportPercentage": 2.5,
"plan": "basic",
"type": "rocGivingV1"
}
],
"address": {
"address1": "1 Example Ave.",
"address2": "Example Address Line 2",
"address3": "Example Address Line 3",
"city": "Chicago",
"country": "US",
"postalCode": "60056",
"state": "Illinois"
},
"businessStartDate": "2020-01-01",
"businessType": "restaurant",
"categoryCode": 5999,
"contactMethods": [
{
"type": "email",
"value": "jane.doe@example.com"
}
],
"contacts": [
{
"contactId": 1543,
"firstName": "Jane",
"lastName": "Doe",
"link": {
"href": "https://api.payroc.com/v1/contacts/1543",
"method": "get",
"rel": "contact"
}
}
],
"createdDate": "2024-07-02T12:00:00.000Z",
"doingBusinessAs": "Pizza Doe",
"funding": {
"acceleratedFundingFee": 1999,
"dailyDiscount": false,
"fundingAccounts": [
{
"fundingAccountId": 123,
"link": {
"href": "https://api.payroc.com/v1/funding-accounts/123",
"method": "get",
"rel": "fundingAccount"
},
"status": "pending"
}
],
"fundingSchedule": "nextday",
"status": "enabled"
},
"lastModifiedDate": "2024-07-02T12:00:00.000Z",
"merchandiseOrServiceSold": "Pizza",
"metadata": {
"customerId": "2345"
},
"owners": [
{
"firstName": "Jane",
"lastName": "Doe",
"link": {
"href": "https://api.payroc.com/v1/owners/4564",
"method": "get",
"rel": "owner"
},
"ownerId": 4564
}
],
"pricing": {
"link": {
"href": "https://api.payroc.com/v1/processing-accounts/38766/pricing",
"method": "get",
"rel": "pricing"
}
},
"processing": {
"monthlyAmounts": {
"average": 3000,
"highest": 100000
},
"transactionAmounts": {
"average": 4500,
"highest": 50000
},
"volumeBreakdown": {
"cardPresent": 80,
"ecommerce": 0,
"mailOrTelephone": 20
}
},
"processingAccountId": "38766",
"processor": "tsys",
"signature": {
"link": {
"href": "https://us.agreementexpress.net/mv2/viewer2.jsp?docId=00000000-0000-0000-0000-000000000000",
"method": "get",
"rel": "agreement"
},
"type": "requestedViaDirectLink"
},
"status": "entered",
"timezone": "America/Chicago",
"website": "www.example.com"
}
},
"ref_5cf3c12be298a11145b9": {
"description": "Object that contains the fees for wireless processing.",
"properties": {
"fees": {
"properties": {
"monthlyAccess": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_109fe7e5f018de7ee04b"
}
],
"description": "Monthly network access fee for Wireless Processing. The value is in the currency's lowest denomination, for example, cents."
},
"setup": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_109fe7e5f018de7ee04b"
}
],
"description": "Setup fee for Wireless Processing. The value is in the currency's lowest denomination, for example, cents."
}
},
"required": [
"setup",
"monthlyAccess"
]
},
"name": {
"description": "Name of the service.",
"enum": [
"wirelessProcessing"
],
"example": "wirelessProcessing",
"type": "string"
}
},
"required": [
"name",
"fees"
],
"type": "object"
},
"ref_5e268a344618d438f814": {
"description": "Refund Payment",
"summary": "Refund Payment",
"value": {
"card": {
"cardNumber": "453985******7062",
"entryMethod": "keyed",
"expiryDate": "1230",
"securityChecks": {
"avsResult": "Y",
"cvvResult": "M"
},
"type": "MasterCard"
},
"customFields": [
{
"name": "yourCustomField",
"value": "acb123"
}
],
"customer": {
"billingAddress": {
"address1": "1 Example Ave.",
"address2": "Example Address Line 2",
"address3": "Example Address Line 3",
"city": "Chicago",
"country": "US",
"postalCode": "60056",
"state": "Illinois"
},
"firstName": "Sarah",
"lastName": "Hopper",
"shippingAddress": {
"address": {
"address1": "1 Example Ave.",
"address2": "Example Address Line 2",
"address3": "Example Address Line 3",
"city": "Chicago",
"country": "US",
"postalCode": "60056",
"state": "Illinois"
},
"recipientName": "Sarah Hopper"
}
},
"operator": "Jane",
"order": {
"amount": 4999,
"currency": "USD",
"dateTime": "2024-07-02T15:30:00Z",
"description": "Large Pepperoni Pizza",
"orderId": "OrderRef6543"
},
"paymentId": "M2MJOG6O2Y",
"processingTerminalId": "1234001",
"refunds": [
{
"amount": -4999,
"currency": "USD",
"dateTime": "2024-07-02T15:30:00Z",
"link": {
"href": "https://api.payroc.com/v1/refunds/BI77XQFQ05",
"method": "GET",
"rel": "self"
},
"refundId": "CD3HN88U9F",
"responseCode": "A",
"responseMessage": "Transaction refunded",
"status": "ready"
}
],
"supportedOperations": [
"refund"
],
"transactionResult": {
"approvalCode": "OK3",
"authorizedAmount": 4999,
"currency": "USD",
"responseCode": "A",
"responseMessage": "OK13",
"status": "complete",
"type": "sale"
}
}
},
"ref_5e3029a3ef34877c347f": {
"description": "Filter event subscriptions by subscription status.",
"examples": {
"example": {
"value": "registered"
}
},
"in": "query",
"name": "status",
"schema": {
"enum": [
"registered",
"suspended",
"failed"
],
"type": "string"
}
},
"ref_5e8c60d58d02042ee191": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_f9d963d00740bbe00c9e"
},
{
"properties": {
"data": {
"description": "Array of eventSubscription objects.",
"items": {
"$ref": "#/x-devx-bundled/ref_4b7a26467bd32e0d5fa8"
},
"type": "array"
}
},
"type": "object"
}
],
"title": "paginated event subscriptions",
"type": "object"
},
"ref_5ea9b5245b40a95eeedc": {
"description": "Filter payments by the last four digits of the card number that the customer used in the transaction.",
"examples": {
"example": {
"value": "7062"
}
},
"in": "query",
"name": "last4",
"schema": {
"pattern": "[0-9]{4}",
"type": "string"
}
},
"ref_5ef41b0d7789b150c540": {
"properties": {
"business": {
"$ref": "#/x-devx-bundled/ref_b96bfccc904b67e0050e"
},
"createdDate": {
"description": "Date that the merchant platform was created. We return this value in the [ISO-8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
"example": "2024-07-02T12:00:00.000+00:00",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"lastModifiedDate": {
"description": "Date that the merchant platform was last modified. We return this value in the [ISO-8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
"example": "2024-07-02T12:00:00.000+00:00",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"links": {
"description": "Array of useful links related to your request.",
"items": {
"$ref": "#/x-devx-bundled/ref_27e6d0e095fb23cba669"
},
"readOnly": true,
"type": "array"
},
"merchantPlatformId": {
"description": "Unique identifier that we assigned to the merchant platform.",
"example": "12345",
"readOnly": true,
"type": "string"
},
"metadata": {
"additionalProperties": {
"type": "string"
},
"description": "Object that you can send to include custom metadata in the request.",
"example": {
"customerId": "2345"
},
"type": "object"
},
"processingAccounts": {
"description": "Array of processingAccount objects.",
"items": {
"properties": {
"addendums": {
"description": "The addendum types that were accepted and appended to the Merchant Processing Agreement for this processing account. Returns an empty array when no addendums were requested.",
"items": {
"$ref": "#/x-devx-bundled/ref_80b2e9c15cc43d211038"
},
"readOnly": true,
"type": "array"
},
"doingBusinessAs": {
"description": "Trading name of the business.",
"example": "Pizza Doe",
"type": "string"
},
"link": {
"description": "Object that contains HATEOAS links for the processing account.",
"properties": {
"href": {
"description": "Link to the resource.",
"example": "https://api.payroc.com/v1/processing-accounts/38765",
"type": "string"
},
"method": {
"description": "HTTP method you can use to retrieve the resource.",
"example": "get",
"type": "string"
},
"rel": {
"description": "Relationship to the parent resource.",
"example": "processingAccount",
"type": "string"
}
},
"type": "object"
},
"processingAccountId": {
"description": "Unique identifier that we assigned to the processing account.",
"example": "38765",
"type": "string"
},
"processor": {
"$ref": "#/x-devx-bundled/ref_173edad0bb113303f045"
},
"signature": {
"$ref": "#/x-devx-bundled/ref_14920c978ef4664c1ec1"
},
"status": {
"description": "Status of the processing account.\n- `entered` - We have received information about the account, but we have not yet reviewed it. \n- `pending` - We have reviewed the information about the account, but we have not yet approved it. \n- `approved` - We have approved the account for processing transactions and funding. \n- `subjectTo` - We have approved the account, but we are waiting on further information. \n- `dormant` - Account is closed for a period. \n- `nonProcessing` - We have approved the account, but the merchant has not yet run a transaction. \n- `rejected` - We rejected the application for the processing account. \n- `terminated` - Processing account is closed. \n- `cancelled` - Merchant withdrew the application for the processing account.\n- `failed` - An error occurred while we were setting up the processing account. \n\n**Note**: You can subscribe to our processingAccount.status.changed event to get notifications when we change the status of a processing account. For more information about how to subscribe to events, go to [Event Subscriptions](https://docs.payroc.com/guides/board-merchants/event-subscriptions).\n",
"enum": [
"entered",
"pending",
"approved",
"subjectTo",
"dormant",
"nonProcessing",
"rejected",
"terminated",
"cancelled",
"failed"
],
"example": "entered",
"readOnly": true,
"type": "string"
}
},
"required": [
"doingBusinessAs",
"processor",
"addendums",
"status"
],
"title": "processingAccount",
"type": "object"
},
"readOnly": true,
"type": "array"
}
},
"required": [
"business",
"processingAccounts"
],
"title": "merchant",
"type": "object"
},
"ref_5f670ac0be2d47f8a490": {
"description": "Add operation adds a new value to an object or array.",
"summary": "Update payment plan: add",
"value": [
{
"op": "add",
"path": "/customFieldNames/-",
"value": "loyaltyPoints"
}
]
},
"ref_60a40c9edfc460ad1dab": {
"description": "Unique identifier of the attachment.",
"example": "12876",
"in": "path",
"name": "attachmentId",
"required": true,
"schema": {
"type": "string"
}
},
"ref_60b8f9f9f668e3f361c4": {
"description": "Polymorphic object that contains pricing information for the processing account. \n\nThe value of the type parameter determines which variant you should use:\n-\t`intent` - Use a pricing agreement template.\n-\t`agreement` - Create a new pricing agreement.\n",
"discriminator": {
"mapping": {
"agreement": "#/components/schemas/pricingAgreement",
"intent": "#/components/schemas/pricingTemplate"
},
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/x-devx-bundled/ref_dba34ab7c46527b180dd"
},
{
"$ref": "#/x-devx-bundled/ref_eac6050eb1e4dbb01198"
}
],
"type": "object"
},
"ref_61195d3ba563471558fa": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_31d3b813b1b175136a5f"
},
{
"properties": {
"surcharge": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_d77d570c70a1a1c56a40"
}
],
"description": "Object that contains information about the [surcharge](https://docs.payroc.com/knowledge/card-payments/credit-card-surcharging) that we applied to the transaction."
},
"taxes": {
"description": "Array of tax objects.",
"items": {
"$ref": "#/x-devx-bundled/ref_ff9e53b467436d074a75"
},
"type": "array"
}
},
"type": "object"
}
],
"description": "Object that contains information about the surcharge and taxes that apply to the transaction.\n",
"required": [
"subtotal"
],
"type": "object"
},
"ref_6152e7b2e2079c927267": {
"description": "Object that contains information about the keyed card details.",
"properties": {
"cardholderName": {
"description": "Cardholder’s name.",
"example": "Sarah Hazel Hopper",
"maxLength": 50,
"minLength": 1,
"type": "string"
},
"cardholderSignature": {
"description": "Cardholder's signature. For more information about how to format the signature, go to [How to send a signature to our gateway](https://docs.payroc.com/knowledge/basic-concepts/signature-capture).",
"example": "a1b1c012345678a000b000c0012345d0e0f010g10061a031i001j071k0a1b0c1d0e1234567890120f1g0h1i0j1k0a1b0123451c012d0e1f0g1h0i1j123k1a1b1c1d1e1f1g123h1i1j1k1a1b1c1d1e1f1g123h123i1j123k12340a120a12345b012c0123012d0d1e0f1g0h1i123j123k10000",
"type": "string"
},
"ebtDetails": {
"$ref": "#/x-devx-bundled/ref_e4a086f8d857fd3e3dd3"
},
"entryMethod": {
"description": "Method that the terminal used to capture the card details.",
"enum": [
"keyed"
],
"example": "keyed",
"type": "string"
},
"keyedData": {
"description": "Polymorphic object that contains payment card details that the merchant manually entered into the device. \n\nThe value of the dataFormat parameter determines which variant you should use: \n-\t`fullyEncrypted` - All payment card details are encrypted.\n-\t`partiallyEncrypted` - Some payment card details are encrypted.\n-\t`plainText` - Payment card details are in plain text.\n",
"discriminator": {
"mapping": {
"fullyEncrypted": "#/components/schemas/fullyEncryptedKeyedDataFormat",
"partiallyEncrypted": "#/components/schemas/partiallyEncryptedKeyedDataFormat",
"plainText": "#/components/schemas/plainTextKeyedDataFormat"
},
"propertyName": "dataFormat"
},
"oneOf": [
{
"$ref": "#/x-devx-bundled/ref_32724c841d41813a03f6"
},
{
"$ref": "#/x-devx-bundled/ref_76fdde248e56e2b06a7c"
},
{
"$ref": "#/x-devx-bundled/ref_305dbe8e7f7fb88c4ebf"
}
],
"type": "object"
},
"pinDetails": {
"description": "Polymorphic object that contains information about the customer's PIN.",
"discriminator": {
"mapping": {
"dukpt": "./pin-v1.yaml#/components/schemas/dukptPinDetails"
},
"propertyName": "dataFormat"
},
"oneOf": [
{
"$ref": "#/x-devx-bundled/ref_5211ee5be47c335f4b2e"
}
],
"type": "object"
}
},
"required": [
"entryMethod",
"keyedData"
],
"title": "keyed",
"type": "object"
},
"ref_616651e4cab06fc31947": {
"description": "Successful response. We created the pricing intent and it is waiting for approval.",
"summary": "Created pricing intent",
"value": {
"base": {
"addressVerification": 5,
"annualFee": {
"amount": 100,
"billInMonth": "june"
},
"batch": 1000,
"chargeback": 2500,
"earlyTermination": 57500,
"maintenance": 500,
"minimum": 100,
"pciNonCompliance": 4995,
"platinumSecurity": {
"amount": 1295,
"billingFrequency": "monthly"
},
"regulatoryAssistanceProgram": 15,
"retrieval": 1500,
"voiceAuthorization": 95
},
"country": "US",
"createdDate": "2024-07-02T09:00:00Z",
"gateway": {
"fees": {
"monthly": 2000,
"perDeviceMonthly": 10,
"perTransaction": 2000,
"setup": 5000
}
},
"id": "5",
"key": "Your-Unique-Identifier",
"lastUpdatedDate": "2024-07-02T09:00:00Z",
"metadata": {
"yourCustomField": "abc123"
},
"processor": {
"ach": {
"fees": {
"accountVerification": 100,
"batch": 1000,
"discountRateAbove10000": 10,
"discountRateUnder10000": 5.25,
"monthlyMinimum": 20000,
"returns": 400,
"statement": 800,
"transaction": 50,
"unauthorizedReturn": 1999
}
},
"card": {
"fees": {
"amex": {
"transaction": 5,
"type": "optBlue",
"volume": 1.25
},
"electronicBenefitsTransfer": {
"transaction": 10
},
"mastercardVisaDiscover": {
"transaction": 5,
"volume": 1.25
},
"pinDebit": {
"additionalDiscount": 1.25,
"monthlyAccess": 1200,
"transaction": 10
},
"specialityCards": {
"transaction": 10
}
},
"planType": "interchangePlus"
}
},
"services": [
{
"enabled": true,
"name": "hardwareAdvantagePlan"
}
],
"status": "pendingReview",
"version": "5.2"
}
},
"ref_618d306001605c811547": {
"description": "Object that contains the details of the payment that the merchant wants to refund.",
"properties": {
"amount": {
"description": "Amount of the payment that the merchant wants to refund. The value is in the currency’s lowest denomination, for example, cents.",
"example": 4999,
"format": "int64",
"type": "integer"
},
"description": {
"description": "Reason for the refund.",
"example": "Customer requested a refund due to a wrong order.",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"operator": {
"description": "Operator who refunded the payment.",
"example": "Jane",
"maxLength": 50,
"minLength": 0,
"type": "string"
}
},
"required": [
"amount",
"description"
],
"type": "object"
},
"ref_62193920a3f6b209f7e3": {
"description": "Status of the settlement.",
"examples": {
"example": {
"value": "settled"
}
},
"in": "query",
"name": "settlementState",
"schema": {
"enum": [
"settled",
"unsettled"
],
"type": "string"
}
},
"ref_622c8816a3233c2ac472": {
"description": "Object that contains information about a healthcare expense.",
"properties": {
"amount": {
"description": "Amount of the healthcare expense. The value is in the currency's lowest denomination, for example, cents.",
"example": 190,
"exclusiveMinimum": 0,
"format": "int64",
"type": "integer"
},
"type": {
"description": "Type of healthcare expense.",
"enum": [
"copay",
"clinic",
"dental",
"prescription",
"transit",
"vision"
],
"example": "dental",
"type": "string"
}
},
"required": [
"type",
"amount"
],
"type": "object"
},
"ref_62daed56a1e56021e904": {
"description": "List of contacts associated with a processing account.",
"summary": "Paginated list of processing account contacts",
"value": {
"count": 2,
"data": [
{
"contactId": 1543,
"contactMethods": [
{
"type": "phone",
"value": "2025550164"
},
{
"type": "mobile",
"value": "8445557624"
},
{
"type": "email",
"value": "jane.doe@example.com"
}
],
"firstName": "Jane",
"identifiers": [
{
"type": "nationalId",
"value": "xxxxx4320"
}
],
"lastName": "Doe",
"middleName": "Helen",
"type": "manager"
},
{
"contactId": 87926,
"contactMethods": [
{
"type": "phone",
"value": "2025550110"
},
{
"type": "mobile",
"value": "85655587451"
},
{
"type": "email",
"value": "fred.nerk@example.com"
}
],
"firstName": "Fred",
"identifiers": [
{
"type": "nationalId",
"value": "xxxxx9876"
}
],
"lastName": "Nerk",
"middleName": "Jim",
"type": "representative"
}
],
"hasMore": true,
"limit": 2,
"links": [
{
"href": "https://api.payroc.com/v1/processing-accounts/38765/contacts?before=1543&limit=2",
"method": "get",
"rel": "previous"
},
{
"href": "https://api.payroc.com/v1/processing-accounts/38765/contacts?after=87926&limit=2",
"method": "get",
"rel": "next"
}
]
}
},
"ref_632a507d8d5dbb2e493d": {
"description": "Create a funding instruction to distribute merchant funds to funding accounts.",
"summary": "Funding instruction with metadata",
"value": {
"merchants": [
{
"merchantId": "4525644354",
"recipients": [
{
"amount": {
"currency": "USD",
"value": 120000
},
"fundingAccountId": 123,
"metadata": {
"supplier": "IT Support Services"
},
"paymentMethod": "ACH"
}
]
}
],
"metadata": {
"instructionCreatedBy": "Jane Doe"
}
}
},
"ref_6390b31795ee298ddaec": {
"description": "Object that contains information about the customer and their shipping address.\n\nContains parameters required for [Level 3 and CEDP transactions](https://docs.payroc.com/knowledge/card-payments/enhanced-data).\n",
"properties": {
"address": {
"$ref": "#/x-devx-bundled/ref_51baeef3d490d18ab4d6",
"description": "Object that contains information about the shipping address.\n\nRequired for [Level 3 and CEDP transactions](https://docs.payroc.com/knowledge/card-payments/enhanced-data).\n"
},
"recipientName": {
"description": "Recipient's name.\n\nRequired for [Level 3 and CEDP transactions](https://docs.payroc.com/knowledge/card-payments/enhanced-data).\n",
"example": "Sarah Hopper",
"maxLength": 50,
"minLength": 0,
"type": "string"
}
},
"type": "object"
},
"ref_63c2d7145a59d4c533c3": {
"description": "Unable to process your request.",
"summary": "Api error",
"value": {
"detail": "We are unable to process your request at this time",
"errors": [
{
"message": "Service offline"
}
],
"status": 500,
"title": "Api error",
"type": "https://docs.payroc.com/api/errors#api-error"
}
},
"ref_63e6cefc99bb7df80593": {
"description": "Indicates the timezone within which transactions will be processed for this terminal",
"enum": [
"Pacific/Midway",
"Pacific/Honolulu",
"America/Anchorage",
"America/Los_Angeles",
"America/Denver",
"America/Phoenix",
"America/Chicago",
"America/Indiana/Indianapolis",
"America/New_York"
],
"example": "America/Chicago",
"maxLength": 28,
"type": "string"
},
"ref_64292eb5f67cff8b9a88": {
"properties": {
"fundingAccountId": {
"description": "Unique identifier that we assigned to the funding account.",
"example": 123,
"readOnly": true,
"type": "integer"
},
"link": {
"$ref": "#/x-devx-bundled/ref_27e6d0e095fb23cba669",
"description": "Object that contains HATEOAS links for the funding accounts that are linked to the processing account.",
"readOnly": true
},
"status": {
"description": "Status of the funding account.",
"enum": [
"approved",
"rejected",
"pending"
],
"example": "pending",
"readOnly": true,
"type": "string"
}
},
"title": "funding account summary",
"type": "object"
},
"ref_643be9b90eb060b3174b": {
"properties": {
"status": {
"description": "Status of the payment intent. The value is one of the following: \n- `pendingPayment` - We haven't received payment for the terminal order. \n- `pendingCancellation` - We haven't received payment for the terminal order, and we are going to cancel the terminal order unless we receive payment. \n- `successful` - We received payment for the terminal order. \n- `unsuccessful` - We attempted to take payment for a terminal order, but it was unsuccessful. \n- `cancelled` - We have canceled the terminal order as we didn't receive payment. \n\n**Note**: To receive notifications if we change the status of a payment intent, subscribe to our paymentIntent.status.changed event. For more information about how to subscribe to events, go to [Event Subscriptions](https://docs.payroc.com/guides/integrate/event-subscriptions).\n",
"enum": [
"pendingPayment",
"pendingCancellation",
"successful",
"unsuccessful",
"cancelled"
],
"example": "pendingPayment",
"maxLength": 19,
"type": "string"
}
},
"required": [
"status"
],
"type": "object"
},
"ref_64549aab9b1ce6e9af13": {
"description": "Partially update an existing pricing intent.\n\nStructure your request to follow the RFC 6902 standard.\n",
"summary": "Partially update pricing intent",
"value": [
{
"op": "replace",
"path": "/processor/card/fees/mastercardVisaDiscover/volume",
"value": 1.5
},
{
"op": "replace",
"path": "/gateway/fees/additionalServiceMonthly",
"value": 16
},
{
"op": "replace",
"path": "/base/addressVerification",
"value": 6
}
]
},
"ref_645d48ac4453f76791af": {
"description": "An example Device Configuration response",
"summary": "Device Configuration",
"value": {
"applications": [
{
"card": "VISA",
"identifier": "A0000000031010",
"matchType": "partialVisa",
"version": "0096"
},
{
"card": "MASTERCARD",
"identifier": "A0000000041010",
"matchType": "partialEuropay",
"version": "0002"
}
],
"certificates": [
{
"certificate": "ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234A",
"exponent": "03",
"rid": "A000000003"
}
],
"manufacturer": "idtech",
"model": "idtechKioskV",
"revokedCertificates": [
{
"certificate": "ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234A",
"exponent": "02",
"rid": "A000000004"
}
],
"supportsAttended": false,
"supportsContactless": true,
"supportsIcc": true,
"supportsKeyed": false,
"supportsMagStripe": true,
"supportsOutputDisplaying": false,
"supportsOutputPrinting": false,
"supportsPinEntry": false,
"supportsUnattended": true,
"visualAssets": [
{
"scope": "logo",
"type": "image",
"url": "https://www.example.com/logo.png"
},
{
"scope": "idleScreen",
"type": "image",
"url": "https://www.example.com/idle-screen.png"
}
]
}
},
"ref_6529a021f62f98e435d3": {
"default": "partner",
"description": "Indicates who provides training to the merchant for the solution.",
"enum": [
"partner",
"payroc"
],
"maxLength": 7,
"type": "string"
},
"ref_6543d0b0fbcfb8aa2a4d": {
"description": "Reverse Bank Transfer Payment",
"summary": "Reverse Bank Transfer Payment",
"value": {
"bankAccount": {
"accountNumber": "*******7890",
"institutionNumber": "543",
"nameOnAccount": "Sarah Hazel Hopper",
"transitNumber": "76543",
"type": "pad"
},
"customFields": [
{
"name": "yourCustomField",
"value": "abc123"
}
],
"customer": {
"contactMethods": [
{
"type": "email",
"value": "sarah.hopper@example.com"
}
],
"notificationLanguage": "en"
},
"order": {
"amount": 4999,
"breakdown": {
"subtotal": 4347,
"taxes": [
{
"amount": 217,
"name": "VAT",
"rate": 5
}
],
"tip": {
"percentage": 10,
"type": "percentage"
}
},
"currency": "USD",
"dateTime": "2024-07-02T15:30:00Z",
"description": "Large Pepperoni Pizza",
"orderId": "OrderRef6543"
},
"paymentId": "M2MJOG6O2Y",
"processingTerminalId": "1234001",
"transactionResult": {
"authorizedAmount": 4999,
"currency": "USD",
"responseCode": "A",
"status": "reversal",
"type": "payment"
}
}
},
"ref_65dae029e49a7e458791": {
"description": "Object that contains the details of the payment that the merchant wants to capture.",
"properties": {
"amount": {
"description": "Amount that the merchant wants to capture. The value is in the currency's lowest denomination, for example, cents. \n**Note:** If the merchant does not send an amount, we capture the total amount of the transaction.\n",
"example": 4999,
"format": "int64",
"type": "integer"
},
"breakdown": {
"$ref": "#/x-devx-bundled/ref_049dcd8f29853ec0de7d"
},
"operator": {
"description": "Operator who captured the payment.",
"example": "Jane",
"maxLength": 50,
"minLength": 0,
"type": "string"
},
"processingTerminalId": {
"description": "Unique identifier that our gateway assigned to the terminal.",
"maxLength": 50,
"minLength": 4,
"type": "string"
}
},
"type": "object"
},
"ref_67037bfcf97d8dcb9e3c": {
"description": "Make changes to an existing payment plan.\n\nStructure your request to follow the [RFC 6902](https://datatracker.ietf.org/doc/html/rfc6902) standard.\n",
"summary": "Update payment plan",
"value": [
{
"op": "replace",
"path": "/currency",
"value": "USD"
},
{
"op": "replace",
"path": "/setupOrder/amount",
"value": 2999
},
{
"op": "replace",
"path": "/frequency",
"value": "yearly"
}
]
},
"ref_671d522a51c56d5d73b9": {
"description": "Pricing intent",
"summary": "Pricing intent",
"value": {
"base": {
"addressVerification": 5,
"annualFee": {
"amount": 100,
"billInMonth": "june"
},
"batch": 1000,
"chargeback": 2500,
"earlyTermination": 57500,
"maintenance": 500,
"minimum": 100,
"pciNonCompliance": 4995,
"platinumSecurity": {
"amount": 1295,
"billingFrequency": "monthly"
},
"regulatoryAssistanceProgram": 15,
"retrieval": 1500,
"voiceAuthorization": 95
},
"country": "US",
"createdDate": "2024-07-02T09:00:00Z",
"gateway": {
"fees": {
"monthly": 1000,
"perDeviceMonthly": 0,
"perTransaction": 0,
"setup": 25000
}
},
"id": "5",
"key": "string",
"lastUpdatedDate": "2024-07-02T09:00:00Z",
"metadata": {
"yourCustomField": "abc123"
},
"processor": {
"ach": {
"fees": {
"accountVerification": 100,
"batch": 1000,
"discountRateAbove10000": 10,
"discountRateUnder10000": 5.25,
"monthlyMinimum": 20000,
"returns": 400,
"statement": 800,
"transaction": 50,
"unauthorizedReturn": 1999
}
},
"card": {
"fees": {
"amex": {
"transaction": 10,
"type": "optBlue",
"volume": 1.25
},
"electronicBenefitsTransfer": {
"transaction": 10
},
"mastercardVisaDiscover": {
"transaction": 5,
"volume": 1.25
},
"pinDebit": {
"additionalDiscount": 1.25,
"monthlyAccess": 1200,
"transaction": 10
},
"specialityCards": {
"transaction": 10
}
},
"planType": "interchangePlus"
}
},
"services": [
{
"enabled": true,
"name": "hardwareAdvantagePlan"
}
],
"status": "pendingReview",
"version": "5.2"
}
},
"ref_67c77db80e4fded0ad81": {
"description": "Object that contains information about the merchant.",
"example": {
"doingBusinessAs": "Pizza Doe",
"link": {
"href": "https://api.payroc.com/v1/processing-accounts/38765",
"method": "get",
"rel": "processingAccount"
},
"merchantId": "4525644354",
"processingAccountId": 38765
},
"properties": {
"doingBusinessAs": {
"description": "Trading name of the business.",
"example": "Pizza Doe",
"type": "string"
},
"link": {
"$ref": "#/x-devx-bundled/ref_27e6d0e095fb23cba669"
},
"merchantId": {
"description": "Unique identifier that the processor assigned to the merchant.",
"example": "4525644354",
"type": "string"
},
"processingAccountId": {
"description": "Unique identifier that we assigned to the processing account.",
"example": 38765,
"type": "integer"
}
},
"title": "merchant summary",
"type": "object"
},
"ref_6815ca44ec34bb6198b0": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_a38a839aab4628df3f20"
},
{
"properties": {
"breakdown": {
"$ref": "#/x-devx-bundled/ref_0331fceeaf098c1c9e92"
}
},
"type": "object"
}
],
"description": "Object that contains information about the cost of each payment. \n**Note:** Send this object only if the value for **type** is `automatic`.\n",
"type": "object"
},
"ref_683a00d6631f2fb3d0fc": {
"description": "Make changes to a subscription.\n\nStructure your request to follow the [RFC 6902](https://datatracker.ietf.org/doc/html/rfc6902) standard.\n",
"summary": "Update subscription",
"value": [
{
"op": "replace",
"path": "/setupOrder/amount",
"value": 2999
},
{
"op": "replace",
"path": "/recurringOrder/amount",
"value": 2999
},
{
"op": "replace",
"path": "/frequency",
"value": "yearly"
}
]
},
"ref_6856721f35e105390b4f": {
"description": "Object that contains information about the card.",
"properties": {
"avsRequest": {
"description": "Indicates whether the merchant used the Address Verification Service (AVS) to verify the cardholder's address.",
"type": "boolean"
},
"avsResponse": {
"description": "Response from the Address Verification Service (AVS).",
"type": "string"
},
"cardNumber": {
"description": "Masked card number. Our gateway shows only the first six digits and the last four digits of the card number, for example, `500165******0000`.",
"example": "453985******7062",
"type": "string"
},
"cvvPresenceIndicator": {
"description": "Indicates whether the cardholder provided the Card Verification Value (CVV).",
"type": "boolean"
},
"type": {
"description": "Card type, for example, Visa. \n\n**Note:** If we can’t match a dispute to a transaction, we don’t return a type object. \n",
"enum": [
"visa",
"masterCard",
"discover",
"debit",
"ebt",
"wrightExpress",
"voyager",
"amex",
"privateLabel",
"storedValue",
"discoverRetained",
"jcbNonSettled",
"dinersClub",
"amexOptBlue",
"fuelman",
"unknown"
],
"type": [
"string",
"null"
]
}
},
"title": "card summary",
"type": "object"
},
"ref_68be72132e3ddb55341d": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_77d38980c21a16856c11"
},
{
"properties": {
"fundingAccounts": {
"description": "Object that contains funding accounts associated with the processing account.",
"items": {
"$ref": "#/x-devx-bundled/ref_64292eb5f67cff8b9a88"
},
"maxItems": 2,
"minItems": 1,
"readOnly": true,
"type": "array"
}
},
"type": "object"
}
],
"description": "Object that contains funding information for the processing account, including funding schedules, funding fees, and details of funding accounts.",
"type": "object"
},
"ref_68cb5c4588a1d2dd977a": {
"properties": {
"appleDomainId": {
"description": "Unique appleDomainId of the merchant's domain that we assigned when you added their domain to our Self-Care Portal.",
"example": "DUHDZJHGYY",
"type": "string"
},
"appleValidationUrl": {
"description": "Validation URL from the Apple Pay JS API.",
"example": "https://apple-pay-gateway.apple.com/paymentservices/startSession",
"type": "string"
}
},
"required": [
"appleDomainId",
"appleValidationUrl"
],
"type": "object"
},
"ref_68f95191b4389dc629cb": {
"description": "Object that contains information about the transaction response details.",
"properties": {
"approvalCode": {
"description": "Authorization code that the processor assigned to the transaction.",
"example": "OK3",
"maxLength": 48,
"minLength": 1,
"type": "string"
},
"authorizedAmount": {
"description": "Amount that the processor authorized for the transaction. This value is in the currency’s lowest denomination, for example, cents. \n\n**Notes:** \n- For partial authorizations, this amount is lower than the amount in the request.\n- If the value for **authorizedAmount** is negative, this indicates that the merchant sent funds to the customer.\n",
"example": 4999,
"format": "int64",
"type": "integer"
},
"cardSchemeReferenceId": {
"description": "Identifier that the card brand assigns to the payment instruction.",
"example": "ABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890",
"maxLength": 64,
"minLength": 1,
"type": "string"
},
"currency": {
"$ref": "#/x-devx-bundled/ref_5c51a0e852c4baa940d0"
},
"ebtType": {
"description": "Indicates the subtype of EBT in the transaction.",
"enum": [
"cashPurchase",
"cashPurchaseWithCashback",
"foodStampPurchase",
"foodStampVoucherPurchase",
"foodStampReturn",
"foodStampVoucherReturn",
"cashBalanceInquiry",
"foodStampBalanceInquiry",
"cashWithdrawal"
],
"example": "foodStampPurchase",
"type": "string"
},
"healthcareIndicator": {
"description": "Indicates if we processed the payment as a healthcare expense. The value is one of the following: \n- `Y` - We processed the payment as a healthcare expense. \n- `N` - We processed the payment but it didn't contain any healthcare expenses. \n- `C` - We processed the payment but the card isn't linked to a Flexible Spending Account (FSA) or a Health Savings Account (HSA). \n- `R` - We processed the payment but the card doesn't support healthcare expenses. \n",
"enum": [
"Y",
"N",
"C",
"R"
],
"example": "Y",
"type": "string"
},
"processorResponseCode": {
"description": "Original response code that the processor sent.",
"example": "00",
"type": "string"
},
"responseCode": {
"description": "Response from the processor. \n- `A` - The processor approved the transaction. \n- `D` - The processor declined the transaction. \n- `E` - The processor received the transaction but will process the transaction later. \n- `P` - The processor authorized a portion of the original amount of the transaction. \n- `R` - The issuer declined the transaction and indicated that the customer should contact their bank. \n- `C` - The issuer declined the transaction and indicated that the merchant should keep the card as it was reported lost or stolen.\n",
"enum": [
"A",
"D",
"E",
"P",
"R",
"C"
],
"example": "A",
"type": "string"
},
"responseMessage": {
"description": "Response description from the processor.",
"example": "OK3",
"maxLength": 48,
"minLength": 1,
"type": "string"
},
"status": {
"description": "Status of the transaction. The value is one of the following: \n- `ready` - Successful transaction. We added the payment to the open batch. \n- `pending` - Successful transaction. We added the payment to the open batch, but we don't collect the funds until the merchant [captures the transaction](https://docs.payroc.com/api/schema/card-payments/payments/capture).\n- `declined` - Unsuccessful transaction. The cardholder's issuing bank declined the transaction. \n- `complete` - Successful transaction. The funds have moved to the merchant's bank account. \n- `referral` - Unsuccessful transaction. The issuing bank identified an issue with the transaction. You should treat a `referral` status as a declined transaction. \n- `pickup` - Unsuccessful transaction. The issuing bank has reported that the card is lost or stolen. \n- `reversal` - Transaction canceled. The transaction was canceled, and we removed the transaction from the open batch. \n- `admin` - Transaction under review. We have flagged an issue with the transaction. \n- `expired` - Transaction expired. If a transaction stays in `pending` status for too long, it expires. \n- `accepted` - Transaction in progress. The transaction is in progress with the processor but we can't confirm the result yet. \n",
"enum": [
"ready",
"pending",
"declined",
"complete",
"referral",
"pickup",
"reversal",
"admin",
"expired",
"accepted"
],
"example": "ready",
"type": "string"
},
"type": {
"description": "Transaction type.",
"enum": [
"sale",
"refund",
"preAuthorization",
"preAuthorizationCompletion"
],
"example": "sale",
"type": "string"
}
},
"required": [
"status",
"responseCode"
],
"type": "object"
},
"ref_699821d417951d54b9d8": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_f3a5b8382be8e3b73da0"
},
{
"properties": {
"accountType": {
"description": "Indicates the customer's account type.\n",
"enum": [
"checking",
"savings"
],
"example": "checking",
"type": "string"
}
},
"type": "object"
}
]
},
"ref_69c528d104cc88086e40": {
"description": "Replace operation updates an existing value.",
"summary": "Update event subscription: replace",
"value": [
{
"op": "replace",
"path": "/enabled",
"value": true
}
]
},
"ref_69d0c405bed69b717603": {
"description": "Object that contains information about the dynamic currency conversion (DCC) offer. \n \nFor more information about DCC, go to [Dynamic Currency Conversion](https://docs.payroc.com/knowledge/card-payments/dynamic-currency-conversion).\n",
"properties": {
"accepted": {
"description": "Indicates if the cardholder accepted DCC offer.",
"example": true,
"type": "boolean",
"writeOnly": true
},
"fxAmount": {
"description": "Amount in the cardholder’s currency in the currency’s lowest denomination, for example, cents.",
"example": 3955,
"format": "int64",
"type": "integer"
},
"fxCurrency": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_5c51a0e852c4baa940d0"
}
],
"description": "Currency of the transaction in the card’s currency. The value for the currency follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard."
},
"fxCurrencyCode": {
"description": "Three-digit currency code for the card. This code follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard.",
"example": "CAD",
"maxLength": 3,
"minLength": 3,
"readOnly": true,
"type": "string"
},
"fxCurrencyExponent": {
"description": "Number of decimal places between the smallest currency unit and a whole currency unit. \n\nFor example, for GBP, the smallest currency unit is 1p and it is equal to £0.01. \nIf you use GBP, the value for **fxCurrencyExponent** is 2.\n",
"example": 2,
"format": "int32",
"readOnly": true,
"type": "integer"
},
"fxRate": {
"description": "Foreign exchange rate for the card's currency.",
"example": 1.37,
"format": "double",
"type": "number",
"x-fern-type-hint": "decimal"
},
"markup": {
"description": "Markup percentage rate that the DCC provider applies to the foreign exchange rate.",
"example": 3.5,
"format": "double",
"type": "number",
"x-fern-type-hint": "decimal"
},
"markupText": {
"description": "Supporting text for the markup rate.",
"example": "3.5% mark-up applied.",
"readOnly": true,
"type": "string"
},
"offerReference": {
"description": "Unique identifier of the DCC offer.",
"example": "DCC123456789",
"type": "string"
},
"provider": {
"description": "Name of the DCC provider.",
"example": "DCC Provider Inc.",
"readOnly": true,
"type": "string"
},
"source": {
"description": "Source that the DCC provider used to get the foreign exchange rates.",
"example": "European Central Bank",
"readOnly": true,
"type": "string"
}
},
"required": [
"fxAmount",
"fxCurrency",
"fxRate",
"markup"
],
"type": "object"
},
"ref_69f1460a68f2f59d262a": {
"description": "Object that contains information about the dispute.",
"properties": {
"authorizationCode": {
"description": "Authorization code of the transaction that the dispute is linked to.",
"type": "string"
},
"card": {
"$ref": "#/x-devx-bundled/ref_6856721f35e105390b4f"
},
"createdDate": {
"description": "Date that we received the dispute. The format of this value is **YYYY-MM-DD**.",
"example": "2024-02-20",
"format": "date",
"type": "string"
},
"currency": {
"description": "Currency of the transaction that the dispute is linked to. The value for the currency follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard.",
"type": "string"
},
"currentStatus": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_0e07938f865866b952e7"
},
{
"properties": {
"link": {
"$ref": "#/x-devx-bundled/ref_27e6d0e095fb23cba669"
}
},
"type": "object"
}
],
"description": "Object that contains information about the current status of the dispute."
},
"description": {
"description": "Description of the dispute.",
"type": "string"
},
"disputeAmount": {
"description": "Dispute amount. We return the value in the currency's lowest denomination, for example, cents.",
"format": "int64",
"type": "integer"
},
"disputeId": {
"description": "Unique identifier that we assigned to the dispute.",
"example": 12345,
"type": "integer"
},
"disputeType": {
"description": "Type of dispute.",
"enum": [
"prearbitration",
"issuerReversal",
"firstDisputeWithReversal",
"firstDispute"
],
"type": "string"
},
"feeAmount": {
"description": "Value of the fees for the dispute. We return the value in the currency's lowest denomination, for example, cents.",
"format": "int64",
"type": "integer"
},
"firstDispute": {
"description": "Indicates if this is the first dispute for the transaction.",
"example": true,
"type": "boolean"
},
"lastModifiedDate": {
"description": "Date that the dispute was last changed. The format of this value is **YYYY-MM-DD**.",
"example": "2024-02-25",
"format": "date",
"type": "string"
},
"merchant": {
"$ref": "#/x-devx-bundled/ref_67c77db80e4fded0ad81"
},
"receivedDate": {
"description": "Date that the acquiring bank received the dispute. The format of this value is **YYYY-MM-DD**.",
"example": "2024-02-18",
"format": "date",
"type": "string"
},
"referenceNumber": {
"description": "Reference number from the acquiring bank.",
"type": "string"
},
"transaction": {
"$ref": "#/x-devx-bundled/ref_7507ed0fd8805671d1aa"
}
},
"title": "dispute",
"type": "object"
},
"ref_6a8d98cf489862e020dc": {
"properties": {
"expiresAt": {
"description": "Date and time that the token expires. We return this value in the [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
"example": "2025-07-02T15:30:00.123456789+02:00",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"processingTerminalId": {
"description": "Unique identifier that we assigned to the terminal.",
"type": "string"
},
"token": {
"description": "Token that our gateway assigned to the Hosted Fields session. \n\nInclude this session token in the config file for Hosted Fields. \n\nThe session token expires after 10 minutes.\n",
"example": "abcdef1234567890abcdef1234567890",
"type": "string"
}
},
"required": [
"processingTerminalId",
"token",
"expiresAt"
],
"type": "object"
},
"ref_6acf0a083a03589f9afe": {
"description": "Format: `YYYY-MM-DD` \nFilter subscriptions that end on a specific date.\n",
"examples": {
"example": {
"value": "2025-07-01"
}
},
"in": "query",
"name": "endDate",
"schema": {
"format": "date",
"type": "string"
}
},
"ref_6ad2ac0964a4eb2dc24b": {
"description": "Unique identifier that we assigned to the batch.",
"examples": {
"example": {
"value": 12345
}
},
"in": "path",
"name": "batchId",
"required": true,
"schema": {
"type": "integer"
},
"style": "simple"
},
"ref_6af5008fcc50131f9758": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_42257c2e1171733db046"
},
{
"properties": {
"regulatedCheckCard": {
"$ref": "#/x-devx-bundled/ref_01f55c7b2d1709665555",
"description": "Object that contains the fees for a regulated debit-card transaction."
},
"unregulatedCheckCard": {
"$ref": "#/x-devx-bundled/ref_01f55c7b2d1709665555",
"description": "Object that contains the fees for an unregulated debit-card transaction."
}
},
"required": [
"regulatedCheckCard",
"unregulatedCheckCard"
],
"type": "object"
}
],
"type": "object"
},
"ref_6b9b37b9a97eaeb09c2c": {
"description": "Add operation adds a new value to an object or array.",
"summary": "Update event subscription: add",
"value": [
{
"op": "add",
"path": "/eventTypes",
"value": "terminalOrder.status.changed"
}
]
},
"ref_6c2e65220549847424ca": {
"description": "Add operation adds a new value to an object or array.",
"summary": "Update subscription: add",
"value": [
{
"op": "add",
"path": "/customFields",
"value": {
"name": "membershipLevel",
"value": "premium"
}
}
]
},
"ref_6d1b41f7d5b044540bd5": {
"properties": {
"transaction": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_109fe7e5f018de7ee04b"
}
],
"description": "Fee for each transaction. The value is in the currency's lowest denomination, for example, cents."
},
"type": {
"description": "Type of American Express program.",
"enum": [
"direct"
],
"type": "string"
}
},
"required": [
"type",
"transaction"
],
"title": "direct",
"type": "object"
},
"ref_6d84754d235eee5ffb8f": {
"description": "Remove operation deletes a value from the subscription.",
"summary": "Update subscription: remove",
"value": [
{
"op": "remove",
"path": "/description"
}
]
},
"ref_6db5fbe977e5d9f1070e": {
"description": "Create the first payment in a recurring series using a secure token.",
"summary": "Card sale with secure token and is the first payment in a series",
"value": {
"channel": "web",
"credentialOnFile": {
"mitAgreement": "recurring"
},
"customFields": [
{
"name": "yourCustomField",
"value": "abc123"
}
],
"customer": {
"billingAddress": {
"address1": "1 Example Ave.",
"address2": "Example Address Line 2",
"address3": "Example Address Line 3",
"city": "Chicago",
"country": "US",
"postalCode": "60056",
"state": "Illinois"
},
"firstName": "Sarah",
"lastName": "Hopper",
"shippingAddress": {
"address": {
"address1": "1 Example Ave.",
"address2": "Example Address Line 2",
"address3": "Example Address Line 3",
"city": "Chicago",
"country": "US",
"postalCode": "60056",
"state": "Illinois"
},
"recipientName": "Sarah Hopper"
}
},
"operator": "Jane",
"order": {
"amount": 4999,
"currency": "USD",
"description": "Pizza Doe #1234 - Dinner",
"orderId": "OrderRef6543",
"standingInstructions": {
"processingModel": "recurring",
"sequence": "first"
}
},
"paymentMethod": {
"token": "296753123456",
"type": "secureToken"
},
"processingTerminalId": "1234001"
}
},
"ref_6e5f6c82188ec67f61c8": {
"properties": {
"attachmentId": {
"description": "Unique identifier that our gateway assigned to the attachment.",
"example": "2587",
"type": "string"
},
"contentType": {
"description": "Content type of the file.",
"example": "application/pdf",
"maxLength": 76,
"type": "string"
},
"createdDate": {
"description": "Date and time that we received your request to upload the attachment.",
"example": "2024-07-02T12:00:00.000Z",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"description": {
"description": "Short description of the attachment.",
"example": "Passport as identification for lease agreement",
"maxLength": 250,
"type": "string"
},
"entity": {
"description": "Object that contains information about the entity that the attachment is linked to.",
"properties": {
"id": {
"description": "Unique identifier of the entity that the attachment is linked to.",
"example": "12667",
"maxLength": 50,
"type": "string"
},
"type": {
"description": "Type of entity that the attachment is linked to.",
"enum": [
"processingAccount"
],
"example": "processingAccount",
"maxLength": 17,
"type": "string"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"fileName": {
"description": "Name of the file.",
"example": "JaneDoePassport.pdf",
"maxLength": 150,
"type": "string"
},
"lastModifiedDate": {
"description": "Date and time the attachment was last modified.",
"example": "2024-07-02T12:00:00.000Z",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"metadata": {
"additionalProperties": {
"type": "string"
},
"description": "Object that you can send to include custom metadata in the request.",
"example": {
"passportId": "123456789"
},
"type": "object"
},
"type": {
"description": "Type of attachment.",
"enum": [
"bankingEvidence",
"questionnairesAndLicenses",
"merchantStatements",
"taxDocuments",
"mpaOrAmendment",
"proofOfBusiness",
"financialStatements",
"personalIdentification",
"other"
],
"example": "personalIdentification",
"maxLength": 22,
"minLength": 5,
"type": "string"
},
"uploadStatus": {
"description": "Upload status of the attachment. The value is one of the following:\n- `pending` - We have not yet uploaded the attachment.\n- `accepted` - We have uploaded the attachment. \n- `rejected` - We rejected the attachment. \n",
"enum": [
"pending",
"accepted",
"rejected"
],
"example": "pending",
"maxLength": 8,
"type": "string"
}
},
"required": [
"attachmentId",
"uploadStatus",
"contentType",
"fileName",
"entity",
"type",
"createdDate",
"lastModifiedDate"
],
"type": "object"
},
"ref_6e69f732f5c733ad3613": {
"description": "Create a new funding recipient with owners and funding accounts.",
"summary": "Create funding recipient",
"value": {
"address": {
"address1": "1 Example Ave.",
"address2": "Example Address Line 2",
"address3": "Example Address Line 3",
"city": "Chicago",
"country": "US",
"postalCode": "60056",
"state": "Illinois"
},
"contactMethods": [
{
"type": "email",
"value": "jane.doe@example.com"
},
{
"type": "phone",
"value": "2025550164"
}
],
"doingBusinessAs": "Pizza Doe",
"fundingAccounts": [
{
"nameOnAccount": "Jane Doe",
"paymentMethods": [
{
"type": "ach",
"value": {
"accountNumber": "1234567890",
"routingNumber": "123456789"
}
}
],
"type": "checking",
"use": "credit"
}
],
"metadata": {
"yourCustomField": "abc123"
},
"owners": [
{
"address": {
"address1": "1 Example Ave.",
"city": "Chicago",
"country": "US",
"postalCode": "60056",
"state": "Illinois"
},
"contactMethods": [
{
"type": "email",
"value": "jane.doe@example.com"
},
{
"type": "phone",
"value": "2025550164"
}
],
"dateOfBirth": "1964-03-22",
"firstName": "Jane",
"identifiers": [
{
"type": "nationalId",
"value": "000-00-4320"
}
],
"lastName": "Doe",
"middleName": "Helen",
"relationship": {
"equityPercentage": 48.5,
"isAuthorizedSignatory": false,
"isControlProng": true,
"title": "CFO"
}
}
],
"recipientType": "privateCorporation",
"taxId": "12-3456789"
}
},
"ref_6ea779bd3356928bc30b": {
"description": "Object that contains information about the Hardware Advantage Plan.",
"properties": {
"enabled": {
"default": true,
"description": "Indicates if the merchant has signed up for the Hardware Advantage Plan.",
"example": true,
"type": "boolean"
},
"name": {
"description": "Name of the service.",
"enum": [
"hardwareAdvantagePlan"
],
"example": "hardwareAdvantagePlan",
"type": "string"
}
},
"required": [
"name",
"enabled"
],
"type": "object"
},
"ref_6eb9ea50131ff5aa24f5": {
"description": "Event subscription after copying the webhook URI into metadata.",
"summary": "Update event subscription: copy",
"value": {
"enabled": true,
"eventTypes": [
"processingAccount.status.changed"
],
"id": 2565435189324,
"metadata": {
"webhookBackup": "https://my-service/notification/endpoint",
"yourCustomField": "abc123"
},
"notifications": [
{
"secret": "**********oP3456",
"supportEmailAddress": "jane.doe@example.com",
"type": "webhook",
"uri": "https://my-server/notification/endpoint"
}
],
"status": "registered"
}
},
"ref_6ec7b620681ea282f7ed": {
"description": "Remove operation deletes a value from the pricing intent.",
"summary": "Update pricing intent: remove",
"value": [
{
"op": "remove",
"path": "/metadata/yourCustomField"
}
]
},
"ref_6f025c42b03b33927339": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_3147c722e948ca9d06ad"
},
{
"properties": {
"amount": {
"description": "Amount of the refund. The value is in the currency's lowest denomination, for example, cents.",
"example": 4999,
"format": "int64",
"type": "integer"
},
"currency": {
"$ref": "#/x-devx-bundled/ref_5c51a0e852c4baa940d0"
},
"dateTime": {
"description": "Date and time that our gateway processed the refund. The value follows the [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) standard.",
"example": "2024-07-02T15:30:00Z",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"dccOffer": {
"$ref": "#/x-devx-bundled/ref_69d0c405bed69b717603"
},
"description": {
"description": "Description of the transaction.",
"example": "Refund for order OrderRef6543",
"maxLength": 256,
"minLength": 1,
"type": "string"
},
"orderId": {
"description": "Unique identifier that the merchant assigns to the transaction.",
"example": "OrderRef6543",
"maxLength": 24,
"minLength": 1,
"type": "string"
}
},
"type": "object"
}
],
"description": "Object that contains information about the refund.",
"required": [
"amount",
"currency",
"description",
"orderId"
],
"type": "object"
},
"ref_6f0582c73052d88625d6": {
"description": "Create a pricing intent.",
"summary": "Flat Rate",
"value": {
"base": {
"addressVerification": 5,
"annualFee": {
"amount": 9900,
"billInMonth": "june"
},
"batch": 0,
"chargeback": 2500,
"earlyTermination": 57500,
"maintenance": 500,
"minimum": 0,
"pciNonCompliance": 4995,
"platinumSecurity": {
"billingFrequency": "monthly"
},
"regulatoryAssistanceProgram": 15,
"retrieval": 1500,
"voiceAuthorization": 95
},
"country": "US",
"key": "Your-Unique-Identifier",
"metadata": {
"yourCustomField": "abc123"
},
"processor": {
"card": {
"fees": {
"electronicBenefitsTransfer": {
"transaction": 25
},
"pinDebit": {
"additionalDiscount": 1.25,
"monthlyAccess": 1200,
"transaction": 25
},
"specialityCards": {
"transaction": 25
},
"standardCards": {
"transaction": 25,
"volume": 2.89
}
},
"planType": "flatRate"
}
},
"services": [
{
"enabled": true,
"name": "hardwareAdvantagePlan"
}
],
"version": "5.2"
}
},
"ref_6f5f7c66fc3a21e3ef34": {
"description": "Secure token after we added a custom field.",
"summary": "Update secure token: add",
"value": {
"customFields": [
{
"name": "yourCustomField",
"value": "abc123"
},
{
"name": "loyaltyTier",
"value": "gold"
}
],
"customer": {
"billingAddress": {
"address1": "1 Example Ave.",
"address2": "Example Address Line 2",
"address3": "Example Address Line 3",
"city": "Chicago",
"country": "US",
"postalCode": "60056",
"state": "Illinois"
},
"contactMethods": [
{
"type": "email",
"value": "sarah.hopper@example.com"
}
],
"dateOfBirth": "1990-07-15",
"firstName": "Sarah",
"lastName": "Hopper",
"notificationLanguage": "en",
"referenceNumber": "Customer-12",
"shippingAddress": {
"address": {
"address1": "1 Example Ave.",
"address2": "Example Address Line 2",
"address3": "Example Address Line 3",
"city": "Chicago",
"country": "US",
"postalCode": "60056",
"state": "Illinois"
},
"recipientName": "Sarah Hopper"
}
},
"mitAgreement": "unscheduled",
"processingTerminalId": "1234001",
"secureTokenId": "MREF_abc1de23-f4a5-6789-bcd0-12e345678901fa",
"source": {
"cardNumber": "453985******7062",
"cardholderName": "Sarah Hazel Hopper",
"expiryDate": "1230",
"type": "card"
},
"status": "notValidated",
"token": "296753123456"
}
},
"ref_6f855718c62bdd201bb6": {
"description": "Unique identifier that our gateway assigned to the refund.",
"examples": {
"example": {
"value": "CD3HN88U9F"
}
},
"in": "path",
"name": "refundId",
"required": true,
"schema": {
"maxLength": 10,
"minLength": 10,
"type": "string"
}
},
"ref_6fb9b9559ed218c0aa0a": {
"description": "Object that contains information regarding the intention to pay, if required.",
"discriminator": {
"mapping": {
"purchase": "#/components/schemas/purchaseIntent"
},
"propertyName": "paymentIntentType"
},
"oneOf": [
{
"$ref": "#/x-devx-bundled/ref_cfe961eef7b95f482be7"
}
],
"type": "object"
},
"ref_6fea4800b71b1b4c8c27": {
"description": "Object that contains information about the gateway fees for MPA 5.0.",
"properties": {
"fees": {
"description": "Object that contains information about the gateway fees.",
"properties": {
"monthly": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_109fe7e5f018de7ee04b"
}
],
"description": "Monthly fee for the gateway. The value is in the currency's lowest denomination, for example, cents."
},
"perDeviceMonthly": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_109fe7e5f018de7ee04b"
}
],
"description": "Monthly fee for each device. The value is in the currency's lowest denomination, for example, cents."
},
"perTransaction": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_109fe7e5f018de7ee04b"
}
],
"description": "Fee for each transaction. The value is in the currency's lowest denomination, for example, cents."
},
"setup": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_109fe7e5f018de7ee04b"
}
],
"description": "Fee for setting up your account with the gateway. The value is in the currency's lowest denomination, for example, cents."
}
},
"required": [
"monthly",
"setup",
"perTransaction",
"perDeviceMonthly"
],
"type": "object"
}
},
"required": [
"fees"
],
"title": "gateway fees",
"type": "object"
},
"ref_7037b7c3d717e0c53992": {
"properties": {
"card": {
"$ref": "#/x-devx-bundled/ref_9ab219963d0de56b1c4a"
},
"customFields": {
"description": "Array of customField objects.\n",
"items": {
"$ref": "#/x-devx-bundled/ref_91509fee696e20aa30f2"
},
"type": "array"
},
"customer": {
"$ref": "#/x-devx-bundled/ref_5698b09ff5e98efedc02"
},
"operator": {
"description": "Operator who initiated the request.",
"example": "Jane",
"maxLength": 50,
"minLength": 0,
"type": "string"
},
"order": {
"$ref": "#/x-devx-bundled/ref_180b93cfd401848a2c1b"
},
"paymentId": {
"description": "Unique identifier that our gateway assigned to the transaction.",
"example": "M2MJOG6O2Y",
"maxLength": 10,
"minLength": 10,
"type": "string"
},
"processingTerminalId": {
"description": "Unique identifier of the terminal that initiated the transaction.",
"example": "1234001",
"maxLength": 50,
"minLength": 4,
"type": "string"
},
"refunds": {
"description": "Array of refundSummary objects. \nEach object contains information about refunds linked to the transaction.\n",
"items": {
"$ref": "#/x-devx-bundled/ref_8a40ea359f0502198da9"
},
"type": "array",
"uniqueItems": true
},
"supportedOperations": {
"$ref": "#/x-devx-bundled/ref_bba41f5c84235f2c1871"
},
"transactionResult": {
"$ref": "#/x-devx-bundled/ref_68f95191b4389dc629cb"
}
},
"required": [
"card",
"order",
"paymentId",
"processingTerminalId",
"transactionResult"
],
"type": "object"
},
"ref_70cc8dae801ba45c5c9f": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_332dff3df47ae1e824ea"
},
{
"properties": {
"taxes": {
"description": "List of taxes.",
"items": {
"$ref": "#/x-devx-bundled/ref_ff9e53b467436d074a75"
},
"type": "array"
}
},
"type": "object"
}
],
"type": "object"
},
"ref_70db04b69eb195758e31": {
"description": "Object that contains information about the progress of the signature instruction.",
"summary": "Signature instruction",
"value": {
"link": {
"href": "https://api.payroc.com/v1/signatures/M2MJOG6O2Y",
"method": "GET",
"rel": "signature"
},
"signatureInstructionId": "a37439165d134678a9100ebba3b29597",
"status": "completed"
}
},
"ref_7115d17448ae36aa6f18": {
"description": "Unique identifier of the terminal order.",
"examples": {
"example": {
"value": "12345"
}
},
"in": "path",
"name": "terminalOrderId",
"required": true,
"schema": {
"type": "string"
}
},
"ref_713c3c35d5f331b857c8": {
"description": "Filter by the frequency of subscription payments.",
"examples": {
"example": {
"value": "monthly"
}
},
"in": "query",
"name": "frequency",
"schema": {
"enum": [
"weekly",
"fortnightly",
"monthly",
"quarterly",
"yearly"
],
"type": "string"
}
},
"ref_714d26764eda6aed1ff1": {
"description": "Object that contains the token.",
"properties": {
"token": {
"description": "Single-use token that the gateway assigned to the payment details.",
"example": "abcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890",
"maxLength": 128,
"minLength": 128,
"type": "string"
},
"type": {
"description": "Type of token.",
"enum": [
"singleUseToken"
],
"example": "singleUseToken",
"type": "string"
}
},
"required": [
"type",
"token"
],
"type": "object"
},
"ref_715be958a787f9a1f183": {
"description": "Secure Token",
"summary": "Secure Token",
"value": {
"customFields": [
{
"name": "yourCustomField",
"value": "abc123"
}
],
"customer": {
"billingAddress": {
"address1": "1 Example Ave.",
"address2": "Example Address Line 2",
"address3": "Example Address Line 3",
"city": "Chicago",
"country": "US",
"postalCode": "60056",
"state": "Illinois"
},
"contactMethods": [
{
"type": "email",
"value": "sarah.hopper@example.com"
}
],
"dateOfBirth": "1990-07-15",
"firstName": "Sarah",
"lastName": "Hopper",
"notificationLanguage": "en",
"referenceNumber": "Customer-12",
"shippingAddress": {
"address": {
"address1": "1 Example Ave.",
"address2": "Example Address Line 2",
"address3": "Example Address Line 3",
"city": "Chicago",
"country": "US",
"postalCode": "60056",
"state": "Illinois"
},
"recipientName": "Sarah Hopper"
}
},
"mitAgreement": "unscheduled",
"processingTerminalId": "1234001",
"secureTokenId": "MREF_abc1de23-f4a5-6789-bcd0-12e345678901fa",
"source": {
"cardNumber": "453985******7062",
"cardholderName": "Sarah Hazel Hopper",
"expiryDate": "1230",
"type": "card"
},
"status": "notValidated",
"token": "296753123456"
}
},
"ref_721dfad0fe6c1d4d2955": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_143db3de56b4d4e7e9c2"
},
{
"$ref": "#/x-devx-bundled/ref_a655a7bef3118e3aec71"
}
],
"description": "Object that contains information about a pricing intent for Merchant Processing Agreement (MPA) 5.0.",
"title": "5.0",
"type": "object"
},
"ref_72499517f50376b0b204": {
"description": "Inform the payfac what to do with the specified funds. **",
"properties": {
"createdDate": {
"description": "Date that we created the funding instruction. The date format follows the [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) standard.",
"example": "2024-07-02T15:30:00Z",
"format": "datetime",
"readOnly": true,
"type": "string"
},
"instructionId": {
"description": "Unique identifier that we assigned to the funding instruction.",
"example": 64643131,
"readOnly": true,
"type": "integer"
},
"lastModifiedDate": {
"description": "Date of the most recent change to the funding instruction. The date format follows the [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) standard.",
"example": "2024-07-02T15:30:00Z",
"format": "datetime",
"readOnly": true,
"type": "string"
},
"merchants": {
"description": "Array of merchants objects. Each object specifies the merchant whose funding balance we distribute and who you want to send the funds to.",
"items": {
"description": "Instruction indicating which recipients should receive funding from the specific merchant balance.",
"properties": {
"link": {
"description": "Object that contains HATEOAS links for the resource.",
"properties": {
"href": {
"description": "URL of the target resource.",
"example": "https://api.payroc.com/v1/processing-accounts/4525644354",
"type": "string"
},
"method": {
"description": "HTTP method that you need to use with the target resource.",
"example": "get",
"type": "string"
},
"rel": {
"description": "Indicates the relationship between the current resource and the target resource.",
"example": "merchant",
"type": "string"
}
},
"readOnly": true,
"type": "object"
},
"merchantId": {
"description": "Unique identifier that the processor assigned to the merchant.",
"example": "4525644354",
"type": "string"
},
"recipients": {
"description": "Array of recipients objects. Each object contains information about the funding account and the amount of funds we send to the funding account.",
"items": {
"description": "Object that contains information about the target funding account.",
"properties": {
"amount": {
"description": "Object that contains information about the funds that we send to the funding account.",
"properties": {
"currency": {
"default": "USD",
"description": "Currency of the value parameter.",
"enum": [
"USD"
],
"example": "USD",
"type": "string"
},
"value": {
"description": "Amount of funds in the currency's lowest denomination, for example, cents.",
"example": 120000,
"type": "integer"
}
},
"required": [
"value"
],
"type": "object"
},
"fundingAccountId": {
"description": "Unique identifier that we assigned to the funding account.",
"example": 123,
"type": "integer"
},
"link": {
"description": "Object that contains HATEOAS links for the resource.",
"properties": {
"href": {
"description": "URL of the target resource.",
"example": "https://api.payroc.com/v1/funding-accounts/123",
"type": "string"
},
"method": {
"description": "HTTP method that you need to use with the target resource.",
"example": "get",
"type": "string"
},
"rel": {
"description": "Indicates the relationship between the current resource and the target resource.",
"example": "fundingAccount",
"type": "string"
}
},
"readOnly": true,
"type": "object"
},
"metadata": {
"additionalProperties": {
"type": "string"
},
"description": "[Metadata](https://docs.payroc.com/api/metadata) object you can use to include custom data with your request.",
"example": {
"yourCustomField": "abc123"
},
"type": "object"
},
"paymentMethod": {
"description": "Payment method that we use to send funds to the funding account.",
"enum": [
"ACH"
],
"example": "ACH",
"type": "string"
},
"status": {
"description": "Status of the individual payment instruction. Our gateway returns one of the following values: \n-\t`accepted` - We received the payment instruction, but we haven't reviewed it. \n-\t`pending` - We are reviewing the payment instruction. \n-\t`released` - We approved the payment instruction. \n-\t`funded` - We sent the funds to the funding account by ACH. \n-\t`failed` - The ACH payment to the funding account failed. \n-\t`rejected` - We reviewed the payment instruction and rejected it. \n- `onHold` - We have placed the payment instruction on hold. \n",
"enum": [
"accepted",
"pending",
"released",
"funded",
"failed",
"rejected",
"onHold"
],
"example": "accepted",
"readOnly": true,
"type": "string"
}
},
"required": [
"fundingAccountId",
"paymentMethod",
"amount"
],
"title": "target funding account",
"type": "object"
},
"minItems": 1,
"type": "array"
}
},
"required": [
"merchantId",
"recipients"
],
"title": "merchant instruction",
"type": "object"
},
"type": "array"
},
"metadata": {
"additionalProperties": {
"type": "string"
},
"description": "[Metadata](https://docs.payroc.com/api/metadata) object you can use to include custom data with your request.",
"example": {
"yourCustomField": "abc123"
},
"type": "object"
},
"status": {
"description": "Status of the funding instruction. Our gateway returns one of the following values: \n- `accepted` - We have received the funding instruction but have not yet reviewed it. \n- `pending` - We have received the funding instruction and we are reviewing it. \n- `completed` - We have reviewed and processed the funding instruction. \n",
"enum": [
"accepted",
"pending",
"completed"
],
"example": "accepted",
"readOnly": true,
"type": "string"
}
},
"title": "funding instruction",
"type": "object"
},
"ref_72e672837842d3f036da": {
"description": "Move operation relocates a value from one location to another.",
"summary": "Update event subscription: move",
"value": [
{
"from": "/eventTypes/0",
"op": "move",
"path": "/eventTypes/1"
}
]
},
"ref_7370bae0071197c0ab53": {
"description": "Processing account created for a Fiserv-bound merchant with no Clover devices ordered. No addendums are appended.",
"summary": "Create Fiserv processing account",
"value": {
"addendums": [],
"address": {
"address1": "1 Example Ave.",
"address2": "Example Address Line 2",
"address3": "Example Address Line 3",
"city": "Chicago",
"country": "US",
"postalCode": "60056",
"state": "Illinois"
},
"businessStartDate": "2020-01-01",
"businessType": "restaurant",
"categoryCode": 5999,
"contactMethods": [
{
"type": "email",
"value": "jane.doe@example.com"
}
],
"contacts": [
{
"contactId": 1543,
"firstName": "Jane",
"lastName": "Doe",
"link": {
"href": "https://api.payroc.com/v1/contacts/1543",
"method": "get",
"rel": "contact"
}
}
],
"createdDate": "2024-07-02T12:00:00.000+00:00",
"doingBusinessAs": "Pizza Doe",
"funding": {
"acceleratedFundingFee": 1999,
"dailyDiscount": false,
"fundingAccounts": [
{
"fundingAccountId": 123,
"link": {
"href": "https://api.payroc.com/v1/funding-accounts/123",
"method": "get",
"rel": "fundingAccount"
},
"status": "pending"
}
],
"fundingSchedule": "nextday",
"status": "enabled"
},
"lastModifiedDate": "2024-07-02T12:00:00.000+00:00",
"merchandiseOrServiceSold": "Pizza",
"metadata": {
"customerId": "2345"
},
"owners": [
{
"firstName": "Jane",
"lastName": "Doe",
"link": {
"href": "https://api.payroc.com/v1/owners/4564",
"method": "get",
"rel": "owner"
},
"ownerId": 4564
}
],
"pricing": {
"link": {
"href": "https://api.payroc.com/v1/processing-accounts/38767/pricing",
"method": "get",
"rel": "pricing"
}
},
"processing": {
"monthlyAmounts": {
"average": 50000,
"highest": 100000
},
"transactionAmounts": {
"average": 5000,
"highest": 10000
},
"volumeBreakdown": {
"cardPresent": 77,
"ecommerce": 20,
"mailOrTelephone": 3
}
},
"processingAccountId": "38767",
"processor": "fiserv",
"signature": {
"link": {
"href": "https://us.agreementexpress.net/mv2/viewer2.jsp?docId=00000000-0000-0000-0000-000000000000",
"method": "get",
"rel": "agreement"
},
"type": "requestedViaDirectLink"
},
"status": "entered",
"timezone": "America/Chicago",
"website": "www.example.com"
}
},
"ref_73b332ab2e0080910d47": {
"description": "Filter results by the order ID of the refund.",
"examples": {
"example": {
"value": "OrderRef6543"
}
},
"in": "query",
"name": "orderId",
"schema": {
"maxLength": 24,
"minLength": 1,
"type": "string"
}
},
"ref_73ccf7ffa65b9a82668c": {
"description": "Object that contains information about the convenience fee for the transaction.",
"properties": {
"amount": {
"description": "If the merchant added a convenience fee, this value indicates the amount of the convenience fee\nin the currency’s lowest denomination, for example, cents.\n",
"example": 25,
"exclusiveMinimum": 0,
"format": "int64",
"type": "integer"
}
},
"readOnly": true,
"required": [
"amount"
],
"type": "object"
},
"ref_7507ed0fd8805671d1aa": {
"description": "Object that contains summary information about the transaction that the dispute is linked to.",
"properties": {
"amount": {
"description": "Total amount of the transaction. The value is in the currency's lowest denomination, for example, cents.",
"example": 25000,
"format": "int64",
"type": "integer"
},
"date": {
"description": "Date of the transaction. The format of this value is **YYYY-MM-DD**.",
"example": "2024-07-02",
"format": "date",
"type": "string"
},
"entryMethod": {
"description": "Describes how the merchant received the payment details. If we can't match a dispute to a transaction, we don't return an entryMethod object.",
"enum": [
"barcodeRead",
"smartChipRead",
"swipedOriginUnknown",
"contactlessChip",
"ecommerce",
"manuallyEntered",
"manuallyEnteredFallback",
"swiped",
"swipedFallback",
"swipedError",
"scannedCheckReader",
"credentialOnFile",
"unknown"
],
"type": [
"string",
"null"
]
},
"link": {
"$ref": "#/x-devx-bundled/ref_27e6d0e095fb23cba669"
},
"transactionId": {
"description": "Unique identifier of the transaction. If we can't match a dispute to a transaction, we don't return the transactionId or link object.",
"example": 12345,
"type": [
"integer",
"null"
]
},
"type": {
"description": "Indicates the type of transaction.",
"enum": [
"capture",
"return"
],
"type": "string"
}
},
"title": "transaction summary",
"type": "object"
},
"ref_75ac48f7260a032d78ce": {
"properties": {
"currency": {
"$ref": "#/x-devx-bundled/ref_5c51a0e852c4baa940d0"
},
"customFieldNames": {
"description": "Array of custom fields that you can use in subscriptions linked to the payment plan.\n",
"example": [
"yourCustomField"
],
"items": {
"maxLength": 56,
"minLength": 1,
"type": "string"
},
"type": "array"
},
"description": {
"description": "Description of the payment plan.",
"example": "Monthly Premium Club subscription",
"maxLength": 128,
"minLength": 0,
"type": "string"
},
"frequency": {
"description": "Indicates how often the merchant or the terminal collects a payment from the customer.",
"enum": [
"weekly",
"fortnightly",
"monthly",
"quarterly",
"yearly"
],
"example": "monthly",
"type": "string"
},
"length": {
"default": 0,
"description": "Number of payments for the payment plan. \n\nTo indicate that the payment plan should run indefinitely, send a value of `0`.\n",
"example": 12,
"format": "int32",
"minimum": 0,
"type": "integer"
},
"name": {
"description": "Name of the payment plan.",
"example": "Premium Club",
"maxLength": 128,
"minLength": 5,
"type": "string"
},
"onDelete": {
"default": "complete",
"description": "Indicates what happens to existing subscriptions if the merchant deletes the payment plan.\n- `complete` - Stops existing subscriptions.\n- `continue` - Continues existing subscriptions.\n",
"enum": [
"complete",
"continue"
],
"example": "continue",
"type": "string"
},
"onUpdate": {
"default": "continue",
"description": "Indicates whether any changes that the merchant makes to the payment plan apply to existing subscriptions.\n- `update` - Changes apply to existing subscriptions.\n- `continue` - Changes don't apply to existing subscriptions.\n",
"enum": [
"update",
"continue"
],
"example": "continue",
"type": "string"
},
"paymentPlanId": {
"description": "Unique identifier that the merchant assigns to the payment plan.",
"example": "PlanRef8765",
"maxLength": 48,
"minLength": 1,
"type": "string"
},
"processingTerminalId": {
"description": "Unique identifier of the terminal that the payment plan is assigned to.",
"example": "1234001",
"maxLength": 50,
"minLength": 4,
"readOnly": true,
"type": "string"
},
"type": {
"default": "automatic",
"description": "Indicates how the merchant takes the payment from the customer's account.\n- `manual` - The merchant manually collects payments from the customer.\n- `automatic` - The terminal automatically collects payments from the customer.\n",
"enum": [
"manual",
"automatic"
],
"example": "automatic",
"type": "string"
}
},
"required": [
"paymentPlanId",
"name",
"currency",
"frequency",
"onDelete",
"onUpdate",
"type"
],
"type": "object"
},
"ref_75f958179d546bcbf343": {
"description": "Payment instruction already completed",
"summary": "Payment instruction already completed",
"value": {
"detail": "You cannot cancel this resource in its current state",
"errors": [
{
"message": "Completed instruction cannot be canceled",
"parameter": "paymentInstructionId"
}
],
"link": {
"href": "https://api.payroc.com/v1/payments/M2MJOG6O2Y",
"method": "GET",
"rel": "payment"
},
"status": 409,
"title": "Cannot be canceled",
"type": "https://docs.payroc.com/api/errors#cannot-be-canceled"
}
},
"ref_76695c1b0a3debe0d3fd": {
"description": "Example patch operations that apply the RFC 6902 standard.\n",
"summary": "Example patch operations that apply the RFC 6902 standard",
"value": [
{
"op": "add",
"path": "/a/b/c",
"value": [
123,
456
]
},
{
"op": "remove",
"path": "/a/b/c"
},
{
"op": "replace",
"path": "/a/b/c",
"value": 789
},
{
"from": "/a/b/c",
"op": "move",
"path": "/a/b/d"
},
{
"from": "/a/b/d",
"op": "copy",
"path": "/a/b/e"
},
{
"op": "test",
"path": "/a/b/c",
"value": 123
}
]
},
"ref_767f7633cd631493d2ab": {
"description": "Convert a single-use token to a secure token when running a bank transfer sale.",
"summary": "Bank transfer sale with single-use token that we convert to a secure token",
"value": {
"bankAccount": {
"accountNumber": "****1591",
"nameOnAccount": "Sarah Hazel Hopper",
"routingNumber": "063100277",
"secCode": "web",
"secureToken": {
"customerName": "Sarah Hazel Hopper",
"link": {
"href": "https://api.payroc.com/v1/processing-terminals/1234001/secure-tokens/MREF_abc1de23-f4a5-6789-bcd0-12e345678901fa",
"method": "GET",
"rel": "self"
},
"secureTokenId": "MREF_abc1de23-f4a5-6789-bcd0-12e345678901fa",
"status": "notValidated",
"token": "296753123456"
},
"type": "ach"
},
"customFields": [
{
"name": "yourCustomField",
"value": "abc123"
}
],
"customer": {
"contactMethods": [
{
"type": "email",
"value": "sarah.hopper@example.com"
}
],
"notificationLanguage": "en"
},
"order": {
"amount": 4999,
"currency": "USD",
"dateTime": "2024-07-02T15:30:00Z",
"description": "Large Pepperoni Pizza",
"orderId": "OrderRef6543"
},
"paymentId": "E29U8OU8Q4",
"processingTerminalId": "1234001",
"transactionResult": {
"authorizedAmount": 4999,
"currency": "USD",
"processorResponseCode": "0",
"responseCode": "A",
"responseMessage": "NoError",
"status": "ready",
"type": "payment"
}
}
},
"ref_7683f58c322dd7c5757f": {
"properties": {
"detail": {
"description": "Explanation of the problem",
"example": "You do not have the required permissions to perform this action",
"type": "string"
},
"instance": {
"description": "Resource path the action was attempted on",
"example": "https://api.payroc.com/v1/example/3",
"type": "string"
},
"resource": {
"description": "Resource the action was attempted on",
"example": "exampleResource",
"type": "string"
},
"status": {
"description": "Http status code",
"example": 403,
"type": "integer"
},
"title": {
"description": "Short description of the issue.",
"example": "Forbidden",
"type": "string"
},
"type": {
"description": "URI reference identifying the problem type",
"example": "https://docs.payroc.com/api/errors#forbidden",
"type": "string"
}
},
"required": [
"type",
"title",
"status",
"detail"
],
"type": "object"
},
"ref_76fdde248e56e2b06a7c": {
"description": "Object that contains information about the partially-encrypted card data for keyed transactions.",
"properties": {
"cvv": {
"description": "Security code of the customer’s card.",
"example": "234",
"pattern": "[0-9]{3,4}",
"type": "string"
},
"cvvEncrypted": {
"description": "Encrypted security code data.",
"format": "hexadecimal",
"type": "string"
},
"dataFormat": {
"description": "Indicates the data format of the customer’s card data.\n-\t`plainText` – Data is not truncated and shows the raw data.\n-\t`fullyEncrypted` – Data is truncated to show only the first digit of the customer’s account number.\n-\t`partiallyEncrypted` – Data is truncated to show only the first six digits and the last four digits of the customer’s card number.\n",
"enum": [
"partiallyEncrypted"
],
"example": "partiallyEncrypted",
"type": "string"
},
"device": {
"$ref": "#/x-devx-bundled/ref_9b532b6dac98bf9563ff"
},
"encryptedPan": {
"description": "Encrypted card number.",
"example": "A1B2C3D4E5F67890ABCD1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF",
"format": "hexadecimal",
"maxLength": 2147483647,
"minLength": 1,
"type": "string"
},
"expiryDate": {
"description": "Expiry date of the customer’s card.",
"example": "1230",
"pattern": "[0-9]{4}",
"type": "string"
},
"issueNumber": {
"description": "Issue number of the customer’s card.",
"example": "78",
"pattern": "[0-9]{1,2}",
"type": "string"
},
"maskedPan": {
"description": "Masked card number. \nThe gateway shows only the first six digits and the last four digits of the account number. For example, `453985******7062`.\n",
"example": "453985******7062",
"maxLength": 19,
"minLength": 12,
"type": "string"
}
},
"required": [
"dataFormat",
"device",
"encryptedPan",
"expiryDate",
"maskedPan"
],
"title": "partiallyEncrypted",
"type": "object"
},
"ref_771c5ab6f019403ab8ae": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_9aa3626bbdc7eb1b405e"
},
{
"properties": {
"accountType": {
"description": "Indicates the customer's account type.\n",
"enum": [
"checking",
"savings"
],
"example": "checking",
"type": "string"
}
},
"type": "object"
}
]
},
"ref_77722c3f40102e1b2d41": {
"description": "Replace operation updates an existing value.",
"summary": "Update secure token: replace",
"value": [
{
"op": "replace",
"path": "/customer/lastName",
"value": "Reed"
}
]
},
"ref_77b5fb747c9a6c1ea0a5": {
"description": "Filter results by the settlement date. Send a value in **YYYY-MM-DD** format.",
"examples": {
"example": {
"value": "2024-07-15"
}
},
"in": "query",
"name": "settlementDate",
"schema": {
"format": "date",
"type": "string"
}
},
"ref_77d38980c21a16856c11": {
"properties": {
"acceleratedFundingFee": {
"default": 0,
"description": "Monthly fee in cents for accelerated funding. The value is in the currency's lowest denomination, for example, cents. \n \nWe apply this fee if the value for fundingSchedule is `sameday` or `nextday`. \n",
"example": 1999,
"type": "integer"
},
"dailyDiscount": {
"description": "Indicates if we collect fees from the merchant's account each day.",
"example": false,
"type": "boolean"
},
"fundingSchedule": {
"default": "standard",
"description": "Indicates when funds are sent to the funding account. \n\nIf you send a value of `sameDay` or `nextDay`, provide a value for acceleratedFundingFee. \n\n**Note:** If you send a value of `sameday`, funding includes all transactions the merchant ran before the ACH cut-off time. \n",
"enum": [
"standard",
"nextday",
"sameday"
],
"example": "nextday",
"type": "string"
},
"status": {
"description": "Indicates if the processing account can receive funds.",
"enum": [
"enabled",
"disabled"
],
"example": "enabled",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"ref_77edacc39d6563d3cbed": {
"description": "Unique identifier of the ACH deposit. You must provide either the 'achDepositId' or the 'date'.",
"examples": {
"example": {
"value": 99
}
},
"in": "query",
"name": "achDepositId",
"schema": {
"type": "integer"
}
},
"ref_7844a2a818521fc56fa4": {
"description": "Object that contains information about the taxes that apply to the transaction.\n",
"properties": {
"subtotal": {
"description": "Total amount for the transaction before tax. The value is in the currency's lowest denomination, for example, cents.",
"example": 4999,
"format": "int64",
"type": "integer"
}
},
"required": [
"subtotal"
],
"type": "object"
},
"ref_786215eeb604b861c0d9": {
"description": "Bank Transfer Unreferenced Refund",
"summary": "Bank Transfer Unreferenced Refund",
"value": {
"customFields": [
{
"name": "yourCustomField",
"value": "abc123"
}
],
"customer": {
"contactMethods": [
{
"type": "email",
"value": "sarah.hopper@example.com"
}
],
"notificationLanguage": "en"
},
"order": {
"amount": 4999,
"currency": "USD",
"description": "Refund for order OrderRef6543",
"orderId": "OrderRef6543"
},
"processingTerminalId": "1234001",
"refundMethod": {
"accountNumber": "1234567890",
"accountType": "checking",
"nameOnAccount": "Sarah Hazel Hopper",
"routingNumber": "123456789",
"secCode": "web",
"type": "ach"
}
}
},
"ref_78f791814858a9abb9ae": {
"description": "Unique identifier that we assigned to the signature.",
"examples": {
"example": {
"value": "JDN4ILZB0T"
}
},
"in": "path",
"name": "signatureId",
"required": true,
"schema": {
"maxLength": 10,
"minLength": 10,
"type": "string"
}
},
"ref_78ffcfd2b99c05650b3c": {
"description": "Create an event subscription",
"summary": "Create event subscription",
"value": {
"enabled": true,
"eventTypes": [
"processingAccount.status.changed"
],
"metadata": {
"yourCustomField": "abc123"
},
"notifications": [
{
"secret": "aBcD1234eFgH5678iJkL9012mNoP3456",
"supportEmailAddress": "jane.doe@example.com",
"type": "webhook",
"uri": "https://my-server/notification/endpoint"
}
]
}
},
"ref_79086ca6df742d8600e5": {
"description": "Filter by payments that the processor settled on a specific date in the format **YYYY-MM-DD**.",
"examples": {
"example": {
"value": "2024-07-02"
}
},
"in": "query",
"name": "settlementDate",
"schema": {
"format": "date",
"type": "string"
}
},
"ref_7960ea97dd5f79b93ae4": {
"discriminator": {
"mapping": {
"email": "#/components/schemas/contactMethodEmail",
"fax": "#/components/schemas/contactMethodFax",
"mobile": "#/components/schemas/contactMethodMobile",
"phone": "#/components/schemas/contactMethodPhone"
},
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/x-devx-bundled/ref_d0e000150e9c1a86a589"
},
{
"$ref": "#/x-devx-bundled/ref_816ba69b485c9306f8ba"
},
{
"$ref": "#/x-devx-bundled/ref_8ebdd2030043664bacdb"
},
{
"$ref": "#/x-devx-bundled/ref_a2a6f05247335180858e"
}
]
},
"ref_7962c22afef6601443db": {
"description": "Object that contains information about the choice rate. We return this only if the value for offered was `true`.\n",
"properties": {
"amount": {
"description": "If the customer used a card to pay for the transaction, this value indicates the amount that our gateway added to the transaction amount. This value is in the currency’s lowest denomination, for example, cents. \n**Note:** Our gateway returns a value for **amount** only if the value for **applied** in the request is `true`.\n",
"example": 75,
"exclusiveMinimum": 0,
"format": "int64",
"type": "integer"
},
"applied": {
"default": false,
"description": "Indicates if the merchant applies a choice rate to the transaction amount. \n\nOur gateway adds a choice rate to the transaction when the merchant offers an alternative payment type, but the customer chooses to pay by card.\n",
"example": true,
"type": "boolean"
},
"rate": {
"description": "If the customer used a card to pay for the transaction, this value indicates the percentage that our gateway added to the transaction amount. \n**Note:** Our gateway returns a value for **rate** only if the value for **applied** in the request is `true`.\n",
"example": 2.5,
"exclusiveMinimum": 0,
"format": "double",
"maximum": 100,
"type": "number",
"x-fern-type-hint": "decimal"
}
},
"readOnly": true,
"required": [
"applied",
"rate",
"amount"
],
"type": "object"
},
"ref_7972062fc6cd36ac2403": {
"description": "Filter payments by tip.",
"examples": {
"example": {
"value": [
"noTip",
"prompted"
]
}
},
"in": "query",
"name": "tipMode",
"schema": {
"items": {
"enum": [
"noTip",
"prompted",
"adjusted"
],
"type": "string"
},
"type": "array"
}
},
"ref_7a089b36b6e5b195941a": {
"properties": {
"certificate": {
"description": "Certificate data encoded in hexadecimal format.",
"example": "ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234A",
"type": "string"
},
"exponent": {
"description": "Public key exponent for the certificate.",
"example": "03",
"type": "string"
},
"rid": {
"description": "Unique identifier of the payment application provider, also known as the Registered Application Provider Identifier (RID).",
"example": "A000000003",
"type": "string"
}
},
"type": "object"
},
"ref_7a1d6586d5d2a85d9ad7": {
"description": "Your request didn’t indicate which owner is the control prong or the authorized signatory. Set one owner as the control prong or the authorized signatory.",
"summary": "No control prong or authorized signatory",
"value": {
"detail": "Set one owner as the control prong or the authorized signatory",
"status": 400,
"title": "No control prong or authorized signatory",
"type": "https://docs.payroc.com/api/errors#no-control-prong-or-authorized-signatory"
}
},
"ref_7a93007b2f94a5098fc4": {
"properties": {
"card": {
"description": "Polymorphic object that contains payment details. \n\nThe value of the type parameter determines which variant you should use: \n-\t`card` - Payment card details\n-\t`singleUseToken` - Single-use token details\n",
"discriminator": {
"mapping": {
"card": "../../../common/schemas/transaction/payment-method-v1.yaml#/components/schemas/cardPayload",
"singleUseToken": "../../../common/schemas/transaction/payment-method-v1.yaml#/components/schemas/singleUseTokenPayload"
},
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/x-devx-bundled/ref_d7a78654a15a2c87ffaa"
},
{
"$ref": "#/x-devx-bundled/ref_9c8bcc4b28365a7b7f70"
}
],
"type": "object"
},
"currency": {
"$ref": "#/x-devx-bundled/ref_5c51a0e852c4baa940d0"
},
"customer": {
"$ref": "#/x-devx-bundled/ref_1674621e10fb2f321406"
},
"operator": {
"description": "Operator who requested the balance inquiry.",
"example": "Jane",
"maxLength": 50,
"minLength": 0,
"type": "string"
},
"processingTerminalId": {
"description": "Unique identifier that we assigned to the terminal.",
"example": "1234001",
"maxLength": 50,
"minLength": 4,
"type": "string"
}
},
"required": [
"card",
"currency",
"processingTerminalId"
],
"type": "object"
},
"ref_7ad5ac1e2a5096a96273": {
"description": "Valid request, but no records match the criteria.",
"summary": "No records found",
"value": {
"count": 0,
"data": [],
"hasMore": false,
"limit": 10,
"links": []
}
},
"ref_7b13ec5af2d2b1d9f8e7": {
"description": "URI reference to created resource.",
"examples": {
"example": {
"value": ""
}
},
"schema": {
"type": "string"
}
},
"ref_7b3c20091dcb1354d9ea": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_5ac2012c6011db9c1f88"
},
{
"properties": {
"breakdown": {
"$ref": "#/x-devx-bundled/ref_3ab18b72178aebd31e74"
}
},
"type": "object"
}
],
"type": "object"
},
"ref_7b54f337810177aab4ea": {
"description": "Filter payments by operator.",
"examples": {
"example": {
"value": "Jane"
}
},
"in": "query",
"name": "operator",
"schema": {
"maxLength": 50,
"minLength": 1,
"type": "string"
}
},
"ref_7b6a073264e2e400d69a": {
"description": "New merchant platform created",
"summary": "Create merchant platform",
"value": {
"business": {
"addresses": [
{
"address1": "1 Example Ave.",
"address2": "Example Address Line 2",
"address3": "Example Address Line 3",
"city": "Chicago",
"country": "US",
"postalCode": "60056",
"state": "Illinois",
"type": "legalAddress"
}
],
"contactMethods": [
{
"type": "email",
"value": "jane.doe@example.com"
}
],
"countryOfOperation": "US",
"name": "Example Corp",
"organizationType": "privateCorporation",
"taxId": "xxxxx6789"
},
"createdDate": "2024-07-02T12:00:00.000+00:00",
"lastModifiedDate": "2024-07-02T12:00:00.000+00:00",
"merchantPlatformId": "12345",
"processingAccounts": [
{
"addendums": [],
"doingBusinessAs": "Pizza Doe",
"link": {
"href": "https://api.payroc.com/v1/processing-accounts/38765",
"method": "get",
"rel": "processingAccount"
},
"processingAccountId": "38765",
"processor": "tsys",
"signature": {
"link": {
"href": "https://us.agreementexpress.net/mv2/viewer2.jsp?docId=00000000-0000-0000-0000-000000000000",
"method": "get",
"rel": "agreement"
},
"type": "requestedViaDirectLink"
},
"status": "pending"
}
]
}
},
"ref_7be0b0e9b61342d5719f": {
"description": "Filter by the customer's name.",
"examples": {
"example": {
"value": "Sarah%20Hazel%20Hopper"
}
},
"in": "query",
"name": "customerName",
"schema": {
"maxLength": 50,
"minLength": 1,
"type": "string"
}
},
"ref_7bef60d9d8959e45cc53": {
"description": "Filter results by the status of the refund.",
"examples": {
"example": {
"value": [
"ready"
]
}
},
"in": "query",
"name": "status",
"schema": {
"items": {
"enum": [
"ready",
"pending",
"declined",
"complete",
"admin",
"reversal",
"returned"
],
"type": "string"
},
"type": "array"
}
},
"ref_7bf22606967313df17c3": {
"description": "Create an event subscription",
"summary": "Create event subscription with metadata",
"value": {
"enabled": true,
"eventTypes": [
"processingAccount.status.changed"
],
"metadata": {
"responsiblePerson": "Jane Doe"
},
"notifications": [
{
"secret": "aBcD1234eFgH5678iJkL9012mNoP3456",
"supportEmailAddress": "jane.doe@example.com",
"type": "webhook",
"uri": "https://my-server/notification/endpoint"
}
]
}
},
"ref_7c70e6f6af9f83a14992": {
"description": "Adjust Payment",
"summary": "Adjust Payment",
"value": {
"card": {
"cardNumber": "453985******7062",
"entryMethod": "keyed",
"expiryDate": "1230",
"securityChecks": {
"avsResult": "Y",
"cvvResult": "M"
},
"type": "MasterCard"
},
"customFields": [
{
"name": "yourCustomField",
"value": "abc123"
}
],
"customer": {
"billingAddress": {
"address1": "1 Example Ave.",
"address2": "Example Address Line 2",
"address3": "Example Address Line 3",
"city": "Chicago",
"country": "US",
"postalCode": "60056",
"state": "Illinois"
},
"firstName": "Sarah",
"lastName": "Hopper",
"shippingAddress": {
"address": {
"address1": "1 Example Ave.",
"address2": "Example Address Line 2",
"address3": "Example Address Line 3",
"city": "Chicago",
"country": "US",
"postalCode": "60056",
"state": "Illinois"
},
"recipientName": "Sarah Hopper"
}
},
"order": {
"amount": 4999,
"currency": "USD",
"dateTime": "2024-07-02T15:30:00Z",
"description": "Example payment",
"orderId": "OrderRef6543"
},
"paymentId": "M2MJOG6O2Y",
"processingTerminalId": "1234001",
"supportedOperations": [
"capture",
"fullyReverse",
"partiallyReverse",
"incrementAuthorization",
"adjustTip",
"setAsPending"
],
"transactionResult": {
"approvalCode": "OK6",
"authorizedAmount": 4999,
"currency": "USD",
"responseCode": "A",
"responseMessage": "OK6",
"status": "ready",
"type": "sale"
}
}
},
"ref_7cad9e45de174d69d018": {
"description": "Move operation relocates a value from one location to another.",
"summary": "Update subscription: move",
"value": [
{
"from": "/customFields/0",
"op": "move",
"path": "/customFields/1"
}
]
},
"ref_7cc43f0fcc66c4cc40a2": {
"description": "Indicates how the merchant batches their transactions.",
"properties": {
"batchCloseTime": {
"description": "Time that the batch automatically closes.",
"example": "23:40",
"maxLength": 5,
"type": "string"
},
"batchCloseType": {
"description": "Indicates how the merchant batches their transactions. Send one of the following:\n - `automatic` - Terminal automatically closes the batch each day. To set the time the batch closes, send a value for the batchCloseTime parameter.\n - `manual` - Merchant manually closes their batch.\n",
"enum": [
"automatic"
],
"type": "string"
}
},
"required": [
"batchCloseType"
],
"title": "automatic",
"type": "object"
},
"ref_7d106756add78c1ab4a4": {
"in": "query",
"name": "status",
"schema": {
"description": "Filter terminal orders by status.",
"enum": [
"open",
"held",
"dispatched",
"fulfilled",
"cancelled"
],
"type": "string"
}
},
"ref_7dc8d292519db9a2cdd0": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_f9d963d00740bbe00c9e"
},
{
"properties": {
"data": {
"description": "Array of payments.",
"items": {
"$ref": "#/x-devx-bundled/ref_b78a8dc49545610d9bab"
},
"type": "array"
}
},
"type": "object"
}
],
"required": [
"count",
"data",
"hasMore",
"limit"
],
"type": "object"
},
"ref_7e5445e7e9561dc2e167": {
"description": "Secure token after we moved a custom field to a different position in the array.",
"summary": "Update secure token: move",
"value": {
"customFields": [
{
"name": "yourCustomField",
"value": "abc123"
}
],
"customer": {
"billingAddress": {
"address1": "1 Example Ave.",
"address2": "Example Address Line 2",
"address3": "Example Address Line 3",
"city": "Chicago",
"country": "US",
"postalCode": "60056",
"state": "Illinois"
},
"contactMethods": [
{
"type": "email",
"value": "sarah.hopper@example.com"
}
],
"dateOfBirth": "1990-07-15",
"firstName": "Sarah",
"lastName": "Hopper",
"notificationLanguage": "en",
"referenceNumber": "Customer-12",
"shippingAddress": {
"address": {
"address1": "1 Example Ave.",
"address2": "Example Address Line 2",
"address3": "Example Address Line 3",
"city": "Chicago",
"country": "US",
"postalCode": "60056",
"state": "Illinois"
},
"recipientName": "Sarah Hopper"
}
},
"mitAgreement": "unscheduled",
"processingTerminalId": "1234001",
"secureTokenId": "MREF_abc1de23-f4a5-6789-bcd0-12e345678901fa",
"source": {
"cardNumber": "453985******7062",
"cardholderName": "Sarah Hazel Hopper",
"expiryDate": "1230",
"type": "card"
},
"status": "notValidated",
"token": "296753123456"
}
},
"ref_7f2c023fc705cc690639": {
"description": "Object that contains information about the EMV tag.",
"properties": {
"hex": {
"description": "Hex code of the EMV tag.",
"example": "9F36",
"type": "string"
},
"value": {
"description": "Value of the EMV tag.",
"example": "001234",
"type": "string"
}
},
"required": [
"hex",
"value"
],
"type": "object"
},
"ref_7f6a2dd1c7bdccb0dcef": {
"description": "Payment link after we removed its custom labels.",
"summary": "Update payment link: remove",
"value": {
"assets": {
"paymentButton": "SUPPORT US\n",
"paymentUrl": "https://payments.payroc.com/merchant/pay-by-link?token=02ada211-ff51-4845-b0b5-e685aeb4b19d"
},
"authType": "sale",
"createdOn": "2024-09-24",
"merchantReference": "LinkRef6543",
"order": {
"charge": {
"currency": "USD",
"type": "prompt"
},
"description": "Pie It Forward charitable trust donation"
},
"paymentLinkId": "JZURRJBUPS",
"paymentMethods": [
"card",
"bankTransfer"
],
"status": "active",
"type": "multiUse"
}
},
"ref_7f6b21f25beeffad163f": {
"description": "Card Balance",
"summary": "Card Balance",
"value": {
"card": {
"cardDetails": {
"cardholderName": "Sarah Hazel Hopper",
"cardholderSignature": "a1b1c012345678a000b000c0012345d0e0f010g10061a031i001j071k0a1b0c1d0e1234567890120f1g0h1i0j1k0a1b0123451c012d0e1f0g1h0i1j123k1a1b1c1d1e1f1g123h1i1j1k1a1b1c1d1e1f1g123h123i1j123k12340a120a12345b012c0123012d0d1e0f1g0h1i123j123k10000",
"ebtDetails": {
"benefitCategory": "cash"
},
"entryMethod": "keyed",
"keyedData": {
"cardNumber": "4539858876047062",
"dataFormat": "plainText",
"device": {
"category": "attended",
"firmwareVersion": "PayDroid_8.1.0_Sagittarius_V11.1.11_20200904 V1.04.02_20210617",
"model": "paxA920",
"serialNumber": "1850010868"
},
"expiryDate": "1230"
},
"pinDetails": {
"dataFormat": "dukpt",
"pin": "0123456789abcdef",
"pinKsn": "0002152304aad1234561"
}
},
"type": "card"
},
"currency": "USD",
"operator": "Jane",
"processingTerminalId": "1234001"
}
},
"ref_80b2e9c15cc43d211038": {
"description": "Polymorphic object that indicates which form we should send to the merchant.\n\nThe value of the type parameter determines which variant you should use.\n",
"discriminator": {
"mapping": {
"cbdV1": "#/components/schemas/cbdV1AddendumEntry",
"cloverMerchantProcessingAmendmentV1": "#/components/schemas/cloverMerchantProcessingAmendmentAddendumEntry",
"donationsV1": "#/components/schemas/donationsV1AddendumEntry",
"firearmsV1": "#/components/schemas/firearmsV1AddendumEntry",
"installmentPaymentsV1": "#/components/schemas/installmentPaymentsV1AddendumEntry",
"moneyServicesV1": "#/components/schemas/moneyServicesV1AddendumEntry",
"pharmacyCnpComplianceV1": "#/components/schemas/pharmacyCnpComplianceV1AddendumEntry",
"rocGivingV1": "#/components/schemas/rocGivingV1AddendumEntry",
"telehealthV1": "#/components/schemas/telehealthV1AddendumEntry",
"tobaccoCnpV1": "#/components/schemas/tobaccoCnpV1AddendumEntry"
},
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/x-devx-bundled/ref_2f7f66a1f273572e1bdd"
},
{
"$ref": "#/x-devx-bundled/ref_c9b735bc493ecec06bc4"
},
{
"$ref": "#/x-devx-bundled/ref_1215d80bbdda31621a4a"
},
{
"$ref": "#/x-devx-bundled/ref_f407174aa45420924704"
},
{
"$ref": "#/x-devx-bundled/ref_970d626bd4d79f7f4937"
},
{
"$ref": "#/x-devx-bundled/ref_f3dcd626dda69114f30c"
},
{
"$ref": "#/x-devx-bundled/ref_c1684241f83e60954f72"
},
{
"$ref": "#/x-devx-bundled/ref_ccadaed26e46692724ee"
},
{
"$ref": "#/x-devx-bundled/ref_ca8783266abbc347a8fe"
},
{
"$ref": "#/x-devx-bundled/ref_e33323df86082a426f50"
}
]
},
"ref_80b86c970506c2b4c4c6": {
"properties": {
"expiresAt": {
"description": "Date and time that the token expires. We return this value in the [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
"example": "2024-07-02T16:00:00Z",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"operator": {
"description": "Operator who initiated the request.",
"example": "Jane",
"maxLength": 50,
"minLength": 0,
"type": "string",
"writeOnly": true
},
"paymentMethod": {
"description": "Polymorphic object that contains payment card details.",
"discriminator": {
"mapping": {
"card": "../../../common/schemas/transaction/payment-method-v1.yaml#/components/schemas/cardPayload"
},
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/x-devx-bundled/ref_d7a78654a15a2c87ffaa"
}
],
"type": "object",
"writeOnly": true
},
"processingTerminalId": {
"description": "Unique identifier that we assigned to the terminal.",
"example": "1234001",
"maxLength": 50,
"minLength": 4,
"readOnly": true,
"type": "string"
},
"source": {
"description": "Polymorphic object that contains the payment method that we tokenized. \n\nThe value of the type parameter determines which variant you should use: \n-\t`ach` - Automated Clearing House (ACH) details\n-\t`pad` - Pre-authorized debit (PAD) details\n-\t`card` - Payment card details\n",
"discriminator": {
"mapping": {
"ach": "../../../common/schemas/transaction/bank-account-v1.yaml#/components/schemas/achSource",
"card": "../../../common/schemas/transaction/card-v1.yaml#/components/schemas/cardSource",
"pad": "../../../common/schemas/transaction/bank-account-v1.yaml#/components/schemas/padSource"
},
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/x-devx-bundled/ref_f3a5b8382be8e3b73da0"
},
{
"$ref": "#/x-devx-bundled/ref_9aa3626bbdc7eb1b405e"
},
{
"$ref": "#/x-devx-bundled/ref_0476f87aaec738b51c8e"
}
],
"type": "object"
},
"token": {
"description": "Unique identifier that our gateway assigned to the payment details. \n**Note:** Merchants can use the token with other terminals linked to their account.\n",
"example": "fa2e9e51bc5265a33a5ca41449524d53d1def596ffd8c0904f222183a71a65cdb58835120a65196a48a6375abc4deafe2b7e948689ab9d6aba919e860f32e247",
"maxLength": 128,
"minLength": 128,
"readOnly": true,
"type": "string"
}
},
"required": [
"processingTerminalId",
"token",
"expiresAt",
"source"
],
"type": "object"
},
"ref_813e84ea1d7275ef40d3": {
"description": "Create a secure token using a single-use token that represents card details.",
"summary": "Secure token created from a single-use token",
"value": {
"customFields": [
{
"name": "yourCustomField",
"value": "abc123"
}
],
"customer": {
"billingAddress": {
"address1": "1 Example Ave.",
"address2": "Example Address Line 2",
"city": "Chicago",
"country": "US",
"postalCode": "60056",
"state": "Illinois"
},
"contactMethods": [
{
"type": "email",
"value": "sarah.hopper@example.com"
}
],
"dateOfBirth": "1990-07-15",
"firstName": "Sarah",
"lastName": "Hopper",
"notificationLanguage": "en",
"referenceNumber": "Customer-12"
},
"ipAddress": {
"type": "ipv4",
"value": "104.18.24.203"
},
"mitAgreement": "unscheduled",
"operator": "Jane",
"source": {
"token": "abcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890",
"type": "singleUseToken"
}
}
},
"ref_816ba69b485c9306f8ba": {
"properties": {
"type": {
"description": "Type of contact method.",
"enum": [
"phone"
],
"type": "string"
},
"value": {
"description": "Phone number.",
"example": "2025550164",
"maxLength": 15,
"type": "string"
}
},
"required": [
"type",
"value"
],
"title": "phone",
"type": "object"
},
"ref_8177505bb0d79df1e279": {
"description": "Adjust Refund",
"summary": "Adjust Refund",
"value": {
"adjustments": [
{
"contactMethods": [
{
"type": "mobile",
"value": "8445558735"
}
],
"type": "customer"
}
],
"operator": "Jane"
}
},
"ref_82411e2afe6edf10b1bd": {
"description": "Funding recipient that we created.",
"summary": "Create funding recipient",
"value": {
"address": {
"address1": "1 Example Ave.",
"address2": "Example Address Line 2",
"address3": "Example Address Line 3",
"city": "Chicago",
"country": "US",
"postalCode": "60056",
"state": "Illinois"
},
"contactMethods": [
{
"type": "email",
"value": "jane.doe@example.com"
},
{
"type": "phone",
"value": "2025550164"
}
],
"createdDate": "2024-07-02T15:30:00+00:00",
"doingBusinessAs": "Pizza Doe",
"fundingAccounts": [
{
"fundingAccountId": 123,
"link": {
"href": "https://api.payroc.com/v1/funding-accounts/123",
"method": "get",
"rel": "fundingAccount"
},
"status": "pending"
}
],
"lastModifiedDate": "2024-07-02T15:30:00+00:00",
"metadata": {
"yourCustomField": "abc123"
},
"owners": [
{
"link": {
"href": "https://api.payroc.com/v1/owners/4564",
"method": "get",
"rel": "owner"
},
"ownerId": 4564
}
],
"recipientId": 234,
"recipientType": "privateCorporation",
"status": "pending",
"taxId": "12-3456789"
}
},
"ref_82beb7666aa84da98879": {
"properties": {
"card": {
"$ref": "#/x-devx-bundled/ref_9ab219963d0de56b1c4a"
},
"operator": {
"description": "Operator who requested the balance inquiry.",
"example": "Jane",
"maxLength": 50,
"minLength": 0,
"type": "string"
},
"processingTerminalId": {
"description": "Unique identifier that we assigned to the terminal.",
"example": "1234001",
"maxLength": 50,
"minLength": 4,
"type": "string"
},
"responseCode": {
"description": "Response from the processor. \n- `A` - The processor approved the transaction. \n- `D` - The processor declined the transaction. \n- `E` - The processor received the transaction but will process the transaction later. \n- `P` - The processor authorized a portion of the original amount of the transaction. \n- `R` - The issuer declined the transaction and indicated that the customer should contact their bank. \n- `C` - The issuer declined the transaction and indicated that the merchant should keep the card as it was reported lost or stolen.\n",
"enum": [
"A",
"D",
"E",
"P",
"R",
"C"
],
"type": "string"
},
"responseMessage": {
"description": "Response description from the payment processor, for example, Refer to Card Issuer.",
"example": "Refer to Card Issuer",
"maxLength": 48,
"minLength": 1,
"type": "string"
}
},
"required": [
"card",
"processingTerminalId"
],
"type": "object"
},
"ref_830d113f4c1fff49df12": {
"description": "Object that contains information about the progress of the signature instruction.",
"summary": "Signature Instruction",
"value": {
"link": {
"href": "https://api.payroc.com/v1/signature-instructions/a37439165d134678a9100ebba3b29597",
"method": "GET",
"rel": "self"
},
"signatureInstructionId": "a37439165d134678a9100ebba3b29597",
"status": "inProgress"
}
},
"ref_8315546d83136ae702c6": {
"description": "Object that contains information about the total funds available to the merchant.",
"properties": {
"available": {
"description": "Amount of the funding balance that you can use in funding instructions. The value is in the currency's lowest denomination, for example, cents.",
"example": 69950,
"type": "integer"
},
"currency": {
"description": "Currency of the funding balance. We return a value of `USD`.",
"example": "USD",
"type": "string"
},
"funds": {
"description": "Total funding balance for the merchant, including pending amounts. The value is in the currency's lowest denomination, for example, cents.",
"example": 120000,
"type": "integer"
},
"merchantId": {
"description": "Unique identifier that the processor assigned to the merchant.",
"example": "4525644354",
"type": "string"
},
"pending": {
"description": "Amount of the funding balance that we have not yet sent to funding accounts. The value is in the currency's lowest denomination, for example, cents.",
"example": 50050,
"type": "integer"
}
},
"title": "merchant balance",
"type": "object"
},
"ref_837868fc01b96f4271ad": {
"description": "Result of verifying a customer's ACH bank account details.",
"summary": "ACH Bank Account Verification",
"value": {
"processingTerminalId": "1234001",
"verified": true
}
},
"ref_83bdb8c876489e7f56cc": {
"properties": {
"midQualRate": {
"$ref": "#/x-devx-bundled/ref_01f55c7b2d1709665555",
"description": "Object that contains the fees for a mid-qualified transaction."
},
"nonQualRate": {
"$ref": "#/x-devx-bundled/ref_01f55c7b2d1709665555",
"description": "Object that contains the fees for a non-qualified transaction."
},
"qualifiedRate": {
"$ref": "#/x-devx-bundled/ref_01f55c7b2d1709665555",
"description": "Object that contains the fees for a qualified transaction."
},
"type": {
"description": "Type of American Express program.",
"enum": [
"optBlue"
],
"type": "string"
}
},
"required": [
"type",
"qualifiedRate",
"midQualRate",
"nonQualRate"
],
"title": "optBlue",
"type": "object"
},
"ref_83c0763f601c84e43200": {
"description": "A Patch Test Operation.",
"properties": {
"op": {
"description": "`test` operation.",
"enum": [
"test"
],
"type": "string"
},
"path": {
"description": "Location of the value that you want to test.\nThe format for this value is JSON Pointer.\n",
"type": "string"
},
"value": {
"description": "Value that you want to compare with the current value at the path."
}
},
"required": [
"op",
"path",
"value"
],
"title": "Patch Test Operation",
"type": "object"
},
"ref_83c73ee340defd8c776d": {
"description": "A JSON Patch document as defined by RFC 6902.",
"example": [
{
"op": "add",
"path": "/a/b/c",
"value": [
"dog",
"cat"
]
},
{
"op": "remove",
"path": "/a/b/c"
},
{
"op": "replace",
"path": "/a/b/c",
"value": 42
},
{
"from": "/a/b/c",
"op": "move",
"path": "/a/b/d"
},
{
"from": "/a/b/d",
"op": "copy",
"path": "/a/b/e"
},
{
"op": "test",
"path": "/a/b/c",
"value": "dog"
}
],
"items": {
"$ref": "#/x-devx-bundled/ref_583e2413d26b1ecd5dc2"
},
"type": "array"
},
"ref_83e8963b8ade74847630": {
"properties": {
"detail": {
"description": "Explanation of the problem",
"example": "The payload submitted is too large.",
"type": "string"
},
"status": {
"description": "Http status code",
"example": 413,
"type": "integer"
},
"title": {
"description": "Short description of the issue.",
"example": "Payload too large",
"type": "string"
},
"type": {
"description": "URI reference identifying the problem type",
"example": "https://docs.payroc.com/api/errors#payload-too-large",
"type": "string"
}
},
"required": [
"type",
"title",
"status",
"detail"
],
"type": "object"
},
"ref_84983d869f962c56f303": {
"description": "One or more validation errors occurred",
"summary": "Bad request",
"value": {
"detail": "One or more validation errors occurred, see error section for more info",
"errors": [
{
"detail": "invalid value",
"message": "Expected integer, got abc",
"parameter": "before"
}
],
"status": 400,
"title": "Bad request",
"type": "https://docs.payroc.com/api/errors#bad-request"
}
},
"ref_8525343432030fe67b60": {
"properties": {
"transaction": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_109fe7e5f018de7ee04b"
}
],
"description": "Fee for each transaction. The value is in the currency's lowest denomination, for example, cents."
},
"type": {
"description": "Type of American Express program.",
"enum": [
"optBlue"
],
"type": "string"
},
"volume": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_d3797fc41828d98b6e34"
}
],
"description": "Percentage of the total transaction amount that the processor charges the merchant."
}
},
"required": [
"type",
"volume",
"transaction"
],
"title": "optBlue",
"type": "object"
},
"ref_86018b50b59b772c6408": {
"description": "Object that contains information about the total funds available in the card.",
"properties": {
"amount": {
"description": "Current balance of the account. This value is in the currency's lowest denomination, for example, cents.",
"example": 50000,
"format": "int64",
"type": "integer"
},
"benefitCategory": {
"description": "Indicates if the balance relates to an EBT Cash account or EBT SNAP account. \n- `cash` – EBT Cash \n- `foodStamp` – EBT SNAP\n",
"enum": [
"cash",
"foodStamp"
],
"example": "cash",
"type": "string"
},
"currency": {
"$ref": "#/x-devx-bundled/ref_5c51a0e852c4baa940d0"
}
},
"required": [
"amount",
"benefitCategory",
"currency"
],
"type": "object"
},
"ref_86226712795cd4aa0e79": {
"properties": {
"detail": {
"description": "Explanation of the problem",
"example": "Resource does not support the representation requested.",
"type": "string"
},
"status": {
"description": "Http status code",
"example": 406,
"type": "integer"
},
"title": {
"description": "Short description of the issue.",
"example": "Not acceptable",
"type": "string"
},
"type": {
"description": "URI reference identifying the problem type",
"example": "https://docs.payroc.com/api/errors#not-acceptable",
"type": "string"
}
},
"required": [
"type",
"title",
"status",
"detail"
],
"type": "object"
},
"ref_8625c84fd7dc6d8a6045": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_97210cf49ae4a58b7540"
},
{
"properties": {
"refundInstructionId": {
"description": "Unique identifier that we assigned to the refund instruction.",
"example": "a37439165d134678a9100ebba3b29597",
"maxLength": 36,
"minLength": 1,
"type": "string"
}
},
"type": "object"
}
],
"required": [
"refundInstructionId",
"status"
],
"type": "object"
},
"ref_864bd057ab1a89a2d83d": {
"description": "Object that contains information about Interchange Plus with three tiers.",
"properties": {
"fees": {
"description": "Object that contains information about the fees.",
"properties": {
"amex": {
"description": "Polymorphic object that contains fees for American Express transactions. \n\nThe value of the type field determines which variant you should use: \n-\t`optBlue` - Amex OptBlue pricing program.\n-\t`direct` - Amex Direct pricing program.\n",
"discriminator": {
"mapping": {
"direct": "#/components/schemas/interchangePlusTiered3AmexDirect",
"optBlue": "#/components/schemas/interchangePlusTiered3AmexOptBlue"
},
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/x-devx-bundled/ref_e97be8a248c59d0c9e2c"
},
{
"$ref": "#/x-devx-bundled/ref_6d1b41f7d5b044540bd5"
}
]
},
"electronicBenefitsTransfer": {
"$ref": "#/x-devx-bundled/ref_2c771c635a39c1d2ba57"
},
"enhancedInterchange": {
"$ref": "#/x-devx-bundled/ref_c81000a305abe78faab1"
},
"mastercardVisaDiscover": {
"$ref": "#/x-devx-bundled/ref_eb68f2c28371d61b1260",
"description": "Object that contains the fees for Mastercard, Visa, and Discover transactions."
},
"pinDebit": {
"$ref": "#/x-devx-bundled/ref_39ea196745f35c0c62a3"
},
"specialityCards": {
"$ref": "#/x-devx-bundled/ref_ca2b35d2127e00c3b179"
}
},
"required": [
"mastercardVisaDiscover"
],
"type": "object"
},
"planType": {
"description": "Type of processing plan.",
"enum": [
"interchangePlusTiered3"
],
"type": "string"
}
},
"required": [
"planType",
"fees"
],
"title": "Interchange Plus with three tiers",
"type": "object"
},
"ref_86ce204cda364b21fc2a": {
"description": "Account update request by single use token",
"summary": "Update account details",
"value": {
"token": "abcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890",
"type": "singleUseToken"
}
},
"ref_874b864c557792343f79": {
"description": "Retrieve a merchant platform.",
"summary": "Retrieve merchant platform",
"value": {
"business": {
"addresses": [
{
"address1": "1 Example Ave.",
"address2": "Example Address Line 2",
"address3": "Example Address Line 3",
"city": "Chicago",
"country": "US",
"postalCode": "60056",
"state": "Illinois",
"type": "legalAddress"
}
],
"contactMethods": [
{
"type": "email",
"value": "jane.doe@example.com"
}
],
"countryOfOperation": "US",
"name": "Example Corp",
"organizationType": "privateCorporation",
"taxId": "xxxxx6789"
},
"createdDate": "2024-07-02T12:00:00.000+00:00",
"lastModifiedDate": "2024-07-02T12:00:00.000+00:00",
"links": [],
"merchantPlatformId": "12345",
"metadata": {
"customerId": "2345"
},
"processingAccounts": [
{
"addendums": [],
"doingBusinessAs": "Pizza Doe",
"link": {
"href": "https://api.payroc.com/v1/processing-accounts/38765",
"method": "get",
"rel": "processingAccount"
},
"processingAccountId": "38765",
"processor": "tsys",
"signature": {
"link": {
"href": "https://us.agreementexpress.net/mv2/viewer2.jsp?docId=00000000-0000-0000-0000-000000000000",
"method": "get",
"rel": "agreement"
},
"type": "requestedViaDirectLink"
},
"status": "approved"
}
]
}
},
"ref_886ee4f1d8c61cf8a614": {
"description": "Move operation relocates a value from one location to another.",
"summary": "Update payment link: move",
"value": [
{
"from": "/customLabels/0",
"op": "move",
"path": "/customLabels/1"
}
]
},
"ref_8896a0cf9b51c598f769": {
"description": "Filter results by the paymentLinkId.",
"examples": {
"example": {
"value": "JZURRJBUPS"
}
},
"in": "query",
"name": "paymentLinkId",
"schema": {
"maxLength": 10,
"minLength": 10,
"type": "string"
}
},
"ref_88af1998c4067fca5d3d": {
"description": "Unique identifier of the dispute.",
"examples": {
"example": {
"value": 12345
}
},
"in": "path",
"name": "disputeId",
"required": true,
"schema": {
"type": "integer"
}
},
"ref_88faa6e8a02090e6f7f0": {
"description": "Create a merchant platform with the Roc Giving Addendum appended to the Merchant Processing Agreement.",
"summary": "Create a merchant platform with Roc Giving Addendum",
"value": {
"business": {
"addresses": [
{
"address1": "1 Example Ave.",
"address2": "Example Address Line 2",
"address3": "Example Address Line 3",
"city": "Chicago",
"country": "US",
"postalCode": "60056",
"state": "Illinois",
"type": "legalAddress"
}
],
"contactMethods": [
{
"type": "email",
"value": "jane.doe@example.com"
}
],
"countryOfOperation": "US",
"name": "Example Corp",
"organizationType": "privateCorporation",
"taxId": "xxxxx6789"
},
"createdDate": "2024-07-02T12:00:00.000Z",
"lastModifiedDate": "2024-07-02T12:00:00.000Z",
"merchantPlatformId": "12347",
"processingAccounts": [
{
"addendums": [
{
"accountAdminContact": {
"emailAddress": "jane.doe@example.com",
"firstName": "Jane",
"lastName": "Doe",
"phone": "2025550164"
},
"autoCloseTime": "23:40",
"donorSupportPercentage": 2.5,
"plan": "basic",
"type": "rocGivingV1"
}
],
"doingBusinessAs": "Pizza Doe",
"link": {
"href": "https://api.payroc.com/v1/processing-accounts/38768",
"method": "get",
"rel": "processingAccount"
},
"processingAccountId": "38768",
"processor": "tsys",
"signature": {
"link": {
"href": "https://us.agreementexpress.net/mv2/viewer2.jsp?docId=00000000-0000-0000-0000-000000000000",
"method": "get",
"rel": "agreement"
},
"type": "requestedViaDirectLink"
},
"status": "pending"
}
]
}
},
"ref_892cf73eb4222b64e3e5": {
"properties": {
"addendums": {
"description": "Array of polymorphic addendumEntry objects that indicate the additional forms that we should send with the Merchant Processing Agreement (MPA).\n\nThe value of the type parameter determines which variant you should use:\n\n- `installmentPaymentsV1` - Send this form if the merchant offers installment payments, loans, or leases.\n- `moneyServicesV1` - Send this form if the merchant offers money services, for example, traveler's checks.\n- `telehealthV1` - Send this form if the merchant provides telehealth services.\n- `firearmsV1` - Send this form if the merchant sells firearms.\n- `pharmacyCnpComplianceV1` - Send this form if the merchant is a pharmacy that accepts card-not-present (CNP) transactions.\n- `cbdV1` - Send this form if the merchant sells any of the following products:\n - CBD products\n - Synthetic THC or Cannabis\n - HHC\n - Kratom\n - Tianeptine\n - Delta 8/9/10/0 THC products\n- `tobaccoCnpV1` - Send this form if the merchant sells tobacco products and accepts CNP transactions.\n- `donationsV1` - Send this form if the merchant accepts donations.\n- `cloverMerchantProcessingAmendmentV1` - Send this form if the merchant requires Clover equipment.\n- `rocGivingV1` - Send this form if the merchant uses Roc Giving.\n",
"items": {
"$ref": "#/x-devx-bundled/ref_80b2e9c15cc43d211038"
},
"type": "array"
},
"address": {
"description": "Polymorphic object that contains address information for the processing account.",
"oneOf": [
{
"$ref": "#/x-devx-bundled/ref_51baeef3d490d18ab4d6"
}
],
"type": "object"
},
"businessStartDate": {
"description": "Date that the business was established. The format of the value is **YYYY-MM-DD**.",
"example": "2020-01-01",
"format": "date",
"type": "string"
},
"businessType": {
"description": "Type of business.",
"enum": [
"retail",
"restaurant",
"internet",
"moto",
"lodging",
"notForProfit"
],
"example": "restaurant",
"type": "string"
},
"categoryCode": {
"description": "Merchant Category Code (MCC) for the type of business.",
"example": 5999,
"format": "int32",
"maxLength": 4,
"type": "integer"
},
"contactMethods": {
"description": "Array of polymorphic objects, which contain contact information. \n\n**Note:** You must provide an email address.\n\nThe value of the type parameter determines which variant you should use: \n-\t`email` - Email address \n-\t`phone` - Phone number\n-\t`mobile` - Mobile number\n-\t`fax` - Fax number.\n",
"items": {
"$ref": "#/x-devx-bundled/ref_7960ea97dd5f79b93ae4"
},
"minItems": 1,
"type": "array"
},
"contacts": {
"description": "Array of contact objects.",
"items": {
"$ref": "#/x-devx-bundled/ref_df1dbb6190ccee505722"
},
"type": "array"
},
"doingBusinessAs": {
"description": "Trading name of the business.",
"example": "Pizza Doe",
"maxLength": 100,
"type": "string"
},
"funding": {
"$ref": "#/x-devx-bundled/ref_d6d993b77cf7f8d82fb7"
},
"merchandiseOrServiceSold": {
"description": "Description of the services or merchandise sold by the business.",
"example": "Pizza",
"maxLength": 125,
"type": "string"
},
"metadata": {
"additionalProperties": {
"type": "string"
},
"description": "Object that you can send to include custom data in the request. For more information about how to use metadata, go to [Metadata](https://docs.payroc.com/api/metadata).",
"example": {
"customerId": "2345"
},
"type": "object"
},
"owners": {
"description": "Collection of individuals that are responsible for a processing account. When you create a processing account, you must indicate at least one owner as either of the following: \n\n- **Control prong** - An individual who has a significant equity stake in the business and can make decisions for the processing account. You can add only one control prong to a processing account. \n- **Authorized signatory** - An individual who doesn't have an equity stake in the business but can make decisions for the processing account.\n",
"items": {
"$ref": "#/x-devx-bundled/ref_d8267a8278910c858c37"
},
"minItems": 1,
"type": "array"
},
"pricing": {
"$ref": "#/x-devx-bundled/ref_60b8f9f9f668e3f361c4"
},
"processing": {
"$ref": "#/x-devx-bundled/ref_8e9a7990c0c3fd2327dc"
},
"processingAccountId": {
"description": "Unique identifier of the processing account.",
"example": "38765",
"readOnly": true,
"type": "string"
},
"processor": {
"$ref": "#/x-devx-bundled/ref_173edad0bb113303f045"
},
"signature": {
"$ref": "#/x-devx-bundled/ref_14920c978ef4664c1ec1"
},
"timezone": {
"$ref": "#/x-devx-bundled/ref_f6e10cfc48a2f2c041b3"
},
"website": {
"description": "Website address of the business.",
"example": "www.example.com",
"maxLength": 128,
"type": "string"
}
},
"required": [
"doingBusinessAs",
"owners",
"merchandiseOrServiceSold",
"businessStartDate",
"timezone",
"address",
"contactMethods",
"processing",
"funding",
"pricing",
"signature"
],
"type": "object"
},
"ref_89dbf015744cfdf80ef7": {
"description": "Subscription after the test operation. A test operation asserts a value, so the subscription doesn't change.\n",
"summary": "Update subscription: test",
"value": {
"currency": "USD",
"currentState": {
"nextDueDate": "2024-08-02",
"outstandingInvoices": 3,
"paidInvoices": 0,
"status": "active"
},
"customFields": [
{
"name": "yourCustomField",
"value": "abc123"
}
],
"description": "Premium Club subscription",
"endDate": "2025-07-01",
"frequency": "monthly",
"length": 12,
"name": "Premium Club",
"pauseCollectionFor": 0,
"paymentPlan": {
"link": {
"href": "https://api.payroc.com/v1/processing-terminals/1234001/payment-plans/PlanRef8765",
"method": "GET",
"rel": "self"
},
"name": "Monthly Premium Club subscription",
"paymentPlanId": "PlanRef8765"
},
"processingTerminalId": "1234001",
"recurringOrder": {
"amount": 4999,
"breakdown": {
"subtotal": 4347,
"surcharge": {
"amount": 217,
"percentage": 5
},
"taxes": [
{
"name": "Sales Tax",
"rate": 5
}
]
},
"description": "Premium Club subscription"
},
"secureToken": {
"customerName": "Sarah Hazel Hopper",
"link": {
"href": "https://api.payroc.com/v1/processing-terminals/1234001/secure-tokens/MREF_abc1de23-f4a5-6789-bcd0-12e345678901fa",
"method": "GET",
"rel": "self"
},
"secureTokenId": "MREF_abc1de23-f4a5-6789-bcd0-12e345678901fa",
"status": "notValidated",
"token": "296753123456"
},
"setupOrder": {
"amount": 4999,
"breakdown": {
"subtotal": 4347,
"surcharge": {
"amount": 217,
"percentage": 5
},
"taxes": [
{
"name": "Sales Tax",
"rate": 5
}
]
},
"description": "Initial setup fee for Premium Club subscription",
"orderId": "OrderRef6543"
},
"startDate": "2024-07-02",
"subscriptionId": "SubRef7654",
"type": "automatic"
}
},
"ref_89fcab83adb061ef2d38": {
"description": "Subscription with convenience fee",
"summary": "Subscription with convenience fee",
"value": {
"currency": "USD",
"currentState": {
"nextDueDate": "2024-08-02",
"outstandingInvoices": 3,
"paidInvoices": 0,
"status": "active"
},
"customFields": [
{
"name": "yourCustomField",
"value": "abc123"
}
],
"description": "Premium Club subscription",
"endDate": "2025-07-01",
"frequency": "monthly",
"length": 12,
"name": "Premium Club",
"pauseCollectionFor": 0,
"paymentPlan": {
"link": {
"href": "https://api.payroc.com/v1/processing-terminals/1234001/payment-plans/PlanRef8765",
"method": "GET",
"rel": "self"
},
"name": "Monthly Premium Club subscription",
"paymentPlanId": "PlanRef8765"
},
"processingTerminalId": "1234001",
"recurringOrder": {
"amount": 4999,
"breakdown": {
"convenienceFee": {
"amount": 217
},
"subtotal": 4347,
"taxes": [
{
"name": "Sales Tax",
"rate": 5
}
]
},
"description": "Premium Club subscription"
},
"secureToken": {
"customerName": "Sarah Hazel Hopper",
"link": {
"href": "https://api.payroc.com/v1/processing-terminals/1234001/secure-tokens/MREF_abc1de23-f4a5-6789-bcd0-12e345678901fa",
"method": "GET",
"rel": "self"
},
"secureTokenId": "MREF_abc1de23-f4a5-6789-bcd0-12e345678901fa",
"status": "notValidated",
"token": "296753123456"
},
"setupOrder": {
"amount": 4999,
"breakdown": {
"convenienceFee": {
"amount": 217
},
"subtotal": 4347,
"taxes": [
{
"name": "Sales Tax",
"rate": 5
}
]
},
"description": "Initial setup fee for Premium Club subscription",
"orderId": "OrderRef6543"
},
"startDate": "2024-07-02",
"subscriptionId": "SubRef7654",
"type": "automatic"
}
},
"ref_8a064dce5871f699f344": {
"description": "We couldn’t resend the email because the merchant already signed the contract.",
"summary": "Contract already signed",
"value": {
"detail": "The merchant has already signed the contract.",
"status": 400,
"title": "Contract already signed",
"type": "https://docs.payroc.com/api/errors#contract-already-signed"
}
},
"ref_8a0780be1b8961295131": {
"description": "Foreign exchange rate for the transaction.",
"properties": {
"baseAmount": {
"description": "Total amount of the transaction in the local currency. The value is in the currency’s lowest denomination, for example, cents.",
"exclusiveMinimum": 0,
"format": "int64",
"type": "integer"
},
"baseCurrency": {
"$ref": "#/x-devx-bundled/ref_5c51a0e852c4baa940d0"
},
"cardInfo": {
"$ref": "#/x-devx-bundled/ref_080cc40e493d508bee9e"
},
"dccOffer": {
"$ref": "#/x-devx-bundled/ref_69d0c405bed69b717603"
},
"inquiryResult": {
"$ref": "#/x-devx-bundled/ref_a637d755ff757609de08"
},
"operator": {
"description": "Operator who ran the transaction.",
"example": "Jane",
"maxLength": 50,
"minLength": 0,
"type": "string"
},
"processingTerminalId": {
"description": "Unique identifier that we assigned to the terminal.",
"example": "1234001",
"maxLength": 50,
"minLength": 4,
"type": "string"
}
},
"required": [
"baseAmount",
"baseCurrency",
"cardInfo",
"inquiryResult",
"processingTerminalId"
],
"type": "object"
},
"ref_8a40ea359f0502198da9": {
"description": "Object that contains information about a refund.",
"properties": {
"amount": {
"description": "Amount of the refund. This value is in the currency’s lowest denomination, for example, cents.",
"example": 4999,
"format": "int64",
"type": "integer"
},
"currency": {
"$ref": "#/x-devx-bundled/ref_5c51a0e852c4baa940d0"
},
"dateTime": {
"description": "Date and time that the refund was processed.",
"example": "2024-07-14T12:25:00Z",
"format": "date-time",
"type": "string"
},
"link": {
"$ref": "#/x-devx-bundled/ref_27e6d0e095fb23cba669"
},
"refundId": {
"description": "Unique identifier of the refund.",
"example": "CD3HN88U9F",
"maxLength": 10,
"minLength": 10,
"type": "string"
},
"responseCode": {
"description": "Response from the processor. \n- `A` - The processor approved the transaction. \n- `D` - The processor declined the transaction. \n- `E` - The processor received the transaction but will process the transaction later. \n- `P` - The processor authorized a portion of the original amount of the transaction. \n- `R` - The issuer declined the transaction and indicated that the customer should contact their bank. \n- `C` - The issuer declined the transaction and indicated that the merchant should keep the card as it was reported lost or stolen.\n",
"enum": [
"A",
"D",
"E",
"P",
"R",
"C"
],
"example": "A",
"type": "string"
},
"responseMessage": {
"description": "Description of the response from the processor.",
"example": "Transaction refunded",
"maxLength": 48,
"minLength": 1,
"type": "string"
},
"status": {
"description": "Current status of the refund.",
"enum": [
"ready",
"pending",
"declined",
"complete",
"referral",
"pickup",
"reversal",
"returned",
"admin",
"expired",
"accepted"
],
"example": "complete",
"type": "string"
}
},
"required": [
"amount",
"currency",
"dateTime",
"refundId",
"status",
"responseCode",
"responseMessage"
],
"type": "object"
},
"ref_8a84ce450c6452ba8861": {
"description": "Object that contains information about the secure token that represents the customer’s payment details.",
"properties": {
"accountType": {
"description": "Indicates the customer’s account type. \n\n**Note:** Send a value for accountType only if the secure token represents bank account details.\n",
"enum": [
"checking",
"savings"
],
"example": "checking",
"type": "string"
},
"secCode": {
"description": "Indicates how the customer authorized the ACH transaction. Send one of the following values:\n\n- `web` – Online transaction.\n- `tel` – Telephone transaction.\n- `ccd` – Corporate credit or debit entry for a business bank account.\n- `ppd` – Pre-arranged transaction.\n\n**Note:** This field is mandatory when the secure token represents ACH bank account details.\n",
"enum": [
"web",
"tel",
"ccd",
"ppd"
],
"example": "web",
"type": "string"
},
"token": {
"description": "Unique token that the gateway assigned to the payment details.",
"example": "1234567890123456789",
"maxLength": 19,
"minLength": 12,
"type": "string"
},
"type": {
"description": "Method that the terminal used to take the payment.",
"enum": [
"secureToken"
],
"example": "secureToken",
"type": "string"
}
},
"required": [
"type",
"token"
],
"title": "secureToken",
"type": "object",
"writeOnly": true
},
"ref_8ab4f66b5429b2e9e8c8": {
"description": "Indicates how authorized transactions will be batched for settlement",
"properties": {
"batchCloseType": {
"description": "Indicates whether batch settlement of authorized transactions are automatically or manually closed",
"enum": [
"manual"
],
"type": "string"
}
},
"required": [
"batchCloseType"
],
"title": "manual",
"type": "object"
},
"ref_8ad7d0d31ac1c6e3fc04": {
"description": "No results found",
"summary": "No results found",
"value": {
"count": 0,
"data": [],
"hasMore": false,
"limit": 10,
"links": []
}
},
"ref_8ba1d56e097ef6db192c": {
"properties": {
"channel": {
"description": "Channel that the merchant used to receive the payment details.",
"enum": [
"pos",
"web",
"moto"
],
"example": "web",
"type": "string"
},
"operator": {
"description": "Operator who initiated the request.",
"example": "Jane",
"maxLength": 50,
"minLength": 1,
"type": "string"
},
"source": {
"description": "Polymorphic object that contains the payment method to tokenize. \n\nThe value of the type parameter determines which variant you should use: \n-\t`ach` - Automated Clearing House (ACH) details\n-\t`pad` - Pre-authorized debit (PAD) details\n-\t`card` - Payment card details\n",
"discriminator": {
"mapping": {
"ach": "../../../common/schemas/transaction/payment-method-v1.yaml#/components/schemas/achPayload",
"card": "../../../common/schemas/transaction/payment-method-v1.yaml#/components/schemas/cardPayload",
"pad": "../../../common/schemas/transaction/payment-method-v1.yaml#/components/schemas/padPayload"
},
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/x-devx-bundled/ref_c799d35ea53644eec4e6"
},
{
"$ref": "#/x-devx-bundled/ref_d8468a3993ad87f32e78"
},
{
"$ref": "#/x-devx-bundled/ref_d7a78654a15a2c87ffaa"
}
],
"type": "object"
}
},
"required": [
"channel",
"source"
],
"type": "object"
},
"ref_8beaaf9977f01c51e61e": {
"description": "Copy operation duplicates a value from one location to another.",
"summary": "Update subscription: copy",
"value": [
{
"from": "/name",
"op": "copy",
"path": "/description"
}
]
},
"ref_8ccc8aafcd9c8e176b79": {
"description": "Object that contains the customer's account details.",
"properties": {
"accountNumber": {
"description": "Customer's bank account number. We mask all digits except the last four digits.",
"example": "1234567890",
"maxLength": 12,
"minLength": 7,
"type": "string"
},
"institutionNumber": {
"description": "Three-digit code that represents the customer's bank.",
"example": "543",
"maxLength": 3,
"minLength": 3,
"type": "string"
},
"nameOnAccount": {
"description": "Customer's name.",
"example": "Sarah Hazel Hopper",
"maxLength": 29,
"minLength": 1,
"type": "string"
},
"secureToken": {
"$ref": "#/x-devx-bundled/ref_0af00846def2cd349cd2"
},
"transitNumber": {
"description": "Five-digit code that represents the customer's banking branch.",
"example": "76543",
"maxLength": 5,
"minLength": 5,
"type": "string"
},
"type": {
"enum": [
"pad"
],
"example": "pad",
"type": "string"
}
},
"required": [
"accountNumber",
"institutionNumber",
"nameOnAccount",
"transitNumber",
"type"
],
"title": "pad",
"type": "object"
},
"ref_8ce0797d4dd986ab9a89": {
"summary": "Paginated ACH deposit fees",
"value": {
"count": 1,
"data": [
{
"achDeposit": {
"achDepositId": 99,
"link": {
"href": "https://api.payroc.com/v1/ach-deposits/99?merchantId=4525644354",
"method": "get",
"rel": "achDeposit"
}
},
"adjustmentDate": "2024-07-02",
"amount": 500,
"associationDate": "2024-07-02",
"description": "ACH Deposit Fee",
"merchant": {
"doingBusinessAs": "Pizza Doe",
"link": {
"href": "https://api.payroc.com/v1/processing-accounts/38765",
"method": "get",
"rel": "processingAccount"
},
"merchantId": "4525644354",
"processingAccountId": 38765
}
}
],
"hasMore": false,
"limit": 2,
"links": [
{
"href": "https://api.payroc.com/v1/ach-deposit-fees?before=65&limit=2&date=2024-07-02",
"method": "get",
"rel": "previous"
}
]
}
},
"ref_8db6575413e6e6ff617a": {
"description": "Upload a file attachment",
"summary": "Upload Attachment",
"value": {
"attachmentId": "15387",
"contentType": "application/pdf",
"createdDate": "2025-09-18T10:19:18.522Z",
"description": "Passport for Jane Doe",
"entity": {
"id": "2585",
"type": "processingAccount"
},
"fileName": "JaneDoePassport.pdf",
"lastModifiedDate": "2025-09-18T10:19:18.522Z",
"metadata": {
"passportId": "123456789"
},
"type": "personalIdentification",
"uploadStatus": "accepted"
}
},
"ref_8db992b7e92107370c75": {
"description": "Object that contains information about the tip amount of a transaction.",
"properties": {
"tip": {
"$ref": "#/x-devx-bundled/ref_90d04e11e8f10457c837"
}
},
"type": "object"
},
"ref_8dc1969fd3fabc37aa31": {
"description": "Filter event subscriptions by an event type. For a list of event types, go to [Events List](https://docs.payroc.com/knowledge/events/events-list).",
"examples": {
"example": {
"value": "processingAccount.status.changed"
}
},
"in": "query",
"name": "event",
"schema": {
"type": "string"
}
},
"ref_8dedab7d683c1741ba7a": {
"description": "Object that contains information about Interchange Plus.",
"properties": {
"fees": {
"description": "Object that contains information about the fees.",
"properties": {
"amex": {
"description": "Polymorphic object that contains fees for American Express transactions. \n\nThe value of the type field determines which variant you should use: \n-\t`optBlue` - Amex OptBlue pricing program.\n-\t`direct` - Amex Direct pricing program.\n",
"discriminator": {
"mapping": {
"direct": "#/components/schemas/interchangePlusAmexDirect",
"optBlue": "#/components/schemas/interchangePlusAmexOptBlue"
},
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/x-devx-bundled/ref_8525343432030fe67b60"
},
{
"$ref": "#/x-devx-bundled/ref_2b34b6058854a07b6289"
}
]
},
"electronicBenefitsTransfer": {
"$ref": "#/x-devx-bundled/ref_2c771c635a39c1d2ba57"
},
"enhancedInterchange": {
"$ref": "#/x-devx-bundled/ref_c81000a305abe78faab1"
},
"mastercardVisaDiscover": {
"$ref": "#/x-devx-bundled/ref_01f55c7b2d1709665555",
"description": "Object that contains the fees for Mastercard, Visa, and Discover transactions."
},
"pinDebit": {
"$ref": "#/x-devx-bundled/ref_39ea196745f35c0c62a3"
},
"specialityCards": {
"$ref": "#/x-devx-bundled/ref_ca2b35d2127e00c3b179"
}
},
"required": [
"mastercardVisaDiscover"
],
"type": "object"
},
"planType": {
"description": "Type of processing plan.",
"enum": [
"interchangePlus"
],
"type": "string"
}
},
"required": [
"planType",
"fees"
],
"title": "Interchange Plus Plan",
"type": "object"
},
"ref_8e1b104378f74dcbbd14": {
"description": "Filter results by the status of the payment link. Send a value of active, completed,deactived, or expired.",
"examples": {
"example": {
"value": "active"
}
},
"in": "query",
"name": "status",
"schema": {
"enum": [
"active",
"completed",
"deactivated",
"expired"
],
"type": "string"
}
},
"ref_8e9a7990c0c3fd2327dc": {
"description": "Object that contains information about how we process transactions for the account.",
"properties": {
"ach": {
"description": "Object that contains information about Automated Clearing House (ACH) transactions.",
"properties": {
"estimatedMonthlyTransactions": {
"description": "Estimated maximum number of transactions that the merchant will process in a month.",
"example": 3000,
"type": "integer"
},
"limits": {
"description": "Object that contains information about transaction limits for the processing account.",
"properties": {
"dailyDeposit": {
"description": "Maximum amount of total transactions allowed per day. The value is in the currency's lowest denomination, for example, cents.",
"example": 200000,
"type": "integer"
},
"monthlyDeposit": {
"description": "Maximum amount of total transactions allowed per month. The value is in the currency's lowest denomination, for example, cents.",
"example": 6000000,
"type": "integer"
},
"singleTransaction": {
"description": "Maximum amount allowed for a single debit or credit transaction. The value is in the currency's lowest denomination, for example, cents.",
"example": 10000,
"type": "integer"
}
},
"required": [
"singleTransaction",
"dailyDeposit",
"monthlyDeposit"
],
"type": "object"
},
"naics": {
"description": "North American Industry Classification System (NAICS) code.",
"example": "5812",
"maxLength": 6,
"type": "string"
},
"previouslyTerminatedForAch": {
"default": false,
"description": "Indicates if the business or its principals were previously turned down for ACH processing.",
"example": false,
"type": "boolean"
},
"refunds": {
"description": "Object that contains information about the ACH refund policy for the processing account.",
"properties": {
"refundPolicyUrl": {
"description": "URL of the written refund policy.",
"example": "www.example.com/refund-poilcy-url",
"maxLength": 2000,
"type": "string"
},
"writtenRefundPolicy": {
"default": false,
"description": "Indicates if the business has a written refund policy.",
"example": true,
"type": "boolean"
}
},
"required": [
"writtenRefundPolicy"
],
"type": "object"
},
"transactionTypes": {
"description": "List of transaction types that the processing account supports.",
"example": [
"prearrangedPayment",
"other"
],
"items": {
"enum": [
"prearrangedPayment",
"corpCashDisbursement",
"telephoneInitiatedPayment",
"webInitiatedPayment",
"other"
],
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"transactionTypesOther": {
"description": "If you send a value of `other` for transactionTypes, provide a list of the supported transaction types.",
"example": "anotherTransactionType",
"maxLength": 100,
"type": "string"
}
},
"required": [
"refunds",
"estimatedMonthlyTransactions",
"limits"
],
"type": "object"
},
"cardAcceptance": {
"description": "Object that contains information about the types of cards that the processing account accepts.",
"properties": {
"cardsAccepted": {
"default": [
"visa",
"mastercard",
"discover",
"amexOptBlue"
],
"description": "List of card types the merchant accepts.",
"example": [
"visa",
"mastercard"
],
"items": {
"enum": [
"visa",
"mastercard",
"discover",
"amexOptBlue"
],
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"debitOnly": {
"default": false,
"description": "Indicates if the merchant accepts only debit cards.",
"example": false,
"type": "boolean"
},
"hsaFsa": {
"default": false,
"description": "Indicates if the merchant accepts health savings account (HSA) and flexible spending account (FSA) cards.",
"example": false,
"type": "boolean"
},
"specialityCards": {
"description": "Information about the speciality cards that the merchant accepts.",
"properties": {
"americanExpressDirect": {
"description": "Object that indicates if the merchant accepts American Express Direct cards and contains the merchant’s American Express merchant number.",
"properties": {
"enabled": {
"default": false,
"description": "Indicates if the merchant accepts American Express Direct.",
"example": true,
"type": "boolean"
},
"merchantNumber": {
"description": "If the merchant accepts American Express Direct, provide their American Express merchant number.",
"example": "abc1234567",
"maxLength": 100,
"type": "string"
}
},
"type": "object"
},
"electronicBenefitsTransfer": {
"description": "Object that indicates if the merchant accepts Electronic Benefits Transfer (EBT) cards and contains the merchant’s Food and Nutrition Services (FNS) number.",
"properties": {
"enabled": {
"default": false,
"description": "Indicates if the merchant accepts EBT.",
"example": true,
"type": "boolean"
},
"fnsNumber": {
"description": "If the merchant accepts EBT, provide their FNS number.",
"example": "abc1234",
"maxLength": 7,
"type": "string"
}
},
"type": "object"
},
"other": {
"description": "Object that contains information about other speciality cards that the merchant accepts.",
"properties": {
"fleetMerchantId": {
"description": "If the merchant accepts Fleet, provide their Fleet merchant ID.",
"example": "abc1234567",
"maxLength": 50,
"type": "string"
},
"voyagerMerchantId": {
"description": "If the merchant accepts Voyager, provide their Voyager merchant ID.",
"example": "abc1234567",
"maxLength": 50,
"type": "string"
},
"wexMerchantNumber": {
"description": "If the merchant accepts WEX, provide their WEX merchant number.",
"example": "abc1234567",
"maxLength": 50,
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
},
"isSeasonal": {
"description": "Indicates if the processing account runs transactions on a seasonal basis. For example, if the processing account runs transactions during only the winter months, send a value of `true`.",
"example": false,
"type": "boolean"
},
"merchantId": {
"description": "Unique identifier that the acquiring platform assigns to the merchant.",
"example": "4525644354",
"maxLength": 15,
"readOnly": true,
"type": "string"
},
"monthlyAmounts": {
"description": "Object that contains information about the monthly processing amounts for the processing account.",
"properties": {
"average": {
"description": "Estimated average transaction amount each month. The value is in the currency's lowest denomination, for example, cents. You must provide an amount that is greater than zero.",
"example": 50000,
"format": "int64",
"type": "integer"
},
"highest": {
"description": "Estimated maximum transaction amount each month. The value is in the currency's lowest denomination, for example, cents. You must provide an amount that is greater than zero.",
"example": 100000,
"format": "int64",
"type": "integer"
}
},
"required": [
"average",
"highest"
],
"type": "object"
},
"monthsOfOperation": {
"description": "Months of the year that the processing account runs transactions.",
"example": [
"jan",
"feb"
],
"items": {
"enum": [
"jan",
"feb",
"mar",
"apr",
"may",
"jun",
"jul",
"aug",
"sep",
"oct",
"nov",
"dec"
],
"type": "string"
},
"maxItems": 12,
"type": "array"
},
"transactionAmounts": {
"description": "Object that contains information about transaction amounts for the processing account.",
"properties": {
"average": {
"description": "Estimated average transaction amount. The value is in the currency's lowest denomination, for example, cents. You must provide an amount that is greater than zero.",
"example": 5000,
"format": "int64",
"type": "integer"
},
"highest": {
"description": "Estimated maximum transaction amount. The value is in the currency's lowest denomination, for example, cents. You must provide an amount that is greater than zero.",
"example": 10000,
"format": "int64",
"type": "integer"
}
},
"required": [
"average",
"highest"
],
"type": "object"
},
"volumeBreakdown": {
"description": "Object that contains information about the types of transactions ran by the processing account. The percentages for transaction types must total 100%.",
"properties": {
"cardPresent": {
"description": "Estimated percentage of card-present transactions.",
"example": 77,
"format": "int32",
"type": "integer"
},
"ecommerce": {
"description": "Estimated percentage of e-Commerce transactions.",
"example": 20,
"format": "int32",
"type": "integer"
},
"mailOrTelephone": {
"description": "Estimated percentage of mail order or telephone transactions.",
"example": 3,
"format": "int32",
"type": "integer"
}
},
"required": [
"cardPresent",
"mailOrTelephone",
"ecommerce"
],
"type": "object"
}
},
"required": [
"transactionAmounts",
"monthlyAmounts",
"volumeBreakdown"
],
"title": "processing",
"type": "object"
},
"ref_8ebdd2030043664bacdb": {
"properties": {
"type": {
"description": "Type of contact method.",
"enum": [
"mobile"
],
"type": "string"
},
"value": {
"description": "Mobile number.",
"example": "8445557624",
"maxLength": 15,
"type": "string"
}
},
"required": [
"type",
"value"
],
"title": "mobile",
"type": "object"
},
"ref_8ed290b57437ba306cdd": {
"description": "Create a multi-use payment link.",
"summary": "Multi-use payment link",
"value": {
"authType": "sale",
"customLabels": [
{
"element": "paymentButton",
"label": "SUPPORT US"
}
],
"merchantReference": "LinkRef6543",
"order": {
"charge": {
"currency": "USD",
"type": "prompt"
},
"description": "Pie It Forward charitable trust donation"
},
"paymentMethods": [
"card",
"bankTransfer"
],
"type": "multiUse"
}
},
"ref_8f2d2339a1306a14acd3": {
"description": "Filter results by the order ID of the payment.",
"examples": {
"example": {
"value": "OrderRef6543"
}
},
"in": "query",
"name": "orderId",
"schema": {
"maxLength": 24,
"minLength": 1,
"type": "string"
}
},
"ref_8f5a1a5b0001a0830136": {
"description": "Create a single-use token. The token expires after 30 minutes.",
"summary": "Create single-use token",
"value": {
"expiresAt": "2024-08-05T19:50:05.723+02:00",
"processingTerminalId": "1234001",
"source": {
"cardNumber": "453985******7062",
"cardType": "Visa Credit",
"cardholderName": "Sarah Hazel Hopper",
"currency": "USD",
"debit": false,
"expiryDate": "1230",
"type": "card"
},
"token": "fa2e9e51bc5265a33a5ca41449524d53d1def596ffd8c0904f222183a71a65cdb58835120a65196a48a6375abc4deafe2b7e948689ab9d6aba919e860f32e247"
}
},
"ref_8f61348dac434c012f6d": {
"description": "Refund Bank Transfer Payment",
"summary": "Refund Bank Transfer Payment",
"value": {
"bankAccount": {
"accountNumber": "****7890",
"institutionNumber": "543",
"nameOnAccount": "Sarah Hazel Hopper",
"secureToken": {
"customerName": "Sarah Hopper",
"link": {
"href": "https://api.payroc.com/v1/processing-terminals/1234001/secure-tokens/MREF_abc1de23-f4a5-6789-bcd0-12e345678901fa",
"method": "GET",
"rel": "self"
},
"secureTokenId": "MREF_abc1de23-f4a5-6789-bcd0-12e345678901fa",
"status": "notValidated",
"token": "296753123456"
},
"transitNumber": "76543",
"type": "pad"
},
"customFields": [
{
"name": "yourCustomField",
"value": "abc123"
}
],
"customer": {
"contactMethods": [
{
"type": "email",
"value": "sarah.hopper@example.com"
}
],
"notificationLanguage": "en"
},
"order": {
"amount": 4999,
"breakdown": {
"subtotal": 4347,
"taxes": [
{
"amount": 217,
"name": "Sales Tax",
"rate": 5
}
],
"tip": {
"amount": 435,
"percentage": 10,
"type": "percentage"
}
},
"currency": "USD",
"dateTime": "2024-07-02T15:30:00Z",
"description": "Refund for order OrderRef6543",
"orderId": "OrderRef6543"
},
"paymentId": "M2MJOG6O2Y",
"processingTerminalId": "1234001",
"transactionResult": {
"authorizedAmount": 4999,
"currency": "USD",
"responseCode": "A",
"status": "reversal",
"type": "payment"
}
}
},
"ref_8f68cc0e352a60082b55": {
"description": "Payment plan after we replaced the frequency.",
"summary": "Update payment plan: replace",
"value": {
"currency": "USD",
"customFieldNames": [
"yourCustomField"
],
"description": "Monthly Premium Club subscription",
"frequency": "yearly",
"length": 12,
"name": "Premium Club",
"onDelete": "complete",
"onUpdate": "continue",
"paymentPlanId": "PlanRef8765",
"processingTerminalId": "1234001",
"recurringOrder": {
"amount": 4999,
"breakdown": {
"subtotal": 4347,
"taxes": [
{
"name": "Sales Tax",
"rate": 5
}
]
},
"description": "Monthly Premium Club subscription"
},
"setupOrder": {
"amount": 4999,
"breakdown": {
"subtotal": 4347,
"taxes": [
{
"name": "Sales Tax",
"rate": 5
}
]
},
"description": "Initial setup fee for Premium Club subscription"
},
"type": "automatic"
}
},
"ref_8f713db43a6183e37a14": {
"description": "Unique identifier of the transaction.",
"examples": {
"example": {
"value": 442233
}
},
"in": "path",
"name": "transactionId",
"required": true,
"schema": {
"type": "integer"
}
},
"ref_8fa1afd5dd605a4e2fdf": {
"description": "Card Balance",
"summary": "Card Balance",
"value": {
"card": {
"balances": [
{
"amount": 10000,
"benefitCategory": "cash",
"currency": "USD"
}
],
"cardNumber": "453985******7062",
"cardholderName": "Sarah Hazel Hopper",
"cardholderSignature": "a1b1c012345678a000b000c0012345d0e0f010g10061a031i001j071k0a1b0c1d0e1234567890120f1g0h1i0j1k0a1b0123451c012d0e1f0g1h0i1j123k1a1b1c1d1e1f1g123h1i1j1k1a1b1c1d1e1f1g123h123i1j123k12340a120a12345b012c0123012d0d1e0f1g0h1i123j123k10000",
"entryMethod": "keyed",
"expiryDate": "1230",
"type": "Common Benefit Identification Card"
},
"operator": "Jane",
"processingTerminalId": "1234001",
"responseCode": "A",
"responseMessage": "Approved"
}
},
"ref_8fa86deb8d98d9b24051": {
"description": "Refund Bank Transfer Payment",
"summary": "Refund Bank Transfer Payment",
"value": {
"amount": 4999,
"description": "amount to refund"
}
},
"ref_907e700f9ba048d64683": {
"description": "Object that contains information about U.S. base fees.",
"properties": {
"addressVerification": {
"description": "Fee for each address verification request. The value is in the currency's lowest denomination, for example, cents.",
"example": 5,
"minimum": 0,
"type": [
"integer",
"null"
]
},
"annualFee": {
"description": "Object that contains information about the annual fee.",
"properties": {
"amount": {
"description": "Annual fee. The value is in the currency's lowest denomination, for example, cents.",
"example": 100,
"minimum": 0,
"type": "integer"
},
"billInMonth": {
"default": "december",
"description": "Indicates whether we collect the annual fee in June or December.",
"enum": [
"june",
"december"
],
"example": "june",
"type": "string"
}
},
"required": [
"amount"
],
"type": "object"
},
"batch": {
"description": "Fee for each batch. The value is in the currency's lowest denomination, for example, cents.",
"example": 5,
"minimum": 0,
"type": "integer"
},
"chargeback": {
"default": 2500,
"description": "Fee for each chargeback. The value is in the currency's lowest denomination, for example, cents.",
"example": 2500,
"maximum": 5000,
"minimum": 750,
"type": "integer"
},
"earlyTermination": {
"default": 57500,
"description": "Fee for early termination. The value is in the currency's lowest denomination, for example, cents.",
"example": 57500,
"maximum": 59500,
"minimum": 19500,
"type": "integer"
},
"maintenance": {
"description": "Monthly fee for maintenance. The value is in the currency's lowest denomination, for example, cents.",
"example": 1995,
"minimum": 500,
"type": "integer"
},
"minimum": {
"description": "Monthly fee that we charge when the merchant doesn't meet the minimum fee amount. This monthly fee is in the currency's lowest denomination, for example, cents.",
"example": 100,
"minimum": 0,
"type": "integer"
},
"pciNonCompliance": {
"default": 7495,
"description": "Fee that we apply each month if you aren't compliant with PCI standards. The value is in the currency's lowest denomination, for example, cents.",
"example": 7495,
"maximum": 10000,
"minimum": 3995,
"type": "integer"
},
"platinumSecurity": {
"description": "Object that contains information about the Platinum Security fee.",
"discriminator": {
"mapping": {
"annual": "#/components/schemas/platinumSecurityAnnually",
"monthly": "#/components/schemas/platinumSecurityMonthly"
},
"propertyName": "billingFrequency"
},
"oneOf": [
{
"$ref": "#/x-devx-bundled/ref_2af9c6993f8d5a424f9e"
},
{
"$ref": "#/x-devx-bundled/ref_3ce26e1f1df00a69bcbf"
}
],
"type": "object"
},
"regulatoryAssistanceProgram": {
"description": "Annual fee for the regulatory assistance program. The value is in the currency's lowest denomination, for example, cents.",
"example": 15,
"minimum": 0,
"type": [
"integer",
"null"
]
},
"retrieval": {
"default": 1500,
"description": "Fee for each retrieval. The value is in the currency's lowest denomination, for example, cents.",
"example": 1500,
"maximum": 5000,
"minimum": 275,
"type": "integer"
},
"voiceAuthorization": {
"default": 95,
"description": "Fee for each voice authorization. The value is in the currency's lowest denomination, for example, cents.",
"example": 95,
"maximum": 200,
"minimum": 95,
"type": "integer"
}
},
"required": [
"addressVerification",
"annualFee",
"regulatoryAssistanceProgram",
"batch",
"maintenance",
"minimum"
],
"title": "US base fees",
"type": "object"
},
"ref_90c4c124dcdf72f36511": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_3147c722e948ca9d06ad"
},
{
"type": "object"
}
],
"description": "Object that contains information about the refund.",
"required": [
"amount",
"currency",
"description",
"orderId"
],
"type": "object"
},
"ref_90d04e11e8f10457c837": {
"description": "Object that contains information about the tip.",
"properties": {
"amount": {
"description": "If the value for type is `fixedAmount`, this value is the tip amount in the currency's lowest denomination, for example, cents. \n",
"example": 500,
"exclusiveMinimum": 0,
"format": "int64",
"type": "integer"
},
"mode": {
"description": "Indicates how the tip was added to the transaction.\n- `prompted` – The customer was prompted to add a tip during payment.\n- `adjusted` – The customer added a tip on the receipt for the merchant to adjust post-transaction.\n",
"enum": [
"prompted",
"adjusted"
],
"example": "prompted",
"readOnly": true,
"type": "string"
},
"percentage": {
"description": "If the value for type is `percentage`, this value is the tip as a percentage.",
"example": 10,
"exclusiveMinimum": 0,
"format": "double",
"maximum": 100,
"type": "number",
"x-fern-type-hint": "decimal"
},
"type": {
"description": "Indicates if the tip is a fixed amount or a percentage. \n**Note:** Our gateway applies the percentage tip to the total amount of the transaction after tax.\n",
"enum": [
"percentage",
"fixedAmount"
],
"example": "percentage",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"ref_9133dec53865497ea171": {
"description": "One or more recipients exceed the 'amount.value' limit for your account",
"summary": "Recipient amount.value limit exceeded",
"value": {
"detail": "One or more recipients exceed the 'amount.value' limit for your account",
"status": 400,
"title": "Recipient amount.value limit exceeded",
"type": "https://docs.payroc.com/api/errors#recipient-amount-value-limit-exceeded"
}
},
"ref_91509fee696e20aa30f2": {
"properties": {
"name": {
"description": "Name of the custom field.",
"example": "yourCustomField",
"maxLength": 56,
"minLength": 1,
"type": "string"
},
"value": {
"description": "Value for the custom field.",
"example": "abc123",
"maxLength": 100,
"minLength": 1,
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"ref_91ecc468ca61b768be31": {
"description": "Event subscription returned unchanged after a test (assert-only) operation.",
"summary": "Update event subscription: test",
"value": {
"enabled": true,
"eventTypes": [
"processingAccount.status.changed"
],
"id": 2565435189324,
"metadata": {
"yourCustomField": "abc123"
},
"notifications": [
{
"secret": "**********oP3456",
"supportEmailAddress": "jane.doe@example.com",
"type": "webhook",
"uri": "https://my-server/notification/endpoint"
}
],
"status": "registered"
}
},
"ref_91fb2fa5a740e5e339ef": {
"description": "Bank Transfer Payment that we represented with new ACH bank account details",
"summary": "Representment Bank Transfer Payment",
"value": {
"bankAccount": {
"accountNumber": "****1010",
"nameOnAccount": "Sarah Hopper",
"routingNumber": "053200983",
"secCode": "tel",
"secureToken": {
"customerName": "Sarah Hopper",
"link": {
"href": "https://api.payroc.com/v1/processing-terminals/1234001/secure-tokens/MREF_abc1de23-f4a5-6789-bcd0-12e345678901fa",
"method": "GET",
"rel": "self"
},
"secureTokenId": "MREF_abc1de23-f4a5-6789-bcd0-12e345678901fa",
"status": "notValidated",
"token": "296753123456"
},
"type": "ach"
},
"customFields": [
{
"name": "yourCustomField",
"value": "abc123"
}
],
"customer": {
"contactMethods": [
{
"type": "email",
"value": "sarah.hopper@example.com"
}
],
"notificationLanguage": "en"
},
"order": {
"amount": 4999,
"breakdown": {
"subtotal": 4347,
"taxes": [
{
"amount": 217,
"name": "Sales Tax",
"rate": 5
}
],
"tip": {
"amount": 435,
"percentage": 10,
"type": "percentage"
}
},
"currency": "USD",
"dateTime": "2024-07-02T15:30:00Z",
"description": "Large Pepperoni Pizza",
"orderId": "OrderRef6543"
},
"paymentId": "M2MJOG6O2Y",
"processingTerminalId": "1234001",
"transactionResult": {
"authorizedAmount": 4999,
"currency": "USD",
"processorResponseCode": "0",
"responseCode": "A",
"responseMessage": "NoError",
"status": "ready",
"type": "payment"
}
}
},
"ref_92b77a0b37393e88b84c": {
"properties": {
"link": {
"$ref": "#/x-devx-bundled/ref_27e6d0e095fb23cba669"
},
"name": {
"description": "Name of the payment plan.",
"example": "Monthly Premium Club subscription",
"maxLength": 128,
"minLength": 5,
"type": "string"
},
"paymentPlanId": {
"description": "Unique identifier that the merchant assigns to the payment plan.",
"example": "PlanRef8765",
"maxLength": 48,
"minLength": 1,
"type": "string"
}
},
"required": [
"name",
"paymentPlanId"
],
"type": "object"
},
"ref_92ff5c2bd438d0e2fcd1": {
"properties": {
"attachment": {
"description": "Object that contains details about the attachment.",
"properties": {
"description": {
"description": "Short description of the attachment.",
"example": "Passport as identification for lease agreement",
"maxLength": 250,
"type": "string"
},
"metadata": {
"additionalProperties": {
"type": "string"
},
"description": "Object that you can send to include custom metadata in the request.",
"example": {
"documentId": "2345"
},
"type": "object"
},
"type": {
"description": "Type of attachment.",
"enum": [
"bankingEvidence",
"questionnairesAndLicenses",
"merchantStatements",
"taxDocuments",
"mpaOrAmendment",
"proofOfBusiness",
"financialStatements",
"personalIdentification",
"other"
],
"example": "personalIdentification",
"maxLength": 25,
"minLength": 5,
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"file": {
"description": "File that you want to upload.",
"format": "binary",
"type": "string"
}
},
"required": [
"attachment",
"file"
],
"type": "object"
},
"ref_931de6260653964c9232": {
"description": "Object that contains information about the settlement.",
"example": {
"achDate": "2024-07-02",
"achDepositId": 99,
"link": {
"href": "https://api.payroc.com/v1/ach-deposits/99?merchantId=4525644354",
"method": "get",
"rel": "achDeposit"
},
"settledBy": "3rd party"
},
"properties": {
"achDate": {
"description": "Date that the processor settled the transaction. The format of this value is **YYYY-MM-DD**.",
"example": "2024-07-02",
"format": "date",
"type": "string"
},
"achDepositId": {
"description": "Unique identifier of the ACH deposit.",
"type": "integer"
},
"link": {
"$ref": "#/x-devx-bundled/ref_27e6d0e095fb23cba669"
},
"settledBy": {
"description": "Processor that settled the transaction.",
"example": "Payroc",
"type": "string"
}
},
"title": "settlement summary",
"type": "object"
},
"ref_934de109dee2c56fbd84": {
"description": "You can't select Daily Discount with a RewardPayChoice pricing plan. To select Daily Discount, choose a different pricing plan.",
"summary": "Cannot select Daily Discount and RewardPayChoice at the same time.",
"value": {
"detail": "Choose a different pricing plan or don't select Daily Discount.",
"status": 400,
"title": "Cannot select Daily Discount and RewardPayChoice at the same time.",
"type": "https://docs.payroc.com/api/errors#daily-discount-and-reward-pay-conflict"
}
},
"ref_93badc2c64529eef6d80": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_97210cf49ae4a58b7540"
},
{
"properties": {
"signatureInstructionId": {
"description": "Unique identifier that our gateway assigned to the instruction.",
"example": "a37439165d134678a9100ebba3b29597",
"maxLength": 36,
"minLength": 1,
"type": "string"
}
},
"type": "object"
}
],
"required": [
"signatureInstructionId",
"status"
],
"type": "object"
},
"ref_93ecbac866b583bd60a3": {
"description": "Payment",
"summary": "Payment",
"value": {
"card": {
"cardNumber": "453985******7062",
"entryMethod": "keyed",
"expiryDate": "1230",
"securityChecks": {
"avsResult": "Y",
"cvvResult": "M"
},
"type": "MasterCard"
},
"customFields": [
{
"name": "yourCustomField",
"value": "abc123"
}
],
"customer": {
"billingAddress": {
"address1": "1 Example Ave.",
"address2": "Example Address Line 2",
"address3": "Example Address Line 3",
"city": "Chicago",
"country": "US",
"postalCode": "60056",
"state": "Illinois"
},
"firstName": "Sarah",
"lastName": "Hopper",
"shippingAddress": {
"address": {
"address1": "1 Example Ave.",
"address2": "Example Address Line 2",
"address3": "Example Address Line 3",
"city": "Chicago",
"country": "US",
"postalCode": "60056",
"state": "Illinois"
},
"recipientName": "Sarah Hopper"
}
},
"operator": "Jane",
"order": {
"amount": 4999,
"currency": "USD",
"dateTime": "2024-07-02T15:30:00Z",
"description": "Large Pepperoni Pizza",
"orderId": "OrderRef6543"
},
"paymentId": "M2MJOG6O2Y",
"processingTerminalId": "1234001",
"supportedOperations": [
"capture",
"fullyReverse",
"partiallyReverse",
"incrementAuthorization",
"adjustTip",
"setAsPending"
],
"transactionResult": {
"approvalCode": "OK3",
"authorizedAmount": 4999,
"currency": "USD",
"responseCode": "A",
"responseMessage": "OK3",
"status": "ready",
"type": "sale"
}
}
},
"ref_942ff8bbe6683f3b5742": {
"description": "Object that contains details about EBT transactions.",
"properties": {
"enabled": {
"description": "Indicates if the terminal accepts Electronic Benefit Transfer (EBT) transactions.",
"type": "boolean"
}
},
"required": [
"enabled"
],
"type": "object"
},
"ref_9477586d4a50bb60f5a4": {
"properties": {
"detail": {
"description": "Explanation of the problem",
"example": "One or more validation errors occurred, see error section for more info",
"type": "string"
},
"errors": {
"items": {
"properties": {
"detail": {
"description": "Short detail of the validation errors",
"example": "invalid date",
"type": "string"
},
"message": {
"description": "Error message",
"example": "Expected time, got '' for start_time",
"type": "string"
},
"parameter": {
"description": "The parameter or field causing the issues",
"example": "start_time",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"status": {
"description": "Http status code",
"example": 400,
"type": "integer"
},
"title": {
"description": "Short description of the issue.",
"example": "Bad request",
"type": "string"
},
"type": {
"description": "URI reference identifying the problem type",
"example": "https://docs.payroc.com/api/errors#bad-request",
"type": "string"
}
},
"required": [
"type",
"title",
"detail",
"status"
],
"type": "object"
},
"ref_9512d9356d224e7686c7": {
"description": "Paginated list of payment links",
"summary": "Payment links",
"value": {
"count": 2,
"data": [
{
"assets": {
"paymentButton": "SUPPORT US\n",
"paymentUrl": "https://payments.payroc.com/merchant/pay-by-link?token=02ada211-ff51-4845-b0b5-e685aeb4b19d"
},
"authType": "sale",
"createdOn": "2024-07-02",
"customLabels": [
{
"element": "paymentButton",
"label": "SUPPORT US"
}
],
"merchantReference": "LinkRef6543",
"order": {
"charge": {
"currency": "USD",
"type": "prompt"
},
"description": "Pie It Forward charitable trust donation"
},
"paymentLinkId": "JZURRJBUPS",
"paymentMethods": [
"card",
"bankTransfer"
],
"status": "active",
"type": "multiUse"
},
{
"assets": {
"paymentButton": "Pay Now\n",
"paymentUrl": "https://payments.payroc.com/merchant/pay-by-link?token=7c2fc08c-cb0e-44ba-8bcd-cf6de6eb3206"
},
"authType": "sale",
"createdOn": "2024-09-24",
"expiresOn": "2024-10-24",
"merchantReference": "LinkRef7654",
"order": {
"charge": {
"amount": 4999,
"currency": "USD",
"type": "preset"
},
"description": "Large Pepperoni Pizza",
"orderId": "OrderRef7654"
},
"paymentLinkId": "CKHP6VVWYT",
"paymentMethods": [
"card"
],
"status": "active",
"type": "singleUse"
}
],
"hasMore": true,
"limit": 2,
"links": [
{
"href": "https://api.payroc.com/v1/processing-terminals/1001/payment-links?limit=2&after=CKHP6VVWYT",
"method": "get",
"rel": "next"
},
{
"href": "https://api.payroc.com/v1/processing-terminals/1001/payment-links?limit=2&before=JZURRJBUPS",
"method": "get",
"rel": "previous"
}
]
}
},
"ref_955602fc29d58cfc1b13": {
"description": "Object that contains information about the charge when the customer enters the amount of the transaction.",
"properties": {
"currency": {
"$ref": "#/x-devx-bundled/ref_5c51a0e852c4baa940d0",
"example": "USD"
},
"type": {
"enum": [
"prompt"
],
"example": "prompt",
"type": "string"
}
},
"required": [
"type",
"currency"
],
"title": "prompt",
"type": "object"
},
"ref_958403d3a1e8d9035c0d": {
"description": "Object that contains signature information if we captured the merchant’s signature by email.",
"properties": {
"type": {
"description": "Method used to capture the owner's signature.",
"enum": [
"requestedViaEmail"
],
"example": "requestedViaEmail",
"type": "string"
}
},
"required": [
"type"
],
"title": "requestedViaEmail",
"type": "object"
},
"ref_95fb68692a3d0cd73a1d": {
"description": "List of owners associated with the funding recipient.",
"summary": "List funding recipient owners",
"value": [
{
"address": {
"address1": "1 Example Ave.",
"city": "Chicago",
"country": "US",
"postalCode": "60056",
"state": "Illinois"
},
"contactMethods": [
{
"type": "email",
"value": "jane.doe@example.com"
}
],
"dateOfBirth": "1964-03-22",
"firstName": "Jane",
"identifiers": [
{
"type": "nationalId",
"value": "xxxxx4320"
}
],
"lastName": "Doe",
"middleName": "Helen",
"ownerId": 4564,
"relationship": {
"equityPercentage": 48.5,
"isAuthorizedSignatory": false,
"isControlProng": true,
"title": "CFO"
}
},
{
"address": {
"address1": "2 Example Ave.",
"city": "Chicago",
"country": "US",
"postalCode": "60056",
"state": "Illinois"
},
"contactMethods": [
{
"type": "email",
"value": "fred.nerk@example.com"
},
{
"type": "phone",
"value": "2025550110"
}
],
"dateOfBirth": "1980-01-19",
"firstName": "Fred",
"identifiers": [
{
"type": "nationalId",
"value": "xxxxx9876"
}
],
"lastName": "Nerk",
"middleName": "Jim",
"ownerId": 12346,
"relationship": {
"equityPercentage": 51.5,
"isAuthorizedSignatory": true,
"isControlProng": false,
"title": "CEO"
}
}
]
},
"ref_9639de5a23f5cb51b2bb": {
"description": "Object that contains information about the card's bank identification number (BIN).",
"properties": {
"bin": {
"example": "123456789012",
"maxLength": 12,
"minLength": 6,
"type": "string"
},
"type": {
"description": "Method that the terminal used to take the payment.",
"enum": [
"cardBin"
],
"example": "cardBin",
"type": "string"
}
},
"required": [
"type",
"bin"
],
"title": "cardBin",
"type": "object",
"writeOnly": true
},
"ref_965109f2a9a48b5186c7": {
"properties": {
"createdDate": {
"description": "Date that we received the terminal order. We return this value in the [ISO-8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
"example": "2020-09-08T12:00:00.000Z",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"lastModifiedDate": {
"description": "Date that the terminal order was last changed. We return this value in the [ISO-8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
"example": "2020-09-09T12:00:00.000Z",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"orderItems": {
"description": "Array of orderItem objects. Provide a minimum of 1 order item and a maximum of 20 order items.",
"items": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_a3961e92072a91d3c0d1"
},
{
"$ref": "#/x-devx-bundled/ref_ed781d6dbf1d3de38e03"
}
],
"type": "object"
},
"maxItems": 20,
"minItems": 1,
"type": "array"
},
"paymentIntent": {
"$ref": "#/x-devx-bundled/ref_eb108d9094d050e3a00c"
},
"shipping": {
"description": "Object that contains the shipping details for the terminal order. If you don't provide a shipping address, we use the Doing Business As (DBA) address of the processing account.",
"properties": {
"address": {
"description": "Object that contains the shipping address for the terminal order.",
"properties": {
"addressLine1": {
"description": "First line of the shipment address.",
"maxLength": 100,
"type": "string"
},
"addressLine2": {
"description": "Second line of the shipment address.",
"maxLength": 100,
"type": "string"
},
"businessName": {
"description": "Name of the business receiving the shipment.",
"maxLength": 100,
"type": "string"
},
"city": {
"description": "City of the shipment address.",
"maxLength": 50,
"type": "string"
},
"email": {
"description": "Contact email address for the shipment.",
"format": "email",
"maxLength": 100,
"type": "string"
},
"phone": {
"description": "Contact number for the shipment.",
"maxLength": 15,
"type": "string"
},
"postalCode": {
"description": "Postal code of the shipment address.",
"maxLength": 9,
"type": "string"
},
"recipientName": {
"description": "Name of the person receiving the shipment.",
"maxLength": 100,
"type": "string"
},
"state": {
"description": "State of the shipment address.",
"maxLength": 30,
"type": "string"
}
},
"required": [
"recipientName",
"addressLine1",
"city",
"state",
"postalCode",
"email"
],
"type": "object"
},
"preferences": {
"description": "Object that contains the shipping preferences for the terminal order.",
"properties": {
"method": {
"default": "nextDay",
"description": "Shipping method for the terminal order. Send one of the following values:\n - `nextDay` - We schedule the order to be delivered the next day.\n - `ground` - We ship the order with ground shipping.\n",
"enum": [
"nextDay",
"ground"
],
"type": "string"
},
"saturdayDelivery": {
"default": false,
"description": "Indicates if we can schedule the terminal order to be delivered on a Saturday.",
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"status": {
"description": "Status of the terminal order. \n\n**Note**: You can subscribe to our terminalOrder.status.changed event to get notifications when we update the status of a terminal order. For more information about how to subscribe to events, go to [Event Subscriptions](https://docs.payroc.com/guides/board-merchants/event-subscriptions). \n",
"enum": [
"open",
"held",
"dispatched",
"fulfilled",
"cancelled"
],
"example": "open",
"type": "string"
},
"terminalOrderId": {
"description": "Unique identifier that we assigned to the terminal order.",
"example": "12345",
"type": "string"
},
"trainingProvider": {
"default": "partner",
"description": "Indicates who provides training to the merchant for the solution.",
"enum": [
"partner",
"payroc"
],
"maxLength": 7,
"type": "string"
}
},
"required": [
"terminalOrderId",
"status",
"orderItems",
"createdDate",
"lastModifiedDate"
],
"type": "object"
},
"ref_9678c1bcb34694611388": {
"description": "Replace operation updates an existing value.",
"summary": "Update subscription: replace",
"value": [
{
"op": "replace",
"path": "/recurringOrder/amount",
"value": 3999
}
]
},
"ref_970d626bd4d79f7f4937": {
"additionalProperties": false,
"description": "Attestation of Compliance and Questionnaire for pharmaceutical merchants that accept CNP transactions.",
"properties": {
"type": {
"const": "pharmacyCnpComplianceV1",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"ref_97210cf49ae4a58b7540": {
"description": "Object that contains information about the status of the instruction",
"properties": {
"errorMessage": {
"description": "Description of the error that caused the instruction to fail.\n\n**Note:** We return this field only if the status is `failure`.\n",
"type": "string"
},
"link": {
"$ref": "#/x-devx-bundled/ref_27e6d0e095fb23cba669"
},
"status": {
"description": "Indicates the current status of the instruction. \n- `canceled` – The instruction was canceled before it was completed.\n- `completed` – The instruction has completed. Use the link object to check the resource.\n- `failure` – The instruction failed. Check the errorMessage field for more information.\n- `inProgress` – The instruction is currently in progress.\n",
"enum": [
"canceled",
"completed",
"failure",
"inProgress"
],
"example": "completed",
"type": "string"
}
},
"type": "object"
},
"ref_97b71715757430566ace": {
"description": "A signature response example.",
"summary": "Signature",
"value": {
"contentType": "image/png",
"createdOn": "2024-07-02",
"processingTerminalId": "1024",
"signature": "iVBORw0KGgoAAAANSUhEUgAAASwAAABkCAYAAAA8AQ3AAAAJT0lEQVR4Xu3dW4hN7x/H8UnOF5ScSaGcY4hyvJiSQ6RE3FDIkEuHNDdcKacc0pSQiCuUw4UL5YKcipGQclYkJKcccv7+/58ne35jzZ5t7b3XWns/a96v2s2etdfMYDyf/Xyf51nPqjDk9Pr1a7t06ZLt2bPH1qxZY7NmzbJBgwZZ69atrbKy0qqrq622ttbq6urs69evwS/P27Nnz2zYsGHBwwD+ryJ4wDffvn2z48eP29y5c12IVFRUZH20adPGzp07F/xy58ePH3bnzh07ceKEbd682RYvXmxjx461Tp06uYee65he0zk699OnTy6kFFYKLYVXu3btig6xBQsW2Pr164OHAZjHgaXwUTAoUKqqqmz//v32/v374Gn1dH7Xrl3/Cq3v37/bxo0bXZip16Tek3pR6k2pV6XeVT4UTsEQ0/d+/Phx8NSsrl69ar169XJhCKAxrwLr9u3bVlNTY3369LERI0bYli1bXAkVVsPQOn/+vA0ZMsRmzpxpT548CZ4aGfXKpk+fHjyc1cSJE+3AgQPBwwD+KPvAUiApmBRQCioFloKrUKdOnbK2bdtat27dXCkZN5Wbw4cPtyNHjgRf+svRo0dt1KhR9uvXr+BLAP4oy8BSaacST6WeSj6VV02NP4X1+/dv27dvn+thzZ8/37p06VL09wzrypUrrtRrqmRVKdm3b9/E/jyAr8ousA4ePOh6QBpEVw9Ig+rFunnzpo0fP9499FwUDhpfSsqKFSvcIxuVjbNnzw4eBhBQNoH1+fNnW7RokQ0dOtTNwkXh48ePbhBdvSr1rtTLakizh0lR70q9LPW2Gnr16pV17tzZHjx48NdxAI0l12JzUEApqBRYCq4oqHemMS99z6Zm+5IMLNE4lsazNK6VsXz5clu1alWDswA0JdkWm4VKQI0n6WMUNOOnmT/NAGomMJekA0s0Y6gSUDR5oMH/d+/eBc4CkE3yLfaPOErAe/fuufEvra3SGqt/KUVgaU1WZuxsypQpbs0WgHCSb7EWTwmoMmvMmDG2e/fu4EtNKkVgiX7u6dOnbfDgwX+VhwByS7zFRl0CZqxbt85mzJgRPJxTKQNLYaXQAhBeYi02jhIw4/Lly9ajRw97+fJl8KWcShlYKgcB5CeRFhtHCZihpQv9+/e3kydPBl/6p1IElgbY9XOLWa0PNFext9i4SsCMpUuXuke+dAmMdndImpYwlCIogTSIreXEWQJmqFel3pV6WfnS2iwt2EySFofqZxJYQGFiaTlxloAZGq/SuJXGrwpx9+5dGzhwYPBwrHT5jdZgEVhAYSJvObpGTxvZxVUCZmhGUDODhbp48aJNmDAheDg2+nfRBc4fPnwoSSkKpEGkgZVtk7w4aK2V1lwVs4ZJ5aQ27EuCxsu0dYy2kNEmfSNHjgyeAiCEyAIrqbASrRTXqvZiaPuaJUuWBA/HQpvyaXM+UdgWMkkAIKLASjKsJIoxII0lrV27Nng4ctruWLs0qGclCqt8VuMD+E/RLT/psJIoAkthlbkIOQ5v3751Zee4cePczGCuG2SEebRq1arRsYavAc1BUS2/FGElaqTFUjmosjAquqj50KFDtmzZMrdTRIcOHWzq1KnWsmVLO3bsmH358sXtLNq+ffu876TzL1H8ewA+KPh/eqnCSqJooBpwL2R1vGgjwBs3btiuXbts3rx51rNnT/fQcx3Tazrn6dOn1rt37/qvi2vAPYp/D8AHBf1PL2VYSRQNVEsatLQhDPWO9HfdsGGDTZs2zfWe1ItSb0q9qqZu46U1YrqnYUYcA+76cyW51TNQSnm3/FKHlWg8SDccvXDhQvCl0LRoVItHG8p1l2cFj46pV6bxqTC0w6j2ps+IesC9HH4XQJLyCqxyaSBv3ryxHTt2uF6OHnquY2Fk7vKsXpLusBzmLs+Frvfatm2brVy5sv5zlYOZ2cJilcvvAkhS6MAq1waiXpZ6W2Fn4XTegAEDrEWLFrZ69eqC7/IchsJKoSUKPu2GGsWAe7n+LoC4hQqstDWQw4cPJ7LKXeWgykJdT6lrK6O4XCltvwsgH/8MrDQ2EIWVQituKi818K6LwPUoxs+fP23r1q3uOs00/S6AfOQMrDSGlS4+7tixo/sYNy1p2L59u+tdFbNrxfXr1921iNqltKkZSaA5aDKwHj16lMp386TKQdF4mZYcFLofmEJOM5O6FZiWTwDNXZOBpXdzlSBpk1Q5WKwzZ8647Wg0oRDHhADgo6yBpXdzlSAaN0mTJMvBQimcFFIKK4UWgP80Ciw1mO7du7txk7RJshwshN4oVP6pDCxmzAtIq0aBtXDhQtdgmqI7Kt+6dcttRqcdP+fMmeMGlZPebrgQ5VoOaiBdJbh6tWl8owCi8ldgqQTp169f1nd37Zq5c+dON4isgFJQKbAUXAqwMLeGL6VyLAd1iU9NTY1bUKrxwrSV4EDU6gNLIaWwyjZu8vDhQ5s0aZJ76LmPyqkc1MXUmzZtcrc/0wXUz58/D54CIIv6wFIZqHKwoUyvSg1LH/W5r8qhHNQ1iXv37nU7kGormmK3eQaaGxdYGjfRQHvD6fM09KoyVAaqlC1lOajSWdcwTp482a5duxZ8GUAIFRo30WBvZmFi5mJijav43qvKKGU5ePbsWRs9erR76DmAwlVosLeqqqrg7Vp8UIpyUL0o9abUq1LvCkDxKnT5SBQb4pWrpGcHNS6l8SmNU2m8qtC9tAA0VqE9ohpuMpc2SZWDmunTjJ8mKDQDqJlAANFyPawXL14Ej6dGHOWgNuGrq6uz2tpaq66utsrKSjeorzVVYbdPBpC/Rivd00ZBcv/+/eDh0LKFk3ax0Ed9ruN6PYqdRAHklvrAUrkbtuQlnIDylvrAUrmbz37vhBNQvlIfWADSg8AC4A0CC4A3CCwA3iCwAHiDwALgDQILgDcILADeILAAeIPAAuANAguANwgsAN4gsAB4g8AC4A0CC4A3CCwA3iCwAHiDwALgDQILgDcILADeILAAeIPAAuANAguANwgsAN4gsAB4g8AC4A0CC4A3CCwA3iCwAHiDwALgDQILgDcILADeILAAeIPAAuANAguANwgsAN4gsAB4g8AC4A0CC4A3CCwA3iCwAHiDwALgDQILgDcILADeILAAeIPAAuANAguANwgsAN4gsAB4g8AC4A0CC4A3/gdbd1ZfSyjQ+QAAAABJRU5ErkJggg==",
"signatureId": "JDN4ILZB0T"
}
},
"ref_97fd591be23011b399ca": {
"description": "Filter results by the last four digits of the account number.",
"examples": {
"example": {
"value": "7062"
}
},
"in": "query",
"name": "last4",
"schema": {
"pattern": "[0-9]{4}",
"type": "string"
}
},
"ref_98165b13204272c0645a": {
"description": "Unique identifier that our gateway assigned to the terminal.",
"examples": {
"example": {
"value": "1234001"
}
},
"in": "path",
"name": "processingTerminalId",
"required": true,
"schema": {
"maxLength": 50,
"minLength": 4,
"type": "string"
}
},
"ref_98b4d9070f47d116d568": {
"description": "Funding recipients.",
"summary": "Funding recipient.",
"value": {
"address": {
"address1": "1 Example Ave.",
"city": "Chicago",
"country": "US",
"postalCode": "60056",
"state": "Illinois"
},
"contactMethods": [
{
"type": "phone",
"value": "2025550164"
}
],
"createdDate": "2024-07-02T15:30:00+00:00",
"doingBusinessAs": "Pizza Doe",
"fundingAccounts": [
{
"fundingAccountId": 123,
"link": {
"href": "https://api.payroc.com/v1/funding-accounts/123",
"method": "get",
"rel": "fundingAccount"
},
"status": "approved"
},
{
"fundingAccountId": 124,
"link": {
"href": "https://api.payroc.com/v1/funding-accounts/124",
"method": "get",
"rel": "fundingAccount"
},
"status": "hold"
}
],
"lastModifiedDate": "2024-07-02T15:30:00+00:00",
"metadata": {
"yourCustomField": "abc123"
},
"owners": [
{
"link": {
"href": "https://api.payroc.com/v1/owners/4564",
"method": "get",
"rel": "owner"
},
"ownerId": 4564
}
],
"recipientId": 234,
"recipientType": "privateCorporation",
"status": "approved",
"taxId": "123456789"
}
},
"ref_9901c23553590ebbcce4": {
"description": "Filter by the customer's phone number.",
"examples": {
"example": {
"value": "2025550165"
}
},
"in": "query",
"name": "phone",
"schema": {
"maxLength": 15,
"minLength": 1,
"type": "string"
}
},
"ref_9939e4d9d5c3293a1455": {
"properties": {
"card": {
"$ref": "#/x-devx-bundled/ref_5acdcf065560ed15cf74"
},
"customFields": {
"description": "Array of customField objects.\n",
"items": {
"$ref": "#/x-devx-bundled/ref_91509fee696e20aa30f2"
},
"type": "array"
},
"customer": {
"$ref": "#/x-devx-bundled/ref_5698b09ff5e98efedc02"
},
"operator": {
"description": "Operator who initiated the request.",
"example": "Jane",
"maxLength": 50,
"minLength": 0,
"type": "string"
},
"order": {
"$ref": "#/x-devx-bundled/ref_180b93cfd401848a2c1b"
},
"paymentId": {
"description": "Unique identifier that our gateway assigned to the transaction.",
"example": "M2MJOG6O2Y",
"maxLength": 10,
"minLength": 10,
"type": "string"
},
"processingTerminalId": {
"description": "Unique identifier of the terminal that initiated the transaction.",
"example": "1234001",
"maxLength": 50,
"minLength": 4,
"type": "string"
},
"refunds": {
"description": "Array of refundSummary objects. \nEach object contains information about refunds linked to the transaction.\n",
"items": {
"$ref": "#/x-devx-bundled/ref_8a40ea359f0502198da9"
},
"type": "array",
"uniqueItems": true
},
"supportedOperations": {
"$ref": "#/x-devx-bundled/ref_bba41f5c84235f2c1871"
},
"transactionResult": {
"$ref": "#/x-devx-bundled/ref_68f95191b4389dc629cb"
}
},
"required": [
"card",
"order",
"paymentId",
"processingTerminalId",
"transactionResult"
],
"type": "object"
},
"ref_994ae86a6e6e6d25cca7": {
"description": "Adjust the amount of a pre-authorization",
"summary": "Adjust pre-authorization",
"value": {
"card": {
"cardNumber": "453985******7062",
"entryMethod": "keyed",
"expiryDate": "1230",
"securityChecks": {
"avsResult": "U"
},
"type": "Visa Credit"
},
"customer": {
"billingAddress": {
"address1": "1 Example Ave.",
"address2": "Example Address Line 2",
"address3": "Example Address Line 3",
"city": "Chicago",
"country": "US",
"postalCode": "60056",
"state": "Illinois"
},
"firstName": "Sarah",
"lastName": "Hopper"
},
"operator": "Jane",
"order": {
"amount": 3999,
"currency": "USD",
"dateTime": "2024-07-02T15:30:00Z",
"description": "Large Pepperoni Pizza",
"orderId": "OrderRef6543"
},
"paymentId": "M2MJOG6O2Y",
"processingTerminalId": "1234001",
"supportedOperations": [
"capture",
"fullyReverse",
"partiallyReverse",
"incrementAuthorization",
"setAsReady"
],
"transactionResult": {
"approvalCode": "OK3",
"authorizedAmount": 3999,
"currency": "USD",
"processorResponseCode": "00",
"responseCode": "A",
"responseMessage": "APPROVAL",
"status": "pending",
"type": "sale"
}
}
},
"ref_9978c2f4aebe867fd1cc": {
"properties": {
"applicationSettings": {
"description": "Object that contains the application settings for the solution.",
"properties": {
"clerkPrompt": {
"description": "Indicates if the terminal should prompt the clerk, for example, if the terminal should prompt when the clerk needs to enter an amount on the terminal.",
"type": "boolean"
},
"invoiceNumberPrompt": {
"description": "Indicates if the terminal should prompt the clerk to provide an invoice number with a sale.",
"type": "boolean"
}
},
"type": "object"
},
"batchClosure": {
"description": "Polymorphic object that contains information about when and how the terminal closes the batch. \n\nThe value of the batchCloseType field determines which variant you should use: \n-\t`automatic` - Terminal automatically closes the batch at a specific time each day. \n- `manual` - Merchant uses the terminal to manually close the batch.\n",
"discriminator": {
"mapping": {
"automatic": "#/components/schemas/automaticBatchClose",
"manual": "#/components/schemas/manualBatchClose"
},
"propertyName": "batchCloseType"
},
"oneOf": [
{
"$ref": "#/x-devx-bundled/ref_a8e33140e7edbc2c532e"
},
{
"$ref": "#/x-devx-bundled/ref_8ab4f66b5429b2e9e8c8"
}
]
},
"devices": {
"description": "Array of device objects. Each object contains information about a device using the processing terminal's configuration.",
"items": {
"description": "Object that contains the details of the device.",
"properties": {
"communicationType": {
"$ref": "#/x-devx-bundled/ref_b646705a6cc76da0b164"
},
"manufacturer": {
"description": "Manufacturer of the terminal.",
"maxLength": 100,
"type": "string"
},
"model": {
"description": "Model of the terminal.",
"maxLength": 100,
"type": "string"
},
"serialNumber": {
"description": "Serial number of the terminal.",
"maxLength": 45,
"type": "string"
}
},
"required": [
"manufacturer",
"model",
"serialNumber"
],
"type": "object"
},
"maxItems": 1,
"minItems": 0,
"type": "array"
},
"features": {
"description": "Object that contains the feature settings for the terminal.",
"properties": {
"ebt": {
"anyOf": [
{
"$ref": "#/x-devx-bundled/ref_3d297ea30d957eeb8369"
},
{
"$ref": "#/x-devx-bundled/ref_942ff8bbe6683f3b5742"
}
],
"description": "Polymorphic object that indicates if the terminal accepts EBT transactions. \n\nThe value of the enabled field determines which variant you should use: \n-\t`true` - Terminal allows EBT transactions.\n-\t`false` - Terminal doesn't allow EBT transactions.\n",
"discriminator": {
"mapping": {
"false": "#/components/schemas/ebtDisabled",
"true": "#/components/schemas/ebtEnabled"
},
"propertyName": "enabled"
}
},
"enhancedProcessing": {
"description": "Object that contains details about level two and level three transactions.",
"properties": {
"enabled": {
"description": "Indicates if the terminal can run level two and level three transactions.",
"type": "boolean"
},
"shippingAddressMode": {
"description": "Indicates the address information that the clerk must provide to qualify for level two or level three data. The value is one of the following:\n- `fullAddress` - The clerk must provide the full address for the transaction to qualify.\n- `postalCode` - The clerk must provide a postal code for the transaction to qualify.\n",
"enum": [
"fullAddress",
"postalCode"
],
"maxLength": 11,
"type": "string"
},
"transactionDataLevel": {
"description": "Indicates if the terminal supports level two or level three transactions.",
"enum": [
"level2",
"level3"
],
"maxLength": 6,
"type": "string"
}
},
"required": [
"enabled"
],
"type": "object"
},
"offlinePayments": {
"description": "Indicates if the terminal can accept payments when it can't connect to the gateway. For more information about offline processing, go to [Offline Processing](https://docs.payroc.com/knowledge/card-payments/offline-processing).",
"type": "boolean"
},
"paymentLinks": {
"description": "Object that contains details about payment links.",
"properties": {
"enabled": {
"description": "Indicates if the terminal supports payment links.",
"type": "boolean"
},
"footerNotes": {
"description": "String that the merchant wants to display on the footer of their payment link email.",
"maxLength": 2000,
"type": "string"
},
"logoUrl": {
"description": "URL of the logo image that the merchant wants to display in their payment link email.",
"maxLength": 200,
"type": "string"
}
},
"required": [
"enabled"
],
"type": "object"
},
"pinDebitCashback": {
"description": "Indicates if the terminal prompts for cashback on PIN debit transactions.",
"type": "boolean"
},
"preAuthorizations": {
"description": "Indicates if the terminal can run pre-authorizations.",
"type": "boolean"
},
"recurringPayments": {
"description": "Indicates if the terminal can run repeat payments. For more information about repeat payments, go to [Payment Plans](https://docs.payroc.com/guides/take-payments/repeat-payments).",
"type": "boolean"
},
"tips": {
"anyOf": [
{
"$ref": "#/x-devx-bundled/ref_13de814984ebc32d2e47"
},
{
"$ref": "#/x-devx-bundled/ref_fd1bea82744c5a13f490"
}
],
"description": "Polymorphic object that indicates if the terminal accepts tips. \n\nThe value of the enabled field determines which variant you should use: \n-\t`true` - Terminal allows tips.\n-\t`false` - Terminal doesn't allow tips.\n",
"discriminator": {
"mapping": {
"false": "#/components/schemas/tipProcessingDisabled",
"true": "#/components/schemas/tipProcessingEnabled"
},
"propertyName": "enabled"
}
}
},
"required": [
"enhancedProcessing",
"pinDebitCashback",
"ebt"
],
"type": "object"
},
"gateway": {
"anyOf": [
{
"$ref": "#/x-devx-bundled/ref_d3c4d3de01cff302d518"
}
],
"description": "Polymorphic object that contains the gateway settings for the solution.",
"discriminator": {
"mapping": {
"payroc": "#/components/schemas/payrocGateway"
},
"propertyName": "gateway"
}
},
"processingTerminalId": {
"description": "Unique identifier that we assigned to the processing terminal.",
"example": "011234001",
"type": "string"
},
"program": {
"description": "Name of the product and its setup.",
"maxLength": 50,
"type": "string"
},
"receiptNotifications": {
"description": "Object that indicates if the terminal can send email receipts or text receipts.",
"properties": {
"emailReceipt": {
"description": "Indicates if the terminal can send receipts by email.",
"type": "boolean"
},
"smsReceipt": {
"description": "Indicates if the terminal can send receipts by text message.",
"type": "boolean"
}
},
"type": "object"
},
"security": {
"description": "Object that contains the tokenization settings and AVS settings for the terminal.",
"properties": {
"avsLevel": {
"description": "Indicates the level of AVS details that the terminal should prompt for.",
"enum": [
"fullAddress",
"postalCode"
],
"maxLength": 11,
"type": "string"
},
"avsPrompt": {
"description": "Indicates if the terminal should prompt for Address Verification Service (AVS) details when running a transaction.",
"type": "boolean"
},
"cvvPrompt": {
"description": "Indicates if the terminal should prompt for a Card Verfication Value (CVV) when running a transaction.",
"type": "boolean"
},
"tokenization": {
"description": "Indicates if the terminal can tokenize customer's payment details. For more information about tokenization, go to [Tokenization](https://docs.payroc.com/knowledge/basic-concepts/tokenization).",
"type": "boolean"
}
},
"required": [
"tokenization",
"avsPrompt",
"cvvPrompt"
],
"type": "object"
},
"status": {
"description": "Indicates if the processing terminal is active.",
"enum": [
"active",
"inactive"
],
"maxLength": 8,
"type": "string"
},
"taxes": {
"description": "Array of tax objects that contains the taxes that apply to the merchant's transactions.",
"items": {
"description": "Object that contains a tax rate with a short description of the tax rate.",
"properties": {
"taxLabel": {
"description": "Short description of the tax rate, for example, \"Sales Tax\".",
"maxLength": 10,
"type": "string"
},
"taxRate": {
"description": "Rate of tax that the terminal applies to each transaction.",
"format": "double",
"maximum": 99.999,
"minimum": 0,
"type": "number",
"x-fern-type-hint": "decimal"
}
},
"required": [
"taxRate",
"taxLabel"
],
"type": "object"
},
"maxItems": 3,
"minItems": 0,
"type": "array"
},
"timezone": {
"$ref": "#/x-devx-bundled/ref_63e6cefc99bb7df80593"
}
},
"required": [
"processingTerminalId",
"status",
"timezone",
"applicationSettings",
"batchClosure",
"features"
],
"type": "object"
},
"ref_9999b37089d453ef5f5f": {
"description": "Resource could not be found",
"summary": "Not found",
"value": {
"detail": "Resource not found",
"resource": "(The Type of the Resource)",
"status": 404,
"title": "Not found",
"type": "https://docs.payroc.com/api/errors#not-found"
}
},
"ref_99e34e4543d5d9950f40": {
"description": "Object that contains information about Interchange Plus Plus.",
"properties": {
"fees": {
"description": "Object that contains information about the fees.",
"properties": {
"amex": {
"description": "Object that contains the fees for American Express transactions.",
"discriminator": {
"mapping": {
"direct": "#/components/schemas/interchangePlusPlusAmexDirect",
"optBlue": "#/components/schemas/interchangePlusPlusAmexOptBlue"
},
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/x-devx-bundled/ref_e02b86f71136a4578d40"
},
{
"$ref": "#/x-devx-bundled/ref_b6fed5bc2d8edc10b7f0"
}
]
},
"electronicBenefitsTransfer": {
"$ref": "#/x-devx-bundled/ref_2c771c635a39c1d2ba57"
},
"mastercardVisaDiscover": {
"$ref": "#/x-devx-bundled/ref_eb68f2c28371d61b1260",
"description": "Object that contains the fees for Mastercard, Visa, and Discover transactions."
},
"pinDebit": {
"$ref": "#/x-devx-bundled/ref_39ea196745f35c0c62a3"
},
"specialityCards": {
"$ref": "#/x-devx-bundled/ref_ca2b35d2127e00c3b179"
}
},
"required": [
"mastercardVisaDiscover"
],
"type": "object"
},
"planType": {
"description": "Type of processing plan.",
"enum": [
"interchangePlusPlus"
],
"example": "interchangePlusPlus",
"type": "string"
}
},
"required": [
"planType",
"fees"
],
"title": "Interchange Plus Plus",
"type": "object"
},
"ref_99e60c4d17bea0756274": {
"description": "Retrieve a pricing agreement for a processing account.",
"summary": "Retrieve processing account pricing agreement",
"value": {
"base": {
"addressVerification": 5,
"annualFee": {
"amount": 9900,
"billInMonth": "december"
},
"batch": 5,
"chargeback": 2500,
"earlyTermination": 57500,
"maintenance": 500,
"minimum": 100,
"pciNonCompliance": 4995,
"platinumSecurity": {
"amount": 1295,
"billingFrequency": "monthly"
},
"regulatoryAssistanceProgram": 15,
"retrieval": 1500,
"voiceAuthorization": 95
},
"country": "US",
"gateway": {
"fees": {
"3dSecurePerTransaction": 0,
"monthly": 0,
"perDeviceMonthly": 0,
"perTransaction": 0,
"setup": 0,
"tapToPayPerTransaction": 0
}
},
"processor": {
"ach": {
"fees": {
"accountVerification": 100,
"batch": 1000,
"discountRateAbove10000": 1.25,
"discountRateUnder10000": 1.25,
"monthlyMinimum": 20000,
"returns": 400,
"statement": 800,
"transaction": 50,
"unauthorizedReturn": 1999
}
},
"card": {
"fees": {
"amex": {
"transaction": 0,
"type": "optBlue",
"volume": 1.25
},
"electronicBenefitsTransfer": {
"transaction": 0
},
"mastercardVisaDiscover": {
"transaction": 0,
"volume": 1.25
},
"pinDebit": {
"additionalDiscount": 1.25,
"monthlyAccess": 0,
"transaction": 0
},
"specialityCards": {
"transaction": 0
}
},
"planType": "interchangePlus"
}
},
"version": "5.2"
}
},
"ref_99e7d9ae8ed734f625cc": {
"description": "Pre-authorization that we captured.",
"summary": "Capture a pre-authorization",
"value": {
"card": {
"cardNumber": "453985******7062",
"entryMethod": "keyed",
"expiryDate": "1230",
"securityChecks": {
"avsResult": "U"
},
"type": "Visa Credit"
},
"customer": {
"billingAddress": {
"address1": "1 Example Ave.",
"address2": "Example Address Line 2",
"address3": "Example Address Line 3",
"city": "Chicago",
"country": "US",
"postalCode": "60056",
"state": "Illinois"
},
"firstName": "Sarah",
"lastName": "Hopper"
},
"operator": "Jane",
"order": {
"amount": 3999,
"currency": "USD",
"dateTime": "2024-07-02T15:30:00Z",
"description": "Large Pepperoni Pizza",
"orderId": "OrderRef6543"
},
"paymentId": "M2MJOG6O2Y",
"processingTerminalId": "1234001",
"supportedOperations": [
"capture",
"fullyReverse",
"partiallyReverse",
"incrementAuthorization",
"setAsPending"
],
"transactionResult": {
"approvalCode": "OK3",
"authorizedAmount": 3999,
"currency": "USD",
"processorResponseCode": "00",
"responseCode": "A",
"responseMessage": "APPROVAL",
"status": "ready",
"type": "sale"
}
}
},
"ref_99ef61275025cb524caf": {
"description": "Object that contains information about the customer.",
"properties": {
"contactMethods": {
"description": "Array of polymorphic objects, which contain contact information. \n\nThe value of the type parameter determines which variant you should use: \n-\t`email` - Email address \n-\t`phone` - Phone number\n-\t`mobile` - Mobile number\n-\t`fax` - Fax number\n",
"items": {
"$ref": "#/x-devx-bundled/ref_7960ea97dd5f79b93ae4"
},
"type": "array",
"uniqueItems": true
},
"notificationLanguage": {
"description": "Customer's preferred notification language. This code follows the [ISO 639-1](https://www.iso.org/iso-639-language-code) standard.",
"enum": [
"en",
"fr"
],
"example": "en",
"format": "iso-639-1",
"maxLength": 2,
"minLength": 2,
"type": "string"
}
},
"type": "object"
},
"ref_9a102086f05b94adac7a": {
"properties": {
"createdDate": {
"description": "Date and time that we received your request to create the funding account in our system.",
"example": "2024-07-02T12:00:00.000+00:00",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"fundingAccountId": {
"description": "Unique identifier that we assigned to the funding account.",
"example": 123,
"readOnly": true,
"type": "integer"
},
"lastModifiedDate": {
"description": "Date and time that the funding account was last modified.",
"example": "2024-07-02T12:00:00.000+00:00",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"links": {
"description": "Array of HATEOAS links.",
"items": {
"$ref": "#/x-devx-bundled/ref_27e6d0e095fb23cba669"
},
"readOnly": true,
"type": "array"
},
"metadata": {
"additionalProperties": {
"type": "string"
},
"description": "[Metadata](https://docs.payroc.com/api/metadata) object you can use to include custom data with your request.",
"example": {
"yourCustomField": "abc123"
},
"type": "object"
},
"nameOnAccount": {
"description": "Name of the account holder.",
"example": "Jane Doe",
"type": "string"
},
"paymentMethods": {
"$ref": "#/x-devx-bundled/ref_a44dccb38b0b586a5c79",
"description": "Array of paymentMethod objects."
},
"status": {
"description": "Status of the funding account. The value is one of the following:\n- `approved` - We approved the funding account.\n- `rejected` - We rejected the funding account.\n- `pending` - We have not yet approved the funding account.\n- `hold` - Our Risk team have temporarily placed a hold on the funding account.\n",
"enum": [
"approved",
"rejected",
"pending",
"hold"
],
"example": "pending",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Type of funding account.",
"enum": [
"checking",
"savings",
"generalLedger"
],
"example": "checking",
"type": "string"
},
"use": {
"description": "Indicates if we send funds or withdraw funds from the account. \n- `credit` - Send funds to the account. \n- `debit` - Withdraw funds from the account. \n- `creditAndDebit` - Send funds and withdraw funds from the account. \n\n**Note:** If the funding account is associated with a funding recipient, we accept only a value of `credit`. \n",
"enum": [
"credit",
"debit",
"creditAndDebit"
],
"type": "string"
}
},
"required": [
"nameOnAccount",
"paymentMethods",
"type",
"use"
],
"title": "funding account",
"type": "object"
},
"ref_9a1e75662789fc8b8cc1": {
"description": "Object that contains information about the progress of the payment instruction.",
"summary": "Payment instruction",
"value": {
"link": {
"href": "https://api.payroc.com/v1/payments/M2MJOG6O2Y",
"method": "GET",
"rel": "payment"
},
"paymentInstructionId": "a37439165d134678a9100ebba3b29597",
"status": "completed"
}
},
"ref_9a60d3164ade65bcdbbe": {
"description": "Filter refunds by cardholder name.",
"examples": {
"example": {
"value": "Sarah%20Hazel%20Hopper"
}
},
"in": "query",
"name": "cardholderName",
"schema": {
"maxLength": 50,
"minLength": 1,
"type": "string"
}
},
"ref_9a9e3c82286fa836da18": {
"description": "Filter by the customer's name.",
"examples": {
"example": {
"value": "Sarah%20Hazel%20Hopper"
}
},
"in": "query",
"name": "customerName",
"schema": {
"maxLength": 50,
"minLength": 1,
"type": "string"
}
},
"ref_9aa3626bbdc7eb1b405e": {
"description": "Object that contains the customer's account details.",
"properties": {
"accountNumber": {
"description": "Customer's account number.",
"example": "1234567890",
"maxLength": 12,
"minLength": 7,
"pattern": "^[0-9]*$",
"type": "string"
},
"institutionNumber": {
"description": "Three-digit code that represents the customer's bank.",
"example": "543",
"maxLength": 3,
"minLength": 3,
"pattern": "^[0-9]*$",
"type": "string"
},
"nameOnAccount": {
"description": "Customer's name.",
"example": "Sarah Hazel Hopper",
"maxLength": 29,
"minLength": 1,
"type": "string"
},
"transitNumber": {
"description": "Five-digit code that represents the customer's banking branch.",
"example": "76543",
"maxLength": 5,
"minLength": 5,
"pattern": "^[0-9]*$",
"type": "string"
},
"type": {
"enum": [
"pad"
],
"example": "pad",
"type": "string"
}
},
"required": [
"type",
"nameOnAccount",
"accountNumber",
"transitNumber",
"institutionNumber"
],
"title": "pad",
"type": "object"
},
"ref_9ab219963d0de56b1c4a": {
"description": "Object that contains the details of the payment card.",
"properties": {
"balances": {
"description": "Array of cardBalance objects. Our gateway returns this array only when the customer uses an Electronic Benefit Transfer (EBT) card.",
"example": [
{
"amount": 50000,
"benefitCategory": "cash",
"currency": "USD"
},
{
"amount": 10000,
"benefitCategory": "foodStamp",
"currency": "USD"
}
],
"items": {
"$ref": "#/x-devx-bundled/ref_86018b50b59b772c6408"
},
"type": "array"
},
"cardNumber": {
"description": "Card number. In the response, our gateway shows only the first six digits and the last four digits of the card number, for example, 500165******0000.\n",
"example": "4539858876047062",
"maxLength": 19,
"minLength": 12,
"type": "string"
},
"cardholderName": {
"description": "Cardholder’s name.",
"example": "Sarah Hazel Hopper",
"maxLength": 50,
"minLength": 1,
"type": "string"
},
"cardholderSignature": {
"description": "Cardholder’s signature.",
"example": "a1b1c012345678a000b000c0012345d0e0f010g10061a031i001j071k0a1b0c1d0e1234567890120f1g0h1i0j1k0a1b0123451c012d0e1f0g1h0i1j123k1a1b1c1d1e1f1g123h1i1j1k1a1b1c1d1e1f1g123h123i1j123k12340a120a12345b012c0123012d0d1e0f1g0h1i123j123k10000",
"type": "string"
},
"emvTags": {
"description": "Array of emvTag objects.",
"example": [
{
"hex": "9F36",
"value": "001234"
},
{
"hex": "5F2A",
"value": "0840"
}
],
"items": {
"$ref": "#/x-devx-bundled/ref_7f2c023fc705cc690639"
},
"type": "array",
"uniqueItems": true
},
"entryMethod": {
"description": "Method that the device used to capture the card details.",
"enum": [
"icc",
"keyed",
"swiped",
"swipedFallback",
"contactlessIcc",
"contactlessMsr"
],
"example": "contactlessIcc",
"type": "string"
},
"expiryDate": {
"description": "Expiry date of the customer's card. The format is in **MMYY**.",
"example": "0725",
"pattern": "[0-9]{4}",
"type": "string"
},
"secureToken": {
"$ref": "#/x-devx-bundled/ref_0af00846def2cd349cd2"
},
"securityChecks": {
"$ref": "#/x-devx-bundled/ref_21f616026feedfb1f92c"
},
"type": {
"description": "Card brand of the card, for example, Visa.",
"example": "Visa",
"type": "string"
}
},
"required": [
"cardNumber",
"entryMethod",
"expiryDate",
"type"
],
"type": "object"
},
"ref_9b532b6dac98bf9563ff": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_32a04596e26026b47268"
},
{
"properties": {
"dataKsn": {
"description": "Key serial number.",
"example": "A1B2C3D4E5F67890ABCD",
"format": "hexadecimal",
"maxLength": 20,
"minLength": 20,
"type": "string"
}
},
"type": "object"
}
],
"description": "Object that contains information about the encryption details of the POS terminal.",
"required": [
"model",
"dataKsn",
"serialNumber"
],
"type": "object"
},
"ref_9bfdca27bc73df647bb9": {
"description": "Object that contains information about the order.",
"properties": {
"charge": {
"description": "Polymorphic object that indicates who enters the amount for the payment link. \n\nThe value of the type parameter determines which variant you should use: \n-\t`prompt` - Customer enters the amount.\n-\t`preset` - Merchant sets the amount. \n",
"oneOf": [
{
"$ref": "#/x-devx-bundled/ref_955602fc29d58cfc1b13"
},
{
"$ref": "#/x-devx-bundled/ref_ee94622e3f9da4e9ce9b"
}
],
"type": "object"
},
"description": {
"description": "A brief description of the transaction.",
"example": "Pie It Forward charitable trust donation",
"maxLength": 1024,
"type": "string"
}
},
"required": [
"charge"
],
"type": "object"
},
"ref_9c408ea9145a23c7cbb5": {
"description": "Filter payments by the status of the transaction.",
"examples": {
"example": {
"value": [
"accepted",
"ready",
"complete"
]
}
},
"in": "query",
"name": "status",
"schema": {
"items": {
"enum": [
"ready",
"pending",
"declined",
"complete",
"referral",
"pickup",
"reversal",
"admin",
"expired",
"accepted"
],
"type": "string"
},
"type": "array"
}
},
"ref_9c8bcc4b28365a7b7f70": {
"description": "Object that contains information about the single-use token, which represents the customer’s payment details.",
"properties": {
"accountType": {
"description": "Indicates the customer’s account type. \n\n**Note:** Send a value for accountType only if the single-use token represents bank account details.\n",
"enum": [
"checking",
"savings"
],
"example": "checking",
"type": "string"
},
"ebtDetails": {
"$ref": "#/x-devx-bundled/ref_e4a086f8d857fd3e3dd3"
},
"pinDetails": {
"description": "Polymorphic object that contains information about a customer's PIN. \n\nThe value of the dataFormat parameter determines which variant you should use: \n- `dukpt` - PIN information is encrypted.\n- `raw` - PIN information is unencrypted.\n",
"discriminator": {
"mapping": {
"dukpt": "./pin-v1.yaml#/components/schemas/dukptPinDetails",
"raw": "./pin-v1.yaml#/components/schemas/rawPinDetails"
},
"propertyName": "dataFormat"
},
"oneOf": [
{
"$ref": "#/x-devx-bundled/ref_5211ee5be47c335f4b2e"
},
{
"$ref": "#/x-devx-bundled/ref_4397ef6127818bc94ba5"
}
],
"type": "object"
},
"secCode": {
"description": "Indicates how the customer authorized the ACH transaction. Send one of the following values:\n\n- `web` – Online transaction.\n- `tel` – Telephone transaction.\n- `ccd` – Corporate credit or debit entry for a business bank account.\n- `ppd` – Pre-arranged transaction.\n\n**Note:** This field is mandatory when the single-use token represents ACH bank account details.\n",
"enum": [
"web",
"tel",
"ccd",
"ppd"
],
"example": "web",
"type": "string"
},
"token": {
"description": "Unique token that the gateway assigned to the payment details.",
"example": "abcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890",
"maxLength": 128,
"minLength": 128,
"type": "string"
},
"type": {
"description": "Method that the terminal used to take the payment.",
"enum": [
"singleUseToken"
],
"example": "singleUseToken",
"type": "string"
}
},
"required": [
"type",
"token"
],
"title": "singleUseToken",
"type": "object",
"writeOnly": true
},
"ref_9cd983fda49001e08d81": {
"properties": {
"detail": {
"description": "Explanation of the problem",
"example": "Specified resource was not found",
"type": "string"
},
"resource": {
"description": "Resource that was not found",
"example": "exampleResource",
"type": "string"
},
"status": {
"description": "Http status code",
"example": 404,
"type": "integer"
},
"title": {
"description": "Short description of the issue.",
"example": "Not found",
"type": "string"
},
"type": {
"description": "URI reference identifying the problem type",
"example": "https://docs.payroc.com/api/errors#not-found",
"type": "string"
}
},
"required": [
"type",
"title",
"status",
"detail"
],
"type": "object"
},
"ref_9cecec158fac171a2359": {
"description": "Filter results by the unique identifier that we assigned to the terminal.",
"examples": {
"example": {
"value": "1234001"
}
},
"in": "query",
"name": "processingTerminalId",
"required": true,
"schema": {
"maxLength": 50,
"minLength": 4,
"type": "string"
}
},
"ref_9d1ed3f4f2a6515925b3": {
"description": "Object that contains information about Flat Rate.",
"properties": {
"fees": {
"description": "Object that contains information about the Flat Rate fees.",
"properties": {
"amex": {
"description": "Polymorphic object that contains fees for American Express transactions.",
"discriminator": {
"mapping": {
"direct": "#/components/schemas/flatRateAmexDirect"
},
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/x-devx-bundled/ref_1b32e7b68330cf3a0901"
}
]
},
"electronicBenefitsTransfer": {
"$ref": "#/x-devx-bundled/ref_2c771c635a39c1d2ba57"
},
"pinDebit": {
"$ref": "#/x-devx-bundled/ref_39ea196745f35c0c62a3"
},
"specialityCards": {
"$ref": "#/x-devx-bundled/ref_ca2b35d2127e00c3b179"
},
"standardCards": {
"$ref": "#/x-devx-bundled/ref_01f55c7b2d1709665555",
"description": "Object that contains the fees for standard card transactions."
}
},
"required": [
"standardCards"
],
"type": "object"
},
"planType": {
"description": "Type of processing plan.",
"enum": [
"flatRate"
],
"type": "string"
}
},
"required": [
"planType",
"fees"
],
"title": "Flat Rate Plan",
"type": "object"
},
"ref_9d2f2af2f39a90b039e0": {
"description": "Unique identifier that the merchant assigned to the secure token.",
"examples": {
"example": {
"value": "MREF_abc1de23-f4a5-6789-bcd0-12e345678901fa"
}
},
"in": "path",
"name": "secureTokenId",
"required": true,
"schema": {
"maxLength": 200,
"minLength": 1,
"type": "string"
}
},
"ref_9d9755a79f0c7f700c99": {
"description": "Object that contains information about repeat payments. \n\nInclude this object if the payment is part of a recurring billing schedule and you don't use our [subscriptions](https://docs.payroc.com/guides/take-payments/repeat-payments/use-our-gateway) feature. \n",
"properties": {
"processingModel": {
"description": "Indicates the type of payment schedule.\n\n- 'unscheduled' – The payment is not part of a regular billing cycle.\n- 'recurring' – The payment is part of a regular billing cycle with no end date.\n- 'installment' – The payment is part of a regular billing cycle with an end date.\n",
"enum": [
"unscheduled",
"recurring",
"installment"
],
"example": "recurring",
"type": "string"
},
"referenceDataOfFirstTxn": {
"$ref": "#/x-devx-bundled/ref_ea0faadf7c30078734c1",
"description": "Object that contains information about the first payment."
},
"sequence": {
"description": "Indicates if this payment is the first payment or if it is a subsequent payment.",
"enum": [
"first",
"subsequent"
],
"example": "first",
"type": "string"
}
},
"required": [
"processingModel",
"sequence"
],
"type": "object"
},
"ref_9e589a3238fca8393cd6": {
"description": "Requested data outside allowed range.",
"summary": "Bad request",
"value": {
"detail": "One or more validation errors occurred, see error section for more info",
"errors": [
{
"detail": "invalid date",
"message": "datefrom cannot be longer than two years ago.",
"parameter": "datefrom"
}
],
"status": 400,
"title": "Bad request",
"type": "https://docs.payroc.com/api/errors#bad-request"
}
},
"ref_9eba136cf19525a5d7a6": {
"description": "Move operation relocates a value from one location to another.",
"summary": "Update pricing intent: move",
"value": [
{
"from": "/services/0",
"op": "move",
"path": "/services/1"
}
]
},
"ref_9ec81cd66483861eb3d0": {
"description": "Object that contains information about the Hardware Advantage Plan.",
"discriminator": {
"mapping": {
"accountUpdater": "#/components/schemas/accountUpdater",
"cloverProcessing": "#/components/schemas/cloverProcessing",
"hardwareAdvantagePlan": "#/components/schemas/hardwareAdvantagePlan",
"rocServicesProcessing": "#/components/schemas/rocServicesProcessing",
"wirelessProcessing": "#/components/schemas/wirelessProcessing"
},
"propertyName": "name"
},
"oneOf": [
{
"$ref": "#/x-devx-bundled/ref_6ea779bd3356928bc30b"
},
{
"$ref": "#/x-devx-bundled/ref_b74f5811f88d18e829a5"
},
{
"$ref": "#/x-devx-bundled/ref_5cf3c12be298a11145b9"
},
{
"$ref": "#/x-devx-bundled/ref_c64df29760ecfe018ce6"
},
{
"$ref": "#/x-devx-bundled/ref_4facb7432bb90af0e910"
}
],
"title": "US version 5.2 service",
"type": "object"
},
"ref_9f038e5a45c70c75cf2a": {
"description": "Subscription after we added the new custom field.",
"summary": "Update subscription: add",
"value": {
"currency": "USD",
"currentState": {
"nextDueDate": "2024-08-02",
"outstandingInvoices": 3,
"paidInvoices": 0,
"status": "active"
},
"customFields": [
{
"name": "yourCustomField",
"value": "abc123"
},
{
"name": "membershipLevel",
"value": "premium"
}
],
"description": "Premium Club subscription",
"endDate": "2025-07-01",
"frequency": "monthly",
"length": 12,
"name": "Premium Club",
"pauseCollectionFor": 0,
"paymentPlan": {
"link": {
"href": "https://api.payroc.com/v1/processing-terminals/1234001/payment-plans/PlanRef8765",
"method": "GET",
"rel": "self"
},
"name": "Monthly Premium Club subscription",
"paymentPlanId": "PlanRef8765"
},
"processingTerminalId": "1234001",
"recurringOrder": {
"amount": 4999,
"breakdown": {
"subtotal": 4347,
"surcharge": {
"amount": 217,
"percentage": 5
},
"taxes": [
{
"name": "Sales Tax",
"rate": 5
}
]
},
"description": "Premium Club subscription"
},
"secureToken": {
"customerName": "Sarah Hazel Hopper",
"link": {
"href": "https://api.payroc.com/v1/processing-terminals/1234001/secure-tokens/MREF_abc1de23-f4a5-6789-bcd0-12e345678901fa",
"method": "GET",
"rel": "self"
},
"secureTokenId": "MREF_abc1de23-f4a5-6789-bcd0-12e345678901fa",
"status": "notValidated",
"token": "296753123456"
},
"setupOrder": {
"amount": 4999,
"breakdown": {
"subtotal": 4347,
"surcharge": {
"amount": 217,
"percentage": 5
},
"taxes": [
{
"name": "Sales Tax",
"rate": 5
}
]
},
"description": "Initial setup fee for Premium Club subscription",
"orderId": "OrderRef6543"
},
"startDate": "2024-07-02",
"subscriptionId": "SubRef7654",
"type": "automatic"
}
},
"ref_9f1e1ce656a540c2f16f": {
"description": "Create a pricing intent.",
"summary": "Tiered 3",
"value": {
"base": {
"addressVerification": 5,
"annualFee": {
"amount": 9900,
"billInMonth": "june"
},
"batch": 1500,
"chargeback": 2500,
"earlyTermination": 57500,
"maintenance": 500,
"minimum": 100,
"pciNonCompliance": 4995,
"platinumSecurity": {
"billingFrequency": "monthly"
},
"regulatoryAssistanceProgram": 15,
"retrieval": 1500,
"voiceAuthorization": 95
},
"country": "US",
"gateway": {
"fees": {
"monthly": 2000,
"perDeviceMonthly": 10,
"perTransaction": 2000,
"setup": 5000
}
},
"key": "Your-Unique-Identifier",
"metadata": {
"yourCustomField": "abc123"
},
"processor": {
"ach": {
"fees": {
"accountVerification": 10,
"batch": 5,
"discountRateAbove10000": 1,
"discountRateUnder10000": 0.5,
"monthlyMinimum": 500,
"returns": 400,
"statement": 250,
"transaction": 50,
"unauthorizedReturn": 500
}
},
"card": {
"fees": {
"amex": {
"midQualRate": {
"transaction": 0,
"volume": 1.75
},
"nonQualRate": {
"transaction": 0,
"volume": 3.84
},
"qualifiedRate": {
"transaction": 0,
"volume": 1.39
},
"type": "optBlue"
},
"mastercardVisaDiscover": {
"midQualRate": {
"transaction": 0,
"volume": 1.75
},
"nonQualRate": {
"transaction": 0,
"volume": 3.84
},
"qualifiedRate": {
"transaction": 0,
"volume": 1.39
}
}
},
"planType": "tiered3"
}
},
"services": [
{
"enabled": true,
"name": "hardwareAdvantagePlan"
}
],
"version": "5.2"
}
},
"ref_a0414249ae6629c4d288": {
"properties": {
"type": {
"description": "Type of ID provided to verify identity.",
"enum": [
"nationalId"
],
"type": "string"
},
"value": {
"description": "Social Security Number (SSN) or Social Insurance Number (SIN).",
"example": "xxxxx4320",
"type": "string"
}
},
"required": [
"type",
"value"
],
"title": "identifier",
"type": "object"
},
"ref_a07ca902af0058dde303": {
"description": "Object that contains information about the customer’s card details for swiped transactions.",
"properties": {
"cardholderName": {
"description": "Cardholder’s name.",
"example": "Sarah Hazel Hopper",
"maxLength": 50,
"minLength": 0,
"type": "string"
},
"cardholderSignature": {
"description": "Cardholder's signature. For more information about how to format the signature, go to [How to send a signature to our gateway](https://docs.payroc.com/knowledge/basic-concepts/signature-capture).",
"example": "a1b1c012345678a000b000c0012345d0e0f010g10061a031i001j071k0a1b0c1d0e1234567890120f1g0h1i0j1k0a1b0123451c012d0e1f0g1h0i1j123k1a1b1c1d1e1f1g123h1i1j1k1a1b1c1d1e1f1g123h123i1j123k12340a120a12345b012c0123012d0d1e0f1g0h1i123j123k10000",
"type": "string"
},
"downgradeTo": {
"description": "If an offline transaction is not approved using the initial entry method, reprocess the transaction using a downgraded entry method. \nFor example, a swiped transaction can be downgraded to a keyed transaction.\n",
"enum": [
"keyed",
"swiped"
],
"example": "swiped",
"type": "string"
},
"ebtDetails": {
"$ref": "#/x-devx-bundled/ref_e4a086f8d857fd3e3dd3"
},
"entryMethod": {
"description": "Method that the terminal used to capture the card details.",
"enum": [
"swiped"
],
"example": "swiped",
"type": "string"
},
"pinDetails": {
"description": "Polymorphic object that contains information about the customer's PIN.",
"discriminator": {
"mapping": {
"dukpt": "./pin-v1.yaml#/components/schemas/dukptPinDetails"
},
"propertyName": "dataFormat"
},
"oneOf": [
{
"$ref": "#/x-devx-bundled/ref_5211ee5be47c335f4b2e"
}
],
"type": "object"
},
"swipedData": {
"description": "Polymorphic object that contains payment card details that a device captured from the magnetic strip. \n\nThe value of the dataFormat parameter determines which variant you should use: \n-\t`encrypted` - Payment card details are encrypted.\n-\t`plainText` - Payment card details are in plain text.\n",
"discriminator": {
"mapping": {
"encrypted": "#/components/schemas/encryptedSwipedDataFormat",
"plainText": "#/components/schemas/plainTextSwipedDataFormat"
},
"propertyName": "dataFormat"
},
"oneOf": [
{
"$ref": "#/x-devx-bundled/ref_46f3efe4ed2468aa9af1"
},
{
"$ref": "#/x-devx-bundled/ref_2cb9a51f12a0448ec194"
}
],
"type": "object"
}
},
"required": [
"entryMethod",
"swipedData"
],
"title": "swiped",
"type": "object"
},
"ref_a1171e1612477c2e8ea7": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_f9d963d00740bbe00c9e"
},
{
"properties": {
"data": {
"description": "Array of pricing intent objects.",
"items": {
"$ref": "#/x-devx-bundled/ref_ed5b576489ee24a9c772"
},
"type": "array"
}
},
"type": "object"
}
],
"description": "Object that contains information about your pricing intents.",
"title": "paginated pricing intents",
"type": "object"
},
"ref_a12134c49289ff848c94": {
"description": "Create a pricing intent.",
"summary": "Consumer Choice",
"value": {
"base": {
"addressVerification": 5,
"annualFee": {
"amount": 9900,
"billInMonth": "june"
},
"batch": 1500,
"chargeback": 2500,
"earlyTermination": 57500,
"maintenance": 500,
"minimum": 100,
"pciNonCompliance": 4995,
"platinumSecurity": {
"billingFrequency": "monthly"
},
"regulatoryAssistanceProgram": 15,
"retrieval": 1500,
"voiceAuthorization": 95
},
"country": "US",
"key": "Your-Unique-Identifier",
"metadata": {
"yourCustomField": "abc123"
},
"processor": {
"card": {
"fees": {
"monthlySubscription": 2500,
"volume": 3.5
},
"planType": "consumerChoice"
}
},
"services": [
{
"enabled": true,
"name": "hardwareAdvantagePlan"
}
],
"version": "5.2"
}
},
"ref_a1ad866dd55174d62fc4": {
"properties": {
"merchant": {
"description": "Object that contains the configuration settings for the merchant.",
"properties": {
"abaNumber": {
"description": "Number that identifies the merchant in direct debit requests.",
"example": "967854108",
"maxLength": 12,
"type": "string"
},
"agentBankNumber": {
"description": "Number of the merchant's bank if it processes transactions on behalf of another entity.",
"example": "000001",
"maxLength": 6,
"type": "string"
},
"binNumber": {
"description": "Unique identifier of the merchant's bank.",
"example": "888888",
"maxLength": 6,
"type": "string"
},
"chainNumber": {
"description": "Number that represents the merchant's chain of locations or stores.",
"example": "222222",
"maxLength": 6,
"type": "string"
},
"locationNumber": {
"description": "Location of the merchant's information.",
"example": "000001",
"maxLength": 6,
"type": "string"
},
"posMid": {
"description": "Unique identifier that the host processor assigned to the merchant.",
"example": "123456789101",
"maxLength": 12,
"type": "string"
},
"reimbursementAttribute": {
"description": "Indicates if the merchant can accept interlink debit cards.",
"example": "Z",
"maxLength": 1,
"type": "string"
},
"settlementAgent": {
"description": "Unique identifier of the merchant's settlement agent.",
"example": "0001",
"maxLength": 4,
"type": "string"
}
},
"required": [
"posMid",
"chainNumber",
"binNumber"
],
"type": "object"
},
"processor": {
"description": "Name of the host processor.",
"enum": [
"tsys"
],
"example": "tsys",
"maxLength": 50,
"type": "string"
},
"terminal": {
"description": "Object that contains the configuration settings for the terminal.",
"properties": {
"authenticationCode": {
"description": "Authenticates the terminal's identity with the host processor.",
"example": "A1B2C3",
"maxLength": 10,
"minLength": 6,
"type": "string"
},
"cardPresentAllowed": {
"description": "Indicates if the terminal can run card present transactions.",
"type": "boolean"
},
"internetAllowed": {
"description": "Indicates if the terminal can run e-Commerce transactions.",
"type": "boolean"
},
"motoAllowed": {
"description": "Indicates if the terminal can run Mail Order/Telephone Order (MOTO) transactions.",
"type": "boolean"
},
"sharingGroups": {
"description": "Indicates the direct debit networks and EBT networks that the terminal can use.",
"example": "3E7HULY8NQWZG",
"maxLength": 26,
"type": "string"
},
"terminalId": {
"description": "Unique identifier that the host processor assigned to the terminal.",
"example": "V500000",
"maxLength": 8,
"type": "string"
},
"terminalNumber": {
"description": "Unique identifier of the terminal at the merchant's site.",
"example": "1111",
"maxLength": 4,
"type": "string"
}
},
"required": [
"terminalId",
"terminalNumber"
],
"type": "object"
}
},
"required": [
"processor",
"merchant",
"terminal"
],
"type": "object"
},
"ref_a216874b9b80aef287c3": {
"description": "Filter payments by order ID.",
"examples": {
"example": {
"value": "OrderRef6543"
}
},
"in": "query",
"name": "orderId",
"schema": {
"maxLength": 24,
"minLength": 1,
"type": "string"
}
},
"ref_a277ab132bf37a57216a": {
"description": "Unique identifier that our gateway assigned to the payment link.",
"examples": {
"example": {
"value": "JZURRJBUPS"
}
},
"in": "query",
"name": "paymentLinkId",
"schema": {
"maxLength": 10,
"minLength": 10,
"type": "string"
}
},
"ref_a28a168a0ca17374feda": {
"description": "Object that contains the paymentMethod object.",
"properties": {
"paymentMethod": {
"description": "Polymorphic object that contains the customer's updated payment details. \n\nThe value of the type parameter determines which variant you should use: \n-\t`ach` - Automated Clearing House (ACH) details\n-\t`secureToken` - Secure token details\n",
"discriminator": {
"mapping": {
"ach": "../../../common/schemas/transaction/payment-method-v1.yaml#/components/schemas/achPayload",
"secureToken": "../../../common/schemas/transaction/payment-method-v1.yaml#/components/schemas/secureTokenPayload"
},
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/x-devx-bundled/ref_c799d35ea53644eec4e6"
},
{
"$ref": "#/x-devx-bundled/ref_8a84ce450c6452ba8861"
}
],
"type": "object"
}
},
"type": "object"
},
"ref_a2a6f05247335180858e": {
"properties": {
"type": {
"description": "Type of contact method.",
"enum": [
"fax"
],
"type": "string"
},
"value": {
"description": "Fax number.",
"example": "2025550110",
"maxLength": 15,
"type": "string"
}
},
"required": [
"type",
"value"
],
"title": "fax",
"type": "object"
},
"ref_a2bf1ec730b1a8ae74b5": {
"description": "List of processing terminals associated with a processing account.",
"summary": "Paginated list of processing terminals",
"value": {
"count": 2,
"data": [
{
"applicationSettings": {
"clerkPrompt": false,
"invoiceNumberPrompt": true
},
"batchClosure": {
"batchCloseTime": "23:40",
"batchCloseType": "automatic"
},
"devices": [
{
"communicationType": "bluetooth",
"manufacturer": "Ingenico",
"model": "Axium Dx4000 Tsys",
"serialNumber": "DX400-1234"
}
],
"features": {
"ebt": {
"ebtType": "foodStamp",
"enabled": true,
"fnsNumber": "3456789"
},
"enhancedProcessing": {
"enabled": true,
"shippingAddressMode": "fullAddress",
"transactionDataLevel": "level2"
},
"offlinePayments": true,
"paymentLinks": {
"enabled": true,
"footerNotes": "Thank you for your business.",
"logoUrl": "https://www.example.com/logo.png"
},
"pinDebitCashback": false,
"preAuthorizations": true,
"recurringPayments": true,
"tips": {
"enabled": false
}
},
"gateway": {
"gateway": "payroc",
"terminalTemplateId": "Roc Services_DX8000"
},
"processingTerminalId": "011234001",
"program": "Payroc Cloud",
"receiptNotifications": {
"emailReceipt": true,
"smsReceipt": false
},
"security": {
"avsLevel": "fullAddress",
"avsPrompt": true,
"cvvPrompt": true,
"tokenization": false
},
"status": "active",
"taxes": [
{
"taxLabel": "Sales Tax",
"taxRate": 6
}
],
"timezone": "Pacific/Midway"
}
],
"hasMore": true,
"limit": 2,
"links": [
{
"href": "https://api.payroc.com/v1/processing-accounts/38765/processing-terminals?before=1543&limit=2",
"method": "get",
"rel": "previous"
},
{
"href": "https://api.payroc.com/v1/processing-accounts/38765/processing-terminals?after=87926&limit=2",
"method": "get",
"rel": "next"
}
]
}
},
"ref_a2f5c84fd4924158737d": {
"properties": {
"amount": {
"description": "Tax amount for the transaction. The value is in the currency's lowest denomination, for example, cents.\n\nRequired for [Level 3 and CEDP transactions](https://docs.payroc.com/knowledge/card-payments/enhanced-data).\n",
"example": 190,
"format": "int64",
"minimum": 0,
"type": "integer"
},
"name": {
"description": "Name of the tax.",
"example": "Sales Tax",
"maxLength": 64,
"minLength": 1,
"type": "string"
},
"type": {
"default": "amount",
"description": "Indicates that the tax is an amount.",
"enum": [
"amount"
],
"type": "string"
}
},
"required": [
"name",
"amount",
"type"
],
"type": "object"
},
"ref_a35453ec328edef4593e": {
"description": "Resource already exists",
"summary": "Resource already exists",
"value": {
"detail": "The resource you attempted to create already exists",
"instance": "https://api.payroc.com/v1/merchant/12345",
"status": 409,
"title": "Resource already exists",
"type": "https://docs.payroc.com/api/errors#resource-already-exists"
}
},
"ref_a35f7d2f7aba5061c4aa": {
"properties": {
"card": {
"description": "Card brand associated with the EMV application.",
"example": "VISA",
"type": "string"
},
"identifier": {
"description": "Unique identifier of the EMV application, also known as the Application Identifier (AID).",
"example": "A0000000031010",
"type": "string"
},
"matchType": {
"description": "Indicates how the terminal matches the EMV application identifier during card selection.\n\n- `full` – The terminal requires an exact match of the full application identifier.\n- `partialVisa` – The terminal uses partial matching as defined by Visa.\n- `partialEuropay` – The terminal uses partial matching as defined by Europay and Mastercard.\n",
"enum": [
"full",
"partialVisa",
"partialEuropay"
],
"type": "string"
},
"version": {
"description": "Version number of the EMV application.",
"example": "0096",
"type": "string"
}
},
"type": "object"
},
"ref_a38a839aab4628df3f20": {
"properties": {
"amount": {
"description": "Total amount for the transaction. The value is in the currency's lowest denomination, for example, cents.
\n
**Important:** Do not add the surcharge to the amount parameter in the request. If the transaction is eligible for surcharging, our gateway adds the surcharge to the amount in the request, and then returns the updated amount in the response.\n",
"example": 4999,
"format": "int64",
"type": "integer"
},
"description": {
"description": "Description of the transaction.",
"example": "Monthly Premium Club subscription",
"maxLength": 1024,
"minLength": 1,
"type": "string"
}
},
"type": "object"
},
"ref_a38d1197edd9f3650cd6": {
"description": "Filter results by the status of the payment.",
"examples": {
"example": {
"value": [
"ready"
]
}
},
"in": "query",
"name": "status",
"schema": {
"items": {
"enum": [
"ready",
"pending",
"declined",
"complete",
"admin",
"reversal",
"returned"
],
"type": "string"
},
"type": "array"
}
},
"ref_a3961e92072a91d3c0d1": {
"properties": {
"deviceCondition": {
"description": "Indicates if the order contains a new item or a refurbished item.",
"enum": [
"new",
"refurbished"
],
"maxLength": 11,
"type": "string"
},
"solutionQuantity": {
"default": 1,
"description": "Quantity of the solution.",
"maximum": 50,
"type": "integer"
},
"solutionSetup": {
"description": "Object that contains the settings for the solution, including gateway settings, device settings, and application settings.",
"properties": {
"applicationSettings": {
"description": "Object that contains the application settings for the solution.",
"properties": {
"clerkPrompt": {
"description": "Indicates if the terminal should prompt the clerk, for example, if the terminal should prompt when the clerk needs to enter an amount on the terminal.",
"example": true,
"type": "boolean"
},
"security": {
"description": "Object that contains the password settings when running specific transaction types.",
"properties": {
"keyedSalePassword": {
"description": "Indicates if the terminal should prompt the clerk for a password when running a keyed sale.",
"type": "boolean"
},
"refundPassword": {
"description": "Indicates if the terminal should prompt the clerk for a password when running a refund.",
"type": "boolean"
},
"reversalPassword": {
"description": "Indicates if the terminal should prompt the clerk for a password when canceling a transaction.",
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"batchClosure": {
"description": "Object that contains information about when and how the terminal closes the batch.",
"discriminator": {
"mapping": {
"automatic": "#/components/schemas/automaticBatchClose",
"manual": "#/components/schemas/manualBatchClose"
},
"propertyName": "batchCloseType"
},
"oneOf": [
{
"$ref": "#/x-devx-bundled/ref_7cc43f0fcc66c4cc40a2"
},
{
"$ref": "#/x-devx-bundled/ref_e037dfe009fdadb64013"
}
]
},
"deviceSettings": {
"description": "Object that contains the device settings if the solution includes a terminal or a peripheral device such as a printer.",
"properties": {
"communicationType": {
"description": "Method of connection between a terminal or a peripheral device and the host.",
"enum": [
"bluetooth",
"cellular",
"ethernet",
"wifi"
],
"maxLength": 9,
"type": "string"
},
"numberOfMobileUsers": {
"description": "Number of users that we need to set up for mobile solutions.",
"type": "integer"
}
},
"type": "object"
},
"gatewaySettings": {
"description": "Object that contains the gateway settings for the solution.",
"properties": {
"merchantPortfolioId": {
"description": "Unique identifier of the merchant portfolio.",
"maxLength": 100,
"type": "string"
},
"merchantTemplateId": {
"description": "Unique identifier of the gateway merchant template.",
"maxLength": 100,
"type": "string"
},
"terminalTemplateId": {
"description": "Unique identifier of the gateway terminal template.",
"maxLength": 100,
"type": "string"
},
"userTemplateId": {
"description": "Unique identifier of the gateway user template.",
"maxLength": 100,
"type": "string"
}
},
"type": "object"
},
"industryTemplateId": {
"description": "Unique identifier of the industry template you want to apply to the solution. Send one of the following values:\n- `Retail`\n- `Restaurant`\n- `Moto`\n- `Ecommerce`\n",
"maxLength": 100,
"type": "string"
},
"receiptNotifications": {
"description": "Object that indicates if the terminal can send email receipts, text receipts, or both.",
"properties": {
"emailReceipt": {
"description": "Indicates if the terminal can send receipts by email.",
"type": "boolean"
},
"smsReceipt": {
"description": "Indicates if the terminal can send receipts by text message.",
"type": "boolean"
}
},
"type": "object"
},
"taxes": {
"description": "Array of tax objects that contains the taxes that apply to the merchant's transactions.",
"items": {
"description": "Tax that applies to the merchant's transactions.",
"properties": {
"taxLabel": {
"description": "Short description of the tax rate, for example, \"Sales Tax\".",
"maxLength": 10,
"type": "string"
},
"taxRate": {
"description": "Rate of tax that the terminal applies to each transaction.",
"format": "double",
"maximum": 99.999,
"minimum": 0,
"type": "number",
"x-fern-type-hint": "decimal"
}
},
"required": [
"taxRate",
"taxLabel"
],
"type": "object"
},
"maxItems": 3,
"minItems": 0,
"type": "array"
},
"timezone": {
"$ref": "#/x-devx-bundled/ref_2815804b038ded2dca60"
},
"tips": {
"description": "Object that contains the tip options for transactions ran on the terminal.",
"properties": {
"enabled": {
"description": "Indicates if the terminal can accept tips.",
"type": "boolean"
}
},
"type": "object"
},
"tokenization": {
"description": "Indicates if the terminal can tokenize customer's payment details. For more information about tokenization, go to [Tokenization.](https://docs.payroc.com/knowledge/basic-concepts/tokenization)",
"example": true,
"type": "boolean"
}
},
"type": "object"
},
"solutionTemplateId": {
"description": "Unique identifier of the solution. Send one of the following values:\n- `Roc Services_DX8000`\n- `Roc Services_DX4000`\n- `Roc Services_Web`\n- `Roc Services_Mobile`\n- `Payroc DX8000`\n- `Payroc DX4000`\n- `Payroc RX7000_Cloud`\n- `Payroc DX8000_Cloud`\n- `Payroc DX4000_Cloud`\n- `Payroc A920Pro`\n- `Payroc A80`\n- `Payroc A920Pro_Cloud`\n- `Payroc A80_Cloud`\n- `Roc Terminal Plus_N950`\n- `Roc Terminal Plus_N950-S`\n- `Roc Terminal Plus_X800`\n- `Gateway_Payroc`\n- `VAR_Only_TSYS`\n- `ROC Services Chipper3X`\n- `BBPOS Chipper 3X`\n- `Augusta EMV`\n- `Ingenico - AXIUM Full Functional Base`\n- `Pax A920 Charging Base`\n- `Pax A920 Comms Base`\n- `A920 Pro Ethernet`\n- `Axium Bundle`\n",
"maxLength": 100,
"type": "string"
},
"type": {
"description": "Type of item.",
"enum": [
"solution"
],
"maxLength": 8,
"type": "string"
}
},
"required": [
"type",
"solutionTemplateId"
],
"type": "object"
},
"ref_a44dccb38b0b586a5c79": {
"description": "Array of PaymentMethodAch objects.",
"example": [
{
"type": "ach",
"value": {
"accountNumber": "1234567890",
"routingNumber": "123456789"
}
}
],
"items": {
"discriminator": {
"mapping": {
"ach": "./payment-method-ach-v1.yaml#/components/schemas/PaymentMethodAch"
},
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/x-devx-bundled/ref_e580435fb1ef2622b396"
}
],
"title": "payment method"
},
"type": "array",
"uniqueItems": true
},
"ref_a4703b740ae138d5b46b": {
"description": "Copy operation duplicates a value from one location to another.",
"summary": "Update pricing intent: copy",
"value": [
{
"from": "/processor/card/fees/mastercardVisaDiscover/volume",
"op": "copy",
"path": "/processor/card/fees/amex/volume"
}
]
},
"ref_a476e2edec6c049e74c7": {
"description": "Create a funding instruction to distribute merchant funds to funding accounts.",
"summary": "Funding instruction",
"value": {
"merchants": [
{
"merchantId": "4525644354",
"recipients": [
{
"amount": {
"currency": "USD",
"value": 120000
},
"fundingAccountId": 123,
"metadata": {
"yourCustomField": "abc123"
},
"paymentMethod": "ACH"
}
]
}
],
"metadata": {
"yourCustomField": "abc123"
}
}
},
"ref_a48b3847246c8a8e58e4": {
"description": "Unique identifier of the funding account.",
"examples": {
"example": {
"value": 123
}
},
"in": "path",
"name": "fundingAccountId",
"required": true,
"schema": {
"type": "integer"
}
},
"ref_a52bfba93be1ce659766": {
"properties": {
"name": {
"description": "Name of the tax. A tax validation on the stored rate for the tax name is performed.",
"example": "Sales Tax",
"maxLength": 64,
"minLength": 1,
"type": "string"
},
"rate": {
"description": "Tax percentage for the transaction.\n\nRequired for [Level 3 and CEDP transactions](https://docs.payroc.com/knowledge/card-payments/enhanced-data).\n",
"example": 7,
"format": "double",
"maximum": 99.99999,
"minimum": 0,
"type": "number",
"x-fern-type-hint": "decimal"
},
"type": {
"default": "rate",
"description": "Indicates that the tax is a rate.",
"enum": [
"rate"
],
"type": "string"
}
},
"required": [
"name",
"rate",
"type"
],
"type": "object"
},
"ref_a59a28abab857f03a07f": {
"description": "Serial number that identifies the merchant’s payment device.",
"examples": {
"example": {
"value": "1850010868"
}
},
"in": "path",
"name": "serialNumber",
"required": true,
"schema": {
"maxLength": 64,
"minLength": 1,
"type": "string"
}
},
"ref_a5e56f21e2529bc7d22a": {
"description": "Convert a single-use token to a secure token when running a card sale.",
"summary": "Card sale with single-use token that we convert to a secure token",
"value": {
"channel": "web",
"credentialOnFile": {
"secureTokenId": "MREF_abc1de23-f4a5-6789-bcd0-12e345678901fa",
"tokenize": true
},
"customFields": [
{
"name": "yourCustomField",
"value": "abc123"
}
],
"customer": {
"billingAddress": {
"address1": "1 Example Ave.",
"address2": "Example Address Line 2",
"address3": "Example Address Line 3",
"city": "Chicago",
"country": "US",
"postalCode": "60056",
"state": "Illinois"
},
"firstName": "Sarah",
"lastName": "Hopper",
"shippingAddress": {
"address": {
"address1": "1 Example Ave.",
"address2": "Example Address Line 2",
"address3": "Example Address Line 3",
"city": "Chicago",
"country": "US",
"postalCode": "60056",
"state": "Illinois"
},
"recipientName": "Sarah Hopper"
}
},
"operator": "Jane",
"order": {
"amount": 4999,
"currency": "USD",
"description": "Large Pepperoni Pizza",
"orderId": "OrderRef6543"
},
"paymentMethod": {
"token": "abcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890",
"type": "singleUseToken"
},
"processingTerminalId": "1234001"
}
},
"ref_a637d755ff757609de08": {
"description": "Object that indicates if the customer's card is eligible for Dynamic Currency Conversion (DCC).",
"properties": {
"causeOfRejection": {
"description": "Explains why the DCC service did not offer a currency conversion rate to the customer.",
"example": "Service unavailable",
"type": "string"
},
"dccOffered": {
"default": false,
"description": "Indicates if the card is eligible for Dynamic Currency Conversion (DCC).",
"example": false,
"type": "boolean"
}
},
"required": [
"dccOffered"
],
"type": "object"
},
"ref_a655a7bef3118e3aec71": {
"description": "Object that contains information about U.S. pricing intents for Merchant Processing Agreement (MPA) 5.0.",
"properties": {
"base": {
"$ref": "#/x-devx-bundled/ref_de4079f49a6978acc1bf"
},
"country": {
"description": "Two-digit code for the country that the pricing intent applies to. The format follows the [ISO-3166-1](https://www.iso.org/iso-3166-country-codes.html) standard.",
"enum": [
"US"
],
"type": "string"
},
"gateway": {
"$ref": "#/x-devx-bundled/ref_6fea4800b71b1b4c8c27"
},
"processor": {
"description": "Object that contains information about U.S. processor fees.",
"properties": {
"ach": {
"$ref": "#/x-devx-bundled/ref_3e611d2ed3e542a2cf3f"
},
"card": {
"description": "Polymorphic object that contains fees for card transactions. \n\nThe value of the planType field determines which variant you should use: \n-\t`interchangePlus` - Interchange + pricing\n-\t`interchangePlusPlus` - Interchange pricing with three tiers\n-\t`tiered3` - Three-tiered pricing \n-\t`tiered4` - Four-tiered pricing\n-\t`tiered6` - Six-tiered pricing\n-\t`flatRate` - Flat rate pricing\n-\t`consumerChoice` - ConsumerChoice \n-\t`rewardPayChoice` - RewardPayChoice\n",
"discriminator": {
"mapping": {
"consumerChoice": "#/components/schemas/consumerChoice",
"flatRate": "#/components/schemas/flatRate",
"interchangePlus": "#/components/schemas/interchangePlus",
"interchangePlusPlus": "#/components/schemas/interchangePlusPlus",
"rewardPayChoice": "#/components/schemas/rewardPayChoice",
"tiered3": "#/components/schemas/tiered3",
"tiered4": "#/components/schemas/tiered4",
"tiered6": "#/components/schemas/tiered6"
},
"propertyName": "planType"
},
"oneOf": [
{
"$ref": "#/x-devx-bundled/ref_8dedab7d683c1741ba7a"
},
{
"$ref": "#/x-devx-bundled/ref_ee60eb6b85d9f43cd55d"
},
{
"$ref": "#/x-devx-bundled/ref_af9f49bdb6f99196dce8"
},
{
"$ref": "#/x-devx-bundled/ref_f27ff73f6b39cb7ab2df"
},
{
"$ref": "#/x-devx-bundled/ref_f7eeb7b4e577c65a5900"
},
{
"$ref": "#/x-devx-bundled/ref_9d1ed3f4f2a6515925b3"
},
{
"$ref": "#/x-devx-bundled/ref_4730198900b1c56ebd04"
},
{
"$ref": "#/x-devx-bundled/ref_0ff3e9c7dbd0e2c9610e"
}
],
"type": "object"
}
},
"title": "US processor fees",
"type": "object"
},
"services": {
"$ref": "#/x-devx-bundled/ref_c657e1f085abbf8e4a16"
},
"version": {
"description": "Version of the MPA.",
"enum": [
"5.0"
],
"type": "string"
}
},
"required": [
"country",
"version",
"base"
],
"title": "US pricing agreement version 5.0",
"type": "object"
},
"ref_a660bef0c3f97b2ed00a": {
"description": "Example of an event subscription.",
"summary": "Event subscription",
"value": {
"enabled": true,
"eventTypes": [
"processingAccount.status.changed"
],
"id": 2565435189324,
"metadata": {
"yourCustomField": "abc123"
},
"notifications": [
{
"secret": "**********oP3456",
"supportEmailAddress": "jane.doe@example.com",
"type": "webhook",
"uri": "https://my-server/notification/endpoint"
}
],
"status": "registered"
}
},
"ref_a71510b23f1c84ff1755": {
"description": "Filter by the customer's email address.",
"examples": {
"example": {
"value": "sarah.hopper@example.com"
}
},
"in": "query",
"name": "email",
"schema": {
"maxLength": 100,
"minLength": 1,
"type": "string"
}
},
"ref_a71fc2114d097f488c6e": {
"description": "Add operation adds a new value to an object or array.",
"summary": "Update payment link: add",
"value": [
{
"op": "add",
"path": "/customLabels/-",
"value": {
"element": "paymentButton",
"label": "DONATE NOW"
}
}
]
},
"ref_a748f92789c13ba52290": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_643be9b90eb060b3174b"
},
{
"$ref": "#/x-devx-bundled/ref_4d4e2c710777ba68dcf1"
}
]
},
"ref_a7d713eee6a8492cd70e": {
"description": "Paginated list of payment link sharing events",
"summary": "Sharing events",
"value": {
"count": 2,
"data": [
{
"dateTime": "2024-07-02T15:30:00Z",
"message": "Dear Sarah,\n\nYou can pay for your order via the link below.\n",
"recipients": [
{
"email": "sarah.hopper@example.com",
"name": "Sarah Hazel Hopper"
}
],
"sharingEventId": "GKB49GZ6DL",
"sharingMethod": "email"
},
{
"dateTime": "2024-07-02T15:30:00Z",
"message": "Dear Sarah,\n\nThank you for continuing to support our Pie It Forward charitable trust.\nYou can make your payment via the link below.\n",
"recipients": [
{
"email": "sarah.hopper@example.com",
"name": "Sarah Hazel Hopper"
}
],
"sharingEventId": "GTZH5WVXK9",
"sharingMethod": "email"
}
],
"hasMore": true,
"limit": 2,
"links": [
{
"href": "https://api.payroc.com/v1/payment-links/CKHP6VVWYT/sharing-events?limit=2&after=GTZH5WVXK9",
"method": "get",
"rel": "next"
},
{
"href": "https://api.payroc.com/v1/payment-links/CKHP6VVWYT/sharing-events?limit=2&before=GKB49GZ6DL",
"method": "get",
"rel": "previous"
}
]
}
},
"ref_a8600843dd7defbf7deb": {
"description": "Type or model of the device.",
"example": "idtechKioskV",
"in": "path",
"name": "model",
"required": true,
"schema": {
"maxLength": 30,
"minLength": 1,
"type": "string"
}
},
"ref_a8ae0075bcc4b67292b5": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_f9d963d00740bbe00c9e"
},
{
"properties": {
"data": {
"description": "Array of transactions.",
"items": {
"$ref": "#/x-devx-bundled/ref_9939e4d9d5c3293a1455"
},
"type": "array"
}
},
"type": "object"
}
],
"required": [
"count",
"data",
"hasMore",
"limit"
],
"type": "object"
},
"ref_a8c42d7993030cdfd2f1": {
"description": "Create a pre-authorization",
"summary": "Create a pre-authorization",
"value": {
"card": {
"cardNumber": "453985******7062",
"entryMethod": "keyed",
"expiryDate": "1230",
"securityChecks": {
"avsResult": "U"
},
"type": "Visa Credit"
},
"customer": {
"billingAddress": {
"address1": "1 Example Ave.",
"address2": "Example Address Line 2",
"address3": "Example Address Line 3",
"city": "Chicago",
"country": "US",
"postalCode": "60056",
"state": "Illinois"
},
"firstName": "Sarah",
"lastName": "Hopper",
"shippingAddress": {
"address": {
"address1": "1 Example Ave.",
"address2": "Example Address Line 2",
"address3": "Example Address Line 3",
"city": "Chicago",
"country": "US",
"postalCode": "60056",
"state": "Illinois"
},
"recipientName": "Sarah Hopper"
}
},
"operator": "Jane",
"order": {
"amount": 9999,
"currency": "USD",
"dateTime": "2024-07-02T15:30:00Z",
"description": "Large Pepperoni Pizza",
"orderId": "OrderRef6543"
},
"paymentId": "M2MJOG6O2Y",
"processingTerminalId": "1234001",
"supportedOperations": [
"capture",
"fullyReverse",
"partiallyReverse",
"incrementAuthorization",
"setAsReady"
],
"transactionResult": {
"approvalCode": "OK3",
"authorizedAmount": 9999,
"currency": "USD",
"processorResponseCode": "00",
"responseCode": "A",
"responseMessage": "APPROVAL",
"status": "pending",
"type": "sale"
}
}
},
"ref_a8e33140e7edbc2c532e": {
"description": "Indicates how authorized transactions will be batched for settlement",
"properties": {
"batchCloseTime": {
"description": "The time, within the specified timezone, at which the batch automatically closes",
"example": "23:40",
"maxLength": 5,
"type": "string"
},
"batchCloseType": {
"description": "Indicates whether batch settlement of authorized transactions are automatically or manually closed",
"enum": [
"automatic"
],
"type": "string"
}
},
"required": [
"batchCloseType",
"batchCloseTime"
],
"title": "automatic",
"type": "object"
},
"ref_a911f07c5b4759ee8471": {
"description": "Object that contains information about the ACH deposit fee.",
"properties": {
"achDeposit": {
"$ref": "#/x-devx-bundled/ref_d84ea69cff6ee961bfe4"
},
"adjustmentDate": {
"description": "Date of the adjustment. The format of this value is **YYYY-MM-DD**.",
"example": "2024-07-02",
"format": "date",
"type": "string"
},
"amount": {
"description": "Total value of ACH deposit fee.",
"example": 100,
"type": "integer"
},
"associationDate": {
"description": "Date that we sent the transaction to the cards brands for clearing. The format of this value is **YYYY-MM-DD**.",
"example": "2024-07-02",
"format": "date",
"type": "string"
},
"description": {
"description": "Description of the ACH deposit fee.",
"example": "Month-End Fees Credit Processing",
"type": "string"
},
"merchant": {
"$ref": "#/x-devx-bundled/ref_67c77db80e4fded0ad81"
}
},
"title": "ACH deposit fee",
"type": "object"
},
"ref_a92561cbba84d7ff51f3": {
"description": "Test operation validates that a value at the target location equals the specified value.",
"summary": "Update event subscription: test",
"value": [
{
"op": "test",
"path": "/enabled",
"value": true
}
]
},
"ref_a96c55b0181acbd6d321": {
"description": "Remove operation deletes a value from the event subscription.",
"summary": "Update event subscription: remove",
"value": [
{
"op": "remove",
"path": "/metadata/yourCustomField"
}
]
},
"ref_a9d70376596ad36868dd": {
"description": "Retrieve processing accounts associated with a merchant platform.",
"summary": "Paginated list of processing account",
"value": {
"count": 2,
"data": [
{
"addendums": [],
"address": {
"address1": "1 Example Ave.",
"address2": "Example Address Line 2",
"address3": "Example Address Line 3",
"city": "Chicago",
"country": "US",
"postalCode": "60056",
"state": "Illinois"
},
"businessStartDate": "2020-01-01",
"businessType": "restaurant",
"categoryCode": 5999,
"contactMethods": [
{
"type": "email",
"value": "example-corp@example.com"
},
{
"type": "phone",
"value": "123 456 7890"
}
],
"contacts": [
{
"contactId": 1543,
"firstName": "Jane",
"lastName": "Doe",
"link": {
"href": "https://api.payroc.com/v1/contacts/1543",
"method": "get",
"rel": "owner"
}
}
],
"createdDate": "2024-07-02T12:00:00.000+00:00",
"doingBusinessAs": "Pizza Doe",
"funding": {
"acceleratedFundingFee": 1999,
"fundingAccounts": [
{
"fundingAccountId": 123,
"link": {
"href": "https://api.payroc.com/v1/funding-accounts/123",
"method": "get",
"rel": "fundingAccount"
},
"status": "pending"
}
],
"fundingSchedule": "nextday",
"status": "enabled"
},
"lastModifiedDate": "2024-07-02T12:00:00.000+00:00",
"merchandiseOrServiceSold": "Food",
"owners": [
{
"firstName": "Jane",
"lastName": "Doe",
"link": {
"href": "https://api.payroc.com/v1/owners/4564",
"method": "get",
"rel": "owner"
},
"ownerId": 4564
}
],
"pricing": {
"link": {
"href": "https://api.payroc.com/v1/processing-accounts/12345/pricing",
"method": "get",
"rel": "pricing"
}
},
"processing": {
"ach": {
"estimatedMonthlyTransactions": 1000,
"limits": {
"dailyDeposit": 1000,
"monthlyDeposit": 2000,
"singleTransaction": 10000000
},
"naics": "5812",
"previouslyTerminatedForAch": false,
"refunds": {
"refundPolicyUrl": "http://www.example.com/refunds",
"writtenRefundPolicy": true
},
"transactionTypes": [
"telephoneInitiatedPayment",
"webInitiatedPayment"
]
},
"cardAcceptance": {
"cardsAccepted": [
"visa",
"mastercard"
],
"debitOnly": false,
"hsaFsa": false,
"specialityCards": {
"americanExpressDirect": {
"enabled": true,
"merchantNumber": "1234567890"
},
"electronicBenefitsTransfer": {
"enabled": true,
"fnsNumber": "1234567"
},
"other": {
"fleetMerchantId": "1234567890",
"voyagerMerchantId": "1234567890",
"wexMerchantNumber": "1234567890"
}
}
},
"isSeasonal": true,
"merchantId": "444412365478965",
"monthlyAmounts": {
"average": 1000000,
"highest": 200000000
},
"monthsOfOperation": [
"jan",
"feb",
"mar",
"nov",
"dec"
],
"transactionAmounts": {
"average": 1000,
"highest": 200000
},
"volumeBreakdown": {
"cardPresent": 77,
"ecommerce": 20,
"mailOrTelephone": 3
}
},
"processingAccountId": "38765",
"processor": "tsys",
"signature": {
"type": "requestedViaEmail"
},
"status": "approved",
"timezone": "America/Chicago",
"website": "www.example.com"
},
{
"addendums": [],
"address": {
"address1": "3 Example Ave.",
"address2": "Example Address Line 2",
"address3": "Example Address Line 3",
"city": "Chicago",
"country": "US",
"postalCode": "60056",
"state": "Illinois"
},
"businessStartDate": "2020-01-01",
"businessType": "internet",
"categoryCode": 5999,
"contactMethods": [
{
"type": "email",
"value": "jane.doe@example.com"
},
{
"type": "phone",
"value": "555 555 3456"
}
],
"contacts": [
{
"contactId": 1543,
"firstName": "Jane",
"lastName": "Doe",
"link": {
"href": "https://api.payroc.com/v1/contacts/1543",
"method": "get",
"rel": "owner"
}
}
],
"createdDate": "2024-07-02T12:00:00.000+00:00",
"doingBusinessAs": "Doe Hot Dogs",
"funding": {
"acceleratedFundingFee": 1999,
"fundingAccounts": [
{
"fundingAccountId": 124,
"link": {
"href": "https://api.payroc.com/v1/funding-accounts/124",
"method": "get",
"rel": "fundingAccount"
},
"status": "pending"
}
],
"fundingSchedule": "nextday",
"status": "enabled"
},
"lastModifiedDate": "2024-07-02T12:00:00.000+00:00",
"merchandiseOrServiceSold": "Food",
"owners": [
{
"firstName": "Jane",
"lastName": "Doe",
"link": {
"href": "https://api.payroc.com/v1/owners/4564",
"method": "get",
"rel": "owner"
},
"ownerId": 4564
}
],
"pricing": {
"link": {
"href": "https://api.payroc.com/v1/processing-accounts/12346/pricing",
"method": "get",
"rel": "pricing"
}
},
"processing": {
"isSeasonal": true,
"merchantId": "444412365478966",
"monthlyAmounts": {
"average": 2000000,
"highest": 300000000
},
"transactionAmounts": {
"average": 2000,
"highest": 300000
},
"volumeBreakdown": {
"cardPresent": 0,
"ecommerce": 100,
"mailOrTelephone": 0
}
},
"processingAccountId": "38766",
"processor": "tsys",
"signature": {
"type": "requestedViaEmail"
},
"status": "approved",
"timezone": "America/Chicago",
"website": "www.example.com"
}
],
"hasMore": true,
"limit": 2,
"links": [
{
"href": "https://api.payroc.com/v1/merchant-platforms/12345/processing-accounts?before=38765&limit=2",
"method": "get",
"rel": "previous"
},
{
"href": "https://api.payroc.com/v1/merchant-platforms/12345/processing-accounts?after=38766&limit=2",
"method": "get",
"rel": "next"
}
]
}
},
"ref_aa08a6b5181eb570f201": {
"description": "Filter results by the account holder's name.",
"examples": {
"example": {
"value": "Sarah%20Hazel%20Hopper"
}
},
"in": "query",
"name": "nameOnAccount",
"schema": {
"maxLength": 50,
"minLength": 1,
"type": "string"
}
},
"ref_ab2d4f80b9ccfeea47e7": {
"description": "Create a pricing intent.",
"summary": "Interchange Plus",
"value": {
"base": {
"addressVerification": 5,
"annualFee": {
"amount": 9900,
"billInMonth": "june"
},
"batch": 1500,
"chargeback": 2500,
"earlyTermination": 57500,
"maintenance": 500,
"minimum": 100,
"pciNonCompliance": 4995,
"platinumSecurity": {
"billingFrequency": "monthly"
},
"regulatoryAssistanceProgram": 15,
"retrieval": 1500,
"voiceAuthorization": 95
},
"country": "US",
"key": "Your-Unique-Identifier",
"metadata": {
"yourCustomField": "abc123"
},
"processor": {
"card": {
"fees": {
"amex": {
"transaction": 0,
"type": "optBlue",
"volume": 0.12
},
"mastercardVisaDiscover": {
"transaction": 0,
"volume": 0.12
}
},
"planType": "interchangePlus"
}
},
"services": [
{
"enabled": true,
"name": "hardwareAdvantagePlan"
}
],
"version": "5.2"
}
},
"ref_ab4750ca54e918c1794a": {
"description": "Contact object",
"summary": "Contact object",
"value": {
"contactId": 1543,
"contactMethods": [
{
"type": "email",
"value": "jane.doe@example.com"
},
{
"type": "phone",
"value": "2025550164"
},
{
"type": "mobile",
"value": "8445557624"
},
{
"type": "fax",
"value": "2025550110"
}
],
"firstName": "Jane",
"identifiers": [
{
"type": "nationalId",
"value": "xxxxx4320"
}
],
"lastName": "Doe",
"middleName": "Helen",
"type": "manager"
}
},
"ref_aba32470cfc5f673a3ca": {
"description": "Unique identifier that our gateway assigned to the refund.",
"examples": {
"example": {
"value": "CD3HN88U9F"
}
},
"in": "path",
"name": "refundId",
"required": true,
"schema": {
"maxLength": 10,
"minLength": 10,
"type": "string"
}
},
"ref_ac099976d4eaf2dbdeec": {
"properties": {
"bankAccount": {
"description": "Polymorphic object that contains bank account information. \n\nThe value of the type field determines which variant you should use: \n-\t`ach` - Automated Clearing House (ACH) details\n-\t`pad` - Pre-authorized debit (PAD) details\n",
"discriminator": {
"mapping": {
"ach": "../../../common/schemas/transaction/bank-account-v1.yaml#/components/schemas/achBankAccount",
"pad": "../../../common/schemas/transaction/bank-account-v1.yaml#/components/schemas/padBankAccount"
},
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/x-devx-bundled/ref_e755fa4f263b012bbbe7"
},
{
"$ref": "#/x-devx-bundled/ref_8ccc8aafcd9c8e176b79"
}
],
"type": "object"
},
"customFields": {
"description": "Array of customField objects.\n",
"items": {
"$ref": "#/x-devx-bundled/ref_91509fee696e20aa30f2"
},
"type": "array"
},
"customer": {
"$ref": "#/x-devx-bundled/ref_99ef61275025cb524caf"
},
"order": {
"$ref": "#/x-devx-bundled/ref_f640737cfbed9624abf9"
},
"payment": {
"$ref": "#/x-devx-bundled/ref_55cbf93e50dd5644578a",
"description": "Object that contains information about the payment that the refund is linked to. \n\n**Note:** We don't return this object for unreferenced refunds. \n"
},
"processingTerminalId": {
"description": "Unique identifier that we assigned to the terminal.",
"example": "1234001",
"maxLength": 50,
"minLength": 4,
"type": "string"
},
"refundId": {
"description": "Unique identifier that our gateway assigned to the refund.",
"example": "CD3HN88U9F",
"maxLength": 10,
"minLength": 10,
"type": "string"
},
"transactionResult": {
"$ref": "#/x-devx-bundled/ref_f79ede1604f3256458f6"
}
},
"required": [
"bankAccount",
"order",
"processingTerminalId",
"refundId",
"transactionResult"
],
"type": "object"
},
"ref_ac1dd76e32ce419051f4": {
"description": "Object that contains information about the order.",
"properties": {
"charge": {
"description": "Polymorphic object that indicates who enters the amount for the payment link. \n\nThe value of the type parameter determines which variant you should use: \n-\t`prompt` - Customer enters the amount.\n-\t`preset` - Merchant sets the amount. \n",
"oneOf": [
{
"$ref": "#/x-devx-bundled/ref_955602fc29d58cfc1b13"
},
{
"$ref": "#/x-devx-bundled/ref_ee94622e3f9da4e9ce9b"
}
],
"type": "object"
},
"description": {
"description": "A brief description of the transaction.",
"example": "Large Pepperoni Pizza",
"maxLength": 1024,
"type": "string"
},
"orderId": {
"description": "Unique identifier that the merchant assigned to the order.",
"example": "OrderRef7654",
"maxLength": 24,
"minLength": 1,
"type": "string"
}
},
"required": [
"orderId",
"charge"
],
"type": "object"
},
"ref_ac65d706ccd09f715e75": {
"description": "When you create a processing account, we send a copy of the pricing agreement to the merchant to sign. You can choose to send them a copy of the pricing agreement by email, or you can generate a link to the pricing agreement.
\nIf you requested the merchant's signature by email and they don't respond, use our Reminders endpoint to create a reminder and to send another email.
\n**Note:** You can use the Reminders endpoint only if you request the merchant's signature by email. If you generate a link to the pricing agreement, you can't use the Reminders endpoint. \n",
"summary": "Create reminder for processing account",
"value": {
"type": "pricingAgreement"
}
},
"ref_ac8399da4ad96bb34ceb": {
"description": "Multi-use payment link that we created.",
"summary": "Multi-use payment link",
"value": {
"assets": {
"paymentButton": "SUPPORT US\n",
"paymentUrl": "https://payments.payroc.com/merchant/pay-by-link?token=02ada211-ff51-4845-b0b5-e685aeb4b19d"
},
"authType": "sale",
"createdOn": "2024-09-24",
"customLabels": [
{
"element": "paymentButton",
"label": "SUPPORT US"
}
],
"merchantReference": "LinkRef6543",
"order": {
"charge": {
"currency": "USD",
"type": "prompt"
},
"description": "Pie It Forward charitable trust donation"
},
"paymentLinkId": "JZURRJBUPS",
"paymentMethods": [
"card",
"bankTransfer"
],
"status": "active",
"type": "multiUse"
}
},
"ref_aca19c0e9ba8e5923c83": {
"description": "Filter by funding instructions sent after a specific date. Send a value in **YYYY-MM-DD** format.",
"examples": {
"example": {
"value": "2024-07-01"
}
},
"in": "query",
"name": "dateFrom",
"required": true,
"schema": {
"format": "date",
"type": "string"
}
},
"ref_accebd8fb8662e2dfcef": {
"properties": {
"transaction": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_109fe7e5f018de7ee04b"
}
],
"description": "Fee for each transaction. The value is in the currency's lowest denomination, for example, cents."
},
"type": {
"description": "Type of American Express program.",
"enum": [
"direct"
],
"type": "string"
}
},
"required": [
"type",
"transaction"
],
"title": "direct",
"type": "object"
},
"ref_aceed7495a711cbfb898": {
"description": "Example response returned from a close-batch request",
"summary": "Close-batch response",
"value": {
"cutOffTime": "13:55",
"timezone": "Pacific/Midway"
}
},
"ref_ae89d3d539618a89d2dd": {
"content": {
"application/problem+json": {
"examples": {
"badRequest": {
"$ref": "#/x-devx-bundled/ref_2b3621a1c5ae119c6693"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_9477586d4a50bb60f5a4"
}
}
},
"description": "Invalid request"
},
"ref_ae8cb5ff6737954e04c4": {
"description": "Add operation adds a new value to an object or array.",
"summary": "Update secure token: add",
"value": [
{
"op": "add",
"path": "/customFields",
"value": {
"name": "loyaltyTier",
"value": "gold"
}
}
]
},
"ref_af4c19209ffc646d3ee0": {
"description": "Example of a paginated pricing intent.",
"summary": "Paginated pricing intent",
"value": {
"count": 1,
"data": [
{
"base": {
"addressVerification": 5,
"annualFee": {
"amount": 100,
"billInMonth": "june"
},
"batch": 1000,
"chargeback": 2500,
"earlyTermination": 57500,
"maintenance": 500,
"minimum": 100,
"pciNonCompliance": 4995,
"platinumSecurity": {
"amount": 1295,
"billingFrequency": "monthly"
},
"regulatoryAssistanceProgram": 15,
"retrieval": 1500,
"voiceAuthorization": 95
},
"country": "US",
"createdDate": "2024-07-02T09:00:00Z",
"gateway": {
"fees": {
"monthly": 1000,
"perDeviceMonthly": 0,
"perTransaction": 0,
"setup": 25000
}
},
"id": "5",
"key": "base",
"lastUpdatedDate": "2024-07-02T09:00:00Z",
"processor": {
"ach": {
"fees": {
"accountVerification": 100,
"batch": 1000,
"discountRateAbove10000": 10,
"discountRateUnder10000": 5.25,
"monthlyMinimum": 20000,
"returns": 400,
"statement": 800,
"transaction": 50,
"unauthorizedReturn": 1999
}
},
"card": {
"fees": {
"amex": {
"transaction": 10,
"type": "optBlue",
"volume": 1.25
},
"electronicBenefitsTransfer": {
"transaction": 10
},
"mastercardVisaDiscover": {
"transaction": 5,
"volume": 1.25
},
"pinDebit": {
"additionalDiscount": 1.25,
"monthlyAccess": 1200,
"transaction": 10
},
"specialityCards": {
"transaction": 10
}
},
"planType": "interchangePlus"
}
},
"services": [
{
"enabled": true,
"name": "hardwareAdvantagePlan"
}
],
"status": "pendingReview",
"version": "5.2"
}
],
"hasMore": true,
"limit": 1,
"links": [
{
"href": "https://api.payroc.com/v1/pricing-intents?before=5&limit=1",
"method": "get",
"rel": "previous"
},
{
"href": "https://api.payroc.com/v1/pricing-intents?after=5&limit=1",
"method": "get",
"rel": "next"
}
]
}
},
"ref_af9f49bdb6f99196dce8": {
"description": "Object that contains information about tiered pricing with three tiers.",
"properties": {
"fees": {
"description": "Object that contains information about the fees.",
"properties": {
"amex": {
"description": "Polymorphic object that contains fees for American Express transactions. \n\nThe value of the type field determines which variant you should use: \n-\t`optBlue` - Amex OptBlue pricing program.\n-\t`direct` - Amex Direct pricing program.\n",
"discriminator": {
"mapping": {
"direct": "#/components/schemas/tiered3AmexDirect",
"optBlue": "#/components/schemas/tiered3AmexOptBlue"
},
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/x-devx-bundled/ref_1794e8f5d9df0ea00937"
},
{
"$ref": "#/x-devx-bundled/ref_accebd8fb8662e2dfcef"
}
]
},
"electronicBenefitsTransfer": {
"$ref": "#/x-devx-bundled/ref_2c771c635a39c1d2ba57"
},
"mastercardVisaDiscover": {
"$ref": "#/x-devx-bundled/ref_eb68f2c28371d61b1260",
"description": "Object that contains the fees for Mastercard, Visa, and Discover transactions."
},
"pinDebit": {
"$ref": "#/x-devx-bundled/ref_39ea196745f35c0c62a3"
},
"specialityCards": {
"$ref": "#/x-devx-bundled/ref_ca2b35d2127e00c3b179"
}
},
"required": [
"mastercardVisaDiscover"
],
"type": "object"
},
"planType": {
"description": "Type of processing plan.",
"enum": [
"tiered3"
],
"type": "string"
}
},
"required": [
"planType",
"fees"
],
"title": "Tiered pricing with three tiers",
"type": "object"
},
"ref_b0282f068ebbc85b31df": {
"description": "Terminal order",
"summary": "Terminal order",
"value": {
"orderItems": [
{
"createdDate": "2024-07-02T12:00:00.000Z",
"deviceCondition": "new",
"lastModifiedDate": "2024-07-02T12:00:00.000Z",
"links": [
{
"link": {
"href": "https://api.payroc.com/v1/processing-terminals/38765",
"method": "get",
"rel": "processingTerminal"
},
"processingTerminalId": "38765"
}
],
"paymentIntent": {
"link": {
"href": "https://api.payroc.com/v1/payment-intents/1542",
"method": "get",
"rel": "paymentIntent"
},
"paymentIntentId": "1542",
"paymentIntentType": "purchase"
},
"solutionQuantity": 1,
"solutionSetup": {
"applicationSettings": {
"clerkPrompt": false,
"security": {
"keyedSalePassword": false,
"refundPassword": true,
"reversalPassword": true
}
},
"batchClosure": {
"batchCloseTime": "23:40",
"batchCloseType": "automatic"
},
"deviceSettings": {
"communicationType": "wifi",
"numberOfMobileUsers": 2
},
"gatewaySettings": {
"merchantPortfolioId": "Example Corp",
"merchantTemplateId": "Example Corp Merchant Template",
"terminalTemplateId": "Example Corp Terminal Template",
"userTemplateId": "Example Corp User Template"
},
"industryTemplateId": "Retail",
"receiptNotifications": {
"emailReceipt": true,
"smsReceipt": false
},
"taxes": [
{
"taxLabel": "Sales Tax",
"taxRate": 6
}
],
"timezone": "America/Chicago",
"tips": {
"enabled": false
},
"tokenization": true
},
"solutionTemplateId": "Roc Services_DX8000",
"type": "solution"
}
],
"shipping": {
"address": {
"addressLine1": "1 Example Ave.",
"addressLine2": "Example Address Line 2",
"businessName": "Example Corp",
"city": "Chicago",
"email": "jane.doe@example.com",
"phone": "2025550164",
"postalCode": "60056",
"recipientName": "Jane Doe",
"state": "Illinois"
},
"preferences": {
"method": "nextDay",
"saturdayDelivery": true
}
},
"status": "open",
"terminalOrderId": "2346",
"trainingProvider": "payroc"
}
},
"ref_b064a307eb20a800a23c": {
"description": "Partially update an existing payment link. \nStructure your request to follow the RFC 6902 standard.\n",
"summary": "Partially update payment link",
"value": [
{
"op": "replace",
"path": "/expiresOn",
"value": "2024-10-25"
}
]
},
"ref_b0b4930f5830799eddd0": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_bb4eb3fe9ae988b55c71"
},
{
"properties": {
"source": {
"description": "Polymorphic object that contains the payment method that we tokenized. \n\nThe value of the type parameter determines which variant you should use: \n-\t`ach` - Automated Clearing House (ACH) details\n-\t`pad` - Pre-authorized debit (PAD) details\n-\t`card` - Payment card details\n",
"discriminator": {
"mapping": {
"ach": "../../../common/schemas/transaction/bank-account-v1.yaml#/components/schemas/achSourceWithAccountType",
"card": "../../../common/schemas/transaction/card-v1.yaml#/components/schemas/cardSource",
"pad": "../../../common/schemas/transaction/bank-account-v1.yaml#/components/schemas/padSourceWithAccountType"
},
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/x-devx-bundled/ref_699821d417951d54b9d8"
},
{
"$ref": "#/x-devx-bundled/ref_771c5ab6f019403ab8ae"
},
{
"$ref": "#/x-devx-bundled/ref_0476f87aaec738b51c8e"
}
],
"type": "object"
}
},
"type": "object"
}
]
},
"ref_b0c11212077c3729f490": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_455786580bede80085f8"
},
{
"properties": {
"taxes": {
"description": "Array of objects that contain information about each tax that applies to the item.\n\nRequired for [Level 3 and CEDP transactions](https://docs.payroc.com/knowledge/card-payments/enhanced-data).\n",
"items": {
"$ref": "#/x-devx-bundled/ref_ff9e53b467436d074a75"
},
"type": "array"
}
},
"type": "object"
}
],
"type": "object"
},
"ref_b394dd97f528cb101adf": {
"description": "One or more validation errors occurred",
"summary": "Bad Request",
"value": {
"detail": "One or more validation errors occurred, see error section for more info",
"errors": [
{
"detail": "invalid value",
"message": "Expected integer, got abc",
"parameter": "before"
}
],
"status": 400,
"title": "Bad request",
"type": "https://docs.payroc.com/api/errors#bad-request"
}
},
"ref_b431b957bb62172688d7": {
"description": "Deactivated multi-use payment link.",
"summary": "Payment link",
"value": {
"assets": {
"paymentButton": "SUPPORT US\n",
"paymentUrl": "https://payments.payroc.com/merchant/pay-by-link?token=02ada211-ff51-4845-b0b5-e685aeb4b19d"
},
"authType": "sale",
"createdOn": "2024-07-24",
"customLabels": [
{
"element": "paymentButton",
"label": "SUPPORT US"
}
],
"merchantReference": "LinkRef6543",
"order": {
"charge": {
"currency": "USD",
"type": "prompt"
},
"description": "Pie It Forward charitable trust donation"
},
"paymentLinkId": "JZURRJBUPS",
"paymentMethods": [
"card",
"bankTransfer"
],
"status": "deactivated",
"type": "multiUse"
}
},
"ref_b54ec0fee326408828f5": {
"description": "Example of a paginated list of event subscriptions",
"summary": "Paginated list of Event subscriptions",
"value": {
"count": 2,
"data": [
{
"enabled": true,
"eventTypes": [
"processingAccount.status.changed"
],
"id": 2565435189324,
"metadata": {
"yourCustomField": "abc123"
},
"notifications": [
{
"secret": "**********oP3456",
"supportEmailAddress": "jane.doe@example.com",
"type": "webhook",
"uri": "https://my-server/notification/endpoint"
}
],
"status": "registered"
},
{
"enabled": true,
"eventTypes": [
"processingAccount.riskStatus.changed"
],
"id": 2565435189325,
"metadata": {
"yourCustomField": "abc123"
},
"notifications": [
{
"secret": "**********oP3456",
"supportEmailAddress": "jane.doe@example.com",
"type": "webhook",
"uri": "https://my-server/notification/endpoint"
}
],
"status": "registered"
}
],
"hasMore": false,
"limit": 10,
"links": [
{
"href": "https://api.payroc.com/v1/event-subscriptions?after=10&limit=10",
"method": "get",
"rel": "next"
}
]
}
},
"ref_b6329324bae9fba46ed8": {
"description": "Object that contains the shipping details for the terminal order. If you don't provide a shipping address, we use the Doing Business As (DBA) address of the processing account.",
"properties": {
"address": {
"description": "Object that contains the shipping address for the terminal order.",
"properties": {
"addressLine1": {
"description": "First line of the shipment address.",
"maxLength": 100,
"type": "string"
},
"addressLine2": {
"description": "Second line of the shipment address.",
"maxLength": 100,
"type": "string"
},
"businessName": {
"description": "Name of the business receiving the shipment.",
"maxLength": 100,
"type": "string"
},
"city": {
"description": "City of the shipment address.",
"maxLength": 50,
"type": "string"
},
"email": {
"description": "Contact email address for the shipment.",
"format": "email",
"maxLength": 100,
"type": "string"
},
"phone": {
"description": "Contact number for the shipment.",
"maxLength": 15,
"type": "string"
},
"postalCode": {
"description": "Postal code of the shipment address.",
"maxLength": 9,
"type": "string"
},
"recipientName": {
"description": "Name of the person receiving the shipment.",
"maxLength": 100,
"type": "string"
},
"state": {
"description": "State of the shipment address.",
"maxLength": 30,
"type": "string"
}
},
"required": [
"recipientName",
"addressLine1",
"city",
"state",
"postalCode",
"email"
],
"type": "object"
},
"preferences": {
"description": "Object that contains the shipping preferences for the terminal order.",
"properties": {
"method": {
"default": "nextDay",
"description": "Shipping method for the terminal order. Send one of the following values:\n - `nextDay` - We schedule the order to be delivered the next day.\n - `ground` - We ship the order with ground shipping.\n",
"enum": [
"nextDay",
"ground"
],
"type": "string"
},
"saturdayDelivery": {
"default": false,
"description": "Indicates if we can schedule the terminal order to be delivered on a Saturday.",
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"ref_b646705a6cc76da0b164": {
"description": "Indicates how the device communicates with its host.",
"enum": [
"bluetooth",
"cellular",
"ethernet",
"wifi"
],
"maxLength": 9,
"type": "string"
},
"ref_b65288f9c4e554ac3078": {
"description": "Create a merchant platform with the Roc Giving Addendum appended to the Merchant Processing Agreement.",
"summary": "Create a merchant platform with Roc Giving Addendum",
"value": {
"business": {
"addresses": [
{
"address1": "1 Example Ave.",
"address2": "Example Address Line 2",
"address3": "Example Address Line 3",
"city": "Chicago",
"country": "US",
"postalCode": "60056",
"state": "Illinois",
"type": "legalAddress"
}
],
"contactMethods": [
{
"type": "email",
"value": "jane.doe@example.com"
}
],
"countryOfOperation": "US",
"name": "Example Corp",
"organizationType": "privateCorporation",
"taxId": "12-3456789"
},
"metadata": {
"customerId": "2345"
},
"processingAccounts": [
{
"addendums": [
{
"accountAdminContact": {
"emailAddress": "jane.doe@example.com",
"firstName": "Jane",
"lastName": "Doe",
"phone": "2025550164"
},
"autoCloseTime": "23:40",
"donorSupportPercentage": 2.5,
"plan": "basic",
"type": "rocGivingV1"
}
],
"address": {
"address1": "1 Example Ave.",
"address2": "Example Address Line 2",
"address3": "Example Address Line 3",
"city": "Chicago",
"country": "US",
"postalCode": "60056",
"state": "Illinois"
},
"businessStartDate": "2020-01-01",
"businessType": "restaurant",
"categoryCode": 5999,
"contactMethods": [
{
"type": "email",
"value": "jane.doe@example.com"
}
],
"doingBusinessAs": "Pizza Doe",
"funding": {
"acceleratedFundingFee": 1999,
"dailyDiscount": false,
"fundingAccounts": [
{
"metadata": {
"yourCustomField": "abc123"
},
"nameOnAccount": "Jane Doe",
"paymentMethods": [
{
"type": "ach",
"value": {
"accountNumber": "321831591",
"routingNumber": "063100277"
}
}
],
"type": "checking",
"use": "creditAndDebit"
}
],
"fundingSchedule": "nextday"
},
"merchandiseOrServiceSold": "Pizza",
"metadata": {
"customerId": "2345"
},
"owners": [
{
"address": {
"address1": "1 Example Ave.",
"address2": "Example Address Line 2",
"address3": "Example Address Line 3",
"city": "Chicago",
"country": "US",
"postalCode": "60056",
"state": "Illinois"
},
"contactMethods": [
{
"type": "email",
"value": "jane.doe@example.com"
}
],
"dateOfBirth": "1964-03-22",
"firstName": "Jane",
"identifiers": [
{
"type": "nationalId",
"value": "000-00-4320"
}
],
"lastName": "Doe",
"middleName": "Helen",
"relationship": {
"equityPercentage": 48.5,
"isAuthorizedSignatory": false,
"isControlProng": true,
"title": "CFO"
}
}
],
"pricing": {
"pricingIntentId": "6123",
"type": "intent"
},
"processing": {
"monthlyAmounts": {
"average": 3000,
"highest": 100000
},
"transactionAmounts": {
"average": 4500,
"highest": 50000
},
"volumeBreakdown": {
"cardPresent": 80,
"ecommerce": 0,
"mailOrTelephone": 20
}
},
"processor": "tsys",
"signature": {
"type": "requestedViaDirectLink"
},
"timezone": "America/Chicago",
"website": "www.example.com"
}
]
}
},
"ref_b6fed5bc2d8edc10b7f0": {
"properties": {
"transaction": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_109fe7e5f018de7ee04b"
}
],
"description": "Fee for each transaction. The value is in the currency's lowest denomination, for example, cents."
},
"type": {
"description": "Type of American Express program.",
"enum": [
"direct"
],
"type": "string"
}
},
"required": [
"type",
"transaction"
],
"title": "direct",
"type": "object"
},
"ref_b70be651077357504b4a": {
"description": "Object that contains information about the Integrated Circuit Card (ICC).",
"properties": {
"cardholderSignature": {
"description": "Cardholder's signature. For more information about how to format the signature, go to [How to send a signature to our gateway](https://docs.payroc.com/knowledge/basic-concepts/signature-capture).",
"example": "012345678a000b000c0012345d0e0f010g10061a031i001j071k0a1b0c1d0e1234567890120f1g0h1i0j1k0a1b0123451c012d0e1f0g1h0i1j123k1a1b1c1d1e1f1g123h1i1j1k1a1b1c1d1e1f1g123h123i1j123k12340a120a12345b012c0123012d0d1e0f1g0h1i123j123k1a1b1c0000",
"type": "string"
},
"device": {
"$ref": "#/x-devx-bundled/ref_9b532b6dac98bf9563ff"
},
"downgradeTo": {
"description": "If an offline transaction is not approved using the initial entry method, reprocess the transaction using a downgraded entry method. \nFor example, an Integrated Circuit Card (ICC) transaction can be downgraded to a swiped transaction or a keyed transaction.\n",
"enum": [
"keyed",
"swiped"
],
"example": "swiped",
"type": "string"
},
"ebtDetails": {
"$ref": "#/x-devx-bundled/ref_e4a086f8d857fd3e3dd3"
},
"entryMethod": {
"description": "Method that the terminal used to capture the card details.",
"enum": [
"icc"
],
"example": "icc",
"type": "string"
},
"firstDigitOfPan": {
"description": "First digit of the card number.",
"example": "4",
"maxLength": 1,
"minLength": 1,
"type": "string"
},
"iccData": {
"description": "Cardholder data from the ICC. The data consists of EMV tags in Tag-Length-Value (TLV) format.",
"example": "5A08476173921001010F",
"format": "hexadecimal",
"type": "string"
}
},
"required": [
"entryMethod",
"device",
"iccData"
],
"title": "icc",
"type": "object"
},
"ref_b74f5811f88d18e829a5": {
"description": "Object that contains the fees for account updater service.",
"properties": {
"fees": {
"description": "Object that contains information about the gateway fees.",
"properties": {
"monthly": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_109fe7e5f018de7ee04b"
}
],
"description": "Monthly fee for Account Updater service. The value is in the currency's lowest denomination, for example, cents."
},
"perUpdate": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_109fe7e5f018de7ee04b"
}
],
"description": "Fee for each account update. The value is in the currency's lowest denomination, for example, cents."
},
"setup": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_109fe7e5f018de7ee04b"
}
],
"description": "Setup fee for Account Updater service. The value is in the currency's lowest denomination, for example, cents."
}
},
"required": [
"setup",
"monthly",
"perUpdate"
],
"type": "object"
},
"name": {
"description": "Name of the service.",
"enum": [
"accountUpdater"
],
"example": "accountUpdater",
"type": "string"
}
},
"required": [
"name",
"fees"
],
"type": "object"
},
"ref_b7793096ce4d62ff8422": {
"description": "Example of a payment intent response.",
"summary": "Payment Intent",
"value": {
"costBreakdown": {
"customCharges": [
{
"name": "FleeceCharge",
"value": 500
}
],
"items": [
{
"name": "TariffCosts",
"quantity": 1,
"unitCost": 999
}
],
"shippingCost": 100
},
"payment": {
"frequency": {
"type": "singlePayment"
},
"method": "hostedPaymentPage",
"payer": "merchant",
"status": "pendingPayment"
},
"paymentIntentId": "15387",
"paymentIntentType": "purchase",
"subTotal": 100,
"tax": {
"isTaxExempt": false,
"taxAmount": 100
}
}
},
"ref_b78a8dc49545610d9bab": {
"description": "Object that contains information about the sale and the customer's bank details.",
"properties": {
"bankAccount": {
"description": "Polymorphic object that contains bank account information.\n\nThe value of the type field determines which variant you should use:\n-\t`ach` - Automated Clearing House (ACH) details\n-\t`pad` - Pre-authorized debit (PAD) details\n",
"discriminator": {
"mapping": {
"ach": "../../../common/schemas/transaction/bank-account-v1.yaml#/components/schemas/achBankAccount",
"pad": "../../../common/schemas/transaction/bank-account-v1.yaml#/components/schemas/padBankAccount"
},
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/x-devx-bundled/ref_e755fa4f263b012bbbe7"
},
{
"$ref": "#/x-devx-bundled/ref_8ccc8aafcd9c8e176b79"
}
],
"type": "object"
},
"customFields": {
"description": "Array of customField objects.\n",
"items": {
"$ref": "#/x-devx-bundled/ref_91509fee696e20aa30f2"
},
"type": "array"
},
"customer": {
"$ref": "#/x-devx-bundled/ref_99ef61275025cb524caf"
},
"order": {
"$ref": "#/x-devx-bundled/ref_fc891050b2851d9104f0"
},
"paymentId": {
"description": "Unique identifier that we assigned to the payment.",
"example": "M2MJOG6O2Y",
"maxLength": 10,
"minLength": 10,
"type": "string"
},
"processingTerminalId": {
"description": "Unique identifier that we assigned to the terminal.",
"example": "1234001",
"maxLength": 50,
"minLength": 4,
"type": "string"
},
"refunds": {
"description": "List of refunds issued against the payment.",
"items": {
"$ref": "#/x-devx-bundled/ref_8a40ea359f0502198da9"
},
"type": "array",
"uniqueItems": true
},
"representment": {
"$ref": "#/x-devx-bundled/ref_55cbf93e50dd5644578a",
"description": "Object that contains details about the re-presented payment linked to the return."
},
"returns": {
"description": "List of returns issued against the payment.",
"items": {
"$ref": "#/x-devx-bundled/ref_586da9478dd65b412201"
},
"type": "array",
"uniqueItems": true
},
"transactionResult": {
"$ref": "#/x-devx-bundled/ref_f79ede1604f3256458f6"
}
},
"required": [
"bankAccount",
"order",
"paymentId",
"processingTerminalId",
"transactionResult"
],
"type": "object"
},
"ref_b7b00394b33d048ac7e8": {
"description": "A closed loop read response example.",
"summary": "Closed Loop Read",
"value": {
"closedLoopReadId": "KEO45MAC1U",
"data": {
"cardType": "MiFareClassic",
"uid": "04134ee21f1d80"
},
"processingTerminalId": "1234001",
"readDate": "2024-07-02"
}
},
"ref_b7bc699fee675ee28da3": {
"description": "Copy operation duplicates a value from one location to another.",
"summary": "Update secure token: copy",
"value": [
{
"from": "/customer/firstName",
"op": "copy",
"path": "/customer/lastName"
}
]
},
"ref_b8699e96d2925dd30c72": {
"description": "A Patch Add Operation.",
"properties": {
"op": {
"description": "`add` operation.",
"enum": [
"add"
],
"type": "string"
},
"path": {
"description": "Location where you want to add the value.\nThe format for this value is JSON Pointer.\n",
"type": "string"
},
"value": {
"description": "Value that you want to add to the resource."
}
},
"required": [
"op",
"path",
"value"
],
"title": "Patch Add Operation",
"type": "object"
},
"ref_b891b8ba48185cd163b9": {
"description": "Create a pricing intent.",
"summary": "Reward Pay Choice",
"value": {
"base": {
"addressVerification": 5,
"annualFee": {
"amount": 9900,
"billInMonth": "june"
},
"batch": 1500,
"chargeback": 2500,
"earlyTermination": 57500,
"maintenance": 500,
"minimum": 100,
"pciNonCompliance": 4995,
"platinumSecurity": {
"billingFrequency": "monthly"
},
"regulatoryAssistanceProgram": 15,
"retrieval": 1500,
"voiceAuthorization": 95
},
"country": "US",
"key": "Your-Unique-Identifier",
"metadata": {
"yourCustomField": "abc123"
},
"processor": {
"card": {
"fees": {
"credit": {
"merchantChargePerTransaction": 10,
"tips": "noTips"
},
"debit": {
"option": "interchangePlus",
"transaction": 10,
"volume": 0
},
"monthlySubscription": 5000,
"specialityCards": {
"transaction": 10
}
},
"planType": "rewardPayChoice"
}
},
"services": [
{
"enabled": true,
"name": "hardwareAdvantagePlan"
}
],
"version": "5.2"
}
},
"ref_b8cdc1351709808de954": {
"description": "Object that contains information about the configuration of the POS terminal.",
"properties": {
"quickChip": {
"default": false,
"description": "Indicates if Quick Chip mode is active on a merchant’s POS terminal.",
"example": false,
"type": "boolean"
}
},
"required": [
"quickChip"
],
"type": "object"
},
"ref_b92d206f2e50ffc4c068": {
"description": "Unique identifier that you generate for each request. You must use the [UUID v4 format](https://www.rfc-editor.org/rfc/rfc4122) for the identifier. For more information about the idempotency key, go to [Idempotency](https://docs.payroc.com/api/idempotency).",
"examples": {
"example": {
"value": "8e03978e-40d5-43e8-bc93-6894a57f9324"
}
},
"in": "header",
"name": "Idempotency-Key",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
"ref_b96bfccc904b67e0050e": {
"description": "Object that contains information about the business.",
"properties": {
"addresses": {
"description": "Array of polymorphic objects that contain address information for the business.",
"items": {
"oneOf": [
{
"$ref": "#/x-devx-bundled/ref_de8fdf66f0dd4fd419b2"
}
]
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"contactMethods": {
"description": "Array of polymorphic objects, which contain contact information. \n\n**Note:** You must provide an email address.\n\nThe value of the type parameter determines which variant you should use: \n-\t`email` - Email address \n-\t`phone` - Phone number\n-\t`mobile` - Mobile number\n-\t`fax` - Fax number\n",
"items": {
"$ref": "#/x-devx-bundled/ref_7960ea97dd5f79b93ae4"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"countryOfOperation": {
"description": "Two-digit code for the country that the business operates in. The format follows the [ISO-3166](https://www.iso.org/iso-3166-country-codes.html) standard.",
"enum": [
"US"
],
"example": "US",
"type": "string"
},
"name": {
"description": "Legal name of the business.",
"example": "Pizza Doe",
"maxLength": 100,
"type": "string"
},
"organizationType": {
"description": "Type of organization.",
"enum": [
"privateCorporation",
"publicCorporation",
"nonProfit",
"privateLlc",
"publicLlc",
"privatePartnership",
"publicPartnership",
"soleProprietor"
],
"example": "privateCorporation",
"type": "string"
},
"taxId": {
"description": "Tax ID of the business.",
"example": "12-3456789",
"maxLength": 20,
"type": "string"
}
},
"required": [
"name",
"taxId",
"contactMethods",
"addresses",
"organizationType"
],
"title": "business",
"type": "object"
},
"ref_b97613a1c74f57f86288": {
"description": "Filter results by the link's created date. Send a value in **YYYY-MM-DD** format.",
"examples": {
"example": {
"value": "2024-07-02"
}
},
"in": "query",
"name": "createdOn",
"schema": {
"format": "date",
"type": "string"
}
},
"ref_b98520de58f4ca31a283": {
"description": "One or more validation errors occurred",
"summary": "Bad Request",
"value": {
"detail": "One or more validation errors occurred, see error section for more info",
"errors": [
{
"detail": "invalid value",
"message": "Expected integer, got abc",
"parameter": "batchId"
}
],
"status": 400,
"title": "Bad request",
"type": "https://docs.payroc.com/api/errors#bad-request"
}
},
"ref_bb4eb3fe9ae988b55c71": {
"description": "Object that contains information about the secure token.",
"properties": {
"customFields": {
"description": "Array of customField objects.\n",
"items": {
"$ref": "#/x-devx-bundled/ref_91509fee696e20aa30f2"
},
"type": "array"
},
"customer": {
"$ref": "#/x-devx-bundled/ref_5698b09ff5e98efedc02"
},
"mitAgreement": {
"description": "Indicates how the merchant can use the customer's card details, as agreed by the customer:\n\n- `unscheduled` - Transactions for a fixed or variable amount that are run at a certain pre-defined event.\n- `recurring` - Transactions for a fixed amount that are run at regular intervals, for example, monthly. Recurring transactions don't have a fixed duration and run until the customer cancels the agreement.\n- `installment` - Transactions for a fixed amount that are run at regular intervals, for example, monthly. Installment transactions have a fixed duration.\n",
"enum": [
"unscheduled",
"recurring",
"installment"
],
"example": "recurring",
"type": "string"
},
"processingTerminalId": {
"description": "Unique identifier that we assigned to the terminal.",
"example": "1234001",
"maxLength": 50,
"minLength": 4,
"type": "string"
},
"secureTokenId": {
"description": "Unique identifier that the merchant created for the secure token that represents the customer's payment details.",
"example": "MREF_abc1de23-f4a5-6789-bcd0-12e345678901fa",
"maxLength": 200,
"minLength": 0,
"type": "string"
},
"source": {
"description": "Polymorphic object that contains the payment method that we tokenized. \n\nThe value of the type parameter determines which variant you should use: \n-\t`ach` - Automated Clearing House (ACH) details\n-\t`pad` - Pre-authorized debit (PAD) details\n-\t`card` - Payment card details\n",
"discriminator": {
"mapping": {
"ach": "../../../common/schemas/transaction/bank-account-v1.yaml#/components/schemas/achSource",
"card": "../../../common/schemas/transaction/card-v1.yaml#/components/schemas/cardSource",
"pad": "../../../common/schemas/transaction/bank-account-v1.yaml#/components/schemas/padSource"
},
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/x-devx-bundled/ref_f3a5b8382be8e3b73da0"
},
{
"$ref": "#/x-devx-bundled/ref_9aa3626bbdc7eb1b405e"
},
{
"$ref": "#/x-devx-bundled/ref_0476f87aaec738b51c8e"
}
],
"type": "object"
},
"status": {
"description": "Outcome of a security check on the status of the customer's payment card or bank account. \n\n**Note:** Depending on the merchant's account settings, this feature may be unavailable. \n",
"enum": [
"notValidated",
"cvvValidated",
"validationFailed",
"issueNumberValidated",
"cardNumberValidated",
"bankAccountValidated"
],
"example": "cvvValidated",
"type": "string"
},
"token": {
"description": "Token that the merchant can use in future transactions to represent the customer's payment details. The token: \n- Begins with the six-digit identification number **296753**.\n- Contains up to 12 digits. \n- Contains a single check digit that we calculate using the Luhn algorithm.\n",
"example": "296753123456",
"maxLength": 19,
"minLength": 12,
"type": "string"
}
},
"required": [
"processingTerminalId",
"secureTokenId",
"source",
"status",
"token"
],
"type": "object"
},
"ref_bba41f5c84235f2c1871": {
"description": "Array of operations that you can perform on the transaction. Our gateway can return any of the following values: \n- `capture` - [Capture the payment](https://docs.payroc.com/api/schema/card-payments/payments/capture).\n- `refund` - [Refund the payment](https://docs.payroc.com/api/schema/card-payments/refunds/create-referenced-refund).\n- `fullyReverse` - [Fully reverse the transaction](https://docs.payroc.com/api/schema/card-payments/refunds/reverse).\n- `partiallyReverse` - [Partially reverse the payment](https://docs.payroc.com/api/schema/card-payments/refunds/reverse).\n- `incrementAuthorization` - [Increase the amount of the authorization](https://docs.payroc.com/api/schema/card-payments/payments/adjust).\n- `adjustTip` - [Adjust the tip post-payment](https://docs.payroc.com/api/schema/card-payments/payments/adjust).\n- `addSignature` - [Add a signature to the payment](https://docs.payroc.com/api/schema/card-payments/payments/adjust).\n- `setAsReady` - [Set the transaction’s status to `ready`](https://docs.payroc.com/api/schema/card-payments/payments/adjust).\n- `setAsPending` - [Set the transaction’s status to `pending`](https://docs.payroc.com/api/schema/card-payments/payments/adjust).\n",
"example": [
"capture",
"refund",
"fullyReverse",
"partiallyReverse",
"incrementAuthorization",
"adjustTip",
"addSignature",
"setAsReady",
"setAsPending"
],
"items": {
"enum": [
"capture",
"refund",
"fullyReverse",
"partiallyReverse",
"incrementAuthorization",
"adjustTip",
"addSignature",
"setAsReady",
"setAsPending"
],
"type": "string"
},
"type": "array"
},
"ref_bbf5dd0b28f6c5984e91": {
"description": "Update a specific owner.",
"summary": "Update owner",
"value": {
"address": {
"address1": "1 Example Ave.",
"address2": "Example Address Line 2",
"address3": "Example Address Line 3",
"city": "Chicago",
"country": "US",
"postalCode": "60056",
"state": "Illinois"
},
"contactMethods": [
{
"type": "email",
"value": "jane.doe@example.com"
}
],
"dateOfBirth": "1964-03-22",
"firstName": "Jane",
"identifiers": [
{
"type": "nationalId",
"value": "000-00-4320"
}
],
"lastName": "Doe",
"middleName": "Helen",
"relationship": {
"equityPercentage": 48.5,
"isAuthorizedSignatory": false,
"isControlProng": true,
"title": "CFO"
}
}
},
"ref_bc4b96b694763626a81c": {
"description": "Create a processing account.",
"summary": "Create processing account",
"value": {
"address": {
"address1": "1 Example Ave.",
"address2": "Example Address Line 2",
"address3": "Example Address Line 3",
"city": "Chicago",
"country": "US",
"postalCode": "60056",
"state": "Illinois"
},
"businessStartDate": "2020-01-01",
"businessType": "restaurant",
"categoryCode": 5999,
"contactMethods": [
{
"type": "email",
"value": "jane.doe@example.com"
}
],
"contacts": [
{
"contactMethods": [
{
"type": "email",
"value": "jane.doe@example.com"
}
],
"firstName": "Jane",
"identifiers": [
{
"type": "nationalId",
"value": "000-00-4320"
}
],
"lastName": "Doe",
"middleName": "Helen",
"type": "manager"
}
],
"doingBusinessAs": "Pizza Doe",
"funding": {
"acceleratedFundingFee": 1999,
"dailyDiscount": false,
"fundingAccounts": [
{
"metadata": {
"yourCustomField": "abc123"
},
"nameOnAccount": "Jane Doe",
"paymentMethods": [
{
"type": "ach",
"value": {
"accountNumber": "1234567890",
"routingNumber": "123456789"
}
}
],
"type": "checking",
"use": "creditAndDebit"
}
],
"fundingSchedule": "nextday"
},
"merchandiseOrServiceSold": "Pizza",
"metadata": {
"customerId": "2345"
},
"owners": [
{
"address": {
"address1": "1 Example Ave.",
"address2": "Example Address Line 2",
"address3": "Example Address Line 3",
"city": "Chicago",
"country": "US",
"postalCode": "60056",
"state": "Illinois"
},
"contactMethods": [
{
"type": "email",
"value": "jane.doe@example.com"
}
],
"dateOfBirth": "1964-03-22",
"firstName": "Jane",
"identifiers": [
{
"type": "nationalId",
"value": "000-00-4320"
}
],
"lastName": "Doe",
"middleName": "Helen",
"relationship": {
"equityPercentage": 51.5,
"isAuthorizedSignatory": false,
"isControlProng": true,
"title": "CFO"
}
}
],
"pricing": {
"pricingIntentId": "6123",
"type": "intent"
},
"processing": {
"ach": {
"estimatedMonthlyTransactions": 3000,
"limits": {
"dailyDeposit": 200000,
"monthlyDeposit": 6000000,
"singleTransaction": 10000
},
"naics": "5812",
"previouslyTerminatedForAch": false,
"refunds": {
"refundPolicyUrl": "http://www.example.com/refunds",
"writtenRefundPolicy": true
},
"transactionTypes": [
"prearrangedPayment",
"other"
],
"transactionTypesOther": "recurringBilling"
},
"cardAcceptance": {
"cardsAccepted": [
"visa",
"mastercard"
],
"debitOnly": false,
"hsaFsa": false,
"specialityCards": {
"americanExpressDirect": {
"enabled": true,
"merchantNumber": "abc1234567"
},
"electronicBenefitsTransfer": {
"enabled": true,
"fnsNumber": "6789012"
},
"other": {
"fleetMerchantId": "abc1234567",
"voyagerMerchantId": "abc1234567",
"wexMerchantNumber": "abc1234567"
}
}
},
"isSeasonal": true,
"monthlyAmounts": {
"average": 50000,
"highest": 100000
},
"monthsOfOperation": [
"jan",
"feb"
],
"transactionAmounts": {
"average": 5000,
"highest": 10000
},
"volumeBreakdown": {
"cardPresent": 77,
"ecommerce": 20,
"mailOrTelephone": 3
}
},
"processor": "tsys",
"signature": {
"type": "requestedViaDirectLink"
},
"timezone": "America/Chicago",
"website": "www.example.com"
}
},
"ref_bc5449817f6e001fe0c5": {
"description": "Payment that we processed with a keyed card.",
"summary": "Card Payment",
"value": {
"card": {
"cardNumber": "453985******7062",
"entryMethod": "keyed",
"expiryDate": "1230",
"securityChecks": {
"avsResult": "Y",
"cvvResult": "M"
},
"type": "MasterCard"
},
"customFields": [
{
"name": "yourCustomField",
"value": "abc123"
}
],
"customer": {
"billingAddress": {
"address1": "1 Example Ave.",
"address2": "Example Address Line 2",
"address3": "Example Address Line 3",
"city": "Chicago",
"country": "US",
"postalCode": "60056",
"state": "Illinois"
},
"firstName": "Sarah",
"lastName": "Hopper",
"shippingAddress": {
"address": {
"address1": "1 Example Ave.",
"address2": "Example Address Line 2",
"address3": "Example Address Line 3",
"city": "Chicago",
"country": "US",
"postalCode": "60056",
"state": "Illinois"
},
"recipientName": "Sarah Hopper"
}
},
"operator": "Jane",
"order": {
"amount": 4999,
"currency": "USD",
"dateTime": "2024-07-02T15:30:00Z",
"description": "Large Pepperoni Pizza",
"orderId": "OrderRef6543"
},
"paymentId": "M2MJOG6O2Y",
"processingTerminalId": "1234001",
"supportedOperations": [
"capture",
"fullyReverse",
"partiallyReverse",
"incrementAuthorization",
"adjustTip",
"setAsPending"
],
"transactionResult": {
"approvalCode": "OK3",
"authorizedAmount": 4999,
"currency": "USD",
"responseCode": "A",
"responseMessage": "OK3",
"status": "ready",
"type": "sale"
}
}
},
"ref_bcb851c87eef17bb9b82": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_f9d963d00740bbe00c9e"
},
{
"properties": {
"data": {
"description": "Array of merchantPlatform objects.",
"items": {
"$ref": "#/x-devx-bundled/ref_5ef41b0d7789b150c540"
},
"type": "array"
}
},
"type": "object"
}
],
"title": "paginated merchant platforms",
"type": "object"
},
"ref_bcdb0bb281250c51203c": {
"properties": {
"customFields": {
"description": "Array of customField objects.\n",
"items": {
"$ref": "#/x-devx-bundled/ref_91509fee696e20aa30f2"
},
"type": "array"
},
"operator": {
"description": "Operator who initiated the request.",
"maxLength": 50,
"minLength": 0,
"type": "string"
},
"order": {
"$ref": "#/x-devx-bundled/ref_571bf5eca14a53be5ae4",
"description": "Object that contains information about the payment."
}
},
"required": [
"order"
]
},
"ref_bcdfbf44b6681305ed2e": {
"description": "Create a pricing intent.",
"summary": "Tiered 4",
"value": {
"base": {
"addressVerification": 5,
"annualFee": {
"amount": 9900,
"billInMonth": "june"
},
"batch": 1500,
"chargeback": 2500,
"earlyTermination": 57500,
"maintenance": 500,
"minimum": 100,
"pciNonCompliance": 4995,
"platinumSecurity": {
"billingFrequency": "monthly"
},
"regulatoryAssistanceProgram": 15,
"retrieval": 1500,
"voiceAuthorization": 95
},
"country": "US",
"gateway": {
"fees": {
"monthly": 2000,
"perDeviceMonthly": 10,
"perTransaction": 2000,
"setup": 5000
}
},
"key": "Your-Unique-Identifier",
"metadata": {
"yourCustomField": "abc123"
},
"processor": {
"ach": {
"fees": {
"accountVerification": 10,
"batch": 5,
"discountRateAbove10000": 1,
"discountRateUnder10000": 0.5,
"monthlyMinimum": 500,
"returns": 400,
"statement": 250,
"transaction": 50,
"unauthorizedReturn": 500
}
},
"card": {
"fees": {
"amex": {
"midQualRate": {
"transaction": 0,
"volume": 1.75
},
"nonQualRate": {
"transaction": 0,
"volume": 3.84
},
"qualifiedRate": {
"transaction": 0,
"volume": 1.39
},
"type": "optBlue"
},
"mastercardVisaDiscover": {
"midQualRate": {
"transaction": 0,
"volume": 1.75
},
"nonQualRate": {
"transaction": 0,
"volume": 3.84
},
"premiumRate": {
"transaction": 0,
"volume": 3.84
},
"qualifiedRate": {
"transaction": 0,
"volume": 1.39
}
}
},
"planType": "tiered4"
}
},
"services": [
{
"enabled": true,
"name": "hardwareAdvantagePlan"
}
],
"version": "5.2"
}
},
"ref_bd1b4d9efad8486adf3d": {
"description": "Object that contains information about the adjustment to the transaction. Send this object if the merchant is adjusting the order details.",
"properties": {
"amount": {
"description": "Total amount of the transaction.",
"example": 4999,
"exclusiveMinimum": 0,
"format": "int64",
"type": "integer"
},
"breakdown": {
"$ref": "#/x-devx-bundled/ref_8db992b7e92107370c75"
},
"type": {
"description": "Type of adjustment.",
"enum": [
"order"
],
"example": "order",
"type": "string"
}
},
"required": [
"type",
"amount"
],
"title": "order",
"type": "object"
},
"ref_bd3a1e97c2759c4f8111": {
"description": "Reversal Payment",
"summary": "Reversal Payment",
"value": {
"amount": 4999
}
},
"ref_bd43970a1ae1b1eb0c0f": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_332dff3df47ae1e824ea"
},
{
"properties": {
"taxes": {
"description": "List of taxes.",
"items": {
"$ref": "#/x-devx-bundled/ref_a52bfba93be1ce659766"
},
"type": "array"
}
},
"type": "object"
}
],
"type": "object"
},
"ref_bd462bdbfedcdb655bb7": {
"description": "Secure token after we removed the customer's date of birth.",
"summary": "Update secure token: remove",
"value": {
"customFields": [
{
"name": "yourCustomField",
"value": "abc123"
}
],
"customer": {
"billingAddress": {
"address1": "1 Example Ave.",
"address2": "Example Address Line 2",
"address3": "Example Address Line 3",
"city": "Chicago",
"country": "US",
"postalCode": "60056",
"state": "Illinois"
},
"contactMethods": [
{
"type": "email",
"value": "sarah.hopper@example.com"
}
],
"firstName": "Sarah",
"lastName": "Hopper",
"notificationLanguage": "en",
"referenceNumber": "Customer-12",
"shippingAddress": {
"address": {
"address1": "1 Example Ave.",
"address2": "Example Address Line 2",
"address3": "Example Address Line 3",
"city": "Chicago",
"country": "US",
"postalCode": "60056",
"state": "Illinois"
},
"recipientName": "Sarah Hopper"
}
},
"mitAgreement": "unscheduled",
"processingTerminalId": "1234001",
"secureTokenId": "MREF_abc1de23-f4a5-6789-bcd0-12e345678901fa",
"source": {
"cardNumber": "453985******7062",
"cardholderName": "Sarah Hazel Hopper",
"expiryDate": "1230",
"type": "card"
},
"status": "notValidated",
"token": "296753123456"
}
},
"ref_bda909a2af1f621a8dec": {
"description": "Subscription after we removed the description.",
"summary": "Update subscription: remove",
"value": {
"currency": "USD",
"currentState": {
"nextDueDate": "2024-08-02",
"outstandingInvoices": 3,
"paidInvoices": 0,
"status": "active"
},
"customFields": [
{
"name": "yourCustomField",
"value": "abc123"
}
],
"endDate": "2025-07-01",
"frequency": "monthly",
"length": 12,
"name": "Premium Club",
"pauseCollectionFor": 0,
"paymentPlan": {
"link": {
"href": "https://api.payroc.com/v1/processing-terminals/1234001/payment-plans/PlanRef8765",
"method": "GET",
"rel": "self"
},
"name": "Monthly Premium Club subscription",
"paymentPlanId": "PlanRef8765"
},
"processingTerminalId": "1234001",
"recurringOrder": {
"amount": 4999,
"breakdown": {
"subtotal": 4347,
"surcharge": {
"amount": 217,
"percentage": 5
},
"taxes": [
{
"name": "Sales Tax",
"rate": 5
}
]
},
"description": "Premium Club subscription"
},
"secureToken": {
"customerName": "Sarah Hazel Hopper",
"link": {
"href": "https://api.payroc.com/v1/processing-terminals/1234001/secure-tokens/MREF_abc1de23-f4a5-6789-bcd0-12e345678901fa",
"method": "GET",
"rel": "self"
},
"secureTokenId": "MREF_abc1de23-f4a5-6789-bcd0-12e345678901fa",
"status": "notValidated",
"token": "296753123456"
},
"setupOrder": {
"amount": 4999,
"breakdown": {
"subtotal": 4347,
"surcharge": {
"amount": 217,
"percentage": 5
},
"taxes": [
{
"name": "Sales Tax",
"rate": 5
}
]
},
"description": "Initial setup fee for Premium Club subscription",
"orderId": "OrderRef6543"
},
"startDate": "2024-07-02",
"subscriptionId": "SubRef7654",
"type": "automatic"
}
},
"ref_bdd8ff6b1a30d57341ad": {
"description": "Unique identifier for the contact.",
"examples": {
"example": {
"value": 1543
}
},
"in": "path",
"name": "contactId",
"required": true,
"schema": {
"type": "integer"
}
},
"ref_be0915cd698503b8a10f": {
"description": "Submit an instruction for initiating a payment on a physical device.",
"summary": "Payment Instruction",
"value": {
"autoCapture": true,
"customizationOptions": {
"entryMethod": "deviceRead"
},
"operator": "Jane",
"order": {
"amount": 4999,
"currency": "USD",
"orderId": "OrderRef6543"
},
"processingTerminalId": "1234001"
}
},
"ref_be112c52713ae6148591": {
"description": "Filter by tender type.",
"examples": {
"example": {
"value": "ebt"
}
},
"in": "query",
"name": "tender",
"schema": {
"enum": [
"ebt",
"creditDebit"
],
"type": "string"
}
},
"ref_be3d9127d2fe7064be93": {
"description": "Update an existing funding instruction to modify merchant funds distribution.",
"summary": "Update funding instruction",
"value": {
"merchants": [
{
"merchantId": "9876543219",
"recipients": [
{
"amount": {
"currency": "USD",
"value": 69950
},
"fundingAccountId": 124,
"metadata": {
"supplier": "IT Support Services"
},
"paymentMethod": "ACH"
}
]
}
],
"metadata": {
"instructionCreatedBy": "Jane Doe"
}
}
},
"ref_bed4509beb9fb54e6ad6": {
"description": "Processing account created for a Fiserv-bound merchant. The Clover Merchant Processing Amendment addendum is appended to the Merchant Processing Agreement with equipment line-item pre-fill data.",
"summary": "Created Fiserv processing account with Clover Merchant Processing Amendment",
"value": {
"addendums": [
{
"lineItems": {
"cloverCashDrawer": {
"quantity": 2,
"totalPrice": 19800
},
"cloverMiniLte3rdGen": {
"quantity": 2,
"totalPrice": 149800
},
"cloverSoloPosSystem": {
"quantity": 1,
"totalPrice": 149900
}
},
"type": "cloverMerchantProcessingAmendmentV1"
}
],
"address": {
"address1": "1 Example Ave.",
"address2": "Example Address Line 2",
"address3": "Example Address Line 3",
"city": "Chicago",
"country": "US",
"postalCode": "60056",
"state": "Illinois"
},
"businessStartDate": "2020-01-01",
"businessType": "restaurant",
"categoryCode": 5999,
"contactMethods": [
{
"type": "email",
"value": "jane.doe@example.com"
}
],
"contacts": [
{
"contactId": 1543,
"firstName": "Jane",
"lastName": "Doe",
"link": {
"href": "https://api.payroc.com/v1/contacts/1543",
"method": "get",
"rel": "contact"
}
}
],
"createdDate": "2024-07-02T12:00:00.000+00:00",
"doingBusinessAs": "Pizza Doe",
"funding": {
"acceleratedFundingFee": 1999,
"dailyDiscount": false,
"fundingAccounts": [
{
"fundingAccountId": 123,
"link": {
"href": "https://api.payroc.com/v1/funding-accounts/123",
"method": "get",
"rel": "fundingAccount"
},
"status": "pending"
}
],
"fundingSchedule": "nextday",
"status": "enabled"
},
"lastModifiedDate": "2024-07-02T12:00:00.000+00:00",
"merchandiseOrServiceSold": "Pizza",
"metadata": {
"customerId": "2345"
},
"owners": [
{
"firstName": "Jane",
"lastName": "Doe",
"link": {
"href": "https://api.payroc.com/v1/owners/4564",
"method": "get",
"rel": "owner"
},
"ownerId": 4564
}
],
"pricing": {
"link": {
"href": "https://api.payroc.com/v1/processing-accounts/38766/pricing",
"method": "get",
"rel": "pricing"
}
},
"processing": {
"monthlyAmounts": {
"average": 50000,
"highest": 100000
},
"transactionAmounts": {
"average": 5000,
"highest": 10000
},
"volumeBreakdown": {
"cardPresent": 77,
"ecommerce": 20,
"mailOrTelephone": 3
}
},
"processingAccountId": "38766",
"processor": "fiserv",
"signature": {
"link": {
"href": "https://us.agreementexpress.net/mv2/viewer2.jsp?docId=00000000-0000-0000-0000-000000000000",
"method": "get",
"rel": "agreement"
},
"type": "requestedViaDirectLink"
},
"status": "entered",
"timezone": "America/Chicago",
"website": "www.example.com"
}
},
"ref_bfd782ac32787312f48a": {
"description": "Example of a created event subscription.",
"summary": "Create event subscription",
"value": {
"enabled": true,
"eventTypes": [
"processingAccount.status.changed"
],
"id": 2565435189324,
"metadata": {
"yourCustomField": "abc123"
},
"notifications": [
{
"secret": "**********oP3456",
"supportEmailAddress": "jane.doe@example.com",
"type": "webhook",
"uri": "https://my-server/notification/endpoint"
}
],
"status": "registered"
}
},
"ref_bfececc849bf00f27e2b": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_f9d963d00740bbe00c9e"
},
{
"properties": {
"data": {
"description": "Array of polymorphic objects that contains payment link information. \n\nThe value of the type parameter determines which variant you should use: \n-\t'multiUse' - Create a link that the merchant can use to take multiple payments.\n-\t'singleUse' - Create a link that the merchant can use for only one payment.\n",
"items": {
"oneOf": [
{
"$ref": "#/x-devx-bundled/ref_210fbadc5eb6d4079f9a"
},
{
"$ref": "#/x-devx-bundled/ref_0f813605d6f1b2a63bdb"
}
],
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
],
"required": [
"count",
"data",
"hasMore",
"limit"
],
"type": "object"
},
"ref_c06e30cc1afc11042537": {
"description": "Paginated list of funding recipients.",
"summary": "Paginated funding recipients.",
"value": {
"count": 1,
"data": [
{
"address": {
"address1": "1 Example Ave.",
"city": "Chicago",
"country": "US",
"postalCode": "60056",
"state": "Illinois"
},
"contactMethods": [
{
"type": "phone",
"value": "2025550164"
}
],
"createdDate": "2024-07-02T15:30:00+00:00",
"doingBusinessAs": "Pizza Doe",
"fundingAccounts": [
{
"fundingAccountId": 123,
"link": {
"href": "https://api.payroc.com/v1/funding-accounts/123",
"method": "get",
"rel": "fundingAccount"
},
"status": "approved"
},
{
"fundingAccountId": 124,
"link": {
"href": "https://api.payroc.com/v1/funding-accounts/124",
"method": "get",
"rel": "fundingAccount"
},
"status": "hold"
}
],
"lastModifiedDate": "2024-07-02T15:30:00+00:00",
"metadata": {
"yourCustomField": "abc123"
},
"owners": [
{
"link": {
"href": "https://api.payroc.com/v1/owners/4564",
"method": "get",
"rel": "owner"
},
"ownerId": 4564
}
],
"recipientId": 234,
"recipientType": "privateCorporation",
"status": "approved",
"taxId": "123456789"
}
],
"hasMore": false,
"limit": 10,
"links": [
{
"href": "https://api.payroc.com/v1/funding-recipients?before=234&limit=10",
"method": "get",
"rel": "previous"
}
]
}
},
"ref_c09c4c9e197fda20d9e7": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_5318f22f1b577e653c08"
},
{
"properties": {
"breakdown": {
"$ref": "#/x-devx-bundled/ref_0331fceeaf098c1c9e92"
}
},
"type": "object"
}
],
"type": "object"
},
"ref_c0b0838a8aec80b427aa": {
"description": "Retrieve terminal orders associated with a processing account.",
"summary": "Paginated list of Terminal Orders",
"value": [
{
"createdDate": "2024-07-02T12:00:00.000+00:00",
"lastModifiedDate": "2024-07-02T12:00:00.000+00:00",
"orderItems": [
{
"deviceCondition": "new",
"links": [
{
"link": {
"href": "https://api.payroc.com/v1/processing-terminals/1234001",
"method": "get",
"rel": "processingTerminal"
},
"processingTerminalId": "1234001"
}
],
"paymentIntent": {
"link": {
"href": "https://api.payroc.com/v1/payment-intents/1542",
"method": "get",
"rel": "paymentIntent"
},
"paymentIntentId": "1542",
"paymentIntentType": "purchase"
},
"solutionQuantity": 1,
"solutionSetup": {
"applicationSettings": {
"clerkPrompt": false,
"security": {
"keyedSalePassword": false,
"refundPassword": true,
"reversalPassword": true
}
},
"batchClosure": {
"batchCloseTime": "23:40",
"batchCloseType": "automatic"
},
"deviceSettings": {
"communicationType": "wifi",
"numberOfMobileUsers": 2
},
"gatewaySettings": {
"merchantPortfolioId": "Company Ltd",
"merchantTemplateId": "Company Ltd Merchant Template",
"terminalTemplateId": "Company Ltd Terminal Template",
"userTemplateId": "Company Ltd User Template"
},
"industryTemplateId": "Retail",
"receiptNotifications": {
"emailReceipt": true,
"smsReceipt": false
},
"taxes": [
{
"taxLabel": "Sales Tax",
"taxRate": 6
}
],
"timezone": "America/Chicago",
"tips": {
"enabled": false
},
"tokenization": true
},
"solutionTemplateId": "Roc Services_DX8000",
"type": "solution"
}
],
"shipping": {
"address": {
"addressLine1": "1 Example Ave.",
"addressLine2": "Example Address Line 2",
"businessName": "Company Ltd",
"city": "Chicago",
"email": "example@mail.com",
"phone": "2025550164",
"postalCode": "60056",
"recipientName": "Sarah Hopper",
"state": "Illinois"
},
"preferences": {
"method": "nextDay",
"saturdayDelivery": true
}
},
"status": "open",
"terminalOrderId": "12345",
"trainingProvider": "payroc"
}
]
},
"ref_c0d4d3c11e403499d96c": {
"description": "Object that indicates whether the merchant pays for the terminal in a single payment or in multiple installments.",
"properties": {
"numberOfInstallments": {
"description": "Number of monthly payments for the terminal order. The merchant can pay for their order over a minimum of two months or a maximum of six months.",
"example": 3,
"maximum": 6,
"minimum": 2,
"type": "integer"
},
"type": {
"default": "singlePayment",
"description": "Indicates whether the merchant wants to pay for the terminal order in one payment or in multiple installments. \n\nIf the merchant wants to pay in installments, send a value for the numberOfInstallments parameter. \n",
"enum": [
"singlePayment",
"installments"
],
"example": "singlePayment",
"maxLength": 13,
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"ref_c0ebd5256603a818f424": {
"description": "Create a funding account and add it to a funding recipient.",
"summary": "Create funding account",
"value": {
"metadata": {
"responsiblePerson": "Jane Doe"
},
"nameOnAccount": "Fred Nerk",
"paymentMethods": [
{
"type": "ach",
"value": {
"accountNumber": "987654321",
"routingNumber": "123123123"
}
}
],
"type": "savings",
"use": "credit"
}
},
"ref_c0f0cd70a9b62501770e": {
"description": "Status history of a dispute.",
"summary": "List dispute statuses",
"value": [
{
"disputeStatusId": 123,
"status": "new",
"statusDate": "2024-07-02"
},
{
"disputeStatusId": 124,
"status": "representmentInProgress",
"statusDate": "2024-07-05"
},
{
"disputeStatusId": 125,
"status": "representmentPaid",
"statusDate": "2024-07-12"
}
]
},
"ref_c1027736facd2c2a7c95": {
"description": "Filter by payments that the processor processed after a specific date. The date format follows the ISO 8601 standard.",
"examples": {
"example": {
"value": "2024-07-01T15:30:00Z"
}
},
"in": "query",
"name": "dateFrom",
"schema": {
"format": "date-time",
"type": "string"
}
},
"ref_c1129b06dcc92ab9c0b5": {
"description": "Object that contains the contact details of the recipient.",
"properties": {
"email": {
"description": "Recipient's email address.",
"example": "sarah.hopper@example.com",
"maxLength": 128,
"minLength": 6,
"type": "string"
},
"name": {
"description": "Recipient's name.",
"example": "Sarah Hazel Hopper",
"maxLength": 48,
"minLength": 1,
"type": "string"
}
},
"required": [
"name",
"email"
],
"type": "object"
},
"ref_c14cdf72d460735f556a": {
"description": "Filter by tender type.",
"examples": {
"example": {
"value": "ebt"
}
},
"in": "query",
"name": "tender",
"schema": {
"enum": [
"ebt",
"creditDebit"
],
"type": "string"
}
},
"ref_c1684241f83e60954f72": {
"additionalProperties": false,
"description": "CNP Tobacco Merchant Questionnaire for merchants that sell tobacco products and accept CNP transactions.",
"properties": {
"type": {
"const": "tobaccoCnpV1",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"ref_c19a1775c4f3ce903a8c": {
"description": "Unique identifier that we assigned to the funding recipient.",
"example": 234,
"in": "path",
"name": "recipientId",
"required": true,
"schema": {
"type": "integer"
}
},
"ref_c1ab92f2f33686625684": {
"description": "Requested representation not supported",
"summary": "Not acceptable",
"value": {
"detail": "Resource does not support the representation requested",
"status": 406,
"title": "Not acceptable",
"type": "https://docs.payroc.com/api/errors#not-acceptable"
}
},
"ref_c26b7e140cdf0511d715": {
"description": "Create a processing account with the Roc Giving Addendum appended to the Merchant Processing Agreement.",
"summary": "Create a processing account with Roc Giving Addendum",
"value": {
"addendums": [
{
"accountAdminContact": {
"emailAddress": "jane.doe@example.com",
"firstName": "Jane",
"lastName": "Doe",
"phone": "2025550164"
},
"autoCloseTime": "23:40",
"donorSupportPercentage": 2.5,
"plan": "basic",
"type": "rocGivingV1"
}
],
"address": {
"address1": "1 Example Ave.",
"address2": "Example Address Line 2",
"address3": "Example Address Line 3",
"city": "Chicago",
"country": "US",
"postalCode": "60056",
"state": "Illinois"
},
"businessStartDate": "2020-01-01",
"businessType": "restaurant",
"categoryCode": 5999,
"contactMethods": [
{
"type": "email",
"value": "jane.doe@example.com"
}
],
"doingBusinessAs": "Pizza Doe",
"funding": {
"acceleratedFundingFee": 1999,
"dailyDiscount": false,
"fundingAccounts": [
{
"metadata": {
"yourCustomField": "abc123"
},
"nameOnAccount": "Jane Doe",
"paymentMethods": [
{
"type": "ach",
"value": {
"accountNumber": "321831591",
"routingNumber": "063100277"
}
}
],
"type": "checking",
"use": "creditAndDebit"
}
],
"fundingSchedule": "nextday"
},
"merchandiseOrServiceSold": "Pizza",
"metadata": {
"customerId": "2345"
},
"owners": [
{
"address": {
"address1": "1 Example Ave.",
"address2": "Example Address Line 2",
"address3": "Example Address Line 3",
"city": "Chicago",
"country": "US",
"postalCode": "60056",
"state": "Illinois"
},
"contactMethods": [
{
"type": "email",
"value": "jane.doe@example.com"
}
],
"dateOfBirth": "1964-03-22",
"firstName": "Jane",
"identifiers": [
{
"type": "nationalId",
"value": "000-00-4320"
}
],
"lastName": "Doe",
"middleName": "Helen",
"relationship": {
"equityPercentage": 51.5,
"isAuthorizedSignatory": false,
"isControlProng": true,
"title": "CFO"
}
}
],
"pricing": {
"pricingIntentId": "6123",
"type": "intent"
},
"processing": {
"monthlyAmounts": {
"average": 3000,
"highest": 100000
},
"transactionAmounts": {
"average": 4500,
"highest": 50000
},
"volumeBreakdown": {
"cardPresent": 80,
"ecommerce": 0,
"mailOrTelephone": 20
}
},
"processor": "tsys",
"signature": {
"type": "requestedViaDirectLink"
},
"timezone": "America/Chicago",
"website": "www.example.com"
}
},
"ref_c35ba0e64f1d0adaba7e": {
"description": "Pricing intent that we partially updated.",
"summary": "Partially update pricing intent",
"value": {
"base": {
"addressVerification": 5,
"annualFee": {
"amount": 100,
"billInMonth": "june"
},
"batch": 1000,
"chargeback": 2500,
"earlyTermination": 57500,
"maintenance": 500,
"minimum": 100,
"pciNonCompliance": 4995,
"platinumSecurity": {
"amount": 1295,
"billingFrequency": "monthly"
},
"regulatoryAssistanceProgram": 15,
"retrieval": 1500,
"voiceAuthorization": 95
},
"country": "US",
"createdDate": "2024-07-02T09:00:00Z",
"gateway": {
"fees": {
"monthly": 1000,
"perDeviceMonthly": 0,
"perTransaction": 0,
"setup": 25000
}
},
"id": "5",
"key": "string",
"lastUpdatedDate": "2024-07-02T09:00:00Z",
"metadata": {
"yourCustomField": "abc123"
},
"processor": {
"ach": {
"fees": {
"accountVerification": 100,
"batch": 1000,
"discountRateAbove10000": 10,
"discountRateUnder10000": 5.25,
"monthlyMinimum": 20000,
"returns": 400,
"statement": 800,
"transaction": 50,
"unauthorizedReturn": 1999
}
},
"card": {
"fees": {
"amex": {
"transaction": 10,
"type": "optBlue",
"volume": 1.25
},
"electronicBenefitsTransfer": {
"transaction": 10
},
"mastercardVisaDiscover": {
"transaction": 5,
"volume": 1.25
},
"pinDebit": {
"additionalDiscount": 1.25,
"monthlyAccess": 1200,
"transaction": 10
},
"specialityCards": {
"transaction": 10
}
},
"planType": "interchangePlus"
}
},
"services": [
{
"enabled": true,
"name": "hardwareAdvantagePlan"
}
],
"status": "pendingReview",
"version": "5.2"
}
},
"ref_c38156a5dcc3d94377dd": {
"description": "Filter payments by transaction type.",
"examples": {
"example": {
"value": [
"sale",
"preAuthorization"
]
}
},
"in": "query",
"name": "type",
"schema": {
"items": {
"enum": [
"sale",
"preAuthorization",
"preAuthorizationCompletion"
],
"type": "string"
},
"type": "array"
}
},
"ref_c409d186912eaed5dbdf": {
"description": "Filter by the token that the merchant used in a transaction to represent the customer's payment details.",
"examples": {
"example": {
"value": "296753123456"
}
},
"in": "query",
"name": "token",
"schema": {
"maxLength": 19,
"minLength": 12,
"type": "string"
}
},
"ref_c44068086d1083ebf58a": {
"description": "Filter transactions by the date that the merchant submitted the batch that contains the transaction. The format of this value is **YYYY-MM-DD**. \n\nYou must provide either the batchId or the date. \n",
"examples": {
"example": {
"value": "2024-07-02"
}
},
"in": "query",
"name": "date",
"schema": {
"format": "date",
"type": "string"
}
},
"ref_c4591cd9ac15c900cf09": {
"description": "Filter refunds by the current status of the refund.",
"examples": {
"example": {
"value": [
"accepted",
"ready",
"complete"
]
}
},
"in": "query",
"name": "status",
"schema": {
"items": {
"enum": [
"ready",
"pending",
"declined",
"complete",
"referral",
"pickup",
"reversal",
"admin",
"expired",
"accepted"
],
"type": "string"
},
"type": "array"
}
},
"ref_c49d710e5998a3f0ac5f": {
"description": "Object that contains the transaction adjustment object.",
"properties": {
"adjustments": {
"description": "Array of polymorphic objects which contain information about adjustments to a payment. \n\nThe value of the type parameter determines which variant you should use:\n-\t`order` - Tip information.\n-\t`status` - Status of the transaction.\n-\t`customer` - Customer's contact information and shipping address.\n-\t`signature` - Customer's signature.\n",
"items": {
"discriminator": {
"mapping": {
"customer": "#/components/schemas/customerAdjustment",
"order": "#/components/schemas/orderAdjustment",
"signature": "#/components/schemas/signatureAdjustment",
"status": "#/components/schemas/statusAdjustment"
},
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/x-devx-bundled/ref_bd1b4d9efad8486adf3d"
},
{
"$ref": "#/x-devx-bundled/ref_df709214365c028258ee"
},
{
"$ref": "#/x-devx-bundled/ref_d7c593c600b95328ff30"
},
{
"$ref": "#/x-devx-bundled/ref_09c9d9c155676d1e101d"
}
]
},
"type": "array",
"uniqueItems": true
},
"operator": {
"description": "Operator who adjusted the payment.",
"example": "Jane",
"maxLength": 50,
"minLength": 0,
"type": "string"
}
},
"required": [
"adjustments"
],
"type": "object"
},
"ref_c4f3f834f7733f0d9fed": {
"properties": {
"startSessionResponse": {
"description": "Object that Apple returns when they start the merchant's Apple Pay session. \n\nSend the content in this object to Apple to retrieve the cardholder's encrypted payment details. \n",
"example": "{\n \"epochTimestamp\": 1736264582447,\n \"expiresAt\": 1736268182447,\n \"merchantSessionIdentifier\": \"SSHE464E2B91B714F18BFD19D46D0F582BF_916523AAED1343F5BC5815E12BEE9250AFFDC1A17C46B0DE5A943F0F94927C24\",\n \"nonce\": \"e5775127\",\n \"merchantIdentifier\": \"BFB110EE83BE2AF4AA7468926C926CCFC57F4A541CCE6E7F3BEFD05002ECE503\",\n \"domainName\": \"store.com\",\n \"displayName\": \"Store One\",\n \"signature\": \"a1b1c012345678a000b000c0012345d0e0f010g10061a031i001j071k0a1b0c1d0e1234567890120f1g0h1i0j1k0a1b0123451c012d0e1f0g1h0i1j123k1a1b1c1d1e1f1g123h1i1j1k1a1b1c1d1e1f1g123h123i1j123k12340a120a12345b012c0123012d0d1e0f1g0h1i123j123k10000\",\n \"operationalAnalyticsIdentifier\": \"Store One:BFB110EE83BE2AF4AA7468926C926CCFC57F4A541CCE6E7F3BEFD05002ECE503\",\n \"retries\": 0,\n \"pspId\": \"17D4AAA8D9357D26D771ABA0DAA0B9D3BB462AD1585492E1FE688AF8BB9558E5\"\n}\n",
"type": "string"
}
},
"required": [
"startSessionResponse"
],
"type": "object"
},
"ref_c4fe60b71e4150611cad": {
"properties": {
"processingTerminalId": {
"description": "Unique identifier that we assigned to the terminal.",
"example": "1234001",
"maxLength": 50,
"minLength": 4,
"type": "string"
},
"verified": {
"description": "Indicates if the customer's bank account details are valid. \n- `true` - Account details are valid. \n- `false` - Account details are not valid.\n",
"example": true,
"type": "boolean"
}
},
"required": [
"processingTerminalId",
"verified"
],
"type": "object"
},
"ref_c545049e00b6d34db3b8": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_70cc8dae801ba45c5c9f"
},
{
"properties": {
"convenienceFee": {
"$ref": "#/x-devx-bundled/ref_73ccf7ffa65b9a82668c"
},
"dutyAmount": {
"description": "Amount of duties or fees that apply to the order. The value is in the currency's lowest denomination, for example, cents.\n\nRequired for [Level 3 and CEDP transactions](https://docs.payroc.com/knowledge/card-payments/enhanced-data).\n",
"example": 0,
"format": "int64",
"type": "integer"
},
"freightAmount": {
"description": "Amount for shipping in the currency's lowest denomination, for example, cents.\n\nRequired for [Level 3 and CEDP transactions](https://docs.payroc.com/knowledge/card-payments/enhanced-data).\n",
"example": 0,
"format": "int64",
"type": "integer"
},
"items": {
"description": "Array of objects that contain information about each item that the customer purchased.\n\nContains parameters required for [Level 3 and CEDP transactions](https://docs.payroc.com/knowledge/card-payments/enhanced-data).\n",
"items": {
"$ref": "#/x-devx-bundled/ref_b0c11212077c3729f490",
"description": "Array of 'lineItem' objects. Each object contains information about the items in the transaction."
},
"type": "array"
}
},
"type": "object"
}
],
"description": "Object that contains information about the breakdown of the transaction.\n\nContains parameters required for [Level 2, Level 3, and CEDP transactions](https://docs.payroc.com/knowledge/card-payments/enhanced-data).\n",
"required": [
"subtotal"
],
"type": "object"
},
"ref_c547a592272a9e41d5f3": {
"description": "Funding accounts restricted.",
"summary": "Funding accounts restricted",
"value": {
"detail": "One or more funding accounts are restricted and can't receive funding instructions",
"errors": [
{
"message": "Funding account on hold",
"parameter": "fundingAccountId"
}
],
"status": 400,
"title": "Funding accounts restricted",
"type": "https://docs.payroc.com/api/errors#funding-accounts-restricted"
}
},
"ref_c64df29760ecfe018ce6": {
"description": "Object that contains the fees for the Clover platform service.",
"properties": {
"fees": {
"description": "Object that contains the Clover platform fee amounts.",
"properties": {
"dataProtectionPerMid": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_109fe7e5f018de7ee04b"
}
],
"description": "Data Protection Services fee per MID. The value is in the currency's lowest denomination, for example, cents."
},
"keyedAuthorizationPerTransaction": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_109fe7e5f018de7ee04b"
}
],
"description": "Fee per keyed or card-not-present transaction. The value is in the currency's lowest denomination, for example, cents."
},
"platformMonthly": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_109fe7e5f018de7ee04b"
}
],
"description": "Monthly platform fee for Clover. The value is in the currency's lowest denomination, for example, cents."
}
},
"required": [
"platformMonthly",
"dataProtectionPerMid",
"keyedAuthorizationPerTransaction"
],
"type": "object"
},
"name": {
"description": "Name of the service.",
"enum": [
"cloverProcessing"
],
"example": "cloverProcessing",
"type": "string"
}
},
"required": [
"name",
"fees"
],
"type": "object"
},
"ref_c657e1f085abbf8e4a16": {
"description": "Array of polymorphic objects that contain information about additional services that we offer.",
"items": {
"$ref": "#/x-devx-bundled/ref_feb6217fee997494806b"
},
"title": "US version 5.0 services array",
"type": "array",
"uniqueItems": true
},
"ref_c6665370075f60a9dc13": {
"description": "Move operation relocates a value from one location to another.",
"summary": "Update payment plan: move",
"value": [
{
"from": "/customFieldNames/0",
"op": "move",
"path": "/customFieldNames/1"
}
]
},
"ref_c68b02cf90eaad772b5f": {
"description": "Unique identifier that we assigned to the payment link.",
"examples": {
"example": {
"value": "JZURRJBUPS"
}
},
"in": "path",
"name": "paymentLinkId",
"required": true,
"schema": {
"maxLength": 10,
"minLength": 10,
"type": "string"
}
},
"ref_c73f68ebc114017ee0a4": {
"description": "Object that contains information about the authorization.",
"properties": {
"amount": {
"description": "Authorization amount. We return the value in the currency's lowest denomination, for example, cents.",
"example": 4999,
"type": "integer"
},
"authorizationId": {
"description": "Unique identifier of the authorization.",
"example": 303101,
"type": "integer"
},
"avsResponseCode": {
"description": "Response code that indicates if the address matches the address registered to the customer.",
"example": "Y",
"type": "string"
},
"code": {
"description": "Authorization code. \n\n**Note:** For returns, the card brands may not provide an authorization code.\n",
"example": "A1B2C3",
"type": "string"
},
"link": {
"$ref": "#/x-devx-bundled/ref_27e6d0e095fb23cba669"
}
},
"title": "authorization summary",
"type": "object"
},
"ref_c791fb405083799347c1": {
"content": {
"application/problem+json": {
"examples": {
"notAcceptable": {
"$ref": "#/x-devx-bundled/ref_c1ab92f2f33686625684"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_86226712795cd4aa0e79"
}
}
},
"description": "Not acceptable"
},
"ref_c799d35ea53644eec4e6": {
"description": "Object that contains information about the payment details for the customer’s automated clearing house (ACH) transactions.",
"properties": {
"accountNumber": {
"description": "Customer’s bank account number. \n**Note:** In responses, our gateway shows only the last four digits of the account number, for example, `*****5929`.\n",
"example": "1234567890",
"maxLength": 17,
"minLength": 4,
"pattern": "^[0-9]*$",
"type": "string"
},
"accountType": {
"description": "Indicates the customer’s account type. \n\n**Note:** For bank account details, send a value for accountType.\n",
"enum": [
"checking",
"savings"
],
"example": "checking",
"type": "string"
},
"nameOnAccount": {
"description": "Customer's name.",
"example": "Shara Hazel Hopper",
"maxLength": 50,
"minLength": 1,
"type": "string"
},
"routingNumber": {
"description": "Nine-digit number that identifies the customer's bank.",
"example": "123456789",
"maxLength": 9,
"minLength": 9,
"pattern": "^[0-9]*$",
"type": "string"
},
"secCode": {
"description": "Indicates how the customer authorized the ACH transaction. Send one of the following values:\n\n- `web` – Online transaction.\n- `tel` – Telephone transaction.\n- `ccd` – Corporate credit or debit entry for a business bank account.\n- `ppd` – Pre-arranged transaction.\n\n**Note:** This field is mandatory for ACH payments and unreferenced refunds.\n",
"enum": [
"web",
"tel",
"ccd",
"ppd"
],
"example": "web",
"type": "string"
},
"type": {
"description": "Indicates the type of bank account details the customer is using: \n- **ACH** - Customer's bank account is in the United States. \n- **PAD** - Customer's bank account is in Canada. \n",
"enum": [
"ach"
],
"example": "ach",
"type": "string"
}
},
"required": [
"type",
"accountNumber",
"nameOnAccount",
"routingNumber"
],
"title": "ach",
"type": "object",
"writeOnly": true
},
"ref_c80128c537381f745ab9": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_75ac48f7260a032d78ce"
},
{
"properties": {
"recurringOrder": {
"$ref": "#/x-devx-bundled/ref_11d707376cd301bb2c48"
},
"setupOrder": {
"$ref": "#/x-devx-bundled/ref_7b3c20091dcb1354d9ea"
}
},
"type": "object"
}
],
"required": [
"paymentPlanId",
"name",
"currency",
"frequency",
"onDelete",
"onUpdate",
"type"
],
"type": "object"
},
"ref_c808d1e5154b0c70f97a": {
"description": "Object that contains the information about a sharing event that the merchant sent by email.",
"properties": {
"dateTime": {
"description": "Date and time that the merchant shared the link. Our gateway returns this value in the [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
"example": "2024-07-02T15:30:00Z",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"merchantCopy": {
"default": false,
"description": "Indicates if we send a copy of the email to the merchant. By default, we don't send a copy to the merchant.",
"example": true,
"type": "boolean",
"writeOnly": true
},
"message": {
"description": "Message that the merchant sends with the payment link.",
"example": "Dear Sarah,\nYour insurance is expiring this month.\nPlease pay the renewal fee by the end of the month to renew your insurance.\n",
"maxLength": 1024,
"type": "string"
},
"recipients": {
"description": "Array that contains the recipients of the payment link.",
"items": {
"$ref": "#/x-devx-bundled/ref_c1129b06dcc92ab9c0b5"
},
"type": "array",
"uniqueItems": true
},
"sharingEventId": {
"description": "Unique identifier that we assigned to the sharing event.",
"example": "GTZH5WVXK9",
"maxLength": 10,
"minLength": 10,
"readOnly": true,
"type": "string"
},
"sharingMethod": {
"description": "Method that the merchant uses to share the payment link.",
"enum": [
"email"
],
"example": "email",
"type": "string"
}
},
"required": [
"sharingMethod",
"recipients"
],
"title": "email",
"type": "object"
},
"ref_c81000a305abe78faab1": {
"description": "Object that contains the fees for enhanced interchange services.",
"properties": {
"creditToMerchant": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_d3797fc41828d98b6e34"
}
],
"description": "Percentage of additional discount."
},
"enrollment": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_109fe7e5f018de7ee04b"
}
],
"description": "Enrollment fee for the enhanced interchange services. The value is in the currency's lowest denomination, for example, cents."
}
},
"required": [
"enrollment",
"creditToMerchant"
],
"type": "object"
},
"ref_c89b6b2eea24e2c0a863": {
"description": "Object that contains information about the Electronic Benefit Transfer (EBT) transaction.",
"properties": {
"benefitCategory": {
"description": "Indicates if the balance relates to an EBT Cash account or an EBT SNAP account. \n - `cash` – EBT Cash \n - `foodStamp` – EBT SNAP\n",
"enum": [
"cash",
"foodStamp"
],
"example": "cash",
"type": "string"
},
"withdrawal": {
"description": "Indicates whether the customer wants to withdraw cash. \n\n**Note:** Cash withdrawals are available only from EBT Cash accounts.\n",
"example": false,
"type": "boolean"
}
},
"required": [
"benefitCategory"
],
"type": "object"
},
"ref_c8f4fa759ab78a27b39c": {
"summary": "Retrieve authorization",
"value": {
"authorizationId": 65,
"authorizationResponse": "successful",
"batch": {
"batchId": 12,
"cycle": "am",
"date": "2024-07-02",
"link": {
"href": "https://api.payroc.com/v1/batches/12",
"method": "get",
"rel": "batch"
}
},
"card": {
"avsRequest": true,
"avsResponse": "Y",
"cardNumber": "453985******7062",
"cvvPresenceIndicator": true,
"type": "visa"
},
"createdDate": "2024-07-02",
"currency": "USD",
"lastModifiedDate": "2024-07-02",
"merchant": {
"doingBusinessAs": "Pizza Doe",
"link": {
"href": "https://api.payroc.com/v1/processing-accounts/38765",
"method": "get",
"rel": "processingAccount"
},
"merchantId": "4525644354",
"processingAccountId": 38765
},
"preauthorizationRequestAmount": 10000,
"transaction": {
"amount": 100,
"date": "2024-07-02",
"entryMethod": "swiped",
"link": {
"href": "https://api.payroc.com/v1/transactions/12345",
"method": "get",
"rel": "transaction"
},
"transactionId": 442233,
"type": "capture"
}
}
},
"ref_c934abb36246f5c66750": {
"description": "We couldn’t resend the email because there is no pricing agreement for the processing account.",
"summary": "No pricing agreement exists for the processing account",
"value": {
"detail": "There is no pricing agreement linked to the processing account.",
"status": 400,
"title": "No pricing agreement exists",
"type": "https://docs.payroc.com/api/errors#no-pricing-agreement-exists-for-the-processing-account"
}
},
"ref_c9541bb57e90d1d0eccb": {
"description": "Secure Token",
"summary": "Secure Token",
"value": {
"customFields": [
{
"name": "yourCustomField",
"value": "abc123"
}
],
"customer": {
"billingAddress": {
"address1": "1 Example Ave.",
"address2": "Example Address Line 2",
"address3": "Example Address Line 3",
"city": "Chicago",
"country": "US",
"postalCode": "60056",
"state": "Illinois"
},
"contactMethods": [
{
"type": "email",
"value": "sarah.hopper@example.com"
}
],
"dateOfBirth": "1990-07-15",
"firstName": "Sarah",
"lastName": "Hopper",
"notificationLanguage": "en",
"referenceNumber": "Customer-12",
"shippingAddress": {
"address": {
"address1": "1 Example Ave.",
"address2": "Example Address Line 2",
"address3": "Example Address Line 3",
"city": "Chicago",
"country": "US",
"postalCode": "60056",
"state": "Illinois"
},
"recipientName": "Sarah Hopper"
}
},
"ipAddress": {
"type": "ipv4",
"value": "104.18.24.203"
},
"mitAgreement": "unscheduled",
"operator": "Jane",
"source": {
"cardDetails": {
"cardholderName": "Sarah Hazel Hopper",
"entryMethod": "keyed",
"keyedData": {
"cardNumber": "4539858876047062",
"cvv": "234",
"dataFormat": "plainText",
"expiryDate": "1230"
}
},
"type": "card"
}
}
},
"ref_c98fc2a997d2d5b4667f": {
"description": "Payment",
"summary": "Payment",
"value": {
"count": 2,
"data": [
{
"card": {
"cardNumber": "453985******7062",
"cardholderName": "Sarah Hopper",
"entryMethod": "keyed",
"expiryDate": "1230",
"secureToken": {
"customerName": "Sarah Hopper",
"link": {
"href": "https://api.payroc.com/v1/processing-terminals/1234001/secure-tokens/MREF_abc1de23-f4a5-6789-bcd0-12e345678901fa",
"method": "GET",
"rel": "self"
},
"secureTokenId": "MREF_abc1de23-f4a5-6789-bcd0-12e345678901fa",
"status": "notValidated",
"token": "296753123456"
},
"securityChecks": {
"avsResult": "X",
"cvvResult": "M"
},
"type": "Visa Credit"
},
"operator": "Automatic Payment",
"order": {
"amount": 4999,
"currency": "USD",
"dateTime": "2024-07-02T15:30:00Z",
"description": "Monthly Premium Club subscription",
"orderId": "OrderRef6543"
},
"paymentId": "M2MJOG6O2Y",
"processingTerminalId": "1234001",
"supportedOperations": [
"fullyReverse",
"setAsPending"
],
"transactionResult": {
"approvalCode": "OK3",
"authorizedAmount": 4999,
"currency": "USD",
"responseCode": "A",
"responseMessage": "APPROVAL",
"status": "ready",
"type": "sale"
}
},
{
"card": {
"cardNumber": "453985******7062",
"cardholderName": "Sarah Hopper",
"entryMethod": "keyed",
"expiryDate": "1230",
"secureToken": {
"customerName": "Sarah Hopper",
"link": {
"href": "https://api.payroc.com/v1/processing-terminals/1234001/secure-tokens/MREF_abc1de23-f4a5-6789-bcd0-12e345678901fa",
"method": "GET",
"rel": "self"
},
"secureTokenId": "MREF_abc1de23-f4a5-6789-bcd0-12e345678901fa",
"status": "notValidated",
"token": "296753123456"
},
"securityChecks": {
"avsResult": "X",
"cvvResult": "M"
},
"type": "Visa Debit"
},
"customFields": [
{
"name": "yourCustomField",
"value": "abc123"
}
],
"operator": "Automatic Payment",
"order": {
"amount": 4999,
"currency": "USD",
"dateTime": "2024-07-02T15:30:00Z",
"description": "Monthly Premium Club subscription",
"orderId": "OrderRef7654"
},
"paymentId": "E29U8OU8Q4",
"processingTerminalId": "1234001",
"supportedOperations": [
"fullyReverse",
"setAsPending"
],
"transactionResult": {
"approvalCode": "475318",
"authorizedAmount": 1000,
"currency": "EUR",
"responseCode": "A",
"responseMessage": "APPROVAL",
"status": "ready",
"type": "sale"
}
}
],
"hasMore": true,
"limit": 2,
"links": [
{
"href": "https://api.payroc.com/v1/payments?processingTerminalId=1234001&limit=2&after=E29U8OU8Q4",
"method": "get",
"rel": "next"
},
{
"href": "https://api.payroc.com/v1/payments?processingTerminalId=1234001&limit=2&before=M2MJOG6O2Y",
"method": "get",
"rel": "previous"
}
]
}
},
"ref_c9a0fa68acaddaeb81ec": {
"description": "Attachment that we received.",
"summary": "Upload attachment to processing account",
"value": {
"attachmentId": "2587",
"contentType": "application/pdf",
"createdDate": "2024-07-02T12:00:00.000Z",
"description": "Passport as identification for lease agreement",
"entity": {
"id": "38765",
"type": "processingAccount"
},
"fileName": "JaneDoePassport.pdf",
"lastModifiedDate": "2024-07-02T12:00:00.000Z",
"metadata": {
"documentId": "2345"
},
"type": "personalIdentification",
"uploadStatus": "pending"
}
},
"ref_c9a3b88a5341a996fb4c": {
"description": "Object that contains the configuration of the device type/model.",
"properties": {
"applications": {
"description": "Array of emvApplication objects. Each object contains information about an EMV application supported by the device.",
"items": {
"$ref": "#/x-devx-bundled/ref_a35f7d2f7aba5061c4aa"
},
"type": "array"
},
"certificates": {
"description": "Array of emvCertificate objects. Each object contains information about an EMV certificate used by the device.",
"items": {
"$ref": "#/x-devx-bundled/ref_7a089b36b6e5b195941a"
},
"type": "array"
},
"manufacturer": {
"description": "Company that manufactured the device.",
"examples": [
"idtech",
"pax",
"ingenico"
],
"type": "string"
},
"model": {
"description": "Type or model of the device.",
"examples": [
"idtechKioskV",
"paxA920Pro",
"ingenicoAxiumRx7000"
],
"type": "string"
},
"revokedCertificates": {
"description": "Array of emvCertificate objects. Each object contains information about a revoked EMV certificate.",
"items": {
"$ref": "#/x-devx-bundled/ref_7a089b36b6e5b195941a"
},
"type": "array"
},
"supportsAttended": {
"description": "Indicates if a clerk must operate the device.",
"example": true,
"type": "boolean"
},
"supportsContactless": {
"description": "Indicates if the device can run contactless transactions.",
"example": false,
"type": "boolean"
},
"supportsIcc": {
"description": "Indicates if the device can read chip cards.",
"example": true,
"type": "boolean"
},
"supportsKeyed": {
"description": "Indicates if the device can run keyed transactions.",
"example": true,
"type": "boolean"
},
"supportsMagStripe": {
"description": "Indicates if the device can run swiped transactions.",
"example": true,
"type": "boolean"
},
"supportsOutputDisplaying": {
"description": "Indicates if the device can display information on a screen.",
"example": true,
"type": "boolean"
},
"supportsOutputPrinting": {
"description": "Indicates if the device can print receipts.",
"example": false,
"type": "boolean"
},
"supportsPinEntry": {
"description": "Indicates if the device can accept PIN entry.",
"example": true,
"type": "boolean"
},
"supportsUnattended": {
"description": "Indicates if the device can operate without a clerk present.",
"example": false,
"type": "boolean"
},
"visualAssets": {
"description": "Array of visualAsset objects. Each object contains information about a visual asset that the device displays.",
"items": {
"$ref": "#/x-devx-bundled/ref_4f1168aea7266bb9a5d7"
},
"type": "array"
}
},
"required": [
"model"
],
"type": "object"
},
"ref_c9b735bc493ecec06bc4": {
"additionalProperties": false,
"description": "Money Services Business Questionnaire for merchants that offer money services, for example, traveler's checks.",
"properties": {
"type": {
"const": "moneyServicesV1",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"ref_ca2b35d2127e00c3b179": {
"description": "Object that contains the fees for speciality cards.",
"properties": {
"transaction": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_109fe7e5f018de7ee04b"
}
],
"description": "Fee for each transaction. The value is in the currency's lowest denomination, for example, cents."
}
},
"required": [
"transaction"
],
"type": "object"
},
"ref_ca4b0a10f6e53239e9d9": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_27e6c97d2efec1f915a5"
},
{
"properties": {
"breakdown": {
"$ref": "#/x-devx-bundled/ref_21ee02f5a5fca430005f"
}
},
"type": "object"
}
],
"description": "Object that contains information about the transaction.",
"required": [
"amount",
"currency",
"orderId"
],
"type": "object"
},
"ref_ca8783266abbc347a8fe": {
"description": "Clover Merchant Processing Amendment for merchants that order Clover equipment.",
"properties": {
"lineItems": {
"additionalProperties": false,
"description": "Object that contains information about the Clover equipment and accessories that the merchant wants to order.",
"example": {
"cloverCashDrawer": {
"quantity": 2,
"totalPrice": 19800
},
"cloverMiniLte3rdGen": {
"quantity": 2,
"totalPrice": 149800
},
"cloverSoloPosSystem": {
"quantity": 1,
"totalPrice": 149900
},
"cloverWeightScale": {
"quantity": 1,
"totalPrice": 19900
}
},
"minProperties": 1,
"properties": {
"cloverBarCodeScanner": {
"$ref": "#/x-devx-bundled/ref_3a74aad80996478553ed"
},
"cloverCashDrawer": {
"$ref": "#/x-devx-bundled/ref_3a74aad80996478553ed"
},
"cloverCompact": {
"$ref": "#/x-devx-bundled/ref_3a74aad80996478553ed"
},
"cloverCompactTetherCable": {
"$ref": "#/x-devx-bundled/ref_3a74aad80996478553ed"
},
"cloverFlex4thGen": {
"$ref": "#/x-devx-bundled/ref_3a74aad80996478553ed"
},
"cloverFlexPocket": {
"$ref": "#/x-devx-bundled/ref_3a74aad80996478553ed"
},
"cloverHandsFreeScanner": {
"$ref": "#/x-devx-bundled/ref_3a74aad80996478553ed"
},
"cloverKds14": {
"$ref": "#/x-devx-bundled/ref_3a74aad80996478553ed"
},
"cloverKds24": {
"$ref": "#/x-devx-bundled/ref_3a74aad80996478553ed"
},
"cloverKitchenPrinter": {
"$ref": "#/x-devx-bundled/ref_3a74aad80996478553ed"
},
"cloverKitchenPrinterThermal": {
"$ref": "#/x-devx-bundled/ref_3a74aad80996478553ed"
},
"cloverMiniLte3rdGen": {
"$ref": "#/x-devx-bundled/ref_3a74aad80996478553ed"
},
"cloverSoloPosSystem": {
"$ref": "#/x-devx-bundled/ref_3a74aad80996478553ed"
},
"cloverStationDuoGen2PosSystem": {
"$ref": "#/x-devx-bundled/ref_3a74aad80996478553ed"
},
"cloverWeightScale": {
"$ref": "#/x-devx-bundled/ref_3a74aad80996478553ed"
}
},
"type": "object"
},
"type": {
"const": "cloverMerchantProcessingAmendmentV1",
"type": "string"
}
},
"required": [
"type",
"lineItems"
],
"type": "object"
},
"ref_cac3c05e321e27a01669": {
"description": "A Patch Move Operation.",
"properties": {
"from": {
"description": "Location of the value that you want to move.\nThe format for this value is JSON Pointer.\n",
"type": "string"
},
"op": {
"description": "`move` operation.",
"enum": [
"move"
],
"type": "string"
},
"path": {
"description": "Location where you want to move the value to.\nThe format for this value is JSON Pointer.\n",
"type": "string"
}
},
"required": [
"op",
"from",
"path"
],
"title": "Patch Move Operation",
"type": "object"
},
"ref_cbb0638a40224bf482e1": {
"description": "Object that contains shareable assets for the payment link.",
"properties": {
"paymentButton": {
"description": "HTML code for the payment link. You can embed the HTML code in the merchant's website.",
"example": "Pay Now\n",
"format": "html",
"type": "string"
},
"paymentUrl": {
"description": "URL of the payment link.",
"example": "https://payments.payroc.com/merchant/pay-by-link?token=7c2fc08c-cb0e-44ba-8bcd-cf6de6eb3206",
"type": "string"
}
},
"readOnly": true,
"required": [
"paymentUrl",
"paymentButton"
],
"type": "object"
},
"ref_cbd9e2b982aae4d5cfe2": {
"description": "Filter payments by the settlement status of the transaction.",
"examples": {
"example": {
"value": "settled"
}
},
"in": "query",
"name": "settlementState",
"schema": {
"enum": [
"settled",
"unsettled"
],
"type": "string"
}
},
"ref_cbe3ccc50d5ca95e33f7": {
"description": "Object that contains available options to customize certain aspects of an instruction.",
"properties": {
"closedLoopOptions": {
"description": "Polymorphic object that indicates the type of closed-loop card that the merchant accepts.\n",
"discriminator": {
"mapping": {
"mifare": "#/components/schemas/closedLoopOptionsMiFare"
},
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/x-devx-bundled/ref_57830f2b2eee9f04ad45"
}
],
"type": "object"
},
"ebtDetails": {
"$ref": "#/x-devx-bundled/ref_c89b6b2eea24e2c0a863"
},
"entryMethod": {
"default": "deviceRead",
"description": "Indicates how you want the device to capture the card details. \n- `deviceRead` - Device prompts the cardholder to tap, swipe, or insert their card. \n- `manualEntry` - Device prompts the merchant or cardholder to manually enter card details. \n- `deviceReadOrManualEntry` - Device prompts the cardholder to tap, swipe, or insert their card. The device also displays an option for the merchant or cardholder to manually enter card details. \n",
"enum": [
"deviceRead",
"manualEntry",
"deviceReadOrManualEntry"
],
"example": "deviceRead",
"type": "string"
}
},
"type": "object"
},
"ref_cbfa9e6af4185110bdd9": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_f9d963d00740bbe00c9e"
},
{
"properties": {
"data": {
"description": "An array of funding recipients",
"items": {
"$ref": "#/x-devx-bundled/ref_cf614403c80b98c3ec2a"
},
"type": "array"
}
},
"type": "object"
}
],
"title": "paginated funding recipients",
"type": "object"
},
"ref_cc0c6d339aacc9796e52": {
"in": "query",
"name": "fromDateTime",
"schema": {
"description": "Filter by terminal orders created after a specific date. The date format follows the [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) standard.",
"example": "2024-09-08T12:00:00.000Z",
"format": "date-time",
"type": "string"
}
},
"ref_ccadaed26e46692724ee": {
"additionalProperties": false,
"description": "Donations Addendum for merchants that accept donations.",
"properties": {
"type": {
"const": "donationsV1",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"ref_ced7ecb5610bd5b00dfe": {
"description": "One or more validation errors occurred",
"summary": "Bad request",
"value": {
"detail": "One or more validation errors occurred, see error section for more info",
"errors": [
{
"detail": "invalid value",
"message": "Expected integer, got abc",
"parameter": "before"
}
],
"status": 400,
"title": "Bad request",
"type": "https://docs.payroc.com/api/errors#bad-request"
}
},
"ref_ceeff4dfd8c3b98b1530": {
"description": "Filter refunds by the unique identifier that the merchant assigned to the order.",
"examples": {
"example": {
"value": "OrderRef6543"
}
},
"in": "query",
"name": "orderId",
"schema": {
"maxLength": 24,
"minLength": 1,
"type": "string"
}
},
"ref_cf614403c80b98c3ec2a": {
"properties": {
"address": {
"description": "Polymorphic object that contains address information for a funding recipient.",
"oneOf": [
{
"$ref": "#/x-devx-bundled/ref_51baeef3d490d18ab4d6"
}
],
"type": "object"
},
"charityId": {
"description": "Government identifier of the charity.",
"type": "string"
},
"contactMethods": {
"description": "Array of polymorphic objects, which contain contact information. \n\nThe value of the type parameter determines which variant you should use: \n-\t`email` - Email address \n-\t`phone` - Phone number\n-\t`mobile` - Mobile number\n-\t`fax` - Fax number\n",
"example": [
{
"type": "email",
"value": "jane.doe@example.com"
}
],
"items": {
"$ref": "#/x-devx-bundled/ref_7960ea97dd5f79b93ae4"
},
"minItems": 1,
"type": "array"
},
"createdDate": {
"description": "Date the funding recipient was created.",
"example": "2024-07-02T15:30:00+00:00",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"doingBusinessAs": {
"description": "Legal name of the business or organization.",
"type": "string"
},
"fundingAccounts": {
"description": "Array of fundingAccount objects associated with the funding recipient.",
"example": [
{
"fundingAccountId": 123,
"link": {
"href": "https://api.payroc.com/v1/funding-accounts/123",
"method": "get",
"rel": "fundingAccount"
},
"status": "approved"
},
{
"fundingAccountId": 124,
"link": {
"href": "https://api.payroc.com/v1/funding-accounts/124",
"method": "get",
"rel": "fundingAccount"
},
"status": "rejected"
}
],
"items": {
"properties": {
"fundingAccountId": {
"description": "Unique identifier of the funding account.",
"example": 123,
"type": "integer"
},
"link": {
"description": "Object that contains HATEOAS links for the resource.",
"properties": {
"href": {
"description": "URL of the target resource.",
"example": "https://api.payroc.com/v1/funding-accounts/123",
"type": "string"
},
"method": {
"description": "HTTP method that you need to use with the target resource.",
"example": "get",
"type": "string"
},
"rel": {
"description": "Indicates the relationship between the current resource and the target resource.",
"example": "fundingAccount",
"type": "string"
}
},
"type": "object"
},
"status": {
"description": "Status of the funding account.",
"enum": [
"approved",
"rejected",
"pending",
"hold"
],
"example": "pending",
"type": "string"
}
},
"title": "funding account summary",
"type": "object"
},
"readOnly": true,
"type": "array"
},
"lastModifiedDate": {
"description": "Date the funding recipient was last modified.",
"example": "2024-07-02T15:30:00+00:00",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"metadata": {
"additionalProperties": {
"type": "string"
},
"description": "[Metadata](https://docs.payroc.com/api/metadata) object you can use to include custom data with your request.",
"example": {
"yourCustomField": "abc123"
},
"type": "object"
},
"owners": {
"description": "Array of owner objects associated with the funding recipient.",
"items": {
"properties": {
"link": {
"description": "Object that contains HATEOAS links for the resource.",
"properties": {
"href": {
"description": "URL of the target resource.",
"example": "https://api.payroc.com/v1/owners/4564",
"type": "string"
},
"method": {
"description": "HTTP method that you need to use with the target resource.",
"example": "get",
"type": "string"
},
"rel": {
"description": "Indicates the relationship between the current resource and the target resource.",
"example": "owner",
"type": "string"
}
},
"type": "object"
},
"ownerId": {
"description": "Unique identifier of the owner.",
"example": 4564,
"type": "integer"
}
},
"title": "owner summary",
"type": "object"
},
"readOnly": true,
"type": "array"
},
"recipientId": {
"description": "Unique identifier that we assigned to the funding recipient.",
"example": 234,
"readOnly": true,
"type": "integer"
},
"recipientType": {
"description": "Type or legal structure of the funding recipient.",
"enum": [
"privateCorporation",
"publicCorporation",
"nonProfit",
"government",
"privateLlc",
"publicLlc",
"privatePartnership",
"publicPartnership",
"soleProprietor"
],
"example": "privateCorporation",
"type": "string"
},
"status": {
"description": "Indicates if we have approved the funding recipient.",
"enum": [
"approved",
"rejected",
"pending"
],
"example": "approved",
"readOnly": true,
"type": "string"
},
"taxId": {
"description": "Employer identification number (EIN) or Social Security number (SSN).",
"example": "123456789",
"type": "string"
}
},
"required": [
"address",
"contactMethods",
"recipientType",
"taxId",
"owners",
"fundingAccounts",
"doingBusinessAs"
],
"title": "funding recipient",
"type": "object"
},
"ref_cf73da6ef9cd0d35a508": {
"description": "Filter results by the settlement status.",
"examples": {
"example": {
"value": "settled"
}
},
"in": "query",
"name": "settlementState",
"schema": {
"enum": [
"settled",
"unsettled"
],
"type": "string"
}
},
"ref_cf90a713b43d9f748754": {
"description": "Bank Account Verification Request for ACH",
"summary": "ACH Bank Account Verification",
"value": {
"bankAccount": {
"accountNumber": "11101010",
"accountType": "checking",
"nameOnAccount": "Sarah Hazel Hopper",
"routingNumber": "053200983",
"secCode": "web",
"type": "ach"
},
"processingTerminalId": "1234001"
}
},
"ref_cf9674a1156522156212": {
"description": "Object that contains information about dual pricing.",
"properties": {
"alternativeTender": {
"description": "Payment method that the merchant presented to the customer as an alternative to their chosen method. \n**Note:** For requests, if the value for **offered** is `true`, you must send a value for **alternativeTender** in the request.\n",
"enum": [
"card",
"cash",
"bankTransfer"
],
"example": "card",
"type": "string"
},
"choiceRate": {
"$ref": "#/x-devx-bundled/ref_7962c22afef6601443db",
"description": "Object that contains information about the choice rate. \n**Note:** For requests, if the value for **offered** is `true`, you must send this object in the request.\n"
},
"offered": {
"description": "Indicates if the merchant offered dual pricing to the customer.",
"example": false,
"type": "boolean"
}
},
"required": [
"offered"
],
"type": "object"
},
"ref_cfe1adbe0a054ebe6791": {
"description": "Object that contains information about our additional services that the merchant can sign up for.",
"items": {
"$ref": "#/x-devx-bundled/ref_9ec81cd66483861eb3d0"
},
"title": "US version 5.2 services array",
"type": "array",
"uniqueItems": true
},
"ref_cfe961eef7b95f482be7": {
"properties": {
"costBreakdown": {
"description": "Object that contains information about the items in the terminal order and the cost of the items.",
"properties": {
"customCharges": {
"description": "List of additional charges for the order.",
"items": {
"properties": {
"name": {
"description": "Name of the charge.",
"example": "Setup Fee",
"maxLength": 50,
"minLength": 1,
"type": "string"
},
"value": {
"description": "Cost of the charge. The value is in the currency’s lowest denomination, for example, cents.",
"example": 4999,
"maximum": 999999,
"minimum": 0,
"type": "integer"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"maxItems": 10,
"minItems": 1,
"type": "array"
},
"items": {
"description": "Array of items objects.",
"items": {
"properties": {
"name": {
"description": "Name or brief description of the item.",
"example": "Terminal",
"maxLength": 50,
"minLength": 1,
"type": "string"
},
"quantity": {
"description": "Quantity of the item in the order.",
"example": 1,
"minimum": 1,
"type": "integer"
},
"unitCost": {
"description": "Cost of the item. The value is in the currency’s lowest denomination, for example, cents.",
"example": 4999,
"maximum": 999999,
"minimum": 0,
"type": "integer"
}
},
"required": [
"name",
"quantity",
"unitCost"
],
"type": "object"
},
"maxItems": 10,
"minItems": 1,
"type": "array"
},
"shippingCost": {
"description": "Cost of shipping the terminal order. The value is in the currency’s lowest denomination, for example, cents.",
"example": 4999,
"maximum": 999999,
"minimum": 0,
"type": "integer"
}
},
"required": [
"items"
],
"type": "object"
},
"payment": {
"description": "Object that contains information about how the payer is paying for the terminal order.",
"discriminator": {
"mapping": {
"merchant": "#/components/schemas/payerMerchant",
"partner": "#/components/schemas/payerPartner"
},
"propertyName": "payer"
},
"oneOf": [
{
"$ref": "#/x-devx-bundled/ref_f0b7a1371b9eea6970de"
},
{
"$ref": "#/x-devx-bundled/ref_a748f92789c13ba52290"
}
],
"type": "object"
},
"paymentIntentId": {
"description": "Unique identifier we assigned to the payment intent.",
"example": "1542",
"type": "string"
},
"paymentIntentType": {
"description": "Type of payment intent.",
"enum": [
"purchase"
],
"example": "purchase",
"maxLength": 8,
"type": "string"
},
"subTotal": {
"description": "Total amount of the terminal order before tax. The value is in the currency’s lowest denomination, for example, cents. \n**Note**: You must send a value for this parameter if the payer is `merchant`.\n",
"example": 4347,
"maximum": 999999,
"minimum": 0,
"type": "integer"
},
"tax": {
"description": "Object that contains the tax information for the terminal order.",
"properties": {
"isTaxExempt": {
"default": false,
"description": "Indicates if the terminal order is tax exempt. The default value is `false`.\n\n**Note**: If you send a value of `false`, send a value for the taxAmount parameter.\n",
"example": true,
"type": "boolean"
},
"taxAmount": {
"description": "Amount of tax for the terminal order. The value is in the currency’s lowest denomination, for example, cents.",
"example": 217,
"maximum": 999999,
"minimum": 0,
"type": "integer"
}
},
"type": "object"
}
},
"required": [
"paymentIntentType",
"payment",
"paymentIntentId"
],
"type": "object"
},
"ref_d0e000150e9c1a86a589": {
"properties": {
"type": {
"description": "Type of contact method.",
"enum": [
"email"
],
"type": "string"
},
"value": {
"description": "Email address.",
"example": "jane.doe@example.com",
"maxLength": 50,
"type": "string"
}
},
"required": [
"type",
"value"
],
"title": "email",
"type": "object"
},
"ref_d12dac40c833df284787": {
"description": "Payment Plan",
"summary": "Payment Plan",
"value": {
"count": 2,
"data": [
{
"currency": "USD",
"description": "Monthly Premium Club subscription",
"frequency": "monthly",
"length": 12,
"name": "Premium Club",
"onDelete": "complete",
"onUpdate": "continue",
"paymentPlanId": "PlanRef8765",
"processingTerminalId": "1234001",
"type": "automatic"
},
{
"currency": "USD",
"customFieldNames": [
"yourCustomField"
],
"description": "Pie It Forward charitable trust donation",
"frequency": "yearly",
"length": 0,
"name": "Pie It Forward",
"onDelete": "complete",
"onUpdate": "continue",
"paymentPlanId": "PlanRef8766",
"processingTerminalId": "1234001",
"type": "automatic"
}
],
"hasMore": true,
"limit": 2,
"links": [
{
"href": "https://api.payroc.com/v1/processing-terminals/1001/payment-plans?limit=2&after=PlanRef8766",
"method": "get",
"rel": "next"
},
{
"href": "https://api.payroc.com/v1/processing-terminals/1001/payment-plans?limit=2&before=PlanRef8765",
"method": "get",
"rel": "previous"
}
]
}
},
"ref_d1c3cf82793d52ba4205": {
"description": "Paginated list of merchant balances.",
"summary": "Paginated list of merchant balances",
"value": {
"count": 2,
"data": [
{
"available": 69950,
"currency": "USD",
"funds": 120000,
"merchantId": "4525644354",
"pending": 50050
},
{
"available": 50000,
"currency": "USD",
"funds": 50000,
"merchantId": "9876543219",
"pending": 0
}
],
"hasMore": true,
"limit": 2,
"links": [
{
"href": "https://api.payroc.com/v1/funding-balance?before=4525644354&limit=2",
"method": "get",
"rel": "previous"
},
{
"href": "https://api.payroc.com/v1/funding-balance?after=9876543219&limit=2",
"method": "get",
"rel": "next"
}
]
}
},
"ref_d1e967a8d89aef838dd2": {
"description": "Filter results by the type of link. Send a value of singleUse or multiUse.",
"examples": {
"example": {
"value": "multiUse"
}
},
"in": "query",
"name": "linkType",
"schema": {
"enum": [
"multiUse",
"singleUse"
],
"type": "string"
}
},
"ref_d20a778f5c01261ca9cd": {
"description": "Payment plan after we moved the custom field name. The array contains only one entry, so the order of the entries doesn't change.\n",
"summary": "Update payment plan: move",
"value": {
"currency": "USD",
"customFieldNames": [
"yourCustomField"
],
"description": "Monthly Premium Club subscription",
"frequency": "monthly",
"length": 12,
"name": "Premium Club",
"onDelete": "complete",
"onUpdate": "continue",
"paymentPlanId": "PlanRef8765",
"processingTerminalId": "1234001",
"recurringOrder": {
"amount": 4999,
"breakdown": {
"subtotal": 4347,
"taxes": [
{
"name": "Sales Tax",
"rate": 5
}
]
},
"description": "Monthly Premium Club subscription"
},
"setupOrder": {
"amount": 4999,
"breakdown": {
"subtotal": 4347,
"taxes": [
{
"name": "Sales Tax",
"rate": 5
}
]
},
"description": "Initial setup fee for Premium Club subscription"
},
"type": "automatic"
}
},
"ref_d27c21dc4044d83a551b": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_360be5d7e0853d272f75"
},
{
"properties": {
"acceptPartialAmount": {
"default": false,
"description": "Indicates if the merchant accepts a partial authorization for this payment. The value is one of the following:\n\n- `true` - If the cardholder doesn't have the full amount available in their account, our gateway processes a partial payment.\n- `false` - If the cardholder doesn't have the full amount available in their account, our gateway declines the payment.\n",
"example": true,
"type": "boolean"
},
"breakdown": {
"$ref": "#/x-devx-bundled/ref_049dcd8f29853ec0de7d"
}
},
"type": "object"
}
],
"description": "Object that contains information about the payment.",
"type": "object"
},
"ref_d2abe31f0db8698b23fb": {
"description": "Host processor configuration of a processing terminal.",
"summary": "Retrieve host processor configuration",
"value": {
"configuration": {
"merchant": {
"abaNumber": "967854108",
"agentBankNumber": "000001",
"binNumber": "888888",
"chainNumber": "222222",
"locationNumber": "000001",
"posMid": "123456789101",
"reimbursementAttribute": "Z",
"settlementAgent": "0001"
},
"processor": "tsys",
"terminal": {
"authenticationCode": "A1B2C3",
"cardPresentAllowed": true,
"internetAllowed": true,
"motoAllowed": false,
"sharingGroups": "3E7HULY8NQWZG",
"terminalId": "V500000",
"terminalNumber": "1111"
}
},
"processingAccountId": "23451",
"processingTerminalId": "0123451001"
}
},
"ref_d33de35f24d92438e9df": {
"description": "Update the details of a funding recipient.",
"summary": "Update funding recipient",
"value": {
"address": {
"address1": "2 Example Ave.",
"address2": "Example Address Line 2",
"address3": "Example Address Line 3",
"city": "Chicago",
"country": "US",
"postalCode": "60056",
"state": "Illinois"
},
"contactMethods": [
{
"type": "email",
"value": "fred.nerk@example.com"
},
{
"type": "phone",
"value": "2025550110"
}
],
"doingBusinessAs": "Doe Hot Dogs",
"fundingAccounts": [
{
"fundingAccountId": 124,
"link": {
"href": "https://api.payroc.com/v1/funding-accounts/124",
"method": "get",
"rel": "fundingAccount"
},
"status": "approved"
}
],
"metadata": {
"responsiblePerson": "Jane Doe"
},
"owners": [
{
"link": {
"href": "https://api.payroc.com/v1/owners/12346",
"method": "get",
"rel": "owner"
},
"ownerId": 12346
}
],
"recipientType": "privateCorporation",
"taxId": "12-3456789"
}
},
"ref_d3797fc41828d98b6e34": {
"description": "Percentage value up to 2 decimal places.",
"example": 1.25,
"format": "double",
"maximum": 100,
"minimum": 0,
"title": "percentage",
"type": "number",
"x-fern-type-hint": "decimal"
},
"ref_d3a4eba54bda0d8ac8e1": {
"description": "Replace operation updates an existing value.",
"summary": "Update payment link: replace",
"value": [
{
"op": "replace",
"path": "/expiresOn",
"value": "2024-11-30"
}
]
},
"ref_d3c4d3de01cff302d518": {
"description": "Object that contains the gateway settings for the solution.",
"properties": {
"gateway": {
"description": "Name of the gateway that processes the transactions.",
"enum": [
"payroc"
],
"type": "string"
},
"terminalTemplateId": {
"description": "Unique identifier of the gateway terminal template.",
"maxLength": 50,
"type": "string"
}
},
"required": [
"gateway",
"terminalTemplateId"
],
"type": "object"
},
"ref_d465d569f024a45a9197": {
"properties": {
"cutOffTime": {
"description": "Time that the processing terminal closes the batch. Our gateway returns this value in `HH:mm` format and uses the 24-hour clock.",
"example": "13:55",
"maxLength": 5,
"pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$",
"readOnly": true,
"type": "string"
},
"timezone": {
"description": "Time zone of the processing terminal. Our gateway returns this value as an [IANA Time Zone Database identifier](https://www.iana.org/time-zones), for example, `America/Chicago` or `Europe/London`.",
"example": "America/Chicago",
"maxLength": 40,
"pattern": "^[A-Z][A-Za-z_+\\-]+(/[A-Za-z_+\\-]+){1,2}$",
"readOnly": true,
"type": "string"
}
},
"required": [
"cutOffTime",
"timezone"
],
"type": "object"
},
"ref_d4a82d501fc873246869": {
"description": "A snapshot of the subscription's current state.",
"properties": {
"nextDueDate": {
"description": "Date that the merchant collects the next payment.",
"example": "2024-08-02",
"format": "date",
"type": "string"
},
"outstandingInvoices": {
"description": "Number of payments until the end of the subscription. \nOur gateway returns a value for **outstandingInvoices** only if the subscription \nhas an end date or a fixed number of billing cycles.\n",
"example": 9,
"format": "int32",
"minimum": 0,
"type": "integer"
},
"paidInvoices": {
"description": "Number of payments that the merchant has collected.",
"example": 3,
"format": "int32",
"minimum": 0,
"type": "integer"
},
"status": {
"description": "Status of the Subscription.\n\n- 'active' - Subscription is active.\n- 'completed' - Subscription has reached the end date or the total number of billing cycles.\n- 'cancelled' - Merchant deactivated the subscription.\n- 'suspended' - Subscription is suspended. For example, if the customer misses payments.\n",
"enum": [
"active",
"completed",
"suspended",
"cancelled"
],
"example": "active",
"type": "string"
}
},
"required": [
"paidInvoices",
"status"
],
"type": "object"
},
"ref_d52f6ca29cad3f557108": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_f9d963d00740bbe00c9e"
},
{
"properties": {
"data": {
"description": "Array of processing terminal objects.",
"items": {
"$ref": "#/x-devx-bundled/ref_9978c2f4aebe867fd1cc"
},
"type": "array"
}
},
"type": "object"
}
],
"title": "paginated Processing Terminals",
"type": "object"
},
"ref_d542796289b905797418": {
"description": "Payment plan after we added the new custom field name.",
"summary": "Update payment plan: add",
"value": {
"currency": "USD",
"customFieldNames": [
"yourCustomField",
"loyaltyPoints"
],
"description": "Monthly Premium Club subscription",
"frequency": "monthly",
"length": 12,
"name": "Premium Club",
"onDelete": "complete",
"onUpdate": "continue",
"paymentPlanId": "PlanRef8765",
"processingTerminalId": "1234001",
"recurringOrder": {
"amount": 4999,
"breakdown": {
"subtotal": 4347,
"taxes": [
{
"name": "Sales Tax",
"rate": 5
}
]
},
"description": "Monthly Premium Club subscription"
},
"setupOrder": {
"amount": 4999,
"breakdown": {
"subtotal": 4347,
"taxes": [
{
"name": "Sales Tax",
"rate": 5
}
]
},
"description": "Initial setup fee for Premium Club subscription"
},
"type": "automatic"
}
},
"ref_d67787cf05a5b220dc42": {
"discriminator": {
"mapping": {
"webhook": "#/components/schemas/webhook"
},
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/x-devx-bundled/ref_f9558cdcf01ed42b8fd5"
}
],
"title": "Notification method",
"type": "object"
},
"ref_d6a1eaa6dc26dc07f865": {
"description": "Object that contains information about the transaction.",
"properties": {
"amount": {
"description": "Transaction amount. We return the value in the currency's lowest denomination, for example, cents.",
"example": 4999,
"type": "integer"
},
"authorization": {
"$ref": "#/x-devx-bundled/ref_c73f68ebc114017ee0a4"
},
"batch": {
"$ref": "#/x-devx-bundled/ref_1a4f881ca24e9232b696"
},
"card": {
"$ref": "#/x-devx-bundled/ref_6856721f35e105390b4f"
},
"cashbackAmount": {
"description": "Cashback amount. We return the value in the currency's lowest denomination, for example, cents.",
"example": 0,
"type": "integer"
},
"createdDate": {
"description": "Date that we received the transaction. The format of this value is **YYYY-MM-DD**.",
"example": "2024-07-02",
"format": "date",
"type": "string"
},
"currency": {
"description": "Currency of the transaction. The value for the currency follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard.",
"example": "USD",
"type": "string"
},
"date": {
"description": "Date of the transaction. The format of this value is **YYYY-MM-DD**.",
"example": "2024-07-02",
"format": "date",
"type": "string"
},
"entryMethod": {
"description": "Indicates how the merchant received the payment details.",
"enum": [
"barcodeRead",
"smartChipRead",
"swipedOriginUnknown",
"contactlessChip",
"ecommerce",
"manuallyEntered",
"manuallyEnteredFallback",
"swiped",
"swipedFallback",
"swipedError",
"scannedCheckReader",
"credentialOnFile",
"unknown"
],
"example": "contactlessChip",
"type": [
"string",
"null"
]
},
"interchange": {
"description": "Object that contains information about the interchange fees for the transaction.",
"properties": {
"basisPoint": {
"description": "Interchange basis points that we apply to the transaction.",
"example": 150,
"type": "integer"
},
"transactionFee": {
"description": "Interchange fee for the transaction. We return the value in the currency's lowest denomination, for example, cents.",
"example": 50,
"type": "integer"
}
},
"type": "object"
},
"lastModifiedDate": {
"description": "Date that the transaction was last changed. The format of this value is **YYYY-MM-DD**.",
"example": "2024-07-02",
"format": "date",
"type": "string"
},
"merchant": {
"$ref": "#/x-devx-bundled/ref_67c77db80e4fded0ad81"
},
"settled": {
"$ref": "#/x-devx-bundled/ref_931de6260653964c9232"
},
"status": {
"description": "Indicates the status of the transaction. The value is one of the following: \n\n-\t`fullSuspense` – Merchant ran the transaction while their account was in full suspense. \n-\t`heldAudited` – We have moved a transaction from fullSuspense and placed it on hold. \n-\t`heldReleasedAudited` – We audited and released the transaction that we had previously held. \n-\t`holdForSettlement30Days` - We are holding the transaction for a maximum of 30 days. \n-\t`holdForSettlementDuplicate` - We held the transaction because the transaction may be a duplicate. \n-\t`holdLongTerm` - We are holding the transaction for an extended period. \n-\t`paid` – We have paid the transaction funds to the merchant. \n-\t`paidByThirdParty` - A third party has paid the transaction funds to the merchant. \n-\t`partialRelease` – We partially released the transaction funds. \n-\t`pull` - We pulled the transaction, and the merchant does not receive funds for the transaction. \n-\t`release` - We released the transaction that we previously held. \n-\t`new` – We have prepared the funds from the transaction to send to the merchant. \n-\t`held` – We held the transaction. \n-\t`unknown` – No transaction status available. \n",
"enum": [
"fullSuspense",
"heldAudited",
"heldReleasedAudited",
"holdForSettlement30Days",
"holdForSettlementDuplicate",
"holdLongTerm",
"paid",
"paidByThirdParty",
"partialRelease",
"pull",
"release",
"new",
"held",
"unknown"
],
"example": "paid",
"type": "string"
},
"transactionId": {
"description": "Unique identifier that we assigned to the transaction.",
"example": 442233,
"type": [
"integer",
"null"
]
},
"type": {
"description": "Indicates the type of transaction. The value is one of the following: \n\n- `capture` - Transaction is a sale. \n- `return` - Transaction is a refund. \n",
"enum": [
"capture",
"return"
],
"example": "capture",
"type": "string"
}
},
"title": "transaction",
"type": "object"
},
"ref_d6bcaa20c2875a8f1079": {
"description": "Adjust Payment",
"summary": "Adjust Payment",
"value": {
"adjustments": [
{
"shippingAddress": {
"address": {
"address1": "1 Example Ave.",
"address2": "Example Address Line 2",
"address3": "Example Address Line 3",
"city": "Chicago",
"country": "US",
"postalCode": "60056",
"state": "Illinois"
},
"recipientName": "Sarah Hopper"
},
"type": "customer"
},
{
"amount": 3999,
"type": "order"
}
]
}
},
"ref_d6d993b77cf7f8d82fb7": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_77d38980c21a16856c11"
},
{
"properties": {
"fundingAccounts": {
"description": "Array of fundingAccounts objects.",
"items": {
"$ref": "#/x-devx-bundled/ref_9a102086f05b94adac7a"
},
"maxItems": 2,
"minItems": 1,
"type": "array",
"writeOnly": true
}
},
"type": "object"
}
],
"description": "Object that contains information about the funding schedule of the processing account. \n",
"type": "object"
},
"ref_d6fca19f77413d66469c": {
"description": "Indicates if you want to return closed processing accounts. This includes processing accounts that have a status of `terminated`, `cancelled`, or `rejected`. \n**Note**: By default, we return only open processing accounts. \n",
"examples": {
"example": {
"value": false
}
},
"in": "query",
"name": "includeClosed",
"schema": {
"default": false,
"type": "boolean"
}
},
"ref_d77d570c70a1a1c56a40": {
"description": "Object that contains information about the surcharge.\n",
"properties": {
"amount": {
"description": "If the merchant added a surcharge fee, this value indicates the amount of the surcharge fee\nin the currency’s lowest denomination, for example, cents.\n",
"example": 50,
"exclusiveMinimum": 0,
"format": "int64",
"readOnly": true,
"type": "integer"
},
"bypass": {
"description": "Indicates if the merchant wants to remove the surcharge fee from the transaction. \n- `true` - Gateway removes the surcharge fee from the transaction. \n- `false` - Gateway adds the fee to the transaction. \n",
"example": false,
"type": "boolean"
},
"percentage": {
"description": "If the merchant added a surcharge fee, this value indicates the surcharge percentage.",
"example": 2,
"exclusiveMinimum": 0,
"format": "double",
"maximum": 100,
"readOnly": true,
"type": "number",
"x-fern-type-hint": "decimal"
}
},
"type": "object"
},
"ref_d7a78654a15a2c87ffaa": {
"description": "Object that contains information about the customer’s payment card.",
"properties": {
"accountType": {
"description": "Indicates the customer’s account type. \n\n**Note:** Send a value for accountType only for bank account details.\n",
"enum": [
"checking",
"savings"
],
"example": "checking",
"type": "string"
},
"cardDetails": {
"description": "Polymorphic object that contains payment card information. \n\nThe value of the entryMethod parameter determines which variant you should use: \n- `raw` - Unencrypted payment data directly from the device.\n- `icc` - Payment data that the device captured from the chip.\n- `keyed` - Payment data that the merchant entered manually.\n- `swiped` - Payment data that the device captured from the magnetic strip.\n",
"discriminator": {
"mapping": {
"icc": "#/components/schemas/iccCardDetails",
"keyed": "#/components/schemas/keyedCardDetails",
"raw": "#/components/schemas/rawCardDetails",
"swiped": "#/components/schemas/swipedCardDetails"
},
"propertyName": "entryMethod"
},
"oneOf": [
{
"$ref": "#/x-devx-bundled/ref_fb5a139ab9687a8241f1"
},
{
"$ref": "#/x-devx-bundled/ref_b70be651077357504b4a"
},
{
"$ref": "#/x-devx-bundled/ref_6152e7b2e2079c927267"
},
{
"$ref": "#/x-devx-bundled/ref_a07ca902af0058dde303"
}
],
"type": "object"
},
"type": {
"description": "Method that the terminal used to take the payment.",
"enum": [
"card"
],
"example": "card",
"type": "string"
}
},
"required": [
"type",
"cardDetails"
],
"title": "card",
"type": "object",
"writeOnly": true
},
"ref_d7c593c600b95328ff30": {
"description": "Object that contains information about the adjustment to the transaction. Send this object if the merchant is adjusting the customer’s contact details.",
"properties": {
"contactMethods": {
"description": "Array of polymorphic objects, which contain contact information. \n\nThe value of the type parameter determines which variant you should use: \n-\t`email` - Email address \n-\t`phone` - Phone number\n-\t`mobile` - Mobile number\n-\t`fax` - Fax number\n",
"items": {
"$ref": "#/x-devx-bundled/ref_7960ea97dd5f79b93ae4"
},
"type": "array",
"uniqueItems": true
},
"shippingAddress": {
"$ref": "#/x-devx-bundled/ref_6390b31795ee298ddaec"
},
"type": {
"description": "Type of adjustment.",
"enum": [
"customer"
],
"example": "customer",
"type": "string"
}
},
"required": [
"type"
],
"title": "customer",
"type": "object"
},
"ref_d8267a8278910c858c37": {
"properties": {
"address": {
"$ref": "#/x-devx-bundled/ref_51baeef3d490d18ab4d6"
},
"contactMethods": {
"description": "Array of polymorphic objects, which contain contact information. \n\n**Note:** If you are adding information about an owner, you must provide at least an email address. If you are adding information about a contact, you must provide at least a contact number. \n\nThe value of the type parameter determines which variant you should use: \n-\t`email` - Email address \n-\t`phone` - Phone number\n-\t`mobile` - Mobile number\n-\t`fax` - Fax number\n",
"items": {
"$ref": "#/x-devx-bundled/ref_7960ea97dd5f79b93ae4"
},
"maxItems": 4,
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"dateOfBirth": {
"description": "Owner's date of birth. The format of this value is **YYYY-MM-DD**.",
"example": "1964-03-22",
"format": "date",
"type": "string"
},
"firstName": {
"description": "Owner's first name.",
"example": "Jane",
"maxLength": 50,
"type": "string"
},
"identifiers": {
"description": "Array of IDs.",
"example": [
{
"type": "nationalId",
"value": "xxxxx4320"
}
],
"items": {
"$ref": "#/x-devx-bundled/ref_a0414249ae6629c4d288"
},
"minItems": 1,
"type": "array"
},
"lastName": {
"description": "Owner's last name.",
"example": "Doe",
"maxLength": 50,
"type": "string"
},
"middleName": {
"description": "Owner's middle name.",
"example": "Helen",
"maxLength": 50,
"type": "string"
},
"ownerId": {
"description": "Unique identifier that we assigned to the owner.",
"example": 4564,
"readOnly": true,
"type": "integer"
},
"relationship": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_50544b326de9b86839df"
}
],
"description": "Object that contains information about the owner's relationship to the business."
}
},
"required": [
"firstName",
"lastName",
"dateOfBirth",
"identifiers",
"contactMethods",
"relationship",
"address"
],
"title": "owner",
"type": "object"
},
"ref_d8468a3993ad87f32e78": {
"description": "Object that contains information about the payment details for the customer’s preauthorized electronic debit (PAD) transactions.",
"properties": {
"accountNumber": {
"description": "Customer's account number. \n**Note:** In responses, our gateway shows only the last four digits of the account number, for example, `*****5929`.\n",
"example": "1234567890",
"maxLength": 12,
"minLength": 7,
"pattern": "^[0-9]*$",
"type": "string"
},
"accountType": {
"description": "Indicates the customer’s account type. \n**Note:** For bank account details, send a value for accountType.\n",
"enum": [
"checking",
"savings"
],
"example": "checking",
"type": "string"
},
"institutionNumber": {
"description": "Three-digit number that identifies the customer's bank.",
"example": "543",
"maxLength": 3,
"minLength": 3,
"pattern": "^[0-9]*$",
"type": "string"
},
"nameOnAccount": {
"description": "Customer's name.",
"example": "Sarah Hazel Hopper",
"maxLength": 29,
"minLength": 1,
"type": "string"
},
"transitNumber": {
"description": "Five-digit number that identifies the customer's bank branch.",
"example": "76543",
"maxLength": 5,
"minLength": 5,
"pattern": "^[0-9]*$",
"type": "string"
},
"type": {
"description": "Indicates the type of bank account details the customer is using: \n- **ACH** - Customer's bank account is in the United States. \n- **PAD** - Customer's bank account is in Canada. \n",
"enum": [
"pad"
],
"example": "pad",
"type": "string"
}
},
"required": [
"type",
"nameOnAccount",
"accountNumber",
"transitNumber",
"institutionNumber"
],
"title": "pad",
"type": "object",
"writeOnly": true
},
"ref_d84ea69cff6ee961bfe4": {
"description": "Object that contains information about the ACH deposit.",
"example": {
"achDepositId": 99,
"link": {
"href": "https://api.payroc.com/v1/ach-deposits/99?merchantId=4525644354",
"method": "get",
"rel": "achDeposit"
}
},
"properties": {
"achDepositId": {
"description": "Unique identifier of the ACH deposit.",
"example": 99,
"type": "integer"
},
"link": {
"$ref": "#/x-devx-bundled/ref_27e6d0e095fb23cba669"
}
},
"title": "ACH deposit summary",
"type": "object"
},
"ref_d8cd14845770b321a0d8": {
"content": {
"application/problem+json": {
"examples": {
"notAuthorized": {
"$ref": "#/x-devx-bundled/ref_2032b83df64d6f876909"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_03121a5c54d7fd9b8c46"
}
}
},
"description": "Identity could not be verified"
},
"ref_d9295fdced72f843ce0f": {
"description": "Refund",
"summary": "Refund",
"value": {
"channel": "pos",
"customFields": [
{
"name": "yourCustomField",
"value": "abc123"
}
],
"order": {
"amount": 4999,
"currency": "USD",
"description": "Refund for order OrderRef6543",
"orderId": "OrderRef6543"
},
"processingTerminalId": "1234001",
"refundMethod": {
"cardDetails": {
"entryMethod": "keyed",
"keyedData": {
"cardNumber": "4539858876047062",
"dataFormat": "plainText",
"device": {
"model": "paxA920",
"serialNumber": "1850010868"
},
"expiryDate": "1230"
}
},
"type": "card"
}
}
},
"ref_d9867eacc8169139adec": {
"description": "Idempotency key must be supplied",
"summary": "Idempotency key missing",
"value": {
"detail": "An 'Idempotency-Key' must be supplied for this request",
"status": 400,
"title": "Idempotency-Key header missing",
"type": "https://docs.payroc.com/api/errors#idempotency-key-missing"
}
},
"ref_d9c7a4f1f108f5d16234": {
"description": "Test operation validates that a value at the target location equals the specified value.",
"summary": "Update subscription: test",
"value": [
{
"op": "test",
"path": "/length",
"value": 12
}
]
},
"ref_da456c8e931765f569e4": {
"description": "Object that contains the IP address of the device that sent the request.",
"properties": {
"type": {
"description": "Internet protocol version of the IP address.",
"enum": [
"ipv4",
"ipv6"
],
"type": "string"
},
"value": {
"description": "IP address of the device.",
"type": "string"
}
},
"required": [
"type",
"value"
],
"type": "object",
"writeOnly": true
},
"ref_da57bdc2edb33f29319b": {
"description": "Serial number of the merchant’s payment device.",
"examples": {
"example": {
"value": "1850010868"
}
},
"in": "path",
"name": "serialNumber",
"required": true,
"schema": {
"maxLength": 64,
"minLength": 1,
"type": "string"
}
},
"ref_da83b3b247e47a3a0932": {
"description": "Filter transactions by transaction type.",
"examples": {
"example": {
"value": "Capture"
}
},
"in": "query",
"name": "transactionType",
"schema": {
"enum": [
"Capture",
"Return"
],
"type": "string"
}
},
"ref_daefdac9b965c8c44156": {
"description": "Filter results by transaction type.",
"examples": {
"example": {
"value": [
"refund"
]
}
},
"in": "query",
"name": "type",
"schema": {
"items": {
"enum": [
"refund",
"unreferencedRefund"
],
"type": "string"
},
"type": "array"
}
},
"ref_db52edd25af194f3f64d": {
"description": "Update the customer's payment details that are represented by the secure token.\n\nStructure your request to follow the [RFC 6902](https://datatracker.ietf.org/doc/html/rfc6902) standard.\n",
"summary": "Update secure token",
"value": [
{
"op": "replace",
"path": "/customer/lastName",
"value": "Reed"
},
{
"op": "replace",
"path": "/shippingAddress/recipientName",
"value": "Sarah Reed"
},
{
"op": "replace",
"path": "/source/cardDetails/cardholderName",
"value": "Sarah Reed"
}
]
},
"ref_dba34ab7c46527b180dd": {
"properties": {
"pricingIntentId": {
"description": "Unique identifier of the pricing intent.",
"example": "6123",
"type": "string"
},
"type": {
"description": "Type of pricing for the processing account. \n**Note**: To create a pricing intent, go to [Create Pricing Intent](https://docs.payroc.com/api/schema/boarding/pricing-intents/create). \n",
"enum": [
"intent"
],
"example": "intent",
"type": "string"
}
},
"required": [
"type",
"pricingIntentId"
],
"title": "intent",
"type": "object"
},
"ref_dc58c2edd8de4473d826": {
"description": "Array of activityRecord objects.",
"properties": {
"amount": {
"description": "Total amount that we removed or added to the merchant's funding balance. The value is in the currency’s lowest denomination, for example, cents.",
"example": 4999,
"format": "int64",
"type": "integer"
},
"currency": {
"description": "Currency of the funds. We return a value of `USD`.",
"example": "USD",
"type": "string"
},
"date": {
"description": "Date that we moved the funds.",
"example": "2024-07-02T15:30:00Z",
"format": "datetime",
"type": "string"
},
"description": {
"description": "Description of the activity.",
"example": "payment",
"type": "string"
},
"id": {
"description": "Unique identifier that we assigned to the activity.",
"example": 12345,
"type": "integer"
},
"merchant": {
"description": "Doing business as (DBA) name of the merchant that owns the funding balance.",
"example": "Pizza Doe",
"type": "string"
},
"recipient": {
"description": "Name of the account holder who owns the funding account that received funds. \n\n**Note:** We return a value for recipient only if the value for type is `debit`.\n",
"example": "Pizza Doe",
"type": "string"
},
"type": {
"description": "Indicates if we moved funds into or out of the funding balance. Our gateway returns one of the following values:\n-\t`credit` - We moved funds into the funding balance. \n-\t`debit` - We moved funds out of the funding balance.\n",
"enum": [
"credit",
"debit"
],
"example": "credit",
"type": "string"
}
},
"required": [
"id",
"date",
"merchant",
"description",
"amount",
"type",
"currency"
],
"title": "activity record",
"type": "object"
},
"ref_dcbbdede824381a2835b": {
"description": "Filter results by payments that the merchant ran after a specific date. The value follows the [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) standard.",
"examples": {
"example": {
"value": "2024-07-01T00:00:00Z"
}
},
"in": "query",
"name": "dateFrom",
"schema": {
"format": "date-time",
"type": "string"
}
},
"ref_dcd1553cbd8f2356acda": {
"description": "Unique identifier that the merchant assigned to the payment plan.",
"examples": {
"example": {
"value": "PlanRef8765"
}
},
"in": "path",
"name": "paymentPlanId",
"required": true,
"schema": {
"maxLength": 48,
"minLength": 1,
"type": "string"
}
},
"ref_dd10526e1c61ed520dcd": {
"description": "Capture a payment with itemized breakdown",
"summary": "Payment capture",
"value": {
"amount": 4999,
"breakdown": {
"dutyAmount": 499,
"freightAmount": 500,
"items": [
{
"quantity": 1,
"unitPrice": 4000
}
],
"subtotal": 4999
},
"operator": "Jane",
"processingTerminalId": "1234001"
}
},
"ref_dd635faa759cfd56238d": {
"description": "Requested data outside allowed range.",
"summary": "Bad request",
"value": {
"detail": "One or more validation errors occurred, see error section for more info",
"errors": [
{
"detail": "invalid date",
"message": "datefrom cannot be longer than two years ago.",
"parameter": "datefrom"
}
],
"status": 400,
"title": "Bad request",
"type": "https://docs.payroc.com/api/errors#bad-request"
}
},
"ref_de4079f49a6978acc1bf": {
"description": "Object that contains information about U.S. base fees.",
"properties": {
"addressVerification": {
"description": "Fee for each address verification request. The value is in the currency's lowest denomination, for example, cents.",
"example": 5,
"minimum": 0,
"type": [
"integer",
"null"
]
},
"annualFee": {
"description": "Object that contains information about the annual fee.",
"properties": {
"amount": {
"description": "Annual fee. The value is in the currency's lowest denomination, for example, cents.",
"example": 100,
"minimum": 0,
"type": "integer"
},
"billInMonth": {
"default": "december",
"description": "Indicates whether we collect the annual fee in June or December.",
"enum": [
"june",
"december"
],
"example": "june",
"type": "string"
}
},
"required": [
"amount"
],
"type": "object"
},
"batch": {
"description": "Fee for each batch. The value is in the currency's lowest denomination, for example, cents.",
"example": 5,
"minimum": 0,
"type": "integer"
},
"chargeback": {
"default": 2500,
"description": "Fee for each chargeback. The value is in the currency's lowest denomination, for example, cents.",
"example": 2500,
"maximum": 5000,
"minimum": 0,
"type": "integer"
},
"earlyTermination": {
"default": 57500,
"description": "Fee for early termination. The value is in the currency's lowest denomination, for example, cents.",
"example": 57500,
"maximum": 59500,
"minimum": 0,
"type": "integer"
},
"maintenance": {
"description": "Monthly fee for maintenance. The value is in the currency's lowest denomination, for example, cents.",
"example": 1995,
"minimum": 0,
"type": "integer"
},
"merchantAdvantage": {
"description": "Monthly fee for Payroc Advantage. The value is in the currency's lowest denomination, for example, cents.",
"example": 10,
"minimum": 0,
"type": [
"integer",
"null"
]
},
"minimum": {
"description": "Monthly fee that we charge when the merchant doesn't meet the minimum fee amount. This monthly fee is in the currency's lowest denomination, for example, cents.",
"example": 100,
"minimum": 0,
"type": "integer"
},
"pciNonCompliance": {
"default": 7495,
"description": "Fee that we apply each month if you aren't compliant with PCI standards. The value is in the currency's lowest denomination, for example, cents.",
"example": 7495,
"maximum": 10000,
"minimum": 0,
"type": "integer"
},
"platinumSecurity": {
"description": "Polymorphic object that contains billing details for Platinum Security. \n\nThe value of the billingFrequency field determines which variant you should use: \n-\t`monthly` - We collect the fee for Platinum Security each month.\n-\t`annual` - We collect the fee for Platinum Security each year. \n",
"discriminator": {
"mapping": {
"annual": "#/components/schemas/platinumSecurityAnnually",
"monthly": "#/components/schemas/platinumSecurityMonthly"
},
"propertyName": "billingFrequency"
},
"oneOf": [
{
"$ref": "#/x-devx-bundled/ref_2af9c6993f8d5a424f9e"
},
{
"$ref": "#/x-devx-bundled/ref_3ce26e1f1df00a69bcbf"
}
],
"type": "object"
},
"regulatoryAssistanceProgram": {
"description": "Annual fee for the regulatory assistance program. The value is in the currency's lowest denomination, for example, cents.",
"example": 15,
"minimum": 0,
"type": [
"integer",
"null"
]
},
"retrieval": {
"default": 1500,
"description": "Fee for each retrieval. The value is in the currency's lowest denomination, for example, cents.",
"example": 1500,
"maximum": 5000,
"minimum": 0,
"type": "integer"
},
"voiceAuthorization": {
"default": 95,
"description": "Fee for each voice authorization. The value is in the currency's lowest denomination, for example, cents.",
"example": 95,
"maximum": 200,
"minimum": 0,
"type": "integer"
}
},
"required": [
"addressVerification",
"annualFee",
"regulatoryAssistanceProgram",
"merchantAdvantage",
"batch",
"maintenance",
"minimum"
],
"title": "US base fees",
"type": "object"
},
"ref_de4ac55714caec7e9f55": {
"description": "Copy operation duplicates a value from one location to another.",
"summary": "Update payment link: copy",
"value": [
{
"from": "/order/description",
"op": "copy",
"path": "/merchantReference"
}
]
},
"ref_de8b01992f3a8526085d": {
"description": "Bank Transfer Payment with ACH payload and token storage",
"summary": "Store Token Bank Transfer Payment",
"value": {
"credentialOnFile": {
"tokenize": true
},
"customFields": [
{
"name": "yourCustomField",
"value": "abc123"
}
],
"customer": {
"contactMethods": [
{
"type": "email",
"value": "joe@blogssoftware.com"
}
],
"notificationLanguage": "en"
},
"order": {
"amount": 4999,
"breakdown": {
"subtotal": 4347,
"taxes": [
{
"name": "Sales Tax",
"rate": 5,
"type": "rate"
}
],
"tip": {
"percentage": 10,
"type": "percentage"
}
},
"currency": "USD",
"description": "Large Pepperoni Pizza",
"orderId": "OrderRef6543"
},
"paymentMethod": {
"accountNumber": "11101010",
"accountType": "checking",
"nameOnAccount": "Sarah Hazel Hopper",
"routingNumber": "053200983",
"secCode": "web",
"type": "ach"
},
"processingTerminalId": "1234001"
}
},
"ref_de8fdf66f0dd4fd419b2": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_31d65dcf82420e739468"
},
{
"$ref": "#/x-devx-bundled/ref_51baeef3d490d18ab4d6"
}
],
"required": [
"type",
"city",
"country",
"address1",
"postalCode",
"state"
],
"title": "legalAddress"
},
"ref_de9d7aba9da94ce2b1c4": {
"description": "A Patch Copy Operation.",
"properties": {
"from": {
"description": "Location of the value that you want to copy.\nThe format for this value is JSON Pointer.\n",
"type": "string"
},
"op": {
"description": "`copy` operation.",
"enum": [
"copy"
],
"type": "string"
},
"path": {
"description": "Location where you want to copy the value to.\nThe format for this value is JSON Pointer.\n",
"type": "string"
}
},
"required": [
"op",
"from",
"path"
],
"title": "Patch Copy Operation",
"type": "object"
},
"ref_df1dbb6190ccee505722": {
"properties": {
"contactId": {
"description": "Unique identifier of the contact.",
"example": 1543,
"readOnly": true,
"type": "integer"
},
"contactMethods": {
"description": "Array of polymorphic objects, which contain contact information. \n\n**Note:** If you are adding information about an owner, you must provide at least an email address. If you are adding information about a contact, you must provide at least a contact number. \n\nThe value of the type parameter determines which variant you should use: \n-\t`email` - Email address \n-\t`phone` - Phone number\n-\t`mobile` - Mobile number\n-\t`fax` - Fax number\n",
"items": {
"$ref": "#/x-devx-bundled/ref_7960ea97dd5f79b93ae4"
},
"maxItems": 4,
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"firstName": {
"description": "Contact's first name.",
"example": "Jane",
"maxLength": 50,
"type": "string"
},
"identifiers": {
"description": "Array of identifier objects.",
"example": [
{
"type": "nationalId",
"value": "000-00-4320"
}
],
"items": {
"$ref": "#/x-devx-bundled/ref_a0414249ae6629c4d288"
},
"minItems": 1,
"type": "array"
},
"lastName": {
"description": "Contact's last name.",
"example": "Doe",
"maxLength": 50,
"type": "string"
},
"middleName": {
"description": "Contact's middle name.",
"example": "Helen",
"maxLength": 50,
"type": "string"
},
"type": {
"description": "Type of contact.",
"enum": [
"manager",
"representative",
"others"
],
"example": "manager",
"type": "string"
}
},
"required": [
"type",
"firstName",
"lastName",
"contactMethods"
],
"title": "contact",
"type": "object"
},
"ref_df56a24cf3e227b81f77": {
"description": "Unique identifier that we assigned to the event subscription. \n**Note:** Our gateway returned the subscriptionId in the id field in the response of the [Create Event Subscription](https://docs.payroc.com/api/schema/notifications/event-subscriptions/create) method. \n",
"examples": {
"example": {
"value": 7654
}
},
"in": "path",
"name": "subscriptionId",
"required": true,
"schema": {
"format": "int32",
"type": "integer"
}
},
"ref_df709214365c028258ee": {
"description": "Object that contains information about the adjustment to the transaction. Send this object if the merchant is adjusting the status of the transaction.",
"properties": {
"toStatus": {
"description": "Status that you want to change the transaction to.",
"enum": [
"ready",
"pending"
],
"example": "ready",
"type": "string"
},
"type": {
"description": "Type of adjustment.",
"enum": [
"status"
],
"example": "status",
"type": "string"
}
},
"required": [
"type",
"toStatus"
],
"title": "status",
"type": "object"
},
"ref_df9a27b1eda78844a30f": {
"summary": "Funding instruction with metadata",
"value": {
"createdDate": "2024-07-02T15:30:00Z",
"instructionId": 64643131,
"lastModifiedDate": "2024-07-02T15:30:00Z",
"merchants": [
{
"link": {
"href": "https://api.payroc.com/v1/processing-accounts/4525644354",
"method": "get",
"rel": "merchant"
},
"merchantId": "4525644354",
"recipients": [
{
"amount": {
"currency": "USD",
"value": 120000
},
"fundingAccountId": 123,
"link": {
"href": "https://api.payroc.com/v1/funding-accounts/123",
"method": "get",
"rel": "fundingAccount"
},
"metadata": {
"supplier": "IT Support Services"
},
"paymentMethod": "ACH",
"status": "accepted"
}
]
}
],
"metadata": {
"instructionCreatedBy": "Jane Doe"
},
"status": "accepted"
}
},
"ref_e02b86f71136a4578d40": {
"properties": {
"midQualRate": {
"$ref": "#/x-devx-bundled/ref_01f55c7b2d1709665555",
"description": "Object that contains the fees for a mid-qualified transaction."
},
"nonQualRate": {
"$ref": "#/x-devx-bundled/ref_01f55c7b2d1709665555",
"description": "Object that contains the fees for a non-qualified transaction."
},
"qualifiedRate": {
"$ref": "#/x-devx-bundled/ref_01f55c7b2d1709665555",
"description": "Object that contains the fees for a qualified transaction."
},
"type": {
"description": "Type of American Express program.",
"enum": [
"optBlue"
],
"type": "string"
}
},
"required": [
"type",
"qualifiedRate",
"midQualRate",
"nonQualRate"
],
"title": "optBlue",
"type": "object"
},
"ref_e037dfe009fdadb64013": {
"description": "Indicates how the merchant batches their transactions.",
"properties": {
"batchCloseType": {
"description": "Indicates how the merchant batches their transactions. Send one of the following:\n - `automatic` - Terminal automatically closes the batch each day. To set the time the batch closes, send a value for the batchCloseTime parameter.\n - `manual` - Merchant manually closes their batch.\n",
"enum": [
"manual"
],
"type": "string"
}
},
"required": [
"batchCloseType"
],
"title": "manual",
"type": "object"
},
"ref_e08abee75402279abc03": {
"description": "One or more supplied national IDs are not unique. All national IDs must be unique.",
"summary": "National ID in use",
"value": {
"detail": "One or more supplied national IDs are not unique. All national IDs must be unique",
"status": 409,
"title": "National ID in use",
"type": "https://docs.payroc.com/api/errors#national-id-in-use"
}
},
"ref_e112f6279759eeb46e44": {
"description": "Object that contains information about a pricing intent.",
"oneOf": [
{
"$ref": "#/x-devx-bundled/ref_faa2548f7ff9f03457c5"
}
],
"title": "pricing intent request",
"type": "object"
},
"ref_e138b0befb3e82a5221d": {
"description": "Card Verification",
"summary": "Card Verification",
"value": {
"card": {
"cardNumber": "453985******7062",
"cardholderName": "Sarah Hazel Hopper",
"cardholderSignature": "a1b1c012345678a000b000c0012345d0e0f010g10061a031i001j071k0a1b0c1d0e1234567890120f1g0h1i0j1k0a1b0123451c012d0e1f0g1h0i1j123k1a1b1c1d1e1f1g123h1i1j1k1a1b1c1d1e1f1g123h123i1j123k12340a120a12345b012c0123012d0d1e0f1g0h1i123j123k10000",
"entryMethod": "keyed",
"expiryDate": "1230",
"type": "Visa Credit"
},
"operator": "Jane",
"processingTerminalId": "1234001",
"transactionResult": {
"processorResponseCode": "00",
"responseCode": "A",
"responseMessage": "APPROVAL",
"status": "ready"
},
"verified": true
}
},
"ref_e17edbd5866b60d4beb9": {
"content": {
"application/problem+json": {
"examples": {
"forbidden": {
"$ref": "#/x-devx-bundled/ref_07e4918a9e731c6dae85"
}
},
"schema": {
"$ref": "#/x-devx-bundled/ref_7683f58c322dd7c5757f"
}
}
},
"description": "Do not have permissions to perform this action"
},
"ref_e1da9671f0c63820f66b": {
"description": "Object that contains information about the sale and the customer's bank details.",
"properties": {
"credentialOnFile": {
"$ref": "#/x-devx-bundled/ref_ef5e9a924c7ad31c29ce"
},
"customFields": {
"description": "Array of customField objects.\n",
"items": {
"$ref": "#/x-devx-bundled/ref_91509fee696e20aa30f2"
},
"type": "array"
},
"customer": {
"$ref": "#/x-devx-bundled/ref_99ef61275025cb524caf"
},
"order": {
"$ref": "#/x-devx-bundled/ref_ca4b0a10f6e53239e9d9"
},
"paymentMethod": {
"description": "Polymorphic object that contains payment detail information. \n\nThe value of the type parameter determines which variant you should use: \n-\t`ach` - Automated Clearing House (ACH) details\n-\t`pad` - Pre-authorized debit (PAD) details\n-\t`secureToken` - Secure token details\n-\t`singleUseToken` - Single-use token details\n",
"discriminator": {
"mapping": {
"ach": "../../../common/schemas/transaction/payment-method-v1.yaml#/components/schemas/achPayload",
"pad": "../../../common/schemas/transaction/payment-method-v1.yaml#/components/schemas/padPayload",
"secureToken": "../../../common/schemas/transaction/payment-method-v1.yaml#/components/schemas/secureTokenPayload",
"singleUseToken": "../../../common/schemas/transaction/payment-method-v1.yaml#/components/schemas/singleUseTokenPayload"
},
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/x-devx-bundled/ref_c799d35ea53644eec4e6"
},
{
"$ref": "#/x-devx-bundled/ref_d8468a3993ad87f32e78"
},
{
"$ref": "#/x-devx-bundled/ref_8a84ce450c6452ba8861"
},
{
"$ref": "#/x-devx-bundled/ref_9c8bcc4b28365a7b7f70"
}
],
"type": "object"
},
"processingTerminalId": {
"description": "Unique identifier that we assigned to the terminal.",
"example": "ready",
"maxLength": 50,
"minLength": 4,
"type": "string"
}
},
"required": [
"order",
"paymentMethod",
"processingTerminalId"
],
"type": "object"
},
"ref_e1e62762b403f96522b7": {
"description": "Test operation validates that a value at the target location equals the specified value.",
"summary": "Update secure token: test",
"value": [
{
"op": "test",
"path": "/mitAgreement",
"value": "unscheduled"
}
]
},
"ref_e205c60b66e51fa053bf": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_f9d963d00740bbe00c9e"
},
{
"properties": {
"data": {
"description": "Array of refund objects.",
"items": {
"$ref": "#/x-devx-bundled/ref_0a2bb17e6e2a6ad0a66f"
},
"type": "array"
}
},
"type": "object"
}
],
"description": "Object that contains information about refund objects.",
"required": [
"count",
"data",
"hasMore",
"limit"
],
"type": "object"
},
"ref_e258178e3e59c83f2c9a": {
"description": "Return the next page of results after the value that you specify. \n\nYou can’t send the after parameter in the same request as the before parameter. \n",
"examples": {
"example": {
"value": "8516"
}
},
"in": "query",
"name": "after",
"schema": {
"type": "string"
}
},
"ref_e280ad413a994c0b7ccc": {
"description": "Object that contains information about the transaction if the merchant ran it when the terminal was offline.",
"properties": {
"approvalCode": {
"description": "Approval code for the transaction from the processor.",
"example": "OK3",
"maxLength": 48,
"minLength": 0,
"type": "string"
},
"dateTime": {
"description": "Date and time that the merchant ran the transaction. The date follows the ISO 8601 standard.",
"example": "2024-07-02T15:30:00Z",
"format": "date-time",
"type": "string"
},
"operation": {
"description": "Status of the transaction.",
"enum": [
"offlineDecline",
"offlineApproval",
"deferredAuthorization"
],
"example": "offlineApproval",
"type": "string"
}
},
"required": [
"operation"
],
"type": "object"
},
"ref_e2a430c1cc67558414bd": {
"properties": {
"batchId": {
"description": "Unique identifier that we assigned to the batch.",
"example": 123,
"type": "integer"
},
"createdDate": {
"description": "Date that we created a record for the batch. The format of this value is **YYYY-MM-DD**.",
"example": "2024-07-02",
"format": "date",
"type": "string"
},
"currency": {
"description": "Currency of the transactions in the batch. The value for the currency follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard.",
"type": "string"
},
"date": {
"description": "Date that the merchant submitted the batch. The format of this value is **YYYY-MM-DD**.",
"example": "2024-07-02",
"format": "date",
"type": "string"
},
"heldAmount": {
"description": "Total value of authorizations in the batch. We return the value in the currency's lowest denomination, for example, cents.",
"format": "int64",
"type": "integer"
},
"lastModifiedDate": {
"description": "Date that the batch was last changed. The format of this value is **YYYY-MM-DD**.",
"example": "2024-07-02",
"format": "date",
"type": "string"
},
"links": {
"example": [
{
"href": "https://api.payroc.com/v1/transactions?batchId=123",
"method": "get",
"rel": "transactions"
},
{
"href": "https://api.payroc.com/v1/authorizations?batchId=123",
"method": "get",
"rel": "authorizations"
}
],
"items": {
"$ref": "#/x-devx-bundled/ref_27e6d0e095fb23cba669"
},
"type": "array"
},
"merchant": {
"$ref": "#/x-devx-bundled/ref_67c77db80e4fded0ad81"
},
"returnAmount": {
"description": "Total value of returns in the batch. We return the value in the currency's lowest denomination, for example, cents.",
"format": "int64",
"type": "integer"
},
"saleAmount": {
"description": "Total value of sales in the batch. We return the value in the currency's lowest denomination, for example, cents.",
"format": "int64",
"type": "integer"
},
"transactionCount": {
"description": "Total number of transactions in the batch.",
"format": "int64",
"type": "integer"
}
},
"title": "batch",
"type": "object"
},
"ref_e33323df86082a426f50": {
"description": "Roc Giving Addendum for merchants that use Roc Giving.",
"properties": {
"accountAdminContact": {
"additionalProperties": false,
"description": "Object that contains contact details for the Roc Giving account administrator.",
"properties": {
"emailAddress": {
"description": "Email address of the Roc Giving account administrator.",
"example": "jane.doe@example.com",
"maxLength": 50,
"type": "string"
},
"firstName": {
"description": "First name of the Roc Giving account administrator.",
"example": "Jane",
"maxLength": 50,
"type": "string"
},
"lastName": {
"description": "Last name of the Roc Giving account administrator.",
"example": "Doe",
"maxLength": 50,
"type": "string"
},
"phone": {
"description": "Phone number of the Roc Giving account administrator.",
"example": "2025550164",
"maxLength": 15,
"type": "string"
}
},
"required": [
"firstName",
"lastName",
"emailAddress"
],
"type": "object"
},
"autoCloseTime": {
"description": "Time that the processing terminal closes the batch in **HH:mm** format using the 24-hour clock.",
"example": "23:40",
"maxLength": 5,
"type": "string"
},
"donorSupportPercentage": {
"description": "Percentage of the total donation amount that a donor can add to their donation to provide additional support to the organization.",
"examples": [
2.5,
3,
3.75
],
"maximum": 100,
"minimum": 0,
"type": "number"
},
"plan": {
"default": "basic",
"description": "Roc Giving pricing plan for the processing account. The value is one of the following: \n - `basic` - Merchant has access to the features available with the basic Roc Giving plan.\n - `advanced` - Merchant has access to the additional features available with the advanced Roc Giving plan.\n",
"enum": [
"basic",
"advanced"
],
"example": "basic",
"type": "string"
},
"type": {
"const": "rocGivingV1",
"type": "string"
}
},
"required": [
"type",
"accountAdminContact",
"autoCloseTime",
"donorSupportPercentage"
],
"type": "object"
},
"ref_e34ba36a4bdd6667f439": {
"description": "Reversal Payment",
"summary": "Reversal Payment",
"value": {
"card": {
"cardNumber": "453985******7062",
"entryMethod": "keyed",
"expiryDate": "1230",
"securityChecks": {
"avsResult": "Y",
"cvvResult": "M"
},
"type": "MasterCard"
},
"customFields": [
{
"name": "yourCustomField",
"value": "abc123"
}
],
"customer": {
"billingAddress": {
"address1": "1 Example Ave.",
"address2": "Example Address Line 2",
"address3": "Example Address Line 3",
"city": "Chicago",
"country": "US",
"postalCode": "60056",
"state": "Illinois"
},
"firstName": "Sarah",
"lastName": "Hopper",
"shippingAddress": {
"address": {
"address1": "1 Example Ave.",
"address2": "Example Address Line 2",
"address3": "Example Address Line 3",
"city": "Chicago",
"country": "IT",
"postalCode": "60056",
"state": "Illinois"
},
"recipientName": "Sarah Hopper"
}
},
"order": {
"amount": 4999,
"currency": "USD",
"dateTime": "2024-07-02T15:30:00Z",
"description": "Large Pepperoni Pizza",
"orderId": "OrderRef6543"
},
"paymentId": "M2MJOG6O2Y",
"processingTerminalId": "1234001",
"supportedOperations": [
"capture",
"fullyReverse",
"partiallyReverse",
"incrementAuthorization",
"adjustTip",
"setAsPending"
],
"transactionResult": {
"approvalCode": "OK2",
"authorizedAmount": 100,
"currency": "USD",
"responseCode": "A",
"responseMessage": "OK2",
"status": "reversal",
"type": "sale"
}
}
},
"ref_e34fb71792f1a2594c56": {
"description": "Create a merchant platform.",
"summary": "Create merchant platform",
"value": {
"business": {
"addresses": [
{
"address1": "1 Example Ave.",
"address2": "Example Address Line 2",
"address3": "Example Address Line 3",
"city": "Chicago",
"country": "US",
"postalCode": "60056",
"state": "Illinois",
"type": "legalAddress"
}
],
"contactMethods": [
{
"type": "email",
"value": "jane.doe@example.com"
}
],
"countryOfOperation": "US",
"name": "Example Corp",
"organizationType": "privateCorporation",
"taxId": "12-3456789"
},
"metadata": {
"customerId": "2345"
},
"processingAccounts": [
{
"address": {
"address1": "1 Example Ave.",
"address2": "Example Address Line 2",
"address3": "Example Address Line 3",
"city": "Chicago",
"country": "US",
"postalCode": "60056",
"state": "Illinois"
},
"businessStartDate": "2020-01-01",
"businessType": "restaurant",
"categoryCode": 5999,
"contactMethods": [
{
"type": "email",
"value": "jane.doe@example.com"
}
],
"contacts": [
{
"contactMethods": [
{
"type": "email",
"value": "jane.doe@example.com"
}
],
"firstName": "Jane",
"identifiers": [
{
"type": "nationalId",
"value": "000-00-4320"
}
],
"lastName": "Doe",
"middleName": "Helen",
"type": "manager"
}
],
"doingBusinessAs": "Pizza Doe",
"funding": {
"acceleratedFundingFee": 1999,
"dailyDiscount": false,
"fundingAccounts": [
{
"metadata": {
"yourCustomField": "abc123"
},
"nameOnAccount": "Jane Doe",
"paymentMethods": [
{
"type": "ach",
"value": {
"accountNumber": "1234567890",
"routingNumber": "123456789"
}
}
],
"type": "checking",
"use": "creditAndDebit"
}
],
"fundingSchedule": "nextday"
},
"merchandiseOrServiceSold": "Pizza",
"metadata": {
"customerId": "2345"
},
"owners": [
{
"address": {
"address1": "1 Example Ave.",
"address2": "Example Address Line 2",
"address3": "Example Address Line 3",
"city": "Chicago",
"country": "US",
"postalCode": "60056",
"state": "Illinois"
},
"contactMethods": [
{
"type": "email",
"value": "jane.doe@example.com"
}
],
"dateOfBirth": "1964-03-22",
"firstName": "Jane",
"identifiers": [
{
"type": "nationalId",
"value": "000-00-4320"
}
],
"lastName": "Doe",
"middleName": "Helen",
"relationship": {
"equityPercentage": 48.5,
"isAuthorizedSignatory": false,
"isControlProng": true,
"title": "CFO"
}
}
],
"pricing": {
"pricingIntentId": "6123",
"type": "intent"
},
"processing": {
"ach": {
"estimatedMonthlyTransactions": 3000,
"limits": {
"dailyDeposit": 200000,
"monthlyDeposit": 6000000,
"singleTransaction": 10000
},
"naics": "5812",
"previouslyTerminatedForAch": false,
"refunds": {
"refundPolicyUrl": "http://www.example.com/refunds",
"writtenRefundPolicy": true
},
"transactionTypes": [
"prearrangedPayment",
"other"
],
"transactionTypesOther": "recurringBilling"
},
"cardAcceptance": {
"cardsAccepted": [
"visa",
"mastercard"
],
"debitOnly": false,
"hsaFsa": false,
"specialityCards": {
"americanExpressDirect": {
"enabled": true,
"merchantNumber": "abc1234567"
},
"electronicBenefitsTransfer": {
"enabled": true,
"fnsNumber": "6789012"
},
"other": {
"fleetMerchantId": "abc1234567",
"voyagerMerchantId": "abc1234567",
"wexMerchantNumber": "abc1234567"
}
}
},
"isSeasonal": true,
"monthlyAmounts": {
"average": 50000,
"highest": 100000
},
"monthsOfOperation": [
"jan",
"feb"
],
"transactionAmounts": {
"average": 5000,
"highest": 10000
},
"volumeBreakdown": {
"cardPresent": 77,
"ecommerce": 20,
"mailOrTelephone": 3
}
},
"processor": "tsys",
"signature": {
"type": "requestedViaDirectLink"
},
"timezone": "America/Chicago",
"website": "www.example.com"
}
]
}
},
"ref_e3c7678fac680cc8015b": {
"description": "Unique identifier of the authorization.",
"examples": {
"example": {
"value": 12345
}
},
"in": "path",
"name": "authorizationId",
"required": true,
"schema": {
"type": "integer"
}
},
"ref_e40902e1b8cdc2f5d9d0": {
"description": "Subscription after we copied the name into the description.",
"summary": "Update subscription: copy",
"value": {
"currency": "USD",
"currentState": {
"nextDueDate": "2024-08-02",
"outstandingInvoices": 3,
"paidInvoices": 0,
"status": "active"
},
"customFields": [
{
"name": "yourCustomField",
"value": "abc123"
}
],
"description": "Premium Club",
"endDate": "2025-07-01",
"frequency": "monthly",
"length": 12,
"name": "Premium Club",
"pauseCollectionFor": 0,
"paymentPlan": {
"link": {
"href": "https://api.payroc.com/v1/processing-terminals/1234001/payment-plans/PlanRef8765",
"method": "GET",
"rel": "self"
},
"name": "Monthly Premium Club subscription",
"paymentPlanId": "PlanRef8765"
},
"processingTerminalId": "1234001",
"recurringOrder": {
"amount": 4999,
"breakdown": {
"subtotal": 4347,
"surcharge": {
"amount": 217,
"percentage": 5
},
"taxes": [
{
"name": "Sales Tax",
"rate": 5
}
]
},
"description": "Premium Club subscription"
},
"secureToken": {
"customerName": "Sarah Hazel Hopper",
"link": {
"href": "https://api.payroc.com/v1/processing-terminals/1234001/secure-tokens/MREF_abc1de23-f4a5-6789-bcd0-12e345678901fa",
"method": "GET",
"rel": "self"
},
"secureTokenId": "MREF_abc1de23-f4a5-6789-bcd0-12e345678901fa",
"status": "notValidated",
"token": "296753123456"
},
"setupOrder": {
"amount": 4999,
"breakdown": {
"subtotal": 4347,
"surcharge": {
"amount": 217,
"percentage": 5
},
"taxes": [
{
"name": "Sales Tax",
"rate": 5
}
]
},
"description": "Initial setup fee for Premium Club subscription",
"orderId": "OrderRef6543"
},
"startDate": "2024-07-02",
"subscriptionId": "SubRef7654",
"type": "automatic"
}
},
"ref_e41a722a917310618c88": {
"summary": "Paginated batches",
"value": {
"count": 2,
"data": [
{
"batchId": 65,
"createdDate": "2024-07-02",
"currency": "USD",
"date": "2024-07-02",
"heldAmount": 0,
"lastModifiedDate": "2024-07-02",
"links": [
{
"href": "https://api.payroc.com/v1/transactions?batchId=65",
"method": "get",
"rel": "transactions"
},
{
"href": "https://api.payroc.com/v1/authorizations?batchId=65",
"method": "get",
"rel": "authorizations"
}
],
"merchant": {
"doingBusinessAs": "Pizza Doe",
"link": {
"href": "https://api.payroc.com/v1/processing-accounts/38765",
"method": "get",
"rel": "processingAccount"
},
"merchantId": "4525644354",
"processingAccountId": 38765
},
"returnAmount": 0,
"saleAmount": 100,
"transactionCount": 10
},
{
"batchId": 66,
"createdDate": "2024-07-02",
"currency": "USD",
"date": "2024-07-02",
"heldAmount": 0,
"lastModifiedDate": "2024-07-02",
"links": [
{
"href": "https://api.payroc.com/v1/transactions?batchId=66",
"method": "get",
"rel": "transactions"
},
{
"href": "https://api.payroc.com/v1/authorizations?batchId=66",
"method": "get",
"rel": "authorizations"
}
],
"merchant": {
"doingBusinessAs": "Joe Bloggs Shoes",
"link": {
"href": "https://api.payroc.com/v1/processing-accounts/68437",
"method": "get",
"rel": "processingAccount"
},
"merchantId": "9876543219",
"processingAccountId": 68437
},
"returnAmount": 12,
"saleAmount": 76,
"transactionCount": 10
}
],
"hasMore": true,
"limit": 2,
"links": [
{
"href": "https://api.payroc.com/v1/batches?before=65&limit=2&date=2024-07-02",
"method": "get",
"rel": "previous"
},
{
"href": "https://api.payroc.com/v1/batches?after=66&limit=2&date=2024-07-02",
"method": "get",
"rel": "next"
}
]
}
},
"ref_e459d08e6c292e0fc1b5": {
"description": "Payment plan after we copied the name into the description.",
"summary": "Update payment plan: copy",
"value": {
"currency": "USD",
"customFieldNames": [
"yourCustomField"
],
"description": "Premium Club",
"frequency": "monthly",
"length": 12,
"name": "Premium Club",
"onDelete": "complete",
"onUpdate": "continue",
"paymentPlanId": "PlanRef8765",
"processingTerminalId": "1234001",
"recurringOrder": {
"amount": 4999,
"breakdown": {
"subtotal": 4347,
"taxes": [
{
"name": "Sales Tax",
"rate": 5
}
]
},
"description": "Monthly Premium Club subscription"
},
"setupOrder": {
"amount": 4999,
"breakdown": {
"subtotal": 4347,
"taxes": [
{
"name": "Sales Tax",
"rate": 5
}
]
},
"description": "Initial setup fee for Premium Club subscription"
},
"type": "automatic"
}
},
"ref_e4a086f8d857fd3e3dd3": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_c89b6b2eea24e2c0a863"
},
{
"properties": {
"voucher": {
"$ref": "#/x-devx-bundled/ref_f54924324f303544eab2"
}
},
"type": "object"
}
],
"description": "Object that contains information about the Electronic Benefit Transfer (EBT) transaction.",
"required": [
"benefitCategory"
],
"type": "object"
},
"ref_e51c40a52ecb254b0a94": {
"description": "Create a merchant platform with addendums appended to the Merchant Processing Agreement.",
"summary": "Create merchant platform with addendums",
"value": {
"business": {
"addresses": [
{
"address1": "1 Example Ave.",
"address2": "Example Address Line 2",
"address3": "Example Address Line 3",
"city": "Chicago",
"country": "US",
"postalCode": "60056",
"state": "Illinois",
"type": "legalAddress"
}
],
"contactMethods": [
{
"type": "email",
"value": "jane.doe@example.com"
}
],
"countryOfOperation": "US",
"name": "Example Corp",
"organizationType": "privateCorporation",
"taxId": "12-3456789"
},
"metadata": {
"customerId": "2345"
},
"processingAccounts": [
{
"addendums": [
{
"type": "telehealthV1"
},
{
"type": "firearmsV1"
}
],
"address": {
"address1": "1 Example Ave.",
"address2": "Example Address Line 2",
"address3": "Example Address Line 3",
"city": "Chicago",
"country": "US",
"postalCode": "60056",
"state": "Illinois"
},
"businessStartDate": "2020-01-01",
"businessType": "restaurant",
"categoryCode": 5999,
"contactMethods": [
{
"type": "email",
"value": "jane.doe@example.com"
}
],
"doingBusinessAs": "Pizza Doe",
"funding": {
"acceleratedFundingFee": 1999,
"dailyDiscount": false,
"fundingAccounts": [
{
"metadata": {
"yourCustomField": "abc123"
},
"nameOnAccount": "Jane Doe",
"paymentMethods": [
{
"type": "ach",
"value": {
"accountNumber": "1234567890",
"routingNumber": "123456789"
}
}
],
"type": "checking",
"use": "creditAndDebit"
}
],
"fundingSchedule": "nextday"
},
"merchandiseOrServiceSold": "Pizza",
"metadata": {
"customerId": "2345"
},
"owners": [
{
"address": {
"address1": "1 Example Ave.",
"address2": "Example Address Line 2",
"address3": "Example Address Line 3",
"city": "Chicago",
"country": "US",
"postalCode": "60056",
"state": "Illinois"
},
"contactMethods": [
{
"type": "email",
"value": "jane.doe@example.com"
}
],
"dateOfBirth": "1964-03-22",
"firstName": "Jane",
"identifiers": [
{
"type": "nationalId",
"value": "000-00-4320"
}
],
"lastName": "Doe",
"middleName": "Helen",
"relationship": {
"equityPercentage": 48.5,
"isAuthorizedSignatory": false,
"isControlProng": true,
"title": "CFO"
}
}
],
"pricing": {
"pricingIntentId": "6123",
"type": "intent"
},
"processing": {
"monthlyAmounts": {
"average": 50000,
"highest": 100000
},
"transactionAmounts": {
"average": 5000,
"highest": 10000
},
"volumeBreakdown": {
"cardPresent": 77,
"ecommerce": 20,
"mailOrTelephone": 3
}
},
"processor": "tsys",
"signature": {
"type": "requestedViaDirectLink"
},
"timezone": "America/Chicago",
"website": "www.example.com"
}
]
}
},
"ref_e580435fb1ef2622b396": {
"properties": {
"type": {
"description": "Payment method that we use to send funds to the account.",
"enum": [
"ach"
],
"type": "string"
},
"value": {
"description": "Object that contains information about the funding account.",
"properties": {
"accountNumber": {
"description": "Account number of the funding account.",
"example": "1234567890",
"maxLength": 12,
"minLength": 9,
"type": "string"
},
"routingNumber": {
"description": "Routing number of the funding account.",
"example": "123456789",
"maxLength": 9,
"minLength": 9,
"type": "string"
}
},
"required": [
"accountNumber",
"routingNumber"
],
"type": "object"
}
},
"title": "ACH payment method",
"type": "object"
},
"ref_e599f09b65108c7f9eb1": {
"description": "Submit an instruction for initiating a payment on a physical device with MiFare closed-loop options.",
"summary": "Payment Instruction with MiFare closed-loop options",
"value": {
"customizationOptions": {
"closedLoopOptions": {
"type": "mifare"
}
},
"operator": "Jane",
"order": {
"amount": 4999,
"currency": "USD",
"orderId": "OrderRef6543"
},
"processingTerminalId": "1234001"
}
},
"ref_e5ac528592a678296a44": {
"description": "Object that contains information about the progress of the payment instruction for a MiFare card.",
"summary": "Payment Instruction with MiFare closed-loop options",
"value": {
"link": {
"href": "https://api.payroc.com/v1/payment-instructions/a37439165d134678a9100ebba3b29597",
"method": "GET",
"rel": "self"
},
"paymentInstructionId": "a37439165d134678a9100ebba3b29597",
"status": "inProgress"
}
},
"ref_e682501abdc2c1d6f4e2": {
"description": "Processing account that we created.",
"summary": "Create processing account",
"value": {
"addendums": [],
"address": {
"address1": "1 Example Ave.",
"address2": "Example Address Line 2",
"address3": "Example Address Line 3",
"city": "Chicago",
"country": "US",
"postalCode": "60056",
"state": "Illinois"
},
"businessStartDate": "2020-01-01",
"businessType": "restaurant",
"categoryCode": 5999,
"contactMethods": [
{
"type": "email",
"value": "jane.doe@example.com"
}
],
"contacts": [
{
"contactId": 1543,
"firstName": "Jane",
"lastName": "Doe",
"link": {
"href": "https://api.payroc.com/v1/contacts/1543",
"method": "get",
"rel": "contact"
}
}
],
"createdDate": "2024-07-02T12:00:00.000+00:00",
"doingBusinessAs": "Pizza Doe",
"funding": {
"acceleratedFundingFee": 1999,
"dailyDiscount": false,
"fundingAccounts": [
{
"fundingAccountId": 123,
"link": {
"href": "https://api.payroc.com/v1/funding-accounts/123",
"method": "get",
"rel": "fundingAccount"
},
"status": "pending"
}
],
"fundingSchedule": "nextday",
"status": "enabled"
},
"lastModifiedDate": "2024-07-02T12:00:00.000+00:00",
"merchandiseOrServiceSold": "Pizza",
"metadata": {
"customerId": "2345"
},
"owners": [
{
"firstName": "Jane",
"lastName": "Doe",
"link": {
"href": "https://api.payroc.com/v1/owners/4564",
"method": "get",
"rel": "owner"
},
"ownerId": 4564
}
],
"pricing": {
"link": {
"href": "https://api.payroc.com/v1/processing-accounts/12345/pricing",
"method": "get",
"rel": "pricing"
}
},
"processing": {
"ach": {
"estimatedMonthlyTransactions": 3000,
"limits": {
"dailyDeposit": 200000,
"monthlyDeposit": 6000000,
"singleTransaction": 10000
},
"naics": "5812",
"previouslyTerminatedForAch": false,
"refunds": {
"refundPolicyUrl": "http://www.example.com/refunds",
"writtenRefundPolicy": true
},
"transactionTypes": [
"prearrangedPayment",
"other"
],
"transactionTypesOther": "recurringBilling"
},
"cardAcceptance": {
"cardsAccepted": [
"visa",
"mastercard"
],
"debitOnly": false,
"hsaFsa": false,
"specialityCards": {
"americanExpressDirect": {
"enabled": true,
"merchantNumber": "abc1234567"
},
"electronicBenefitsTransfer": {
"enabled": true,
"fnsNumber": "6789012"
},
"other": {
"fleetMerchantId": "abc1234567",
"voyagerMerchantId": "abc1234567",
"wexMerchantNumber": "abc1234567"
}
}
},
"isSeasonal": true,
"monthlyAmounts": {
"average": 50000,
"highest": 100000
},
"monthsOfOperation": [
"jan",
"feb"
],
"transactionAmounts": {
"average": 5000,
"highest": 10000
},
"volumeBreakdown": {
"cardPresent": 77,
"ecommerce": 20,
"mailOrTelephone": 3
}
},
"processingAccountId": "38765",
"processor": "tsys",
"signature": {
"link": {
"href": "https://us.agreementexpress.net/mv2/viewer2.jsp?docId=00000000-0000-0000-0000-000000000000",
"method": "get",
"rel": "agreement"
},
"type": "requestedViaDirectLink"
},
"status": "entered",
"timezone": "America/Chicago",
"website": "www.example.com"
}
},
"ref_e749498bd04d8b0b6e15": {
"description": "BIN lookup",
"summary": "BIN lookup",
"value": {
"cardNumber": "453985******7062",
"country": "US",
"currency": "USD",
"debit": false,
"healthcare": false,
"type": "Visa Credit"
}
},
"ref_e755fa4f263b012bbbe7": {
"description": "Object that contains the customer's account details.",
"properties": {
"accountNumber": {
"description": "Customer's bank account number. We mask all digits except the last four digits.",
"example": "123456789",
"maxLength": 17,
"minLength": 4,
"type": "string"
},
"nameOnAccount": {
"description": "Customer's name.",
"example": "Sarah Hazel Hopper",
"maxLength": 50,
"minLength": 1,
"type": "string"
},
"routingNumber": {
"description": "Routing number of the customer’s account.\n\n**Note:** In responses, our gateway shows only the last four digits of the account's routing number, for example, *****4162. \n",
"example": "123456789",
"maxLength": 9,
"minLength": 9,
"type": "string"
},
"secCode": {
"description": "Indicates the type of authorization for the transaction. \n\n**Note:** The field is mandatory for ACH secure token. \n\n- `web` – Online transaction. \n- `tel` – Telephone transaction. \n- `ccd` – Corporate credit or debit entry for a business bank account.\n- `ppd` – Pre-arranged transaction.\n",
"enum": [
"web",
"tel",
"ccd",
"ppd"
],
"example": "web",
"type": "string"
},
"secureToken": {
"$ref": "#/x-devx-bundled/ref_0af00846def2cd349cd2"
},
"type": {
"enum": [
"ach"
],
"example": "ach",
"type": "string"
}
},
"required": [
"accountNumber",
"nameOnAccount",
"routingNumber",
"type"
],
"title": "ach",
"type": "object"
},
"ref_e760e7fd6ad0cb29adc8": {
"description": "Update a specific contact.",
"summary": "Update contact",
"value": {
"contactMethods": [
{
"type": "email",
"value": "jane.doe@example.com"
}
],
"firstName": "Jane",
"identifiers": [
{
"type": "nationalId",
"value": "000-00-4320"
}
],
"lastName": "Doe",
"middleName": "Helen",
"type": "manager"
}
},
"ref_e7cf09f3bd34113e7f73": {
"description": "One or more validation errors occurred",
"summary": "Bad Request",
"value": {
"detail": "One or more validation errors occurred, see error section for more info",
"errors": [
{
"detail": "invalid value",
"message": "Expected integer, got abc",
"parameter": "transactionId"
}
],
"status": 400,
"title": "Bad request",
"type": "https://docs.payroc.com/api/errors#bad-request"
}
},
"ref_e97be8a248c59d0c9e2c": {
"properties": {
"midQualRate": {
"$ref": "#/x-devx-bundled/ref_01f55c7b2d1709665555",
"description": "Object that contains the fees for a mid-qualified transaction."
},
"nonQualRate": {
"$ref": "#/x-devx-bundled/ref_01f55c7b2d1709665555",
"description": "Object that contains the fees for a non-qualified transaction."
},
"qualifiedRate": {
"$ref": "#/x-devx-bundled/ref_01f55c7b2d1709665555",
"description": "Object that contains the fees for a qualified transaction."
},
"type": {
"description": "Type of American Express program.",
"enum": [
"optBlue"
],
"type": "string"
}
},
"required": [
"type",
"qualifiedRate",
"midQualRate",
"nonQualRate"
],
"title": "optBlue",
"type": "object"
},
"ref_ea0faadf7c30078734c1": {
"description": "Object that contains information about the first payment.",
"properties": {
"cardSchemeReferenceId": {
"description": "Identifier that the card brand assigned to the first payment.",
"example": "ABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890",
"maxLength": 64,
"minLength": 1,
"type": "string"
},
"paymentId": {
"description": "Unique identifier of the first payment. \n**Note:** We recommend that you always send a value for the **paymentId** parameter.\n",
"example": "M2MJOG6O2Y",
"maxLength": 10,
"minLength": 10,
"type": "string"
}
},
"type": "object"
},
"ref_ea51a751962ec64b8d86": {
"description": "Secure token is unchanged because the test operation only asserts that a value matches.",
"summary": "Update secure token: test",
"value": {
"customFields": [
{
"name": "yourCustomField",
"value": "abc123"
}
],
"customer": {
"billingAddress": {
"address1": "1 Example Ave.",
"address2": "Example Address Line 2",
"address3": "Example Address Line 3",
"city": "Chicago",
"country": "US",
"postalCode": "60056",
"state": "Illinois"
},
"contactMethods": [
{
"type": "email",
"value": "sarah.hopper@example.com"
}
],
"dateOfBirth": "1990-07-15",
"firstName": "Sarah",
"lastName": "Hopper",
"notificationLanguage": "en",
"referenceNumber": "Customer-12",
"shippingAddress": {
"address": {
"address1": "1 Example Ave.",
"address2": "Example Address Line 2",
"address3": "Example Address Line 3",
"city": "Chicago",
"country": "US",
"postalCode": "60056",
"state": "Illinois"
},
"recipientName": "Sarah Hopper"
}
},
"mitAgreement": "unscheduled",
"processingTerminalId": "1234001",
"secureTokenId": "MREF_abc1de23-f4a5-6789-bcd0-12e345678901fa",
"source": {
"cardNumber": "453985******7062",
"cardholderName": "Sarah Hazel Hopper",
"expiryDate": "1230",
"type": "card"
},
"status": "notValidated",
"token": "296753123456"
}
},
"ref_ea59515d841f46f0d0e1": {
"description": "Filter results by the unique identifier that the processor assigned to the merchant.",
"examples": {
"example": {
"value": "4525644354"
}
},
"in": "query",
"name": "merchantId",
"schema": {
"type": "string"
}
},
"ref_eac6050eb1e4dbb01198": {
"allOf": [
{
"description": "Polymorphic object that contains pricing agreement information for the processing account.",
"properties": {
"type": {
"enum": [
"agreement"
],
"example": "agreement",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"oneOf": [
{
"$ref": "#/x-devx-bundled/ref_2334f7c0d1cd64614f53"
}
]
}
],
"title": "agreement",
"type": "object"
},
"ref_eadb292c05306fab39ef": {
"description": "The request contains duplicate addendum type values.",
"summary": "Duplicate addendum type",
"value": {
"detail": "Your request must not contain duplicate addendum types.",
"errors": [
{
"detail": "Duplicate addendum type.",
"message": "You can add each addendum type only once.",
"parameter": "processingAccounts[0].addendums[1].type"
}
],
"status": 400,
"title": "One or more validation errors occurred.",
"type": "https://docs.payroc.com/api/errors#bad-request"
}
},
"ref_eaf5d3470b5ee12b1835": {
"description": "Bank Transfer Payment that was declined with return information",
"summary": "Declined Payment",
"value": {
"bankAccount": {
"accountNumber": "****1591",
"nameOnAccount": "Sarah Hazel Hopper",
"routingNumber": "053200983",
"secCode": "web",
"type": "ach"
},
"customer": {
"contactMethods": [
{
"type": "email",
"value": "sarah.hopper@example.com"
}
],
"notificationLanguage": "en"
},
"order": {
"amount": 4999,
"breakdown": {
"subtotal": 4347,
"taxes": [
{
"amount": 217,
"name": "Sales Tax",
"rate": 5
}
],
"tip": {
"amount": 435,
"percentage": 10,
"type": "percentage"
}
},
"currency": "USD",
"dateTime": "2024-07-02T15:30:00Z",
"description": "Large Pepperoni Pizza",
"orderId": "OrderRef7654"
},
"paymentId": "E29U8OU8Q4",
"processingTerminalId": "1234001",
"returns": [
{
"closed": false,
"date": "2024-07-02",
"link": {
"href": "https://api.payroc.com/v1/bank-transfer-payments/M2MJOG6O2Y",
"method": "GET",
"rel": "self"
},
"paymentId": "M2MJOG6O2Y",
"represented": false,
"returnCode": "R11",
"returnReason": "Customer advises not authorized"
}
],
"transactionResult": {
"authorizedAmount": 4999,
"currency": "USD",
"processorResponseCode": "R11",
"responseCode": "D",
"responseMessage": "Payment Declined",
"status": "declined",
"type": "payment"
}
}
},
"ref_eb108d9094d050e3a00c": {
"description": "Object that contains information about who pays for the terminal order and how they are paying for it.",
"properties": {
"link": {
"description": "Array of useful links related to your request.",
"example": {
"href": "https://api.payroc.com/v1/payment-intents/1542",
"method": "GET",
"rel": "self"
},
"properties": {
"href": {
"description": "The URL.",
"type": "string"
},
"method": {
"description": "The REST method.",
"type": "string"
},
"rel": {
"description": "The link type.",
"type": "string"
}
},
"required": [
"href",
"rel",
"method"
],
"type": "object"
},
"paymentIntentId": {
"description": "Unique identifier that we assigned to the payment intent.",
"example": "1542",
"type": "string"
},
"paymentIntentType": {
"description": "Type of payment intent.",
"enum": [
"purchase",
"free",
"loan"
],
"example": "purchase",
"type": "string"
}
},
"required": [
"paymentIntentId",
"paymentIntentType",
"link"
],
"type": "object"
},
"ref_eb26de9bfde8d7a22231": {
"description": "Object that contains information about the gateway fees for MPA 5.2.",
"properties": {
"fees": {
"description": "Object that contains information about the gateway fees.",
"properties": {
"3dSecurePerTransaction": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_109fe7e5f018de7ee04b"
}
],
"description": "Fee for each transaction which utilizes 3D Secure. The value is in the currency's lowest denomination, for example, cents."
},
"monthly": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_109fe7e5f018de7ee04b"
}
],
"description": "Monthly fee for the gateway. The value is in the currency's lowest denomination, for example, cents."
},
"perDeviceMonthly": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_109fe7e5f018de7ee04b"
}
],
"description": "Monthly fee for each device. The value is in the currency's lowest denomination, for example, cents."
},
"perTransaction": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_109fe7e5f018de7ee04b"
}
],
"description": "Fee for each transaction. The value is in the currency's lowest denomination, for example, cents."
},
"setup": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_109fe7e5f018de7ee04b"
}
],
"description": "Fee for setting up your account with the gateway. The value is in the currency's lowest denomination, for example, cents."
},
"tapToPayPerTransaction": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_109fe7e5f018de7ee04b"
}
],
"description": "Fee for each tap to pay transaction. The value is in the currency's lowest denomination, for example, cents."
}
},
"required": [
"monthly",
"setup",
"perTransaction",
"perDeviceMonthly"
],
"type": "object"
}
},
"required": [
"fees"
],
"title": "gateway fees",
"type": "object"
},
"ref_eb4bec06b486e2ceb76c": {
"description": "Return the previous page of results before the value that you specify. \n\nYou can’t send the before parameter in the same request as the after parameter. \n",
"examples": {
"example": {
"value": "2571"
}
},
"in": "query",
"name": "before",
"schema": {
"type": "string"
}
},
"ref_eb6353451b063de00d76": {
"description": "Object that contains information about the pricing agreement reminder.",
"properties": {
"reminderId": {
"description": "Unique ID of the reminder.",
"example": "1234567",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Type of reminder.",
"enum": [
"pricingAgreement"
],
"example": "pricingAgreement",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"ref_eb68f2c28371d61b1260": {
"properties": {
"midQualRate": {
"$ref": "#/x-devx-bundled/ref_01f55c7b2d1709665555",
"description": "Object that contains the fees for a mid-qualified transaction."
},
"nonQualRate": {
"$ref": "#/x-devx-bundled/ref_01f55c7b2d1709665555",
"description": "Object that contains the fees for a non-qualified transaction."
},
"qualifiedRate": {
"$ref": "#/x-devx-bundled/ref_01f55c7b2d1709665555",
"description": "Object that contains the fees for a qualified transaction."
}
},
"required": [
"qualifiedRate",
"midQualRate",
"nonQualRate"
],
"type": "object"
},
"ref_eb7d7cab924d0e73a344": {
"description": "Share a payment link.",
"summary": "Share a payment link",
"value": {
"merchantCopy": true,
"message": "Dear Sarah,\n\nYour insurance is expiring this month.\nPlease, pay the renewal fee by the end of the month to renew it.\n",
"recipients": [
{
"email": "sarah.hopper@example.com",
"name": "Sarah Hazel Hopper"
}
],
"sharingMethod": "email"
}
},
"ref_eb84992a3f298576baf5": {
"description": "Partially update an existing event subscription.\n\nStructure your request to follow the RFC 6902 standard.\n",
"summary": "Partially update event subscription",
"value": [
{
"op": "replace",
"path": "/enabled",
"value": false
}
]
},
"ref_ec10c8ff2f2642ded7ca": {
"description": "Object that contains information about the cost of each payment. \n**Note:** Send this object only if the value for **type** is `automatic`.\n",
"properties": {
"amount": {
"description": "Total amount before surcharges. The value is in the currency's lowest denomination, for example, cents.",
"example": 4999,
"format": "int64",
"type": "integer"
},
"description": {
"description": "Description of the transaction.",
"example": "Monthly Premium Club subscription",
"maxLength": 1024,
"minLength": 1,
"type": "string"
}
},
"type": "object"
},
"ref_ec2b9fff1c2a6e488cf9": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_3147c722e948ca9d06ad"
},
{
"properties": {
"acceptPartialAmount": {
"default": false,
"description": "Indicates if the merchant accepts a partial authorization for this transaction.\n\n- `true` — If the issuer cannot approve the full amount, the gateway accepts a partial\n authorization and returns the approved amount. The integrator is responsible for\n collecting the remaining balance via a follow-up payment.\n- `false` — Standard authorization behavior. If the issuer cannot approve the full\n amount, the transaction is declined.\n\n**Note:** When this field is omitted, the default is `false` and standard authorization behavior applies.\n",
"example": true,
"type": "boolean"
},
"breakdown": {
"$ref": "#/x-devx-bundled/ref_bd43970a1ae1b1eb0c0f"
}
},
"type": "object"
}
],
"description": "Object that contains information about the payment.",
"required": [
"amount",
"currency",
"orderId"
],
"type": "object"
},
"ref_ec3e38e8e442656fe694": {
"description": "Object that contains information about the address.",
"properties": {
"address1": {
"description": "Address line 1.",
"example": "1 Example Ave.",
"maxLength": 150,
"type": "string"
},
"address2": {
"description": "Address line 2.",
"example": "Example Address Line 2",
"maxLength": 150,
"type": "string"
},
"address3": {
"description": "Address line 3.",
"example": "Example Address Line 3",
"maxLength": 150,
"type": "string"
},
"city": {
"description": "City.",
"example": "Chicago",
"maxLength": 50,
"type": "string"
},
"country": {
"description": "Two-digit country code for the country that the business operates in. The format follows the [ISO-3166-1](https://www.iso.org/iso-3166-country-codes.html) standard.",
"example": "US",
"maxLength": 2,
"minLength": 2,
"type": "string"
},
"postalCode": {
"description": "Zip code or postal code.",
"example": "60056",
"maxLength": 10,
"type": "string"
},
"state": {
"description": "Name of the state or state abbreviation.",
"example": "Illinois",
"maxLength": 50,
"type": "string"
}
},
"title": "address",
"type": "object"
},
"ref_eca55e69eabf5f90e327": {
"description": "Unique identifier that our gateway assigned to the signature instruction.",
"examples": {
"example": {
"value": "a37439165d134678a9100ebba3b29597"
}
},
"in": "path",
"name": "signatureInstructionId",
"required": true,
"schema": {
"maxLength": 36,
"minLength": 1,
"type": "string"
}
},
"ref_ecf2f0f7e7e376484555": {
"description": "Unique identifier that our gateway assigned to the payment.",
"examples": {
"example": {
"value": "M2MJOG6O2Y"
}
},
"in": "path",
"name": "paymentId",
"required": true,
"schema": {
"maxLength": 10,
"minLength": 10,
"type": "string"
}
},
"ref_ed5b576489ee24a9c772": {
"description": "Polymorphic object that contains pricing intent information.",
"oneOf": [
{
"$ref": "#/x-devx-bundled/ref_721dfad0fe6c1d4d2955"
},
{
"$ref": "#/x-devx-bundled/ref_faa2548f7ff9f03457c5"
}
],
"title": "pricing intent",
"type": "object"
},
"ref_ed781d6dbf1d3de38e03": {
"description": "Array of links related to your order items.",
"properties": {
"links": {
"description": "Array of objects that contain information about each processing terminal that the terminal order is linked to.",
"items": {
"anyOf": [
{
"$ref": "#/x-devx-bundled/ref_3a384f5c8394f04df42d"
}
],
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"ref_ed868a8491d301a0b2c9": {
"description": "Adjust Refund",
"summary": "Adjust Refund",
"value": {
"card": {
"cardNumber": "453985******7062",
"entryMethod": "keyed",
"expiryDate": "1230",
"type": "Visa Credit"
},
"customFields": [
{
"name": "yourCustomField",
"value": "abc123"
}
],
"customer": {
"contactMethods": [
{
"type": "mobile",
"value": "8445558735"
}
]
},
"operator": "Jane",
"order": {
"amount": 4999,
"currency": "USD",
"dateTime": "2024-07-02T15:30:00Z",
"description": "Refund for order OrderRef6543",
"orderId": "OrderRef6543"
},
"processingTerminalId": "1234001",
"refundId": "CD3HN88U9F",
"transactionResult": {
"approvalCode": "000000",
"authorizedAmount": -4999,
"currency": "USD",
"responseCode": "A",
"responseMessage": "OK13",
"status": "ready",
"type": "refund"
}
}
},
"ref_ed895fe230c39097d47a": {
"description": "Unique identifier of the ACH deposit.",
"examples": {
"example": {
"value": 99
}
},
"in": "path",
"name": "achDepositId",
"required": true,
"schema": {
"type": "integer"
}
},
"ref_ee60eb6b85d9f43cd55d": {
"description": "Object that contains information about Interchange Plus Plus.",
"properties": {
"fees": {
"description": "Object that contains information about the fees.",
"properties": {
"amex": {
"description": "Polymorphic object that contains fees for American Express transactions. \n\nThe value of the type field determines which variant you should use: \n-\t`optBlue` - Amex OptBlue pricing program.\n-\t`direct` - Amex Direct pricing program.\n",
"discriminator": {
"mapping": {
"direct": "#/components/schemas/interchangePlusPlusAmexDirect",
"optBlue": "#/components/schemas/interchangePlusPlusAmexOptBlue"
},
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/x-devx-bundled/ref_e02b86f71136a4578d40"
},
{
"$ref": "#/x-devx-bundled/ref_b6fed5bc2d8edc10b7f0"
}
]
},
"electronicBenefitsTransfer": {
"$ref": "#/x-devx-bundled/ref_2c771c635a39c1d2ba57"
},
"enhancedInterchange": {
"$ref": "#/x-devx-bundled/ref_c81000a305abe78faab1"
},
"mastercardVisaDiscover": {
"$ref": "#/x-devx-bundled/ref_eb68f2c28371d61b1260",
"description": "Object that contains the fees for Mastercard, Visa, and Discover transactions."
},
"pinDebit": {
"$ref": "#/x-devx-bundled/ref_39ea196745f35c0c62a3"
},
"specialityCards": {
"$ref": "#/x-devx-bundled/ref_ca2b35d2127e00c3b179"
}
},
"required": [
"mastercardVisaDiscover"
],
"type": "object"
},
"planType": {
"description": "Type of processing plan.",
"enum": [
"interchangePlusPlus"
],
"type": "string"
}
},
"required": [
"planType",
"fees"
],
"title": "Interchange Plus Plus",
"type": "object"
},
"ref_ee82e5cfe4fc68200074": {
"summary": "Paginated transactions",
"value": {
"count": 1,
"data": [
{
"amount": 4999,
"authorization": {
"amount": 4999,
"authorizationId": 303101,
"avsResponseCode": "",
"code": "A1B2C3",
"link": {
"href": "https://api.payroc.com/v1/authorizations/303101",
"method": "get",
"rel": "authorization"
}
},
"batch": {
"batchId": 12,
"cycle": "am",
"date": "2024-07-02",
"link": {
"href": "https://api.payroc.com/v1/batches/12",
"method": "get",
"rel": "batch"
}
},
"card": {
"avsRequest": true,
"avsResponse": "",
"cardNumber": "453985******7062",
"cvvPresenceIndicator": true,
"type": "visa"
},
"cashbackAmount": 0,
"createdDate": "2024-07-02",
"currency": "USD",
"date": "2024-07-02",
"entryMethod": "ecommerce",
"interchange": {
"basisPoint": 0,
"transactionFee": 0
},
"lastModifiedDate": "2024-07-02",
"merchant": {
"doingBusinessAs": "Pizza Doe",
"link": {
"href": "https://api.payroc.com/v1/processing-accounts/38765",
"method": "get",
"rel": "processingAccount"
},
"merchantId": "4525644354",
"processingAccountId": 38765
},
"settled": {
"achDate": "2024-07-02",
"achDepositId": 99,
"link": {
"href": "https://api.payroc.com/v1/ach-deposits/99",
"method": "get",
"rel": "achDeposit"
},
"settledBy": "3rd party"
},
"status": "paid",
"transactionId": 442233,
"type": "capture"
}
],
"hasMore": false,
"limit": 2,
"links": [
{
"href": "https://api.payroc.com/v1/transactions?before=442233&limit=2&date=2024-07-02",
"method": "get",
"rel": "previous"
}
]
}
},
"ref_ee94622e3f9da4e9ce9b": {
"description": "Object that contains information about the charge when the merchant enters the amount of the transaction.",
"properties": {
"amount": {
"description": "Total amount of the transaction. The value is in the currency's lowest denomination, for example, cents.",
"example": 4999,
"format": "int64",
"type": "integer"
},
"currency": {
"$ref": "#/x-devx-bundled/ref_5c51a0e852c4baa940d0",
"example": "USD"
},
"type": {
"enum": [
"preset"
],
"example": "preset",
"type": "string"
}
},
"required": [
"type",
"amount",
"currency"
],
"title": "preset",
"type": "object"
},
"ref_eea3e8d8fb1af5850e3d": {
"bearerFormat": "JWT",
"description": "Example: Authorization: Bearer ",
"scheme": "bearer",
"type": "http"
},
"ref_eea40aa5ad1960d5cfae": {
"description": "Object that contains the 3-D Secure information from a third party.",
"properties": {
"cavv": {
"description": "Cardholder Authentication Verification Value (CAVV) that the card issuer provided to prove that they authorized the online payment.",
"example": "QWxhZGRpbjpvcGVuIHNlc2FtZQ==",
"maxLength": 50,
"minLength": 0,
"type": "string"
},
"dsTransactionId": {
"description": "Directory Server Transaction ID that the processor assigned to the request.",
"example": "123e4567-e89b-12d3-a456-426614174000",
"maxLength": 36,
"minLength": 0,
"type": "string"
},
"eci": {
"description": "E-commerce indicator (ECI) result of a the 3-D Secure check.",
"enum": [
"fullyAuthenticated",
"authAttempted"
],
"example": "fullyAuthenticated",
"type": "string"
},
"serviceProvider": {
"description": "Provider of your 3-D Secure protocol.",
"enum": [
"thirdParty"
],
"example": "thirdParty",
"type": "string"
},
"xid": {
"description": "Unique transaction identifier that the merchant assigned to the transaction and sent in the authentication request.",
"example": "VGhpcyBpcyBhbiBleGFtcGxlIFhJRA==",
"maxLength": 50,
"minLength": 0,
"type": "string"
}
},
"required": [
"eci",
"serviceProvider"
],
"title": "thirdParty",
"type": "object"
},
"ref_ef28873e9f9f9507a593": {
"description": "Payment link after we added a custom label.",
"summary": "Update payment link: add",
"value": {
"assets": {
"paymentButton": "SUPPORT US\n",
"paymentUrl": "https://payments.payroc.com/merchant/pay-by-link?token=02ada211-ff51-4845-b0b5-e685aeb4b19d"
},
"authType": "sale",
"createdOn": "2024-09-24",
"customLabels": [
{
"element": "paymentButton",
"label": "SUPPORT US"
},
{
"element": "paymentButton",
"label": "DONATE NOW"
}
],
"merchantReference": "LinkRef6543",
"order": {
"charge": {
"currency": "USD",
"type": "prompt"
},
"description": "Pie It Forward charitable trust donation"
},
"paymentLinkId": "JZURRJBUPS",
"paymentMethods": [
"card",
"bankTransfer"
],
"status": "active",
"type": "multiUse"
}
},
"ref_ef2d0bbf2b4dd8888832": {
"description": "Adjust the amount of a pre-authorization",
"summary": "Adjust pre-authorization",
"value": {
"adjustments": [
{
"amount": 3999,
"type": "order"
}
],
"operator": "Jane"
}
},
"ref_ef5e9a924c7ad31c29ce": {
"description": "Object that contains information about saving the customer’s payment details.",
"properties": {
"externalVault": {
"default": false,
"description": "Indicates if the merchant uses a third-party vault to store the customer’s payment details.",
"example": false,
"type": "boolean"
},
"mitAgreement": {
"description": "Indicates how the merchant can use the customer's card details to run future card transactions, as agreed with the customer. \n\nIf you send a value for the **mitAgreement** parameter, you must also include the **[standingInstructions](https://docs.payroc.com/api/schema/card-payments/payments/create#request.body.order.standingInstructions)** object in your request.\n\n- `unscheduled` - Transactions for a fixed or variable amount that the merchant runs at a certain predefined event. \n- `recurring` - Transactions for a fixed amount that the merchant runs at regular intervals, for example, monthly. Recurring transactions don’t have a fixed duration and run until the customer cancels the agreement. \n- `installment` - Transactions for a fixed amount that the merchant runs at regular intervals, for example, monthly. Installment transactions have a fixed duration. \n \n**Note:** If you send a value for **mitAgreement**, you must send the **standingInstructions** object in the **paymentOrder** object.\n",
"enum": [
"unscheduled",
"recurring",
"installment"
],
"example": "recurring",
"type": "string"
},
"secureTokenId": {
"description": "Unique identifier that the merchant creates for the secure token that represents the customer’s payment details.\n**Note:** If you do not send a value for the **secureTokenId** parameter, our gateway generates a unique identifier for the token.\n",
"example": "MREF_abc1de23-f4a5-6789-bcd0-12e345678901fa",
"maxLength": 200,
"minLength": 0,
"type": "string"
},
"tokenize": {
"description": "Indicates if our gateway should tokenize the customer’s payment details as part of the transaction.",
"example": true,
"type": "boolean"
}
},
"type": "object"
},
"ref_efc30f89a824cd57f874": {
"description": "Unit of measurement for the item. For more information about units of measurement, go to [Units of measurement](https://docs.payroc.com/knowledge/basic-concepts/units-of-measurement).",
"enum": [
"ACR",
"AMH",
"AMP",
"APZ",
"ARE",
"ASM",
"ASV",
"ATM",
"ATT",
"BAR",
"BFT",
"BHP",
"BHX",
"BIL",
"BLD",
"BLL",
"BQL",
"BTU",
"BUA",
"BUI",
"BX",
"CCT",
"CDL",
"CEL",
"CEN",
"CGM",
"CKG",
"CLF",
"CLT",
"CMK",
"CMT",
"CNP",
"CNT",
"COU",
"CS",
"CTM",
"CUR",
"CWA",
"DAA",
"DAD",
"DAY",
"DEC",
"DLT",
"DMK",
"DMQ",
"DMT",
"DPC",
"DPT",
"DRA",
"DRI",
"DRL",
"DRM",
"DTH",
"DTN",
"DWT",
"DZN",
"DZP",
"DZR",
"EA",
"EAC",
"FAH",
"FAR",
"FOT",
"FTK",
"FTQ",
"GBQ",
"GFI",
"GGR",
"GII",
"GLD",
"GLI",
"GLL",
"GRM",
"GRN",
"GRO",
"GRT",
"GWH",
"HAR",
"HBA",
"HGM",
"HIU",
"HLT",
"HMQ",
"HMT",
"HPA",
"HTZ",
"HUR",
"INH",
"INK",
"INQ",
"ITM",
"JOU",
"KBA",
"KEL",
"KGM",
"KGS",
"KHZ",
"KJO",
"KMH",
"KMK",
"KMQ",
"KMT",
"KNI",
"KNS",
"KNT",
"KPA",
"KPH",
"KPO",
"KPP",
"KSD",
"KSH",
"KTN",
"KUR",
"KVA",
"KVR",
"KVT",
"KWH",
"KWT",
"LBR",
"LBS",
"LEF",
"LPA",
"LTN",
"LTR",
"LUM",
"LUX",
"MAL",
"MAM",
"MAW",
"MBE",
"MBF",
"MBR",
"MCU",
"MGM",
"MHZ",
"MIK",
"MIL",
"MIN",
"MIO",
"MIU",
"MLD",
"MLT",
"MMK",
"MMQ",
"MMT",
"MON",
"MPA",
"MQH",
"MQS",
"MSK",
"MTK",
"MTQ",
"MTR",
"MTS",
"MVA",
"MWH",
"NAR",
"NBB",
"NCL",
"NEW",
"NIU",
"NMB",
"NMI",
"NMP",
"NMR",
"NPL",
"NPT",
"NRL",
"NTT",
"OHM",
"ONZ",
"OZA",
"OZI",
"PAL",
"PCB",
"PCE",
"PGL",
"PK",
"PSC",
"PTD",
"PTI",
"PTL",
"QAN",
"QTD",
"QTI",
"QTL",
"QTR",
"RPM",
"RPS",
"SAN",
"SCO",
"SCR",
"SEC",
"SET",
"SHT",
"SIE",
"SMI",
"SST",
"ST",
"STI",
"TAH",
"TNE",
"TPR",
"TQD",
"TRL",
"TSD",
"TSH",
"VLT",
"WCD",
"WEB",
"WEE",
"WHR",
"WSD",
"WTT",
"YDK",
"YDQ"
],
"example": "QAN",
"type": "string"
},
"ref_f0824408a74fbe3169d2": {
"description": "Create a merchant platform for a Fiserv-bound merchant with the Clover Merchant Processing Amendment addendum including equipment line-item pre-fill data.",
"summary": "Create Fiserv merchant platform with Clover Merchant Processing Amendment",
"value": {
"business": {
"addresses": [
{
"address1": "1 Example Ave.",
"address2": "Example Address Line 2",
"address3": "Example Address Line 3",
"city": "Chicago",
"country": "US",
"postalCode": "60056",
"state": "Illinois",
"type": "legalAddress"
}
],
"contactMethods": [
{
"type": "email",
"value": "jane.doe@example.com"
}
],
"countryOfOperation": "US",
"name": "Example Corp",
"organizationType": "privateCorporation",
"taxId": "12-3456789"
},
"metadata": {
"customerId": "2345"
},
"processingAccounts": [
{
"addendums": [
{
"lineItems": {
"cloverCashDrawer": {
"quantity": 2,
"totalPrice": 19800
},
"cloverSoloPosSystem": {
"quantity": 1,
"totalPrice": 149900
}
},
"type": "cloverMerchantProcessingAmendmentV1"
}
],
"address": {
"address1": "1 Example Ave.",
"address2": "Example Address Line 2",
"address3": "Example Address Line 3",
"city": "Chicago",
"country": "US",
"postalCode": "60056",
"state": "Illinois"
},
"businessStartDate": "2020-01-01",
"businessType": "restaurant",
"categoryCode": 5999,
"contactMethods": [
{
"type": "email",
"value": "jane.doe@example.com"
}
],
"doingBusinessAs": "Pizza Doe",
"funding": {
"acceleratedFundingFee": 1999,
"dailyDiscount": false,
"fundingAccounts": [
{
"metadata": {
"yourCustomField": "abc123"
},
"nameOnAccount": "Jane Doe",
"paymentMethods": [
{
"type": "ach",
"value": {
"accountNumber": "1234567890",
"routingNumber": "123456789"
}
}
],
"type": "checking",
"use": "creditAndDebit"
}
],
"fundingSchedule": "nextday"
},
"merchandiseOrServiceSold": "Pizza",
"metadata": {
"customerId": "2345"
},
"owners": [
{
"address": {
"address1": "1 Example Ave.",
"address2": "Example Address Line 2",
"address3": "Example Address Line 3",
"city": "Chicago",
"country": "US",
"postalCode": "60056",
"state": "Illinois"
},
"contactMethods": [
{
"type": "email",
"value": "jane.doe@example.com"
}
],
"dateOfBirth": "1964-03-22",
"firstName": "Jane",
"identifiers": [
{
"type": "nationalId",
"value": "000-00-4320"
}
],
"lastName": "Doe",
"middleName": "Helen",
"relationship": {
"equityPercentage": 48.5,
"isAuthorizedSignatory": false,
"isControlProng": true,
"title": "CFO"
}
}
],
"pricing": {
"pricingIntentId": "6123",
"type": "intent"
},
"processing": {
"monthlyAmounts": {
"average": 50000,
"highest": 100000
},
"transactionAmounts": {
"average": 5000,
"highest": 10000
},
"volumeBreakdown": {
"cardPresent": 77,
"ecommerce": 20,
"mailOrTelephone": 3
}
},
"processor": "fiserv",
"signature": {
"type": "requestedViaDirectLink"
},
"timezone": "America/Chicago",
"website": "www.example.com"
}
]
}
},
"ref_f0ab6d6e61cc49ba06f0": {
"description": "Filter by payments that the processer processed before a specific date. The date format follows the ISO 8601 standard.",
"examples": {
"example": {
"value": "2024-07-03T15:30:00Z"
}
},
"in": "query",
"name": "dateTo",
"schema": {
"format": "date-time",
"type": "string"
}
},
"ref_f0b7a1371b9eea6970de": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_643be9b90eb060b3174b"
},
{
"$ref": "#/x-devx-bundled/ref_fc8f7663e04a5c1c54b8"
}
]
},
"ref_f19f62b6b85953855c92": {
"description": "One or more validation errors occurred.",
"summary": "Bad request",
"value": {
"detail": "One or more validation errors occurred, see error section for more info",
"errors": [
{
"detail": "invalid value",
"message": "Expected integer, got abc",
"parameter": "instructionId"
}
],
"status": 400,
"title": "Bad request",
"type": "https://docs.payroc.com/api/errors#bad-request"
}
},
"ref_f218edb412905fb7df43": {
"description": "Payment link after we replaced its expiry date.",
"summary": "Update payment link: replace",
"value": {
"assets": {
"paymentButton": "SUPPORT US\n",
"paymentUrl": "https://payments.payroc.com/merchant/pay-by-link?token=02ada211-ff51-4845-b0b5-e685aeb4b19d"
},
"authType": "sale",
"createdOn": "2024-09-24",
"customLabels": [
{
"element": "paymentButton",
"label": "SUPPORT US"
}
],
"expiresOn": "2024-11-30",
"merchantReference": "LinkRef6543",
"order": {
"charge": {
"currency": "USD",
"type": "prompt"
},
"description": "Pie It Forward charitable trust donation"
},
"paymentLinkId": "JZURRJBUPS",
"paymentMethods": [
"card",
"bankTransfer"
],
"status": "active",
"type": "multiUse"
}
},
"ref_f27ff73f6b39cb7ab2df": {
"description": "Object that contains information about tiered pricing with four tiers.",
"properties": {
"fees": {
"description": "Object that contains information about the fees.",
"properties": {
"amex": {
"description": "Polymorphic object that contains fees for American Express transactions. \n\nThe value of the type field determines which variant you should use: \n-\t`optBlue` - Amex OptBlue pricing program.\n-\t`direct` - Amex Direct pricing program.\n",
"discriminator": {
"mapping": {
"direct": "#/components/schemas/tiered4AmexDirect",
"optBlue": "#/components/schemas/tiered4AmexOptBlue"
},
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/x-devx-bundled/ref_5c46dfd7d417f370f5b9"
},
{
"$ref": "#/x-devx-bundled/ref_f62c9104c55dc5de0b38"
}
]
},
"electronicBenefitsTransfer": {
"$ref": "#/x-devx-bundled/ref_2c771c635a39c1d2ba57"
},
"mastercardVisaDiscover": {
"$ref": "#/x-devx-bundled/ref_42257c2e1171733db046",
"description": "Object that contains the fees for Mastercard, Visa, and Discover transactions."
},
"pinDebit": {
"$ref": "#/x-devx-bundled/ref_39ea196745f35c0c62a3"
},
"specialityCards": {
"$ref": "#/x-devx-bundled/ref_ca2b35d2127e00c3b179"
}
},
"required": [
"mastercardVisaDiscover"
],
"type": "object"
},
"planType": {
"description": "Type of processing plan.",
"enum": [
"tiered4"
],
"type": "string"
}
},
"required": [
"planType",
"fees"
],
"title": "Tiered pricing with four tiers",
"type": "object"
},
"ref_f2a33074005524a7a836": {
"description": "Attachment that you want to upload to a processing account.",
"summary": "Upload attachment to processing account",
"value": {
"attachment": {
"description": "Passport as identification for lease agreement",
"metadata": {
"documentId": "2345"
},
"type": "personalIdentification"
},
"file": "JaneDoePassport.pdf"
}
},
"ref_f2abf89ac2d4b9e16ebd": {
"description": "Reminder created.",
"summary": "Create reminder for processing account",
"value": {
"reminderId": "1234567",
"type": "pricingAgreement"
}
},
"ref_f2dca78935024ce9572f": {
"description": "Valid payfac account with activity for date range.",
"summary": "Paginated activity records",
"value": {
"count": 10,
"data": [
{
"amount": 4999,
"currency": "USD",
"date": "2024-07-02T17:00:00.000Z",
"description": "sales",
"id": 11,
"merchant": "Pizza Doe",
"type": "credit"
},
{
"amount": 3999,
"currency": "USD",
"date": "2024-07-02T19:32:00.000Z",
"description": "sales",
"id": 12,
"merchant": "Pizza Doe",
"type": "credit"
},
{
"amount": 3299,
"currency": "USD",
"date": "2024-07-02T17:00:00.000Z",
"description": "sales",
"id": 13,
"merchant": "Pizza Doe",
"type": "credit"
},
{
"amount": 50,
"currency": "USD",
"date": "2024-07-02T17:00:00.000Z",
"description": "Interchange Fees",
"id": 14,
"merchant": "Pizza Doe",
"recipient": "Payroc",
"type": "debit"
},
{
"amount": 4999,
"currency": "USD",
"date": "2024-07-02T09:10:00.000Z",
"description": "sales",
"id": 15,
"merchant": "Pizza Doe",
"type": "credit"
},
{
"amount": 750,
"currency": "USD",
"date": "2024-07-02T17:00:00.000Z",
"description": "Adjustment",
"id": 16,
"merchant": "Doe Hot Dogs",
"type": "credit"
},
{
"amount": 5,
"currency": "USD",
"date": "2024-07-02T17:00:00.000Z",
"description": "Interchange Fees",
"id": 17,
"merchant": "Doe Hot Dogs",
"recipient": "Payroc",
"type": "debit"
},
{
"amount": 1000,
"currency": "USD",
"date": "2024-07-02T17:00:00.000Z",
"description": "Charge back",
"id": 18,
"merchant": "Pizza Doe",
"recipient": "Payroc",
"type": "debit"
},
{
"amount": 5999,
"currency": "USD",
"date": "2024-07-02T17:00:00.000Z",
"description": "sales",
"id": 19,
"merchant": "Pizza Doe",
"type": "credit"
},
{
"amount": 1000,
"currency": "USD",
"date": "2024-07-02T17:00:00.000Z",
"description": "payment",
"id": 20,
"merchant": "Pizza Doe",
"recipient": "Pizza Doe",
"type": "debit"
}
],
"hasMore": true,
"limit": 10,
"links": [
{
"href": "https://api.payroc.com/v1/funding-activity?before=11&limit=10&datefrom=2024-07-01&dateto=2024-07-03",
"method": "get",
"rel": "previous"
},
{
"href": "https://api.payroc.com/v1/funding-activity?after=20&limit=10&datefrom=2024-07-01&dateto=2024-07-03",
"method": "get",
"rel": "next"
}
]
}
},
"ref_f2f878b62955a67eeadf": {
"description": "Filter by refunds processed before a specific date. The date format follows the ISO 8601 standard.",
"examples": {
"example": {
"value": "2024-07-03T15:30:00Z"
}
},
"in": "query",
"name": "dateTo",
"schema": {
"format": "date-time",
"type": "string"
}
},
"ref_f3a5b8382be8e3b73da0": {
"description": "Object that contains the customer's account details.",
"properties": {
"accountNumber": {
"description": "Customer's account number.",
"example": "123456789",
"maxLength": 17,
"minLength": 4,
"pattern": "^[0-9]*$",
"type": "string"
},
"nameOnAccount": {
"description": "Customer's name.",
"example": "Sarah Hazel Hopper",
"maxLength": 50,
"minLength": 1,
"type": "string"
},
"routingNumber": {
"description": "Routing number of the customer's account.",
"example": "123456789",
"maxLength": 9,
"minLength": 9,
"pattern": "^[0-9]*$",
"type": "string"
},
"type": {
"enum": [
"ach"
],
"example": "ach",
"type": "string"
}
},
"required": [
"type",
"nameOnAccount",
"accountNumber",
"routingNumber"
],
"title": "ach",
"type": "object"
},
"ref_f3dcd626dda69114f30c": {
"additionalProperties": false,
"description": "CBD Attestation for merchants that sell any of the following products:\n\n- CBD products\n- Synthetic THC or Cannabis\n- HHC\n- Kratom\n- Tianeptine\n- Delta 8/9/10/0 THC products\n",
"properties": {
"type": {
"const": "cbdV1",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"ref_f407174aa45420924704": {
"additionalProperties": false,
"description": "Firearms Due Diligence for merchants that sell firearms.",
"properties": {
"type": {
"const": "firearmsV1",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"ref_f4b6c313f736a4a4eef8": {
"description": "Object that contains information about the payment details in the customer’s digital wallet.",
"properties": {
"accountType": {
"description": "Indicates the customer’s account type. \n\n**Note:** Send a value for accountType only for bank account details.\n",
"enum": [
"checking",
"savings"
],
"example": "checking",
"type": "string"
},
"cardholderName": {
"description": "Cardholder’s name.",
"maxLength": 50,
"minLength": 0,
"type": "string"
},
"encryptedData": {
"description": "Encrypted data of the digital wallet.",
"maxLength": 20480,
"minLength": 128,
"type": "string"
},
"serviceProvider": {
"description": "Provider of the digital wallet. Send one of the following values:\n- `apple` - For more information about how to integrate with Apple Pay, go to [Apple Pay®](https://docs.payroc.com/guides/take-payments/apple-pay).\n- `google` - For more information about how to integrate with google Pay, go to [Google Pay®](https://docs.payroc.com/guides/take-payments/google-pay).\n",
"enum": [
"apple",
"google"
],
"type": "string"
},
"type": {
"description": "Method that the terminal used to take the payment.",
"enum": [
"digitalWallet"
],
"type": "string"
}
},
"required": [
"type",
"encryptedData",
"serviceProvider"
],
"title": "digitalWallet",
"type": "object",
"writeOnly": true
},
"ref_f4dc973b396baa11312d": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_f9d963d00740bbe00c9e"
},
{
"properties": {
"data": {
"description": "Array of subscriptions.",
"items": {
"$ref": "#/x-devx-bundled/ref_4c17f383035c3260c513"
},
"type": "array"
}
},
"type": "object"
}
],
"required": [
"count",
"data",
"hasMore",
"limit"
],
"type": "object"
},
"ref_f54924324f303544eab2": {
"description": "Object that contains information about the EBT voucher. \n\n**Note:** Vouchers are available only for EBT SNAP payments.\n",
"properties": {
"approvalCode": {
"description": "Authorization code that the processor issued for the transaction.",
"example": "123456",
"maxLength": 6,
"minLength": 6,
"type": "string"
},
"serialNumber": {
"description": "Serial number of the voucher.",
"example": "SN123456789",
"maxLength": 15,
"minLength": 7,
"type": "string"
}
},
"required": [
"approvalCode",
"serialNumber"
],
"type": "object"
},
"ref_f55097134a658e246ef1": {
"description": "Filter results by refunds that the merchant ran before a specific date. The value follows the [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) standard.",
"examples": {
"example": {
"value": "2024-07-31T23:59:59Z"
}
},
"in": "query",
"name": "dateTo",
"schema": {
"format": "date-time",
"type": "string"
}
},
"ref_f62c9104c55dc5de0b38": {
"properties": {
"transaction": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_109fe7e5f018de7ee04b"
}
],
"description": "Fee for each transaction. The value is in the currency's lowest denomination, for example, cents."
},
"type": {
"description": "Type of American Express program.",
"enum": [
"direct"
],
"type": "string"
}
},
"required": [
"type",
"transaction"
],
"title": "direct",
"type": "object"
},
"ref_f640737cfbed9624abf9": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_3147c722e948ca9d06ad"
},
{
"description": "Object that contains information about the transaction.",
"properties": {
"amount": {
"description": "Total amount of the transaction. The value is in the currency's lowest denomination, for example, cents.",
"example": 2899,
"format": "int64",
"type": "integer"
},
"currency": {
"$ref": "#/x-devx-bundled/ref_5c51a0e852c4baa940d0",
"example": "USD"
},
"dateTime": {
"description": "Date and time that we processed the transaction. We return this value in the ISO 8601 format.",
"example": "2024-07-02T15:30:00Z",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"description": {
"description": "Description of the refund.",
"example": "Pizza Doe #1234 - Dinner",
"maxLength": 256,
"minLength": 0,
"type": "string"
},
"orderId": {
"description": "Unique identifier that the merchant assigned to the transaction.",
"example": "OrderRef6543",
"maxLength": 24,
"minLength": 1,
"type": "string"
}
},
"type": "object"
}
],
"description": "Object that contains information about the order.",
"required": [
"amount",
"currency",
"description",
"orderId"
],
"type": "object"
},
"ref_f677b5a197b397de6df2": {
"description": "Create a secure token using a single-use token that represents card details.",
"summary": "Secure token created from a single-use token",
"value": {
"customFields": [
{
"name": "yourCustomField",
"value": "abc123"
}
],
"customer": {
"billingAddress": {
"address1": "1 Example Ave.",
"address2": "Example Address Line 2",
"city": "Chicago",
"country": "US",
"postalCode": "60056",
"state": "Illinois"
},
"contactMethods": [
{
"type": "email",
"value": "sarah.hopper@example.com"
}
],
"dateOfBirth": "1990-07-15",
"firstName": "Sarah",
"lastName": "Hopper",
"notificationLanguage": "en",
"referenceNumber": "Customer-12"
},
"mitAgreement": "unscheduled",
"processingTerminalId": "1234001",
"secureTokenId": "MREF_abc1de23-f4a5-6789-bcd0-12e345678901fa",
"source": {
"cardNumber": "453985******7062",
"cardholderName": "Sarah Hazel Hopper",
"expiryDate": "1230",
"type": "card"
},
"status": "notValidated",
"token": "296753123456"
}
},
"ref_f6e10cfc48a2f2c041b3": {
"description": "Time zone for the processing account.",
"enum": [
"Pacific/Midway",
"Pacific/Honolulu",
"America/Anchorage",
"America/Los_Angeles",
"America/Denver",
"America/Phoenix",
"America/Chicago",
"America/Indiana/Indianapolis",
"America/New_York"
],
"example": "America/Chicago",
"maxLength": 28,
"type": "string"
},
"ref_f757013ea5967635deaf": {
"properties": {
"closedLoopReadId": {
"description": "Unique identifier that we assigned to the closed-loop read.",
"example": "KEO45MAC1U",
"type": "string"
},
"data": {
"description": "Unstructured payload from the card.\n",
"example": {
"cardType": "MiFareClassic",
"uid": "04134ee21f1d80"
},
"type": "object"
},
"processingTerminalId": {
"description": "Unique identifier that we assigned to the terminal.",
"example": "1234001",
"type": "string"
},
"readDate": {
"description": "Date that the payment device read the closed-loop card. Our gateway returns this value in **YYYY-MM-DD** format.",
"example": "2024-07-02",
"format": "date",
"type": "string"
}
},
"required": [
"processingTerminalId",
"closedLoopReadId",
"readDate",
"data"
],
"type": "object"
},
"ref_f79ede1604f3256458f6": {
"description": "Object that contains information about the transaction.",
"properties": {
"authorizedAmount": {
"description": "Amount of the transaction. \n**Note:** The amount is negative for a refund.\n",
"example": 2899,
"format": "int64",
"type": "integer"
},
"currency": {
"$ref": "#/x-devx-bundled/ref_5c51a0e852c4baa940d0"
},
"processorResponseCode": {
"description": "Original response code that the processor sent.",
"example": "A",
"type": "string"
},
"responseCode": {
"description": "Response from the processor. \n- `A` - The processor approved the transaction. \n- `D` - The processor declined the transaction. \n",
"example": "A",
"type": "string"
},
"responseMessage": {
"description": "Description of the response from the processor.",
"example": "Payment Approved",
"maxLength": 48,
"minLength": 1,
"type": "string"
},
"status": {
"description": "Status of the transaction. The value is one of the following: \n- `ready` - Successful transaction. We added the payment to the open batch. \n- `pending` - Successful transaction. We added the payment to the open batch, but we don’t collect the funds when the batch is closed. \n-\t`declined` - Unsuccessful transaction. The customer's bank declined the transfer. \n-\t`complete` - Successful transaction. The funds have moved to the merchant’s bank account. \n-\t`admin` - Transaction under review. We have flagged an issue with the transaction. \n-\t`reversal` - Transaction canceled. The transaction was canceled, and we removed the transaction from the open batch. \n-\t`returned` - Unsuccessful transaction. Automated clearing house (ACH) returned the transaction due to an error. For more information about the error, view the **returns** object. \n",
"enum": [
"ready",
"pending",
"declined",
"complete",
"admin",
"reversal",
"returned"
],
"example": "complete",
"type": "string"
},
"type": {
"description": "Type of transaction.",
"enum": [
"payment",
"refund",
"unreferencedRefund",
"accountVerification"
],
"example": "payment",
"type": "string"
}
},
"readOnly": true,
"required": [
"status",
"type",
"responseCode"
],
"type": "object"
},
"ref_f7eeb7b4e577c65a5900": {
"description": "Object that contains information about tiered pricing with six tiers.",
"properties": {
"fees": {
"description": "Object that contains information about the fees.",
"properties": {
"amex": {
"description": "Polymorphic object that contains fees for American Express transactions. \n\nThe value of the type field determines which variant you should use: \n-\t`optBlue` - Amex OptBlue pricing program.\n-\t`direct` - Amex Direct pricing program.\n",
"discriminator": {
"mapping": {
"direct": "#/components/schemas/tiered6AmexDirect",
"optBlue": "#/components/schemas/tiered6AmexOptBlue"
},
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/x-devx-bundled/ref_83bdb8c876489e7f56cc"
},
{
"$ref": "#/x-devx-bundled/ref_13e96b9f11d47b95852d"
}
]
},
"electronicBenefitsTransfer": {
"$ref": "#/x-devx-bundled/ref_2c771c635a39c1d2ba57"
},
"mastercardVisaDiscover": {
"$ref": "#/x-devx-bundled/ref_6af5008fcc50131f9758",
"description": "Object that contains the fees for Mastercard, Visa, and Discover transactions."
},
"pinDebit": {
"$ref": "#/x-devx-bundled/ref_39ea196745f35c0c62a3"
},
"specialityCards": {
"$ref": "#/x-devx-bundled/ref_ca2b35d2127e00c3b179"
}
},
"required": [
"mastercardVisaDiscover"
],
"type": "object"
},
"planType": {
"description": "Type of processing plan.",
"enum": [
"tiered6"
],
"type": "string"
}
},
"required": [
"planType",
"fees"
],
"title": "Tiered pricing with six tiers",
"type": "object"
},
"ref_f8dacd706f9d02dd8d64": {
"description": "Paginated Secure Token",
"summary": "Paginated Secure Token",
"value": {
"count": 2,
"data": [
{
"customer": {
"billingAddress": {
"address1": "1 Example Ave.",
"address2": "Example Address Line 2",
"address3": "Example Address Line 3",
"city": "Chicago",
"country": "US",
"postalCode": "60056",
"state": "Illinois"
},
"dateOfBirth": "1990-07-15",
"firstName": "Sarah",
"lastName": "Hopper",
"referenceNumber": "Customer-12",
"shippingAddress": {
"address": {
"address1": "1 Example Ave.",
"address2": "Example Address Line 2",
"address3": "Example Address Line 3",
"city": "Chicago",
"country": "US",
"postalCode": "60056",
"state": "Illinois"
},
"recipientName": "Sarah Hopper"
}
},
"mitAgreement": "unscheduled",
"processingTerminalId": "1234001",
"secureTokenId": "MREF_abc1de23-f4a5-6789-bcd0-12e345678901fa",
"source": {
"cardNumber": "453985******7062",
"cardholderName": "Sarah Hopper",
"expiryDate": "1230",
"type": "card"
},
"status": "notValidated",
"token": "296753123456"
},
{
"customFields": [
{
"name": "yourCustomField",
"value": "abc123"
}
],
"customer": {
"billingAddress": {
"address1": "1 Example Ave.",
"address2": "Example Address Line 2",
"address3": "Example Address Line 3",
"city": "Chicago",
"country": "US",
"postalCode": "60056",
"state": "Illinois"
},
"dateOfBirth": "1990-07-15",
"firstName": "Sarah",
"lastName": "Hopper",
"referenceNumber": "Customer-12",
"shippingAddress": {
"address": {
"address1": "1 Example Ave.",
"address2": "Example Address Line 2",
"address3": "Example Address Line 3",
"city": "Chicago",
"country": "US",
"postalCode": "60056",
"state": "Illinois"
},
"recipientName": "Sarah Hopper"
}
},
"mitAgreement": "unscheduled",
"processingTerminalId": "1234001",
"secureTokenId": "MREF_fe0d9876-cba5-432f-e10d-9cb87654a3f2e1",
"source": {
"cardNumber": "500165******0000",
"cardholderName": "Sarah Hazel Hopper",
"expiryDate": "0328",
"type": "card"
},
"status": "notValidated",
"token": "307864234567"
}
],
"hasMore": true,
"limit": 2,
"links": [
{
"href": "https://api.payroc.com/v1/processing-terminals/1234001/secure-tokens?limit=2&after=MREF_fe0d9876-cba5-432f-e10d-9cb87654a3f2e1",
"method": "get",
"rel": "next"
},
{
"href": "https://api.payroc.com/v1/processing-terminals/1234001/secure-tokens?limit=2&before=MREF_abc1de23-f4a5-6789-bcd0-12e345678901fa",
"method": "get",
"rel": "previous"
}
]
}
},
"ref_f9558cdcf01ed42b8fd5": {
"properties": {
"secret": {
"description": "String that we send with a notification so that you can ensure it is a valid notification from our gateway. We include the value in the Payroc-Secret header parameter in the webhook call. \n**Note:** In the response, we truncate the secret to the last 16 characters and mask the first 10 characters. \n",
"example": "aBcD1234eFgH5678iJkL9012mNoP3456",
"maxLength": 64,
"minLength": 16,
"type": "string"
},
"supportEmailAddress": {
"description": "Email address of the person or team that we contact if we can't deliver notifications.",
"type": "string"
},
"type": {
"description": "Type of notification method. \n**Note:** To receive notifications by webhook, your server must be able to handle POST requests. \n",
"enum": [
"webhook"
],
"example": "webhook",
"type": "string"
},
"uri": {
"description": "Public endpoint that we send notifications to.",
"example": "https://my-server/notification/endpoint",
"type": "string"
}
},
"required": [
"type",
"uri",
"secret",
"supportEmailAddress"
],
"type": "object"
},
"ref_f9cda9181de4b9730c36": {
"description": "Create session response.",
"summary": "Create session",
"value": {
"expiresAt": "2025-07-02T15:30:00.123456789+02:00",
"processingTerminalId": "1234001",
"token": "abcdef1234567890abcdef1234567890"
}
},
"ref_f9d963d00740bbe00c9e": {
"description": "Contains the pagination properties that you use to navigate through a list of results.",
"properties": {
"count": {
"description": "Number of results we returned on this page. \n\n**Note:** This might not be the total number of results that match your query. \n",
"example": 23,
"type": "integer"
},
"hasMore": {
"description": "Indicates whether there is another page of results available.",
"example": false,
"type": "boolean"
},
"limit": {
"description": "Maximum number of results that we return for each page.",
"example": 25,
"type": "integer"
},
"links": {
"description": "Reference links to navigate to the previous page of results or to the next page of results.",
"example": [
{
"href": "",
"method": "get",
"rel": "previous"
},
{
"href": "",
"method": "get",
"rel": "next"
}
],
"items": {
"$ref": "#/x-devx-bundled/ref_27e6d0e095fb23cba669"
},
"type": "array"
}
},
"type": "object"
},
"ref_fa7c86811eba798b4839": {
"description": "Filter results by the settlement date. Send a value in **YYYY-MM-DD** format.",
"examples": {
"example": {
"value": "2024-07-15"
}
},
"in": "query",
"name": "settlementDate",
"schema": {
"format": "date",
"type": "string"
}
},
"ref_faa2548f7ff9f03457c5": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_143db3de56b4d4e7e9c2"
},
{
"$ref": "#/x-devx-bundled/ref_2334f7c0d1cd64614f53"
}
],
"description": "Object that contains information about a pricing intent for Merchant Processing Agreement (MPA) 5.2.",
"title": "5.2",
"type": "object"
},
"ref_faa337c615389cdead2b": {
"description": "Capture a pre-authorization",
"summary": "Capture a pre-authorization",
"value": {
"amount": 3999,
"operator": "Jane",
"processingTerminalId": "1234001"
}
},
"ref_faf1a830a92d4db7bd17": {
"summary": "Paginated ACH deposits",
"value": {
"count": 1,
"data": [
{
"achAdjustment": 1000,
"achDate": "2024-07-02",
"achDepositId": 99,
"associationDate": "2024-07-02",
"dailyFees": 1000,
"heldSales": 1000,
"holdback": 1000,
"links": [
{
"href": "https://api.payroc.com/v1/ach-deposit-fees?achDepositId=99&merchantId=4525644354",
"method": "get",
"rel": "achDepositFees"
}
],
"merchant": {
"doingBusinessAs": "Pizza Doe",
"link": {
"href": "https://api.payroc.com/v1/processing-accounts/38765",
"method": "get",
"rel": "processingAccount"
},
"merchantId": "4525644354",
"processingAccountId": 38765
},
"netAmount": 36500,
"paymentDate": "2024-07-02",
"reserveRelease": 500,
"returns": 10000,
"sales": 50000,
"transactions": 10
}
],
"hasMore": false,
"limit": 2,
"links": [
{
"href": "https://api.payroc.com/v1/ach-deposits?before=65&limit=2&date=2024-07-02",
"method": "get",
"rel": "previous"
}
]
}
},
"ref_fb18ff3a7be62ead942a": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_f9d963d00740bbe00c9e"
},
{
"properties": {
"data": {
"description": "Array of saved payment details.",
"items": {
"$ref": "#/x-devx-bundled/ref_b0b4930f5830799eddd0"
},
"type": "array"
}
},
"type": "object"
}
],
"required": [
"count",
"data",
"hasMore",
"limit"
],
"type": "object"
},
"ref_fb5a139ab9687a8241f1": {
"description": "Object that contains information about the unencrypted card details.",
"properties": {
"cardholderSignature": {
"description": "Cardholder's signature. For more information about how to format the signature, go to [How to send a signature to our gateway](https://docs.payroc.com/knowledge/basic-concepts/signature-capture).",
"example": "a1b1c012345678a000b000c0012345d0e0f010g10061a031i001j071k0a1b0c1d0e1234567890120f1g0h1i0j1k0a1b0123451c012d0e1f0g1h0i1j123k1a1b1c1d1e1f1g123h1i1j1k1a1b1c1d1e1f1g123h123i1j123k12340a120a12345b012c0123012d0d1e0f1g0h1i123j123k10000",
"type": "string"
},
"device": {
"$ref": "#/x-devx-bundled/ref_32a04596e26026b47268"
},
"downgradeTo": {
"description": "If an offline transaction is not approved using the initial entry method, reprocess the transaction using a downgraded entry method.\nFor example, an Integrated Circuit Card (ICC) transaction can be downgraded to a swiped transaction or to a keyed transaction.\n",
"enum": [
"keyed",
"swiped"
],
"example": "swiped",
"type": "string"
},
"entryMethod": {
"description": "Method that the terminal used to capture the card details.",
"enum": [
"raw"
],
"example": "raw",
"type": "string"
},
"rawData": {
"description": "Unencrypted data from the POS terminal.",
"example": "A1B2C3D4E5F67890ABCD1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF",
"format": "hexadecimal",
"maxLength": 2147483647,
"minLength": 1,
"type": "string"
}
},
"required": [
"entryMethod",
"device",
"rawData"
],
"title": "raw",
"type": "object"
},
"ref_fc48a721906cd4080a66": {
"description": "Filter results by the customer's name.",
"examples": {
"example": {
"value": "Sarah Hazel Hopper"
}
},
"in": "query",
"name": "recipientName",
"schema": {
"maxLength": 48,
"minLength": 1,
"type": "string"
}
},
"ref_fc891050b2851d9104f0": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_27e6c97d2efec1f915a5"
},
{
"properties": {
"breakdown": {
"$ref": "#/x-devx-bundled/ref_2cab84ef08bff0d773e2"
}
},
"type": "object"
}
],
"description": "Object that contains information about the transaction.",
"required": [
"amount",
"currency",
"orderId"
],
"type": "object"
},
"ref_fc8f7663e04a5c1c54b8": {
"properties": {
"frequency": {
"$ref": "#/x-devx-bundled/ref_c0d4d3c11e403499d96c"
},
"method": {
"description": "Method of payment for the terminal order. The value is one of the following: \n- `hostedPaymentPage` - We send a link to the merchant to pay for the terminal order. \n- `accountOnFile` - We use the merchant's payment details that we have stored to pay for the terminal order.\n",
"enum": [
"hostedPaymentPage",
"accountOnFile"
],
"example": "hostedPaymentPage",
"maxLength": 17,
"type": "string"
},
"payer": {
"description": "Indicates who is paying for the terminal order. Send a value of `merchant`.",
"enum": [
"merchant"
],
"example": "merchant",
"maxLength": 12,
"type": "string"
}
},
"required": [
"payer",
"method"
],
"type": "object"
},
"ref_fca565eee84a34e9245c": {
"description": "Remove operation deletes a value from the secure token.",
"summary": "Update secure token: remove",
"value": [
{
"op": "remove",
"path": "/customer/dateOfBirth"
}
]
},
"ref_fcc3ce73949c1562a8cf": {
"description": "Object that contains signature information if we captured the merchant’s signature by direct link.",
"properties": {
"link": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_27e6d0e095fb23cba669"
}
],
"description": "Object that contains links to the signed contract.",
"example": {
"href": "https://us.agreementexpress.net/mv2/viewer2.jsp?docId=00000000-0000-0000-0000-000000000000",
"method": "get",
"rel": "agreement"
}
},
"type": {
"description": "Method used to capture the owner's signature.",
"enum": [
"requestedViaDirectLink"
],
"example": "requestedViaDirectLink",
"type": "string"
}
},
"required": [
"type"
],
"title": "requestedViaDirectLink",
"type": "object"
},
"ref_fd1bea82744c5a13f490": {
"description": "Tip settings",
"properties": {
"enabled": {
"description": "Indicates if the terminal can accept tips.",
"type": "boolean"
}
},
"required": [
"enabled"
],
"type": "object"
},
"ref_fe8bb1cf77667d3bf0ca": {
"allOf": [
{
"$ref": "#/x-devx-bundled/ref_f9d963d00740bbe00c9e"
},
{
"properties": {
"data": {
"description": "Array of owner objects.",
"items": {
"$ref": "#/x-devx-bundled/ref_d8267a8278910c858c37"
},
"type": "array"
}
},
"type": "object"
}
],
"title": "paginated Owners",
"type": "object"
},
"ref_feb6217fee997494806b": {
"description": "Object that contains information about the Hardware Advantage Plan.",
"discriminator": {
"mapping": {
"hardwareAdvantagePlan": "#/components/schemas/hardwareAdvantagePlan"
},
"propertyName": "name"
},
"oneOf": [
{
"$ref": "#/x-devx-bundled/ref_6ea779bd3356928bc30b"
}
],
"title": "hardwareAdvantagePlan",
"type": "object"
},
"ref_fedffac120362e641ae9": {
"description": "One or more validation errors occurred",
"summary": "Bad request",
"value": {
"detail": "One or more validation errors occurred, see error section for more info",
"errors": [
{
"detail": "invalid value",
"message": "Expected integer, got abc",
"parameter": "before"
}
],
"status": 400,
"title": "Bad request",
"type": "https://docs.payroc.com/api/errors#bad-request"
}
},
"ref_fee7c4d5f68fe4bab281": {
"description": "Event subscription after moving a value within the eventTypes array.",
"summary": "Update event subscription: move",
"value": {
"enabled": true,
"eventTypes": [
"processingAccount.status.changed"
],
"id": 2565435189324,
"metadata": {
"yourCustomField": "abc123"
},
"notifications": [
{
"secret": "**********oP3456",
"supportEmailAddress": "jane.doe@example.com",
"type": "webhook",
"uri": "https://my-server/notification/endpoint"
}
],
"status": "registered"
}
},
"ref_ff5778400f1d9cc0abb1": {
"description": "Submit an instruction for capturing a signature on a physical device.",
"summary": "Signature Instruction",
"value": {
"processingTerminalId": "1234001"
}
},
"ref_ff895c9be121743fda06": {
"description": "Fx-Rate",
"summary": "Fx-Rate",
"value": {
"baseAmount": 10000,
"baseCurrency": "USD",
"channel": "web",
"operator": "Jane",
"paymentMethod": {
"accountType": "checking",
"cardDetails": {
"cardholderName": "Sarah Hazel Hopper",
"entryMethod": "keyed",
"keyedData": {
"cardNumber": "4539858876047062",
"dataFormat": "plainText",
"expiryDate": "1230"
}
},
"type": "card"
},
"processingTerminalId": "1234001"
}
},
"ref_ff9e53b467436d074a75": {
"properties": {
"amount": {
"description": "Amount of tax that was applied to the transaction. The value is in the currency's lowest denomination, for example, cents.",
"example": 190,
"exclusiveMinimum": 0,
"format": "int64",
"readOnly": true,
"type": "integer"
},
"name": {
"description": "Name of the tax.",
"example": "Sales Tax",
"maxLength": 64,
"minLength": 1,
"type": "string"
},
"rate": {
"description": "Tax percentage for the transaction.",
"example": 7,
"format": "double",
"maximum": 99.99999,
"minimum": 0,
"type": "number",
"x-fern-type-hint": "decimal"
}
},
"required": [
"name",
"rate"
],
"type": "object"
}
}
}