Errors

1
{
2
  "type": "https://docs.payroc.com/api/errors#api-error",
3
  "title": "Api error",
4
  "status": 500,
5
  "detail": "We are unable to process your request at this time"
6
  "errors": [
7
    {
8
      "message": "Service offline"
9
    }
10
  ]
11
}

1
{
2
  "type": "https://docs.payroc.com/api/errors#bad-request",
3
  "title": "Bad request",
4
  "status": 400,
5
  "detail": "One or more validation errors occurred, see error section for more info",
6
  "errors": [
7
    {
8
      "parameter": "start_time",
9
      "detail": "invalid date",
10
      "message": "Expected time, got \\\"\\\" for start_time"
11
    }
12
  ]
13
}

1
{
2
  "type": "https://docs.payroc.com/api/errors#cannot-be-modified",
3
  "title": "Cannot be modified",
4
  "status": 409,
5
  "detail": "You cannot modify this resource in its current state"
6
}

1
{
2
  "type": "https://docs.payroc.com/api/errors#capabilities-missing",
3
  "title": "Capabilities missing",
4
  "status": 400,
5
  "detail": "The terminal does not support the capability you are trying to use.", 
6
  "errors": [
7
    {
8
      "parameter": "processingTerminalId",
9
      "message": "Processing terminal does not support pre-authorizations"
10
    }
11
  ]
12
}

1
{
2
  "type": "https://docs.payroc.com/api/errors#card-type-not-supported",
3
  "title": "Card type is not supported",
4
  "status": 400,
5
  "detail": "You cannot process transactions with 'card_type' cards through this account"
6
}

1
{
2
  "type": "https://docs.payroc.com/api/errors#contract-already-signed",
3
  "title": "Contract already signed",
4
  "status": 400,
5
  "detail": "The merchant has already signed the contract"
6
}

1
{
2
  "type": "https://docs.payroc.com/api/errors#currency-not-supported",
3
  "title": "Currency is not supported",
4
  "status": 400,
5
  "detail": "You cannot process 'currency_code' transactions through this account"
6
}

1
{
2
  "type": "https://docs.payroc.com/api/errors#forbidden",
3
  "title": "Forbidden",
4
  "status": 403,
5
  "detail": "You do not have the required permissions to perform this action"
6
}

1
{
2
  "type": "https://docs.payroc.com/api/errors#funding-accounts-limit-reached",
3
  "title": "Funding accounts limit reached",
4
  "status": 400,
5
  "detail": "You can not have any more than two funding accounts attached to this entity",
6
}

1
{
2
  "type": "https://docs.payroc.com/api/errors#funding-accounts-restricted",
3
  "title": "Funding accounts restricted",
4
  "status": 400,
5
  "detail": "One or more funding accounts are restricted and can't receive funding instructions",
6
  "errors": [
7
    {
8
      "fundingAccountId": 123,
9
      "message": "Funding account on hold"
10
    }
11
  ]
12
}

1
{
2
  "type": "https://docs.payroc.com/api/errors#idempotency-key-in-use",
3
  "title": "Idempotency-Key in use",
4
  "status": 409,
5
  "detail": "'Idempotency-Key' is already in use against a different request",
6
}

1
{
2
  "type": "https://docs.payroc.com/api/errors#idempotency-key-missing",
3
  "title": "Idempotent-key header missing",
4
  "status": 400,
5
  "detail": "An 'Idempotency-Key' must be supplied for this request",
6
}

1
{
2
  "type": "https://docs.payroc.com/api/errors#insufficient-funds",
3
  "title": "Insufficient funds",
4
  "status": 400,
5
  "detail": "You do not have the required funds to complete this transaction",
6
}

1
{
2
  "type": "https://docs.payroc.com/api/errors#kyc-check-failed",
3
  "title": "Failed KYC Checks",
4
  "status": 400,
5
  "detail": "Entity has been rejected due to failing KYC checks",
6
}

