{"openapi":"3.0.4","info":{"title":"Payment API (processor)","termsOfService":"http://www.payra.com/terms","contact":{"name":"PAYRA","url":"http://payra.com/"},"version":"1.0","description":"Single OpenAPI surface for payment operations: ACH and card share these routes (for example `/v1/transactions`, `/v1/tokens`). Which rails are enabled follows your merchant contract."},"paths":{"/v1/accounts/{key}":{"get":{"tags":["Accounts"],"summary":"Gets the status of an account. (Deprecated)","description":"This endpoint is deprecated. Please use the other version of this endpoint.\r\nThis endpoint can be called two different ways - \r\n1. Server-side with a key and secret to get details of each account individually. This would be used server-side to synchronize data between this API and the platform.\r\n2. Client-side with only the accountKey in the header and route. This would be used client-side to dynamically generate a payment form.","parameters":[{"name":"accountKey","in":"header","description":"The unique key for the account.","schema":{"type":"string"}},{"name":"key","in":"path","description":"The unique key for the account.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"text/plain; x-api-version=1.0":{"schema":{"$ref":"#/components/schemas/GetAccountResponse"}},"application/json; x-api-version=1.0":{"schema":{"$ref":"#/components/schemas/GetAccountResponse"}},"text/json; x-api-version=1.0":{"schema":{"$ref":"#/components/schemas/GetAccountResponse"}}}},"404":{"description":"Not Found"}},"deprecated":true,"security":[{"basic":[]}],"servers":[{"url":"https://paymentsapisandbox.payra.com","description":"Payment processor API (`/v1/...`): same surface for ACH and card (tokens, transactions, accounts, payer fees, and related operations)."}]},"servers":[{"url":"https://paymentsapisandbox.payra.com","description":"Payment processor API (`/v1/...`): same surface for ACH and card (tokens, transactions, accounts, payer fees, and related operations)."}]},"/v1/accounts":{"get":{"tags":["Accounts"],"summary":"Gets the status of an account.","description":"This endpoint can be called two different ways - \r\n1. Server-side with a key and secret to get details of each account individually. This would be used server-side to synchronize data between this API and the platform.\r\n2. Client-side with only the accountKey in the header and route. This would be used client-side to dynamically generate a payment form.","parameters":[{"name":"accountKey","in":"header","description":"The unique key for the account.","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"text/plain; x-api-version=1.0":{"schema":{"$ref":"#/components/schemas/GetAccountResponse"}},"application/json; x-api-version=1.0":{"schema":{"$ref":"#/components/schemas/GetAccountResponse"}},"text/json; x-api-version=1.0":{"schema":{"$ref":"#/components/schemas/GetAccountResponse"}}}},"404":{"description":"Not Found"}},"security":[{"basic":[]}],"servers":[{"url":"https://paymentsapisandbox.payra.com","description":"Payment processor API (`/v1/...`): same surface for ACH and card (tokens, transactions, accounts, payer fees, and related operations)."}]},"servers":[{"url":"https://paymentsapisandbox.payra.com","description":"Payment processor API (`/v1/...`): same surface for ACH and card (tokens, transactions, accounts, payer fees, and related operations)."}]},"/v1/accountValidations":{"post":{"tags":["AccountValidations"],"summary":"Validates a payment method's account details.","parameters":[{"name":"accountKey","in":"header","description":"Used to make API calls on behalf of another account.","schema":{"type":"string"}},{"name":"culture","in":"header","description":"The culture to be used when setting the language for error messages.","schema":{"type":"string"}}],"requestBody":{"description":"Details of the account to be validated.","content":{"application/json; x-api-version=1.0":{"schema":{"$ref":"#/components/schemas/PostAccountValidationRequest"}},"text/json; x-api-version=1.0":{"schema":{"$ref":"#/components/schemas/PostAccountValidationRequest"}},"application/*+json; x-api-version=1.0":{"schema":{"$ref":"#/components/schemas/PostAccountValidationRequest"}}}},"responses":{"200":{"description":"The payment method is valid.","content":{"text/plain; x-api-version=1.0":{"schema":{"$ref":"#/components/schemas/PostAccountValidationResponse"}},"application/json; x-api-version=1.0":{"schema":{"$ref":"#/components/schemas/PostAccountValidationResponse"}},"text/json; x-api-version=1.0":{"schema":{"$ref":"#/components/schemas/PostAccountValidationResponse"}}}}},"security":[{"basic":[]}],"servers":[{"url":"https://paymentsapisandbox.payra.com","description":"Payment processor API (`/v1/...`): same surface for ACH and card (tokens, transactions, accounts, payer fees, and related operations)."}]},"servers":[{"url":"https://paymentsapisandbox.payra.com","description":"Payment processor API (`/v1/...`): same surface for ACH and card (tokens, transactions, accounts, payer fees, and related operations)."}]},"/v1/applicationSessions":{"post":{"tags":["ApplicationSessions"],"summary":"Creates a application session.","requestBody":{"description":"Details to pre-fill the sign up form.","content":{"application/json; x-api-version=1.0":{"schema":{"$ref":"#/components/schemas/PostApplicationSessionRequest"}},"text/json; x-api-version=1.0":{"schema":{"$ref":"#/components/schemas/PostApplicationSessionRequest"}},"application/*+json; x-api-version=1.0":{"schema":{"$ref":"#/components/schemas/PostApplicationSessionRequest"}}}},"responses":{"201":{"description":"Created","content":{"text/plain; x-api-version=1.0":{"schema":{"$ref":"#/components/schemas/PostApplicationSessionResponse"}},"application/json; x-api-version=1.0":{"schema":{"$ref":"#/components/schemas/PostApplicationSessionResponse"}},"text/json; x-api-version=1.0":{"schema":{"$ref":"#/components/schemas/PostApplicationSessionResponse"}}}}},"security":[{"basic":[]}],"servers":[{"url":"https://paymentsapisandbox.payra.com","description":"Payment processor API (`/v1/...`): same surface for ACH and card (tokens, transactions, accounts, payer fees, and related operations)."}]},"servers":[{"url":"https://paymentsapisandbox.payra.com","description":"Payment processor API (`/v1/...`): same surface for ACH and card (tokens, transactions, accounts, payer fees, and related operations)."}]},"/v1/batches/{id}":{"get":{"tags":["Batches"],"summary":"Gets the summary details of a single batch.","parameters":[{"name":"id","in":"path","description":"The unique identifier of the batch.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"accountKey","in":"header","description":"Used to make API calls on behalf of another account.","schema":{"type":"string"}},{"name":"culture","in":"header","description":"The culture to be used when setting the language for error messages.","schema":{"type":"string"}}],"responses":{"200":{"description":"The batch was found and the details are in the response body.","content":{"text/plain; x-api-version=1.0":{"schema":{"$ref":"#/components/schemas/GetBatchResponse"}},"application/json; x-api-version=1.0":{"schema":{"$ref":"#/components/schemas/GetBatchResponse"}},"text/json; x-api-version=1.0":{"schema":{"$ref":"#/components/schemas/GetBatchResponse"}}}},"404":{"description":"The batch could not be found."}},"security":[{"basic":[]}],"servers":[{"url":"https://paymentsapisandbox.payra.com","description":"Payment processor API (`/v1/...`): same surface for ACH and card (tokens, transactions, accounts, payer fees, and related operations)."}]},"servers":[{"url":"https://paymentsapisandbox.payra.com","description":"Payment processor API (`/v1/...`): same surface for ACH and card (tokens, transactions, accounts, payer fees, and related operations)."}]},"/v1/batches":{"get":{"tags":["Batches"],"summary":"Returns a list of batches.","parameters":[{"name":"accountKey","in":"header","description":"Used to make API calls on behalf of another account.","schema":{"type":"string"}},{"name":"culture","in":"header","description":"The culture to be used when setting the language for error messages.","schema":{"type":"string"}},{"name":"page","in":"query","description":"The current page of the search results starting at 1.","schema":{"type":"integer","format":"int32","default":1}},{"name":"pageSize","in":"query","description":"The number of records per page. The default is 25 and the maximum is 50.","schema":{"type":"integer","format":"int32","default":25}}],"responses":{"200":{"description":"OK","content":{"text/plain; x-api-version=1.0":{"schema":{"$ref":"#/components/schemas/GetBatchResponseSearchResults"}},"application/json; x-api-version=1.0":{"schema":{"$ref":"#/components/schemas/GetBatchResponseSearchResults"}},"text/json; x-api-version=1.0":{"schema":{"$ref":"#/components/schemas/GetBatchResponseSearchResults"}}}}},"security":[{"basic":[]}],"servers":[{"url":"https://paymentsapisandbox.payra.com","description":"Payment processor API (`/v1/...`): same surface for ACH and card (tokens, transactions, accounts, payer fees, and related operations)."}]},"servers":[{"url":"https://paymentsapisandbox.payra.com","description":"Payment processor API (`/v1/...`): same surface for ACH and card (tokens, transactions, accounts, payer fees, and related operations)."}]},"/v1/checks/files/{transactionFileCategory}":{"post":{"tags":["Checks"],"summary":"Accepts a check file (typically in the form of an image) to be used in validation and further processing.","parameters":[{"name":"transactionFileCategory","in":"path","description":"The category of file being uploaded (e.g. Front of Check).","required":true,"schema":{"$ref":"#/components/schemas/TransactionFileCategory"}},{"name":"accountKey","in":"header","description":"Used to make API calls on behalf of another account.","schema":{"type":"string"}},{"name":"culture","in":"header","description":"The culture to be used when setting the language for error messages.","schema":{"type":"string"}}],"requestBody":{"content":{"multipart/form-data; x-api-version=1.0":{"schema":{"type":"object","properties":{"file":{"type":"string","description":"The byte array of the file being uploaded.","format":"binary"}}},"encoding":{"file":{"style":"form"}}}}},"responses":{"201":{"description":"The response represents the newly created check file identifier.","content":{"text/plain; x-api-version=1.0":{"schema":{"$ref":"#/components/schemas/PostCheckFileResponse"}},"application/json; x-api-version=1.0":{"schema":{"$ref":"#/components/schemas/PostCheckFileResponse"}},"text/json; x-api-version=1.0":{"schema":{"$ref":"#/components/schemas/PostCheckFileResponse"}}}},"400":{"description":"The file was not created successfully. Error messages can be found in the body of the response.","content":{"text/plain; x-api-version=1.0":{"schema":{"$ref":"#/components/schemas/ValidationProblemDetails"}},"application/json; x-api-version=1.0":{"schema":{"$ref":"#/components/schemas/ValidationProblemDetails"}},"text/json; x-api-version=1.0":{"schema":{"$ref":"#/components/schemas/ValidationProblemDetails"}}}}},"security":[{"basic":[]}],"servers":[{"url":"https://paymentsapisandbox.payra.com","description":"Payment processor API (`/v1/...`): same surface for ACH and card (tokens, transactions, accounts, payer fees, and related operations)."}]},"servers":[{"url":"https://paymentsapisandbox.payra.com","description":"Payment processor API (`/v1/...`): same surface for ACH and card (tokens, transactions, accounts, payer fees, and related operations)."}]},"/v1/checks/validate":{"post":{"tags":["Checks"],"summary":"Validates the previously uploaded files.","parameters":[{"name":"accountKey","in":"header","description":"Used to make API calls on behalf of another account.","schema":{"type":"string"}},{"name":"culture","in":"header","description":"The culture to be used when setting the language for error messages.","schema":{"type":"string"}}],"requestBody":{"description":"Contains the list of file identifiers to be validated. The front and back images of the check must be included in this request.","content":{"application/json; x-api-version=1.0":{"schema":{"$ref":"#/components/schemas/PostCheckValidateRequest"}},"text/json; x-api-version=1.0":{"schema":{"$ref":"#/components/schemas/PostCheckValidateRequest"}},"application/*+json; x-api-version=1.0":{"schema":{"$ref":"#/components/schemas/PostCheckValidateRequest"}}}},"responses":{"200":{"description":"The validation was successful and the response contains details from the scanned check.","content":{"text/plain; x-api-version=1.0":{"schema":{"$ref":"#/components/schemas/PostCheckValidateResponse"}},"application/json; x-api-version=1.0":{"schema":{"$ref":"#/components/schemas/PostCheckValidateResponse"}},"text/json; x-api-version=1.0":{"schema":{"$ref":"#/components/schemas/PostCheckValidateResponse"}}}},"400":{"description":"The session was not created successfully. Error messages can be found in the body of the response.","content":{"text/plain; x-api-version=1.0":{"schema":{"$ref":"#/components/schemas/ValidationProblemDetails"}},"application/json; x-api-version=1.0":{"schema":{"$ref":"#/components/schemas/ValidationProblemDetails"}},"text/json; x-api-version=1.0":{"schema":{"$ref":"#/components/schemas/ValidationProblemDetails"}}}}},"security":[{"basic":[]}],"servers":[{"url":"https://paymentsapisandbox.payra.com","description":"Payment processor API (`/v1/...`): same surface for ACH and card (tokens, transactions, accounts, payer fees, and related operations)."}]},"servers":[{"url":"https://paymentsapisandbox.payra.com","description":"Payment processor API (`/v1/...`): same surface for ACH and card (tokens, transactions, accounts, payer fees, and related operations)."}]},"/v1/customers":{"put":{"tags":["Customers"],"summary":"Performs a full replacement of customers for this account.","parameters":[{"name":"accountKey","in":"header","description":"Used to make API calls on behalf of another account.","schema":{"type":"string"}},{"name":"culture","in":"header","description":"The culture to be used when setting the language for error messages.","schema":{"type":"string"}}],"requestBody":{"description":"Contains a collection of customers.","content":{"application/json; x-api-version=1.0":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Customer"}}},"text/json; x-api-version=1.0":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Customer"}}},"application/*+json; x-api-version=1.0":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Customer"}}}}},"responses":{"202":{"description":"The customers were accepted for storage."},"400":{"description":"The customers were not saved successfully. Error messages can be found in the body of the response.","content":{"text/plain; x-api-version=1.0":{"schema":{"$ref":"#/components/schemas/ValidationProblemDetails"}},"application/json; x-api-version=1.0":{"schema":{"$ref":"#/components/schemas/ValidationProblemDetails"}},"text/json; x-api-version=1.0":{"schema":{"$ref":"#/components/schemas/ValidationProblemDetails"}}}}},"security":[{"basic":[]}],"servers":[{"url":"https://paymentsapisandbox.payra.com","description":"Payment processor API (`/v1/...`): same surface for ACH and card (tokens, transactions, accounts, payer fees, and related operations)."}]},"post":{"tags":["Customers"],"summary":"Saves customers to the data store using inserts and updates based on the Id property of each customer. No deletions occur as a part of this operation.","parameters":[{"name":"accountKey","in":"header","description":"Used to make API calls on behalf of another account.","schema":{"type":"string"}},{"name":"culture","in":"header","description":"The culture to be used when setting the language for error messages.","schema":{"type":"string"}}],"requestBody":{"description":"Contains a collection of customers.","content":{"application/json; x-api-version=1.0":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Customer"}}},"text/json; x-api-version=1.0":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Customer"}}},"application/*+json; x-api-version=1.0":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Customer"}}}}},"responses":{"200":{"description":"The customers were processed for updates and inserts."},"400":{"description":"The customers were not saved successfully. Error messages can be found in the body of the response.","content":{"text/plain; x-api-version=1.0":{"schema":{"$ref":"#/components/schemas/ValidationProblemDetails"}},"application/json; x-api-version=1.0":{"schema":{"$ref":"#/components/schemas/ValidationProblemDetails"}},"text/json; x-api-version=1.0":{"schema":{"$ref":"#/components/schemas/ValidationProblemDetails"}}}}},"security":[{"basic":[]}],"servers":[{"url":"https://paymentsapisandbox.payra.com","description":"Payment processor API (`/v1/...`): same surface for ACH and card (tokens, transactions, accounts, payer fees, and related operations)."}]},"servers":[{"url":"https://paymentsapisandbox.payra.com","description":"Payment processor API (`/v1/...`): same surface for ACH and card (tokens, transactions, accounts, payer fees, and related operations)."}]},"/v1/customers/{id}":{"delete":{"tags":["Customers"],"summary":"Deletes an individual customer.","parameters":[{"name":"id","in":"path","description":"The unique identifier for the customer.","required":true,"schema":{"type":"string"}},{"name":"accountKey","in":"header","description":"Used to make API calls on behalf of another account.","schema":{"type":"string"}},{"name":"culture","in":"header","description":"The culture to be used when setting the language for error messages.","schema":{"type":"string"}}],"responses":{"204":{"description":"The customer was deleted."}},"security":[{"basic":[]}],"servers":[{"url":"https://paymentsapisandbox.payra.com","description":"Payment processor API (`/v1/...`): same surface for ACH and card (tokens, transactions, accounts, payer fees, and related operations)."}]},"servers":[{"url":"https://paymentsapisandbox.payra.com","description":"Payment processor API (`/v1/...`): same surface for ACH and card (tokens, transactions, accounts, payer fees, and related operations)."}]},"/v1/invoices":{"put":{"tags":["Invoices"],"summary":"Performs a full replacement of invoices for this account.","parameters":[{"name":"accountKey","in":"header","description":"Used to make API calls on behalf of another account.","schema":{"type":"string"}},{"name":"culture","in":"header","description":"The culture to be used when setting the language for error messages.","schema":{"type":"string"}}],"requestBody":{"description":"Contains a collection of invoices.","content":{"application/json; x-api-version=1.0":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Invoice"}}},"text/json; x-api-version=1.0":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Invoice"}}},"application/*+json; x-api-version=1.0":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Invoice"}}}}},"responses":{"202":{"description":"The invoices were accepted for storage."},"400":{"description":"The invoices were not saved successfully. Error messages can be found in the body of the response.","content":{"text/plain; x-api-version=1.0":{"schema":{"$ref":"#/components/schemas/ValidationProblemDetails"}},"application/json; x-api-version=1.0":{"schema":{"$ref":"#/components/schemas/ValidationProblemDetails"}},"text/json; x-api-version=1.0":{"schema":{"$ref":"#/components/schemas/ValidationProblemDetails"}}}}},"security":[{"basic":[]}],"servers":[{"url":"https://paymentsapisandbox.payra.com","description":"Payment processor API (`/v1/...`): same surface for ACH and card (tokens, transactions, accounts, payer fees, and related operations)."}]},"post":{"tags":["Invoices"],"summary":"Saves invoices to the data store using inserts and updates based on the Id property of each invoice. No deletions occur as a part of this operation.","parameters":[{"name":"accountKey","in":"header","description":"Used to make API calls on behalf of another account.","schema":{"type":"string"}},{"name":"culture","in":"header","description":"The culture to be used when setting the language for error messages.","schema":{"type":"string"}}],"requestBody":{"description":"Contains a collection of invoices.","content":{"application/json; x-api-version=1.0":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Invoice"}}},"text/json; x-api-version=1.0":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Invoice"}}},"application/*+json; x-api-version=1.0":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Invoice"}}}}},"responses":{"200":{"description":"The invoices were processed for updates and inserts."},"400":{"description":"The invoices were not saved successfully. Error messages can be found in the body of the response.","content":{"text/plain; x-api-version=1.0":{"schema":{"$ref":"#/components/schemas/ValidationProblemDetails"}},"application/json; x-api-version=1.0":{"schema":{"$ref":"#/components/schemas/ValidationProblemDetails"}},"text/json; x-api-version=1.0":{"schema":{"$ref":"#/components/schemas/ValidationProblemDetails"}}}}},"security":[{"basic":[]}],"servers":[{"url":"https://paymentsapisandbox.payra.com","description":"Payment processor API (`/v1/...`): same surface for ACH and card (tokens, transactions, accounts, payer fees, and related operations)."}]},"servers":[{"url":"https://paymentsapisandbox.payra.com","description":"Payment processor API (`/v1/...`): same surface for ACH and card (tokens, transactions, accounts, payer fees, and related operations)."}]},"/v1/invoices/{id}":{"delete":{"tags":["Invoices"],"summary":"Deletes an individual invoice.","parameters":[{"name":"id","in":"path","description":"The unique identifier for the invoice.","required":true,"schema":{"type":"string"}},{"name":"accountKey","in":"header","description":"Used to make API calls on behalf of another account.","schema":{"type":"string"}},{"name":"culture","in":"header","description":"The culture to be used when setting the language for error messages.","schema":{"type":"string"}}],"responses":{"204":{"description":"The invoice was deleted."}},"security":[{"basic":[]}],"servers":[{"url":"https://paymentsapisandbox.payra.com","description":"Payment processor API (`/v1/...`): same surface for ACH and card (tokens, transactions, accounts, payer fees, and related operations)."}]},"servers":[{"url":"https://paymentsapisandbox.payra.com","description":"Payment processor API (`/v1/...`): same surface for ACH and card (tokens, transactions, accounts, payer fees, and related operations)."}]},"/v1/payerFees":{"get":{"tags":["PayerFees"],"summary":"Calculates the payer fees so the fees can be displayed to a user prior to payment.","parameters":[{"name":"amount","in":"query","description":"The amount of the payment from which to calculate the payer fees.","schema":{"type":"number","format":"double"}},{"name":"cardNumber","in":"query","description":"The card number to calculate the payer fees. This is useful when calculating payer fees based on compliant surcharging rules. The card token Id should be null if this value is passed in.","schema":{"type":"string"}},{"name":"tokenId","in":"query","description":"The token identifier for the card. The card number should be null if this value is passed in.","schema":{"type":"string"}},{"name":"accountKey","in":"header","description":"Used to make API calls on behalf of another account.","schema":{"type":"string"}},{"name":"culture","in":"header","description":"The culture to be used when setting the language for error messages.","schema":{"type":"string"}}],"responses":{"200":{"description":"The payer fees were calculated and are in the response body.","content":{"text/plain; x-api-version=1.0":{"schema":{"$ref":"#/components/schemas/GetPayerFeesResponse"}},"application/json; x-api-version=1.0":{"schema":{"$ref":"#/components/schemas/GetPayerFeesResponse"}},"text/json; x-api-version=1.0":{"schema":{"$ref":"#/components/schemas/GetPayerFeesResponse"}}}}},"security":[{"basic":[]}],"servers":[{"url":"https://paymentsapisandbox.payra.com","description":"Payment processor API (`/v1/...`): same surface for ACH and card (tokens, transactions, accounts, payer fees, and related operations)."}]},"servers":[{"url":"https://paymentsapisandbox.payra.com","description":"Payment processor API (`/v1/...`): same surface for ACH and card (tokens, transactions, accounts, payer fees, and related operations)."}]},"/v1/terminals":{"get":{"tags":["Terminals"],"summary":"Returns the list of terminals","parameters":[{"name":"accountKey","in":"header","description":"Used to make API calls on behalf of another account.","schema":{"type":"string"}},{"name":"culture","in":"header","description":"The culture to be used when setting the language for error messages.","schema":{"type":"string"}},{"name":"page","in":"query","description":"The current page of the search results starting at 1.","schema":{"type":"integer","format":"int32","default":1}},{"name":"pageSize","in":"query","description":"The number of records per page. The default is 25 and the maximum is 50.","schema":{"type":"integer","format":"int32","default":25}}],"responses":{"200":{"description":"OK","content":{"text/plain; x-api-version=1.0":{"schema":{"$ref":"#/components/schemas/GetTransactionResponseSearchResults"}},"application/json; x-api-version=1.0":{"schema":{"$ref":"#/components/schemas/GetTransactionResponseSearchResults"}},"text/json; x-api-version=1.0":{"schema":{"$ref":"#/components/schemas/GetTransactionResponseSearchResults"}}}}},"security":[{"basic":[]}],"servers":[{"url":"https://paymentsapisandbox.payra.com","description":"Payment processor API (`/v1/...`): same surface for ACH and card (tokens, transactions, accounts, payer fees, and related operations)."}]},"servers":[{"url":"https://paymentsapisandbox.payra.com","description":"Payment processor API (`/v1/...`): same surface for ACH and card (tokens, transactions, accounts, payer fees, and related operations)."}]},"/v1/terminalSessions":{"post":{"tags":["TerminalSessions"],"summary":"Initiates a terminal session for the payer to complete a payment.","parameters":[{"name":"accountKey","in":"header","description":"Used to make API calls on behalf of another account.","schema":{"type":"string"}},{"name":"culture","in":"header","description":"The culture to be used when setting the language for error messages.","schema":{"type":"string"}}],"requestBody":{"description":"Contains the information for the payer to be presented with a payment.","content":{"application/json; x-api-version=1.0":{"schema":{"$ref":"#/components/schemas/PostTerminalSessionRequest"}},"text/json; x-api-version=1.0":{"schema":{"$ref":"#/components/schemas/PostTerminalSessionRequest"}},"application/*+json; x-api-version=1.0":{"schema":{"$ref":"#/components/schemas/PostTerminalSessionRequest"}}}},"responses":{"201":{"description":"The response represents the newly created request to the terminal with an identifier to the new terminal session. Any error, if any, will be in the error message property."},"400":{"description":"The payment was not created successfully. Error messages can be found in the body of the response.","content":{"text/plain; x-api-version=1.0":{"schema":{"$ref":"#/components/schemas/ValidationProblemDetails"}},"application/json; x-api-version=1.0":{"schema":{"$ref":"#/components/schemas/ValidationProblemDetails"}},"text/json; x-api-version=1.0":{"schema":{"$ref":"#/components/schemas/ValidationProblemDetails"}}}}},"security":[{"basic":[]}],"servers":[{"url":"https://paymentsapisandbox.payra.com","description":"Payment processor API (`/v1/...`): same surface for ACH and card (tokens, transactions, accounts, payer fees, and related operations)."}]},"servers":[{"url":"https://paymentsapisandbox.payra.com","description":"Payment processor API (`/v1/...`): same surface for ACH and card (tokens, transactions, accounts, payer fees, and related operations)."}]},"/v1/terminalSessions/{id}/cancel":{"post":{"tags":["TerminalSessions"],"summary":"Cancels the terminal session.","parameters":[{"name":"id","in":"path","description":"The unique identifier for the session.","required":true,"schema":{"type":"string"}},{"name":"accountKey","in":"header","description":"Used to make API calls on behalf of another account.","schema":{"type":"string"}},{"name":"culture","in":"header","description":"The culture to be used when setting the language for error messages.","schema":{"type":"string"}}],"responses":{"202":{"description":"The session has been cancelled successfully."},"400":{"description":"The payment was not created successfully. Error messages can be found in the body of the response.","content":{"text/plain; x-api-version=1.0":{"schema":{"$ref":"#/components/schemas/ValidationProblemDetails"}},"application/json; x-api-version=1.0":{"schema":{"$ref":"#/components/schemas/ValidationProblemDetails"}},"text/json; x-api-version=1.0":{"schema":{"$ref":"#/components/schemas/ValidationProblemDetails"}}}}},"security":[{"basic":[]}],"servers":[{"url":"https://paymentsapisandbox.payra.com","description":"Payment processor API (`/v1/...`): same surface for ACH and card (tokens, transactions, accounts, payer fees, and related operations)."}]},"servers":[{"url":"https://paymentsapisandbox.payra.com","description":"Payment processor API (`/v1/...`): same surface for ACH and card (tokens, transactions, accounts, payer fees, and related operations)."}]},"/v1/terminalSessions/{id}":{"get":{"tags":["TerminalSessions"],"summary":"Gets detailed information on a single terminal session.","parameters":[{"name":"id","in":"path","description":"The unique identifier of the terminal session.","required":true,"schema":{"type":"string"}},{"name":"accountKey","in":"header","description":"Used to make API calls on behalf of another account.","schema":{"type":"string"}},{"name":"culture","in":"header","description":"The culture to be used when setting the language for error messages.","schema":{"type":"string"}}],"responses":{"200":{"description":"The terminal session was found and the details are in the response body. All account numbers will be masked.","content":{"text/plain; x-api-version=1.0":{"schema":{"$ref":"#/components/schemas/GetTerminalSessionResponse"}},"application/json; x-api-version=1.0":{"schema":{"$ref":"#/components/schemas/GetTerminalSessionResponse"}},"text/json; x-api-version=1.0":{"schema":{"$ref":"#/components/schemas/GetTerminalSessionResponse"}}}},"404":{"description":"The terminal session could not be found."}},"security":[{"basic":[]}],"servers":[{"url":"https://paymentsapisandbox.payra.com","description":"Payment processor API (`/v1/...`): same surface for ACH and card (tokens, transactions, accounts, payer fees, and related operations)."}]},"servers":[{"url":"https://paymentsapisandbox.payra.com","description":"Payment processor API (`/v1/...`): same surface for ACH and card (tokens, transactions, accounts, payer fees, and related operations)."}]},"/v1/tokens/{id}":{"get":{"tags":["Tokens"],"summary":"Gets the masked details of a saved payment token.","parameters":[{"name":"id","in":"path","description":"The unique identifier of the token.","required":true,"schema":{"type":"string"}},{"name":"accountKey","in":"header","description":"Used to make API calls on behalf of another account.","schema":{"type":"string"}},{"name":"culture","in":"header","description":"The culture to be used when setting the language for error messages.","schema":{"type":"string"}}],"responses":{"200":{"description":"The token was found and the details are in the response body. All account numbers will be masked.","content":{"text/plain; x-api-version=1.0":{"schema":{"$ref":"#/components/schemas/GetTokenResponse"}},"application/json; x-api-version=1.0":{"schema":{"$ref":"#/components/schemas/GetTokenResponse"}},"text/json; x-api-version=1.0":{"schema":{"$ref":"#/components/schemas/GetTokenResponse"}}}},"404":{"description":"The token could not be found."}},"security":[{"basic":[]}],"servers":[{"url":"https://paymentsapisandbox.payra.com","description":"Payment processor API (`/v1/...`): same surface for ACH and card (tokens, transactions, accounts, payer fees, and related operations)."}]},"delete":{"tags":["Tokens"],"summary":"Deletes a saved payment method. This will not impact any transactions that are already in process with this token.","parameters":[{"name":"id","in":"path","description":"The unique identifier of the token.","required":true,"schema":{"type":"string"}},{"name":"accountKey","in":"header","description":"Used to make API calls on behalf of another account.","schema":{"type":"string"}},{"name":"culture","in":"header","description":"The culture to be used when setting the language for error messages.","schema":{"type":"string"}}],"responses":{"200":{"description":"The token was deleted successfully."},"404":{"description":"The token could not be found."}},"security":[{"basic":[]}],"servers":[{"url":"https://paymentsapisandbox.payra.com","description":"Payment processor API (`/v1/...`): same surface for ACH and card (tokens, transactions, accounts, payer fees, and related operations)."}]},"servers":[{"url":"https://paymentsapisandbox.payra.com","description":"Payment processor API (`/v1/...`): same surface for ACH and card (tokens, transactions, accounts, payer fees, and related operations)."}]},"/v1/tokens":{"post":{"tags":["Tokens"],"summary":"Saves a payment method as a token for later use.","parameters":[{"name":"accountKey","in":"header","description":"Used to make API calls on behalf of another account.","schema":{"type":"string"}},{"name":"culture","in":"header","description":"The culture to be used when setting the language for error messages.","schema":{"type":"string"}}],"requestBody":{"description":"Contains payment information to be stored.","content":{"application/json; x-api-version=1.0":{"schema":{"$ref":"#/components/schemas/PostTokenRequest"}},"text/json; x-api-version=1.0":{"schema":{"$ref":"#/components/schemas/PostTokenRequest"}},"application/*+json; x-api-version=1.0":{"schema":{"$ref":"#/components/schemas/PostTokenRequest"}}}},"responses":{"201":{"description":"The token was created successfully. The Id for the new token is in the body of the response.","content":{"text/plain; x-api-version=1.0":{"schema":{"$ref":"#/components/schemas/GetTokenResponse"}},"application/json; x-api-version=1.0":{"schema":{"$ref":"#/components/schemas/GetTokenResponse"}},"text/json; x-api-version=1.0":{"schema":{"$ref":"#/components/schemas/GetTokenResponse"}}}},"400":{"description":"The token was not created successfully. Error messages can be found in the body of the response.","content":{"text/plain; x-api-version=1.0":{"schema":{"$ref":"#/components/schemas/ValidationProblemDetails"}},"application/json; x-api-version=1.0":{"schema":{"$ref":"#/components/schemas/ValidationProblemDetails"}},"text/json; x-api-version=1.0":{"schema":{"$ref":"#/components/schemas/ValidationProblemDetails"}}}}},"security":[{"basic":[]}],"servers":[{"url":"https://paymentsapisandbox.payra.com","description":"Payment processor API (`/v1/...`): same surface for ACH and card (tokens, transactions, accounts, payer fees, and related operations)."}]},"servers":[{"url":"https://paymentsapisandbox.payra.com","description":"Payment processor API (`/v1/...`): same surface for ACH and card (tokens, transactions, accounts, payer fees, and related operations)."}]},"/v1/transactions/{id}":{"get":{"tags":["Transactions"],"summary":"Gets detailed information on a single transaction.","parameters":[{"name":"id","in":"path","description":"The unique identifier of the transaction.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"accountKey","in":"header","description":"Used to make API calls on behalf of another account.","schema":{"type":"string"}},{"name":"culture","in":"header","description":"The culture to be used when setting the language for error messages.","schema":{"type":"string"}}],"responses":{"200":{"description":"The transaction was found and the details are in the response body. All account numbers will be masked.","content":{"text/plain; x-api-version=1.0":{"schema":{"$ref":"#/components/schemas/GetTransactionResponse"}},"application/json; x-api-version=1.0":{"schema":{"$ref":"#/components/schemas/GetTransactionResponse"}},"text/json; x-api-version=1.0":{"schema":{"$ref":"#/components/schemas/GetTransactionResponse"}}}},"404":{"description":"The transaction could not be found."}},"security":[{"basic":[]}],"servers":[{"url":"https://paymentsapisandbox.payra.com","description":"Payment processor API (`/v1/...`): same surface for ACH and card (tokens, transactions, accounts, payer fees, and related operations)."}]},"servers":[{"url":"https://paymentsapisandbox.payra.com","description":"Payment processor API (`/v1/...`): same surface for ACH and card (tokens, transactions, accounts, payer fees, and related operations)."}]},"/v1/transactions":{"get":{"tags":["Transactions"],"summary":"Returns a list of transactions that match the search criteria.","parameters":[{"name":"accountKey","in":"header","description":"Used to make API calls on behalf of another account.","schema":{"type":"string"}},{"name":"culture","in":"header","description":"The culture to be used when setting the language for error messages.","schema":{"type":"string"}},{"name":"batchId","in":"query","description":"Filter for transactions in a given batch.","schema":{"type":"integer","format":"int64"}},{"name":"transactionEventType","in":"query","description":"Filter by the type of event that initiated the transaction. If used in \r\n            conjunction with the begin date and/or end date, this will filter by the date associated with that event. For example,\r\n            specifying an event type of Refund as well as dates would filter for transactions that were refunded in that date range.","schema":{"$ref":"#/components/schemas/TransactionEventType"}},{"name":"paymentMethodType","in":"query","description":"Filter by payment method type.","schema":{"$ref":"#/components/schemas/PaymentMethodType"}},{"name":"beginDate","in":"query","description":"The first date by which to filter.","schema":{"type":"string","format":"date-time"}},{"name":"endDate","in":"query","description":"The last date by which to filter.","schema":{"type":"string","format":"date-time"}},{"name":"page","in":"query","description":"The current page of the search results starting at 1.","schema":{"type":"integer","format":"int32","default":1}},{"name":"pageSize","in":"query","description":"The number of records per page. The default is 25 and the maximum is 50.","schema":{"type":"integer","format":"int32","default":25}}],"responses":{"200":{"description":"OK","content":{"text/plain; x-api-version=1.0":{"schema":{"$ref":"#/components/schemas/GetTransactionResponseSearchResults"}},"application/json; x-api-version=1.0":{"schema":{"$ref":"#/components/schemas/GetTransactionResponseSearchResults"}},"text/json; x-api-version=1.0":{"schema":{"$ref":"#/components/schemas/GetTransactionResponseSearchResults"}}}}},"security":[{"basic":[]}],"servers":[{"url":"https://paymentsapisandbox.payra.com","description":"Payment processor API (`/v1/...`): same surface for ACH and card (tokens, transactions, accounts, payer fees, and related operations)."}]},"servers":[{"url":"https://paymentsapisandbox.payra.com","description":"Payment processor API (`/v1/...`): same surface for ACH and card (tokens, transactions, accounts, payer fees, and related operations)."}]},"/v1/transactions/pay":{"post":{"tags":["Transactions"],"summary":"Attempts to initiate a payment using a specified payment method. This operation runs an authorization and capture on card transactions.","parameters":[{"name":"accountKey","in":"header","description":"Used to make API calls on behalf of another account.","schema":{"type":"string"}},{"name":"culture","in":"header","description":"The culture to be used when setting the language for error messages.","schema":{"type":"string"}}],"requestBody":{"description":"The payment details required to initiate the transaction.","content":{"application/json; x-api-version=1.0":{"schema":{"$ref":"#/components/schemas/PostPayRequest"}},"text/json; x-api-version=1.0":{"schema":{"$ref":"#/components/schemas/PostPayRequest"}},"application/*+json; x-api-version=1.0":{"schema":{"$ref":"#/components/schemas/PostPayRequest"}}}},"responses":{"201":{"description":"The response represents the newly created transaction. Any error, if any, will be in the error message property.","content":{"text/plain; x-api-version=1.0":{"schema":{"$ref":"#/components/schemas/GetTransactionResponse"}},"application/json; x-api-version=1.0":{"schema":{"$ref":"#/components/schemas/GetTransactionResponse"}},"text/json; x-api-version=1.0":{"schema":{"$ref":"#/components/schemas/GetTransactionResponse"}}}},"400":{"description":"The payment was not created successfully. Error messages can be found in the body of the response.","content":{"text/plain; x-api-version=1.0":{"schema":{"$ref":"#/components/schemas/ValidationProblemDetails"}},"application/json; x-api-version=1.0":{"schema":{"$ref":"#/components/schemas/ValidationProblemDetails"}},"text/json; x-api-version=1.0":{"schema":{"$ref":"#/components/schemas/ValidationProblemDetails"}}}}},"security":[{"basic":[]}],"servers":[{"url":"https://paymentsapisandbox.payra.com","description":"Payment processor API (`/v1/...`): same surface for ACH and card (tokens, transactions, accounts, payer fees, and related operations)."}]},"servers":[{"url":"https://paymentsapisandbox.payra.com","description":"Payment processor API (`/v1/...`): same surface for ACH and card (tokens, transactions, accounts, payer fees, and related operations)."}]},"/v1/transactions/authorize":{"post":{"tags":["Transactions"],"summary":"Attempts to authorize a payment using on a card.","parameters":[{"name":"accountKey","in":"header","description":"Used to make API calls on behalf of another account.","schema":{"type":"string"}},{"name":"culture","in":"header","description":"The culture to be used when setting the language for error messages.","schema":{"type":"string"}}],"requestBody":{"description":"The payment details required to authorize the transaction.","content":{"application/json; x-api-version=1.0":{"schema":{"$ref":"#/components/schemas/PostAuthorizeRequest"}},"text/json; x-api-version=1.0":{"schema":{"$ref":"#/components/schemas/PostAuthorizeRequest"}},"application/*+json; x-api-version=1.0":{"schema":{"$ref":"#/components/schemas/PostAuthorizeRequest"}}}},"responses":{"201":{"description":"The response represents the newly created transaction. Any error, if any, will be in the error message property.","content":{"text/plain; x-api-version=1.0":{"schema":{"$ref":"#/components/schemas/GetTransactionResponse"}},"application/json; x-api-version=1.0":{"schema":{"$ref":"#/components/schemas/GetTransactionResponse"}},"text/json; x-api-version=1.0":{"schema":{"$ref":"#/components/schemas/GetTransactionResponse"}}}},"400":{"description":"The authorization was not created successfully. Error messages can be found in the body of the response.","content":{"text/plain; x-api-version=1.0":{"schema":{"$ref":"#/components/schemas/ValidationProblemDetails"}},"application/json; x-api-version=1.0":{"schema":{"$ref":"#/components/schemas/ValidationProblemDetails"}},"text/json; x-api-version=1.0":{"schema":{"$ref":"#/components/schemas/ValidationProblemDetails"}}}}},"security":[{"basic":[]}],"servers":[{"url":"https://paymentsapisandbox.payra.com","description":"Payment processor API (`/v1/...`): same surface for ACH and card (tokens, transactions, accounts, payer fees, and related operations)."}]},"servers":[{"url":"https://paymentsapisandbox.payra.com","description":"Payment processor API (`/v1/...`): same surface for ACH and card (tokens, transactions, accounts, payer fees, and related operations)."}]},"/v1/transactions/{id}/capture":{"post":{"tags":["Transactions"],"summary":"Attempts to capture a payment from a previously authorized transaction.","parameters":[{"name":"id","in":"path","description":"The identifier of the previously authorized transaction.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"accountKey","in":"header","description":"Used to make API calls on behalf of another account.","schema":{"type":"string"}},{"name":"culture","in":"header","description":"The culture to be used when setting the language for error messages.","schema":{"type":"string"}}],"requestBody":{"description":"The details of the amount to be captured.","content":{"application/json; x-api-version=1.0":{"schema":{"$ref":"#/components/schemas/PostCaptureRequest"}},"text/json; x-api-version=1.0":{"schema":{"$ref":"#/components/schemas/PostCaptureRequest"}},"application/*+json; x-api-version=1.0":{"schema":{"$ref":"#/components/schemas/PostCaptureRequest"}}}},"responses":{"201":{"description":"The response represents the newly created transaction. Any error, if any, will be in the error message property.","content":{"text/plain; x-api-version=1.0":{"schema":{"$ref":"#/components/schemas/GetTransactionResponse"}},"application/json; x-api-version=1.0":{"schema":{"$ref":"#/components/schemas/GetTransactionResponse"}},"text/json; x-api-version=1.0":{"schema":{"$ref":"#/components/schemas/GetTransactionResponse"}}}},"400":{"description":"The capture transaction was not created successfully. Error messages can be found in the body of the response.","content":{"text/plain; x-api-version=1.0":{"schema":{"$ref":"#/components/schemas/ValidationProblemDetails"}},"application/json; x-api-version=1.0":{"schema":{"$ref":"#/components/schemas/ValidationProblemDetails"}},"text/json; x-api-version=1.0":{"schema":{"$ref":"#/components/schemas/ValidationProblemDetails"}}}}},"security":[{"basic":[]}],"servers":[{"url":"https://paymentsapisandbox.payra.com","description":"Payment processor API (`/v1/...`): same surface for ACH and card (tokens, transactions, accounts, payer fees, and related operations)."}]},"servers":[{"url":"https://paymentsapisandbox.payra.com","description":"Payment processor API (`/v1/...`): same surface for ACH and card (tokens, transactions, accounts, payer fees, and related operations)."}]},"/v1/transactions/{id}/void":{"post":{"tags":["Transactions"],"summary":"Attempts to void a payment. Note that voiding is only allowed on new transactions where the movement of \r\nfunds has not yet occurred.","parameters":[{"name":"id","in":"path","description":"The identifier of the transaction.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"accountKey","in":"header","description":"Used to make API calls on behalf of another account.","schema":{"type":"string"}},{"name":"culture","in":"header","description":"The culture to be used when setting the language for error messages.","schema":{"type":"string"}}],"responses":{"200":{"description":"The transaction was voided created successfully."},"400":{"description":"The transaction was not voided successfully. Error messages can be found in the body of the response.","content":{"text/plain; x-api-version=1.0":{"schema":{"$ref":"#/components/schemas/ValidationProblemDetails"}},"application/json; x-api-version=1.0":{"schema":{"$ref":"#/components/schemas/ValidationProblemDetails"}},"text/json; x-api-version=1.0":{"schema":{"$ref":"#/components/schemas/ValidationProblemDetails"}}}}},"security":[{"basic":[]}],"servers":[{"url":"https://paymentsapisandbox.payra.com","description":"Payment processor API (`/v1/...`): same surface for ACH and card (tokens, transactions, accounts, payer fees, and related operations)."}]},"servers":[{"url":"https://paymentsapisandbox.payra.com","description":"Payment processor API (`/v1/...`): same surface for ACH and card (tokens, transactions, accounts, payer fees, and related operations)."}]},"/v1/transactions/{id}/refund":{"post":{"tags":["Transactions"],"summary":"Attempts to refund a successful payment.","parameters":[{"name":"id","in":"path","description":"The identifier of the transaction to be refunded.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"accountKey","in":"header","description":"Used to make API calls on behalf of another account.","schema":{"type":"string"}},{"name":"culture","in":"header","description":"The culture to be used when setting the language for error messages.","schema":{"type":"string"}}],"requestBody":{"description":"The details of the amount to be refunded.","content":{"application/json; x-api-version=1.0":{"schema":{"$ref":"#/components/schemas/PostRefundRequest"}},"text/json; x-api-version=1.0":{"schema":{"$ref":"#/components/schemas/PostRefundRequest"}},"application/*+json; x-api-version=1.0":{"schema":{"$ref":"#/components/schemas/PostRefundRequest"}}}},"responses":{"201":{"description":"The response represents the newly created transaction. Any error, if any, will be in the error message property.","content":{"text/plain; x-api-version=1.0":{"schema":{"$ref":"#/components/schemas/GetTransactionResponse"}},"application/json; x-api-version=1.0":{"schema":{"$ref":"#/components/schemas/GetTransactionResponse"}},"text/json; x-api-version=1.0":{"schema":{"$ref":"#/components/schemas/GetTransactionResponse"}}}},"400":{"description":"The refund transaction was not created successfully. Error messages can be found in the body of the response.","content":{"text/plain; x-api-version=1.0":{"schema":{"$ref":"#/components/schemas/ValidationProblemDetails"}},"application/json; x-api-version=1.0":{"schema":{"$ref":"#/components/schemas/ValidationProblemDetails"}},"text/json; x-api-version=1.0":{"schema":{"$ref":"#/components/schemas/ValidationProblemDetails"}}}}},"security":[{"basic":[]}],"servers":[{"url":"https://paymentsapisandbox.payra.com","description":"Payment processor API (`/v1/...`): same surface for ACH and card (tokens, transactions, accounts, payer fees, and related operations)."}]},"servers":[{"url":"https://paymentsapisandbox.payra.com","description":"Payment processor API (`/v1/...`): same surface for ACH and card (tokens, transactions, accounts, payer fees, and related operations)."}]},"/v1/transactions/{id}/metadata":{"patch":{"tags":["Transactions"],"summary":"Upserts metadata values. This is only allowed for a limited time after the initial creation of the transaction record.","parameters":[{"name":"id","in":"path","description":"The identifier of the transaction to be updated.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"accountKey","in":"header","description":"Used to make API calls on behalf of another account.","schema":{"type":"string"}},{"name":"culture","in":"header","description":"The culture to be used when setting the language for error messages.","schema":{"type":"string"}}],"requestBody":{"description":"Dictionary of values to be upserted. Any value of null will remove a previously saved key.","content":{"application/json; x-api-version=1.0":{"schema":{"type":"object","additionalProperties":{"type":"string"}}},"text/json; x-api-version=1.0":{"schema":{"type":"object","additionalProperties":{"type":"string"}}},"application/*+json; x-api-version=1.0":{"schema":{"type":"object","additionalProperties":{"type":"string"}}}}},"responses":{"200":{"description":"The response represents the newly updated transaction.","content":{"text/plain; x-api-version=1.0":{"schema":{"$ref":"#/components/schemas/GetTransactionResponseSearchResults"}},"application/json; x-api-version=1.0":{"schema":{"$ref":"#/components/schemas/GetTransactionResponseSearchResults"}},"text/json; x-api-version=1.0":{"schema":{"$ref":"#/components/schemas/GetTransactionResponseSearchResults"}}}},"400":{"description":"The transaction was not updated successfully. Error messages can be found in the body of the response."}},"security":[{"basic":[]}],"servers":[{"url":"https://paymentsapisandbox.payra.com","description":"Payment processor API (`/v1/...`): same surface for ACH and card (tokens, transactions, accounts, payer fees, and related operations)."}]},"servers":[{"url":"https://paymentsapisandbox.payra.com","description":"Payment processor API (`/v1/...`): same surface for ACH and card (tokens, transactions, accounts, payer fees, and related operations)."}]}},"components":{"schemas":{"AccountProcessorCredentialStatus":{"enum":["Active","Rejected","UnderReview","InformationRequired","Closed","Other"],"type":"string"},"AccountValidationMethod":{"enum":["AccountNumber","AccountNumberAndName"],"type":"string"},"Ach":{"required":["accountNumber","bankAccountHolder","routingNumber"],"type":"object","properties":{"bankAccountHolder":{"maxLength":150,"minLength":1,"type":"string","description":"The name of the bank account holder.","example":"Acme Corporation"},"routingNumber":{"maxLength":9,"minLength":9,"type":"string","description":"The 9 digit routing number.","example":"021000021"},"bankAccountType":{"$ref":"#/components/schemas/BankAccountType"},"accountNumber":{"maxLength":17,"minLength":4,"type":"string","description":"The full account number.","example":"08292983191"}},"additionalProperties":false,"description":"The banking information used to process an ACH payment."},"Acss":{"required":["accountHolder","accountNumber","institutionNumber","transitNumber"],"type":"object","properties":{"accountHolder":{"maxLength":150,"minLength":1,"type":"string","description":"The name of the account holder.","example":"Acme Corporation"},"bankAccountType":{"$ref":"#/components/schemas/BankAccountType"},"institutionNumber":{"maxLength":3,"minLength":3,"type":"string","description":"The 3 digit institution number.","example":"001"},"transitNumber":{"maxLength":5,"minLength":5,"type":"string","description":"The 5 digit transit number.","example":"00114"},"accountNumber":{"maxLength":12,"minLength":7,"type":"string","description":"The full account number.","example":"08292983191"}},"additionalProperties":false,"description":"The banking information used to process a Canadian bank transaction."},"Address":{"type":"object","properties":{"name":{"maxLength":150,"type":"string","description":"The name at the address","nullable":true,"example":"Acme Corporation"},"streetAddress":{"maxLength":250,"type":"string","description":"The street address including the street and unit number.","nullable":true,"example":"1234 Main Street"},"city":{"maxLength":100,"type":"string","description":"The city of the address.","nullable":true,"example":"Austin"},"stateOrProvince":{"maxLength":100,"type":"string","description":"The abbreviated state or province of the address.","nullable":true,"example":"TX"},"postalCode":{"maxLength":15,"type":"string","description":"The postal code of the address.","nullable":true,"example":"78701"},"country":{"maxLength":2,"type":"string","description":"The two character country code.","nullable":true,"example":"US"},"phoneNumber":{"type":"string","description":"The phone number.","nullable":true,"example":"512-555-1234"}},"additionalProperties":false,"description":"Full address information."},"AuDirectDebit":{"required":["accountNumber","bankAccountHolder","bsb"],"type":"object","properties":{"bankAccountHolder":{"maxLength":150,"minLength":1,"type":"string","description":"The name of the account holder.","example":"Acme Corporation"},"bsb":{"maxLength":7,"minLength":7,"type":"string","description":"The BSB","example":"123-456"},"accountNumber":{"maxLength":17,"minLength":5,"type":"string","description":"The full account number.","example":"08292983191"}},"additionalProperties":false,"description":"Australian direct debit."},"Bacs":{"required":["accountNumber","bankAccountHolder","sortCode"],"type":"object","properties":{"bankAccountHolder":{"maxLength":150,"minLength":1,"type":"string","description":"The name of the account holder.","example":"Acme Corporation"},"sortCode":{"maxLength":6,"minLength":6,"type":"string","description":"The sort code.","example":"102030"},"accountNumber":{"maxLength":8,"minLength":8,"type":"string","description":"The full account number.","example":"12345678"}},"additionalProperties":false,"description":"United Kingdom direct debit."},"BankAccountType":{"enum":["PersonalSavings","PersonalChecking","CorporateSavings","CorporateChecking"],"type":"string"},"BatchFundAttempt":{"type":"object","properties":{"createDate":{"type":"string","description":"The date the fund attempt was created.","format":"date-time"},"estimatedSettlementDate":{"type":"string","description":"The estimated date of the settlement of funds.","format":"date-time","nullable":true},"status":{"$ref":"#/components/schemas/BatchFundAttemptStatus"},"returnDate":{"type":"string","description":"The return date in the event of a failure.","format":"date-time","nullable":true},"errorMessage":{"type":"string","description":"The error message in the event of a failure.","nullable":true},"errorCode":{"type":"string","description":"The specific error code in the event of a failure.","nullable":true}},"additionalProperties":false,"description":"Contains status of a batch fund attempt."},"BatchFundAttemptStatus":{"enum":["New","InProcess","Sent","Failed"],"type":"string"},"BrowserInformation":{"type":"object","properties":{"userAgent":{"type":"string","description":"The User-Agent request header value.","nullable":true,"example":"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/123.0.0.0 Safari/537.36"}},"additionalProperties":false,"description":"The information on the user's browser."},"Card":{"required":["cardHolder","cardNumber","expirationMonth","expirationYear"],"type":"object","properties":{"cardHolder":{"maxLength":150,"minLength":1,"type":"string","description":"The name of the card holder.","example":"John Smith"},"cardNumber":{"maxLength":16,"minLength":14,"type":"string","description":"The card number.","format":"credit-card","example":"4895379980003055"},"cardBrand":{"$ref":"#/components/schemas/CardBrand"},"expirationMonth":{"maximum":12,"minimum":1,"type":"integer","description":"The expiration month.","format":"int32","example":12},"expirationYear":{"type":"integer","description":"The two or four digit expiration year.","format":"int32","example":2025},"securityCode":{"type":"string","description":"The CVV/security code for the card.","nullable":true,"example":"123"}},"additionalProperties":false,"description":"The card details used to process a payment."},"CardBrand":{"enum":["Visa","Mastercard","AmericanExpress","Discover","DinersClub"],"type":"string"},"Channel":{"enum":["API","Terminal","Automated","Scan","Bank"],"type":"string"},"Check":{"required":["fileIds"],"type":"object","properties":{"checkNumber":{"maxLength":150,"type":"string","description":"The check number.","nullable":true,"example":"012345"},"routingNumber":{"maxLength":9,"minLength":9,"type":"string","description":"The 9 digit routing number.","nullable":true,"example":"021000021"},"accountNumber":{"maxLength":17,"minLength":4,"type":"string","description":"The full account number.","nullable":true,"example":"08292983191"},"fileIds":{"type":"array","items":{"type":"string"},"description":"The file Ids that were used for validation."}},"additionalProperties":false,"description":"Paper check."},"Currency":{"enum":["USD","CAD","EUR","AUD","GBP","NZD","DKK","NOK","SEK","CHF"],"type":"string"},"Customer":{"required":["amountDue","id","name"],"type":"object","properties":{"id":{"maxLength":200,"minLength":1,"type":"string","description":"The unique identifier for the customer.","example":"jsmith123"},"name":{"maxLength":150,"minLength":1,"type":"string","description":"The name of the customer.","example":"John Smith"},"phoneNumber":{"maxLength":50,"type":"string","description":"The phone number.","nullable":true,"example":"512-555-1234"},"emailAddress":{"maxLength":150,"type":"string","description":"The email address.","nullable":true,"example":"johnsmith@gmail.com"},"billingAddress":{"$ref":"#/components/schemas/Address"},"dueDate":{"type":"string","description":"The due date.","format":"date-time","nullable":true,"example":"2050-02-28"},"amountDue":{"minimum":0,"type":"number","description":"The amount due.","format":"double","example":123.45},"currency":{"$ref":"#/components/schemas/Currency"},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"A  <string, string>  dictionary of any application-specific metadata to have stored with the customer.","nullable":true,"example":{"userId":"jsmith","accountId":"123"}}},"additionalProperties":false,"description":"The customer data for specifying the the amount due on account."},"GetAccountResponse":{"type":"object","properties":{"doingBusinessAs":{"type":"string","description":"The name of the account.","nullable":true,"example":"Acme Corporation"},"platformIdentifier":{"type":"string","description":"This is used to crosswalk from dhango to the platform's system.","nullable":true,"example":"abcdef123456"},"isActive":{"type":"boolean","description":"True if processing is turned on for the account. Otherwise; false.","example":true},"processorCredentialStatuses":{"type":"array","items":{"$ref":"#/components/schemas/ProcessorCredentialStatus"},"description":"The list of processors for this account as well as the status of each one.","nullable":true},"paymentMethodProcessors":{"type":"array","items":{"$ref":"#/components/schemas/PaymentMethodProcessor"},"description":"The list of payment methods that are activated along with the payment processor.","nullable":true},"defaultCurrency":{"$ref":"#/components/schemas/Currency"},"supportedPaymentMethods":{"type":"array","items":{"$ref":"#/components/schemas/PaymentMethodType"},"description":"The supported payment methods on the account.","nullable":true}},"additionalProperties":false,"description":"Contains the status of an account."},"GetBatchResponse":{"type":"object","properties":{"id":{"type":"integer","description":"The unique identifier of the batch.","format":"int64","example":12345},"grossAmount":{"type":"number","description":"The total gross amount of the batch. This will be different than the net amount if transactions in the batch were net funded.","format":"double","example":7873.3},"netAmount":{"type":"number","description":"The total net amount deposited to or debited from the bank account.","format":"double","example":7870.1},"currency":{"$ref":"#/components/schemas/Currency"},"createDate":{"type":"string","description":"The date the batch was created (GMT).","format":"date-time","example":"6/1/2023"},"transactionCount":{"type":"integer","description":"The number of transactions in the batch.","format":"int32","example":123},"batchFundAttempts":{"type":"array","items":{"$ref":"#/components/schemas/BatchFundAttempt"},"description":"The funding attempts for the current batch.","nullable":true}},"additionalProperties":false,"description":"The summary details of a batch."},"GetBatchResponseSearchResults":{"type":"object","properties":{"records":{"type":"array","items":{"$ref":"#/components/schemas/GetBatchResponse"},"description":"The list of records to display in the search results.","nullable":true},"totalRecords":{"type":"integer","description":"The total number of records in the search results.","format":"int32"}},"additionalProperties":false,"description":"Represents search results to display on a page."},"GetPayerFeesResponse":{"type":"object","properties":{"achFee":{"type":"number","description":"The calculated fee for an ACH payment.","format":"double","readOnly":true,"example":5.12,"deprecated":true},"cardFee":{"type":"number","description":"The calculated fee for a card payment.","format":"double","readOnly":true,"example":5.12,"deprecated":true},"payerFees":{"type":"array","items":{"$ref":"#/components/schemas/PayerFee"},"description":"The payer fees by payment method type.","nullable":true}},"additionalProperties":false,"description":"The response payload after calculating the payer fees that would be associated with a payment."},"GetTerminalSessionResponse":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the terminal session.","nullable":true,"example":"abcdef123456"},"payer":{"type":"string","description":"The name of the payer. This is not necessarily the same name as the card or bank account holder name.","nullable":true,"example":"John Smith"},"userId":{"type":"string","description":"The user Id from the application that represents the user tied to this transaction.","nullable":true,"example":"jsmith12345"},"emailAddress":{"type":"string","description":"The email address of the user.","nullable":true,"example":"jsmith@example.com"},"customerId":{"type":"string","description":"The customer identifier for the entity making the payment.","nullable":true,"example":"1234567890"},"orderId":{"type":"string","description":"The unique order identifier for this transaction.","nullable":true,"example":"abcdefghi"},"terminalId":{"type":"integer","description":"The identifier for the terminal.","format":"int64","example":67890},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"A  <string, string>  dictionary of any application-specific metadata to have stored with the payment record.","nullable":true,"example":{"userId":"jsmith","accountId":"123"}},"billingAddress":{"$ref":"#/components/schemas/Address"},"shippingAddress":{"$ref":"#/components/schemas/Address"},"amount":{"type":"number","description":"The total amount of the transaction. This is inclusive all fees, if any. This will be a negative amount in the\r\ncase of refunds, ACH returns, chargebacks, etc.","format":"double","example":787.33},"payerFee":{"type":"number","description":"The amount the payer was charged to initiate this transaction, if any. This would be a non-zero amount when\r\nthe payer is charged a fee (e.g. a convenience fee or surcharge).","format":"double","nullable":true,"example":5.12},"platformFees":{"$ref":"#/components/schemas/PlatformFees"},"shippingAmount":{"type":"number","description":"The amount charged for shipping, if any.","format":"double","nullable":true,"example":7.87},"taxAmount":{"type":"number","description":"The amount charged for tax, if any.","format":"double","nullable":true,"example":78.73},"lineItems":{"type":"array","items":{"$ref":"#/components/schemas/TransactionLineItem"},"description":"Line items needed for Level 2/3 qualification.","nullable":true},"paidCustomers":{"type":"array","items":{"$ref":"#/components/schemas/TransactionPaidCustomer"},"description":"The list of customers tied to this transaction.","nullable":true},"paidInvoices":{"type":"array","items":{"$ref":"#/components/schemas/TransactionPaidInvoice"},"description":"The list of paid invoices on this transaction.","nullable":true},"currency":{"$ref":"#/components/schemas/Currency"},"comments":{"type":"string","description":"Additional comments tied to the transaction.","nullable":true,"example":"We are so excited about this purchase!"},"transactionId":{"type":"integer","description":"Points to the transaction if a payment was made from this session.","format":"int64","nullable":true,"example":12345}},"additionalProperties":false,"description":"The details of a terminal session."},"GetTokenResponse":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the token.","nullable":true,"example":"123"},"userId":{"type":"string","description":"The user Id from the application that represents the user that owns this payment method.","nullable":true,"example":"jsmith12345"},"emailAddress":{"type":"string","description":"The email address of the owner of this payment method.","nullable":true,"example":"jsmith@example.com"},"card":{"$ref":"#/components/schemas/Card"},"ach":{"$ref":"#/components/schemas/Ach"},"acss":{"$ref":"#/components/schemas/Acss"},"auDirectDebit":{"$ref":"#/components/schemas/AuDirectDebit"},"bacs":{"$ref":"#/components/schemas/Bacs"},"nzDirectDebit":{"$ref":"#/components/schemas/NzDirectDebit"},"sepa":{"$ref":"#/components/schemas/Sepa"},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"A  <string, string>  dictionary of any application-specific metadata to have stored with the token record.","nullable":true,"example":{"userId":"jsmith","accountId":"123"}},"address":{"$ref":"#/components/schemas/Address"},"status":{"$ref":"#/components/schemas/TokenStatus"}},"additionalProperties":false,"description":"The masked payment method that has been tokenized."},"GetTransactionResponse":{"type":"object","properties":{"id":{"type":"integer","description":"The unique identifier of the transaction.","format":"int64","example":12345},"payer":{"type":"string","description":"The name of the payer. This is not necessarily the same name as the card or bank account holder name.","nullable":true,"example":"John Smith"},"userId":{"type":"string","description":"The user Id from the application that represents the user tied to this transaction.","nullable":true,"example":"jsmith12345"},"emailAddress":{"type":"string","description":"The email address of the user.","nullable":true,"example":"jsmith@example.com"},"customerId":{"type":"string","description":"The customer identifier for the entity making the payment.","nullable":true,"example":"1234567890"},"orderId":{"type":"string","description":"The unique order identifier for this transaction.","nullable":true,"example":"abcdefghi"},"ach":{"$ref":"#/components/schemas/Ach"},"acss":{"$ref":"#/components/schemas/Acss"},"auDirectDebit":{"$ref":"#/components/schemas/AuDirectDebit"},"bacs":{"$ref":"#/components/schemas/Bacs"},"card":{"$ref":"#/components/schemas/Card"},"check":{"$ref":"#/components/schemas/Check"},"nzDirectDebit":{"$ref":"#/components/schemas/NzDirectDebit"},"sepa":{"$ref":"#/components/schemas/Sepa"},"terminalId":{"type":"integer","description":"The identifier for the terminal if the transaction was through a point of sale device.","format":"int64","nullable":true,"example":67890},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"A  <string, string>  dictionary of any application-specific metadata to have stored with the payment record.","nullable":true,"example":{"userId":"jsmith","accountId":"123"}},"billingAddress":{"$ref":"#/components/schemas/Address"},"shippingAddress":{"$ref":"#/components/schemas/Address"},"amount":{"type":"number","description":"The total amount of the transaction. This is inclusive all fees, if any. This will be a negative amount in the\r\ncase of refunds, ACH returns, chargebacks, etc.","format":"double","example":787.33},"payerFee":{"type":"number","description":"The amount the payer was charged to initiate this transaction, if any. This would be a non-zero amount when\r\nthe payer is charged a fee (e.g. a convenience fee or surcharge).","format":"double","nullable":true,"example":5.12},"platformFees":{"$ref":"#/components/schemas/PlatformFees"},"shippingAmount":{"type":"number","description":"The amount charged for shipping, if any.","format":"double","nullable":true,"example":7.87},"taxAmount":{"type":"number","description":"The amount charged for tax, if any.","format":"double","nullable":true,"example":78.73},"lineItems":{"type":"array","items":{"$ref":"#/components/schemas/TransactionLineItem"},"description":"Line items needed for Level 2/3 qualification.","nullable":true},"paidCustomers":{"type":"array","items":{"$ref":"#/components/schemas/TransactionPaidCustomer"},"description":"The list of customers tied to this transaction.","nullable":true},"paidInvoices":{"type":"array","items":{"$ref":"#/components/schemas/TransactionPaidInvoice"},"description":"The list of paid invoices on this transaction.","nullable":true},"currency":{"$ref":"#/components/schemas/Currency"},"comments":{"type":"string","description":"Additional comments tied to the transaction.","nullable":true,"example":"We are so excited about this purchase!"},"errorMessage":{"type":"string","description":"The translated error message, if any.","nullable":true},"transactionEventType":{"$ref":"#/components/schemas/TransactionEventType"},"originalTransactionId":{"type":"integer","description":"Points back to the original transaction. For example, if this is a refund, the original transaction Id would\r\nbe a reference to the original payment record.","format":"int64","nullable":true,"example":null},"processorTransactionId":{"type":"string","description":"The identifier for the transaction at the underlying processor.","nullable":true,"example":null,"deprecated":true},"events":{"type":"array","items":{"$ref":"#/components/schemas/TransactionEvent"},"description":"The list of events that occurred on this transaction.","nullable":true,"example":[{"EventDate":"1/1/2023","TransactionEventType":"Payment"}]},"channel":{"$ref":"#/components/schemas/Channel"},"isVoidable":{"type":"boolean","description":"True if the transaction is voidable. Otherwise, this is false."},"nextAction":{"$ref":"#/components/schemas/NextAction"},"processorTransaction":{"$ref":"#/components/schemas/ProcessorTransaction"}},"additionalProperties":false,"description":"The details of a transaction. This could represent a payment, refund, chargeback, etc."},"GetTransactionResponseSearchResults":{"type":"object","properties":{"records":{"type":"array","items":{"$ref":"#/components/schemas/GetTransactionResponse"},"description":"The list of records to display in the search results.","nullable":true},"totalRecords":{"type":"integer","description":"The total number of records in the search results.","format":"int32"}},"additionalProperties":false,"description":"Represents search results to display on a page."},"Invoice":{"required":["amountDue","id"],"type":"object","properties":{"id":{"maxLength":200,"minLength":1,"type":"string","description":"The unique identifier for the invoice.","example":"abcde12345"},"customerId":{"maxLength":200,"type":"string","description":"The identifier for the customer.","nullable":true,"example":"jsmith123"},"name":{"maxLength":150,"type":"string","description":"The name of the entity to which the invoice is addressed.","nullable":true,"example":"John Smith"},"invoiceDate":{"type":"string","description":"The date the invoice was created.","format":"date-time","nullable":true,"example":"2050-02-28"},"dueDate":{"type":"string","description":"The due date for the invoice.","format":"date-time","nullable":true,"example":"2050-02-28"},"amountDue":{"minimum":0,"type":"number","description":"The amount due on the invoice.","format":"double","example":123.45},"currency":{"$ref":"#/components/schemas/Currency"},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"A  <string, string>  dictionary of any application-specific metadata to have stored with the invoice.","nullable":true,"example":{"userId":"jsmith","accountId":"123"}}},"additionalProperties":false,"description":"The invoice data."},"NextAction":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/NextActionType"},"url":{"type":"string","description":"The URL to redirect the user to complete the payment.","nullable":true}},"additionalProperties":false,"description":"The next action to take after a payment is made."},"NextActionType":{"enum":["Redirect"],"type":"string"},"NzDirectDebit":{"required":["accountNumber","bankAccountHolder","bankCode","branchCode","suffix"],"type":"object","properties":{"bankAccountHolder":{"maxLength":150,"minLength":1,"type":"string","description":"The name of the bank account holder.","example":"Acme Corporation"},"bankCode":{"maxLength":2,"minLength":2,"type":"string","description":"The bank code.","example":"01"},"branchCode":{"maxLength":4,"minLength":4,"type":"string","description":"The branch code.","example":"1234"},"suffix":{"maxLength":3,"minLength":2,"type":"string","description":"The suffix.","example":"123"},"accountNumber":{"maxLength":7,"minLength":7,"type":"string","description":"The full account number.","example":"1234567"}},"additionalProperties":false,"description":"New Zealand direct debit."},"PayerFee":{"type":"object","properties":{"paymentMethodType":{"$ref":"#/components/schemas/PaymentMethodType"},"percentageFee":{"type":"number","description":"The percentage fee, if any.","format":"double"},"flatFee":{"type":"number","description":"The flat fee, if any.","format":"double"},"total":{"type":"number","description":"The total payer fee.","format":"double","readOnly":true}},"additionalProperties":false,"description":"The payer fee breakdown by payment method type."},"PaymentMethodProcessor":{"type":"object","properties":{"processor":{"$ref":"#/components/schemas/Processor"},"identifier":{"type":"string","description":"The unique identifier for the credential.","nullable":true},"paymentMethodType":{"$ref":"#/components/schemas/PaymentMethodType"}},"additionalProperties":false,"description":"The payment method and processor for an account."},"PaymentMethodType":{"enum":["Card","ACH","ACSS","Check","AuDirectDebit","NzDirectDebit","BACS","SEPA","CustomerInitiatedEntry"],"type":"string"},"PlatformFees":{"type":"object","properties":{"flatFee":{"type":"number","description":"The flat fee.","format":"double","nullable":true,"example":5},"percentageFee":{"type":"number","description":"The percentage fee.","format":"double","nullable":true,"example":0.12},"total":{"type":"number","description":"The total fee.","format":"double","nullable":true,"example":5.12}},"additionalProperties":false,"description":"The construct to hold the platform fees."},"PostAccountValidationRequest":{"type":"object","properties":{"ach":{"$ref":"#/components/schemas/Ach"},"accountValidationMethod":{"$ref":"#/components/schemas/AccountValidationMethod"}},"additionalProperties":false,"description":"Requests validation of a payment method."},"PostAccountValidationResponse":{"type":"object","properties":{"isValid":{"type":"boolean","description":"True if the account is valid; otherwise, false."},"errorMessage":{"type":"string","description":"The error message, if any, from the validation. This will be null if the account is valid.","nullable":true}},"additionalProperties":false,"description":"Response to validation of a payment method."},"PostApplicationSessionRequest":{"type":"object","properties":{"platformIdentifier":{"maxLength":150,"type":"string","description":"The identifier for the applicant from the platform's system.","nullable":true,"example":"abcde12345"},"contactFirstName":{"maxLength":100,"type":"string","description":"The first name of the person filling out the application.","nullable":true,"example":"John"},"contactLastName":{"maxLength":100,"type":"string","description":"The last name of the person filling out the application.","nullable":true,"example":"Smith"},"contactEmailAddress":{"maxLength":150,"type":"string","description":"The email address of the person filling out the application.","format":"email","nullable":true,"example":"jsmith@example.com"},"contactPhoneNumber":{"maxLength":50,"type":"string","description":"The phone number of the person filling out the application.","nullable":true,"example":"512-555-1234"},"organizationName":{"maxLength":150,"type":"string","description":"The legal name of the organization.","nullable":true,"example":"Acme Corporation"},"doingBusinessAs":{"maxLength":150,"type":"string","description":"The name of the DBA.","nullable":true,"example":"Acme"},"address":{"$ref":"#/components/schemas/Address"},"websiteUri":{"maxLength":250,"type":"string","description":"The URL of the website.","format":"uri","nullable":true,"example":"www.example.com"}},"additionalProperties":false,"description":"A request object to create an application session for pre-populating the sign up form."},"PostApplicationSessionResponse":{"type":"object","properties":{"sessionId":{"type":"string","description":"The session Id to be used when sending the applicant to the sign up application.","nullable":true,"example":"abcdefghi123456789"}},"additionalProperties":false,"description":"The response from creating an application session."},"PostAuthorizeRequest":{"required":["amount","payer"],"type":"object","properties":{"payer":{"maxLength":150,"minLength":1,"type":"string","description":"The name of the payer. This is not necessarily the same name as the card or bank account holder name.","example":"John Smith"},"userId":{"maxLength":150,"type":"string","description":"The user Id from the application that represents the user that owns this payment method.","nullable":true,"example":"jsmith12345"},"emailAddress":{"maxLength":150,"type":"string","description":"The email address of the user.","format":"email","nullable":true,"example":"jsmith@example.com"},"customerId":{"maxLength":25,"type":"string","description":"The customer identifier for the entity making the payment.","nullable":true,"example":"1234567890","deprecated":true},"orderId":{"maxLength":25,"type":"string","description":"The unique order identifier for this transaction.","nullable":true,"example":"abcdefghij"},"tokenId":{"type":"string","description":"The token identifier for a previously saved payment method. If this is supplied, the other payment\r\noptions can be left as null.","nullable":true,"example":"12345"},"card":{"$ref":"#/components/schemas/Card"},"processorToken":{"$ref":"#/components/schemas/ProcessorToken"},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"A  <string, string>  dictionary of any application-specific metadata to have stored with the payment record.","nullable":true,"example":{"userId":"jsmith","accountId":"123"}},"billingAddress":{"$ref":"#/components/schemas/Address"},"shippingAddress":{"$ref":"#/components/schemas/Address"},"amount":{"maximum":2147483647,"minimum":0,"type":"number","description":"The total amount being paid. This is inclusive of the payer fee, if any.","format":"double","example":787.33},"shippingAmount":{"maximum":2147483647,"minimum":0,"type":"number","description":"The amount charged for shipping, if any.","format":"double","nullable":true,"example":7.87},"taxAmount":{"maximum":2147483647,"minimum":0,"type":"number","description":"The amount charged for tax, if any.","format":"double","nullable":true,"example":78.73},"lineItems":{"type":"array","items":{"$ref":"#/components/schemas/TransactionLineItem"},"description":"Line items needed for Level 2/3 qualification.","nullable":true},"paidCustomers":{"type":"array","items":{"$ref":"#/components/schemas/TransactionPaidCustomer"},"description":"The list of customers tied to this transaction.","nullable":true},"paidInvoices":{"type":"array","items":{"$ref":"#/components/schemas/TransactionPaidInvoice"},"description":"The list of paid invoices on this transaction.","nullable":true},"currency":{"$ref":"#/components/schemas/Currency"},"comments":{"type":"string","description":"Additional comments entered in by the payer.","nullable":true,"example":"We are so excited about this purchase!"},"ipAddress":{"type":"string","description":"The IP address of the payer.","format":"string","nullable":true},"browserInformation":{"$ref":"#/components/schemas/BrowserInformation"},"returnUrl":{"type":"string","description":"The return URL to be used if an authorization flow is supported by the integrating application (e.g. 3DS).","format":"uri","nullable":true,"example":null},"sendPayerReceipt":{"type":"boolean","description":"If true, the payer will receive e-receipts on this transaction and any related returns, refunds, or voids. This value will be overridden by the \r\nsetting at the account left if it's null.","nullable":true}},"additionalProperties":false,"description":"The model to generate a card authorization."},"PostCaptureRequest":{"required":["payerFee"],"type":"object","properties":{"amount":{"maximum":2147483647,"minimum":0.01,"type":"number","description":"The amount of the previously authorized transaction that is being captured.","format":"double","example":51.2},"payerFee":{"maximum":2147483647,"minimum":0,"type":"number","description":"The amount the payer is being charged to initiate this transaction. This should only be a non-zero amount when\r\nyou are charging the payer a fee (e.g. a convenience fee or surcharge).","format":"double","example":5.12},"platformFee":{"maximum":2147483647,"minimum":0,"type":"number","description":"The amount the platform is charging the account for this transaction. If left null, the fee will be calculated \r\nautomatically based on the fee settings on the account. This is only used as an override to that calculation.\r\nOnly the platform can set this fee.","format":"double","nullable":true,"example":5.12},"shippingAmount":{"maximum":2147483647,"minimum":0,"type":"number","description":"The amount charged for shipping, if any.","format":"double","nullable":true,"example":7.87},"taxAmount":{"maximum":2147483647,"minimum":0,"type":"number","description":"The amount charged for tax, if any.","format":"double","nullable":true,"example":78.73},"lineItems":{"type":"array","items":{"$ref":"#/components/schemas/TransactionLineItem"},"description":"Line items needed for Level 2/3 qualification.","nullable":true},"paidCustomers":{"type":"array","items":{"$ref":"#/components/schemas/TransactionPaidCustomer"},"description":"The list of customers tied to this transaction.","nullable":true},"paidInvoices":{"type":"array","items":{"$ref":"#/components/schemas/TransactionPaidInvoice"},"description":"The list of paid invoices on this transaction.","nullable":true}},"additionalProperties":false,"description":"The model to capture a previously authorized transaction."},"PostCheckFileResponse":{"type":"object","properties":{"id":{"type":"string","description":"The file Id that was successfully uploaded.","nullable":true,"example":"abcdefghi123456789"}},"additionalProperties":false,"description":"The response from creating a file that is associated with a check payment."},"PostCheckValidateRequest":{"type":"object","properties":{"fileIds":{"type":"array","items":{"type":"string"},"description":"A collection of file identifiers to be used for check processing.","nullable":true}},"additionalProperties":false,"description":"Validates the check using at least a front image and back image identifiers obtained from the file submission process."},"PostCheckValidateResponse":{"type":"object","properties":{"checkNumber":{"type":"string","description":"The check number.","nullable":true,"example":"12345"},"routingNumber":{"type":"string","description":"The routing number.","nullable":true,"example":"021000021"},"accountNumber":{"type":"string","description":"The account number.","nullable":true,"example":"1234567890"},"amount":{"type":"number","description":"The amount.","format":"double","nullable":true,"example":123.45}},"additionalProperties":false,"description":"Contains the details of a check validation if successful."},"PostPayRequest":{"required":["amount","payer","payerFee"],"type":"object","properties":{"payer":{"maxLength":150,"minLength":1,"type":"string","description":"The name of the payer. This is not necessarily the same name as the card or bank account holder name.","example":"John Smith"},"userId":{"type":"string","description":"The user Id from the application that represents the user that owns this payment method.","nullable":true,"example":"jsmith12345"},"emailAddress":{"maxLength":150,"type":"string","description":"The email address of the user.","format":"email","nullable":true,"example":"jsmith@example.com"},"customerId":{"maxLength":25,"type":"string","description":"The customer identifier for the entity making the payment.","nullable":true,"example":"1234567890","deprecated":true},"orderId":{"maxLength":25,"type":"string","description":"The unique order identifier for this transaction.","nullable":true,"example":"abcdefghi"},"tokenId":{"type":"string","description":"The token identifier for a previously saved payment method. If this is supplied, the other payment\r\noptions can be left as null.","nullable":true,"example":"12345"},"ach":{"$ref":"#/components/schemas/Ach"},"acss":{"$ref":"#/components/schemas/Acss"},"auDirectDebit":{"$ref":"#/components/schemas/AuDirectDebit"},"bacs":{"$ref":"#/components/schemas/Bacs"},"card":{"$ref":"#/components/schemas/Card"},"check":{"$ref":"#/components/schemas/Check"},"nzDirectDebit":{"$ref":"#/components/schemas/NzDirectDebit"},"sepa":{"$ref":"#/components/schemas/Sepa"},"processorToken":{"$ref":"#/components/schemas/ProcessorToken"},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"A  <string, string>  dictionary of any application-specific metadata to have stored with the payment record.","nullable":true,"example":{"userId":"jsmith","accountId":"123"}},"billingAddress":{"$ref":"#/components/schemas/Address"},"shippingAddress":{"$ref":"#/components/schemas/Address"},"amount":{"maximum":2147483647,"minimum":0.01,"type":"number","description":"The total amount being paid. This is inclusive of the payer fee, if any.","format":"double","example":787.33},"payerFee":{"maximum":2147483647,"minimum":0,"type":"number","description":"The amount the payer is being charged to initiate this transaction. This should only be a non-zero amount when\r\nyou are charging the payer a fee (e.g. a convenience fee or surcharge).","format":"double","example":5.12},"platformFee":{"maximum":2147483647,"minimum":0,"type":"number","description":"The amount the platform is charging the account for this transaction. If left null, the fee will be calculated \r\nautomatically based on the fee settings on the account. This is only used as an override to that calculation.\r\nOnly the platform can set this fee.","format":"double","nullable":true,"example":5.12},"shippingAmount":{"maximum":2147483647,"minimum":0,"type":"number","description":"The amount charged for shipping, if any.","format":"double","nullable":true,"example":7.87},"taxAmount":{"maximum":2147483647,"minimum":0,"type":"number","description":"The amount charged for tax, if any.","format":"double","nullable":true,"example":78.73},"lineItems":{"type":"array","items":{"$ref":"#/components/schemas/TransactionLineItem"},"description":"Line items needed for Level 2/3 qualification.","nullable":true},"paidCustomers":{"type":"array","items":{"$ref":"#/components/schemas/TransactionPaidCustomer"},"description":"The list of customers tied to this transaction.","nullable":true},"paidInvoices":{"type":"array","items":{"$ref":"#/components/schemas/TransactionPaidInvoice"},"description":"The list of paid invoices on this transaction.","nullable":true},"currency":{"$ref":"#/components/schemas/Currency"},"comments":{"type":"string","description":"Additional comments entered in by the payer.","nullable":true,"example":"We are so excited about this purchase!"},"ipAddress":{"type":"string","description":"The IP address of the payer.","format":"string","nullable":true,"example":"127.0.0.1"},"browserInformation":{"$ref":"#/components/schemas/BrowserInformation"},"returnUrl":{"type":"string","description":"The return URL to be used if an authorization flow is supported by the integrating application (e.g. 3DS).","format":"uri","nullable":true,"example":null},"sendPayerReceipt":{"type":"boolean","description":"If true, the payer will receive e-receipts on this transaction and any related returns, refunds, or voids. This value will be overridden by the \r\nsetting at the account left if it's null.","nullable":true}},"additionalProperties":false,"description":"The model to generate a payment."},"PostRefundRequest":{"type":"object","properties":{"amount":{"maximum":2147483647,"minimum":0.01,"type":"number","description":"The amount to be refunded.","format":"double","example":51.2}},"additionalProperties":false,"description":"Requests the refund of a specific amount on a transaction."},"PostTerminalSessionRequest":{"required":["amount","payer","payerFee"],"type":"object","properties":{"terminalId":{"type":"integer","description":"The unique identifier for the terminal.","format":"int64","example":12345},"payer":{"maxLength":150,"minLength":1,"type":"string","description":"The name of the payer. This is not necessarily the same name as the card or bank account holder name.","example":"John Smith"},"userId":{"type":"string","description":"The user Id from the application that represents the user that owns this payment method.","nullable":true,"example":"jsmith12345"},"emailAddress":{"maxLength":150,"type":"string","description":"The email address of the user.","format":"email","nullable":true,"example":"jsmith@example.com"},"customerId":{"maxLength":25,"type":"string","description":"The customer identifier for the entity making the payment.","nullable":true,"example":"1234567890","deprecated":true},"orderId":{"maxLength":25,"type":"string","description":"The unique order identifier for this transaction.","nullable":true,"example":"abcdefghi"},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"A  <string, string>  dictionary of any application-specific metadata to have stored with the payment record.","nullable":true,"example":{"userId":"jsmith","accountId":"123"}},"billingAddress":{"$ref":"#/components/schemas/Address"},"shippingAddress":{"$ref":"#/components/schemas/Address"},"amount":{"maximum":2147483647,"minimum":0.01,"type":"number","description":"The total amount being paid. This is inclusive of the payer fee, if any.","format":"double","example":787.33},"payerFee":{"maximum":2147483647,"minimum":0,"type":"number","description":"The amount the payer is being charged to initiate this transaction. This should only be a non-zero amount when\r\nyou are charging the payer a fee (e.g. a convenience fee or surcharge).","format":"double","example":5.12},"platformFee":{"maximum":2147483647,"minimum":0,"type":"number","description":"The amount the platform is charging the account for this transaction. If left null, the fee will be calculated \r\nautomatically based on the fee settings on the account. This is only used as an override to that calculation.\r\nOnly the platform can set this fee.","format":"double","nullable":true,"example":5.12},"shippingAmount":{"maximum":2147483647,"minimum":0,"type":"number","description":"The amount charged for shipping, if any.","format":"double","nullable":true,"example":7.87},"taxAmount":{"maximum":2147483647,"minimum":0,"type":"number","description":"The amount charged for tax, if any.","format":"double","nullable":true,"example":78.73},"lineItems":{"type":"array","items":{"$ref":"#/components/schemas/TransactionLineItem"},"description":"Line items needed for Level 2/3 qualification.","nullable":true},"paidCustomers":{"type":"array","items":{"$ref":"#/components/schemas/TransactionPaidCustomer"},"description":"The list of customers tied to this transaction.","nullable":true},"paidInvoices":{"type":"array","items":{"$ref":"#/components/schemas/TransactionPaidInvoice"},"description":"The list of paid invoices on this transaction.","nullable":true},"currency":{"$ref":"#/components/schemas/Currency"},"comments":{"type":"string","description":"Additional comments entered in by the payer.","nullable":true,"example":"We are so excited about this purchase!"}},"additionalProperties":false,"description":"The model to initiate a session on a point of sale terminal."},"PostTokenRequest":{"type":"object","properties":{"userId":{"maxLength":150,"type":"string","description":"The user Id from the application that represents the user that owns this payment method. This is required\r\nfor network tokenization.","nullable":true,"example":"jsmith12345"},"emailAddress":{"maxLength":150,"type":"string","description":"The email address of the owner of this payment method. This is required to enable network tokenization.","format":"email","nullable":true,"example":"jsmith@example.com"},"ach":{"$ref":"#/components/schemas/Ach"},"acss":{"$ref":"#/components/schemas/Acss"},"auDirectDebit":{"$ref":"#/components/schemas/AuDirectDebit"},"bacs":{"$ref":"#/components/schemas/Bacs"},"card":{"$ref":"#/components/schemas/Card"},"nzDirectDebit":{"$ref":"#/components/schemas/NzDirectDebit"},"sepa":{"$ref":"#/components/schemas/Sepa"},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"A  <string, string>  dictionary of any application-specific metadata to have stored with the token record.","nullable":true,"example":{"userId":"jsmith","accountId":"123"}},"address":{"$ref":"#/components/schemas/Address"},"validateAccount":{"type":"boolean","description":"True if the account validation should be run immediately before tokenization. Otherwise, this is false. This is currently only supported on ACH payments methods.","example":false,"deprecated":true}},"additionalProperties":false,"description":"Used to save a payment method as a token. Only one of the payment methods should be supplied in the request."},"Processor":{"enum":["Fake","AdyenPlatform","AdyenMerchant","StripePlatform","StripeMerchant","TokenEx","LegacyGatewaySupport","NachaDirect","NachaTpsFnboPlatform","NachaTpsFnboMerchant","NachaTpsFakePlatform","NachaTpsFakeMerchant","FtniPlatform","FtniMerchant","AmericanExpressPlatform","AmericanExpressMerchant","DeluxeMerchant","CyberSource","AuthorizeDotNet","TrustCommerce","PayPalPayflowPro"],"type":"string"},"ProcessorCredentialStatus":{"type":"object","properties":{"processor":{"$ref":"#/components/schemas/Processor"},"identifier":{"type":"string","description":"The unique identifier for the credential.","nullable":true},"status":{"$ref":"#/components/schemas/AccountProcessorCredentialStatus"},"statusReasons":{"type":"array","items":{"type":"string"},"description":"The reasons for the status, if any. This is typically null or empty if the status is Active.","nullable":true,"example":["Identification required","Invalid mailing address"]}},"additionalProperties":false,"description":"The processor for an account as well as the status of processing capabilities."},"ProcessorToken":{"required":["maskedAccountNumber","paymentMethodType","tokenId"],"type":"object","properties":{"customerId":{"type":"string","description":"The processor's customer identifier.","nullable":true,"example":"1234567890"},"tokenId":{"minLength":1,"type":"string","description":"The processor's token identifier.","example":"abcdefg"},"paymentMethodType":{"$ref":"#/components/schemas/PaymentMethodType"},"cardBrand":{"$ref":"#/components/schemas/CardBrand"},"maskedAccountNumber":{"minLength":1,"type":"string","description":"The masked account number.","example":"XXXXXXXXXXXX4242"}},"additionalProperties":false,"description":"The processor token for backwards compatibility. This is used if the token is stored with the processor."},"ProcessorTransaction":{"type":"object","properties":{"processor":{"$ref":"#/components/schemas/Processor"},"transactionId":{"type":"string","description":"The processor's transaction identifier.","nullable":true,"example":"abcdef123456"}},"additionalProperties":false,"description":"Transaction details from the processor."},"Sepa":{"required":["accountHolder","iban"],"type":"object","properties":{"accountHolder":{"maxLength":150,"minLength":1,"type":"string","description":"The name of the account holder.","example":"Acme Corporation"},"iban":{"maxLength":34,"minLength":15,"type":"string","description":"The IBAN number for the account.","example":"DE87123456781234567890"}},"additionalProperties":false,"description":"The Single Euro Payments Area direct debit."},"TokenStatus":{"enum":["Active","Deleted","Invalid"],"type":"string"},"TransactionEvent":{"type":"object","properties":{"eventName":{"type":"string","description":"The user friendly name of the event.","nullable":true},"eventDate":{"type":"string","description":"The date of the event. The timestamp is in UTC.","format":"date-time"},"transactionEventType":{"$ref":"#/components/schemas/TransactionEventType"}},"additionalProperties":false,"description":"Represents an event that occurred that is relevant to a transaction."},"TransactionEventType":{"enum":["Payment","Authorization","Capture","Refund","Return","Chargeback","ChargebackReversal","Dispute","Settle","Process","Reject","Void","Hold","HoldReleased","InitiatePayment","InitiateAuthorization","Fee","TopUp","Batch"],"type":"string"},"TransactionFileCategory":{"enum":["Other","CheckFront","CheckBack"],"type":"string"},"TransactionLineItem":{"type":"object","properties":{"productCode":{"maxLength":15,"type":"string","description":"The code for the product.","nullable":true,"example":"widget123"},"productDescription":{"maxLength":50,"type":"string","description":"The description for the product.","nullable":true,"example":"Shiny new widget. Great for all ages."},"unitPrice":{"maximum":2147483647,"minimum":0.01,"type":"number","description":"The price per unit.","format":"double","nullable":true,"example":51.2},"quantity":{"maximum":2147483647,"minimum":1,"type":"integer","description":"The number of units sold.","format":"int32","nullable":true,"example":3},"taxAmount":{"maximum":2147483647,"minimum":0,"type":"number","description":"The total tax amount for this one line item.","format":"double","nullable":true,"example":0.51},"discountAmount":{"maximum":2147483647,"minimum":0,"type":"number","description":"The total discount amount for this one line item.","format":"double","nullable":true,"example":7.87},"unitOfMeasure":{"maxLength":15,"type":"string","description":"The unit of measure.","nullable":true,"example":"ea"},"commodityCode":{"maxLength":15,"type":"string","description":"The commodity code for this product as defined by https://www.unspsc.org/.","nullable":true,"example":"44121709"}},"additionalProperties":false,"description":"Line item data that is typically needed for Level 2/3 qualification."},"TransactionPaidCustomer":{"required":["amount","id","name"],"type":"object","properties":{"id":{"maxLength":200,"minLength":1,"type":"string","description":"The unique identifier for the customer.","example":"jsmith123"},"name":{"maxLength":150,"minLength":1,"type":"string","description":"The name of the customer.","example":"John Smith"},"amount":{"minimum":0,"type":"number","description":"The amount paid for this customer.","format":"double","example":123.45},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"A  <string, string>  dictionary of any application-specific metadata to have stored with the customer.","nullable":true,"example":{"userId":"jsmith","accountId":"123"}}},"additionalProperties":false,"description":"Represents a customer record associated with a transaction."},"TransactionPaidInvoice":{"required":["amount","id"],"type":"object","properties":{"id":{"maxLength":200,"minLength":1,"type":"string","description":"The unique identifier for the invoice.","example":"abcde12345"},"customerId":{"maxLength":200,"type":"string","description":"The name of the customer.","nullable":true,"example":"jsmith123"},"amount":{"minimum":0,"type":"number","description":"The amount paid for this invoice.","format":"double","example":123.45},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"A  <string, string>  dictionary of any application-specific metadata to have stored with the invoice.","nullable":true,"example":{"userId":"jsmith","accountId":"123"}}},"additionalProperties":false,"description":"Represents an invoice record associated with a transaction."},"ValidationProblemDetails":{"type":"object","properties":{"type":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"status":{"type":"integer","format":"int32","nullable":true},"detail":{"type":"string","nullable":true},"instance":{"type":"string","nullable":true},"errors":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}},"nullable":true}},"additionalProperties":{}}},"securitySchemes":{"basic":{"type":"http","scheme":"basic"}}},"servers":[{"url":"https://paymentsapisandbox.payra.com","description":"Payment processor API (`/v1/...`): same surface for ACH and card (tokens, transactions, accounts, payer fees, and related operations)."}]}