1
{
2
  "type": "https://docs.payroc.com/api/errors#national-id-in-use",
3
  "title": "National ID in use",
4
  "status": 409,
5
  "detail": "One or more supplied national IDs are not unique. All national IDs must be unique"
6
}

1
{
2
  "type": "https://docs.payroc.com/api/errors#no-control-prong-or-authorized-signatory",
3
  "title": "No control prong or authorized signatory",
4
  "status": 400,
5
  "detail": "Set one owner as the control prong or the authorized signatory"
6
}

1
{
2
  "type": "https://docs.payroc.com/api/errors#no-pricing-agreement-exists-for-the-processing-account",
3
  "title": "No pricing agreement exists",
4
  "status": 400,
5
  "detail": "There is no pricing agreement linked to the processing account"
6
}

1
{
2
  "type": "https://docs.payroc.com/api/errors#not-acceptable",
3
  "title": "Not acceptable",
4
  "status": 406,
5
  "detail": "Resource does not support the representation requested"
6
}

1
{
2
  "type": "https://docs.payroc.com/api/errors#not-authorized",
3
  "title": "Not authorized",
4
  "status": 401,
5
  "detail": "Your identity could not be verified"
6
}

1
{
2
  "type": "https://docs.payroc.com/api/errors#not-found",
3
  "title": "Not found",
4
  "status": 404,
5
  "detail": "Resource not found",
6
  "resource": "account"
7
}

1
{
2
  "type": "https://docs.payroc.com/api/errors#not-requested-by-email",
3
  "title": "Not requested by email",
4
  "status": 400,
5
  "detail": "You can use the Reminders endpoint only for information that we sent by email",
6
}

1
{
2
  "type": "https://docs.payroc.com/api/errors#payload-too-large",
3
  "title": "Payload too large",
4
  "status": 413,
5
  "detail": "The payload submitted is too large"
6
}

1
{
2
  "type": "https://docs.payroc.com/api/errors#processing-terminal-not-accepted",
3
  "title": "Processing terminal was not accepted",
4
  "status": 400,
5
  "detail": "The processing terminal is unable to handle the request, see error section for more info",
6
  "errors": [
7
    {
8
      "parameter": "processingTerminalId",
9
      "message": "Processing terminal has been deactivated"
10
    }
11
  ]
12
}

1
{
2
  "type": "https://docs.payroc.com/api/errors#resource-already-exists",
3
  "title": "Resource already exists",
4
  "status": 409,
5
  "detail": "The resource you attempted to create already exists",
6
}

1
{
2
  "type": "https://docs.payroc.com/api/errors#search-too-broad",
3
  "title": "Search too broad",
4
  "status": 400,
5
  "detail": "Your request has produced a list of results that is too large."
6
}

1
{
2
  "type": "https://docs.payroc.com/api/errors#tax-id-in-use",
3
  "title": "Tax ID already in use",
4
  "status": 409,
5
  "detail": "The tax ID that you supplied is already in use. Supply a unique tax ID"
6
}

1
{
2
  "type": "https://docs.payroc.com/api/errors#too-many-control-prongs",
3
  "title": "Too many control prongs",
4
  "status": 400,
5
  "detail": "You can set only one owner as the control prong"
6
}

1
{
2
  "type": "https://docs.payroc.com/api/errors#unsupported-media-type",
3
  "title": "Unsupported media type",
4
  "status": 415,
5
  "detail": "You submitted a payload in an unsupported format"
6
}

1
{
2
  "type": "https://docs.payroc.com/api/errors#volume-limit-reached",
3
  "title": "Volume limit has been reached",
4
  "status": 400,
5
  "detail": "You have exceeded the processing volume limit for your account.",
6
  "errors": [
7
    {
8
      "parameter": "order.amount",
9
      "detail": "Above maximum",
10
      "message": "'amount' must not exceed USD 500"
11
    }
12
  ]
13
}